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

package/dist/commonjs/searchApiKeyCredentialPolicy.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchApiKeyCredentialPolicy.js","sourceRoot":"","sources":["../../src/searchApiKeyCredentialPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAiBlC,gFAUC;AAjBD,MAAM,mBAAmB,GAAG,SAAS,CAAC;AACtC,MAAM,4BAA4B,GAAG,8BAA8B,CAAC;AAEpE;;;GAGG;AACH,SAAgB,kCAAkC,CAAC,UAAyB;IAC1E,OAAO;QACL,IAAI,EAAE,4BAA4B;QAClC,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;YAC3D,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBAC9C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { KeyCredential } from \"@azure/core-auth\";\nimport {\n  PipelinePolicy,\n  PipelineRequest,\n  PipelineResponse,\n  SendRequest,\n} from \"@azure/core-rest-pipeline\";\n\nconst API_KEY_HEADER_NAME = \"api-key\";\nconst searchApiKeyCredentialPolicy = \"SearchApiKeyCredentialPolicy\";\n\n/**\n * Create an HTTP pipeline policy to authenticate a request\n * using an `AzureKeyCredential` for Azure Cognitive Search\n */\nexport function createSearchApiKeyCredentialPolicy(credential: KeyCredential): PipelinePolicy {\n  return {\n    name: searchApiKeyCredentialPolicy,\n    async sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse> {\n      if (!request.headers.has(API_KEY_HEADER_NAME)) {\n        request.headers.set(API_KEY_HEADER_NAME, credential.key);\n      }\n      return next(request);\n    },\n  };\n}\n"]}
+{"version":3,"file":"searchApiKeyCredentialPolicy.js","sourceRoot":"","sources":["../../src/searchApiKeyCredentialPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAiBlC,gFAUC;AAjBD,MAAM,mBAAmB,GAAG,SAAS,CAAC;AACtC,MAAM,4BAA4B,GAAG,8BAA8B,CAAC;AAEpE;;;GAGG;AACH,SAAgB,kCAAkC,CAAC,UAAyB;IAC1E,OAAO;QACL,IAAI,EAAE,4BAA4B;QAClC,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;YAC3D,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBAC9C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { KeyCredential } from \"@azure/core-auth\";\nimport type {\n  PipelinePolicy,\n  PipelineRequest,\n  PipelineResponse,\n  SendRequest,\n} from \"@azure/core-rest-pipeline\";\n\nconst API_KEY_HEADER_NAME = \"api-key\";\nconst searchApiKeyCredentialPolicy = \"SearchApiKeyCredentialPolicy\";\n\n/**\n * Create an HTTP pipeline policy to authenticate a request using an `AzureKeyCredential` for Azure\n * AI Search\n */\nexport function createSearchApiKeyCredentialPolicy(credential: KeyCredential): PipelinePolicy {\n  return {\n    name: searchApiKeyCredentialPolicy,\n    async sendRequest(request: PipelineRequest, next: SendRequest): Promise<PipelineResponse> {\n      if (!request.headers.has(API_KEY_HEADER_NAME)) {\n        request.headers.set(API_KEY_HEADER_NAME, credential.key);\n      }\n      return next(request);\n    },\n  };\n}\n"]}

package/dist/commonjs/searchClient.d.ts

@@ -1,11 +1,12 @@
-import { KeyCredential, TokenCredential } from "@azure/core-auth";
-import { ExtendedCommonClientOptions } from "@azure/core-http-compat";
-import { AutocompleteResult, IndexDocumentsResult } from "./generated/data/models/index.js";
+import type { KeyCredential, TokenCredential } from "@azure/core-auth";
+import type { ExtendedCommonClientOptions } from "@azure/core-http-compat";
+import type { Pipeline } from "@azure/core-rest-pipeline";
+import type { AutocompleteResult, IndexDocumentsResult } from "./generated/data/models/index.js";
 import { IndexDocumentsBatch } from "./indexDocumentsBatch.js";
