Class OpenAIFiles

Hierarchy (view full)

Serializable
- OpenAIFiles

Index

Constructors

constructor

Methods

createFile deleteFile listFiles retrieveFile retrieveFileContent toJSON toJSONNotImplemented

Constructors

constructor

new OpenAIFiles(fields?): OpenAIFiles
Parameters
- Optionalfields: OpenAIFilesInput
Returns OpenAIFiles
Overrides Serializable.constructor
- Defined in langchain/src/experimental/openai_files/index.ts:14

Methods

createFile

createFile(__namedParameters): Promise<FileObject & {}>
Upload file Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB.
Parameters
- __namedParameters: OpenAIClient.Files.FileCreateParams & {
  options?: RequestOptions;
  }
Returns Promise<FileObject & {}>
Note
The size of individual files can be a maximum of 512 MB. See the Assistants Tools guide to learn more about the types of files supported. The Fine-tuning API only supports .jsonl files.

Link
- Defined in langchain/src/experimental/openai_files/index.ts:31

deleteFile

deleteFile(__namedParameters): Promise<FileDeleted & {}>
Delete a file.
Parameters
- __namedParameters: {
  fileId: string;
  options?: RequestOptions;
  }
  - fileId: string
  - Optionaloptions?: RequestOptions
Returns Promise<FileDeleted & {}>
Link
- Defined in langchain/src/experimental/openai_files/index.ts:49

listFiles

listFiles(props?): Promise<FileObjectsPage>
List files Returns a list of files that belong to the user's organization.
Parameters
- Optionalprops: {
  options?: RequestOptions;
  query?: OpenAIClient.Files.FileListParams;
  }
  - Optionaloptions?: RequestOptions
  - Optionalquery?: OpenAIClient.Files.FileListParams
Returns Promise<FileObjectsPage>
Link
- Defined in langchain/src/experimental/openai_files/index.ts:68

retrieveFile

retrieveFile(__namedParameters): Promise<FileObject & {}>
Retrieve file Returns information about a specific file.
Parameters
- __namedParameters: {
  fileId: string;
  options?: RequestOptions;
  }
  - fileId: string
  - Optionaloptions?: RequestOptions
Returns Promise<FileObject & {}>
Link
- Defined in langchain/src/experimental/openai_files/index.ts:84

retrieveFileContent

retrieveFileContent(__namedParameters): Promise<string>
Retrieve file content Returns the contents of the specified file.
Parameters
- __namedParameters: {
  fileId: string;
  options?: RequestOptions;
  }
  - fileId: string
  - Optionaloptions?: RequestOptions
Returns Promise<string>
Note
You can't retrieve the contents of a file that was uploaded with the "purpose": "assistants" API.

Link
- Defined in langchain/src/experimental/openai_files/index.ts:105

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from Serializable.toJSON
- Defined in langchain-core/dist/load/serializable.d.ts:69

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from Serializable.toJSONNotImplemented
- Defined in langchain-core/dist/load/serializable.d.ts:70

Class OpenAIFiles

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OpenAIFiles

Methods

createFile

Parameters

Returns Promise<FileObject & {}>

Note

Link

deleteFile

Parameters

fileId: string

Optionaloptions?: RequestOptions

Returns Promise<FileDeleted & {}>

Link

listFiles

Parameters

Optionaloptions?: RequestOptions

Optionalquery?: OpenAIClient.Files.FileListParams

Returns Promise<FileObjectsPage>

Link

retrieveFile

Parameters

fileId: string

Optionaloptions?: RequestOptions

Returns Promise<FileObject & {}>

Link

retrieveFileContent

Parameters

fileId: string

Optionaloptions?: RequestOptions

Returns Promise<string>

Note

Link

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Settings

On This Page

`Optional`options?: RequestOptions

`Optional`options?: RequestOptions

`Optional`query?: OpenAIClient.Files.FileListParams

`Optional`options?: RequestOptions

`Optional`options?: RequestOptions