Share via


SemanticPrioritizedFields Class

Definition

Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.

public class SemanticPrioritizedFields : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SemanticPrioritizedFields>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SemanticPrioritizedFields>
type SemanticPrioritizedFields = class
    interface IJsonModel<SemanticPrioritizedFields>
    interface IPersistableModel<SemanticPrioritizedFields>
Public Class SemanticPrioritizedFields
Implements IJsonModel(Of SemanticPrioritizedFields), IPersistableModel(Of SemanticPrioritizedFields)
Inheritance
SemanticPrioritizedFields
Implements

Constructors

Name Description
SemanticPrioritizedFields()

Initializes a new instance of SemanticPrioritizedFields.

Properties

Name Description
ContentFields

Defines the content fields to be used for semantic ranking, captions, highlights, and answers.

For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long.

KeywordsFields

Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers.

For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long.

TitleField

Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank.

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SemanticPrioritizedFields>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SemanticPrioritizedFields>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SemanticPrioritizedFields>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SemanticPrioritizedFields>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SemanticPrioritizedFields>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to