다음을 통해 공유


Azure.Search.Documents.Models Namespace

Classes

AutocompleteItem

The result of Autocomplete requests.

AutocompleteResults

The result of Autocomplete query.

DocumentDebugInfo

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

FacetResult

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.

HybridSearch

TThe query parameters to configure hybrid search behaviors.

IndexActionCompletedEventArgs<T>

Provides data for ActionCompleted event.

IndexActionEventArgs<T>

Provides data for ActionAdded and ActionSent events.

IndexActionFailedEventArgs<T>

Provides data for ActionCompleted event.

IndexDocumentsAction

Creates IndexDocumentsAction<T> instances to add to an IndexDocumentsBatch<T> and submit via IndexDocuments<T>(IndexDocumentsBatch<T>, IndexDocumentsOptions, CancellationToken).

IndexDocumentsAction<T>

Represents an index action that operates on a document.

IndexDocumentsBatch

Creates IndexDocumentsBatch<T> instances to update search indexes via IndexDocuments<T>(IndexDocumentsBatch<T>, IndexDocumentsOptions, CancellationToken).

IndexDocumentsBatch<T>

Contains a batch of document write actions to send to a search index via IndexDocuments<T>(IndexDocumentsBatch<T>, IndexDocumentsOptions, CancellationToken).

IndexDocumentsResult

Response containing the status of operations for all documents in the indexing request.

IndexingResult

Status of an indexing operation for a single document.

QueryAnswer

Configuration for how semantic search returns answers to the search.

QueryAnswerResult

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.

QueryCaption

Configuration for how semantic search captions search results.

QueryCaptionResult

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.

QueryResultDocumentRerankerInput

The raw concatenated strings that were sent to the semantic enrichment process.

QueryResultDocumentSemanticField

Description of fields that were sent to the semantic enrichment process, as well as how they were used.

QueryResultDocumentSubscores

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.

RangeFacetResult<T>

A single bucket of a range facet query result that reports the number of documents with a field value falling within a particular range.

ResetDocumentOptions

The DocumentKeysOrIds.

ResetSkillsOptions

The SkillNames.

SearchDocument

Represents an untyped document returned from a search or document lookup. It can be accessed as either a dynamic object or a dictionary.

SearchModelFactory

Model factory for models.

SearchResult<T>

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

SearchResults<T>

Response containing search results from an index.

SearchResultsPage<T>

A page of SearchResult<T>s returned from GetResultsAsync()'s AsPages(String, Nullable<Int32>) method.

SearchScoreThreshold

The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score.

SearchSuggestion<T>

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

SemanticDebugInfo

The SemanticDebugInfo.

SemanticSearchOptions

Options for performing Semantic Search.

SemanticSearchResult

Semantic search result.

SemanticSearchResults

Semantic search results from an index.

SingleVectorFieldResult

A single vector field result. Both @search.score and vector similarity values are returned. Vector similarity is related to @search.score by an equation.

SuggestResults<T>

Response containing suggestion query results from an index.

TextResult

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

ValueFacetResult<T>

A single bucket of a simple or interval facet query result that reports the number of documents with a field falling within a particular interval or having a specific value.

VectorizableImageBinaryQuery

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

VectorizableImageUrlQuery

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

VectorizableTextQuery

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

VectorizedQuery

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

VectorQuery

The query parameters for vector and hybrid search queries. Please note VectorQuery is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VectorizableImageBinaryQuery, VectorizableImageUrlQuery, VectorizableTextQuery and VectorizedQuery.

VectorsDebugInfo

The VectorsDebugInfo.

VectorSearchOptions

Options for performing Vector Search.

VectorSimilarityThreshold

The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field.

VectorThreshold

The threshold used for vector queries. Please note VectorThreshold is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchScoreThreshold and VectorSimilarityThreshold.

Structs

HybridCountAndFacetMode

Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. The default value is 'countAllResults'.

QueryAnswerType

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-&lt;number of answers&gt; 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-&lt;confidence threshold&gt; option after the answers parameter value, such as extractive|threshold-0.9. Default threshold is 0.7.

QueryCaptionType

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-&lt;true/false&gt; option, such as extractive|highlight-true. Defaults to None.

QueryDebugMode

Enables a debugging tool that can be used to further explore your search results.

QueryLanguage

The language of the query.

QuerySpellerType

Improve search recall by spell-correcting individual search query terms.

SemanticErrorMode

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

SemanticErrorReason

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

SemanticFieldState

The way the field was used for the semantic enrichment process.

SemanticSearchResultsType

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

VectorFilterMode

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

Enums

AutocompleteMode

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.

FacetType

Specifies the type of a facet query result.

IndexActionType

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

ScoringStatistics

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.

SearchMode

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

SearchQueryType

Specifies the syntax of the search query. The default is "simple". Use "full" if your query uses the Lucene query syntax.