@azure/search-documents 12.2.0-beta.1 → 12.2.0-beta.3

package/dist/browser/searchClient.d.ts

@@ -0,0 +1,277 @@
+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 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 AI Search API requests.
+ */
+export interface SearchClientOptions extends ExtendedCommonClientOptions {
+    /**
+     * The API version to use when communicating with the service.
+     * @deprecated use {@link serviceVersion} instead
+     */
+    apiVersion?: string;
+    /**
+     * The service version to use when communicating with the service.
+     */
+    serviceVersion?: string;
+    /**
+     * The Audience to use for authentication with Azure Active Directory (AAD). The
+     * audience is not considered when using a shared key.
+     * {@link KnownSearchAudience} can be used interchangeably with audience
+     */
+    audience?: string;
+}
+/**
+ * Class used to perform operations against a search index,
+ * including querying documents in the index as well as
+ * adding, updating, and removing them.
+ */
+export declare class SearchClient<TModel extends object> implements IndexDocumentsClient<TModel> {
+    /**
+     *  The service version to use when communicating with the service.
+     */
+    readonly serviceVersion: string;
+    /**
+     * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
+     */
+    readonly apiVersion: string;
+    /**
+     * The endpoint of the search service
+     */
+    readonly endpoint: string;
+    /**
+     * The name of the index
+     */
+    readonly indexName: string;
+    /**
+     * @hidden
+     * 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 snippet:ReadmeSampleSearchClient
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+     *
+     * const searchClient = new SearchClient(
+     *   "<endpoint>",
+     *   "<indexName>",
+     *   new AzureKeyCredential("<apiKey>"),
+     * );
+     * ```
+     *
+     * Optionally, the type of the model can be used to enable strong typing and type hints:
+     * ```ts snippet:ReadmeSampleSearchClientWithModel
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+     *
+     * type TModel = {
+     *   keyName: string;
+     *   field1?: string | null;
+     *   field2?: {
+     *     anotherField?: string | null;
+     *   } | null;
+     * };
+     *
+     * const searchClient = new SearchClient<TModel>(
+     *   "<endpoint>",
+     *   "<indexName>",
+     *   new AzureKeyCredential("<apiKey>"),
+     * );
+     * ```
+     *
+     * @param endpoint - The endpoint of the search service
+     * @param indexName - The name of the index
+     * @param credential - Used to authenticate requests to the service.
+     * @param options - Used to configure the Search client.
+     *
+     * @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`.
+     */
+    constructor(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions);
+    /**
+     * Retrieves the number of documents in the index.
+     * @param options - Options to the count operation.
+     */
+    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.
+     * @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 options - Options to the autocomplete operation.
+     * @example
+     * ```ts snippet:ReadmeSampleAutocomplete
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
+     *
+     * type TModel = {
+     *   key: string;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
+     * };
+     *
+     * const client = new SearchClient<TModel>(
+     *   "endpoint.azure",
+     *   "indexName",
+     *   new AzureKeyCredential("key"),
+     * );
+     *
+     * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
+     *
+     * const autocompleteResult = await client.autocomplete("searchText", "suggesterName", {
+     *   searchFields,
+     * });
+     * ```
+     */
+    autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>;
+    private searchDocuments;
+    private listSearchResultsPage;
+    private listSearchResultsAll;
+    private listSearchResults;
+    /**
+     * Performs a search on the current index given
+     * the specified arguments.
+     * @param searchText - Text to search
+     * @param options - Options for the search operation.
+     * @example
+     * ```ts snippet:ReadmeSampleSearchTModel
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
+     *
+     * type TModel = {
+     *   key: string;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
+     * };
+     *
+     * const client = new SearchClient<TModel>(
+     *   "endpoint.azure",
+     *   "indexName",
+     *   new AzureKeyCredential("key"),
+     * );
+     *
+     * const select = ["azure/sdk"] as const;
+     * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
+     *
+     * const searchResult = await client.search("searchText", {
+     *   select,
+     *   searchFields,
+     * });
+     * ```
+     */
+    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.
+     * @param options - Options for the suggest operation
+     * @example
+     * ```ts snippet:ReadmeSampleSuggest
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
+     *
+     * type TModel = {
+     *   key: string;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
+     * };
+     *
+     * const client = new SearchClient<TModel>(
+     *   "endpoint.azure",
+     *   "indexName",
+     *   new AzureKeyCredential("key"),
+     * );
+     *
+     * const select = ["azure/sdk"] as const;
+     * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
+     *
+     * const suggestResult = await client.suggest("searchText", "suggesterName", {
+     *   select,
+     *   searchFields,
+     * });
+     * ```
+     */
+    suggest<TFields extends SelectFields<TModel> = never>(searchText: string, suggesterName: string, options?: SuggestOptions<TModel, TFields>): Promise<SuggestDocumentsResult<TModel, TFields>>;
+    /**
+     * Retrieve a particular document from the index by key.
+     * @param key - The primary key value of the document
+     * @param options - Additional options
+     */
+    getDocument<TFields extends SelectFields<TModel>>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>;
+    /**
+     * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
+     * for the given set of documents.
+     * 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://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.
+     */
+    indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
+    /**
+     * Upload an array of documents to the index.
+     * @param documents - The documents to upload.
+     * @param options - Additional options.
+     */
+    uploadDocuments(documents: TModel[], options?: UploadDocumentsOptions): Promise<IndexDocumentsResult>;
+    /**
+     * Update a set of documents in the index.
+     *
+     * 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://learn.microsoft.com/rest/api/searchservice/AddUpdate-or-Delete-Documents
+     * @param documents - The updated documents.
+     * @param options - Additional options.
+     */
+    mergeOrUploadDocuments(documents: TModel[], options?: MergeOrUploadDocumentsOptions): Promise<IndexDocumentsResult>;
+    /**
+     * Delete a set of documents.
+     * @param documents - Documents to be deleted.
+     * @param options - Additional options.
+     */
+    deleteDocuments(documents: TModel[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
+    /**
+     * Delete a set of documents.
+     * @param keyName - The name of their primary key in the index.
+     * @param keyValues - The primary key values of documents to delete.
+     * @param options - Additional options.
+     */
+    deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
+    private encodeContinuationToken;
+    private decodeContinuationToken;
+    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/browser/searchClient.d.ts.map

@@ -0,0 +1 @@
+{"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"}