Share via

UpdateVectorStoreOptionalParams interface

  • Reference
Package:
@azure/ai-projects

Optional parameters for updating a vector store.

Extends

VectorStoreUpdateOptions,OperationOptions

Inherited Properties

abortSignal

The signal which can be used to abort requests.
expiresAfter

Details on when this vector store expires
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.
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

expiresAfter

Details on when this vector store expires

expiresAfter?: null | VectorStoreExpirationPolicy

Property Value

null | VectorStoreExpirationPolicy

Inherited From VectorStoreUpdateOptions.expiresAfter

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 VectorStoreUpdateOptions.metadata

name

The name of the vector store.

name?: null | string

Property Value

null | string

Inherited From VectorStoreUpdateOptions.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

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