AgentsClient.ModifyVectorStoreAsync Method

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

ModifyVectorStoreAsync(String, String, VectorStoreExpirationPolicy, IReadOnlyDictionary<String,String>, CancellationToken)

The ID of the vector store to modify.

ModifyVectorStoreAsync(String, RequestContent, RequestContext)

[Protocol Method] The ID of the vector store to modify.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Please try the simpler ModifyVectorStoreAsync(String, String, VectorStoreExpirationPolicy, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.

ModifyVectorStoreAsync(String, String, VectorStoreExpirationPolicy, IReadOnlyDictionary<String,String>, CancellationToken)

Source:: AgentsClient.cs

The ID of the vector store to modify.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.VectorStore>> ModifyVectorStoreAsync (string vectorStoreId, string name = default, Azure.AI.Projects.VectorStoreExpirationPolicy expiresAfter = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ModifyVectorStoreAsync : string * string * Azure.AI.Projects.VectorStoreExpirationPolicy * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.VectorStore>>
override this.ModifyVectorStoreAsync : string * string * Azure.AI.Projects.VectorStoreExpirationPolicy * System.Collections.Generic.IReadOnlyDictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.VectorStore>>

Public Overridable Function ModifyVectorStoreAsync (vectorStoreId As String, Optional name As String = Nothing, Optional expiresAfter As VectorStoreExpirationPolicy = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VectorStore))

Parameters

vectorStoreId: String

Identifier of the vector store.

name: String

The name of the vector store.

expiresAfter: VectorStoreExpirationPolicy

Details on when this vector store expires.

metadata: IReadOnlyDictionary<String,String>

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.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<VectorStore>>

Exceptions

ArgumentNullException

vectorStoreId is null.

ArgumentException

vectorStoreId is an empty string, and was expected to be non-empty.

Applies to

ModifyVectorStoreAsync(String, RequestContent, RequestContext)

Source:: AgentsClient.cs

[Protocol Method] The ID of the vector store to modify.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Please try the simpler ModifyVectorStoreAsync(String, String, VectorStoreExpirationPolicy, IReadOnlyDictionary<String,String>, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> ModifyVectorStoreAsync (string vectorStoreId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member ModifyVectorStoreAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.ModifyVectorStoreAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function ModifyVectorStoreAsync (vectorStoreId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)