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

package/dist/browser/models/azure/search/documents/models.js

@@ -0,0 +1,1021 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { parseCsvCollection } from "../../../../static-helpers/serialization/parse-csv-collection.js";
+import { serializeRecord } from "../../../../static-helpers/serialization/serialize-record.js";
+export function errorResponseDeserializer(item) {
+    return {
+        error: !item["error"] ? item["error"] : errorDetailDeserializer(item["error"]),
+    };
+}
+export function errorDetailDeserializer(item) {
+    return {
+        code: item["code"],
+        message: item["message"],
+        target: item["target"],
+        details: !item["details"] ? item["details"] : errorDetailArrayDeserializer(item["details"]),
+        additionalInfo: !item["additionalInfo"]
+            ? item["additionalInfo"]
+            : errorAdditionalInfoArrayDeserializer(item["additionalInfo"]),
+    };
+}
+export function errorDetailArrayDeserializer(result) {
+    return result.map((item) => {
+        return errorDetailDeserializer(item);
+    });
+}
+export function errorAdditionalInfoArrayDeserializer(result) {
+    return result.map((item) => {
+        return errorAdditionalInfoDeserializer(item);
+    });
+}
+export function errorAdditionalInfoDeserializer(item) {
+    return {
+        type: item["type"],
+        info: !item["info"]
+            ? item["info"]
+            : Object.fromEntries(Object.entries(item["info"]).map(([k, p]) => [k, p])),
+    };
+}
+export function searchDocumentsResultSerializer(_item) {
+    return {};
+}
+export function searchDocumentsResultDeserializer(item) {
+    return {
+        count: item["@odata.count"],
+        coverage: item["@search.coverage"],
+        facets: !item["@search.facets"]
+            ? item["@search.facets"]
+            : facetResultArrayRecordDeserializer(item["@search.facets"]),
+        answers: !item["@search.answers"]
+            ? item["@search.answers"]
+            : queryAnswerResultArrayDeserializer(item["@search.answers"]),
+        debugInfo: !item["@search.debug"]
+            ? item["@search.debug"]
+            : debugInfoDeserializer(item["@search.debug"]),
+        nextPageParameters: !item["@search.nextPageParameters"]
+            ? item["@search.nextPageParameters"]
+            : searchRequestDeserializer(item["@search.nextPageParameters"]),
+        results: searchResultArrayDeserializer(item["value"]),
+        nextLink: item["@odata.nextLink"],
+        semanticPartialResponseReason: item["@search.semanticPartialResponseReason"],
+        semanticPartialResponseType: item["@search.semanticPartialResponseType"],
+        semanticQueryRewritesResultType: item["@search.semanticQueryRewritesResultType"],
+    };
+}
+export function facetResultArrayRecordSerializer(item) {
+    const result = {};
+    Object.keys(item).map((key) => {
+        result[key] = !item[key] ? item[key] : facetResultArraySerializer(item[key]);
+    });
+    return result;
+}
+export function facetResultArrayRecordDeserializer(item) {
+    const result = {};
+    Object.keys(item).map((key) => {
+        result[key] = !item[key] ? item[key] : facetResultArrayDeserializer(item[key]);
+    });
+    return result;
+}
+export function facetResultArraySerializer(result) {
+    return result.map((item) => {
+        return facetResultSerializer(item);
+    });
+}
+export function facetResultArrayDeserializer(result) {
+    return result.map((item) => {
+        return facetResultDeserializer(item);
+    });
+}
+export function facetResultSerializer(item) {
+    return { ...serializeRecord(item.additionalProperties ?? {}) };
+}
+export function facetResultDeserializer(item) {
+    return {
+        additionalProperties: serializeRecord(item, [
+            "count",
+            "avg",
+            "min",
+            "max",
+            "sum",
+            "cardinality",
+            "facets",
+        ]),
+        count: item["count"],
+        avg: item["avg"],
+        min: item["min"],
+        max: item["max"],
+        sum: item["sum"],
+        cardinality: item["cardinality"],
+        facets: !item["@search.facets"]
+            ? item["@search.facets"]
+            : facetResultArrayRecordDeserializer(item["@search.facets"]),
+    };
+}
+export function queryAnswerResultArraySerializer(result) {
+    return result.map((item) => {
+        return queryAnswerResultSerializer(item);
+    });
+}
+export function queryAnswerResultArrayDeserializer(result) {
+    return result.map((item) => {
+        return queryAnswerResultDeserializer(item);
+    });
+}
+export function queryAnswerResultSerializer(item) {
+    return { ...serializeRecord(item.additionalProperties ?? {}) };
+}
+export function queryAnswerResultDeserializer(item) {
+    return {
+        additionalProperties: serializeRecord(item, ["score", "key", "text", "highlights"]),
+        score: item["score"],
+        key: item["key"],
+        text: item["text"],
+        highlights: item["highlights"],
+    };
+}
+export function debugInfoSerializer(_item) {
+    return {};
+}
+export function debugInfoDeserializer(item) {
+    return {
+        queryRewrites: !item["queryRewrites"]
+            ? item["queryRewrites"]
+            : queryRewritesDebugInfoDeserializer(item["queryRewrites"]),
+    };
+}
+export function queryRewritesDebugInfoDeserializer(item) {
+    return {
+        text: !item["text"] ? item["text"] : queryRewritesValuesDebugInfoDeserializer(item["text"]),
+        vectors: !item["vectors"]
+            ? item["vectors"]
+            : queryRewritesValuesDebugInfoArrayDeserializer(item["vectors"]),
+    };
+}
+export function queryRewritesValuesDebugInfoDeserializer(item) {
+    return {
+        inputQuery: item["inputQuery"],
+        rewrites: !item["rewrites"]
+            ? item["rewrites"]
+            : item["rewrites"].map((p) => {
+                return p;
+            }),
+    };
+}
+export function queryRewritesValuesDebugInfoArrayDeserializer(result) {
+    return result.map((item) => {
+        return queryRewritesValuesDebugInfoDeserializer(item);
+    });
+}
+export function searchRequestDeserializer(item) {
+    return {
+        includeTotalCount: item["count"],
+        facets: !item["facets"]
+            ? item["facets"]
+            : item["facets"].map((p) => {
+                return p;
+            }),
+        filter: item["filter"],
+        highlightFields: item["highlight"] === null || item["highlight"] === undefined
+            ? item["highlight"]
+            : parseCsvCollection(item["highlight"]),
+        highlightPostTag: item["highlightPostTag"],
+        highlightPreTag: item["highlightPreTag"],
+        minimumCoverage: item["minimumCoverage"],
+        orderBy: item["orderby"],
+        queryType: item["queryType"],
+        scoringStatistics: item["scoringStatistics"],
+        sessionId: item["sessionId"],
+        scoringParameters: !item["scoringParameters"]
+            ? item["scoringParameters"]
+            : item["scoringParameters"].map((p) => {
+                return p;
+            }),
+        scoringProfile: item["scoringProfile"],
+        debug: item["debug"],
+        searchText: item["search"],
+        searchFields: item["searchFields"],
+        searchMode: item["searchMode"],
+        queryLanguage: item["queryLanguage"],
+        querySpeller: item["speller"],
+        select: item["select"],
+        skip: item["skip"],
+        top: item["top"],
+        semanticConfigurationName: item["semanticConfiguration"],
+        semanticErrorHandling: item["semanticErrorHandling"],
+        semanticMaxWaitInMilliseconds: item["semanticMaxWaitInMilliseconds"],
+        semanticQuery: item["semanticQuery"],
+        answers: item["answers"],
+        captions: item["captions"],
+        queryRewrites: item["queryRewrites"],
+        semanticFields: item["semanticFields"] === null || item["semanticFields"] === undefined
+            ? item["semanticFields"]
+            : parseCsvCollection(item["semanticFields"]),
+        vectorQueries: !item["vectorQueries"]
+            ? item["vectorQueries"]
+            : vectorQueryUnionArrayDeserializer(item["vectorQueries"]),
+        vectorFilterMode: item["vectorFilterMode"],
+        hybridSearch: !item["hybridSearch"]
+            ? item["hybridSearch"]
+            : hybridSearchDeserializer(item["hybridSearch"]),
+    };
+}
+/** 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 var KnownQueryType;
+(function (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. */
+    KnownQueryType["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. */
+    KnownQueryType["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. */
+    KnownQueryType["Semantic"] = "semantic";
+})(KnownQueryType || (KnownQueryType = {}));
+/** 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 var KnownQueryDebugMode;
+(function (KnownQueryDebugMode) {
+    /** No query debugging information will be returned. */
+    KnownQueryDebugMode["Disabled"] = "disabled";
+    /** Allows the user to further explore their reranked results. */
+    KnownQueryDebugMode["Semantic"] = "semantic";
+    /** Allows the user to further explore their hybrid and vector query results. */
+    KnownQueryDebugMode["Vector"] = "vector";
+    /** Allows the user to explore the list of query rewrites generated for their search request. */
+    KnownQueryDebugMode["QueryRewrites"] = "queryRewrites";
+    /** Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. */
+    KnownQueryDebugMode["InnerHits"] = "innerHits";
+    /** Turn on all debug options. */
+    KnownQueryDebugMode["All"] = "all";
+})(KnownQueryDebugMode || (KnownQueryDebugMode = {}));
+/** The language of the query. */
+export var KnownQueryLanguage;
+(function (KnownQueryLanguage) {
+    /** Query language not specified. */
+    KnownQueryLanguage["None"] = "none";
+    /** Query language value for English (United States). */
+    KnownQueryLanguage["EnUs"] = "en-us";
+    /** Query language value for English (Great Britain). */
+    KnownQueryLanguage["EnGb"] = "en-gb";
+    /** Query language value for English (India). */
+    KnownQueryLanguage["EnIn"] = "en-in";
+    /** Query language value for English (Canada). */
+    KnownQueryLanguage["EnCa"] = "en-ca";
+    /** Query language value for English (Australia). */
+    KnownQueryLanguage["EnAu"] = "en-au";
+    /** Query language value for French (France). */
+    KnownQueryLanguage["FrFr"] = "fr-fr";
+    /** Query language value for French (Canada). */
+    KnownQueryLanguage["FrCa"] = "fr-ca";
+    /** Query language value for German (Germany). */
+    KnownQueryLanguage["DeDe"] = "de-de";
+    /** Query language value for Spanish (Spain). */
+    KnownQueryLanguage["EsEs"] = "es-es";
+    /** Query language value for Spanish (Mexico). */
+    KnownQueryLanguage["EsMx"] = "es-mx";
+    /** Query language value for Chinese (China). */
+    KnownQueryLanguage["ZhCn"] = "zh-cn";
+    /** Query language value for Chinese (Taiwan). */
+    KnownQueryLanguage["ZhTw"] = "zh-tw";
+    /** Query language value for Portuguese (Brazil). */
+    KnownQueryLanguage["PtBr"] = "pt-br";
+    /** Query language value for Portuguese (Portugal). */
+    KnownQueryLanguage["PtPt"] = "pt-pt";
+    /** Query language value for Italian (Italy). */
+    KnownQueryLanguage["ItIt"] = "it-it";
+    /** Query language value for Japanese (Japan). */
+    KnownQueryLanguage["JaJp"] = "ja-jp";
+    /** Query language value for Korean (Korea). */
+    KnownQueryLanguage["KoKr"] = "ko-kr";
+    /** Query language value for Russian (Russia). */
+    KnownQueryLanguage["RuRu"] = "ru-ru";
+    /** Query language value for Czech (Czech Republic). */
+    KnownQueryLanguage["CsCz"] = "cs-cz";
+    /** Query language value for Dutch (Belgium). */
+    KnownQueryLanguage["NlBe"] = "nl-be";
+    /** Query language value for Dutch (Netherlands). */
+    KnownQueryLanguage["NlNl"] = "nl-nl";
+    /** Query language value for Hungarian (Hungary). */
+    KnownQueryLanguage["HuHu"] = "hu-hu";
+    /** Query language value for Polish (Poland). */
+    KnownQueryLanguage["PlPl"] = "pl-pl";
+    /** Query language value for Swedish (Sweden). */
+    KnownQueryLanguage["SvSe"] = "sv-se";
+    /** Query language value for Turkish (Turkey). */
+    KnownQueryLanguage["TrTr"] = "tr-tr";
+    /** Query language value for Hindi (India). */
+    KnownQueryLanguage["HiIn"] = "hi-in";
+    /** Query language value for Arabic (Saudi Arabia). */
+    KnownQueryLanguage["ArSa"] = "ar-sa";
+    /** Query language value for Arabic (Egypt). */
+    KnownQueryLanguage["ArEg"] = "ar-eg";
+    /** Query language value for Arabic (Morocco). */
+    KnownQueryLanguage["ArMa"] = "ar-ma";
+    /** Query language value for Arabic (Kuwait). */
+    KnownQueryLanguage["ArKw"] = "ar-kw";
+    /** Query language value for Arabic (Jordan). */
+    KnownQueryLanguage["ArJo"] = "ar-jo";
+    /** Query language value for Danish (Denmark). */
+    KnownQueryLanguage["DaDk"] = "da-dk";
+    /** Query language value for Norwegian (Norway). */
+    KnownQueryLanguage["NoNo"] = "no-no";
+    /** Query language value for Bulgarian (Bulgaria). */
+    KnownQueryLanguage["BgBg"] = "bg-bg";
+    /** Query language value for Croatian (Croatia). */
+    KnownQueryLanguage["HrHr"] = "hr-hr";
+    /** Query language value for Croatian (Bosnia and Herzegovina). */
+    KnownQueryLanguage["HrBa"] = "hr-ba";
+    /** Query language value for Malay (Malaysia). */
+    KnownQueryLanguage["MsMy"] = "ms-my";
+    /** Query language value for Malay (Brunei Darussalam). */
+    KnownQueryLanguage["MsBn"] = "ms-bn";
+    /** Query language value for Slovenian (Slovenia). */
+    KnownQueryLanguage["SlSl"] = "sl-sl";
+    /** Query language value for Tamil (India). */
+    KnownQueryLanguage["TaIn"] = "ta-in";
+    /** Query language value for Vietnamese (Viet Nam). */
+    KnownQueryLanguage["ViVn"] = "vi-vn";
+    /** Query language value for Greek (Greece). */
+    KnownQueryLanguage["ElGr"] = "el-gr";
+    /** Query language value for Romanian (Romania). */
+    KnownQueryLanguage["RoRo"] = "ro-ro";
+    /** Query language value for Icelandic (Iceland). */
+    KnownQueryLanguage["IsIs"] = "is-is";
+    /** Query language value for Indonesian (Indonesia). */
+    KnownQueryLanguage["IdId"] = "id-id";
+    /** Query language value for Thai (Thailand). */
+    KnownQueryLanguage["ThTh"] = "th-th";
+    /** Query language value for Lithuanian (Lithuania). */
+    KnownQueryLanguage["LtLt"] = "lt-lt";
+    /** Query language value for Ukrainian (Ukraine). */
+    KnownQueryLanguage["UkUa"] = "uk-ua";
+    /** Query language value for Latvian (Latvia). */
+    KnownQueryLanguage["LvLv"] = "lv-lv";
+    /** Query language value for Estonian (Estonia). */
+    KnownQueryLanguage["EtEe"] = "et-ee";
+    /** Query language value for Catalan. */
+    KnownQueryLanguage["CaEs"] = "ca-es";
+    /** Query language value for Finnish (Finland). */
+    KnownQueryLanguage["FiFi"] = "fi-fi";
+    /** Query language value for Serbian (Bosnia and Herzegovina). */
+    KnownQueryLanguage["SrBa"] = "sr-ba";
+    /** Query language value for Serbian (Montenegro). */
+    KnownQueryLanguage["SrMe"] = "sr-me";
+    /** Query language value for Serbian (Serbia). */
+    KnownQueryLanguage["SrRs"] = "sr-rs";
+    /** Query language value for Slovak (Slovakia). */
+    KnownQueryLanguage["SkSk"] = "sk-sk";
+    /** Query language value for Norwegian (Norway). */
+    KnownQueryLanguage["NbNo"] = "nb-no";
+    /** Query language value for Armenian (Armenia). */
+    KnownQueryLanguage["HyAm"] = "hy-am";
+    /** Query language value for Bengali (India). */
+    KnownQueryLanguage["BnIn"] = "bn-in";
+    /** Query language value for Basque. */
+    KnownQueryLanguage["EuEs"] = "eu-es";
+    /** Query language value for Galician. */
+    KnownQueryLanguage["GlEs"] = "gl-es";
+    /** Query language value for Gujarati (India). */
+    KnownQueryLanguage["GuIn"] = "gu-in";
+    /** Query language value for Hebrew (Israel). */
+    KnownQueryLanguage["HeIl"] = "he-il";
+    /** Query language value for Irish (Ireland). */
+    KnownQueryLanguage["GaIe"] = "ga-ie";
+    /** Query language value for Kannada (India). */
+    KnownQueryLanguage["KnIn"] = "kn-in";
+    /** Query language value for Malayalam (India). */
+    KnownQueryLanguage["MlIn"] = "ml-in";
+    /** Query language value for Marathi (India). */
+    KnownQueryLanguage["MrIn"] = "mr-in";
+    /** Query language value for Persian (U.A.E.). */
+    KnownQueryLanguage["FaAe"] = "fa-ae";
+    /** Query language value for Punjabi (India). */
+    KnownQueryLanguage["PaIn"] = "pa-in";
+    /** Query language value for Telugu (India). */
+    KnownQueryLanguage["TeIn"] = "te-in";
+    /** Query language value for Urdu (Pakistan). */
+    KnownQueryLanguage["UrPk"] = "ur-pk";
+})(KnownQueryLanguage || (KnownQueryLanguage = {}));
+/** Improve search recall by spell-correcting individual search query terms. */
+export var KnownQuerySpellerType;
+(function (KnownQuerySpellerType) {
+    /** Speller not enabled. */
+    KnownQuerySpellerType["None"] = "none";
+    /** Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. */
+    KnownQuerySpellerType["Lexicon"] = "lexicon";
+})(KnownQuerySpellerType || (KnownQuerySpellerType = {}));
+/** Allows the user to choose whether a semantic call should fail completely, or to return partial results. */
+export var KnownSemanticErrorMode;
+(function (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. */
+    KnownSemanticErrorMode["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. */
+    KnownSemanticErrorMode["Fail"] = "fail";
+})(KnownSemanticErrorMode || (KnownSemanticErrorMode = {}));
+/** 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 var KnownQueryAnswerType;
+(function (KnownQueryAnswerType) {
+    /** Do not return answers for the query. */
+    KnownQueryAnswerType["None"] = "none";
+    /** Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. */
+    KnownQueryAnswerType["Extractive"] = "extractive";
+})(KnownQueryAnswerType || (KnownQueryAnswerType = {}));
+/** 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 var KnownQueryCaptionType;
+(function (KnownQueryCaptionType) {
+    /** Do not return captions for the query. */
+    KnownQueryCaptionType["None"] = "none";
+    /** Extracts captions from the matching documents that contain passages relevant to the search query. */
+    KnownQueryCaptionType["Extractive"] = "extractive";
+})(KnownQueryCaptionType || (KnownQueryCaptionType = {}));
+/** 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 var KnownQueryRewritesType;
+(function (KnownQueryRewritesType) {
+    /** Do not generate additional query rewrites for this query. */
+    KnownQueryRewritesType["None"] = "none";
+    /** Generate alternative query terms to increase the recall of a search request. */
+    KnownQueryRewritesType["Generative"] = "generative";
+})(KnownQueryRewritesType || (KnownQueryRewritesType = {}));
+export function vectorQueryUnionArraySerializer(result) {
+    return result.map((item) => {
+        return vectorQueryUnionSerializer(item);
+    });
+}
+export function vectorQueryUnionArrayDeserializer(result) {
+    return result.map((item) => {
+        return vectorQueryUnionDeserializer(item);
+    });
+}
+export function vectorQuerySerializer(item) {
+    return {
+        k: item["kNearestNeighborsCount"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionSerializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+    };
+}
+export function vectorQueryDeserializer(item) {
+    return {
+        kNearestNeighborsCount: item["k"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionDeserializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+    };
+}
+export function vectorQueryUnionSerializer(item) {
+    switch (item.kind) {
+        case "vector":
+            return vectorizedQuerySerializer(item);
+        case "text":
+            return vectorizableTextQuerySerializer(item);
+        case "imageUrl":
+            return vectorizableImageUrlQuerySerializer(item);
+        case "imageBinary":
+            return vectorizableImageBinaryQuerySerializer(item);
+        default:
+            return vectorQuerySerializer(item);
+    }
+}
+export function vectorQueryUnionDeserializer(item) {
+    switch (item["kind"]) {
+        case "vector":
+            return vectorizedQueryDeserializer(item);
+        case "text":
+            return vectorizableTextQueryDeserializer(item);
+        case "imageUrl":
+            return vectorizableImageUrlQueryDeserializer(item);
+        case "imageBinary":
+            return vectorizableImageBinaryQueryDeserializer(item);
+        default:
+            return vectorQueryDeserializer(item);
+    }
+}
+export function vectorThresholdSerializer(item) {
+    return { kind: item["kind"] };
+}
+export function vectorThresholdDeserializer(item) {
+    return {
+        kind: item["kind"],
+    };
+}
+export function vectorThresholdUnionSerializer(item) {
+    switch (item.kind) {
+        case "vectorSimilarity":
+            return vectorSimilarityThresholdSerializer(item);
+        case "searchScore":
+            return searchScoreThresholdSerializer(item);
+        default:
+            return vectorThresholdSerializer(item);
+    }
+}
+export function vectorThresholdUnionDeserializer(item) {
+    switch (item["kind"]) {
+        case "vectorSimilarity":
+            return vectorSimilarityThresholdDeserializer(item);
+        case "searchScore":
+            return searchScoreThresholdDeserializer(item);
+        default:
+            return vectorThresholdDeserializer(item);
+    }
+}
+/** The kind of threshold used to filter vector queries. */
+export var KnownVectorThresholdKind;
+(function (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. */
+    KnownVectorThresholdKind["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. */
+    KnownVectorThresholdKind["SearchScore"] = "searchScore";
+})(KnownVectorThresholdKind || (KnownVectorThresholdKind = {}));
+export function vectorSimilarityThresholdSerializer(item) {
+    return { kind: item["kind"], value: item["value"] };
+}
+export function vectorSimilarityThresholdDeserializer(item) {
+    return {
+        kind: item["kind"],
+        value: item["value"],
+    };
+}
+export function searchScoreThresholdSerializer(item) {
+    return { kind: item["kind"], value: item["value"] };
+}
+export function searchScoreThresholdDeserializer(item) {
+    return {
+        kind: item["kind"],
+        value: item["value"],
+    };
+}
+/** The kind of vector query being performed. */
+export var KnownVectorQueryKind;
+(function (KnownVectorQueryKind) {
+    /** Vector query where a raw vector value is provided. */
+    KnownVectorQueryKind["Vector"] = "vector";
+    /** Vector query where a text value that needs to be vectorized is provided. */
+    KnownVectorQueryKind["Text"] = "text";
+    /** Vector query where an url that represents an image value that needs to be vectorized is provided. */
+    KnownVectorQueryKind["ImageUrl"] = "imageUrl";
+    /** Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. */
+    KnownVectorQueryKind["ImageBinary"] = "imageBinary";
+})(KnownVectorQueryKind || (KnownVectorQueryKind = {}));
+export function vectorizedQuerySerializer(item) {
+    return {
+        k: item["kNearestNeighborsCount"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionSerializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        vector: item["vector"].map((p) => {
+            return p;
+        }),
+    };
+}
+export function vectorizedQueryDeserializer(item) {
+    return {
+        kNearestNeighborsCount: item["k"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionDeserializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        vector: item["vector"].map((p) => {
+            return p;
+        }),
+    };
+}
+export function vectorizableTextQuerySerializer(item) {
+    return {
+        k: item["kNearestNeighborsCount"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionSerializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        text: item["text"],
+        queryRewrites: item["queryRewrites"],
+    };
+}
+export function vectorizableTextQueryDeserializer(item) {
+    return {
+        kNearestNeighborsCount: item["k"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionDeserializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        text: item["text"],
+        queryRewrites: item["queryRewrites"],
+    };
+}
+export function vectorizableImageUrlQuerySerializer(item) {
+    return {
+        k: item["kNearestNeighborsCount"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionSerializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        url: item["url"],
+    };
+}
+export function vectorizableImageUrlQueryDeserializer(item) {
+    return {
+        kNearestNeighborsCount: item["k"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionDeserializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        url: item["url"],
+    };
+}
+export function vectorizableImageBinaryQuerySerializer(item) {
+    return {
+        k: item["kNearestNeighborsCount"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionSerializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        base64Image: item["base64Image"],
+    };
+}
+export function vectorizableImageBinaryQueryDeserializer(item) {
+    return {
+        kNearestNeighborsCount: item["k"],
+        fields: item["fields"],
+        exhaustive: item["exhaustive"],
+        oversampling: item["oversampling"],
+        weight: item["weight"],
+        threshold: !item["threshold"]
+            ? item["threshold"]
+            : vectorThresholdUnionDeserializer(item["threshold"]),
+        filterOverride: item["filterOverride"],
+        perDocumentVectorLimit: item["perDocumentVectorLimit"],
+        kind: item["kind"],
+        base64Image: item["base64Image"],
+    };
+}
+/** Determines whether or not filters are applied before or after the vector search is performed. */
+export var KnownVectorFilterMode;
+(function (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'. */
+    KnownVectorFilterMode["PostFilter"] = "postFilter";
+    /** The filter will be applied before the search query. */
+    KnownVectorFilterMode["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'. */
+    KnownVectorFilterMode["StrictPostFilter"] = "strictPostFilter";
+})(KnownVectorFilterMode || (KnownVectorFilterMode = {}));
+export function hybridSearchSerializer(item) {
+    return {
+        maxTextRecallSize: item["maxTextRecallSize"],
+        countAndFacetMode: item["countAndFacetMode"],
+    };
+}
+export function hybridSearchDeserializer(item) {
+    return {
+        maxTextRecallSize: item["maxTextRecallSize"],
+        countAndFacetMode: item["countAndFacetMode"],
+    };
+}
+/** 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 var KnownHybridCountAndFacetMode;
+(function (KnownHybridCountAndFacetMode) {
+    /** Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. */
+    KnownHybridCountAndFacetMode["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. */
+    KnownHybridCountAndFacetMode["CountAllResults"] = "countAllResults";
+})(KnownHybridCountAndFacetMode || (KnownHybridCountAndFacetMode = {}));
+export function searchResultArraySerializer(result) {
+    return result.map((item) => {
+        return searchResultSerializer(item);
+    });
+}
+export function searchResultArrayDeserializer(result) {
+    return result.map((item) => {
+        return searchResultDeserializer(item);
+    });
+}
+export function searchResultSerializer(item) {
+    return { ...serializeRecord(item.additionalProperties ?? {}) };
+}
+export function searchResultDeserializer(item) {
+    return {
+        additionalProperties: serializeRecord(item, [
+            "score",
+            "rerankerScore",
+            "rerankerBoostedScore",
+            "highlights",
+            "captions",
+            "documentDebugInfo",
+        ]),
+        score: item["@search.score"],
+        rerankerScore: item["@search.rerankerScore"],
+        rerankerBoostedScore: item["@search.rerankerBoostedScore"],
+        highlights: !item["@search.highlights"]
+            ? item["@search.highlights"]
+            : Object.fromEntries(Object.entries(item["@search.highlights"]).map(([k, p]) => [
+                k,
+                p.map((p1) => {
+                    return p1;
+                }),
+            ])),
+        captions: !item["@search.captions"]
+            ? item["@search.captions"]
+            : queryCaptionResultArrayDeserializer(item["@search.captions"]),
+        documentDebugInfo: !item["@search.documentDebugInfo"]
+            ? item["@search.documentDebugInfo"]
+            : documentDebugInfoDeserializer(item["@search.documentDebugInfo"]),
+    };
+}
+export function queryCaptionResultArrayDeserializer(result) {
+    return result.map((item) => {
+        return queryCaptionResultDeserializer(item);
+    });
+}
+export function queryCaptionResultDeserializer(item) {
+    return {
+        additionalProperties: serializeRecord(item, ["text", "highlights"]),
+        text: item["text"],
+        highlights: item["highlights"],
+    };
+}
+export function documentDebugInfoDeserializer(item) {
+    return {
+        semantic: !item["semantic"]
+            ? item["semantic"]
+            : semanticDebugInfoDeserializer(item["semantic"]),
+        vectors: !item["vectors"] ? item["vectors"] : vectorsDebugInfoDeserializer(item["vectors"]),
+        innerHits: !item["innerHits"]
+            ? item["innerHits"]
+            : queryResultDocumentInnerHitArrayRecordDeserializer(item["innerHits"]),
+    };
+}
+export function semanticDebugInfoDeserializer(item) {
+    return {
+        titleField: !item["titleField"]
+            ? item["titleField"]
+            : queryResultDocumentSemanticFieldDeserializer(item["titleField"]),
+        contentFields: !item["contentFields"]
+            ? item["contentFields"]
+            : queryResultDocumentSemanticFieldArrayDeserializer(item["contentFields"]),
+        keywordFields: !item["keywordFields"]
+            ? item["keywordFields"]
+            : queryResultDocumentSemanticFieldArrayDeserializer(item["keywordFields"]),
+        rerankerInput: !item["rerankerInput"]
+            ? item["rerankerInput"]
+            : queryResultDocumentRerankerInputDeserializer(item["rerankerInput"]),
+    };
+}
+export function queryResultDocumentSemanticFieldDeserializer(item) {
+    return {
+        name: item["name"],
+        state: item["state"],
+    };
+}
+/** The way the field was used for the semantic enrichment process. */
+export var KnownSemanticFieldState;
+(function (KnownSemanticFieldState) {
+    /** The field was fully used for semantic enrichment. */
+    KnownSemanticFieldState["Used"] = "used";
+    /** The field was not used for semantic enrichment. */
+    KnownSemanticFieldState["Unused"] = "unused";
+    /** The field was partially used for semantic enrichment. */
+    KnownSemanticFieldState["Partial"] = "partial";
+})(KnownSemanticFieldState || (KnownSemanticFieldState = {}));
+export function queryResultDocumentSemanticFieldArrayDeserializer(result) {
+    return result.map((item) => {
+        return queryResultDocumentSemanticFieldDeserializer(item);
+    });
+}
+export function queryResultDocumentRerankerInputDeserializer(item) {
+    return {
+        title: item["title"],
+        content: item["content"],
+        keywords: item["keywords"],
+    };
+}
+export function vectorsDebugInfoDeserializer(item) {
+    return {
+        subscores: !item["subscores"]
+            ? item["subscores"]
+            : queryResultDocumentSubscoresDeserializer(item["subscores"]),
+    };
+}
+export function queryResultDocumentSubscoresDeserializer(item) {
+    return {
+        text: !item["text"] ? item["text"] : textResultDeserializer(item["text"]),
+        vectors: !item["vectors"]
+            ? item["vectors"]
+            : singleVectorFieldResultRecordArrayDeserializer(item["vectors"]),
+        documentBoost: item["documentBoost"],
+    };
+}
+export function textResultDeserializer(item) {
+    return {
+        searchScore: item["searchScore"],
+    };
+}
+export function singleVectorFieldResultRecordArrayDeserializer(result) {
+    return result.map((item) => {
+        return singleVectorFieldResultRecordDeserializer(item);
+    });
+}
+export function singleVectorFieldResultRecordDeserializer(item) {
+    const result = {};
+    Object.keys(item).map((key) => {
+        result[key] = !item[key] ? item[key] : singleVectorFieldResultDeserializer(item[key]);
+    });
+    return result;
+}
+export function singleVectorFieldResultDeserializer(item) {
+    return {
+        searchScore: item["searchScore"],
+        vectorSimilarity: item["vectorSimilarity"],
+    };
+}
+export function queryResultDocumentInnerHitArrayRecordDeserializer(item) {
+    const result = {};
+    Object.keys(item).map((key) => {
+        result[key] = !item[key] ? item[key] : queryResultDocumentInnerHitArrayDeserializer(item[key]);
+    });
+    return result;
+}
+export function queryResultDocumentInnerHitArrayDeserializer(result) {
+    return result.map((item) => {
+        return queryResultDocumentInnerHitDeserializer(item);
+    });
+}
+export function queryResultDocumentInnerHitDeserializer(item) {
+    return {
+        ordinal: item["ordinal"],
+        vectors: !item["vectors"]
+            ? item["vectors"]
+            : singleVectorFieldResultRecordArrayDeserializer(item["vectors"]),
+    };
+}
+/** Reason that a partial response was returned for a semantic ranking request. */
+export var KnownSemanticErrorReason;
+(function (KnownSemanticErrorReason) {
+    /** If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned. */
+    KnownSemanticErrorReason["MaxWaitExceeded"] = "maxWaitExceeded";
+    /** The request was throttled. Only the base results were returned. */
+    KnownSemanticErrorReason["CapacityOverloaded"] = "capacityOverloaded";
+    /** At least one step of the semantic process failed. */
+    KnownSemanticErrorReason["Transient"] = "transient";
+})(KnownSemanticErrorReason || (KnownSemanticErrorReason = {}));
+/** Type of partial response that was returned for a semantic ranking request. */
+export var KnownSemanticSearchResultsType;
+(function (KnownSemanticSearchResultsType) {
+    /** Results without any semantic enrichment or reranking. */
+    KnownSemanticSearchResultsType["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. */
+    KnownSemanticSearchResultsType["RerankedResults"] = "rerankedResults";
+})(KnownSemanticSearchResultsType || (KnownSemanticSearchResultsType = {}));
+/** Type of query rewrite that was used for this request. */
+export var KnownSemanticQueryRewritesResultType;
+(function (KnownSemanticQueryRewritesResultType) {
+    /** Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. */
+    KnownSemanticQueryRewritesResultType["OriginalQueryOnly"] = "originalQueryOnly";
+})(KnownSemanticQueryRewritesResultType || (KnownSemanticQueryRewritesResultType = {}));
+export function lookupDocumentDeserializer(item) {
+    return {
+        additionalProperties: serializeRecord(item, []),
+    };
+}
+export function suggestDocumentsResultDeserializer(item) {
+    return {
+        results: suggestResultArrayDeserializer(item["value"]),
+        coverage: item["@search.coverage"],
+    };
+}
+export function suggestResultArraySerializer(result) {
+    return result.map((item) => {
+        return suggestResultSerializer(item);
+    });
+}
+export function suggestResultArrayDeserializer(result) {
+    return result.map((item) => {
+        return suggestResultDeserializer(item);
+    });
+}
+export function suggestResultSerializer(item) {
+    return { ...serializeRecord(item.additionalProperties ?? {}) };
+}
+export function suggestResultDeserializer(item) {
+    return {
+        additionalProperties: serializeRecord(item, ["text"]),
+        text: item["@search.text"],
+    };
+}
+export function indexDocumentsBatchSerializer(item) {
+    return { value: indexActionArraySerializer(item["actions"]) };
+}
+export function indexActionArraySerializer(result) {
+    return result.map((item) => {
+        return indexActionSerializer(item);
+    });
+}
+export function indexActionSerializer(item) {
+    return {
+        ...serializeRecord(item.additionalProperties ?? {}),
+        "@search.action": item["actionType"],
+    };
+}
+export function indexDocumentsResultDeserializer(item) {
+    return {
+        results: indexingResultArrayDeserializer(item["value"]),
+    };
+}
+export function indexingResultArraySerializer(result) {
+    return result.map((item) => {
+        return indexingResultSerializer(item);
+    });
+}
+export function indexingResultArrayDeserializer(result) {
+    return result.map((item) => {
+        return indexingResultDeserializer(item);
+    });
+}
+export function indexingResultSerializer(_item) {
+    return {};
+}
+export function indexingResultDeserializer(item) {
+    return {
+        key: item["key"],
+        errorMessage: item["errorMessage"],
+        succeeded: item["status"],
+        statusCode: item["statusCode"],
+    };
+}
+export function autocompleteResultDeserializer(item) {
+    return {
+        coverage: item["@search.coverage"],
+        results: autocompleteItemArrayDeserializer(item["value"]),
+    };
+}
+export function autocompleteItemArraySerializer(result) {
+    return result.map((item) => {
+        return autocompleteItemSerializer(item);
+    });
+}
+export function autocompleteItemArrayDeserializer(result) {
+    return result.map((item) => {
+        return autocompleteItemDeserializer(item);
+    });
+}
+export function autocompleteItemSerializer(_item) {
+    return {};
+}
+export function autocompleteItemDeserializer(item) {
+    return {
+        text: item["text"],
+        queryPlusText: item["queryPlusText"],
+    };
+}
+//# sourceMappingURL=models.js.map