@azure/search-documents 11.3.1 → 11.3.3

package/types/search-documents.d.ts

@@ -1,10 +1,11 @@
 /// <reference lib="esnext.asynciterable" />
+
 import { AzureKeyCredential } from '@azure/core-auth';
+import { ExtendedCommonClientOptions } from '@azure/core-http-compat';
 import { KeyCredential } from '@azure/core-auth';
-import { OperationOptions } from '@azure/core-http';
+import { OperationOptions } from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PipelineOptions } from '@azure/core-http';
-import { RestError } from '@azure/core-http';
+import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
 /** Information about a token returned by an analyzer. */
@@ -104,12 +105,12 @@ export declare type AutocompleteMode = "oneTerm" | "twoTerms" | "oneTermWithCont
 /**
  * Options for retrieving completion text for a partial searchText.
  */
-export declare type AutocompleteOptions<Fields> = OperationOptions & AutocompleteRequest<Fields>;
+export declare type AutocompleteOptions<TFields> = OperationOptions & AutocompleteRequest<TFields>;
 
 /**
  * Parameters for fuzzy matching, and other autocomplete query behaviors.
  */
-export declare interface AutocompleteRequest<Fields> {
+export declare interface AutocompleteRequest<TFields> {
     /**
      * Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles
      * and 'oneTermWithContext' to use the current context while producing auto-completed terms.
@@ -150,7 +151,7 @@ export declare interface AutocompleteRequest<Fields> {
      * The comma-separated list of field names to consider when querying for auto-completed terms.
      * Target fields must be included in the specified suggester.
      */
-    searchFields?: Fields[];
+    searchFields?: TFields[] | string[];
     /**
      * The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The
      * default is 5.
@@ -179,6 +180,7 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
     /** The authentication key of the specified AAD application. */
     applicationSecret?: string;
 }
+
 export { AzureKeyCredential }
 
 /** Base type for character filters. */
@@ -327,7 +329,7 @@ export declare type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
  * {@link KnownCharFilterName} can be used interchangeably with CharFilterName,
  *  this enum contains the known values that the service supports.
  * ### Know values supported by the service
- * **html_strip**: 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
+ * **html_strip**: 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
  */
 export declare type CharFilterName = string;
 
@@ -450,7 +452,7 @@ export declare type CreateIndexOptions = OperationOptions;
  */
 export declare interface CreateorUpdateDataSourceConnectionOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
 }
@@ -460,7 +462,7 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
  */
 export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
 }
@@ -487,7 +489,7 @@ export declare interface CreateOrUpdateIndexOptions extends OperationOptions {
  */
 export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
 }
@@ -497,7 +499,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
  */
 export declare interface CreateOrUpdateSynonymMapOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
 }
