Class Completions

Hierarchy

APIResource
- Completions

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected`_client

_client: OpenAI

Methods

create

create(body, options?): APIPromise<ChatCompletion>
Creates a model response for the given chat conversation.
Parameters
- body: OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ChatCompletion>
- Defined in node_modules/openai/resources/chat/completions.d.ts:13
create(body, options?): APIPromise<Stream<ChatCompletionChunk>>
Parameters
- body: OpenAI.Chat.Completions.ChatCompletionCreateParamsStreaming
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Stream<ChatCompletionChunk>>
- Defined in node_modules/openai/resources/chat/completions.d.ts:14
create(body, options?): APIPromise<ChatCompletion | Stream<ChatCompletionChunk>>
Parameters
- body: ChatCompletionCreateParamsBase
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ChatCompletion | Stream<ChatCompletionChunk>>
- Defined in node_modules/openai/resources/chat/completions.d.ts:15