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

package/dist/esm/searchClient.js

@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 import { isTokenCredential } from "@azure/core-auth";
-import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
+import { bearerTokenAuthenticationPolicy, bearerTokenAuthenticationPolicyName, } from "@azure/core-rest-pipeline";
 import { decode, encode } from "./base64.js";
-import { SearchClient as GeneratedClient } from "./generated/data/searchClient.js";
+import { SearchClient as GeneratedClient } from "./search/searchClient.js";
 import { IndexDocumentsBatch } from "./indexDocumentsBatch.js";
 import { logger } from "./logger.js";
 import { createOdataMetadataPolicy } from "./odataMetadataPolicy.js";
@@ -11,7 +11,7 @@ import { createSearchApiKeyCredentialPolicy } from "./searchApiKeyCredentialPoli
 import { KnownSearchAudience } from "./searchAudience.js";
 import { deserialize, serialize } from "./serialization.js";
 import * as utils from "./serviceUtils.js";
-import { createSpan } from "./tracing.js";
+import { tracingClient } from "./tracing.js";
 /**
  * Class used to perform operations against a search index,
  * including querying documents in the index as well as
@@ -111,8 +111,10 @@ export class SearchClient {
         this.serviceVersion =
             options.serviceVersion ?? options.apiVersion ?? utils.defaultServiceVersion;
         this.apiVersion = this.serviceVersion;
-        this.client = new GeneratedClient(this.endpoint, this.indexName, this.serviceVersion, internalClientPipelineOptions);
+        this.client = new GeneratedClient(this.endpoint, credential, this.indexName, internalClientPipelineOptions);
         this.pipeline = this.client.pipeline;
+        // Replaced with a custom policy below
+        this.pipeline.removePolicy({ name: bearerTokenAuthenticationPolicyName });
         if (isTokenCredential(credential)) {
             const scope = options.audience
                 ? `${options.audience}/.default`
@@ -130,30 +132,10 @@ export class SearchClient {
      */
     // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     async getDocumentsCount(options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-getDocumentsCount", options);
