CosmosDBVectorEmbedding Class
Definition
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.
Represents a vector embedding. A vector embedding is used to define a vector field in the documents.
public class CosmosDBVectorEmbedding : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBVectorEmbedding>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBVectorEmbedding>
type CosmosDBVectorEmbedding = class
interface IJsonModel<CosmosDBVectorEmbedding>
interface IPersistableModel<CosmosDBVectorEmbedding>
Public Class CosmosDBVectorEmbedding
Implements IJsonModel(Of CosmosDBVectorEmbedding), IPersistableModel(Of CosmosDBVectorEmbedding)
- Inheritance
-
CosmosDBVectorEmbedding
- Implements
Constructors
CosmosDBVectorEmbedding(String, CosmosDBVectorDataType, VectorDistanceFunction, Int32) |
Initializes a new instance of CosmosDBVectorEmbedding. |
Properties
DataType |
Indicates the data type of vector. |
Dimensions |
The number of dimensions in the vector. |
DistanceFunction |
The distance function to use for distance calculation in between vectors. |
Path |
The path to the vector field in the document. |
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
IJsonModel<CosmosDBVectorEmbedding>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<CosmosDBVectorEmbedding>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<CosmosDBVectorEmbedding>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<CosmosDBVectorEmbedding>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<CosmosDBVectorEmbedding>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |