Share via

CreateVectorStoreFileOptionalParams interface

  • Reference
Package:
@azure/ai-projects

Optional parameters for creating a vector store file.

Extends

CreateVectorStoreFileOptions,OperationOptions,PollingOptionsParams

Inherited Properties

abortSignal

The signal which can be used to abort requests.
chunkingStrategy

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.
dataSources

The data sources to be used. This option is mutually exclusive with fileId.
fileId

A File ID that the vector store should use. Useful for tools like file_search that can access files.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
pollingOptions

Options for configuring polling behavior.
requestOptions

Options used when creating and sending HTTP requests for this operation.
tracingOptions

Options used when tracing is enabled.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

chunkingStrategy

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.

chunkingStrategy?: VectorStoreChunkingStrategyRequest

Property Value

VectorStoreChunkingStrategyRequest

Inherited From CreateVectorStoreFileOptions.chunkingStrategy

dataSources

The data sources to be used. This option is mutually exclusive with fileId.

dataSources?: VectorStoreDataSource[]

Property Value

VectorStoreDataSource[]

Inherited From CreateVectorStoreFileOptions.dataSources

fileId

A File ID that the vector store should use. Useful for tools like file_search that can access files.

fileId?: string

Property Value

string

Inherited From CreateVectorStoreFileOptions.fileId

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

pollingOptions

Options for configuring polling behavior.

pollingOptions?: PollingOptions

Property Value

PollingOptions

Inherited From PollingOptionsParams.pollingOptions

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions