models Package

The result of Autocomplete requests.

Contains debugging information that can be used to further explore your search results.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval.

Represents an index action that operates on a document.

Represent a batch of update operations for documents in an Azure Search index.

Index operations are performed in the order in which they are added to the batch.

Status of an indexing operation for a single document.

A document retrieved via a document lookup operation.

An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected.

Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type semantic.

The breakdown of subscores between the text and vector query components of the search query for this document. Each vector query is shown as a separate object in the same order they were received.

Contains a document found by a search query, plus associated metadata.

A single vector field result. Both.

A result containing a document found by a suggestion query, plus associated metadata.

The BM25 or Classic score for the text portion of the query.

The query parameters for vector and hybrid search queries.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: VectorizableImageBinaryQuery, VectorizableImageUrlQuery, VectorizableTextQuery, VectorizedQuery

The query parameters to use for vector search when a base 64 encoded binary of an image that needs to be vectorized is provided.

The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided.

The query parameters to use for vector search when a text value that needs to be vectorized is provided.

The query parameters to use for vector search when a raw vector value is provided.

"Contains debugging information specific to vector and hybrid search.").

Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms.

The operation to perform on a document in an indexing batch.

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. The maximum character length of answers can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.

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. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.

Enables a debugging tool that can be used to further explore your search results. You can enable multiple debug modes simultaneously by separating them with a | character, for example: semantic|queryRewrites.

Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed.

A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries.

Specifies whether any or all of the search terms must be matched in order to count the document as a match.

Allows the user to choose whether a semantic call should fail completely, or to return partial results.

Reason that a partial response was returned for a semantic ranking request.

Type of partial response that was returned for a semantic ranking request.

Determines whether or not filters are applied before or after the vector search is performed.

The kind of vector query being performed.