Chat with an assistant
The chat_assistant
endpoint allows you to chat with an assistant and get back citations in structured form.
This is the recommended way to chat with an assistant, as it offers more functionality and control over the assistant’s responses and references than the chat_completion_assistant
endpoint.
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 ChatCompletionCitationModel describes the response format of a chat request from the citation api
stop
, length
, content_filter
, function_call
The MessageModel describes the format of a message in a chat
The UsageModel describes the usage of a chat completion
Was this page helpful?