Perform chat completion inference

Auth

The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the chat_completion task type.

Note

The chat_completion task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. To determine whether a given inference service supports this task type, please see the page for that service.

Path parameters

inference_id string required

The inference Id

Query parameters

timeout string · default: 30s

Specifies the amount of time to wait for the inference request to complete.

Request body

messages object[] required

A list of objects representing the conversation. Requests should generally only add new messages from the user (role user). The other message roles (assistant, system, or tool) should generally only be copied from the response to a previous completion request, such that the messages array is built up throughout a conversation.

content union oneOf

The content of the message.

String example:

{
   "content": "Some string"
}

Object example:

{
  "content": [
      {
       "text": "Some text",
       "type": "text"
      }
   ]
}
One of:
role string required

The role of the message author. Valid values are user, assistant, system, and tool.

tool_call_id string

Only for tool role messages. The tool call that this message is responding to.

tool_calls object[]

Only for assistant role messages. The tool calls generated by the model. If it's specified, the content field is optional. Example:

{
  "tool_calls": [
      {
          "id": "call_KcAjWtAww20AihPHphUh46Gd",
          "type": "function",
          "function": {
              "name": "get_current_weather",
              "arguments": "{\"location\":\"Boston, MA\"}"
          }
      }
  ]
}
id string required

The identifier of the tool call.

function object required

The function that the model called.

arguments string required

The arguments to call the function with in JSON format.

name string required

The name of the function to call.

type string required

The type of the tool call.

model string

The ID of the model to use.

max_completion_tokens number

The upper bound limit for the number of tokens that can be generated for a completion request.

stop string[]

A sequence of strings to control when the model should stop generating additional tokens.

temperature number

The sampling temperature to use.

tool_choice union oneOf

Controls which tool is called by the model. String representation: One of auto, none, or requrired. auto allows the model to choose between calling tools and generating a message. none causes the model to not call any tools. required forces the model to call one or more tools. Example (object representation):

{
  "tool_choice": {
      "type": "function",
      "function": {
          "name": "get_current_weather"
      }
  }
}
One of:
tools object[]

A list of tools that the model can call. Example:

{
  "tools": [
      {
          "type": "function",
          "function": {
              "name": "get_price_of_item",
              "description": "Get the current price of an item",
              "parameters": {
                  "type": "object",
                  "properties": {
                      "item": {
                          "id": "12345"
                      },
                      "unit": {
                          "type": "currency"
                      }
                  }
              }
          }
      }
  ]
}
type string required

The type of tool.

function object required

The function definition.

description string

A description of what the function does. This is used by the model to choose when and how to call the function.

name string required

The name of the function.

parameters object

The parameters the functional accepts. This should be formatted as a JSON object.

strict boolean

Whether to enable schema adherence when generating the function call.

top_p number

Nucleus sampling, an alternative to sampling with temperature.

Response

application/json

Response Type: object