Chat through an OpenAI-compatible interface
The chat_completion_assistant
endpoint is used to chat with an assistant. This endpoint is based on the OpenAI Chat Completion API, a commonly used and adopted API.
It is useful if you need inline citations or OpenAI-compatible responses, but has limited functionality compared to the chat_assistant
operation.
Authorizations
Pinecone API Key
Path Parameters
The name of the assistant to be described.
Body
The list of queries / chat's to chat an assistant
If false, the assistant will return a single JSON response. If true, the assistant will return a stream of responses.
The large language model to use for answer generation
gpt-4o
, claude-3-5-sonnet
Optionally filter which documents can be used in this query.
Response
The ChatCompletionModel describes the response format of a chat request
The UsageModel describes the usage of a chat completion
Was this page helpful?