@azure/search-documents 12.0.0-beta.1 → 12.0.0-beta.2

package/dist/index.js

@@ -134,6 +134,20 @@ const SearchDocumentsResult = {
                     className: "SearchRequest"
                 }
             },
+            semanticPartialResponseReason: {
+                serializedName: "@search\\.semanticPartialResponseReason",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            semanticPartialResponseType: {
+                serializedName: "@search\\.semanticPartialResponseType",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
             results: {
                 serializedName: "value",
                 required: true,
@@ -316,6 +330,28 @@ const SearchRequest = {
                     name: "String"
                 }
             },
+            semanticErrorHandling: {
+                serializedName: "semanticErrorHandling",
+                type: {
+                    name: "String"
+                }
+            },
+            semanticMaxWaitInMilliseconds: {
+                constraints: {
+                    InclusiveMinimum: 700
+                },
+                serializedName: "semanticMaxWaitInMilliseconds",
+                nullable: true,
+                type: {
+                    name: "Number"
+                }
+            },
+            debug: {
+                serializedName: "debug",
+                type: {
+                    name: "String"
+                }
+            },
             searchText: {
                 serializedName: "search",
                 type: {
@@ -382,6 +418,44 @@ const SearchRequest = {
                 type: {
                     name: "String"
                 }
+            },
+            vector: {
+                serializedName: "vector",
+                type: {
+                    name: "Composite",
+                    className: "Vector"
+                }
+            }
+        }
+    }
+};
+const Vector = {
+    type: {
+        name: "Composite",
+        className: "Vector",
+        modelProperties: {
+            value: {
+                serializedName: "value",
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Number"
+                        }
+                    }
+                }
+            },
+            kNearestNeighborsCount: {
+                serializedName: "k",
+                type: {
+                    name: "Number"
+                }
+            },
+            fields: {
+                serializedName: "fields",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -431,6 +505,20 @@ const SearchResult = {
                         }
                     }
                 }
+            },
+            documentDebugInfo: {
+                serializedName: "@search\\.documentDebugInfo",
+                readOnly: true,
+                nullable: true,
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "DocumentDebugInfo"
+                        }
+                    }
+                }
             }
         }
     }
@@ -459,6 +547,120 @@ const CaptionResult = {
         }
     }
 };
