Orq.ai Documentation - AI Gateway & LLM Collaboration Platform

Create rerank

curl --request POST \
  --url https://api.orq.ai/v2/gateway/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "model": "<string>",
  "top_n": 123,
  "filename": "<string>",
  "orq": {
    "name": "<string>",
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "cache": {
      "type": "exact_match",
      "ttl": 3600
    },
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "contact": {
      "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "display_name": "Jane Doe",
      "email": "[email protected]",
      "metadata": [
        {
          "department": "Engineering",
          "role": "Senior Developer"
        }
      ],
      "logo_url": "https://example.com/avatars/jane-doe.jpg",
      "tags": [
        "hr",
        "engineering"
      ]
    },
    "load_balancer": [
      {
        "model": "openai/gpt-4o",
        "weight": 0.7
      },
      {
        "model": "anthropic/claude-3-5-sonnet",
        "weight": 0.3
      }
    ],
    "timeout": {
      "call_timeout": 30000
    }
  }
}
'

{
  "object": "list",
  "results": [
    {
      "object": "rerank",
      "index": 123,
      "relevance_score": 123,
      "document": {
        "text": "<string>"
      }
    }
  ],
  "id": "<string>",
  "usage": {
    "total_tokens": 123
  }
}

POST

gateway

rerank

Create rerank

curl --request POST \
  --url https://api.orq.ai/v2/gateway/rerank \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "documents": [
    "<string>"
  ],
  "model": "<string>",
  "top_n": 123,
  "filename": "<string>",
  "orq": {
    "name": "<string>",
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "cache": {
      "type": "exact_match",
      "ttl": 3600
    },
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "contact": {
      "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "display_name": "Jane Doe",
      "email": "[email protected]",
      "metadata": [
        {
          "department": "Engineering",
          "role": "Senior Developer"
        }
      ],
      "logo_url": "https://example.com/avatars/jane-doe.jpg",
      "tags": [
        "hr",
        "engineering"
      ]
    },
    "load_balancer": [
      {
        "model": "openai/gpt-4o",
        "weight": 0.7
      },
      {
        "model": "anthropic/claude-3-5-sonnet",
        "weight": 0.3
      }
    ],
    "timeout": {
      "call_timeout": 30000
    }
  }
}
'

{
  "object": "list",
  "results": [
    {
      "object": "rerank",
      "index": 123,
      "relevance_score": 123,
      "document": {
        "text": "<string>"
      }
    }
  ],
  "id": "<string>",
  "usage": {
    "total_tokens": 123
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

input

query

string

required

The search query

documents

string[]

required

A list of texts that will be compared to the query. For optimal performance we recommend against sending more than 1,000 documents in a single request.

model

string

required

The identifier of the model to use

top_n

number

The number of most relevant documents or indices to return, defaults to the length of the documents

filename

string | null

The filename of the document to rerank

orq

object

Show child attributes

orq.name

string

The name to display on the trace. If not specified, the default system name will be used.

orq.fallbacks

object[]

Array of fallback models to use if primary model fails

Show child attributes

orq.fallbacks.model

string

required

Fallback model identifier

Example:

"openai/gpt-4o-mini"

orq.cache

object

Cache configuration for the request.

Show child attributes

orq.cache.type

enum<string>

required

Available options:

exact_match

orq.cache.ttl

number

default:1800

Time to live for cached responses in seconds. Maximum 259200 seconds (3 days).

Required range: 1 <= x <= 259200

Example:

3600

orq.retry

object

Retry configuration for the request

Show child attributes

orq.retry.count

number

default:3

Number of retry attempts (1-5)

Required range: 1 <= x <= 5

Example:

3

orq.retry.on_codes

number[]

HTTP status codes that trigger retry logic

Minimum array length: 1

Required range: 100 <= x <= 599

Example:

[429, 500, 502, 503, 504]

orq.contact

object

Information about the contact making the request. If the contact does not exist, it will be created automatically.

Show child attributes

orq.contact.id

string

required

Unique identifier for the contact

Example:

"contact_01ARZ3NDEKTSV4RRFFQ69G5FAV"

orq.contact.display_name

string

Display name of the contact

Example:

"Jane Doe"

orq.contact.email

string<email>

Email address of the contact

Example:

"[email protected]"

orq.contact.metadata

object[]

A hash of key/value pairs containing any other data about the contact

Show child attributes

orq.contact.metadata.{key}

any

Example:

[
  {
    "department": "Engineering",
    "role": "Senior Developer"
  }
]

orq.contact.logo_url

string

URL to the contact's avatar or logo

Example:

"https://example.com/avatars/jane-doe.jpg"

orq.contact.tags

string[]

A list of tags associated with the contact

Example:

["hr", "engineering"]

orq.load_balancer

object[]

Array of models with weights for load balancing requests

Show child attributes

orq.load_balancer.model

string

required

Model identifier for load balancing

Example:

"openai/gpt-4o"

orq.load_balancer.weight

number

default:0.5

Weight assigned to this model for load balancing

Required range: 0.001 <= x <= 1

Example:

0.7

Example:

[
  { "model": "openai/gpt-4o", "weight": 0.7 },
  {
    "model": "anthropic/claude-3-5-sonnet",
    "weight": 0.3
  }
]

orq.timeout

object

Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.

Show child attributes

orq.timeout.call_timeout

number

required

Timeout value in milliseconds

Required range: x >= 1

Example:

30000

Response

200 - application/json

Returns the reranked documents.

object

enum<string>

required

Available options:

list

results

object[]

required

An ordered list of ranked documents

Show child attributes

results.object

enum<string>

required

The object type, which is always rerank.

Available options:

rerank

results.index

number

required

Corresponds to the index in the original list of documents to which the ranked document belongs.

results.relevance_score

number

required

Relevance scores are normalized to be in the range [0, 1]. Scores close to 1 indicate a high relevance to the query, and scores closer to 0 indicate low relevance.

results.document

object

If return_documents is set as false this will return none, if true it will return the documents passed in

Show child attributes

results.document.text

string

required

The text of the document to rerank

string

A unique identifier for the rerank.

usage

object

Show child attributes

usage.total_tokens

number

required

The total number of tokens used in the rerank

Create moderation

⌘I

Platform APIs

Gateway APIs

Create rerank

Authorizations

Body

Response