@@ -832,7 +834,12 @@ export declare type ElisionTokenFilter = BaseTokenFilter & {
  */
 export declare type EntityCategory = string;
 
-/** Text analytics entity recognition. */
+/**
+ * Text analytics entity recognition.
+ *
+ * @deprecated EntityRecognitionSkill has been deprecated. See
+ * https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-deprecated
+ */
 export declare type EntityRecognitionSkill = BaseSearchIndexerSkill & {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     odatatype: "#Microsoft.Skills.Text.EntityRecognitionSkill";
@@ -957,12 +964,12 @@ export declare type GetDataSourceConnectionOptions = OperationOptions;
 /**
  * Options for retrieving a single document.
  */
-export declare interface GetDocumentOptions<Fields> extends OperationOptions {
+export declare interface GetDocumentOptions<TFields> extends OperationOptions {
     /**
      * List of field names to retrieve for the document; Any field not retrieved will be missing from
      * the returned document.
      */
-    selectedFields?: Fields[];
+    selectedFields?: TFields[] | string[];
 }
 
 /**
@@ -1049,58 +1056,58 @@ export declare type IndexActionType = "upload" | "merge" | "mergeOrUpload" | "de
 /**
  * Represents an index action that operates on a document.
  */
-export declare type IndexDocumentsAction<T> = {
+export declare type IndexDocumentsAction<TModel> = {
     /**
      * The operation to perform on a document in an indexing batch. Possible values include:
      * 'upload', 'merge', 'mergeOrUpload', 'delete'
      */
     __actionType: IndexActionType;
-} & Partial<T>;
+} & Partial<TModel>;
 
 /**
  * Class used to perform batch operations
  * with multiple documents to the index.
  */
-export declare class IndexDocumentsBatch<T> {
+export declare class IndexDocumentsBatch<TModel> {
     /**
      * The set of actions taken in this batch.
      */
-    readonly actions: IndexDocumentsAction<T>[];
-    constructor(actions?: IndexDocumentsAction<T>[]);
+    readonly actions: IndexDocumentsAction<TModel>[];
+    constructor(actions?: IndexDocumentsAction<TModel>[]);
     /**
      * Upload an array of documents to the index.
      * @param documents - The documents to upload.
      */
-    upload(documents: T[]): void;
+    upload(documents: TModel[]): void;
     /**
      * 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
      * @param documents - The updated documents.
      */
-    merge(documents: T[]): void;
+    merge(documents: TModel[]): void;
     /**
      * Update a set of documents in the index or uploads 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
      * @param documents - The new/updated documents.
      */
-    mergeOrUpload(documents: T[]): void;
+    mergeOrUpload(documents: TModel[]): void;
     /**
      * 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.
      */
-    delete(keyName: keyof T, keyValues: string[]): void;
+    delete(keyName: keyof TModel, keyValues: string[]): void;
     /**
      * Delete a set of documents.
      * @param documents - Documents to be deleted.
      */
-    delete(documents: T[]): void;
+    delete(documents: TModel[]): void;
 }
 
 /**
  * Index Documents Client
  */
-export declare interface IndexDocumentsClient<T> {
+export declare interface IndexDocumentsClient<TModel> {
     /**
      * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
      * for the given set of documents.
@@ -1108,7 +1115,7 @@ export declare interface IndexDocumentsClient<T> {
      * @param batch - An array of actions to perform on the index.
      * @param options - Additional options.
      */
-    indexDocuments(batch: IndexDocumentsBatch<T>, options: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
+    indexDocuments(batch: IndexDocumentsBatch<TModel>, options: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
 }
 
 /**
@@ -2930,12 +2937,12 @@ export declare type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneS
  * **ur.microsoft**: Microsoft analyzer for Urdu. \
  * **vi.microsoft**: Microsoft analyzer for Vietnamese. \
  * **standard.lucene**: Standard Lucene analyzer. \
- * **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers \
- * **keyword**: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html \
- * **pattern**: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html \
- * **simple**: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html \
- * **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html \
- * **whitespace**: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html
+ * **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https:\/\/docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#Analyzers \
+ * **keyword**: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/KeywordAnalyzer.html \
+ * **pattern**: Flexibly separates text into terms via a regular expression pattern. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/PatternAnalyzer.html \
+ * **simple**: Divides text at non-letters and converts them to lower case. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/SimpleAnalyzer.html \
+ * **stop**: Divides text at non-letters; Applies the lowercase and stopword token filters. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/StopAnalyzer.html \
+ * **whitespace**: An analyzer that uses the whitespace tokenizer. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/WhitespaceAnalyzer.html
  */
 export declare type LexicalAnalyzerName = string;
 
@@ -3407,7 +3414,7 @@ export declare type ScoringStatistics = "local" | "global";
  * including querying documents in the index as well as
  * adding, updating, and removing them.
  */
-export declare class SearchClient<T> implements IndexDocumentsClient<T> {
+export declare class SearchClient<TModel> implements IndexDocumentsClient<TModel> {
     /**
      * The API version to use when communicating with the service.
      */
@@ -3431,13 +3438,18 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
      * const client = new SearchClient(
      *   "<endpoint>",
      *   "<indexName>",
-     *   new AzureKeyCredential("<Admin Key>");
+     *   new AzureKeyCredential("<Admin Key>")
      * );
      * ```
      * @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);
     /**
@@ -3452,7 +3464,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
      * @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.
      */
-    autocomplete<Fields extends keyof T>(searchText: string, suggesterName: string, options?: AutocompleteOptions<Fields>): Promise<AutocompleteResult>;
+    autocomplete<TFields extends keyof TModel>(searchText: string, suggesterName: string, options?: AutocompleteOptions<TFields>): Promise<AutocompleteResult>;
     private searchDocuments;
     private listSearchResultsPage;
     private listSearchResultsAll;
@@ -3463,7 +3475,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
      * @param searchText - Text to search
      * @param options - Options for the search operation.
      */
-    search<Fields extends keyof T>(searchText?: string, options?: SearchOptions<Fields>): Promise<SearchDocumentsResult<Pick<T, Fields>>>;
+    search<TFields extends keyof TModel>(searchText?: string, options?: SearchOptions<TFields>): Promise<SearchDocumentsResult<Pick<TModel, TFields>>>;
     /**
      * Returns a short list of suggestions based on the searchText
      * and specified suggester.
@@ -3471,13 +3483,13 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
      * @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
      */
-    suggest<Fields extends keyof T = never>(searchText: string, suggesterName: string, options?: SuggestOptions<Fields>): Promise<SuggestDocumentsResult<Pick<T, Fields>>>;
+    suggest<TFields extends keyof TModel = never>(searchText: string, suggesterName: string, options?: SuggestOptions<TFields>): Promise<SuggestDocumentsResult<Pick<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<Fields extends keyof T>(key: string, options?: GetDocumentOptions<Fields>): Promise<T>;
+    getDocument<TFields extends Extract<keyof TModel, string>>(key: string, options?: GetDocumentOptions<TFields>): Promise<TModel>;
     /**
      * Perform a set of index modifications (upload, merge, mergeOrUpload, delete)
      * for the given set of documents.
@@ -3488,43 +3500,42 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
      * @param batch - An array of actions to perform on the index.
      * @param options - Additional options.
      */
-    indexDocuments(batch: IndexDocumentsBatch<T>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>;
+    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: T[], options?: UploadDocumentsOptions): Promise<IndexDocumentsResult>;
+    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
      * @param documents - The updated documents.
      * @param options - Additional options.
      */
-    mergeDocuments(documents: T[], options?: MergeDocumentsOptions): Promise<IndexDocumentsResult>;
+    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
      * @param documents - The updated documents.
      * @param options - Additional options.
      */
-    mergeOrUploadDocuments(documents: T[], options?: MergeOrUploadDocumentsOptions): Promise<IndexDocumentsResult>;
+    mergeOrUploadDocuments(documents: TModel[], options?: MergeOrUploadDocumentsOptions): Promise<IndexDocumentsResult>;
     /**
      * Delete a set of documents.
      * @param documents - Documents to be deleted.
      * @param options - Additional options.
      */
-    deleteDocuments(documents: T[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
+    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 T, keyValues: string[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
+    deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: DeleteDocumentsOptions): Promise<IndexDocumentsResult>;
     private encodeContinuationToken;
     private decodeContinuationToken;
-    private extractOperationOptions;
     private convertSelect;
     private convertSearchFields;
     private convertOrderBy;
@@ -3533,7 +3544,7 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
 /**
  * Client options used to configure Cognitive Search API requests.
  */
-export declare interface SearchClientOptions extends PipelineOptions {
+export declare interface SearchClientOptions extends ExtendedCommonClientOptions {
     /**
      * The API version to use when communicating with the service.
      */
@@ -3549,12 +3560,12 @@ export declare interface SearchClientOptions extends PipelineOptions {
 /**
  * Response containing search page results from an index.
  */
-export declare interface SearchDocumentsPageResult<T> extends SearchDocumentsResultBase {
+export declare interface SearchDocumentsPageResult<TModel> extends SearchDocumentsResultBase {
     /**
      * The sequence of results returned by the query.
      * **NOTE: This property will not be serialized. It can only be populated by the server.**
      */
-    readonly results: SearchResult<T>[];
+    readonly results: SearchResult<TModel>[];
     /**
      * A token used for retrieving the next page of results when the server
      * enforces pagination.
@@ -3565,12 +3576,12 @@ export declare interface SearchDocumentsPageResult<T> extends SearchDocumentsRes
 /**
  * Response containing search results from an index.
  */
-export declare interface SearchDocumentsResult<T> extends SearchDocumentsResultBase {
+export declare interface SearchDocumentsResult<TModel> extends SearchDocumentsResultBase {
     /**
      * The sequence of results returned by the query.
      * **NOTE: This property will not be serialized. It can only be populated by the server.**
      */
-    readonly results: SearchIterator<T>;
+    readonly results: SearchIterator<TModel>;
 }
 
 /**
@@ -3610,9 +3621,9 @@ export declare type SearchField = SimpleField | ComplexField;
 /**
  * Defines values for SearchFieldDataType.
  * Possible values include: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean',
- * 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)',
- * 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)',
- * 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)'
+ * 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)',
+ * 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)',
+ * 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)'
  * @readonly
  */
 export declare type SearchFieldDataType = "Edm.String" | "Edm.Int32" | "Edm.Int64" | "Edm.Double" | "Edm.Boolean" | "Edm.DateTimeOffset" | "Edm.GeographyPoint" | "Collection(Edm.String)" | "Collection(Edm.Int32)" | "Collection(Edm.Int64)" | "Collection(Edm.Double)" | "Collection(Edm.Boolean)" | "Collection(Edm.DateTimeOffset)" | "Collection(Edm.GeographyPoint)";
@@ -3822,14 +3833,18 @@ export declare class SearchIndexClient {
      * Retrieves the SearchClient corresponding to this SearchIndexClient
      * @param indexName - Name of the index
      * @param options - SearchClient Options
+     * @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`.
      */
-    getSearchClient<T>(indexName: string, options?: SearchClientOptions): SearchClient<T>;
+    getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>;
 }
 
 /**
  * Client options used to configure Cognitive Search API requests.
  */
-export declare interface SearchIndexClientOptions extends PipelineOptions {
+export declare interface SearchIndexClientOptions extends ExtendedCommonClientOptions {
     /**
      * The API version to use when communicating with the service.
      */
@@ -4062,7 +4077,7 @@ export declare class SearchIndexerClient {
 /**
  * Client options used to configure Cognitive Search API requests.
  */
-export declare interface SearchIndexerClientOptions extends PipelineOptions {
+export declare interface SearchIndexerClientOptions extends ExtendedCommonClientOptions {
     /**
      * The API version to use when communicating with the service.
      */
@@ -4353,7 +4368,7 @@ export declare interface SearchIndexerWarning {
  * Class used to perform buffered operations against a search index,
  * including adding, updating, and removing them.
  */
-export declare class SearchIndexingBufferedSender<T> {
+export declare class SearchIndexingBufferedSender<TModel> {
     /**
      * Search Client used to call the underlying IndexBatch operations.
      */
@@ -4405,35 +4420,35 @@ export declare class SearchIndexingBufferedSender<T> {
      * @param options - Options to modify auto flush.
      *
      */
-    constructor(client: IndexDocumentsClient<T>, documentKeyRetriever: (document: T) => string, options?: SearchIndexingBufferedSenderOptions);
+    constructor(client: IndexDocumentsClient<TModel>, documentKeyRetriever: (document: TModel) => string, options?: SearchIndexingBufferedSenderOptions);
     /**
      * Uploads the documents/Adds the documents to the upload queue.
      *
      * @param documents - Documents to be uploaded.
      * @param options - Upload options.
      */
-    uploadDocuments(documents: T[], options?: SearchIndexingBufferedSenderUploadDocumentsOptions): Promise<void>;
+    uploadDocuments(documents: TModel[], options?: SearchIndexingBufferedSenderUploadDocumentsOptions): Promise<void>;
     /**
      * Merges the documents/Adds the documents to the merge queue.
      *
      * @param documents - Documents to be merged.
      * @param options - Upload options.
      */
-    mergeDocuments(documents: T[], options?: SearchIndexingBufferedSenderMergeDocumentsOptions): Promise<void>;
+    mergeDocuments(documents: TModel[], options?: SearchIndexingBufferedSenderMergeDocumentsOptions): Promise<void>;
     /**
      * Merges/Uploads the documents/Adds the documents to the merge/upload queue.
      *
      * @param documents - Documents to be merged/uploaded.
      * @param options - Upload options.
      */
-    mergeOrUploadDocuments(documents: T[], options?: SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions): Promise<void>;
+    mergeOrUploadDocuments(documents: TModel[], options?: SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions): Promise<void>;
     /**
      * Deletes the documents/Adds the documents to the delete queue.
      *
      * @param documents - Documents to be deleted.
      * @param options - Upload options.
      */
-    deleteDocuments(documents: T[], options?: SearchIndexingBufferedSenderDeleteDocumentsOptions): Promise<void>;
+    deleteDocuments(documents: TModel[], options?: SearchIndexingBufferedSenderDeleteDocumentsOptions): Promise<void>;
     /**
      * Flushes the queue manually.
      *
@@ -4452,7 +4467,7 @@ export declare class SearchIndexingBufferedSender<T> {
      */
     on(event: "batchAdded", listener: (e: {
         action: string;
-        documents: T[];
+        documents: TModel[];
     }) => void): void;
     /**
      * Attach Batch Sent Event
@@ -4460,7 +4475,7 @@ export declare class SearchIndexingBufferedSender<T> {
      * @param event - Event to be emitted
      * @param listener - Event Listener
      */
-    on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<T>) => void): void;
+    on(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void): void;
     /**
      * Attach Batch Succeeded Event
      *
@@ -4483,7 +4498,7 @@ export declare class SearchIndexingBufferedSender<T> {
      */
     off(event: "batchAdded", listener: (e: {
         action: string;
-        documents: T[];
+        documents: TModel[];
     }) => void): void;
     /**
      * Detach Batch Sent Event
@@ -4491,7 +4506,7 @@ export declare class SearchIndexingBufferedSender<T> {
      * @param event - Event to be emitted
      * @param listener - Event Listener
      */
-    off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<T>) => void): void;
+    off(event: "beforeDocumentSent", listener: (e: IndexDocumentsAction<TModel>) => void): void;
     /**
      * Detach Batch Succeeded Event
      *
@@ -4596,7 +4611,7 @@ export declare interface SearchIndexStatistics {
  * as needed during iteration. Use .byPage() to make one request to the server
  * per iteration.
  */
-export declare type SearchIterator<Fields> = PagedAsyncIterableIterator<SearchResult<Fields>, SearchDocumentsPageResult<Fields>, ListSearchResultsPageSettings>;
+export declare type SearchIterator<TFields> = PagedAsyncIterableIterator<SearchResult<TFields>, SearchDocumentsPageResult<TFields>, ListSearchResultsPageSettings>;
 
 /** Defines values for SearchMode. */
 export declare type SearchMode = "any" | "all";
@@ -4604,7 +4619,7 @@ export declare type SearchMode = "any" | "all";
 /**
  * Options for committing a full search request.
  */
-export declare type SearchOptions<Fields> = OperationOptions & SearchRequestOptions<Fields>;
+export declare type SearchOptions<TFields> = OperationOptions & SearchRequestOptions<TFields>;
 
 /**
  * Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
@@ -4726,7 +4741,7 @@ export declare interface SearchRequest {
 /**
  * Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
  */
-export declare interface SearchRequestOptions<Fields> {
+export declare interface SearchRequestOptions<TFields> {
     /**
      * A value that specifies whether to fetch the total count of results. Default is false. Setting
      * this value to true may have a performance impact. Note that the count returned is an
@@ -4794,7 +4809,7 @@ export declare interface SearchRequestOptions<Fields> {
      * fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each
      * fielded search expression take precedence over any field names listed in this parameter.
      */
-    searchFields?: Fields[];
+    searchFields?: TFields[] | string[];
     /**
      * A value that specifies whether any or all of the search terms must be matched in order to
      * count the document as a match. Possible values include: 'any', 'all'
@@ -4818,7 +4833,7 @@ export declare interface SearchRequestOptions<Fields> {
      * The list of fields to retrieve. If unspecified, all fields marked as
      * retrievable in the schema are included.
      */
-    select?: Fields[];
+    select?: TFields[] | string[];
     /**
      * The number of search results to skip. This value cannot be greater than 100,000. If you need
      * to scan documents in sequence, but cannot use skip due to this limitation, consider using
@@ -4869,7 +4884,7 @@ export declare interface SearchResourceEncryptionKey {
 /**
  * Contains a document found by a search query, plus associated metadata.
  */
-export declare type SearchResult<T> = {
+export declare type SearchResult<TModel> = {
     /**
      * The relevance score of the document compared to other documents returned by the query.
      * **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -4881,9 +4896,9 @@ export declare type SearchResult<T> = {
      * **NOTE: This property will not be serialized. It can only be populated by the server.**
      */
     readonly highlights?: {
-        [k in keyof T]?: string[];
+        [k in keyof TModel]?: string[];
     };
-    document: T;
+    document: TModel;
 };
 
 /**
@@ -4911,7 +4926,12 @@ export declare interface SearchSuggester {
     sourceFields: string[];
 }
 
-/** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
+/**
+ * Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.
+ *
+ * @deprecated SentimentSkill has been deprecated. See
+ * https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-deprecated
+ */
 export declare type SentimentSkill = BaseSearchIndexerSkill & {
     /** Polymorphic discriminator, which specifies the different types this object can be */
     odatatype: "#Microsoft.Skills.Text.SentimentSkill";
@@ -5019,7 +5039,7 @@ export declare interface SimpleField {
     name: string;
     /**
      * The data type of the field. Possible values include: 'Edm.String', 'Edm.Int32', 'Edm.Int64',
-     * 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint'
+     * 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint',
      * 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)',
      * 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)',
      * 'Collection(Edm.GeographyPoint)'
@@ -5213,12 +5233,12 @@ export declare type StopwordsTokenFilter = BaseTokenFilter & {
 /**
  * Response containing suggestion query results from an index.
  */
-export declare interface SuggestDocumentsResult<T> {
+export declare interface SuggestDocumentsResult<TModel> {
     /**
      * The sequence of results returned by the query.
      * **NOTE: This property will not be serialized. It can only be populated by the server.**
      */
-    readonly results: SuggestResult<T>[];
+    readonly results: SuggestResult<TModel>[];
     /**
      * A value indicating the percentage of the index that was included in the query, or null if
      * minimumCoverage was not set in the request.
@@ -5230,12 +5250,12 @@ export declare interface SuggestDocumentsResult<T> {
 /**
  * Options for retrieving suggestions based on the searchText.
  */
-export declare type SuggestOptions<Fields> = OperationOptions & SuggestRequest<Fields>;
+export declare type SuggestOptions<TFields> = OperationOptions & SuggestRequest<TFields>;
 
 /**
  * Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.
  */
-export declare interface SuggestRequest<Fields> {
+export declare interface SuggestRequest<TFields> {
     /**
      * An OData expression that filters the documents considered for suggestions.
      */
@@ -5278,12 +5298,12 @@ export declare interface SuggestRequest<Fields> {
      * The comma-separated list of field names to search for the specified search text. Target fields
      * must be included in the specified suggester.
      */
-    searchFields?: Fields[];
+    searchFields?: TFields[] | string[];
     /**
      * The list of fields to retrieve. If unspecified, only the key field will be
      * included in the results.
      */
-    select?: Fields[];
+    select?: TFields[] | string[];
     /**
      * The number of suggestions to retrieve. This must be a value between 1 and 100. The default is
      * 5.
@@ -5294,13 +5314,13 @@ export declare interface SuggestRequest<Fields> {
 /**
  * A result containing a document found by a suggestion query, plus associated metadata.
  */
-export declare type SuggestResult<T> = {
+export declare type SuggestResult<TModel> = {
     /**
      * The text of the suggestion result.
      * **NOTE: This property will not be serialized. It can only be populated by the server.**
      */
     readonly text: string;
-    document: T;
+    document: TModel;
 };
 
 /**
@@ -5472,39 +5492,39 @@ export declare type TokenFilter = AsciiFoldingTokenFilter | CjkBigramTokenFilter
  * {@link KnownTokenFilterName} can be used interchangeably with TokenFilterName,
  *  this enum contains the known values that the service supports.
  * ### Know values supported by the service
- * **arabic_normalization**: A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html \
- * **apostrophe**: Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html \
- * **asciifolding**: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html \
- * **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html \
- * **cjk_width**: Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html \
- * **classic**: Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html \
- * **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html \
- * **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html \
- * **elision**: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html \
- * **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html \
- * **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html \
- * **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html \
- * **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html \
- * **kstem**: A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html \
- * **length**: Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html \
- * **limit**: Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html \
- * **lowercase**: Normalizes token text to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm \
- * **nGram_v2**: Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html \
- * **persian_normalization**: Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html \
- * **phonetic**: Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html \
- * **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer \
- * **reverse**: Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html \
- * **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html \
- * **scandinavian_folding**: Folds Scandinavian characters åÅäæÄÆ-&gt;a and öÖøØ-&gt;o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html \
- * **shingle**: Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html \
- * **snowball**: A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html \
- * **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html \
- * **stemmer**: Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters \
- * **stopwords**: Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html \
- * **trim**: Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html \
- * **truncate**: Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html \
- * **unique**: Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html \
- * **uppercase**: Normalizes token text to upper case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html \
+ * **arabic_normalization**: A token filter that applies the Arabic normalizer to normalize the orthography. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ar\/ArabicNormalizationFilter.html \
+ * **apostrophe**: Strips all characters after an apostrophe (including the apostrophe itself). See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/tr\/ApostropheFilter.html \
+ * **asciifolding**: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ASCIIFoldingFilter.html \
+ * **cjk_bigram**: Forms bigrams of CJK terms that are generated from the standard tokenizer. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKBigramFilter.html \
+ * **cjk_width**: Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/cjk\/CJKWidthFilter.html \
+ * **classic**: Removes English possessives, and dots from acronyms. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/standard\/ClassicFilter.html \
+ * **common_grams**: Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/commongrams\/CommonGramsFilter.html \
+ * **edgeNGram_v2**: Generates n-grams of the given size(s) starting from the front or the back of an input token. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/EdgeNGramTokenFilter.html \
+ * **elision**: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/util\/ElisionFilter.html \
+ * **german_normalization**: Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/de\/GermanNormalizationFilter.html \
+ * **hindi_normalization**: Normalizes text in Hindi to remove some differences in spelling variations. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/hi\/HindiNormalizationFilter.html \
+ * **indic_normalization**: Normalizes the Unicode representation of text in Indian languages. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/in\/IndicNormalizationFilter.html \
+ * **keyword_repeat**: Emits each incoming token twice, once as keyword and once as non-keyword. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/KeywordRepeatFilter.html \
+ * **kstem**: A high-performance kstem filter for English. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/en\/KStemFilter.html \
+ * **length**: Removes words that are too long or too short. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LengthFilter.html \
+ * **limit**: Limits the number of tokens while indexing. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/LimitTokenCountFilter.html \
+ * **lowercase**: Normalizes token text to lower case. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/LowerCaseFilter.htm \
+ * **nGram_v2**: Generates n-grams of the given size(s). See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ngram\/NGramTokenFilter.html \
+ * **persian_normalization**: Applies normalization for Persian. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/fa\/PersianNormalizationFilter.html \
+ * **phonetic**: Create tokens for phonetic matches. See https:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-phonetic\/org\/apache\/lucene\/analysis\/phonetic\/package-tree.html \
+ * **porter_stem**: Uses the Porter stemming algorithm to transform the token stream. See http:\/\/tartarus.org\/~martin\/PorterStemmer \
+ * **reverse**: Reverses the token string. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/reverse\/ReverseStringFilter.html \
+ * **scandinavian_normalization**: Normalizes use of the interchangeable Scandinavian characters. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianNormalizationFilter.html \
+ * **scandinavian_folding**: Folds Scandinavian characters åÅäæÄÆ-&gt;a and öÖøØ-&gt;o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/ScandinavianFoldingFilter.html \
+ * **shingle**: Creates combinations of tokens as a single token. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/shingle\/ShingleFilter.html \
+ * **snowball**: A filter that stems words using a Snowball-generated stemmer. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/snowball\/SnowballFilter.html \
+ * **sorani_normalization**: Normalizes the Unicode representation of Sorani text. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ckb\/SoraniNormalizationFilter.html \
+ * **stemmer**: Language specific stemming filter. See https:\/\/docs.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#TokenFilters \
+ * **stopwords**: Removes stop words from a token stream. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/StopFilter.html \
+ * **trim**: Trims leading and trailing whitespace from tokens. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TrimFilter.html \
+ * **truncate**: Truncates the terms to a specific length. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/TruncateTokenFilter.html \
+ * **unique**: Filters out tokens with same text as the previous token. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/miscellaneous\/RemoveDuplicatesTokenFilter.html \
+ * **uppercase**: Normalizes token text to upper case. See http:\/\/lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/core\/UpperCaseFilter.html \
  * **word_delimiter**: Splits words into subwords and performs optional transformations on subword groups.
  */
 export declare type TokenFilterName = string;