Class Completions

Hierarchy

APIResource
- Completions

Index

Constructors

Methods

parse runFunctions runTools stream

Constructors

constructor

new Completions(client): OpenAIClient.Beta.Chat.Completions
Parameters
- client: OpenAI
Returns OpenAIClient.Beta.Chat.Completions
Inherited from APIResource.constructor
- Defined in libs/langchain-openai/node_modules/openai/resource.d.ts:4

Methods

parse

parse<Params, ParsedT>(body, options?): APIPromise<ParsedChatCompletion<ParsedT>>
Type Parameters
- Params extends OpenAIClient.Chat.Completions.ChatCompletionCreateParamsNonStreaming
- ParsedT = ExtractParsedContentFromParams<Params>
Parameters
- body: Params
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ParsedChatCompletion<ParsedT>>
- Defined in libs/langchain-openai/node_modules/openai/resources/beta/chat/completions.d.ts:36

runFunctions

runFunctions<FunctionsArgs>(body, options?): ChatCompletionRunner<null>
Type Parameters
- FunctionsArgs extends BaseFunctionsArgs
Parameters
- body: ChatCompletionFunctionRunnerParams<FunctionsArgs>
- Optionaloptions: RequestOptions<unknown>
Returns ChatCompletionRunner<null>
Deprecated
- use runTools instead.
- Defined in libs/langchain-openai/node_modules/openai/resources/beta/chat/completions.d.ts:40
runFunctions<FunctionsArgs>(body, options?): ChatCompletionStreamingRunner<null>
Type Parameters
- FunctionsArgs extends BaseFunctionsArgs
Parameters
- body: ChatCompletionStreamingFunctionRunnerParams<FunctionsArgs>
- Optionaloptions: RequestOptions<unknown>
Returns ChatCompletionStreamingRunner<null>
- Defined in libs/langchain-openai/node_modules/openai/resources/beta/chat/completions.d.ts:41

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
- body: Params
- Optionaloptions: RunnerOptions
Returns ChatCompletionRunner<ParsedT>
- Defined in libs/langchain-openai/node_modules/openai/resources/beta/chat/completions.d.ts:51
runTools<Params, ParsedT>(body, options?): ChatCompletionStreamingRunner<ParsedT>
Type Parameters
- Params extends ChatCompletionStreamingToolRunnerParams<any>
- ParsedT = ExtractParsedContentFromParams<Params>
Parameters
- body: Params
- Optionaloptions: RunnerOptions
Returns ChatCompletionStreamingRunner<ParsedT>
- Defined in libs/langchain-openai/node_modules/openai/resources/beta/chat/completions.d.ts:52

stream

stream<Params, ParsedT>(body, options?): ChatCompletionStream<ParsedT>
Creates a chat completion stream
Type Parameters
- Params extends ChatCompletionStreamParams
- ParsedT = ExtractParsedContentFromParams<Params>
Parameters
- body: Params
- Optionaloptions: RequestOptions<unknown>
Returns ChatCompletionStream<ParsedT>
- Defined in libs/langchain-openai/node_modules/openai/resources/beta/chat/completions.d.ts:56