@azure/search-documents 12.2.0 → 12.3.0-alpha.20251031.1

package/dist/browser/generated/data/models/index.d.ts

@@ -1,6 +1,7 @@
 import * as coreClient from "@azure/core-client";
 import * as coreHttpCompat from "@azure/core-http-compat";
-export type VectorQueryUnion = VectorQuery | VectorizedQuery | VectorizableTextQuery;
+export type VectorQueryUnion = VectorQuery | VectorizedQuery | VectorizableTextQuery | VectorizableImageUrlQuery | VectorizableImageBinaryQuery;
+export type VectorThresholdUnion = VectorThreshold | VectorSimilarityThreshold | SearchScoreThreshold;
 /** 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. */
@@ -96,6 +97,11 @@ export interface SearchDocumentsResult {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly semanticPartialResponseType?: SemanticSearchResultsType;
+    /**
+     * Type of query rewrite that was used to retrieve documents.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly semanticQueryRewritesResultType?: SemanticQueryRewritesResultType;
 }
 /** 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 {
@@ -106,6 +112,38 @@ export interface FacetResult {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly count?: number;
+    /**
+     * The resulting total avg for the facet when a avg metric is requested.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly avg?: number;
+    /**
+     * The resulting total min for the facet when a min metric is requested.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly min?: number;
+    /**
+     * The resulting total max for the facet when a max metric is requested.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly max?: number;
+    /**
+     * The resulting total sum for the facet when a sum metric is requested.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly sum?: number;
+    /**
+     * The resulting total cardinality for the facet when a cardinality metric is requested.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    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.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly facets?: {
+        [propertyName: string]: FacetResult[];
+    };
 }
 /** 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 {
@@ -168,6 +206,10 @@ export interface SearchRequest {
     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 specified the type of the speller to use to spell-correct individual search query terms. */
+    speller?: 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. */
@@ -186,15 +228,21 @@ export interface SearchRequest {
     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;
 }
 /** The query parameters for vector and hybrid search queries. */
 export interface VectorQuery {
     /** Polymorphic discriminator, which specifies the different types this object can be */
-    kind: "vector" | "text";
+    kind: "vector" | "text" | "imageUrl" | "imageBinary";
     /** 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. */
@@ -205,6 +253,24 @@ export interface VectorQuery {
     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;
+}
+/** The threshold used for vector queries. */
+export interface VectorThreshold {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "vectorSimilarity" | "searchScore";
+}
+/** TThe 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;
 }
 /** Contains a document found by a search query, plus associated metadata. */
 export interface SearchResult {
@@ -224,7 +290,7 @@ export interface SearchResult {
      * 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'
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
-    readonly rerankerBoostedScore?: number;
+    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.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -241,7 +307,7 @@ export interface SearchResult {
      * Contains debugging information that can be used to further explore your search results.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
-    readonly documentDebugInfo?: DocumentDebugInfo;
+    readonly _documentDebugInfo?: DocumentDebugInfo;
 }
 /** 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 {
@@ -260,11 +326,76 @@ export interface 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.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly semantic?: SemanticDebugInfo;
     /**
      * Contains debugging information specific to vector and hybrid search.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly vectors?: VectorsDebugInfo;
+    /**
+     * Contains debugging information specific to vectors matched within a collection of complex types.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly innerHits?: {
+        [propertyName: string]: QueryResultDocumentInnerHit[];
+    };
+}
+export interface SemanticDebugInfo {
+    /**
+     * The title field that was sent to the semantic enrichment process, as well as how it was used
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly titleField?: QueryResultDocumentSemanticField;
+    /**
+     * The content fields that were sent to the semantic enrichment process, as well as how they were used
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly contentFields?: QueryResultDocumentSemanticField[];
+    /**
+     * The keyword fields that were sent to the semantic enrichment process, as well as how they were used
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly keywordFields?: QueryResultDocumentSemanticField[];
+    /**
+     * The raw concatenated strings that were sent to the semantic enrichment process.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly rerankerInput?: QueryResultDocumentRerankerInput;
+}
+/** 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
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The way the field was used for the semantic enrichment process (fully used, partially used, or unused)
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly state?: SemanticFieldState;
+}
+/** 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.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly title?: string;
+    /**
+     * The raw concatenated strings for the content fields that were used for semantic enrichment.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly content?: string;
+    /**
+     * The raw concatenated strings for the keyword fields that were used for semantic enrichment.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly keywords?: string;
 }
 export interface VectorsDebugInfo {
     /**
@@ -314,6 +445,21 @@ export interface SingleVectorFieldResult {
      */
     readonly vectorSimilarity?: number;
 }
+/** 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.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly ordinal?: number;
+    /**
+     * Detailed scoring information for an individual element of a complex collection that matched a vector query.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly vectors?: {
+        [propertyName: string]: SingleVectorFieldResult;
+    }[];
+}
 /** Response containing suggestion query results from an index. */
 export interface SuggestDocumentsResult {
     /**
@@ -454,6 +600,40 @@ export interface AutocompleteRequest {
     /** The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. */
     top?: number;
 }
+/** Contains debugging information that can be used to further explore your search results. */
+export interface DebugInfo {
+    /**
+     * Contains debugging information specific to query rewrites.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly queryRewrites?: QueryRewritesDebugInfo;
+}
+/** Contains debugging information specific to query rewrites. */
+export interface QueryRewritesDebugInfo {
+    /**
+     * List of query rewrites generated for the text query.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly text?: QueryRewritesValuesDebugInfo;
+    /**
+     * List of query rewrites generated for the vectorizable text queries.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly vectors?: QueryRewritesValuesDebugInfo[];
+}
+/** 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.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly inputQuery?: string;
+    /**
+     * List of query rewrites.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly rewrites?: string[];
+}
 /** The query parameters to use for vector search when a raw vector value is provided. */
 export interface VectorizedQuery extends VectorQuery {
     /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -467,6 +647,36 @@ export interface VectorizableTextQuery extends VectorQuery {
     kind: "text";
     /** 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 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 {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "imageUrl";
+    /** The URL of an image to be vectorized to perform a vector search query. */
+    url?: string;
+}
+/** 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 {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "imageBinary";
+    /** The base 64 encoded binary of an image to be vectorized to perform a vector search query. */
+    base64Image?: 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 {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "vectorSimilarity";
+    /** 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 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 interface SearchScoreThreshold extends VectorThreshold {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    kind: "searchScore";
+    /** The threshold 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. */
+    value: number;
 }
 /** Parameter group */
 export interface SearchOptions {
@@ -512,14 +722,22 @@ export interface SearchOptions {
     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;
-    /** 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. */
+    /** 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'. */
     answers?: QueryAnswerType;
-    /** 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`. */
+    /** 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'. */
     captions?: QueryCaptionType;
     /** 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;
+    /** 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`. This parameter is only valid if the query type is `semantic`. */
+    queryRewrites?: QueryRewritesType;
     /** Enables a debugging tool that can be used to further explore your search results. */
     debug?: QueryDebugMode;
+    /** The language of the query. */
+    queryLanguage?: QueryLanguage;
+    /** Improve search recall by spell-correcting individual search query terms. */
+    speller?: QuerySpellerType;
+    /** The list of field names used for semantic ranking. */
+    semanticFields?: string[];
 }
 /** Parameter group */
 export interface SuggestOptions {
@@ -561,19 +779,19 @@ export interface AutocompleteOptions {
     /** The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. */
     top?: number;
 }
-/** Known values of {@link ApiVersion20250901} that the service accepts. */
-export declare enum KnownApiVersion20250901 {
-    /** Api Version '2025-09-01' */
-    TwoThousandTwentyFive0901 = "2025-09-01"
+/** Known values of {@link ApiVersion20251101Preview} that the service accepts. */
+export declare enum KnownApiVersion20251101Preview {
+    /** Api Version '2025-11-01-preview' */
+    TwoThousandTwentyFive1101Preview = "2025-11-01-preview"
 }
 /**
- * Defines values for ApiVersion20250901. \
- * {@link KnownApiVersion20250901} can be used interchangeably with ApiVersion20250901,
+ * Defines values for ApiVersion20251101Preview. \
+ * {@link KnownApiVersion20251101Preview} can be used interchangeably with ApiVersion20251101Preview,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **2025-09-01**: Api Version '2025-09-01'
+ * **2025-11-01-preview**: Api Version '2025-11-01-preview'
  */
-export type ApiVersion20250901 = string;
+export type ApiVersion20251101Preview = string;
 /** Known values of {@link SemanticErrorMode} that the service accepts. */
 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. */
@@ -622,12 +840,36 @@ export declare enum KnownQueryCaptionType {
  * **extractive**: Extracts captions from the matching documents that contain passages relevant to the search query.
  */
 export type QueryCaptionType = string;
+/** Known values of {@link QueryRewritesType} that the service accepts. */
+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"
+}
+/**
+ * Defines values for QueryRewritesType. \
+ * {@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;
 /** Known values of {@link QueryDebugMode} that the service accepts. */
 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"
+    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"
 }
 /**
  * Defines values for QueryDebugMode. \
@@ -635,15 +877,265 @@ export declare enum KnownQueryDebugMode {
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
  * **disabled**: No query debugging information will be returned. \
- * **vector**: Allows the user to further explore their hybrid and vector query results.
+ * **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;
+/** Known values of {@link QueryLanguage} that the service accepts. */
+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"
+}
+/**
+ * Defines values for QueryLanguage. \
+ * {@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;
+/** Known values of {@link QuerySpellerType} that the service accepts. */
+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"
+}
+/**
+ * Defines values for QuerySpellerType. \
+ * {@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;
 /** Known values of {@link VectorQueryKind} that the service accepts. */
 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"
+    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"
 }
 /**
  * Defines values for VectorQueryKind. \
@@ -651,15 +1143,35 @@ export declare enum KnownVectorQueryKind {
  *  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.
+ * **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;
+/** Known values of {@link VectorThresholdKind} that the service accepts. */
+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"
+}
+/**
+ * Defines values for VectorThresholdKind. \
+ * {@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;
 /** Known values of {@link VectorFilterMode} that the service accepts. */
 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"
+    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"
 }
 /**
  * Defines values for VectorFilterMode. \
@@ -667,9 +1179,45 @@ export declare enum KnownVectorFilterMode {
  *  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.
+ * **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;
+/** Known values of {@link HybridCountAndFacetMode} that the service accepts. */
+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"
+}
+/**
+ * Defines values for HybridCountAndFacetMode. \
+ * {@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;
+/** Known values of {@link SemanticFieldState} that the service accepts. */
+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"
+}
+/**
+ * Defines values for SemanticFieldState. \
+ * {@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;
 /** Known values of {@link SemanticErrorReason} that the service accepts. */
 export declare enum KnownSemanticErrorReason {
     /** If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned. */
@@ -705,6 +1253,19 @@ export declare enum KnownSemanticSearchResultsType {
  * **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;
+/** Known values of {@link SemanticQueryRewritesResultType} that the service accepts. */
+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"
+}
+/**
+ * Defines values for SemanticQueryRewritesResultType. \
+ * {@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;
 /** Defines values for QueryType. */
 export type QueryType = "simple" | "full" | "semantic";
 /** Defines values for SearchMode. */
@@ -729,16 +1290,28 @@ export interface DocumentsSearchGetOptionalParams extends coreClient.OperationOp
     searchOptions?: SearchOptions;
     /** A full-text search query expression; Use "*" or omit this parameter to match all documents. */
     searchText?: string;
+    /** Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. */
+    xMsQuerySourceAuthorization?: string;
+    /** A value that enables elevated read that bypass document level permission checks for the query operation. */
+    xMsEnableElevatedRead?: boolean;
 }
 /** Contains response data for the searchGet operation. */
 export type DocumentsSearchGetResponse = SearchDocumentsResult;
 /** Optional parameters. */
 export interface DocumentsSearchPostOptionalParams extends coreClient.OperationOptions {
+    /** Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. */
+    xMsQuerySourceAuthorization?: string;
+    /** A value that enables elevated read that bypass document level permission checks for the query operation. */
+    xMsEnableElevatedRead?: boolean;
 }
 /** Contains response data for the searchPost operation. */
 export type DocumentsSearchPostResponse = SearchDocumentsResult;
 /** Optional parameters. */
 export interface DocumentsGetOptionalParams extends coreClient.OperationOptions {
+    /** Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. */
+    xMsQuerySourceAuthorization?: string;
+    /** A value that enables elevated read that bypass document level permission checks for the query operation. */
+    xMsEnableElevatedRead?: boolean;
     /** List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. */
     selectedFields?: string[];
 }