Share via

CreateVectorStoreOptionalParams interface

  • Reference
Package:
@azure/ai-projects

Optional parameters creating vector store.

Extends

VectorStoreOptions,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. Only applicable if file_ids is non-empty.
configuration

The vector store configuration, used when vector store is created from Azure asset URIs.
expiresAfter

Details on when this vector store expires
fileIds

A list of file IDs that the vector store should use. Useful for tools like file_search that can access files.
metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
name

The name of the vector store.
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. Only applicable if file_ids is non-empty.

chunkingStrategy?: VectorStoreChunkingStrategyRequest

Property Value

VectorStoreChunkingStrategyRequest

Inherited From VectorStoreOptions.chunkingStrategy

configuration

The vector store configuration, used when vector store is created from Azure asset URIs.

configuration?: VectorStoreConfiguration

Property Value

VectorStoreConfiguration

Inherited From VectorStoreOptions.configuration

expiresAfter

Details on when this vector store expires

expiresAfter?: VectorStoreExpirationPolicy

Property Value

VectorStoreExpirationPolicy

Inherited From VectorStoreOptions.expiresAfter

fileIds

A list of file IDs that the vector store should use. Useful for tools like file_search that can access files.

fileIds?: string[]

Property Value

string[]

Inherited From VectorStoreOptions.fileIds

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

Inherited From VectorStoreOptions.metadata

name

The name of the vector store.

name?: string

Property Value

string

Inherited From VectorStoreOptions.name

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