SemanticSearchOptions Class

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

SemanticSearchOptions.cs

Options for performing Semantic Search.

public class SemanticSearchOptions

type SemanticSearchOptions = class

Public Class SemanticSearchOptions

Inheritance

Object

SemanticSearchOptions

Constructors

SemanticSearchOptions()

Properties

ErrorMode	Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results.
MaxWait	Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.
QueryAnswer	This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents.The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-(number of answers)' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-(confidence threshold)' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7.
QueryCaption	This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-(true/false)' option, such as 'extractive|highlight-true'. Defaults to 'None'.
SemanticConfigurationName	The name of a semantic configuration that will be used when processing documents for queries of type semantic.
SemanticQuery	Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase.