Class Assistants

Hierarchy

APIResource
- Assistants

Index

Constructors

Methods

create del list retrieve update

Constructors

constructor

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

Methods

create

create(body, options?): APIPromise<OpenAIClient.Beta.Assistants.Assistant>
Create an assistant with a model and instructions.
Parameters
- body: AssistantCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<OpenAIClient.Beta.Assistants.Assistant>
- Defined in node_modules/openai/resources/beta/assistants.d.ts:13

del

del(assistantId, options?): APIPromise<AssistantDeleted>
Delete an assistant.
Parameters
- assistantId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AssistantDeleted>
- Defined in node_modules/openai/resources/beta/assistants.d.ts:30

list

list(query?, options?): PagePromise<AssistantsPage, OpenAIClient.Beta.Assistants.Assistant>
Returns a list of assistants.
Parameters
- Optionalquery: AssistantListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<AssistantsPage, OpenAIClient.Beta.Assistants.Assistant>
- Defined in node_modules/openai/resources/beta/assistants.d.ts:25
list(options?): PagePromise<AssistantsPage, OpenAIClient.Beta.Assistants.Assistant>
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<AssistantsPage, OpenAIClient.Beta.Assistants.Assistant>
- Defined in node_modules/openai/resources/beta/assistants.d.ts:26

retrieve

retrieve(assistantId, options?): APIPromise<OpenAIClient.Beta.Assistants.Assistant>
Retrieves an assistant.
Parameters
- assistantId: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<OpenAIClient.Beta.Assistants.Assistant>
- Defined in node_modules/openai/resources/beta/assistants.d.ts:17

update

update(assistantId, body, options?): APIPromise<OpenAIClient.Beta.Assistants.Assistant>
Modifies an assistant.
Parameters
- assistantId: string
- body: AssistantUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<OpenAIClient.Beta.Assistants.Assistant>
- Defined in node_modules/openai/resources/beta/assistants.d.ts:21