-        try {
-            let documentsCount = 0;
-            await this.client.documents.count({
-                ...updatedOptions,
-                onResponse: (rawResponse, flatResponse) => {
-                    documentsCount = Number(rawResponse.bodyAsText);
-                    if (updatedOptions.onResponse) {
-                        updatedOptions.onResponse(rawResponse, flatResponse);
-                    }
-                },
-            });
-            return documentsCount;
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("SearchClient-getDocumentsCount", options, async (updatedOptions) => {
+            const count = await this.client.getDocumentCount(updatedOptions);
+            return Number(count);
+        });
     }
     /**
      * Based on a partial searchText from the user, return a list of potential completion strings
@@ -187,38 +169,25 @@ export class SearchClient {
      * ```
      */
     async autocomplete(searchText, suggesterName, options = {}) {
-        const { searchFields, ...nonFieldOptions } = options;
-        const fullOptions = {
-            searchText: searchText,
-            suggesterName: suggesterName,
-            searchFields: this.convertSearchFields(searchFields),
-            ...nonFieldOptions,
-        };
-        if (!fullOptions.searchText) {
+        if (!searchText) {
             throw new RangeError("searchText must be provided.");
         }
-        if (!fullOptions.suggesterName) {
+        if (!suggesterName) {
             throw new RangeError("suggesterName must be provided.");
         }
-        const { span, updatedOptions } = createSpan("SearchClient-autocomplete", options);
-        try {
-            const result = await this.client.documents.autocompletePost(fullOptions, updatedOptions);
-            return result;
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
+        const { searchFields, ...restOptions } = options;
+        return tracingClient.withSpan("SearchClient-autocomplete", options, async (updatedOptions) => {
+            return this.client.autocompletePost(searchText, suggesterName, {
+                ...updatedOptions,
+                ...restOptions,
+                // Cast readonly array to mutable - the generated code doesn't mutate it
+                searchFields: searchFields,
             });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     async searchDocuments(searchText, options = {}, nextPageParameters = {}) {
-        const { includeTotalCount, orderBy, searchFields, select, vectorSearchOptions, semanticSearchOptions, hybridSearch, ...restOptions } = options;
-        const { semanticFields, configurationName, errorMode, answers, captions, debugMode, queryRewrites, ...restSemanticOptions } = semanticSearchOptions ?? {};
+        const { includeTotalCount, orderBy, searchFields, select, highlightFields, vectorSearchOptions, semanticSearchOptions, debug, ...restOptions } = options;
+        const { semanticFields, configurationName, errorMode, answers, captions, debugMode, ...restSemanticOptions } = semanticSearchOptions ?? {};
         const { queries, filterMode, ...restVectorOptions } = vectorSearchOptions ?? {};
         const fullOptions = {
             ...restSemanticOptions,
@@ -226,47 +195,36 @@ export class SearchClient {
             ...restOptions,
             ...nextPageParameters,
             searchFields: this.convertSearchFields(searchFields),
-            semanticFields: this.convertSemanticFields(semanticFields),
             select: this.convertSelect(select) || "*",
+            highlightFields: highlightFields?.split(","),
             orderBy: this.convertOrderBy(orderBy),
-            includeTotalResultCount: includeTotalCount,
+            includeTotalCount,
             vectorQueries: queries?.map(this.convertVectorQuery.bind(this)),
             answers: this.convertQueryAnswers(answers),
             captions: this.convertQueryCaptions(captions),
             semanticErrorHandling: errorMode,
             semanticConfigurationName: configurationName,
-            debug: debugMode,
-            queryRewrites: this.convertQueryRewrites(queryRewrites),
+            debug: debugMode ?? debug, // Use semanticSearchOptions.debugMode if set, otherwise use top-level debug
             vectorFilterMode: filterMode,
-            hybridSearch: hybridSearch,
         };
-        const { span, updatedOptions } = createSpan("SearchClient-searchDocuments", options);
-        try {
-            const result = await this.client.documents.searchPost({
-                ...fullOptions,
+        return tracingClient.withSpan("SearchClient-searchDocuments", fullOptions, async (updatedOptions) => {
+            const result = await this.client.searchPost({
+                ...updatedOptions,
                 searchText: searchText,
-            }, updatedOptions);
-            const { results, nextLink, nextPageParameters: resultNextPageParameters, semanticPartialResponseReason: semanticErrorReason, semanticPartialResponseType: semanticSearchResultsType, ...restResult } = result;
+            });
+            const { results, nextLink, nextPageParameters: resultNextPageParameters, semanticPartialResponseReason: semanticErrorReason, semanticPartialResponseType: semanticSearchResultsType, facets, answers: resultAnswers, ...restResult } = result;
             const modifiedResults = utils.generatedSearchResultToPublicSearchResult(results);
             const converted = {
                 ...restResult,
+                facets: utils.convertGeneratedFacetsToPublic(facets),
+                answers: utils.convertGeneratedAnswersToPublic(resultAnswers),
                 results: modifiedResults,
                 semanticErrorReason,
                 semanticSearchResultsType,
                 continuationToken: this.encodeContinuationToken(nextLink, resultNextPageParameters),
             };
             return deserialize(converted);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     async *listSearchResultsPage(searchText, options = {}, settings = {}) {
         let decodedContinuation = this.decodeContinuationToken(settings.continuationToken);
@@ -335,25 +293,14 @@ export class SearchClient {
      * });
      * ```
      */
-    async search(searchText, options) {
-        const { span, updatedOptions } = createSpan("SearchClient-search", options);
-        try {
+    async search(searchText, options = {}) {
+        return tracingClient.withSpan("SearchClient-search", options, async (updatedOptions) => {
             const pageResult = await this.searchDocuments(searchText, updatedOptions);
             return {
                 ...pageResult,
                 results: this.listSearchResults(pageResult, searchText, updatedOptions),
             };
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Returns a short list of suggestions based on the searchText and specified suggester.
@@ -391,35 +338,23 @@ export class SearchClient {
     async suggest(searchText, suggesterName, options = {}) {
         const { select, searchFields, orderBy, ...nonFieldOptions } = options;
         const fullOptions = {
-            searchText: searchText,
-            suggesterName: suggesterName,
+            // Cast readonly arrays to mutable - the generated code doesn't mutate them
             searchFields: this.convertSearchFields(searchFields),
             select: this.convertSelect(select),
             orderBy: this.convertOrderBy(orderBy),
             ...nonFieldOptions,
         };
-        if (!fullOptions.searchText) {
+        if (!searchText) {
             throw new RangeError("searchText must be provided.");
         }
-        if (!fullOptions.suggesterName) {
+        if (!suggesterName) {
             throw new RangeError("suggesterName must be provided.");
         }
-        const { span, updatedOptions } = createSpan("SearchClient-suggest", options);
-        try {
-            const result = await this.client.documents.suggestPost(fullOptions, updatedOptions);
+        return tracingClient.withSpan("SearchClient-suggest", fullOptions, async (updatedOptions) => {
+            const result = await this.client.suggestPost(searchText, suggesterName, updatedOptions);
             const modifiedResult = utils.generatedSuggestDocumentsResultToPublicSuggestDocumentsResult(result);
             return deserialize(modifiedResult);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Retrieve a particular document from the index by key.
@@ -427,24 +362,14 @@ export class SearchClient {
      * @param options - Additional options
      */
     async getDocument(key, options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-getDocument", options);
-        try {
-            const result = await this.client.documents.get(key, {
+        return tracingClient.withSpan("SearchClient-getDocument", options, async (updatedOptions) => {
+            const result = await this.client.getDocument(key, {
                 ...updatedOptions,
                 selectedFields: updatedOptions.selectedFields,
             });
-            return deserialize(result);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+            // The generated code puts document fields in additionalProperties
+            return deserialize(result.additionalProperties ?? {});
+        });
     }
     /**
      * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
@@ -459,10 +384,10 @@ export class SearchClient {
     async indexDocuments(
     // eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters
     batch, options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-indexDocuments", options);
-        try {
+        return tracingClient.withSpan("SearchClient-indexDocuments", options, async (updatedOptions) => {
             let status = 0;
-            const result = await this.client.documents.index({ actions: serialize(batch.actions) }, {
+            const serializedActions = serialize(batch.actions);
+            const result = await this.client.index({ actions: utils.convertPublicActionsToGeneratedActions(serializedActions) }, {
                 ...updatedOptions,
                 onResponse: (rawResponse, flatResponse) => {
                     status = rawResponse.status;
@@ -475,17 +400,7 @@ export class SearchClient {
                 throw result;
             }
             return result;
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Upload an array of documents to the index.
@@ -493,22 +408,11 @@ export class SearchClient {
      * @param options - Additional options.
      */
     async uploadDocuments(documents, options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-uploadDocuments", options);
-        const batch = new IndexDocumentsBatch();
-        batch.upload(documents);
-        try {
-            return await this.indexDocuments(batch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("SearchClient-uploadDocuments", options, async (updatedOptions) => {
+            const batch = new IndexDocumentsBatch();
+            batch.upload(documents);
+            return this.indexDocuments(batch, updatedOptions);
+        });
     }
     /**
      * Update a set of documents in the index.
@@ -519,22 +423,11 @@ export class SearchClient {
      * @param options - Additional options.
      */
     async mergeDocuments(documents, options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-mergeDocuments", options);
-        const batch = new IndexDocumentsBatch();
-        batch.merge(documents);
-        try {
-            return await this.indexDocuments(batch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("SearchClient-mergeDocuments", options, async (updatedOptions) => {
+            const batch = new IndexDocumentsBatch();
+            batch.merge(documents);
+            return this.indexDocuments(batch, updatedOptions);
+        });
     }
     /**
      * Update a set of documents in the index or upload them if they don't exist.
@@ -545,45 +438,23 @@ export class SearchClient {
      * @param options - Additional options.
      */
     async mergeOrUploadDocuments(documents, options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-mergeDocuments", options);
-        const batch = new IndexDocumentsBatch();
-        batch.mergeOrUpload(documents);
-        try {
-            return await this.indexDocuments(batch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("SearchClient-mergeOrUploadDocuments", options, async (updatedOptions) => {
+            const batch = new IndexDocumentsBatch();
+            batch.mergeOrUpload(documents);
+            return this.indexDocuments(batch, updatedOptions);
+        });
     }
     async deleteDocuments(keyNameOrDocuments, keyValuesOrOptions, options = {}) {
-        const { span, updatedOptions } = createSpan("SearchClient-deleteDocuments", options);
-        const batch = new IndexDocumentsBatch();
-        if (typeof keyNameOrDocuments === "string") {
-            batch.delete(keyNameOrDocuments, keyValuesOrOptions);
-        }
-        else {
-            batch.delete(keyNameOrDocuments);
-        }
-        try {
-            return await this.indexDocuments(batch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        return tracingClient.withSpan("SearchClient-deleteDocuments", options, async (updatedOptions) => {
+            const batch = new IndexDocumentsBatch();
+            if (typeof keyNameOrDocuments === "string") {
+                batch.delete(keyNameOrDocuments, keyValuesOrOptions);
+            }
+            else {
+                batch.delete(keyNameOrDocuments);
+            }
+            return this.indexDocuments(batch, updatedOptions);
+        });
     }
     encodeContinuationToken(nextLink, nextPageParameters) {
         if (!nextLink || !nextPageParameters) {
@@ -619,35 +490,29 @@ export class SearchClient {
         if (select) {
             return select.join(",");
         }
-        return select;
+        return undefined;
     }
     convertVectorQueryFields(fields) {
         if (fields) {
             return fields.join(",");
         }
-        return fields;
+        return undefined;
     }
     convertSearchFields(searchFields) {
         if (searchFields) {
             return searchFields.join(",");
         }
-        return searchFields;
-    }
-    convertSemanticFields(semanticFields) {
-        if (semanticFields) {
-            return semanticFields.join(",");
-        }
-        return semanticFields;
+        return undefined;
     }
     convertOrderBy(orderBy) {
         if (orderBy) {
             return orderBy.join(",");
         }
-        return orderBy;
+        return undefined;
     }
     convertQueryAnswers(answers) {
         if (!answers) {
-            return answers;
+            return undefined;
         }
         const config = [];
         const { answerType: output, count, threshold, maxAnswerLength } = answers;
@@ -667,7 +532,7 @@ export class SearchClient {
     }
     convertQueryCaptions(captions) {
         if (!captions) {
-            return captions;
+            return undefined;
         }
         const config = [];
         const { captionType: output, highlight, maxCaptionLength } = captions;
@@ -685,40 +550,30 @@ export class SearchClient {
     convertVectorQuery(vectorQuery) {
         switch (vectorQuery.kind) {
             case "text": {
-                const { fields, queryRewrites, ...restFields } = vectorQuery;
+                const { fields, ...restFields } = vectorQuery;
                 return {
                     ...restFields,
                     fields: this.convertVectorQueryFields(fields),
-                    queryRewrites: this.convertQueryRewrites(queryRewrites),
                 };
             }
             case "vector":
-            case "imageUrl":
-            case "imageBinary": {
+            case "imageUrl": {
                 return { ...vectorQuery, fields: this.convertVectorQueryFields(vectorQuery?.fields) };
             }
+            case "imageBinary": {
+                // Map convenience layer's binaryImage to generated layer's base64Image
+                const { binaryImage, fields, ...rest } = vectorQuery;
+                return {
+                    ...rest,
+                    base64Image: binaryImage,
+                    fields: this.convertVectorQueryFields(fields),
+                };
+            }
             default: {
                 logger.warning("Unknown vector query kind; sending without serialization");
                 return vectorQuery;
             }
         }
     }
-    convertQueryRewrites(queryRewrites) {
-        if (!queryRewrites) {
-            return queryRewrites;
-        }
-        const { rewritesType: baseOutput } = queryRewrites;
-        switch (baseOutput) {
-            case "generative": {
-                const { count } = queryRewrites;
-                const config = [...(count === undefined ? [] : [`count-${count}`])];
-                if (config.length)
-                    return baseOutput + `|${config.join(",")}`;
-                return baseOutput;
-            }
-            default:
-                return baseOutput;
-        }
-    }
 }
 //# sourceMappingURL=searchClient.js.map