com.azure.search.documents.models

Package:

com.azure.search.documents.models

Maven Artifact:

com.azure:azure-search-documents:11.8.0-beta.5

Package containing the data models for SearchIndexClient. Client that can be used to query an index and upload, merge, or delete documents.

Classes

AutocompleteItem	The result of Autocomplete requests.
AutocompleteOptions	Parameter group.
AutocompleteResult	The result of Autocomplete query.
DebugInfo	Contains debugging information that can be used to further explore your search results.
DocumentDebugInfo	Contains debugging information that can be used to further explore your search results.
FacetResult	A single bucket of a facet query result.
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.
HybridSearch	TThe query parameters to configure hybrid search behaviors.
IndexAction<T>	Represents an index action that operates on a document.
IndexBatchBase<T>	Contains a batch of document write actions to send to the index.
IndexBatchException	An IndexBatchException is thrown whenever Azure AI Search index call was only partially successful.
IndexDocumentsOptions	Options for document index operations.
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.
QueryAnswerType	This parameter is only valid if the query type is `semantic`.
QueryCaption	Configuration for how semantic search captions search results.
QueryCaptionResult	Captions are the most representative passages from the document relatively to the search query.
QueryCaptionType	This parameter is only valid if the query type is `semantic`.
QueryDebugMode	Enables a debugging tool that can be used to further explore your search results.
QueryLanguage	The language of the query.
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.
QueryRewrites	Configuration for how semantic search rewrites a query.
QueryRewritesDebugInfo	Contains debugging information specific to query rewrites.
QueryRewritesType	This parameter is only valid if the query type is `semantic`.
QueryRewritesValuesDebugInfo	Contains debugging information specific to query rewrites.
QuerySpellerType	Improve search recall by spell-correcting individual search query terms.
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.
ScoringParameter	Represents a parameter value to be used in scoring functions (for example, referencePointParameter).
SearchAudience	Cloud audiences available for Search.
SearchOptions	Additional parameters for searchGet operation.
SearchResult	Contains a document found by a search query, plus associated metadata.
SearchScoreThreshold	The results of the vector query will filter based on the '@search.score' value.
SemanticDebugInfo	The SemanticDebugInfo model.
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.
SemanticQueryRewritesResultType	Type of query rewrite that was used for this request.
SemanticSearchOptions	Parameters for performing vector searches.
SemanticSearchResult	The document-level results for a SEMANTIC search.
SemanticSearchResults	The page-level results for a SEMANTIC search.
SemanticSearchResultsType	Type of partial response that was returned for a semantic ranking request.
SingleVectorFieldResult	A single vector field result.
SuggestOptions	Parameter group.
SuggestResult	A result containing a document found by a suggestion query, plus associated metadata.
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.
VectorFilterMode	Determines whether or not filters are applied before or after the vector search is performed.
VectorQuery	The query parameters for vector and hybrid search queries.
VectorQueryKind	The kind of vector query being performed.
VectorSearchOptions	Parameters for performing vector searches.
VectorSimilarityThreshold	The results of the vector query will be filtered based on the vector similarity metric.
VectorThreshold	The threshold used for vector queries.
VectorThresholdKind	The kind of vector query being performed.
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.
VectorsDebugInfo	The VectorsDebugInfo model.

Enums

AutocompleteMode	Specifies the mode for Autocomplete.
IndexActionType	The operation to perform on a document in an indexing batch.
QueryType	Specifies the syntax of the search query.
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.
SearchMode	Specifies whether any or all of the search terms must be matched in order to count the document as a match.