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

    Class ChatStream<Item>

    An async iterable of assistant response chunks.

    Obtain it from Assistant.chatStream or Assistant.chatCompletionStream; do not construct it directly. Unlike a complete chat response, it yields updates as they arrive.

    import { Pinecone } from '@pinecone-database/pinecone';
    const pc = new Pinecone();
    const assistant = pc.assistant({ name: 'support-guide' });
    const stream = await assistant.chatStream({ messages: ['How do I return an order?'] });
    for await (const chunk of stream) console.log(chunk);

    Type Parameters

    • Item

      The response chunk yielded during iteration.

    Implements

    • AsyncIterable<Item>
    Index
    [asyncIterator]

    • Iterates over response chunks as they arrive.

      Returns AsyncIterator<Item>

      An iterator over the response chunks.

      import { Pinecone } from '@pinecone-database/pinecone';
      const pc = new Pinecone();
      const assistant = pc.assistant({ name: 'support-guide' });
      const stream = await assistant.chatStream({ messages: ['How do I return an order?'] });
      for await (const chunk of stream) console.log(chunk);

    Settings
    Member Visibility

    On This Page
    Methods