SUsuperlinked
inference

Changed on

Cohere v1-compatible text-only subset over SIE's native score primitive. Supported request fields are model, query, string documents, top_n, return_documents, and the documented SIE options extension. Unknown or unsupported fields reject with 400. The adapter rejects partial native results and forwards only authoritative worker-emitted usage.

post/v1/rerank

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Headers

X-SIE-MACHINE-PROFILEstring nullable

Preferred GPU or machine profile

X-SIE-Poolstring nullable

Explicit pool routing override

X-SIE-SDK-Versionstring nullable

Client SDK version for skew warnings

X-SIE-Remote'forbid'

Require local serving through a current worker execution fence. A selected remote profile returns 400; no verified local worker returns retryable 503. Duplicate or other values return 400.

Request body

documentsstring[] required

One to 1,000 nonblank text candidates. Execution is internally batched within the selected model profile's max_batch_tokens limit.

modelstring required

SIE model id. Blank or whitespace-only values are rejected.

querystring required

Text query. Blank or whitespace-only values are rejected.

return_documentsboolean nullable
top_ninteger nullable

Response

Cohere v1-compatible subset response

modelstring required

Changes

  • da41b562c094Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      added subschema #1 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

  • f180cec53d4fRevision changes
    • info

      added the new optional header request parameter X-SIE-Remote