@azure/search-documents 12.3.0-beta.1 → 13.1.0-beta.1

package/dist/browser/models/azure/search/documents/models.d.ts

@@ -0,0 +1,1001 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export interface ErrorResponse {
+    /** The error object. */
+    error?: ErrorDetail;
+}
+export declare function errorResponseDeserializer(item: any): ErrorResponse;
+/** The error detail. */
+export interface ErrorDetail {
+    /** The error code. */
+    readonly code?: string;
+    /** The error message. */
+    readonly message?: string;
+    /** The error target. */
+    readonly target?: string;
+    /** The error details. */
+    readonly details?: ErrorDetail[];
+    /** The error additional info. */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+export declare function errorDetailDeserializer(item: any): ErrorDetail;
+export declare function errorDetailArrayDeserializer(result: Array<ErrorDetail>): any[];
+export declare function errorAdditionalInfoArrayDeserializer(result: Array<ErrorAdditionalInfo>): any[];
+/** The resource management error additional info. */
+export interface ErrorAdditionalInfo {
+    /** The additional info type. */
+    readonly type?: string;
+    /** The additional info. */
+    readonly info?: Record<string, unknown>;
+}
+export declare function errorAdditionalInfoDeserializer(item: any): ErrorAdditionalInfo;
+/** Response containing search results from an index. */
+export interface SearchDocumentsResult {
+    /** The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if the query can't return all the requested documents in a single response. */
+    readonly count?: number;
+    /** A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. */
+    readonly coverage?: number;
+    /** The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions. */
+    readonly facets?: Record<string, FacetResult[]>;
+    /** The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. */
+    readonly answers?: QueryAnswerResult[];
+    /** Debug information that applies to the search results as a whole. */
+    readonly debugInfo?: DebugInfo;
+    /** Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with */
+    readonly nextPageParameters?: SearchRequest;
+    /** The sequence of results returned by the query. */
+    readonly results: SearchResult[];
+    /** Continuation URL returned when the query can't return all the requested results in a single response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. */
+    readonly nextLink?: string;
+    /** Reason that a partial response was returned for a semantic ranking request. */
+    readonly semanticPartialResponseReason?: SemanticErrorReason;
+    /** Type of partial response that was returned for a semantic ranking request. */
+    readonly semanticPartialResponseType?: SemanticSearchResultsType;
+    /** Type of query rewrite that was used to retrieve documents. */
+    readonly semanticQueryRewritesResultType?: SemanticQueryRewritesResultType;
+}
+export declare function searchDocumentsResultSerializer(_item: SearchDocumentsResult): any;
+export declare function searchDocumentsResultDeserializer(item: any): SearchDocumentsResult;
+export declare function facetResultArrayRecordSerializer(item: Record<string, Array<FacetResult>>): Record<string, any>;
+export declare function facetResultArrayRecordDeserializer(item: Record<string, any>): Record<string, Array<FacetResult>>;
+export declare function facetResultArraySerializer(result: Array<FacetResult>): any[];
+export declare function facetResultArrayDeserializer(result: Array<FacetResult>): any[];
+/** 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. */
+export interface FacetResult {
+    /** The approximate count of documents falling within the bucket described by this facet. */
+    readonly count?: number;
+    /** The resulting total avg for the facet when a avg metric is requested. */
+    readonly avg?: number;
+    /** The resulting total min for the facet when a min metric is requested. */
+    readonly min?: number;
+    /** The resulting total max for the facet when a max metric is requested. */
+    readonly max?: number;
+    /** The resulting total sum for the facet when a sum metric is requested. */
+    readonly sum?: number;
+    /** The resulting total cardinality for the facet when a cardinality metric is requested. */
+    readonly cardinality?: number;
+    /** The nested facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not contain any nested facets. */
+    readonly facets?: Record<string, FacetResult[]>;
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function facetResultSerializer(item: FacetResult): any;
+export declare function facetResultDeserializer(item: any): FacetResult;
+export declare function queryAnswerResultArraySerializer(result: Array<QueryAnswerResult>): any[];
+export declare function queryAnswerResultArrayDeserializer(result: Array<QueryAnswerResult>): any[];
+/** 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. */
+export interface QueryAnswerResult {
+    /** The score value represents how relevant the answer is to the query relative to other answers returned for the query. */
+    readonly score?: number;
+    /** The key of the document the answer was extracted from. */
+    readonly key?: string;
+    /** The text passage extracted from the document contents as the answer. */
+    readonly text?: string;
+    /** Same text passage as in the Text property with highlighted text phrases most relevant to the query. */
+    readonly highlights?: string;
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function queryAnswerResultSerializer(item: QueryAnswerResult): any;
+export declare function queryAnswerResultDeserializer(item: any): QueryAnswerResult;
+/** Contains debugging information that can be used to further explore your search results. */
+export interface DebugInfo {
+    /** Contains debugging information specific to query rewrites. */
+    readonly queryRewrites?: QueryRewritesDebugInfo;
+}
+export declare function debugInfoSerializer(_item: DebugInfo): any;
+export declare function debugInfoDeserializer(item: any): DebugInfo;
+/** Contains debugging information specific to query rewrites. */
+export interface QueryRewritesDebugInfo {
+    /** List of query rewrites generated for the text query. */
+    readonly text?: QueryRewritesValuesDebugInfo;
+    /** List of query rewrites generated for the vectorizable text queries. */
+    readonly vectors?: QueryRewritesValuesDebugInfo[];
+}
+export declare function queryRewritesDebugInfoDeserializer(item: any): QueryRewritesDebugInfo;
+/** Contains debugging information specific to query rewrites. */
+export interface QueryRewritesValuesDebugInfo {
+    /** The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. */
+    readonly inputQuery?: string;
+    /** List of query rewrites. */
+    readonly rewrites?: string[];
+}
+export declare function queryRewritesValuesDebugInfoDeserializer(item: any): QueryRewritesValuesDebugInfo;
+export declare function queryRewritesValuesDebugInfoArrayDeserializer(result: Array<QueryRewritesValuesDebugInfo>): any[];
+/** Parameters for filtering, sorting, faceting, paging, and other search query behaviors. */
+export interface SearchRequest {
+    /** A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. */
+    includeTotalCount?: boolean;
+    /** The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. */
+    facets?: string[];
+    /** The OData $filter expression to apply to the search query. */
+    filter?: string;
+    /** The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. */
+    highlightFields?: string[];
+    /** A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is &lt;/em&gt;. */
+    highlightPostTag?: string;
+    /** A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is &lt;em&gt;. */
+    highlightPreTag?: string;
+    /** A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. */
+    minimumCoverage?: number;
+    /** The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. */
+    orderBy?: string;
+    /** A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. */
+    queryType?: QueryType;
+    /** 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. */
+    scoringStatistics?: ScoringStatistics;
+    /** A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. */
+    sessionId?: string;
+    /** The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). */
+    scoringParameters?: string[];
+    /** The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. */
+    scoringProfile?: string;
+    /** Enables a debugging tool that can be used to further explore your reranked results. */
+    debug?: QueryDebugMode;
+    /** A full-text search query expression; Use "*" or omit this parameter to match all documents. */
+    searchText?: string;
+    /** The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter. */
+    searchFields?: string;
+    /** A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. */
+    searchMode?: SearchMode;
+    /** A value that specifies the language of the search query. */
+    queryLanguage?: QueryLanguage;
+    /** A value that specifies the type of the speller to use to spell-correct individual search query terms. */
+    querySpeller?: QuerySpellerType;
+    /** The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. */
+    select?: string;
+    /** The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead. */
+    skip?: number;
+    /** The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results. */
+    top?: number;
+    /** The name of a semantic configuration that will be used when processing documents for queries of type semantic. */
+    semanticConfigurationName?: string;
+    /** Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results. */
+    semanticErrorHandling?: SemanticErrorMode;
+    /** 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. */
+    semanticMaxWaitInMilliseconds?: number;
+    /** 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. */
+    semanticQuery?: string;
+    /** A value that specifies whether answers should be returned as part of the search response. */
+    answers?: QueryAnswerType;
+    /** A value that specifies whether captions should be returned as part of the search response. */
+    captions?: QueryCaptionType;
+    /** A value that specifies whether query rewrites should be generated to augment the search query. */
+    queryRewrites?: QueryRewritesType;
+    /** The comma-separated list of field names used for semantic ranking. */
+    semanticFields?: string[];
+    /** The query parameters for vector and hybrid search queries. */
+    vectorQueries?: VectorQueryUnion[];
+    /** Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes. */
+    vectorFilterMode?: VectorFilterMode;
+    /** The query parameters to configure hybrid search behaviors. */
+    hybridSearch?: HybridSearch;
+}
+export declare function searchRequestDeserializer(item: any): SearchRequest;
+/** 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. */
+export declare enum KnownQueryType {
+    /** Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. */
+    Simple = "simple",
+    /** Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. */
+    Full = "full",
+    /** Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. */
+    Semantic = "semantic"
+}
+/**
+ * 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. \
+ * {@link KnownQueryType} can be used interchangeably with QueryType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **simple**: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. \
+ * **full**: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. \
+ * **semantic**: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus.
+ */
+export type QueryType = string;
+/** 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. */
+export type ScoringStatistics = "local" | "global";
+/** 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. */
+export declare enum KnownQueryDebugMode {
+    /** No query debugging information will be returned. */
+    Disabled = "disabled",
+    /** Allows the user to further explore their reranked results. */
+    Semantic = "semantic",
+    /** Allows the user to further explore their hybrid and vector query results. */
+    Vector = "vector",
+    /** Allows the user to explore the list of query rewrites generated for their search request. */
+    QueryRewrites = "queryRewrites",
+    /** Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. */
+    InnerHits = "innerHits",
+    /** Turn on all debug options. */
+    All = "all"
+}
+/**
+ * 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. \
+ * {@link KnownQueryDebugMode} can be used interchangeably with QueryDebugMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **disabled**: No query debugging information will be returned. \
+ * **semantic**: Allows the user to further explore their reranked results. \
+ * **vector**: Allows the user to further explore their hybrid and vector query results. \
+ * **queryRewrites**: Allows the user to explore the list of query rewrites generated for their search request. \
+ * **innerHits**: Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. \
+ * **all**: Turn on all debug options.
+ */
+export type QueryDebugMode = string;
+/** Specifies whether any or all of the search terms must be matched in order to count the document as a match. */
+export type SearchMode = "any" | "all";
+/** The language of the query. */
+export declare enum KnownQueryLanguage {
+    /** Query language not specified. */
+    None = "none",
+    /** Query language value for English (United States). */
+    EnUs = "en-us",
+    /** Query language value for English (Great Britain). */
+    EnGb = "en-gb",
+    /** Query language value for English (India). */
+    EnIn = "en-in",
+    /** Query language value for English (Canada). */
+    EnCa = "en-ca",
+    /** Query language value for English (Australia). */
+    EnAu = "en-au",
+    /** Query language value for French (France). */
+    FrFr = "fr-fr",
+    /** Query language value for French (Canada). */
+    FrCa = "fr-ca",
+    /** Query language value for German (Germany). */
+    DeDe = "de-de",
+    /** Query language value for Spanish (Spain). */
+    EsEs = "es-es",
+    /** Query language value for Spanish (Mexico). */
+    EsMx = "es-mx",
+    /** Query language value for Chinese (China). */
+    ZhCn = "zh-cn",
+    /** Query language value for Chinese (Taiwan). */
+    ZhTw = "zh-tw",
+    /** Query language value for Portuguese (Brazil). */
+    PtBr = "pt-br",
+    /** Query language value for Portuguese (Portugal). */
+    PtPt = "pt-pt",
+    /** Query language value for Italian (Italy). */
+    ItIt = "it-it",
+    /** Query language value for Japanese (Japan). */
+    JaJp = "ja-jp",
+    /** Query language value for Korean (Korea). */
+    KoKr = "ko-kr",
+    /** Query language value for Russian (Russia). */
+    RuRu = "ru-ru",
+    /** Query language value for Czech (Czech Republic). */
+    CsCz = "cs-cz",
+    /** Query language value for Dutch (Belgium). */
+    NlBe = "nl-be",
+    /** Query language value for Dutch (Netherlands). */
+    NlNl = "nl-nl",
+    /** Query language value for Hungarian (Hungary). */
+    HuHu = "hu-hu",
+    /** Query language value for Polish (Poland). */
+    PlPl = "pl-pl",
+    /** Query language value for Swedish (Sweden). */
+    SvSe = "sv-se",
+    /** Query language value for Turkish (Turkey). */
+    TrTr = "tr-tr",
+    /** Query language value for Hindi (India). */
+    HiIn = "hi-in",
+    /** Query language value for Arabic (Saudi Arabia). */
+    ArSa = "ar-sa",
+    /** Query language value for Arabic (Egypt). */
+    ArEg = "ar-eg",
+    /** Query language value for Arabic (Morocco). */
+    ArMa = "ar-ma",
+    /** Query language value for Arabic (Kuwait). */
+    ArKw = "ar-kw",
+    /** Query language value for Arabic (Jordan). */
+    ArJo = "ar-jo",
+    /** Query language value for Danish (Denmark). */
+    DaDk = "da-dk",
+    /** Query language value for Norwegian (Norway). */
+    NoNo = "no-no",
+    /** Query language value for Bulgarian (Bulgaria). */
+    BgBg = "bg-bg",
+    /** Query language value for Croatian (Croatia). */
+    HrHr = "hr-hr",
+    /** Query language value for Croatian (Bosnia and Herzegovina). */
+    HrBa = "hr-ba",
+    /** Query language value for Malay (Malaysia). */
+    MsMy = "ms-my",
+    /** Query language value for Malay (Brunei Darussalam). */
+    MsBn = "ms-bn",
+    /** Query language value for Slovenian (Slovenia). */
+    SlSl = "sl-sl",
+    /** Query language value for Tamil (India). */
+    TaIn = "ta-in",
+    /** Query language value for Vietnamese (Viet Nam). */
+    ViVn = "vi-vn",
+    /** Query language value for Greek (Greece). */
+    ElGr = "el-gr",
+    /** Query language value for Romanian (Romania). */
+    RoRo = "ro-ro",
+    /** Query language value for Icelandic (Iceland). */
+    IsIs = "is-is",
+    /** Query language value for Indonesian (Indonesia). */
+    IdId = "id-id",
+    /** Query language value for Thai (Thailand). */
+    ThTh = "th-th",
+    /** Query language value for Lithuanian (Lithuania). */
+    LtLt = "lt-lt",
+    /** Query language value for Ukrainian (Ukraine). */
+    UkUa = "uk-ua",
+    /** Query language value for Latvian (Latvia). */
+    LvLv = "lv-lv",
+    /** Query language value for Estonian (Estonia). */
+    EtEe = "et-ee",
+    /** Query language value for Catalan. */
+    CaEs = "ca-es",
+    /** Query language value for Finnish (Finland). */
+    FiFi = "fi-fi",
+    /** Query language value for Serbian (Bosnia and Herzegovina). */
+    SrBa = "sr-ba",
+    /** Query language value for Serbian (Montenegro). */
+    SrMe = "sr-me",
+    /** Query language value for Serbian (Serbia). */
+    SrRs = "sr-rs",
+    /** Query language value for Slovak (Slovakia). */
+    SkSk = "sk-sk",
+    /** Query language value for Norwegian (Norway). */
+    NbNo = "nb-no",
+    /** Query language value for Armenian (Armenia). */
+    HyAm = "hy-am",
+    /** Query language value for Bengali (India). */
+    BnIn = "bn-in",
+    /** Query language value for Basque. */
+    EuEs = "eu-es",
+    /** Query language value for Galician. */
+    GlEs = "gl-es",
+    /** Query language value for Gujarati (India). */
+    GuIn = "gu-in",
+    /** Query language value for Hebrew (Israel). */
+    HeIl = "he-il",
+    /** Query language value for Irish (Ireland). */
+    GaIe = "ga-ie",
+    /** Query language value for Kannada (India). */
+    KnIn = "kn-in",
+    /** Query language value for Malayalam (India). */
+    MlIn = "ml-in",
+    /** Query language value for Marathi (India). */
+    MrIn = "mr-in",
+    /** Query language value for Persian (U.A.E.). */
+    FaAe = "fa-ae",
+    /** Query language value for Punjabi (India). */
+    PaIn = "pa-in",
+    /** Query language value for Telugu (India). */
+    TeIn = "te-in",
+    /** Query language value for Urdu (Pakistan). */
+    UrPk = "ur-pk"
+}
+/**
+ * The language of the query. \
+ * {@link KnownQueryLanguage} can be used interchangeably with QueryLanguage,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **none**: Query language not specified. \
+ * **en-us**: Query language value for English (United States). \
+ * **en-gb**: Query language value for English (Great Britain). \
+ * **en-in**: Query language value for English (India). \
+ * **en-ca**: Query language value for English (Canada). \
+ * **en-au**: Query language value for English (Australia). \
+ * **fr-fr**: Query language value for French (France). \
+ * **fr-ca**: Query language value for French (Canada). \
+ * **de-de**: Query language value for German (Germany). \
+ * **es-es**: Query language value for Spanish (Spain). \
+ * **es-mx**: Query language value for Spanish (Mexico). \
+ * **zh-cn**: Query language value for Chinese (China). \
+ * **zh-tw**: Query language value for Chinese (Taiwan). \
+ * **pt-br**: Query language value for Portuguese (Brazil). \
+ * **pt-pt**: Query language value for Portuguese (Portugal). \
+ * **it-it**: Query language value for Italian (Italy). \
+ * **ja-jp**: Query language value for Japanese (Japan). \
+ * **ko-kr**: Query language value for Korean (Korea). \
+ * **ru-ru**: Query language value for Russian (Russia). \
+ * **cs-cz**: Query language value for Czech (Czech Republic). \
+ * **nl-be**: Query language value for Dutch (Belgium). \
+ * **nl-nl**: Query language value for Dutch (Netherlands). \
+ * **hu-hu**: Query language value for Hungarian (Hungary). \
+ * **pl-pl**: Query language value for Polish (Poland). \
+ * **sv-se**: Query language value for Swedish (Sweden). \
+ * **tr-tr**: Query language value for Turkish (Turkey). \
+ * **hi-in**: Query language value for Hindi (India). \
+ * **ar-sa**: Query language value for Arabic (Saudi Arabia). \
+ * **ar-eg**: Query language value for Arabic (Egypt). \
+ * **ar-ma**: Query language value for Arabic (Morocco). \
+ * **ar-kw**: Query language value for Arabic (Kuwait). \
+ * **ar-jo**: Query language value for Arabic (Jordan). \
+ * **da-dk**: Query language value for Danish (Denmark). \
+ * **no-no**: Query language value for Norwegian (Norway). \
+ * **bg-bg**: Query language value for Bulgarian (Bulgaria). \
+ * **hr-hr**: Query language value for Croatian (Croatia). \
+ * **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
+ * **ms-my**: Query language value for Malay (Malaysia). \
+ * **ms-bn**: Query language value for Malay (Brunei Darussalam). \
+ * **sl-sl**: Query language value for Slovenian (Slovenia). \
+ * **ta-in**: Query language value for Tamil (India). \
+ * **vi-vn**: Query language value for Vietnamese (Viet Nam). \
+ * **el-gr**: Query language value for Greek (Greece). \
+ * **ro-ro**: Query language value for Romanian (Romania). \
+ * **is-is**: Query language value for Icelandic (Iceland). \
+ * **id-id**: Query language value for Indonesian (Indonesia). \
+ * **th-th**: Query language value for Thai (Thailand). \
+ * **lt-lt**: Query language value for Lithuanian (Lithuania). \
+ * **uk-ua**: Query language value for Ukrainian (Ukraine). \
+ * **lv-lv**: Query language value for Latvian (Latvia). \
+ * **et-ee**: Query language value for Estonian (Estonia). \
+ * **ca-es**: Query language value for Catalan. \
+ * **fi-fi**: Query language value for Finnish (Finland). \
+ * **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
+ * **sr-me**: Query language value for Serbian (Montenegro). \
+ * **sr-rs**: Query language value for Serbian (Serbia). \
+ * **sk-sk**: Query language value for Slovak (Slovakia). \
+ * **nb-no**: Query language value for Norwegian (Norway). \
+ * **hy-am**: Query language value for Armenian (Armenia). \
+ * **bn-in**: Query language value for Bengali (India). \
+ * **eu-es**: Query language value for Basque. \
+ * **gl-es**: Query language value for Galician. \
+ * **gu-in**: Query language value for Gujarati (India). \
+ * **he-il**: Query language value for Hebrew (Israel). \
+ * **ga-ie**: Query language value for Irish (Ireland). \
+ * **kn-in**: Query language value for Kannada (India). \
+ * **ml-in**: Query language value for Malayalam (India). \
+ * **mr-in**: Query language value for Marathi (India). \
+ * **fa-ae**: Query language value for Persian (U.A.E.). \
+ * **pa-in**: Query language value for Punjabi (India). \
+ * **te-in**: Query language value for Telugu (India). \
+ * **ur-pk**: Query language value for Urdu (Pakistan).
+ */
+export type QueryLanguage = string;
+/** Improve search recall by spell-correcting individual search query terms. */
+export declare enum KnownQuerySpellerType {
+    /** Speller not enabled. */
+    None = "none",
+    /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
+    Lexicon = "lexicon"
+}
+/**
+ * Improve search recall by spell-correcting individual search query terms. \
+ * {@link KnownQuerySpellerType} can be used interchangeably with QuerySpellerType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **none**: Speller not enabled. \
+ * **lexicon**: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter.
+ */
+export type QuerySpellerType = string;
+/** Allows the user to choose whether a semantic call should fail completely, or to return partial results. */
+export declare enum KnownSemanticErrorMode {
+    /** If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure. */
+    Partial = "partial",
+    /** If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error. */
+    Fail = "fail"
+}
+/**
+ * Allows the user to choose whether a semantic call should fail completely, or to return partial results. \
+ * {@link KnownSemanticErrorMode} can be used interchangeably with SemanticErrorMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **partial**: If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure. \
+ * **fail**: If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error.
+ */
+export type SemanticErrorMode = string;
+/** 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'. */
+export declare enum KnownQueryAnswerType {
+    /** Do not return answers for the query. */
+    None = "none",
+    /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
+    Extractive = "extractive"
+}
+/**
+ * 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'. \
+ * {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **none**: Do not return answers for the query. \
+ * **extractive**: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.
+ */
+export type QueryAnswerType = string;
+/** 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'. */
+export declare enum KnownQueryCaptionType {
+    /** Do not return captions for the query. */
+    None = "none",
+    /** Extracts captions from the matching documents that contain passages relevant to the search query. */
+    Extractive = "extractive"
+}
+/**
+ * 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'. \
+ * {@link KnownQueryCaptionType} can be used interchangeably with QueryCaptionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **none**: Do not return captions for the query. \
+ * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
+ */
+export type QueryCaptionType = string;
+/** This parameter is only valid if the query type is `semantic`. When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. */
+export declare enum KnownQueryRewritesType {
+    /** Do not generate additional query rewrites for this query. */
+    None = "none",
+    /** Generate alternative query terms to increase the recall of a search request. */
+    Generative = "generative"
+}
+/**
+ * This parameter is only valid if the query type is `semantic`. When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. \
+ * {@link KnownQueryRewritesType} can be used interchangeably with QueryRewritesType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **none**: Do not generate additional query rewrites for this query. \
+ * **generative**: Generate alternative query terms to increase the recall of a search request.
+ */
+export type QueryRewritesType = string;
+export declare function vectorQueryUnionArraySerializer(result: Array<VectorQueryUnion>): any[];
+export declare function vectorQueryUnionArrayDeserializer(result: Array<VectorQueryUnion>): any[];
+/** The query parameters for vector and hybrid search queries. */
+export interface VectorQuery {
+    /** Number of nearest neighbors to return as top hits. */
+    kNearestNeighborsCount?: number;
+    /** Vector Fields of type Collection(Edm.Single) to be included in the vector searched. */
+    fields?: string;
+    /** When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. */
+    exhaustive?: boolean;
+    /** Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field. */
+    oversampling?: number;
+    /** Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. */
+    weight?: number;
+    /** The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. */
+    threshold?: VectorThresholdUnion;
+    /** The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead. */
+    filterOverride?: string;
+    /** Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0. */
+    perDocumentVectorLimit?: number;
+    /** Type of query. */
+    /** The discriminator possible values: vector, text, imageUrl, imageBinary */
+    kind: VectorQueryKind;
+}
+export declare function vectorQuerySerializer(item: VectorQuery): any;
+export declare function vectorQueryDeserializer(item: any): VectorQuery;
+/** Alias for VectorQueryUnion */
+export type VectorQueryUnion = VectorizedQuery | VectorizableTextQuery | VectorizableImageUrlQuery | VectorizableImageBinaryQuery | VectorQuery;
+export declare function vectorQueryUnionSerializer(item: VectorQueryUnion): any;
+export declare function vectorQueryUnionDeserializer(item: any): VectorQueryUnion;
+/** The threshold used for vector queries. */
+export interface VectorThreshold {
+    /** Type of threshold. */
+    /** The discriminator possible values: vectorSimilarity, searchScore */
+    kind: VectorThresholdKind;
+}
+export declare function vectorThresholdSerializer(item: VectorThreshold): any;
+export declare function vectorThresholdDeserializer(item: any): VectorThreshold;
+/** Alias for VectorThresholdUnion */
+export type VectorThresholdUnion = VectorSimilarityThreshold | SearchScoreThreshold | VectorThreshold;
+export declare function vectorThresholdUnionSerializer(item: VectorThresholdUnion): any;
+export declare function vectorThresholdUnionDeserializer(item: any): VectorThresholdUnion;
+/** The kind of threshold used to filter vector queries. */
+export declare enum KnownVectorThresholdKind {
+    /** 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. */
+    VectorSimilarity = "vectorSimilarity",
+    /** 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. */
+    SearchScore = "searchScore"
+}
+/**
+ * The kind of threshold used to filter vector queries. \
+ * {@link KnownVectorThresholdKind} can be used interchangeably with VectorThresholdKind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **vectorSimilarity**: 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. \
+ * **searchScore**: 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.
+ */
+export type VectorThresholdKind = string;
+/** 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. */
+export interface VectorSimilarityThreshold extends VectorThreshold {
+    /** The threshold will filter based on the similarity metric value. 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. */
+    value: number;
+    /** The kind of threshold used to filter vector queries */
+    kind: "vectorSimilarity";
+}
+export declare function vectorSimilarityThresholdSerializer(item: VectorSimilarityThreshold): any;
+export declare function vectorSimilarityThresholdDeserializer(item: any): VectorSimilarityThreshold;
+/** The results of the vector query will filter based on the ' */
+export interface SearchScoreThreshold extends VectorThreshold {
+    /** The threshold will filter based on the ' */
+    value: number;
+    /** The kind of threshold used to filter vector queries */
+    kind: "searchScore";
+}
+export declare function searchScoreThresholdSerializer(item: SearchScoreThreshold): any;
+export declare function searchScoreThresholdDeserializer(item: any): SearchScoreThreshold;
+/** The kind of vector query being performed. */
+export declare enum KnownVectorQueryKind {
+    /** Vector query where a raw vector value is provided. */
+    Vector = "vector",
+    /** Vector query where a text value that needs to be vectorized is provided. */
+    Text = "text",
+    /** Vector query where an url that represents an image value that needs to be vectorized is provided. */
+    ImageUrl = "imageUrl",
+    /** Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. */
+    ImageBinary = "imageBinary"
+}
+/**
+ * The kind of vector query being performed. \
+ * {@link KnownVectorQueryKind} can be used interchangeably with VectorQueryKind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **vector**: Vector query where a raw vector value is provided. \
+ * **text**: Vector query where a text value that needs to be vectorized is provided. \
+ * **imageUrl**: Vector query where an url that represents an image value that needs to be vectorized is provided. \
+ * **imageBinary**: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided.
+ */
+export type VectorQueryKind = string;
+/** The query parameters to use for vector search when a raw vector value is provided. */
+export interface VectorizedQuery extends VectorQuery {
+    /** The vector representation of a search query. */
+    vector: number[];
+    /** The kind of vector query being performed. */
+    kind: "vector";
+}
+export declare function vectorizedQuerySerializer(item: VectorizedQuery): any;
+export declare function vectorizedQueryDeserializer(item: any): VectorizedQuery;
+/** The query parameters to use for vector search when a text value that needs to be vectorized is provided. */
+export interface VectorizableTextQuery extends VectorQuery {
+    /** The text to be vectorized to perform a vector search query. */
+    text: string;
+    /** Can be configured to let a generative model rewrite the query before sending it to be vectorized. */
+    queryRewrites?: QueryRewritesType;
+    /** The kind of vector query being performed. */
+    kind: "text";
+}
+export declare function vectorizableTextQuerySerializer(item: VectorizableTextQuery): any;
+export declare function vectorizableTextQueryDeserializer(item: any): VectorizableTextQuery;
+/** The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided. */
+export interface VectorizableImageUrlQuery extends VectorQuery {
+    /** The URL of an image to be vectorized to perform a vector search query. */
+    url: string;
+    /** The kind of vector query being performed. */
+    kind: "imageUrl";
+}
+export declare function vectorizableImageUrlQuerySerializer(item: VectorizableImageUrlQuery): any;
+export declare function vectorizableImageUrlQueryDeserializer(item: any): VectorizableImageUrlQuery;
+/** The query parameters to use for vector search when a base 64 encoded binary of an image that needs to be vectorized is provided. */
+export interface VectorizableImageBinaryQuery extends VectorQuery {
+    /** The base 64 encoded binary of an image to be vectorized to perform a vector search query. */
+    base64Image?: string;
+    /** The kind of vector query being performed. */
+    kind: "imageBinary";
+}
+export declare function vectorizableImageBinaryQuerySerializer(item: VectorizableImageBinaryQuery): any;
+export declare function vectorizableImageBinaryQueryDeserializer(item: any): VectorizableImageBinaryQuery;
+/** Determines whether or not filters are applied before or after the vector search is performed. */
+export declare enum KnownVectorFilterMode {
+    /** The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. */
+    PostFilter = "postFilter",
+    /** The filter will be applied before the search query. */
+    PreFilter = "preFilter",
+    /** The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'. */
+    StrictPostFilter = "strictPostFilter"
+}
+/**
+ * Determines whether or not filters are applied before or after the vector search is performed. \
+ * {@link KnownVectorFilterMode} can be used interchangeably with VectorFilterMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **postFilter**: The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. \
+ * **preFilter**: The filter will be applied before the search query. \
+ * **strictPostFilter**: The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'.
+ */
+export type VectorFilterMode = string;
+/** The query parameters to configure hybrid search behaviors. */
+export interface HybridSearch {
+    /** Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. */
+    maxTextRecallSize?: number;
+    /** 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. */
+    countAndFacetMode?: HybridCountAndFacetMode;
+}
+export declare function hybridSearchSerializer(item: HybridSearch): any;
+export declare function hybridSearchDeserializer(item: any): HybridSearch;
+/** 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'. */
+export declare enum KnownHybridCountAndFacetMode {
+    /** Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. */
+    CountRetrievableResults = "countRetrievableResults",
+    /** Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. */
+    CountAllResults = "countAllResults"
+}
+/**
+ * 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'. \
+ * {@link KnownHybridCountAndFacetMode} can be used interchangeably with HybridCountAndFacetMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **countRetrievableResults**: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. \
+ * **countAllResults**: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window.
+ */
+export type HybridCountAndFacetMode = string;
+export declare function searchResultArraySerializer(result: Array<SearchResult>): any[];
+export declare function searchResultArrayDeserializer(result: Array<SearchResult>): any[];
+/** Contains a document found by a search query, plus associated metadata. */
+export interface SearchResult {
+    /** The relevance score of the document compared to other documents returned by the query. */
+    readonly score: number;
+    /** The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'. */
+    readonly rerankerScore?: number;
+    /** The relevance score computed by boosting the Reranker Score. Search results are sorted by the RerankerScore/RerankerBoostedScore based on useScoringProfileBoostedRanking in the Semantic Config. RerankerBoostedScore is only returned for queries of type 'semantic'. */
+    readonly rerankerBoostedScore?: number;
+    /** Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query. */
+    readonly highlights?: Record<string, string[]>;
+    /** 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'. */
+    readonly captions?: QueryCaptionResult[];
+    /** Contains debugging information that can be used to further explore your search results. */
+    readonly documentDebugInfo?: DocumentDebugInfo;
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function searchResultSerializer(item: SearchResult): any;
+export declare function searchResultDeserializer(item: any): SearchResult;
+export declare function queryCaptionResultArrayDeserializer(result: Array<QueryCaptionResult>): any[];
+/** 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`. */
+export interface QueryCaptionResult {
+    /** A representative text passage extracted from the document most relevant to the search query. */
+    readonly text?: string;
+    /** Same text passage as in the Text property with highlighted phrases most relevant to the query. */
+    readonly highlights?: string;
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function queryCaptionResultDeserializer(item: any): QueryCaptionResult;
+/** Contains debugging information that can be used to further explore your search results. */
+export interface DocumentDebugInfo {
+    /** Contains debugging information specific to semantic ranking requests. */
+    readonly semantic?: SemanticDebugInfo;
+    /** Contains debugging information specific to vector and hybrid search. */
+    readonly vectors?: VectorsDebugInfo;
+    /** Contains debugging information specific to vectors matched within a collection of complex types. */
+    readonly innerHits?: Record<string, QueryResultDocumentInnerHit[]>;
+}
+export declare function documentDebugInfoDeserializer(item: any): DocumentDebugInfo;
+/** Contains debugging information specific to semantic ranking requests. */
+export interface SemanticDebugInfo {
+    /** The title field that was sent to the semantic enrichment process, as well as how it was used */
+    readonly titleField?: QueryResultDocumentSemanticField;
+    /** The content fields that were sent to the semantic enrichment process, as well as how they were used */
+    readonly contentFields?: QueryResultDocumentSemanticField[];
+    /** The keyword fields that were sent to the semantic enrichment process, as well as how they were used */
+    readonly keywordFields?: QueryResultDocumentSemanticField[];
+    /** The raw concatenated strings that were sent to the semantic enrichment process. */
+    readonly rerankerInput?: QueryResultDocumentRerankerInput;
+}
+export declare function semanticDebugInfoDeserializer(item: any): SemanticDebugInfo;
+/** Description of fields that were sent to the semantic enrichment process, as well as how they were used */
+export interface QueryResultDocumentSemanticField {
+    /** The name of the field that was sent to the semantic enrichment process */
+    readonly name?: string;
+    /** The way the field was used for the semantic enrichment process (fully used, partially used, or unused) */
+    readonly state?: SemanticFieldState;
+}
+export declare function queryResultDocumentSemanticFieldDeserializer(item: any): QueryResultDocumentSemanticField;
+/** The way the field was used for the semantic enrichment process. */
+export declare enum KnownSemanticFieldState {
+    /** The field was fully used for semantic enrichment. */
+    Used = "used",
+    /** The field was not used for semantic enrichment. */
+    Unused = "unused",
+    /** The field was partially used for semantic enrichment. */
+    Partial = "partial"
+}
+/**
+ * The way the field was used for the semantic enrichment process. \
+ * {@link KnownSemanticFieldState} can be used interchangeably with SemanticFieldState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **used**: The field was fully used for semantic enrichment. \
+ * **unused**: The field was not used for semantic enrichment. \
+ * **partial**: The field was partially used for semantic enrichment.
+ */
+export type SemanticFieldState = string;
+export declare function queryResultDocumentSemanticFieldArrayDeserializer(result: Array<QueryResultDocumentSemanticField>): any[];
+/** The raw concatenated strings that were sent to the semantic enrichment process. */
+export interface QueryResultDocumentRerankerInput {
+    /** The raw string for the title field that was used for semantic enrichment. */
+    readonly title?: string;
+    /** The raw concatenated strings for the content fields that were used for semantic enrichment. */
+    readonly content?: string;
+    /** The raw concatenated strings for the keyword fields that were used for semantic enrichment. */
+    readonly keywords?: string;
+}
+export declare function queryResultDocumentRerankerInputDeserializer(item: any): QueryResultDocumentRerankerInput;
+/** "Contains debugging information specific to vector and hybrid search.") */
+export interface VectorsDebugInfo {
+    /** The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF. */
+    readonly subscores?: QueryResultDocumentSubscores;
+}
+export declare function vectorsDebugInfoDeserializer(item: any): VectorsDebugInfo;
+/** 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. */
+export interface QueryResultDocumentSubscores {
+    /** The BM25 or Classic score for the text portion of the query. */
+    readonly text?: TextResult;
+    /** The vector similarity and */
+    readonly vectors?: Record<string, SingleVectorFieldResult>[];
+    /** The BM25 or Classic score for the text portion of the query. */
+    readonly documentBoost?: number;
+}
+export declare function queryResultDocumentSubscoresDeserializer(item: any): QueryResultDocumentSubscores;
+/** The BM25 or Classic score for the text portion of the query. */
+export interface TextResult {
+    /** The BM25 or Classic score for the text portion of the query. */
+    readonly searchScore?: number;
+}
+export declare function textResultDeserializer(item: any): TextResult;
+export declare function singleVectorFieldResultRecordArrayDeserializer(result: Array<Record<string, SingleVectorFieldResult>>): any[];
+export declare function singleVectorFieldResultRecordDeserializer(item: Record<string, any>): Record<string, SingleVectorFieldResult>;
+/** A single vector field result. Both */
+export interface SingleVectorFieldResult {
+    /** The */
+    readonly searchScore?: number;
+    /** The vector similarity score for this document. Note this is the canonical definition of similarity metric, not the 'distance' version. For example, cosine similarity instead of cosine distance. */
+    readonly vectorSimilarity?: number;
+}
+export declare function singleVectorFieldResultDeserializer(item: any): SingleVectorFieldResult;
+export declare function queryResultDocumentInnerHitArrayRecordDeserializer(item: Record<string, any>): Record<string, Array<QueryResultDocumentInnerHit>>;
+export declare function queryResultDocumentInnerHitArrayDeserializer(result: Array<QueryResultDocumentInnerHit>): any[];
+/** Detailed scoring information for an individual element of a complex collection. */
+export interface QueryResultDocumentInnerHit {
+    /** Position of this specific matching element within it's original collection. Position starts at 0. */
+    readonly ordinal?: number;
+    /** Detailed scoring information for an individual element of a complex collection that matched a vector query. */
+    readonly vectors?: Record<string, SingleVectorFieldResult>[];
+}
+export declare function queryResultDocumentInnerHitDeserializer(item: any): QueryResultDocumentInnerHit;
+/** Reason that a partial response was returned for a semantic ranking request. */
+export declare enum KnownSemanticErrorReason {
+    /** If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned. */
+    MaxWaitExceeded = "maxWaitExceeded",
+    /** The request was throttled. Only the base results were returned. */
+    CapacityOverloaded = "capacityOverloaded",
+    /** At least one step of the semantic process failed. */
+    Transient = "transient"
+}
+/**
+ * Reason that a partial response was returned for a semantic ranking request. \
+ * {@link KnownSemanticErrorReason} can be used interchangeably with SemanticErrorReason,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **maxWaitExceeded**: If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned. \
+ * **capacityOverloaded**: The request was throttled. Only the base results were returned. \
+ * **transient**: At least one step of the semantic process failed.
+ */
+export type SemanticErrorReason = string;
+/** Type of partial response that was returned for a semantic ranking request. */
+export declare enum KnownSemanticSearchResultsType {
+    /** Results without any semantic enrichment or reranking. */
+    BaseResults = "baseResults",
+    /** Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights. */
+    RerankedResults = "rerankedResults"
+}
+/**
+ * Type of partial response that was returned for a semantic ranking request. \
+ * {@link KnownSemanticSearchResultsType} can be used interchangeably with SemanticSearchResultsType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **baseResults**: Results without any semantic enrichment or reranking. \
+ * **rerankedResults**: Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights.
+ */
+export type SemanticSearchResultsType = string;
+/** Type of query rewrite that was used for this request. */
+export declare enum KnownSemanticQueryRewritesResultType {
+    /** Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. */
+    OriginalQueryOnly = "originalQueryOnly"
+}
+/**
+ * Type of query rewrite that was used for this request. \
+ * {@link KnownSemanticQueryRewritesResultType} can be used interchangeably with SemanticQueryRewritesResultType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **originalQueryOnly**: Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results.
+ */
+export type SemanticQueryRewritesResultType = string;
+/** A document retrieved via a document lookup operation. */
+export interface LookupDocument {
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function lookupDocumentDeserializer(item: any): LookupDocument;
+/** Response containing suggestion query results from an index. */
+export interface SuggestDocumentsResult {
+    /** The sequence of results returned by the query. */
+    readonly results: SuggestResult[];
+    /** A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request. */
+    readonly coverage?: number;
+}
+export declare function suggestDocumentsResultDeserializer(item: any): SuggestDocumentsResult;
+export declare function suggestResultArraySerializer(result: Array<SuggestResult>): any[];
+export declare function suggestResultArrayDeserializer(result: Array<SuggestResult>): any[];
+/** A result containing a document found by a suggestion query, plus associated metadata. */
+export interface SuggestResult {
+    /** The text of the suggestion result. */
+    readonly text: string;
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function suggestResultSerializer(item: SuggestResult): any;
+export declare function suggestResultDeserializer(item: any): SuggestResult;
+/** Contains a batch of document write actions to send to the index. */
+export interface IndexDocumentsBatch {
+    /** The actions in the batch. */
+    actions: IndexAction[];
+}
+export declare function indexDocumentsBatchSerializer(item: IndexDocumentsBatch): any;
+export declare function indexActionArraySerializer(result: Array<IndexAction>): any[];
+/** Represents an index action that operates on a document. */
+export interface IndexAction {
+    /** The operation to perform on a document in an indexing batch. */
+    actionType?: IndexActionType;
+    /** Additional properties */
+    additionalProperties?: Record<string, any>;
+}
+export declare function indexActionSerializer(item: IndexAction): any;
+/** The operation to perform on a document in an indexing batch. */
+export type IndexActionType = "upload" | "merge" | "mergeOrUpload" | "delete";
+/** Response containing the status of operations for all documents in the indexing request. */
+export interface IndexDocumentsResult {
+    /** The list of status information for each document in the indexing request. */
+    readonly results: IndexingResult[];
+}
+export declare function indexDocumentsResultDeserializer(item: any): IndexDocumentsResult;
+export declare function indexingResultArraySerializer(result: Array<IndexingResult>): any[];
+export declare function indexingResultArrayDeserializer(result: Array<IndexingResult>): any[];
+/** Status of an indexing operation for a single document. */
+export interface IndexingResult {
+    /** The key of a document that was in the indexing request. */
+    readonly key: string;
+    /** The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. */
+    readonly errorMessage?: string;
+    /** A value indicating whether the indexing operation succeeded for the document identified by the key. */
+    readonly succeeded: boolean;
+    /** The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. */
+    readonly statusCode: number;
+}
+export declare function indexingResultSerializer(_item: IndexingResult): any;
+export declare function indexingResultDeserializer(item: any): IndexingResult;
+/** The result of Autocomplete query. */
+export interface AutocompleteResult {
+    /** A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request. */
+    readonly coverage?: number;
+    /** The list of returned Autocompleted items. */
+    readonly results: AutocompleteItem[];
+}
+export declare function autocompleteResultDeserializer(item: any): AutocompleteResult;
+export declare function autocompleteItemArraySerializer(result: Array<AutocompleteItem>): any[];
+export declare function autocompleteItemArrayDeserializer(result: Array<AutocompleteItem>): any[];
+/** The result of Autocomplete requests. */
+export interface AutocompleteItem {
+    /** The completed term. */
+    readonly text: string;
+    /** The query along with the completed term. */
+    readonly queryPlusText: string;
+}
+export declare function autocompleteItemSerializer(_item: AutocompleteItem): any;
+export declare function autocompleteItemDeserializer(item: any): AutocompleteItem;
+/** 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. */
+export type AutocompleteMode = "oneTerm" | "twoTerms" | "oneTermWithContext";
+//# sourceMappingURL=models.d.ts.map