-import { AutocompleteOptions, CountDocumentsOptions, DeleteDocumentsOptions, GetDocumentOptions, IndexDocumentsOptions, MergeDocumentsOptions, MergeOrUploadDocumentsOptions, NarrowedModel, SearchDocumentsResult, SearchOptions, SelectFields, SuggestDocumentsResult, SuggestOptions, UploadDocumentsOptions } from "./indexModels.js";
-import { IndexDocumentsClient } from "./searchIndexingBufferedSender.js";
+import type { AutocompleteOptions, CountDocumentsOptions, DeleteDocumentsOptions, GetDocumentOptions, IndexDocumentsOptions, MergeDocumentsOptions, MergeOrUploadDocumentsOptions, NarrowedModel, SearchDocumentsResult, SearchOptions, SelectFields, SuggestDocumentsResult, SuggestOptions, UploadDocumentsOptions } from "./indexModels.js";
+import type { IndexDocumentsClient } from "./searchIndexingBufferedSender.js";
 /**
- * Client options used to configure Cognitive Search API requests.
+ * Client options used to configure AI Search API requests.
  */
 export interface SearchClientOptions extends ExtendedCommonClientOptions {
     /**
@@ -52,30 +53,40 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * A reference to the auto-generated SearchClient
      */
     private readonly client;
+    /**
+     * A reference to the internal HTTP pipeline for use with raw requests
+     */
+    readonly pipeline: Pipeline;
     /**
      * Creates an instance of SearchClient.
      *
      * Example usage:
-     * ```ts
-     * const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+     * ```ts snippet:ReadmeSampleSearchClient
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
      *
-     * const client = new SearchClient(
+     * const searchClient = new SearchClient(
      *   "<endpoint>",
      *   "<indexName>",
-     *   new AzureKeyCredential("<Admin Key>")
+     *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      *
      * Optionally, the type of the model can be used to enable strong typing and type hints:
-     * ```ts
+     * ```ts snippet:ReadmeSampleSearchClientWithModel
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+     *
      * type TModel = {
      *   keyName: string;
      *   field1?: string | null;
-     *   field2?: { anotherField?: string | null } | null;
+     *   field2?: {
+     *     anotherField?: string | null;
+     *   } | null;
      * };
      *
-     * const client = new SearchClient<TModel>(
-     *   ...
+     * const searchClient = new SearchClient<TModel>(
+     *   "<endpoint>",
+     *   "<indexName>",
+     *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      *
@@ -96,37 +107,34 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      */
     getDocumentsCount(options?: CountDocumentsOptions): Promise<number>;
     /**
-     * Based on a partial searchText from the user, return a list
-     * of potential completion strings based on a specified suggester.
+     * Based on a partial searchText from the user, return a list of potential completion strings
+     * based on a specified suggester.
      * @param searchText - The search text on which to base autocomplete results.
-     * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
+     * @param suggesterName - The name of the suggester as specified in the suggesters collection
+     * that's part of the index definition.
      * @param options - Options to the autocomplete operation.
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleAutocomplete
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
      *
-     * const autocompleteResult = await client.autocomplete(
-     *   "searchText",
-     *   "suggesterName",
-     *   { searchFields }
-     * );
+     * const autocompleteResult = await client.autocomplete("searchText", "suggesterName", {
+     *   searchFields,
+     * });
      * ```
      */
     autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>;
@@ -140,22 +148,20 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * @param searchText - Text to search
      * @param options - Options for the search operation.
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleSearchTModel
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const select = ["azure/sdk"] as const;
@@ -169,28 +175,27 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      */
     search<TFields extends SelectFields<TModel>>(searchText?: string, options?: SearchOptions<TModel, TFields>): Promise<SearchDocumentsResult<TModel, TFields>>;
     /**
-     * Returns a short list of suggestions based on the searchText
-     * and specified suggester.
-     * @param searchText - The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.
-     * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
+     * Returns a short list of suggestions based on the searchText and specified suggester.
+     * @param searchText - The search text to use to suggest documents. Must be at least 1 character,
+     * and no more than 100 characters.
+     * @param suggesterName - The name of the suggester as specified in the suggesters collection
+     * that's part of the index definition.
      * @param options - Options for the suggest operation
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleSuggest
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const select = ["azure/sdk"] as const;
@@ -215,7 +220,7 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * This operation may partially succeed and not all document operations will
      * be reflected in the index. If you would like to treat this as an exception,
      * set the `throwOnAnyFailure` option to true.
-     * For more details about how merging works, see: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     * For more details about how merging works, see: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
      * @param batch - An array of actions to perform on the index.
      * @param options - Additional options.
      */
@@ -228,14 +233,18 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
     uploadDocuments(documents: TModel[], options?: UploadDocumentsOptions): Promise<IndexDocumentsResult>;
     /**
      * Update a set of documents in the index.
-     * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     *
+     * For more details about how merging works, see
+     * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
      * @param documents - The updated documents.
      * @param options - Additional options.
      */
     mergeDocuments(documents: TModel[], options?: MergeDocumentsOptions): Promise<IndexDocumentsResult>;
     /**
      * Update a set of documents in the index or upload them if they don't exist.
-     * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     *
+     * For more details about how merging works, see
+     * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
      * @param documents - The updated documents.
      * @param options - Additional options.
      */
@@ -258,9 +267,11 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
     private convertSelect;
     private convertVectorQueryFields;
     private convertSearchFields;
+    private convertSemanticFields;
     private convertOrderBy;
     private convertQueryAnswers;
     private convertQueryCaptions;
     private convertVectorQuery;
+    private convertQueryRewrites;
 }
 //# sourceMappingURL=searchClient.d.ts.map