+const DocumentDebugInfo = {
+    type: {
+        name: "Composite",
+        className: "DocumentDebugInfo",
+        modelProperties: {
+            semantic: {
+                serializedName: "semantic",
+                type: {
+                    name: "Composite",
+                    className: "SemanticDebugInfo"
+                }
+            }
+        }
+    }
+};
+const SemanticDebugInfo = {
+    type: {
+        name: "Composite",
+        className: "SemanticDebugInfo",
+        modelProperties: {
+            titleField: {
+                serializedName: "titleField",
+                type: {
+                    name: "Composite",
+                    className: "QueryResultDocumentSemanticField"
+                }
+            },
+            contentFields: {
+                serializedName: "contentFields",
+                readOnly: true,
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "QueryResultDocumentSemanticField"
+                        }
+                    }
+                }
+            },
+            keywordFields: {
+                serializedName: "keywordFields",
+                readOnly: true,
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "QueryResultDocumentSemanticField"
+                        }
+                    }
+                }
+            },
+            rerankerInput: {
+                serializedName: "rerankerInput",
+                type: {
+                    name: "Composite",
+                    className: "QueryResultDocumentRerankerInput"
+                }
+            }
+        }
+    }
+};
+const QueryResultDocumentSemanticField = {
+    type: {
+        name: "Composite",
+        className: "QueryResultDocumentSemanticField",
+        modelProperties: {
+            name: {
+                serializedName: "name",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            state: {
+                serializedName: "state",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const QueryResultDocumentRerankerInput = {
+    type: {
+        name: "Composite",
+        className: "QueryResultDocumentRerankerInput",
+        modelProperties: {
+            title: {
+                serializedName: "title",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            content: {
+                serializedName: "content",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            },
+            keywords: {
+                serializedName: "keywords",
+                readOnly: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const SuggestDocumentsResult = {
     type: {
         name: "Composite",
@@ -812,8 +1014,13 @@ var Mappers$1 = /*#__PURE__*/Object.freeze({
     FacetResult: FacetResult,
     AnswerResult: AnswerResult,
     SearchRequest: SearchRequest,
+    Vector: Vector,
     SearchResult: SearchResult,
     CaptionResult: CaptionResult,
+    DocumentDebugInfo: DocumentDebugInfo,
+    SemanticDebugInfo: SemanticDebugInfo,
+    QueryResultDocumentSemanticField: QueryResultDocumentSemanticField,
+    QueryResultDocumentRerankerInput: QueryResultDocumentRerankerInput,
     SuggestDocumentsResult: SuggestDocumentsResult,
     SuggestResult: SuggestResult,
     SuggestRequest: SuggestRequest,
@@ -1017,6 +1224,36 @@ const semanticConfiguration = {
         }
     }
 };
+const semanticErrorHandling = {
+    parameterPath: ["options", "searchOptions", "semanticErrorHandling"],
+    mapper: {
+        serializedName: "semanticErrorHandling",
+        type: {
+            name: "String"
+        }
+    }
+};
+const semanticMaxWaitInMilliseconds = {
+    parameterPath: ["options", "searchOptions", "semanticMaxWaitInMilliseconds"],
+    mapper: {
+        constraints: {
+            InclusiveMinimum: 700
+        },
+        serializedName: "semanticMaxWaitInMilliseconds",
+        type: {
+            name: "Number"
+        }
+    }
+};
+const debug = {
+    parameterPath: ["options", "searchOptions", "debug"],
+    mapper: {
+        serializedName: "debug",
+        type: {
+            name: "String"
+        }
+    }
+};
 const searchFields = {
     parameterPath: ["options", "searchOptions", "searchFields"],
     mapper: {
@@ -1532,6 +1769,9 @@ const searchGetOperationSpec = {
         scoringParameters,
         scoringProfile,
         semanticConfiguration,
+        semanticErrorHandling,
+        semanticMaxWaitInMilliseconds,
+        debug,
         searchFields,
         queryLanguage,
         speller,
@@ -1734,7 +1974,7 @@ class SearchClient$1 extends coreHttpCompat__namespace.ExtendedServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-search-documents/12.0.0-beta.1`;
+        const packageDetails = `azsdk-js-search-documents/12.0.0-beta.2`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1770,10 +2010,6 @@ function createSearchApiKeyCredentialPolicy(credential) {
     };
 }
 
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const SDK_VERSION = "12.0.0-beta.1";
-
 // Copyright (c) Microsoft Corporation.
 /**
  * The `@azure/logger` configuration for this package.
@@ -2891,15 +3127,16 @@ function convertFieldsToPublic(fields) {
         return fields;
     }
     return fields.map((field) => {
-        let result;
         if (field.type === "Collection(Edm.ComplexType)" || field.type === "Edm.ComplexType") {
-            return {
+            const result = {
                 name: field.name,
                 type: field.type,
                 fields: convertFieldsToPublic(field.fields),
             };
+            return result;
         }
         else {
+            const type = field.type;
             const analyzerName = field.analyzer;
             const searchAnalyzerName = field.searchAnalyzer;
             const indexAnalyzerName = field.indexAnalyzer;
@@ -2907,14 +3144,15 @@ function convertFieldsToPublic(fields) {
             const normalizerName = field.normalizer;
             const { retrievable } = field, restField = tslib.__rest(field, ["retrievable"]);
             const hidden = typeof retrievable === "boolean" ? !retrievable : retrievable;
-            result = Object.assign(Object.assign({}, restField), { hidden,
+            const result = Object.assign(Object.assign({}, restField), { type,
+                hidden,
                 analyzerName,
                 searchAnalyzerName,
                 indexAnalyzerName,
                 synonymMapNames,
                 normalizerName });
+            return result;
         }
-        return result;
     });
 }
 function convertFieldsToGenerated(fields) {
@@ -3036,11 +3274,12 @@ function generatedIndexToPublicIndex(generatedIndex) {
         fields: convertFieldsToPublic(generatedIndex.fields),
         similarity: convertSimilarityToPublic(generatedIndex.similarity),
         semanticSettings: generatedIndex.semanticSettings,
+        vectorSearch: generatedIndex.vectorSearch,
     };
 }
 function generatedSearchResultToPublicSearchResult(results) {
     const returnValues = results.map((result) => {
-        const { _score, _highlights, rerankerScore, captions } = result, restProps = tslib.__rest(result, ["_score", "_highlights", "rerankerScore", "captions"]);
+        const { _score, _highlights, rerankerScore, captions, documentDebugInfo } = result, restProps = tslib.__rest(result, ["_score", "_highlights", "rerankerScore", "captions", "documentDebugInfo"]);
         const doc = Object.assign({}, restProps);
         const obj = {
             score: _score,
@@ -3048,6 +3287,7 @@ function generatedSearchResultToPublicSearchResult(results) {
             rerankerScore,
             captions,
             document: doc,
+            documentDebugInfo,
         };
         return obj;
     });
@@ -3070,23 +3310,8 @@ function generatedSuggestDocumentsResultToPublicSuggestDocumentsResult(searchDoc
     return result;
 }
 function publicIndexToGeneratedIndex(index) {
-    return {
-        name: index.name,
-        defaultScoringProfile: index.defaultScoringProfile,
-        corsOptions: index.corsOptions,
-        suggesters: index.suggesters,
-        encryptionKey: convertEncryptionKeyToGenerated(index.encryptionKey),
-        etag: index.etag,
-        tokenFilters: convertTokenFiltersToGenerated(index.tokenFilters),
-        charFilters: index.charFilters,
-        normalizers: index.normalizers,
-        scoringProfiles: index.scoringProfiles,
-        analyzers: convertAnalyzersToGenerated(index.analyzers),
-        tokenizers: convertTokenizersToGenerated(index.tokenizers),
-        fields: convertFieldsToGenerated(index.fields),
-        similarity: convertSimilarityToGenerated(index.similarity),
-        semanticSettings: index.semanticSettings,
-    };
+    const { encryptionKey, tokenFilters, analyzers, tokenizers, fields, similarity } = index;
+    return Object.assign(Object.assign({}, index), { encryptionKey: convertEncryptionKeyToGenerated(encryptionKey), tokenFilters: convertTokenFiltersToGenerated(tokenFilters), analyzers: convertAnalyzersToGenerated(analyzers), tokenizers: convertTokenizersToGenerated(tokenizers), fields: convertFieldsToGenerated(fields), similarity: convertSimilarityToGenerated(similarity) });
 }
 function generatedSkillsetToPublicSkillset(generatedSkillset) {
     return {
@@ -3094,7 +3319,7 @@ function generatedSkillsetToPublicSkillset(generatedSkillset) {
         description: generatedSkillset.description,
         skills: convertSkillsToPublic(generatedSkillset.skills),
         cognitiveServicesAccount: convertCognitiveServicesAccountToPublic(generatedSkillset.cognitiveServicesAccount),
-        knowledgeStore: generatedSkillset.knowledgeStore,
+        knowledgeStore: convertKnowledgeStoreToPublic(generatedSkillset.knowledgeStore),
         etag: generatedSkillset.etag,
         encryptionKey: convertEncryptionKeyToPublic(generatedSkillset.encryptionKey),
     };
@@ -3137,7 +3362,11 @@ function publicSearchIndexerToGeneratedSearchIndexer(indexer) {
     return Object.assign(Object.assign({}, indexer), { encryptionKey: convertEncryptionKeyToGenerated(indexer.encryptionKey) });
 }
 function generatedSearchIndexerToPublicSearchIndexer(indexer) {
-    return Object.assign(Object.assign({}, indexer), { encryptionKey: convertEncryptionKeyToPublic(indexer.encryptionKey) });
+    return Object.assign(Object.assign({}, indexer), { encryptionKey: convertEncryptionKeyToPublic(indexer.encryptionKey), cache: convertSearchIndexerCacheToPublic(indexer.cache) });
+}
+function generatedSearchRequestToPublicSearchRequest(request) {
+    const { semanticErrorHandling, debug, vector } = request, props = tslib.__rest(request, ["semanticErrorHandling", "debug", "vector"]);
+    return Object.assign({ semanticErrorHandlingMode: semanticErrorHandling, debugMode: debug, vector: convertVectorToPublic(vector) }, props);
 }
 function publicDataSourceToGeneratedDataSource(dataSource) {
     return {
@@ -3198,6 +3427,14 @@ function convertDataDeletionDetectionPolicyToPublic(dataDeletionDetectionPolicy)
     }
     return dataDeletionDetectionPolicy;
 }
+function convertVectorToPublic(vector) {
+    var _a;
+    if (!vector) {
+        return vector;
+    }
+    const fields = (_a = vector.fields) === null || _a === void 0 ? void 0 : _a.split(",");
+    return Object.assign(Object.assign({}, vector), { fields });
+}
 function getRandomIntegerInclusive(min, max) {
     // Make sure inputs are integers.
     min = Math.ceil(min);
@@ -3216,7 +3453,19 @@ function getRandomIntegerInclusive(min, max) {
 function delay(timeInMs) {
     return new Promise((resolve) => setTimeout(() => resolve(), timeInMs));
 }
-const defaultServiceVersion = "2021-04-30-Preview";
+const defaultServiceVersion = "2023-07-01-Preview";
+function convertKnowledgeStoreToPublic(knowledgeStore) {
+    if (!knowledgeStore) {
+        return knowledgeStore;
+    }
+    return Object.assign(Object.assign({}, knowledgeStore), { identity: convertSearchIndexerDataIdentityToPublic(knowledgeStore.identity) });
+}
+function convertSearchIndexerCacheToPublic(cache) {
+    if (!cache) {
+        return cache;
+    }
+    return Object.assign(Object.assign({}, cache), { identity: convertSearchIndexerDataIdentityToPublic(cache.identity) });
+}
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -3298,16 +3547,6 @@ class SearchClient {
         this.apiVersion = defaultServiceVersion;
         this.endpoint = endpoint;
         this.indexName = indexName;
-        const libInfo = `azsdk-js-search-documents/${SDK_VERSION}`;
-        if (!options.userAgentOptions) {
-            options.userAgentOptions = {};
-        }
-        if (options.userAgentOptions.userAgentPrefix) {
-            options.userAgentOptions.userAgentPrefix = `${options.userAgentOptions.userAgentPrefix} ${libInfo}`;
-        }
-        else {
-            options.userAgentOptions.userAgentPrefix = libInfo;
-        }
         const internalClientPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
                 logger: logger.info,
@@ -3374,7 +3613,7 @@ class SearchClient {
      * import {
      *   AzureKeyCredential,
      *   SearchClient,
-     *   SelectFields,
+     *   SearchFieldArray,
      * } from "@azure/search-documents";
      *
      * type TModel = {
@@ -3388,7 +3627,7 @@ class SearchClient {
      *   new AzureKeyCredential("key")
      * );
      *
-     * const searchFields: SelectFields<TModel>[] = ["azure/sdk"];
+     * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
      *
      * const autocompleteResult = await client.autocomplete(
      *   "searchText",
@@ -3398,8 +3637,7 @@ class SearchClient {
      * ```
      */
     async autocomplete(searchText, suggesterName, options = {}) {
-        const { operationOptions, restOptions } = this.extractOperationOptions(Object.assign({}, options));
-        const { searchFields } = restOptions, nonFieldOptions = tslib.__rest(restOptions, ["searchFields"]);
+        const { searchFields } = options, nonFieldOptions = tslib.__rest(options, ["searchFields"]);
         const fullOptions = Object.assign({ searchText: searchText, suggesterName: suggesterName, searchFields: this.convertSearchFields(searchFields) }, nonFieldOptions);
         if (!fullOptions.searchText) {
             throw new RangeError("searchText must be provided.");
@@ -3407,7 +3645,7 @@ class SearchClient {
         if (!fullOptions.suggesterName) {
             throw new RangeError("suggesterName must be provided.");
         }
-        const { span, updatedOptions } = createSpan("SearchClient-autocomplete", operationOptions);
+        const { span, updatedOptions } = createSpan("SearchClient-autocomplete", options);
         try {
             const result = await this.client.documents.autocompletePost(fullOptions, updatedOptions);
             return result;
@@ -3424,22 +3662,16 @@ class SearchClient {
         }
     }
     async searchDocuments(searchText, options = {}, nextPageParameters = {}) {
-        const { operationOptions, restOptions } = this.extractOperationOptions(Object.assign({}, options));
-        const { select, searchFields, orderBy, semanticFields } = restOptions, nonFieldOptions = tslib.__rest(restOptions, ["select", "searchFields", "orderBy", "semanticFields"]);
-        const fullOptions = Object.assign(Object.assign({ searchFields: this.convertSearchFields(searchFields), semanticFields: this.convertSemanticFields(semanticFields), select: this.convertSelect(select) || "*", orderBy: this.convertOrderBy(orderBy) }, nonFieldOptions), nextPageParameters);
-        const { span, updatedOptions } = createSpan("SearchClient-searchDocuments", operationOptions);
+        const { searchFields, semanticFields, select, orderBy, includeTotalCount, vector, answers, semanticErrorHandlingMode, debugMode } = options, restOptions = tslib.__rest(options, ["searchFields", "semanticFields", "select", "orderBy", "includeTotalCount", "vector", "answers", "semanticErrorHandlingMode", "debugMode"]);
+        const fullOptions = Object.assign(Object.assign(Object.assign({}, restOptions), nextPageParameters), { searchFields: this.convertSearchFields(searchFields), semanticFields: this.convertSemanticFields(semanticFields), select: this.convertSelect(select) || "*", orderBy: this.convertOrderBy(orderBy), includeTotalResultCount: includeTotalCount, vector: this.convertVector(vector), answers: this.convertAnswers(answers), semanticErrorHandling: semanticErrorHandlingMode, debug: debugMode });
+        const { span, updatedOptions } = createSpan("SearchClient-searchDocuments", options);
         try {
-            const result = await this.client.documents.searchPost(Object.assign(Object.assign({}, fullOptions), { includeTotalResultCount: fullOptions.includeTotalCount, searchText: searchText }), updatedOptions);
-            const { results, count, coverage, facets, answers, nextLink } = result;
+            const result = await this.client.documents.searchPost(Object.assign(Object.assign({}, fullOptions), { searchText: searchText }), updatedOptions);
+            const { results, nextLink, nextPageParameters: resultNextPageParameters, semanticPartialResponseReason, semanticPartialResponseType } = result, restResult = tslib.__rest(result, ["results", "nextLink", "nextPageParameters", "semanticPartialResponseReason", "semanticPartialResponseType"]);
             const modifiedResults = generatedSearchResultToPublicSearchResult(results);
-            const converted = {
-                results: modifiedResults,
-                count,
-                coverage,
-                facets,
-                answers,
-                continuationToken: this.encodeContinuationToken(nextLink, result.nextPageParameters),
-            };
+            const converted = Object.assign(Object.assign({}, restResult), { results: modifiedResults, semanticPartialResponseReason: semanticPartialResponseReason, semanticPartialResponseType: semanticPartialResponseType, continuationToken: this.encodeContinuationToken(nextLink, resultNextPageParameters
+                    ? generatedSearchRequestToPublicSearchRequest(resultNextPageParameters)
+                    : resultNextPageParameters) });
             return deserialize(converted);
         }
         catch (e) {
@@ -3521,7 +3753,7 @@ class SearchClient {
      * import {
      *   AzureKeyCredential,
      *   SearchClient,
-     *   SelectFields,
+     *   SearchFieldArray,
      * } from "@azure/search-documents";
      *
      * type TModel = {
@@ -3536,7 +3768,7 @@ class SearchClient {
      * );
      *
      * const select = ["azure/sdk"] as const;
-     * const searchFields: SelectFields<TModel>[] = ["azure/sdk"];
+     * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
      *
      * const searchResult = await client.search("searchText", {
      *   select,
@@ -3548,14 +3780,7 @@ class SearchClient {
         const { span, updatedOptions } = createSpan("SearchClient-search", options);
         try {
             const pageResult = await this.searchDocuments(searchText, updatedOptions);
-            const { count, coverage, facets, answers } = pageResult;
-            return {
-                count,
-                coverage,
-                facets,
-                answers,
-                results: this.listSearchResults(pageResult, searchText, updatedOptions),
-            };
+            return Object.assign(Object.assign({}, pageResult), { results: this.listSearchResults(pageResult, searchText, updatedOptions) });
         }
         catch (e) {
             span.setStatus({
@@ -3579,7 +3804,7 @@ class SearchClient {
      * import {
      *   AzureKeyCredential,
      *   SearchClient,
-     *   SelectFields,
+     *   SearchFieldArray,
      * } from "@azure/search-documents";
      *
      * type TModel = {
@@ -3594,7 +3819,7 @@ class SearchClient {
      * );
      *
      * const select = ["azure/sdk"] as const;
-     * const searchFields: SelectFields<TModel>[] = ["azure/sdk"];
+     * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
      *
      * const suggestResult = await client.suggest("searchText", "suggesterName", {
      *   select,
@@ -3603,8 +3828,7 @@ class SearchClient {
      * ```
      */
     async suggest(searchText, suggesterName, options = {}) {
-        const { operationOptions, restOptions } = this.extractOperationOptions(Object.assign({}, options));
-        const { select, searchFields, orderBy } = restOptions, nonFieldOptions = tslib.__rest(restOptions, ["select", "searchFields", "orderBy"]);
+        const { select, searchFields, orderBy } = options, nonFieldOptions = tslib.__rest(options, ["select", "searchFields", "orderBy"]);
         const fullOptions = Object.assign({ searchText: searchText, suggesterName: suggesterName, searchFields: this.convertSearchFields(searchFields), select: this.convertSelect(select), orderBy: this.convertOrderBy(orderBy) }, nonFieldOptions);
         if (!fullOptions.searchText) {
             throw new RangeError("searchText must be provided.");
@@ -3612,7 +3836,7 @@ class SearchClient {
         if (!fullOptions.suggesterName) {
             throw new RangeError("suggesterName must be provided.");
         }
-        const { span, updatedOptions } = createSpan("SearchClient-suggest", operationOptions);
+        const { span, updatedOptions } = createSpan("SearchClient-suggest", options);
         try {
             const result = await this.client.documents.suggestPost(fullOptions, updatedOptions);
             const modifiedResult = generatedSuggestDocumentsResultToPublicSuggestDocumentsResult(result);
@@ -3813,24 +4037,18 @@ class SearchClient {
             throw new Error(`Corrupted or invalid continuation token: ${decodedToken}`);
         }
     }
-    // eslint-disable-next-line @typescript-eslint/no-shadow
-    extractOperationOptions(obj) {
-        const { abortSignal, requestOptions, tracingOptions } = obj, restOptions = tslib.__rest(obj, ["abortSignal", "requestOptions", "tracingOptions"]);
-        return {
-            operationOptions: {
-                abortSignal,
-                requestOptions,
-                tracingOptions,
-            },
-            restOptions,
-        };
-    }
     convertSelect(select) {
         if (select) {
             return select.join(",");
         }
         return select;
     }
+    convertVectorFields(fields) {
+        if (fields) {
+            return fields.join(",");
+        }
+        return fields;
+    }
     convertSearchFields(searchFields) {
         if (searchFields) {
             return searchFields.join(",");
@@ -3849,6 +4067,32 @@ class SearchClient {
         }
         return orderBy;
     }
+    convertAnswers(answers) {
+        if (!answers || typeof answers === "string") {
+            return answers;
+        }
+        if (answers.answers === "none") {
+            return answers.answers;
+        }
+        const config = [];
+        const { answers: output, count, threshold } = answers;
+        if (count) {
+            config.push(`count-${count}`);
+        }
+        if (threshold) {
+            config.push(`threshold-${threshold}`);
+        }
+        if (config.length) {
+            return output + `|${config.join(",")}`;
+        }
+        return output;
+    }
+    convertVector(vector) {
+        if (!vector) {
+            return vector;
+        }
+        return Object.assign(Object.assign({}, vector), { fields: this.convertVectorFields(vector === null || vector === void 0 ? void 0 : vector.fields) });
+    }
 }
 
 // Copyright (c) Microsoft Corporation.
@@ -4787,9 +5031,7 @@ const FieldMappingFunction = {
                 nullable: true,
                 type: {
                     name: "Dictionary",
-                    value: {
-                        type: { name: "Dictionary", value: { type: { name: "any" } } }
-                    }
+                    value: { type: { name: "any" } }
                 }
             }
         }
@@ -4812,6 +5054,13 @@ const SearchIndexerCache = {
                 type: {
                     name: "Boolean"
                 }
+            },
+            identity: {
+                serializedName: "identity",
+                type: {
+                    name: "Composite",
+                    className: "SearchIndexerDataIdentity"
+                }
             }
         }
     }
@@ -5421,6 +5670,13 @@ const SearchIndexerKnowledgeStore = {
                         }
                     }
                 }
+            },
+            identity: {
+                serializedName: "identity",
+                type: {
+                    name: "Composite",
+                    className: "SearchIndexerDataIdentity"
+                }
             }
         }
     }
@@ -5762,6 +6018,13 @@ const SearchIndex = {
                     className: "SemanticSettings"
                 }
             },
+            vectorSearch: {
+                serializedName: "vectorSearch",
+                type: {
+                    name: "Composite",
+                    className: "VectorSearch"
+                }
+            },
             etag: {
                 serializedName: "@odata\\.etag",
                 type: {
@@ -5854,6 +6117,24 @@ const SearchField = {
                     name: "String"
                 }
             },
+            vectorSearchDimensions: {
+                constraints: {
+                    InclusiveMaximum: 2048,
+                    InclusiveMinimum: 2
+                },
+                serializedName: "dimensions",
+                nullable: true,
+                type: {
+                    name: "Number"
+                }
+            },
+            vectorSearchConfiguration: {
+                serializedName: "vectorSearchConfiguration",
+                nullable: true,
+                type: {
+                    name: "String"
+                }
+            },
             synonymMaps: {
                 serializedName: "synonymMaps",
                 type: {
@@ -6206,6 +6487,12 @@ const SemanticSettings = {
         name: "Composite",
         className: "SemanticSettings",
         modelProperties: {
+            defaultConfiguration: {
+                serializedName: "defaultConfiguration",
+                type: {
+                    name: "String"
+                }
+            },
             configurations: {
                 serializedName: "configurations",
                 type: {
@@ -6296,6 +6583,53 @@ const SemanticField = {
         }
     }
 };
+const VectorSearch = {
+    type: {
+        name: "Composite",
+        className: "VectorSearch",
+        modelProperties: {
+            algorithmConfigurations: {
+                serializedName: "algorithmConfigurations",
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "VectorSearchAlgorithmConfiguration"
+                        }
+                    }
+                }
+            }
+        }
+    }
+};
+const VectorSearchAlgorithmConfiguration = {
+    type: {
+        name: "Composite",
+        className: "VectorSearchAlgorithmConfiguration",
+        uberParent: "VectorSearchAlgorithmConfiguration",
+        polymorphicDiscriminator: {
+            serializedName: "kind",
+            clientName: "kind"
+        },
+        modelProperties: {
+            name: {
+                serializedName: "name",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            kind: {
+                serializedName: "kind",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const ListIndexesResult = {
     type: {
         name: "Composite",
@@ -6338,6 +6672,13 @@ const GetIndexStatisticsResult = {
                 type: {
                     name: "Number"
                 }
+            },
+            vectorIndexSize: {
+                serializedName: "vectorIndexSize",
+                readOnly: true,
+                type: {
+                    name: "Number"
+                }
             }
         }
     }
@@ -6595,6 +6936,13 @@ const ServiceCounters = {
                     name: "Composite",
                     className: "ResourceCounter"
                 }
+            },
+            vectorIndexSizeCounter: {
+                serializedName: "vectorIndexSize",
+                type: {
+                    name: "Composite",
+                    className: "ResourceCounter"
+                }
             }
         }
     }
@@ -6657,6 +7005,57 @@ const ServiceLimits = {
         }
     }
 };
+const HnswParameters = {
+    type: {
+        name: "Composite",
+        className: "HnswParameters",
+        modelProperties: {
+            m: {
+                defaultValue: 4,
+                constraints: {
+                    InclusiveMaximum: 10,
+                    InclusiveMinimum: 4
+                },
+                serializedName: "m",
+                nullable: true,
+                type: {
+                    name: "Number"
+                }
+            },
+            efConstruction: {
+                defaultValue: 400,
+                constraints: {
+                    InclusiveMaximum: 1000,
+                    InclusiveMinimum: 100
+                },
+                serializedName: "efConstruction",
+                nullable: true,
+                type: {
+                    name: "Number"
+                }
+            },
+            efSearch: {
+                defaultValue: 500,
+                constraints: {
+                    InclusiveMaximum: 1000,
+                    InclusiveMinimum: 100
+                },
+                serializedName: "efSearch",
+                nullable: true,
+                type: {
+                    name: "Number"
+                }
+            },
+            metric: {
+                serializedName: "metric",
+                nullable: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const DistanceScoringParameters = {
     type: {
         name: "Composite",
@@ -7440,9 +7839,7 @@ const DocumentExtractionSkill = {
                 nullable: true,
                 type: {
                     name: "Dictionary",
-                    value: {
-                        type: { name: "Dictionary", value: { type: { name: "any" } } }
-                    }
+                    value: { type: { name: "any" } }
                 }
             } })
     }
@@ -7488,6 +7885,18 @@ const WebApiSkill = {
                 type: {
                     name: "Number"
                 }
+            }, authResourceId: {
+                serializedName: "authResourceId",
+                nullable: true,
+                type: {
+                    name: "String"
+                }
+            }, authIdentity: {
+                serializedName: "authIdentity",
+                type: {
+                    name: "Composite",
+                    className: "SearchIndexerDataIdentity"
+                }
             } })
     }
 };
@@ -9145,6 +9554,22 @@ const BM25Similarity = {
             } })
     }
 };
+const HnswVectorSearchAlgorithmConfiguration = {
+    serializedName: "hnsw",
+    type: {
+        name: "Composite",
+        className: "HnswVectorSearchAlgorithmConfiguration",
+        uberParent: "VectorSearchAlgorithmConfiguration",
+        polymorphicDiscriminator: VectorSearchAlgorithmConfiguration.type.polymorphicDiscriminator,
+        modelProperties: Object.assign(Object.assign({}, VectorSearchAlgorithmConfiguration.type.modelProperties), { parameters: {
+                serializedName: "hnswParameters",
+                type: {
+                    name: "Composite",
+                    className: "HnswParameters"
+                }
+            } })
+    }
+};
 const SearchIndexerKnowledgeStoreObjectProjectionSelector = {
     type: {
         name: "Composite",
@@ -9172,6 +9597,7 @@ let discriminators = {
     CharFilter: CharFilter,
     LexicalNormalizer: LexicalNormalizer,
     Similarity: Similarity,
+    VectorSearchAlgorithmConfiguration: VectorSearchAlgorithmConfiguration,
     "SearchIndexerDataIdentity.#Microsoft.Azure.Search.DataNoneIdentity": SearchIndexerDataNoneIdentity,
     "SearchIndexerDataIdentity.#Microsoft.Azure.Search.DataUserAssignedIdentity": SearchIndexerDataUserAssignedIdentity,
     "DataChangeDetectionPolicy.#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy": HighWaterMarkChangeDetectionPolicy,
@@ -9247,7 +9673,8 @@ let discriminators = {
     "CharFilter.#Microsoft.Azure.Search.PatternReplaceCharFilter": PatternReplaceCharFilter,
     "LexicalNormalizer.#Microsoft.Azure.Search.CustomNormalizer": CustomNormalizer,
     "Similarity.#Microsoft.Azure.Search.ClassicSimilarity": ClassicSimilarity,
-    "Similarity.#Microsoft.Azure.Search.BM25Similarity": BM25Similarity
+    "Similarity.#Microsoft.Azure.Search.BM25Similarity": BM25Similarity,
+    "VectorSearchAlgorithmConfiguration.hnsw": HnswVectorSearchAlgorithmConfiguration
 };
 
 var Mappers = /*#__PURE__*/Object.freeze({
@@ -9306,6 +9733,8 @@ var Mappers = /*#__PURE__*/Object.freeze({
     SemanticConfiguration: SemanticConfiguration,
     PrioritizedFields: PrioritizedFields,
     SemanticField: SemanticField,
+    VectorSearch: VectorSearch,
+    VectorSearchAlgorithmConfiguration: VectorSearchAlgorithmConfiguration,
     ListIndexesResult: ListIndexesResult,
     GetIndexStatisticsResult: GetIndexStatisticsResult,
     AnalyzeRequest: AnalyzeRequest,
@@ -9317,6 +9746,7 @@ var Mappers = /*#__PURE__*/Object.freeze({
     ServiceCounters: ServiceCounters,
     ResourceCounter: ResourceCounter,
     ServiceLimits: ServiceLimits,
+    HnswParameters: HnswParameters,
     DistanceScoringParameters: DistanceScoringParameters,
     FreshnessScoringParameters: FreshnessScoringParameters,
     MagnitudeScoringParameters: MagnitudeScoringParameters,
@@ -9401,6 +9831,7 @@ var Mappers = /*#__PURE__*/Object.freeze({
     CustomNormalizer: CustomNormalizer,
     ClassicSimilarity: ClassicSimilarity,
     BM25Similarity: BM25Similarity,
+    HnswVectorSearchAlgorithmConfiguration: HnswVectorSearchAlgorithmConfiguration,
     SearchIndexerKnowledgeStoreObjectProjectionSelector: SearchIndexerKnowledgeStoreObjectProjectionSelector,
     SearchIndexerKnowledgeStoreFileProjectionSelector: SearchIndexerKnowledgeStoreFileProjectionSelector,
     discriminators: discriminators
@@ -10776,7 +11207,7 @@ class SearchServiceClient extends coreHttpCompat__namespace.ExtendedServiceClien
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-search-documents/12.0.0-beta.1`;
+        const packageDetails = `azsdk-js-search-documents/12.0.0-beta.2`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -10858,17 +11289,7 @@ class SearchIndexClient {
         this.endpoint = endpoint;
         this.credential = credential;
         this.options = options;
-        const libInfo = `azsdk-js-search-documents/${SDK_VERSION}`;
-        if (!options.userAgentOptions) {
-            options.userAgentOptions = {};
-        }
-        if (options.userAgentOptions.userAgentPrefix) {
-            options.userAgentOptions.userAgentPrefix = `${options.userAgentOptions.userAgentPrefix} ${libInfo}`;
-        }
-        else {
-            options.userAgentOptions.userAgentPrefix = libInfo;
-        }
-        const internalClientPipelineOptions = Object.assign(Object.assign({}, options), {
+        const internalClientPipelineOptions = Object.assign(Object.assign({}, this.options), {
             loggingOptions: {
                 logger: logger.info,
                 additionalAllowedHeaderNames: [
@@ -10882,12 +11303,12 @@ class SearchIndexClient {
             },
         });
         this.serviceVersion =
-            (_b = (_a = options.serviceVersion) !== null && _a !== void 0 ? _a : options.apiVersion) !== null && _b !== void 0 ? _b : defaultServiceVersion;
+            (_b = (_a = this.options.serviceVersion) !== null && _a !== void 0 ? _a : this.options.apiVersion) !== null && _b !== void 0 ? _b : defaultServiceVersion;
         this.apiVersion = this.serviceVersion;
         this.client = new SearchServiceClient(this.endpoint, this.serviceVersion, internalClientPipelineOptions);
         if (coreAuth.isTokenCredential(credential)) {
-            const scope = options.audience
-                ? `${options.audience}/.default`
+            const scope = this.options.audience
+                ? `${this.options.audience}/.default`
                 : `${exports.KnownSearchAudience.AzurePublicCloud}/.default`;
             this.client.pipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({ credential, scopes: scope }));
         }
@@ -11478,7 +11899,7 @@ class SearchIndexClient {
      * Retrieves the SearchClient corresponding to this SearchIndexClient
      * @param indexName - Name of the index
      * @param options - SearchClient Options
-     * @typeParam Model - An optional type that represents the documents stored in
+     * @typeParam TModel - An optional type that represents the documents stored in
      * the search index. For the best typing experience, all non-key fields should
      * be marked optional and nullable, and the key property should have the
      * non-nullable type `string`.
@@ -11523,16 +11944,6 @@ class SearchIndexerClient {
          */
         this.apiVersion = defaultServiceVersion;
         this.endpoint = endpoint;
-        const libInfo = `azsdk-js-search-documents/${SDK_VERSION}`;
-        if (!options.userAgentOptions) {
-            options.userAgentOptions = {};
-        }
-        if (options.userAgentOptions.userAgentPrefix) {
-            options.userAgentOptions.userAgentPrefix = `${options.userAgentOptions.userAgentPrefix} ${libInfo}`;
-        }
-        else {
-            options.userAgentOptions.userAgentPrefix = libInfo;
-        }
         const internalClientPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
                 logger: logger.info,
@@ -12135,12 +12546,28 @@ function odata(strings, ...values) {
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-/** Known values of {@link ApiVersion20210430Preview} that the service accepts. */
-var KnownApiVersion20210430Preview$1;
-(function (KnownApiVersion20210430Preview) {
-    /** Api Version '2021-04-30-Preview' */
-    KnownApiVersion20210430Preview["TwoThousandTwentyOne0430Preview"] = "2021-04-30-Preview";
-})(KnownApiVersion20210430Preview$1 || (KnownApiVersion20210430Preview$1 = {}));
+/** Known values of {@link ApiVersion20230701Preview} that the service accepts. */
+var KnownApiVersion20230701Preview$1;
+(function (KnownApiVersion20230701Preview) {
+    /** Api Version '2023-07-01-Preview' */
+    KnownApiVersion20230701Preview["TwoThousandTwentyThree0701Preview"] = "2023-07-01-Preview";
+})(KnownApiVersion20230701Preview$1 || (KnownApiVersion20230701Preview$1 = {}));
+/** Known values of {@link SemanticErrorHandling} that the service accepts. */
+var KnownSemanticErrorHandling;
+(function (KnownSemanticErrorHandling) {
+    /** 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. */
+    KnownSemanticErrorHandling["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. */
+    KnownSemanticErrorHandling["Fail"] = "fail";
+})(KnownSemanticErrorHandling || (KnownSemanticErrorHandling = {}));
+/** Known values of {@link QueryDebugMode} that the service accepts. */
+var KnownQueryDebugMode;
+(function (KnownQueryDebugMode) {
+    /** No query debugging information will be returned. */
+    KnownQueryDebugMode["Disabled"] = "disabled";
+    /** Allows the user to further explore their Semantic search results. */
+    KnownQueryDebugMode["Semantic"] = "semantic";
+})(KnownQueryDebugMode || (KnownQueryDebugMode = {}));
 /** Known values of {@link QueryLanguage} that the service accepts. */
 exports.KnownQueryLanguage = void 0;
 (function (KnownQueryLanguage) {
@@ -12337,6 +12764,34 @@ exports.KnownQueryCaptionType = void 0;
     /** Extracts captions from the matching documents that contain passages relevant to the search query. */
     KnownQueryCaptionType["Extractive"] = "extractive";
 })(exports.KnownQueryCaptionType || (exports.KnownQueryCaptionType = {}));
+/** Known values of {@link SemanticPartialResponseReason} that the service accepts. */
+var KnownSemanticPartialResponseReason;
+(function (KnownSemanticPartialResponseReason) {
+    /** If 'semanticMaxWaitInMilliseconds' was set and the semantic processing duration exceeded that value. Only the base results were returned. */
+    KnownSemanticPartialResponseReason["MaxWaitExceeded"] = "maxWaitExceeded";
+    /** The request was throttled. Only the base results were returned. */
+    KnownSemanticPartialResponseReason["CapacityOverloaded"] = "capacityOverloaded";
+    /** At least one step of the semantic process failed. */
+    KnownSemanticPartialResponseReason["Transient"] = "transient";
+})(KnownSemanticPartialResponseReason || (KnownSemanticPartialResponseReason = {}));
+/** Known values of {@link SemanticPartialResponseType} that the service accepts. */
+var KnownSemanticPartialResponseType;
+(function (KnownSemanticPartialResponseType) {
+    /** Results without any semantic enrichment or reranking. */
+    KnownSemanticPartialResponseType["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. */
+    KnownSemanticPartialResponseType["RerankedResults"] = "rerankedResults";
+})(KnownSemanticPartialResponseType || (KnownSemanticPartialResponseType = {}));
+/** Known values of {@link SemanticFieldState} that the service accepts. */
+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 = {}));
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -12345,12 +12800,12 @@ exports.KnownQueryCaptionType = void 0;
  * Code generated by Microsoft (R) AutoRest Code Generator.
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
-/** Known values of {@link ApiVersion20210430Preview} that the service accepts. */
-var KnownApiVersion20210430Preview;
-(function (KnownApiVersion20210430Preview) {
-    /** Api Version '2021-04-30-Preview' */
-    KnownApiVersion20210430Preview["TwoThousandTwentyOne0430Preview"] = "2021-04-30-Preview";
-})(KnownApiVersion20210430Preview || (KnownApiVersion20210430Preview = {}));
+/** Known values of {@link ApiVersion20230701Preview} that the service accepts. */
+var KnownApiVersion20230701Preview;
+(function (KnownApiVersion20230701Preview) {
+    /** Api Version '2023-07-01-Preview' */
+    KnownApiVersion20230701Preview["TwoThousandTwentyThree0701Preview"] = "2023-07-01-Preview";
+})(KnownApiVersion20230701Preview || (KnownApiVersion20230701Preview = {}));
 /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
 exports.KnownSearchIndexerDataSourceType = void 0;
 (function (KnownSearchIndexerDataSourceType) {
@@ -12452,14 +12907,8 @@ var KnownSearchFieldDataType;
     KnownSearchFieldDataType["GeographyPoint"] = "Edm.GeographyPoint";
     /** Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. */
     KnownSearchFieldDataType["Complex"] = "Edm.ComplexType";
-    KnownSearchFieldDataType["CollectionEdmString"] = "Collection(Edm.String)";
-    KnownSearchFieldDataType["CollectionEdmInt32"] = "Collection(Edm.Int32)";
-    KnownSearchFieldDataType["CollectionEdmInt64"] = "Collection(Edm.Int64)";
-    KnownSearchFieldDataType["CollectionEdmDouble"] = "Collection(Edm.Double)";
-    KnownSearchFieldDataType["CollectionEdmBoolean"] = "Collection(Edm.Boolean)";
-    KnownSearchFieldDataType["CollectionEdmDateTimeOffset"] = "Collection(Edm.DateTimeOffset)";
-    KnownSearchFieldDataType["CollectionEdmGeographyPoint"] = "Collection(Edm.GeographyPoint)";
-    KnownSearchFieldDataType["CollectionEdmComplexType"] = "Collection(Edm.ComplexType)";
+    /** Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). */
+    KnownSearchFieldDataType["Single"] = "Edm.Single";
 })(KnownSearchFieldDataType || (KnownSearchFieldDataType = {}));
 /** Known values of {@link LexicalAnalyzerName} that the service accepts. */
 exports.KnownLexicalAnalyzerName = void 0;
@@ -12743,6 +13192,13 @@ exports.KnownCharFilterName = void 0;
     /** A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html */
     KnownCharFilterName["HtmlStrip"] = "html_strip";
 })(exports.KnownCharFilterName || (exports.KnownCharFilterName = {}));
+/** Known values of {@link VectorSearchAlgorithmMetric} that the service accepts. */
+var KnownVectorSearchAlgorithmMetric;
+(function (KnownVectorSearchAlgorithmMetric) {
+    KnownVectorSearchAlgorithmMetric["Cosine"] = "cosine";
+    KnownVectorSearchAlgorithmMetric["Euclidean"] = "euclidean";
+    KnownVectorSearchAlgorithmMetric["DotProduct"] = "dotProduct";
+})(KnownVectorSearchAlgorithmMetric || (KnownVectorSearchAlgorithmMetric = {}));
 /** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
 exports.KnownKeyPhraseExtractionSkillLanguage = void 0;
 (function (KnownKeyPhraseExtractionSkillLanguage) {