Body Required

• query string | object Required

  Query input. The query can be specified as a single string, or as an object. The object form additionally allows specifying non-text inputs, such as images.

  
  

  Only the elastic service currently supports non-text queries for the rerank task. For all other services, the query must be a string.

  string example:

  "query": "some query text"
  

  object example:

  "query": {
    "type": "image",
    "format": "base64",
    "value": "data:image/jpeg;base64,..."
  }
  

  One of:

  string-1 string Input object object

  An object describing a single input for the rerank task, which additionally allows specifying non-text inputs, such as images.

  Hide attributes Show attributes

  • type string Required

    The type of input. Not all services and models support all input types.

    Values are text or image.

  • format string

    The format of the input. For the text type this must be text. For the image type this must be base64. If not specified, this defaults to text for the text type and base64 for the image type.

    Values are text or base64.

  • value string Required

    The value of the input. For images, this must be a base64-encoded data URI, that is, "data:content/type;base64,...".

• input string | array[string] | object | array[object] Required

  The documents to rank. The input can be specified as a single string or an array of strings, or as an object or an array of objects. The object form additionally allows specifying non-text inputs, such as images.

  
  

  Only the elastic service currently supports non-text inputs for the rerank task. For all other services, the input must be a string or an array of strings.

  string example:

  "input": "some document text"
  

  string array example:

  "input": ["some document text", "some more document text"]
  

  object example:

  "input": {
    "type": "image",
    "format": "base64",
    "value": "data:image/jpeg;base64,..."
  }
  

  object array example:

  "input": [
    {
      "type": "text",
      "format": "text",
      "value": "some document text"
    },
    {
      "type": "image",
      "format": "base64",
      "value": "data:image/jpeg;base64,..."
    }
  ]
  

  One of:

  string-1 string Array of strings array[string] Input object object Array of objects array[object]

  An array of text documents to rank.

  An object describing a single input for the rerank task, which additionally allows specifying non-text inputs, such as images.

  Hide attributes Show attributes

  • type string Required

    The type of input. Not all services and models support all input types.

    Values are text or image.

  • format string

    The format of the input. For the text type this must be text. For the image type this must be base64. If not specified, this defaults to text for the text type and base64 for the image type.

    Values are text or base64.

  • value string Required

    The value of the input. For images, this must be a base64-encoded data URI, that is, "data:content/type;base64,...".

  An array of input objects to rank. Each object can specify a non-text input, such as an image.

• return_documents boolean

  Include the document text in the response.

• top_n number

  Limit the response to the top N documents.

• task_settings object

  Task settings for the individual inference request. These settings are specific to the task type you specified and override the task settings specified when initializing the service.