SemanticConfiguration Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.6

Source:: SemanticConfiguration.cs

Source:: SemanticConfiguration.cs

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.

Defines a specific configuration to be used in the context of semantic capabilities.

public class SemanticConfiguration

public class SemanticConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SemanticConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SemanticConfiguration>

type SemanticConfiguration = class

type SemanticConfiguration = class
    interface IJsonModel<SemanticConfiguration>
    interface IPersistableModel<SemanticConfiguration>

Public Class SemanticConfiguration

Public Class SemanticConfiguration
Implements IJsonModel(Of SemanticConfiguration), IPersistableModel(Of SemanticConfiguration)

Inheritance: Object
SemanticConfiguration

Implements: IJsonModel<SemanticConfiguration> IPersistableModel<SemanticConfiguration> IPersistableModel<T>

Constructors

SemanticConfiguration(String, SemanticPrioritizedFields)

Initializes a new instance of SemanticConfiguration.

Properties

FlightingOptIn	Determines which semantic or query rewrite models to use during model flighting/upgrades.
Name	The name of the semantic configuration.
PrioritizedFields	Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set.
RankingOrder	Specifies the score type to be used for the sort order of the search results.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SemanticConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<SemanticConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<SemanticConfiguration>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<SemanticConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<SemanticConfiguration>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to