Class Completions

Hierarchy

  • APIResource
    • Completions

Constructors

constructor

Methods

parse runFunctions runTools stream

Constructors

constructor

Methods

parse

runFunctions

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

  • Type Parameters

    • FunctionsArgs extends BaseFunctionsArgs

    Parameters

    Returns ChatCompletionRunner<null>

    Deprecated

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

  • Type Parameters

    • FunctionsArgs extends BaseFunctionsArgs

    Parameters

    Returns ChatCompletionStreamingRunner<null>

runTools

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

  • 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

    • Params extends ChatCompletionToolRunnerParams<any>
    • ParsedT = ExtractParsedContentFromParams<Params>

    Parameters

    Returns ChatCompletionRunner<ParsedT>

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

  • Type Parameters

    • Params extends ChatCompletionStreamingToolRunnerParams<any>
    • ParsedT = ExtractParsedContentFromParams<Params>

    Parameters

    Returns ChatCompletionStreamingRunner<ParsedT>

stream

  • stream<Params, ParsedT>(body, options?): ChatCompletionStream<ParsedT>

  • Creates a chat completion stream

    Type Parameters

    • Params extends ChatCompletionStreamParams
    • ParsedT = ExtractParsedContentFromParams<Params>

    Parameters

    Returns ChatCompletionStream<ParsedT>

Settings

Member Visibility

On This Page

Constructors
Methods