Skip to content

@ralphschuler.ai function caller.index.<internal>.OpenAI.Beta.Threads.Messages.Files

github-actions edited this page Nov 26, 2023 · 1 revision

Class: Files

Threads.Messages.Files

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Files(client): Files

Parameters

Name Type
client OpenAI

Returns

Files

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

Methods

list

list(threadId, messageId, query?, options?): PagePromise<MessageFilesPage, MessageFile>

Returns a list of message files.

Parameters

Name Type
threadId string
messageId string
query? FileListParams
options? RequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<MessageFilesPage, MessageFile>

Defined in

node_modules/openai/resources/beta/threads/messages/files.d.ts:13

list(threadId, messageId, options?): PagePromise<MessageFilesPage, MessageFile>

Parameters

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

Returns

PagePromise<MessageFilesPage, MessageFile>

Defined in

node_modules/openai/resources/beta/threads/messages/files.d.ts:14


retrieve

retrieve(threadId, messageId, fileId, options?): APIPromise<MessageFile>

Retrieves a message file.

Parameters

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

Returns

APIPromise<MessageFile>

Defined in

node_modules/openai/resources/beta/threads/messages/files.d.ts:9

Typescript Libraries

Modules

Namespaces

Clone this wiki locally