Class Completions

Hierarchy

  • APIResource
    • Completions

Constructors

constructor

Properties

_client

Methods

runFunctions runTools stream

Constructors

constructor

Properties

Protected _client

_client: openai.OpenAI

Methods

runFunctions

  • runFunctions<FunctionsArgs>(body, options?): ChatCompletionRunner

  • Type Parameters

    • FunctionsArgs extends BaseFunctionsArgs

    Parameters

    Returns ChatCompletionRunner

    Deprecated

    • use runTools instead.
  • runFunctions<FunctionsArgs>(body, options?): ChatCompletionStreamingRunner

  • Type Parameters

    • FunctionsArgs extends BaseFunctionsArgs

    Parameters

    Returns ChatCompletionStreamingRunner

runTools

  • runTools<FunctionsArgs>(body, options?): ChatCompletionRunner

  • A convenience helper for using tool calls with the /chat/completions endpoint which automatically calls the JavaScript functions you provide and sends their results back to the /chat/completions endpoint, looping as long as the model requests function calls.

    For more details and examples, see the docs

    Type Parameters

    • FunctionsArgs extends BaseFunctionsArgs

    Parameters

    Returns ChatCompletionRunner

  • runTools<FunctionsArgs>(body, options?): ChatCompletionStreamingRunner

  • Type Parameters

    • FunctionsArgs extends BaseFunctionsArgs

    Parameters

    Returns ChatCompletionStreamingRunner

stream

  • stream(body, options?): ChatCompletionStream

  • Creates a chat completion stream

    Parameters

    • body: ChatCompletionStreamParams
    • Optional options: RequestOptions<unknown>

    Returns ChatCompletionStream

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc