JIjina
Generative Models

Chat Completions

Changed on

Transcribe a document image. Send the page as an image_url content part and the reply is its text; response_format with a json_schema constrains that to a schema instead.

post/v1/chat/completions

Request

Request body

model'jina-ocr-v1' required

The model to use.

streamboolean
max_completion_tokensinteger nullable
temperaturenumber nullable
top_pnumber nullable
presence_penaltynumber nullable
frequency_penaltynumber nullable
seedinteger nullable
logprobsboolean nullable
top_logprobsinteger nullable
logit_biasobject nullable

Response

An OpenAI chat completion, or a stream of chat.completion.chunk events when stream is true.

unknown required

Changes

  • e1c9fccc2a1aRevision changes
    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property errors list-of-types was widened by adding types null to media type application/json of response 422

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • d16aa597a85dRevision changes
    • breaking

      added required request body

    • breaking

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

    • info

      api tag Generative Models added

    • info

      api tag Search Foundation Models removed

    • info

      added the non-success response with the status