@@ -27450,12 +27450,34 @@ paths:
2745027450 top_n: 3
2745127451 properties:
2745227452 documents:
27453- description: The list of documents to rerank
27453+ description: >-
27454+ The list of documents to rerank. Documents may be plain strings, or structured objects with `text`
27455+ and/or `image` for multimodal models.
2745427456 example:
2745527457 - Paris is the capital of France.
2745627458 - Berlin is the capital of Germany.
2745727459 items:
27458- type: string
27460+ anyOf:
27461+ - type: string
27462+ - description: >-
27463+ A structured document with optional text and/or image content. At least one of `text` or
27464+ `image` must be provided.
27465+ properties:
27466+ image:
27467+ description: >-
27468+ An image associated with the document, as a remote URL (http/https) or a base64-encoded
27469+ data URI (data:image/...).
27470+ example: https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png
27471+ type: string
27472+ text:
27473+ description: The document text
27474+ example: AI enables robots to perceive, plan, and act autonomously.
27475+ type: string
27476+ type: object
27477+ description: >-
27478+ A document to rerank. Either a plain string, or a structured object with optional `text` and/or
27479+ `image`.
27480+ minItems: 1
2745927481 type: array
2746027482 model:
2746127483 description: The rerank model to use
@@ -27526,14 +27548,16 @@ paths:
2752627548 relevance_score: 0.98
2752727549 properties:
2752827550 document:
27529- description: The document object containing the original text
27551+ description: The document object echoing the original input ( text and/or image)
2753027552 properties:
27553+ image:
27554+ description: The image (URL or data URI) from the original document
27555+ example: https://example.com/image.png
27556+ type: string
2753127557 text:
2753227558 description: The document text
2753327559 example: Paris is the capital of France.
2753427560 type: string
27535- required:
27536- - text
2753727561 type: object
2753827562 index:
2753927563 description: Index of the document in the original input list
0 commit comments