QdrantVectorDbClient.GetVectorByPayloadIdAsync Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Qdrant

Assembly:: Microsoft.SemanticKernel.Connectors.Qdrant.dll

Package:: Microsoft.SemanticKernel.Connectors.Qdrant v1.20.0-alpha

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.

Get a specific vector by a unique identifier in the metadata (Qdrant payload).

public System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Qdrant.QdrantVectorRecord?> GetVectorByPayloadIdAsync (string collectionName, string metadataId, bool withVector = false, System.Threading.CancellationToken cancellationToken = default);

abstract member GetVectorByPayloadIdAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Qdrant.QdrantVectorRecord>
override this.GetVectorByPayloadIdAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Qdrant.QdrantVectorRecord>

Public Function GetVectorByPayloadIdAsync (collectionName As String, metadataId As String, Optional withVector As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of QdrantVectorRecord)

Parameters

collectionName: String

The name assigned to a collection of vectors.

metadataId: String

The unique ID stored in a Qdrant vector entry's metadata.

withVector: Boolean

Whether to include the vector data in the returned result.

cancellationToken: CancellationToken

The CancellationToken to monitor for cancellation requests. The default is None.

Returns

Task<QdrantVectorRecord>

The Qdrant vector record associated with the given ID if found, null if not.

Implements

GetVectorByPayloadIdAsync(String, String, Boolean, CancellationToken)

Applies to

Partager via