@ralphschuler.ai function caller.index.<internal>.OpenAI.Beta.Assistants

Class: Assistants

OpenAI.Beta.Assistants

Hierarchy

• APIResource

  ↳ Assistants

Table of contents

Constructors

• constructor

Properties

• _client
• files

Methods

• create
• del
• list
• retrieve
• update

Constructors

constructor

• new Assistants(client): Assistants

Parameters

Name	Type
client	OpenAI

Returns

Assistants

Inherited from

APIResource.constructor

Defined in

node_modules/openai/resource.d.ts:4

Properties

_client

• Protected _client: OpenAI

Inherited from

APIResource._client

Defined in

node_modules/openai/resource.d.ts:3

---

files

• files: Files

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:8

Methods

create

▸ create(body, options?): APIPromise<Assistant>

Create an assistant with a model and instructions.

Parameters

Name	Type
body	AssistantCreateParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<Assistant>

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:12

---

del

▸ del(assistantId, options?): APIPromise<AssistantDeleted>

Delete an assistant.

Parameters

Name	Type
assistantId	string
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<AssistantDeleted>

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:29

---

list

▸ list(query?, options?): PagePromise<AssistantsPage, Assistant>

Returns a list of assistants.

Parameters

Name	Type
query?	AssistantListParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<AssistantsPage, Assistant>

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:24

▸ list(options?): PagePromise<AssistantsPage, Assistant>

Parameters

Name	Type
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<AssistantsPage, Assistant>

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:25

---

retrieve

▸ retrieve(assistantId, options?): APIPromise<Assistant>

Retrieves an assistant.

Parameters

Name	Type
assistantId	string
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<Assistant>

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:16

---

update

▸ update(assistantId, body, options?): APIPromise<Assistant>

Modifies an assistant.

Parameters

Name	Type
assistantId	string
body	AssistantUpdateParams
options?	RequestOptions<Readable | Record<string, unknown>>

Returns

APIPromise<Assistant>

Defined in

node_modules/openai/resources/beta/assistants/assistants.d.ts:20