SingleVectorFieldResult 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.
A single vector field result. Both @search.score and vector similarity values are returned. Vector similarity is related to @search.score by an equation.
public class SingleVectorFieldResult : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Models.SingleVectorFieldResult>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Models.SingleVectorFieldResult>type SingleVectorFieldResult = class
interface IJsonModel<SingleVectorFieldResult>
interface IPersistableModel<SingleVectorFieldResult>Public Class SingleVectorFieldResult
Implements IJsonModel(Of SingleVectorFieldResult), IPersistableModel(Of SingleVectorFieldResult)- Inheritance
-
SingleVectorFieldResult
- Implements
Properties
| SearchScore |
The @search.score value that is calculated from the vector similarity score. This is the score that's visible in a pure single-field single-vector query. |
| VectorSimilarity |
The vector similarity score for this document. Note this is the canonical definition of similarity metric, not the 'distance' version. For example, cosine similarity instead of cosine distance. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
| IJsonModel<SingleVectorFieldResult>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SingleVectorFieldResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SingleVectorFieldResult>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SingleVectorFieldResult>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SingleVectorFieldResult>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
