Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Interface ChatOptions

    Messages and response settings for Assistant.chat and Assistant.chatStream.

    import type { ChatOptions } from '@pinecone-database/pinecone';
    const options: ChatOptions = { messages: ['How do I return an order?'] };
    interface ChatOptions {
        contextOptions?: ChatContextOptions;
        filter?: object;
        includeHighlights?: boolean;
        jsonResponse?: boolean;
        messages: MessagesModel;
        model?: string;
        temperature?: number;
    }
    Index
    contextOptions? filter? includeHighlights? jsonResponse? messages model? temperature?
    contextOptions?: ChatContextOptions

    Controls the context snippets used to generate an answer.

    filter?: object

    Filter the files used for retrieval by metadata, such as { category: 'returns' }.

    includeHighlights?: boolean

    Request highlighted passages from the source files that support the answer.

    jsonResponse?: boolean

    Request a JSON answer with Assistant.chat; unavailable for streaming.

    messages: MessagesModel

    The MessagesModel to send to the Assistant. Can be a list of strings or a list of objects. If sent as a list of objects, must have exactly two keys: role and content. The role key can only be one of user or assistant.

    model?: string

    The large language model to use for answer generation

    temperature?: number

    Controls response variability where supported by the model. Lower values favor more consistent answers.

    Settings
    Member Visibility

    On This Page
    Properties