package/dist/commonjs/searchClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AAKA,OAAO,EAAqB,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAErF,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAGtE,OAAO,EAEL,kBAAkB,EAClB,oBAAoB,EAMrB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,qBAAqB,EAErB,qBAAqB,EACrB,6BAA6B,EAC7B,aAAa,EAIb,qBAAqB,EAGrB,aAAa,EAGb,YAAY,EAGZ,sBAAsB,EACtB,cAAc,EACd,sBAAsB,EAEvB,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAKzE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,2BAA2B;IACtE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,YAAY,CAAC,MAAM,SAAS,MAAM,CAAE,YAAW,oBAAoB,CAAC,MAAM,CAAC;IAItF;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAA+B;IAErE;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAA+B;IAEjE;;OAEG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;gBAED,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,GAAE,mBAAwB;IAgDnC;;;OAGG;IACU,iBAAiB,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IA0BpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,YAAY,CACvB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,mBAAmB,CAAC,MAAM,CAAM,GACxC,OAAO,CAAC,kBAAkB,CAAC;YAiChB,eAAe;YAmFd,qBAAqB;YA2BrB,oBAAoB;IAenC,OAAO,CAAC,iBAAiB;IAoBzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,MAAM,CAAC,OAAO,SAAS,YAAY,CAAC,MAAM,CAAC,EACtD,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,GACvC,OAAO,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAqBlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACU,OAAO,CAAC,OAAO,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,KAAK,EAC/D,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAM,GAC5C,OAAO,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAyCnD;;;;OAIG;IACU,WAAW,CAAC,OAAO,SAAS,YAAY,CAAC,MAAM,CAAC,EAC3D,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAM,GAChD,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmB1C;;;;;;;;;OASG;IACU,cAAc,CAEzB,KAAK,EAAE,mBAAmB,CAAC,MAAM,CAAC,EAClC,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC;IA+BhC;;;;OAIG;IACU,eAAe,CAC1B,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;;OAKG;IACU,cAAc,CACzB,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;;OAKG;IACU,sBAAsB,CACjC,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;OAIG;IACU,eAAe,CAC1B,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAEhC;;;;;OAKG;IACU,eAAe,CAC1B,OAAO,EAAE,MAAM,MAAM,EACrB,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IA6BhC,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,uBAAuB;IA6B/B,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,wBAAwB;IAOhC,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,mBAAmB;IAuB3B,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,kBAAkB;CAG3B"}
+{"version":3,"file":"searchClient.d.ts","sourceRoot":"","sources":["../../src/searchClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGvE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAG1D,OAAO,KAAK,EAEV,kBAAkB,EAClB,oBAAoB,EAOrB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,qBAAqB,EAErB,qBAAqB,EACrB,6BAA6B,EAC7B,aAAa,EAKb,qBAAqB,EAGrB,aAAa,EAGb,YAAY,EAGZ,sBAAsB,EACtB,cAAc,EACd,sBAAsB,EAEvB,MAAM,kBAAkB,CAAC;AAK1B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAK9E;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,2BAA2B;IACtE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,YAAY,CAAC,MAAM,SAAS,MAAM,CAAE,YAAW,oBAAoB,CAAC,MAAM,CAAC;IAItF;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAA+B;IAErE;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAA+B;IAEjE;;OAEG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IAEzC;;OAEG;IACH,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;gBAED,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,GAAE,mBAAwB;IAkDnC;;;OAGG;IAEU,iBAAiB,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IA0BpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,YAAY,CACvB,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,mBAAmB,CAAC,MAAM,CAAM,GACxC,OAAO,CAAC,kBAAkB,CAAC;YAiChB,eAAe;YAgGd,qBAAqB;YA2BrB,oBAAoB;IAenC,OAAO,CAAC,iBAAiB;IAoBzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,MAAM,CAAC,OAAO,SAAS,YAAY,CAAC,MAAM,CAAC,EACtD,UAAU,CAAC,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,GACvC,OAAO,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAqBlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,OAAO,CAAC,OAAO,SAAS,YAAY,CAAC,MAAM,CAAC,GAAG,KAAK,EAC/D,UAAU,EAAE,MAAM,EAClB,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,cAAc,CAAC,MAAM,EAAE,OAAO,CAAM,GAC5C,OAAO,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAyCnD;;;;OAIG;IACU,WAAW,CAAC,OAAO,SAAS,YAAY,CAAC,MAAM,CAAC,EAC3D,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAM,GAChD,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAmB1C;;;;;;;;;OASG;IACU,cAAc,CAEzB,KAAK,EAAE,mBAAmB,CAAC,MAAM,CAAC,EAClC,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC;IA+BhC;;;;OAIG;IACU,eAAe,CAC1B,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;;;;OAOG;IACU,cAAc,CACzB,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;;;;OAOG;IACU,sBAAsB,CACjC,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,GAAE,6BAAkC,GAC1C,OAAO,CAAC,oBAAoB,CAAC;IAmBhC;;;;OAIG;IACU,eAAe,CAC1B,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAEhC;;;;;OAKG;IACU,eAAe,CAC1B,OAAO,EAAE,MAAM,MAAM,EACrB,SAAS,EAAE,MAAM,EAAE,EACnB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IA6BhC,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,uBAAuB;IA6B/B,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,wBAAwB;IAOhC,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,qBAAqB;IAO7B,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,mBAAmB;IA2B3B,OAAO,CAAC,oBAAoB;IAuB5B,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,oBAAoB;CAkB7B"}

package/dist/commonjs/searchClient.js

@@ -4,7 +4,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchClient = void 0;
 const tslib_1 = require("tslib");
-/// <reference lib="esnext.asynciterable" />
 const core_auth_1 = require("@azure/core-auth");
 const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
 const base64_js_1 = require("./base64.js");
@@ -47,30 +46,40 @@ class SearchClient {
      * A reference to the auto-generated SearchClient
      */
     client;
+    /**
+     * A reference to the internal HTTP pipeline for use with raw requests
+     */
+    pipeline;
     /**
      * Creates an instance of SearchClient.
      *
      * Example usage:
-     * ```ts
-     * const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+     * ```ts snippet:ReadmeSampleSearchClient
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
      *
-     * const client = new SearchClient(
+     * const searchClient = new SearchClient(
      *   "<endpoint>",
      *   "<indexName>",
-     *   new AzureKeyCredential("<Admin Key>")
+     *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      *
      * Optionally, the type of the model can be used to enable strong typing and type hints:
-     * ```ts
+     * ```ts snippet:ReadmeSampleSearchClientWithModel
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+     *
      * type TModel = {
      *   keyName: string;
      *   field1?: string | null;
-     *   field2?: { anotherField?: string | null } | null;
+     *   field2?: {
+     *     anotherField?: string | null;
+     *   } | null;
      * };
      *
-     * const client = new SearchClient<TModel>(
-     *   ...
+     * const searchClient = new SearchClient<TModel>(
+     *   "<endpoint>",
+     *   "<indexName>",
+     *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      *
@@ -107,6 +116,7 @@ class SearchClient {
             options.serviceVersion ?? options.apiVersion ?? utils.defaultServiceVersion;
         this.apiVersion = this.serviceVersion;
         this.client = new searchClient_js_1.SearchClient(this.endpoint, this.indexName, this.serviceVersion, internalClientPipelineOptions);
+        this.pipeline = this.client.pipeline;
         if ((0, core_auth_1.isTokenCredential)(credential)) {
             const scope = options.audience
                 ? `${options.audience}/.default`
@@ -122,6 +132,7 @@ class SearchClient {
      * Retrieves the number of documents in the index.
      * @param options - Options to the count operation.
      */
+    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     async getDocumentsCount(options = {}) {
         const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchClient-getDocumentsCount", options);
         try {
@@ -149,37 +160,34 @@ class SearchClient {
         }
     }
     /**
-     * Based on a partial searchText from the user, return a list
-     * of potential completion strings based on a specified suggester.
+     * Based on a partial searchText from the user, return a list of potential completion strings
+     * based on a specified suggester.
      * @param searchText - The search text on which to base autocomplete results.
-     * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
+     * @param suggesterName - The name of the suggester as specified in the suggesters collection
+     * that's part of the index definition.
      * @param options - Options to the autocomplete operation.
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleAutocomplete
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
      *
-     * const autocompleteResult = await client.autocomplete(
-     *   "searchText",
-     *   "suggesterName",
-     *   { searchFields }
-     * );
+     * const autocompleteResult = await client.autocomplete("searchText", "suggesterName", {
+     *   searchFields,
+     * });
      * ```
      */
     async autocomplete(searchText, suggesterName, options = {}) {
@@ -213,8 +221,8 @@ class SearchClient {
         }
     }
     async searchDocuments(searchText, options = {}, nextPageParameters = {}) {
-        const { includeTotalCount, orderBy, searchFields, select, vectorSearchOptions, semanticSearchOptions, ...restOptions } = options;
-        const { configurationName, errorMode, answers, captions, ...restSemanticOptions } = semanticSearchOptions ?? {};
+        const { includeTotalCount, orderBy, searchFields, select, vectorSearchOptions, semanticSearchOptions, hybridSearch, ...restOptions } = options;
+        const { semanticFields, configurationName, errorMode, answers, captions, debugMode, queryRewrites, ...restSemanticOptions } = semanticSearchOptions ?? {};
         const { queries, filterMode, ...restVectorOptions } = vectorSearchOptions ?? {};
         const fullOptions = {
             ...restSemanticOptions,
@@ -222,6 +230,7 @@ class SearchClient {
             ...restOptions,
             ...nextPageParameters,
             searchFields: this.convertSearchFields(searchFields),
+            semanticFields: this.convertSemanticFields(semanticFields),
             select: this.convertSelect(select) || "*",
             orderBy: this.convertOrderBy(orderBy),
             includeTotalResultCount: includeTotalCount,
@@ -230,7 +239,10 @@ class SearchClient {
             captions: this.convertQueryCaptions(captions),
             semanticErrorHandling: errorMode,
             semanticConfigurationName: configurationName,
+            debug: debugMode,
+            queryRewrites: this.convertQueryRewrites(queryRewrites),
             vectorFilterMode: filterMode,
+            hybridSearch: hybridSearch,
         };
         const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchClient-searchDocuments", options);
         try {
@@ -302,22 +314,20 @@ class SearchClient {
      * @param searchText - Text to search
      * @param options - Options for the search operation.
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleSearchTModel
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const select = ["azure/sdk"] as const;
@@ -350,28 +360,27 @@ class SearchClient {
         }
     }
     /**
-     * Returns a short list of suggestions based on the searchText
-     * and specified suggester.
-     * @param searchText - The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.
-     * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
+     * Returns a short list of suggestions based on the searchText and specified suggester.
+     * @param searchText - The search text to use to suggest documents. Must be at least 1 character,
+     * and no more than 100 characters.
+     * @param suggesterName - The name of the suggester as specified in the suggesters collection
+     * that's part of the index definition.
      * @param options - Options for the suggest operation
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleSuggest
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const select = ["azure/sdk"] as const;
@@ -447,7 +456,7 @@ class SearchClient {
      * This operation may partially succeed and not all document operations will
      * be reflected in the index. If you would like to treat this as an exception,
      * set the `throwOnAnyFailure` option to true.
-     * For more details about how merging works, see: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     * For more details about how merging works, see: https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
      * @param batch - An array of actions to perform on the index.
      * @param options - Additional options.
      */
@@ -507,7 +516,9 @@ class SearchClient {
     }
     /**
      * Update a set of documents in the index.
-     * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     *
+     * For more details about how merging works, see
+     * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
      * @param documents - The updated documents.
      * @param options - Additional options.
      */
@@ -531,7 +542,9 @@ class SearchClient {
     }
     /**
      * Update a set of documents in the index or upload them if they don't exist.
-     * For more details about how merging works, see https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     *
+     * For more details about how merging works, see
+     * https://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
      * @param documents - The updated documents.
      * @param options - Additional options.
      */
@@ -624,6 +637,12 @@ class SearchClient {
         }
         return searchFields;
     }
+    convertSemanticFields(semanticFields) {
+        if (semanticFields) {
+            return semanticFields.join(",");
+        }
+        return semanticFields;
+    }
     convertOrderBy(orderBy) {
         if (orderBy) {
             return orderBy.join(",");
@@ -635,13 +654,16 @@ class SearchClient {
             return answers;
         }
         const config = [];
-        const { answerType: output, count, threshold } = answers;
+        const { answerType: output, count, threshold, maxAnswerLength } = answers;
         if (count) {
             config.push(`count-${count}`);
         }
         if (threshold) {
             config.push(`threshold-${threshold}`);
         }
+        if (maxAnswerLength) {
+            config.push(`maxcharlength-${maxAnswerLength}`);
+        }
         if (config.length) {
             return output + `|${config.join(",")}`;
         }
@@ -652,17 +674,55 @@ class SearchClient {
             return captions;
         }
         const config = [];
-        const { captionType: output, highlight } = captions;
+        const { captionType: output, highlight, maxCaptionLength } = captions;
         if (highlight !== undefined) {
             config.push(`highlight-${highlight}`);
         }
+        if (maxCaptionLength) {
+            config.push(`maxcharlength-${maxCaptionLength}`);
+        }
         if (config.length) {
             return output + `|${config.join(",")}`;
         }
         return output;
     }
     convertVectorQuery(vectorQuery) {
-        return { ...vectorQuery, fields: this.convertVectorQueryFields(vectorQuery?.fields) };
+        switch (vectorQuery.kind) {
+            case "text": {
+                const { fields, queryRewrites, ...restFields } = vectorQuery;
+                return {
+                    ...restFields,
+                    fields: this.convertVectorQueryFields(fields),
+                    queryRewrites: this.convertQueryRewrites(queryRewrites),
+                };
+            }
+            case "vector":
+            case "imageUrl":
+            case "imageBinary": {
+                return { ...vectorQuery, fields: this.convertVectorQueryFields(vectorQuery?.fields) };
+            }
+            default: {
+                logger_js_1.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;
+        }
     }
 }
 exports.SearchClient = SearchClient;