@azure/search-documents 11.3.0-beta.4 → 11.3.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/dist/index.js +1352 -504
- package/dist/index.js.map +1 -1
- package/dist-esm/src/constants.js +1 -1
- package/dist-esm/src/constants.js.map +1 -1
- package/dist-esm/src/generated/data/models/index.js +141 -1
- package/dist-esm/src/generated/data/models/index.js.map +1 -1
- package/dist-esm/src/generated/data/models/mappers.js +6 -0
- package/dist-esm/src/generated/data/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/data/models/parameters.js +9 -0
- package/dist-esm/src/generated/data/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/data/operations/documents.js +1 -0
- package/dist-esm/src/generated/data/operations/documents.js.map +1 -1
- package/dist-esm/src/generated/data/searchClientContext.js +1 -1
- package/dist-esm/src/generated/data/searchClientContext.js.map +1 -1
- package/dist-esm/src/generated/service/models/index.js +2 -0
- package/dist-esm/src/generated/service/models/index.js.map +1 -1
- package/dist-esm/src/generated/service/models/mappers.js +218 -7
- package/dist-esm/src/generated/service/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/service/models/parameters.js +15 -1
- package/dist-esm/src/generated/service/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/service/operations/aliases.js +166 -0
- package/dist-esm/src/generated/service/operations/aliases.js.map +1 -0
- package/dist-esm/src/generated/service/operations/index.js +1 -0
- package/dist-esm/src/generated/service/operations/index.js.map +1 -1
- package/dist-esm/src/generated/service/operationsInterfaces/aliases.js +9 -0
- package/dist-esm/src/generated/service/operationsInterfaces/aliases.js.map +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/index.js +1 -0
- package/dist-esm/src/generated/service/operationsInterfaces/index.js.map +1 -1
- package/dist-esm/src/generated/service/searchServiceClient.js +2 -1
- package/dist-esm/src/generated/service/searchServiceClient.js.map +1 -1
- package/dist-esm/src/generated/service/searchServiceClientContext.js +1 -1
- package/dist-esm/src/generated/service/searchServiceClientContext.js.map +1 -1
- package/dist-esm/src/geographyPoint.js +1 -1
- package/dist-esm/src/geographyPoint.js.map +1 -1
- package/dist-esm/src/index.js +4 -4
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/indexDocumentsBatch.js +1 -1
- package/dist-esm/src/indexDocumentsBatch.js.map +1 -1
- package/dist-esm/src/indexModels.js.map +1 -1
- package/dist-esm/src/odataMetadataPolicy.js +1 -1
- package/dist-esm/src/odataMetadataPolicy.js.map +1 -1
- package/dist-esm/src/searchApiKeyCredentialPolicy.js +1 -1
- package/dist-esm/src/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/src/searchClient.js +39 -27
- package/dist-esm/src/searchClient.js.map +1 -1
- package/dist-esm/src/searchIndexClient.js +186 -28
- package/dist-esm/src/searchIndexClient.js.map +1 -1
- package/dist-esm/src/searchIndexerClient.js +47 -35
- package/dist-esm/src/searchIndexerClient.js.map +1 -1
- package/dist-esm/src/searchIndexingBufferedSender.js +10 -10
- package/dist-esm/src/searchIndexingBufferedSender.js.map +1 -1
- package/dist-esm/src/serialization.js +6 -6
- package/dist-esm/src/serialization.js.map +1 -1
- package/dist-esm/src/serviceModels.js.map +1 -1
- package/dist-esm/src/serviceUtils.js +25 -18
- package/dist-esm/src/serviceUtils.js.map +1 -1
- package/dist-esm/src/synonymMapHelper.js +1 -1
- package/dist-esm/src/synonymMapHelper.js.map +1 -1
- package/dist-esm/src/tracing.js +1 -1
- package/dist-esm/src/tracing.js.map +1 -1
- package/package.json +17 -29
- package/types/search-documents.d.ts +445 -52
|
@@ -8,6 +8,13 @@ import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
|
8
8
|
import { RestError } from '@azure/core-rest-pipeline';
|
|
9
9
|
import { TokenCredential } from '@azure/core-auth';
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* An iterator for listing the aliases that exist in the Search service. Will make requests
|
|
13
|
+
* as needed during iteration. Use .byPage() to make one request to the server
|
|
14
|
+
* per iteration.
|
|
15
|
+
*/
|
|
16
|
+
export declare type AliasIterator = PagedAsyncIterableIterator<SearchIndexAlias, SearchIndexAlias[], {}>;
|
|
17
|
+
|
|
11
18
|
/** Information about a token returned by an analyzer. */
|
|
12
19
|
export declare interface AnalyzedTokenInfo {
|
|
13
20
|
/**
|
|
@@ -86,7 +93,7 @@ export declare interface AnswerResult {
|
|
|
86
93
|
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
87
94
|
[property: string]: any;
|
|
88
95
|
/**
|
|
89
|
-
* The score value represents how relevant the answer is to the
|
|
96
|
+
* The score value represents how relevant the answer is to the query relative to other answers returned for the query.
|
|
90
97
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
91
98
|
*/
|
|
92
99
|
readonly score: number;
|
|
@@ -223,6 +230,24 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
|
|
|
223
230
|
|
|
224
231
|
export { AzureKeyCredential }
|
|
225
232
|
|
|
233
|
+
/** The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment. */
|
|
234
|
+
export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
|
|
235
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
236
|
+
odatatype: "#Microsoft.Skills.Custom.AmlSkill";
|
|
237
|
+
/** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
|
|
238
|
+
scoringUri?: string;
|
|
239
|
+
/** (Required for key authentication) The key for the AML service. */
|
|
240
|
+
authenticationKey?: string;
|
|
241
|
+
/** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
|
|
242
|
+
resourceId?: string;
|
|
243
|
+
/** (Optional) When specified, indicates the timeout for the http client making the API call. */
|
|
244
|
+
timeout?: string;
|
|
245
|
+
/** (Optional for token authentication). The region the AML service is deployed in. */
|
|
246
|
+
region?: string;
|
|
247
|
+
/** (Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. */
|
|
248
|
+
degreeOfParallelism?: number;
|
|
249
|
+
};
|
|
250
|
+
|
|
226
251
|
/** Base type for character filters. */
|
|
227
252
|
export declare interface BaseCharFilter {
|
|
228
253
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -296,7 +321,7 @@ export declare interface BaseSearchIndexerDataIdentity {
|
|
|
296
321
|
/** Base type for skills. */
|
|
297
322
|
export declare interface BaseSearchIndexerSkill {
|
|
298
323
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
299
|
-
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill";
|
|
324
|
+
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.AmlSkill";
|
|
300
325
|
/** The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. */
|
|
301
326
|
name?: string;
|
|
302
327
|
/** The description of the skill which describes the inputs, outputs, and usage of the skill. */
|
|
@@ -512,6 +537,11 @@ export declare interface CorsOptions {
|
|
|
512
537
|
*/
|
|
513
538
|
export declare type CountDocumentsOptions = OperationOptions;
|
|
514
539
|
|
|
540
|
+
/**
|
|
541
|
+
* Options for create alias operation.
|
|
542
|
+
*/
|
|
543
|
+
export declare type CreateAliasOptions = OperationOptions;
|
|
544
|
+
|
|
515
545
|
/**
|
|
516
546
|
* Options for create datasource operation.
|
|
517
547
|
*/
|
|
@@ -527,6 +557,16 @@ export declare type CreateIndexerOptions = OperationOptions;
|
|
|
527
557
|
*/
|
|
528
558
|
export declare type CreateIndexOptions = OperationOptions;
|
|
529
559
|
|
|
560
|
+
/**
|
|
561
|
+
* Options for create or update alias operation.
|
|
562
|
+
*/
|
|
563
|
+
export declare interface CreateOrUpdateAliasOptions extends OperationOptions {
|
|
564
|
+
/**
|
|
565
|
+
* If set to true, Resource will be deleted only if the etag matches.
|
|
566
|
+
*/
|
|
567
|
+
onlyIfUnchanged?: boolean;
|
|
568
|
+
}
|
|
569
|
+
|
|
530
570
|
/**
|
|
531
571
|
* Options for create/update datasource operation.
|
|
532
572
|
*/
|
|
@@ -770,6 +810,16 @@ export declare type DefaultCognitiveServicesAccount = BaseCognitiveServicesAccou
|
|
|
770
810
|
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices";
|
|
771
811
|
};
|
|
772
812
|
|
|
813
|
+
/**
|
|
814
|
+
* Options for delete alias operation.
|
|
815
|
+
*/
|
|
816
|
+
export declare interface DeleteAliasOptions extends OperationOptions {
|
|
817
|
+
/**
|
|
818
|
+
* If set to true, Resource will be deleted only if the etag matches.
|
|
819
|
+
*/
|
|
820
|
+
onlyIfUnchanged?: boolean;
|
|
821
|
+
}
|
|
822
|
+
|
|
773
823
|
/**
|
|
774
824
|
* Options for delete datasource operation.
|
|
775
825
|
*/
|
|
@@ -1083,6 +1133,11 @@ export declare class GeographyPoint {
|
|
|
1083
1133
|
toJSON(): Record<string, unknown>;
|
|
1084
1134
|
}
|
|
1085
1135
|
|
|
1136
|
+
/**
|
|
1137
|
+
* Options for get alias operation.
|
|
1138
|
+
*/
|
|
1139
|
+
export declare type GetAliasOptions = OperationOptions;
|
|
1140
|
+
|
|
1086
1141
|
/**
|
|
1087
1142
|
* Options for get datasource operation.
|
|
1088
1143
|
*/
|
|
@@ -1265,45 +1320,6 @@ export declare interface IndexDocumentsResult {
|
|
|
1265
1320
|
readonly results: IndexingResult[];
|
|
1266
1321
|
}
|
|
1267
1322
|
|
|
1268
|
-
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
1269
|
-
export declare interface IndexerCurrentState {
|
|
1270
|
-
/**
|
|
1271
|
-
* The mode the indexer is running in.
|
|
1272
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1273
|
-
*/
|
|
1274
|
-
readonly mode?: IndexingMode;
|
|
1275
|
-
/**
|
|
1276
|
-
* Change tracking state used when indexing starts on all documents in the datasource.
|
|
1277
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1278
|
-
*/
|
|
1279
|
-
readonly allDocsInitialChangeTrackingState?: string;
|
|
1280
|
-
/**
|
|
1281
|
-
* Change tracking state value when indexing finishes on all documents in the datasource.
|
|
1282
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1283
|
-
*/
|
|
1284
|
-
readonly allDocsFinalChangeTrackingState?: string;
|
|
1285
|
-
/**
|
|
1286
|
-
* Change tracking state used when indexing starts on select, reset documents in the datasource.
|
|
1287
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1288
|
-
*/
|
|
1289
|
-
readonly resetDocsInitialChangeTrackingState?: string;
|
|
1290
|
-
/**
|
|
1291
|
-
* Change tracking state value when indexing finishes on select, reset documents in the datasource.
|
|
1292
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1293
|
-
*/
|
|
1294
|
-
readonly resetDocsFinalChangeTrackingState?: string;
|
|
1295
|
-
/**
|
|
1296
|
-
* The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
|
|
1297
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1298
|
-
*/
|
|
1299
|
-
readonly resetDocumentKeys?: string[];
|
|
1300
|
-
/**
|
|
1301
|
-
* The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
|
|
1302
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1303
|
-
*/
|
|
1304
|
-
readonly resetDatasourceDocumentIds?: string[];
|
|
1305
|
-
}
|
|
1306
|
-
|
|
1307
1323
|
/**
|
|
1308
1324
|
* Defines values for IndexerExecutionEnvironment. \
|
|
1309
1325
|
* {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
|
|
@@ -1330,7 +1346,7 @@ export declare interface IndexerExecutionResult {
|
|
|
1330
1346
|
* All of the state that defines and dictates the indexer's current execution.
|
|
1331
1347
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1332
1348
|
*/
|
|
1333
|
-
readonly currentState?:
|
|
1349
|
+
readonly currentState?: IndexerState;
|
|
1334
1350
|
/**
|
|
1335
1351
|
* The error message indicating the top-level error, if any.
|
|
1336
1352
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1390,6 +1406,45 @@ export declare type IndexerExecutionStatus = "transientFailure" | "success" | "i
|
|
|
1390
1406
|
*/
|
|
1391
1407
|
export declare type IndexerExecutionStatusDetail = string;
|
|
1392
1408
|
|
|
1409
|
+
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
1410
|
+
export declare interface IndexerState {
|
|
1411
|
+
/**
|
|
1412
|
+
* The mode the indexer is running in.
|
|
1413
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1414
|
+
*/
|
|
1415
|
+
readonly mode?: IndexingMode;
|
|
1416
|
+
/**
|
|
1417
|
+
* Change tracking state used when indexing starts on all documents in the datasource.
|
|
1418
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1419
|
+
*/
|
|
1420
|
+
readonly allDocumentsInitialChangeTrackingState?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* Change tracking state value when indexing finishes on all documents in the datasource.
|
|
1423
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1424
|
+
*/
|
|
1425
|
+
readonly allDocumentsFinalChangeTrackingState?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* Change tracking state used when indexing starts on select, reset documents in the datasource.
|
|
1428
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1429
|
+
*/
|
|
1430
|
+
readonly resetDocumentsInitialChangeTrackingState?: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* Change tracking state value when indexing finishes on select, reset documents in the datasource.
|
|
1433
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1434
|
+
*/
|
|
1435
|
+
readonly resetDocumentsFinalChangeTrackingState?: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
|
|
1438
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1439
|
+
*/
|
|
1440
|
+
readonly resetDocumentKeys?: string[];
|
|
1441
|
+
/**
|
|
1442
|
+
* The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
|
|
1443
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1444
|
+
*/
|
|
1445
|
+
readonly resetDatasourceDocumentIds?: string[];
|
|
1446
|
+
}
|
|
1447
|
+
|
|
1393
1448
|
/** Defines values for IndexerStatus. */
|
|
1394
1449
|
export declare type IndexerStatus = "unknown" | "error" | "running";
|
|
1395
1450
|
|
|
@@ -2468,7 +2523,9 @@ export declare enum KnownOcrSkillLanguage {
|
|
|
2468
2523
|
/** Serbian (Latin, Serbia) */
|
|
2469
2524
|
SrLatn = "sr-Latn",
|
|
2470
2525
|
/** Slovak */
|
|
2471
|
-
Sk = "sk"
|
|
2526
|
+
Sk = "sk",
|
|
2527
|
+
/** Unknown. If the language is explicitly set to "unk", the language will be auto-detected. */
|
|
2528
|
+
Unk = "unk"
|
|
2472
2529
|
}
|
|
2473
2530
|
|
|
2474
2531
|
/** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
|
|
@@ -2499,8 +2556,148 @@ export declare enum KnownQueryCaptionType {
|
|
|
2499
2556
|
export declare enum KnownQueryLanguage {
|
|
2500
2557
|
/** Query language not specified. */
|
|
2501
2558
|
None = "none",
|
|
2502
|
-
/** English */
|
|
2503
|
-
EnUs = "en-us"
|
|
2559
|
+
/** Query language value for English (United States). */
|
|
2560
|
+
EnUs = "en-us",
|
|
2561
|
+
/** Query language value for English (Great Britain). */
|
|
2562
|
+
EnGb = "en-gb",
|
|
2563
|
+
/** Query language value for English (India). */
|
|
2564
|
+
EnIn = "en-in",
|
|
2565
|
+
/** Query language value for English (Canada). */
|
|
2566
|
+
EnCa = "en-ca",
|
|
2567
|
+
/** Query language value for English (Australia). */
|
|
2568
|
+
EnAu = "en-au",
|
|
2569
|
+
/** Query language value for French (France). */
|
|
2570
|
+
FrFr = "fr-fr",
|
|
2571
|
+
/** Query language value for French (Canada). */
|
|
2572
|
+
FrCa = "fr-ca",
|
|
2573
|
+
/** Query language value for German (Germany). */
|
|
2574
|
+
DeDe = "de-de",
|
|
2575
|
+
/** Query language value for Spanish (Spain). */
|
|
2576
|
+
EsEs = "es-es",
|
|
2577
|
+
/** Query language value for Spanish (Mexico). */
|
|
2578
|
+
EsMx = "es-mx",
|
|
2579
|
+
/** Query language value for Chinese (China). */
|
|
2580
|
+
ZhCn = "zh-cn",
|
|
2581
|
+
/** Query language value for Chinese (Taiwan). */
|
|
2582
|
+
ZhTw = "zh-tw",
|
|
2583
|
+
/** Query language value for Portuguese (Brazil). */
|
|
2584
|
+
PtBr = "pt-br",
|
|
2585
|
+
/** Query language value for Portuguese (Portugal). */
|
|
2586
|
+
PtPt = "pt-pt",
|
|
2587
|
+
/** Query language value for Italian (Italy). */
|
|
2588
|
+
ItIt = "it-it",
|
|
2589
|
+
/** Query language value for Japanese (Japan). */
|
|
2590
|
+
JaJp = "ja-jp",
|
|
2591
|
+
/** Query language value for Korean (Korea). */
|
|
2592
|
+
KoKr = "ko-kr",
|
|
2593
|
+
/** Query language value for Russian (Russia). */
|
|
2594
|
+
RuRu = "ru-ru",
|
|
2595
|
+
/** Query language value for Czech (Czech Republic). */
|
|
2596
|
+
CsCz = "cs-cz",
|
|
2597
|
+
/** Query language value for Dutch (Belgium). */
|
|
2598
|
+
NlBe = "nl-be",
|
|
2599
|
+
/** Query language value for Dutch (Netherlands). */
|
|
2600
|
+
NlNl = "nl-nl",
|
|
2601
|
+
/** Query language value for Hungarian (Hungary). */
|
|
2602
|
+
HuHu = "hu-hu",
|
|
2603
|
+
/** Query language value for Polish (Poland). */
|
|
2604
|
+
PlPl = "pl-pl",
|
|
2605
|
+
/** Query language value for Swedish (Sweden). */
|
|
2606
|
+
SvSe = "sv-se",
|
|
2607
|
+
/** Query language value for Turkish (Turkey). */
|
|
2608
|
+
TrTr = "tr-tr",
|
|
2609
|
+
/** Query language value for Hindi (India). */
|
|
2610
|
+
HiIn = "hi-in",
|
|
2611
|
+
/** Query language value for Arabic (Saudi Arabia). */
|
|
2612
|
+
ArSa = "ar-sa",
|
|
2613
|
+
/** Query language value for Arabic (Egypt). */
|
|
2614
|
+
ArEg = "ar-eg",
|
|
2615
|
+
/** Query language value for Arabic (Morocco). */
|
|
2616
|
+
ArMa = "ar-ma",
|
|
2617
|
+
/** Query language value for Arabic (Kuwait). */
|
|
2618
|
+
ArKw = "ar-kw",
|
|
2619
|
+
/** Query language value for Arabic (Jordan). */
|
|
2620
|
+
ArJo = "ar-jo",
|
|
2621
|
+
/** Query language value for Danish (Denmark). */
|
|
2622
|
+
DaDk = "da-dk",
|
|
2623
|
+
/** Query language value for Norwegian (Norway). */
|
|
2624
|
+
NoNo = "no-no",
|
|
2625
|
+
/** Query language value for Bulgarian (Bulgaria). */
|
|
2626
|
+
BgBg = "bg-bg",
|
|
2627
|
+
/** Query language value for Croatian (Croatia). */
|
|
2628
|
+
HrHr = "hr-hr",
|
|
2629
|
+
/** Query language value for Croatian (Bosnia and Herzegovina). */
|
|
2630
|
+
HrBa = "hr-ba",
|
|
2631
|
+
/** Query language value for Malay (Malaysia). */
|
|
2632
|
+
MsMy = "ms-my",
|
|
2633
|
+
/** Query language value for Malay (Brunei Darussalam). */
|
|
2634
|
+
MsBn = "ms-bn",
|
|
2635
|
+
/** Query language value for Slovenian (Slovenia). */
|
|
2636
|
+
SlSl = "sl-sl",
|
|
2637
|
+
/** Query language value for Tamil (India). */
|
|
2638
|
+
TaIn = "ta-in",
|
|
2639
|
+
/** Query language value for Vietnamese (Viet Nam). */
|
|
2640
|
+
ViVn = "vi-vn",
|
|
2641
|
+
/** Query language value for Greek (Greece). */
|
|
2642
|
+
ElGr = "el-gr",
|
|
2643
|
+
/** Query language value for Romanian (Romania). */
|
|
2644
|
+
RoRo = "ro-ro",
|
|
2645
|
+
/** Query language value for Icelandic (Iceland). */
|
|
2646
|
+
IsIs = "is-is",
|
|
2647
|
+
/** Query language value for Indonesian (Indonesia). */
|
|
2648
|
+
IdId = "id-id",
|
|
2649
|
+
/** Query language value for Thai (Thailand). */
|
|
2650
|
+
ThTh = "th-th",
|
|
2651
|
+
/** Query language value for Lithuanian (Lithuania). */
|
|
2652
|
+
LtLt = "lt-lt",
|
|
2653
|
+
/** Query language value for Ukrainian (Ukraine). */
|
|
2654
|
+
UkUa = "uk-ua",
|
|
2655
|
+
/** Query language value for Latvian (Latvia). */
|
|
2656
|
+
LvLv = "lv-lv",
|
|
2657
|
+
/** Query language value for Estonian (Estonia). */
|
|
2658
|
+
EtEe = "et-ee",
|
|
2659
|
+
/** Query language value for Catalan (Spain). */
|
|
2660
|
+
CaEs = "ca-es",
|
|
2661
|
+
/** Query language value for Finnish (Finland). */
|
|
2662
|
+
FiFi = "fi-fi",
|
|
2663
|
+
/** Query language value for Serbian (Bosnia and Herzegovina). */
|
|
2664
|
+
SrBa = "sr-ba",
|
|
2665
|
+
/** Query language value for Serbian (Montenegro). */
|
|
2666
|
+
SrMe = "sr-me",
|
|
2667
|
+
/** Query language value for Serbian (Serbia). */
|
|
2668
|
+
SrRs = "sr-rs",
|
|
2669
|
+
/** Query language value for Slovak (Slovakia). */
|
|
2670
|
+
SkSk = "sk-sk",
|
|
2671
|
+
/** Query language value for Norwegian (Norway). */
|
|
2672
|
+
NbNo = "nb-no",
|
|
2673
|
+
/** Query language value for Armenian (Armenia). */
|
|
2674
|
+
HyAm = "hy-am",
|
|
2675
|
+
/** Query language value for Bengali (India). */
|
|
2676
|
+
BnIn = "bn-in",
|
|
2677
|
+
/** Query language value for Basque (Spain). */
|
|
2678
|
+
EuEs = "eu-es",
|
|
2679
|
+
/** Query language value for Galician (Spain). */
|
|
2680
|
+
GlEs = "gl-es",
|
|
2681
|
+
/** Query language value for Gujarati (India). */
|
|
2682
|
+
GuIn = "gu-in",
|
|
2683
|
+
/** Query language value for Hebrew (Israel). */
|
|
2684
|
+
HeIl = "he-il",
|
|
2685
|
+
/** Query language value for Irish (Ireland). */
|
|
2686
|
+
GaIe = "ga-ie",
|
|
2687
|
+
/** Query language value for Kannada (India). */
|
|
2688
|
+
KnIn = "kn-in",
|
|
2689
|
+
/** Query language value for Malayalam (India). */
|
|
2690
|
+
MlIn = "ml-in",
|
|
2691
|
+
/** Query language value for Marathi (India). */
|
|
2692
|
+
MrIn = "mr-in",
|
|
2693
|
+
/** Query language value for Persian (U.A.E.). */
|
|
2694
|
+
FaAe = "fa-ae",
|
|
2695
|
+
/** Query language value for Punjabi (India). */
|
|
2696
|
+
PaIn = "pa-in",
|
|
2697
|
+
/** Query language value for Telugu (India). */
|
|
2698
|
+
TeIn = "te-in",
|
|
2699
|
+
/** Query language value for Urdu (Pakistan). */
|
|
2700
|
+
UrPk = "ur-pk"
|
|
2504
2701
|
}
|
|
2505
2702
|
|
|
2506
2703
|
/** Known values of {@link QuerySpellerType} that the service accepts. */
|
|
@@ -3282,6 +3479,11 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
|
|
|
3282
3479
|
*/
|
|
3283
3480
|
export declare type LineEnding = string;
|
|
3284
3481
|
|
|
3482
|
+
/**
|
|
3483
|
+
* Options for list aliases operation.
|
|
3484
|
+
*/
|
|
3485
|
+
export declare type ListAliasesOptions = OperationOptions;
|
|
3486
|
+
|
|
3285
3487
|
/**
|
|
3286
3488
|
* Options for a list data sources operation.
|
|
3287
3489
|
*/
|
|
@@ -3505,7 +3707,8 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
|
|
|
3505
3707
|
* **ro**: Romanian \
|
|
3506
3708
|
* **sr-Cyrl**: Serbian (Cyrillic, Serbia) \
|
|
3507
3709
|
* **sr-Latn**: Serbian (Latin, Serbia) \
|
|
3508
|
-
* **sk**: Slovak
|
|
3710
|
+
* **sk**: Slovak \
|
|
3711
|
+
* **unk**: Unknown. If the language is explicitly set to "unk", the language will be auto-detected.
|
|
3509
3712
|
*/
|
|
3510
3713
|
export declare type OcrSkillLanguage = string;
|
|
3511
3714
|
|
|
@@ -3687,6 +3890,16 @@ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
|
|
|
3687
3890
|
*/
|
|
3688
3891
|
export declare type PIIDetectionSkillMaskingMode = string;
|
|
3689
3892
|
|
|
3893
|
+
/** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
|
|
3894
|
+
export declare interface PrioritizedFields {
|
|
3895
|
+
/** Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. */
|
|
3896
|
+
titleField?: SemanticField;
|
|
3897
|
+
/** Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
|
|
3898
|
+
prioritizedContentFields?: SemanticField[];
|
|
3899
|
+
/** Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
|
|
3900
|
+
prioritizedKeywordsFields?: SemanticField[];
|
|
3901
|
+
}
|
|
3902
|
+
|
|
3690
3903
|
/**
|
|
3691
3904
|
* Defines values for QueryAnswerType. \
|
|
3692
3905
|
* {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
|
|
@@ -3713,7 +3926,77 @@ export declare type QueryCaptionType = string;
|
|
|
3713
3926
|
* this enum contains the known values that the service supports.
|
|
3714
3927
|
* ### Known values supported by the service
|
|
3715
3928
|
* **none**: Query language not specified. \
|
|
3716
|
-
* **en-us**: English
|
|
3929
|
+
* **en-us**: Query language value for English (United States). \
|
|
3930
|
+
* **en-gb**: Query language value for English (Great Britain). \
|
|
3931
|
+
* **en-in**: Query language value for English (India). \
|
|
3932
|
+
* **en-ca**: Query language value for English (Canada). \
|
|
3933
|
+
* **en-au**: Query language value for English (Australia). \
|
|
3934
|
+
* **fr-fr**: Query language value for French (France). \
|
|
3935
|
+
* **fr-ca**: Query language value for French (Canada). \
|
|
3936
|
+
* **de-de**: Query language value for German (Germany). \
|
|
3937
|
+
* **es-es**: Query language value for Spanish (Spain). \
|
|
3938
|
+
* **es-mx**: Query language value for Spanish (Mexico). \
|
|
3939
|
+
* **zh-cn**: Query language value for Chinese (China). \
|
|
3940
|
+
* **zh-tw**: Query language value for Chinese (Taiwan). \
|
|
3941
|
+
* **pt-br**: Query language value for Portuguese (Brazil). \
|
|
3942
|
+
* **pt-pt**: Query language value for Portuguese (Portugal). \
|
|
3943
|
+
* **it-it**: Query language value for Italian (Italy). \
|
|
3944
|
+
* **ja-jp**: Query language value for Japanese (Japan). \
|
|
3945
|
+
* **ko-kr**: Query language value for Korean (Korea). \
|
|
3946
|
+
* **ru-ru**: Query language value for Russian (Russia). \
|
|
3947
|
+
* **cs-cz**: Query language value for Czech (Czech Republic). \
|
|
3948
|
+
* **nl-be**: Query language value for Dutch (Belgium). \
|
|
3949
|
+
* **nl-nl**: Query language value for Dutch (Netherlands). \
|
|
3950
|
+
* **hu-hu**: Query language value for Hungarian (Hungary). \
|
|
3951
|
+
* **pl-pl**: Query language value for Polish (Poland). \
|
|
3952
|
+
* **sv-se**: Query language value for Swedish (Sweden). \
|
|
3953
|
+
* **tr-tr**: Query language value for Turkish (Turkey). \
|
|
3954
|
+
* **hi-in**: Query language value for Hindi (India). \
|
|
3955
|
+
* **ar-sa**: Query language value for Arabic (Saudi Arabia). \
|
|
3956
|
+
* **ar-eg**: Query language value for Arabic (Egypt). \
|
|
3957
|
+
* **ar-ma**: Query language value for Arabic (Morocco). \
|
|
3958
|
+
* **ar-kw**: Query language value for Arabic (Kuwait). \
|
|
3959
|
+
* **ar-jo**: Query language value for Arabic (Jordan). \
|
|
3960
|
+
* **da-dk**: Query language value for Danish (Denmark). \
|
|
3961
|
+
* **no-no**: Query language value for Norwegian (Norway). \
|
|
3962
|
+
* **bg-bg**: Query language value for Bulgarian (Bulgaria). \
|
|
3963
|
+
* **hr-hr**: Query language value for Croatian (Croatia). \
|
|
3964
|
+
* **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
|
|
3965
|
+
* **ms-my**: Query language value for Malay (Malaysia). \
|
|
3966
|
+
* **ms-bn**: Query language value for Malay (Brunei Darussalam). \
|
|
3967
|
+
* **sl-sl**: Query language value for Slovenian (Slovenia). \
|
|
3968
|
+
* **ta-in**: Query language value for Tamil (India). \
|
|
3969
|
+
* **vi-vn**: Query language value for Vietnamese (Viet Nam). \
|
|
3970
|
+
* **el-gr**: Query language value for Greek (Greece). \
|
|
3971
|
+
* **ro-ro**: Query language value for Romanian (Romania). \
|
|
3972
|
+
* **is-is**: Query language value for Icelandic (Iceland). \
|
|
3973
|
+
* **id-id**: Query language value for Indonesian (Indonesia). \
|
|
3974
|
+
* **th-th**: Query language value for Thai (Thailand). \
|
|
3975
|
+
* **lt-lt**: Query language value for Lithuanian (Lithuania). \
|
|
3976
|
+
* **uk-ua**: Query language value for Ukrainian (Ukraine). \
|
|
3977
|
+
* **lv-lv**: Query language value for Latvian (Latvia). \
|
|
3978
|
+
* **et-ee**: Query language value for Estonian (Estonia). \
|
|
3979
|
+
* **ca-es**: Query language value for Catalan (Spain). \
|
|
3980
|
+
* **fi-fi**: Query language value for Finnish (Finland). \
|
|
3981
|
+
* **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
|
|
3982
|
+
* **sr-me**: Query language value for Serbian (Montenegro). \
|
|
3983
|
+
* **sr-rs**: Query language value for Serbian (Serbia). \
|
|
3984
|
+
* **sk-sk**: Query language value for Slovak (Slovakia). \
|
|
3985
|
+
* **nb-no**: Query language value for Norwegian (Norway). \
|
|
3986
|
+
* **hy-am**: Query language value for Armenian (Armenia). \
|
|
3987
|
+
* **bn-in**: Query language value for Bengali (India). \
|
|
3988
|
+
* **eu-es**: Query language value for Basque (Spain). \
|
|
3989
|
+
* **gl-es**: Query language value for Galician (Spain). \
|
|
3990
|
+
* **gu-in**: Query language value for Gujarati (India). \
|
|
3991
|
+
* **he-il**: Query language value for Hebrew (Israel). \
|
|
3992
|
+
* **ga-ie**: Query language value for Irish (Ireland). \
|
|
3993
|
+
* **kn-in**: Query language value for Kannada (India). \
|
|
3994
|
+
* **ml-in**: Query language value for Malayalam (India). \
|
|
3995
|
+
* **mr-in**: Query language value for Marathi (India). \
|
|
3996
|
+
* **fa-ae**: Query language value for Persian (U.A.E.). \
|
|
3997
|
+
* **pa-in**: Query language value for Punjabi (India). \
|
|
3998
|
+
* **te-in**: Query language value for Telugu (India). \
|
|
3999
|
+
* **ur-pk**: Query language value for Urdu (Pakistan).
|
|
3717
4000
|
*/
|
|
3718
4001
|
export declare type QueryLanguage = string;
|
|
3719
4002
|
|
|
@@ -3749,7 +4032,7 @@ export declare type RegexFlags = string;
|
|
|
3749
4032
|
/**
|
|
3750
4033
|
* Options for reset docs operation.
|
|
3751
4034
|
*/
|
|
3752
|
-
export declare interface
|
|
4035
|
+
export declare interface ResetDocumentsOptions extends OperationOptions {
|
|
3753
4036
|
/** document keys to be reset */
|
|
3754
4037
|
documentKeys?: string[];
|
|
3755
4038
|
/** datasource document identifiers to be reset */
|
|
@@ -3766,7 +4049,10 @@ export declare type ResetIndexerOptions = OperationOptions;
|
|
|
3766
4049
|
/**
|
|
3767
4050
|
* Options for reset skills operation.
|
|
3768
4051
|
*/
|
|
3769
|
-
export declare
|
|
4052
|
+
export declare interface ResetSkillsOptions extends OperationOptions {
|
|
4053
|
+
/** the names of skills to be reset. */
|
|
4054
|
+
skillNames?: string[];
|
|
4055
|
+
}
|
|
3770
4056
|
|
|
3771
4057
|
/** Represents a resource's usage and quota. */
|
|
3772
4058
|
export declare interface ResourceCounter {
|
|
@@ -3819,14 +4105,29 @@ export declare interface ScoringProfile {
|
|
|
3819
4105
|
/** Defines values for ScoringStatistics. */
|
|
3820
4106
|
export declare type ScoringStatistics = "local" | "global";
|
|
3821
4107
|
|
|
4108
|
+
/** Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. */
|
|
4109
|
+
export declare interface SearchAlias {
|
|
4110
|
+
/** The name of the alias. */
|
|
4111
|
+
name: string;
|
|
4112
|
+
/** The name of the index this alias maps to. Only one index name may be specified. */
|
|
4113
|
+
indexes: string[];
|
|
4114
|
+
/** The ETag of the alias. */
|
|
4115
|
+
etag?: string;
|
|
4116
|
+
}
|
|
4117
|
+
|
|
3822
4118
|
/**
|
|
3823
4119
|
* Class used to perform operations against a search index,
|
|
3824
4120
|
* including querying documents in the index as well as
|
|
3825
4121
|
* adding, updating, and removing them.
|
|
3826
4122
|
*/
|
|
3827
4123
|
export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
4124
|
+
/**
|
|
4125
|
+
* The service version to use when communicating with the service.
|
|
4126
|
+
*/
|
|
4127
|
+
readonly serviceVersion: string;
|
|
3828
4128
|
/**
|
|
3829
4129
|
* The API version to use when communicating with the service.
|
|
4130
|
+
* @deprecated use {@Link serviceVersion} instead
|
|
3830
4131
|
*/
|
|
3831
4132
|
readonly apiVersion: string;
|
|
3832
4133
|
/**
|
|
@@ -3954,8 +4255,13 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
|
|
|
3954
4255
|
export declare interface SearchClientOptions extends CommonClientOptions {
|
|
3955
4256
|
/**
|
|
3956
4257
|
* The API version to use when communicating with the service.
|
|
4258
|
+
* @deprecated use {@Link serviceVersion} instead
|
|
3957
4259
|
*/
|
|
3958
4260
|
apiVersion?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
* The service version to use when communicating with the service.
|
|
4263
|
+
*/
|
|
4264
|
+
serviceVersion?: string;
|
|
3959
4265
|
}
|
|
3960
4266
|
|
|
3961
4267
|
/**
|
|
@@ -4103,12 +4409,21 @@ export declare interface SearchIndex {
|
|
|
4103
4409
|
* be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
|
|
4104
4410
|
*/
|
|
4105
4411
|
similarity?: SimilarityAlgorithm;
|
|
4412
|
+
/**
|
|
4413
|
+
* Defines parameters for a search index that influence semantic capabilities.
|
|
4414
|
+
*/
|
|
4415
|
+
semanticSettings?: SemanticSettings;
|
|
4106
4416
|
/**
|
|
4107
4417
|
* The ETag of the index.
|
|
4108
4418
|
*/
|
|
4109
4419
|
etag?: string;
|
|
4110
4420
|
}
|
|
4111
4421
|
|
|
4422
|
+
/**
|
|
4423
|
+
* Search Alias object.
|
|
4424
|
+
*/
|
|
4425
|
+
export declare type SearchIndexAlias = SearchAlias;
|
|
4426
|
+
|
|
4112
4427
|
/**
|
|
4113
4428
|
* Class to perform operations to manage
|
|
4114
4429
|
* (create, update, list/delete)
|
|
@@ -4118,6 +4433,11 @@ export declare class SearchIndexClient {
|
|
|
4118
4433
|
/**
|
|
4119
4434
|
* The API version to use when communicating with the service.
|
|
4120
4435
|
*/
|
|
4436
|
+
readonly serviceVersion: string;
|
|
4437
|
+
/**
|
|
4438
|
+
* The API version to use when communicating with the service.
|
|
4439
|
+
* @deprecated use {@Link serviceVersion} instead
|
|
4440
|
+
*/
|
|
4121
4441
|
readonly apiVersion: string;
|
|
4122
4442
|
/**
|
|
4123
4443
|
* The endpoint of the search service
|
|
@@ -4156,6 +4476,13 @@ export declare class SearchIndexClient {
|
|
|
4156
4476
|
* @param options - Options to the list index operation.
|
|
4157
4477
|
*/
|
|
4158
4478
|
listIndexes(options?: ListIndexesOptions): IndexIterator;
|
|
4479
|
+
private listAliasesPage;
|
|
4480
|
+
private listAliasesAll;
|
|
4481
|
+
/**
|
|
4482
|
+
* Lists all aliases available for a search service.
|
|
4483
|
+
* @param options - The options parameters.
|
|
4484
|
+
*/
|
|
4485
|
+
listAliases(options?: ListAliasesOptions): AliasIterator;
|
|
4159
4486
|
private listIndexesNamesPage;
|
|
4160
4487
|
private listIndexesNamesAll;
|
|
4161
4488
|
/**
|
|
@@ -4221,6 +4548,31 @@ export declare class SearchIndexClient {
|
|
|
4221
4548
|
* @param options - Additional optional arguments.
|
|
4222
4549
|
*/
|
|
4223
4550
|
deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>;
|
|
4551
|
+
/**
|
|
4552
|
+
* Creates a new search alias or updates an alias if it already exists.
|
|
4553
|
+
* @param alias - The definition of the alias to create or update.
|
|
4554
|
+
* @param options - The options parameters.
|
|
4555
|
+
*/
|
|
4556
|
+
createOrUpdateAlias(alias: SearchIndexAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchIndexAlias>;
|
|
4557
|
+
/**
|
|
4558
|
+
* Creates a new search alias.
|
|
4559
|
+
* @param alias - The definition of the alias to create.
|
|
4560
|
+
* @param options - The options parameters.
|
|
4561
|
+
*/
|
|
4562
|
+
createAlias(alias: SearchIndexAlias, options?: CreateAliasOptions): Promise<SearchIndexAlias>;
|
|
4563
|
+
/**
|
|
4564
|
+
* Deletes a search alias and its associated mapping to an index. This operation is permanent, with no
|
|
4565
|
+
* recovery option. The mapped index is untouched by this operation.
|
|
4566
|
+
* @param alias - Alias/Name name of the alias to delete.
|
|
4567
|
+
* @param options - The options parameters.
|
|
4568
|
+
*/
|
|
4569
|
+
deleteAlias(alias: string | SearchIndexAlias, options?: DeleteAliasOptions): Promise<void>;
|
|
4570
|
+
/**
|
|
4571
|
+
* Retrieves an alias definition.
|
|
4572
|
+
* @param aliasName - The name of the alias to retrieve.
|
|
4573
|
+
* @param options - The options parameters.
|
|
4574
|
+
*/
|
|
4575
|
+
getAlias(aliasName: string, options?: GetAliasOptions): Promise<SearchIndexAlias>;
|
|
4224
4576
|
/**
|
|
4225
4577
|
* Retrieves statistics about an index, such as the count of documents and the size
|
|
4226
4578
|
* of index storage.
|
|
@@ -4254,8 +4606,13 @@ export declare class SearchIndexClient {
|
|
|
4254
4606
|
export declare interface SearchIndexClientOptions extends CommonClientOptions {
|
|
4255
4607
|
/**
|
|
4256
4608
|
* The API version to use when communicating with the service.
|
|
4609
|
+
* @deprecated use {@Link serviceVersion} instead
|
|
4257
4610
|
*/
|
|
4258
4611
|
apiVersion?: string;
|
|
4612
|
+
/**
|
|
4613
|
+
* The service version to use when communicating with the service.
|
|
4614
|
+
*/
|
|
4615
|
+
serviceVersion?: string;
|
|
4259
4616
|
}
|
|
4260
4617
|
|
|
4261
4618
|
/**
|
|
@@ -4342,6 +4699,11 @@ export declare class SearchIndexerClient {
|
|
|
4342
4699
|
/**
|
|
4343
4700
|
* The API version to use when communicating with the service.
|
|
4344
4701
|
*/
|
|
4702
|
+
readonly serviceVersion: string;
|
|
4703
|
+
/**
|
|
4704
|
+
* The API version to use when communicating with the service.
|
|
4705
|
+
* @deprecated use {@Link serviceVersion} instead
|
|
4706
|
+
*/
|
|
4345
4707
|
readonly apiVersion: string;
|
|
4346
4708
|
/**
|
|
4347
4709
|
* The endpoint of the search service
|
|
@@ -4490,14 +4852,14 @@ export declare class SearchIndexerClient {
|
|
|
4490
4852
|
* @param indexerName - The name of the indexer to reset documents for.
|
|
4491
4853
|
* @param options - Additional optional arguments.
|
|
4492
4854
|
*/
|
|
4493
|
-
|
|
4855
|
+
resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
|
|
4494
4856
|
/**
|
|
4495
4857
|
* Reset an existing skillset in a search service.
|
|
4496
4858
|
* @param skillsetName - The name of the skillset to reset.
|
|
4497
4859
|
* @param skillNames - The names of skills to reset.
|
|
4498
4860
|
* @param options - The options parameters.
|
|
4499
4861
|
*/
|
|
4500
|
-
resetSkills(skillsetName: string,
|
|
4862
|
+
resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
|
|
4501
4863
|
}
|
|
4502
4864
|
|
|
4503
4865
|
/**
|
|
@@ -4506,8 +4868,13 @@ export declare class SearchIndexerClient {
|
|
|
4506
4868
|
export declare interface SearchIndexerClientOptions extends CommonClientOptions {
|
|
4507
4869
|
/**
|
|
4508
4870
|
* The API version to use when communicating with the service.
|
|
4871
|
+
* @deprecated use {@Link serviceVersion} instead
|
|
4509
4872
|
*/
|
|
4510
4873
|
apiVersion?: string;
|
|
4874
|
+
/**
|
|
4875
|
+
* The service version to use when communicating with the service.
|
|
4876
|
+
*/
|
|
4877
|
+
serviceVersion?: string;
|
|
4511
4878
|
}
|
|
4512
4879
|
|
|
4513
4880
|
/** Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. */
|
|
@@ -4713,7 +5080,7 @@ export declare interface SearchIndexerLimits {
|
|
|
4713
5080
|
/**
|
|
4714
5081
|
* Contains the possible cases for Skill.
|
|
4715
5082
|
*/
|
|
4716
|
-
export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill;
|
|
5083
|
+
export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill | AzureMachineLearningSkill;
|
|
4717
5084
|
|
|
4718
5085
|
/**
|
|
4719
5086
|
* A list of skills.
|
|
@@ -5148,6 +5515,11 @@ export declare interface SearchRequest {
|
|
|
5148
5515
|
* the results.
|
|
5149
5516
|
*/
|
|
5150
5517
|
scoringProfile?: string;
|
|
5518
|
+
/**
|
|
5519
|
+
* The name of a semantic configuration that will be used when processing documents for queries of
|
|
5520
|
+
* type semantic.
|
|
5521
|
+
*/
|
|
5522
|
+
semanticConfiguration?: string;
|
|
5151
5523
|
/**
|
|
5152
5524
|
* A full-text search query expression; Use "*" or omit this parameter to match all documents.
|
|
5153
5525
|
*/
|
|
@@ -5435,6 +5807,25 @@ export declare interface SearchSuggester {
|
|
|
5435
5807
|
sourceFields: string[];
|
|
5436
5808
|
}
|
|
5437
5809
|
|
|
5810
|
+
/** Defines a specific configuration to be used in the context of semantic capabilities. */
|
|
5811
|
+
export declare interface SemanticConfiguration {
|
|
5812
|
+
/** The name of the semantic configuration. */
|
|
5813
|
+
name: string;
|
|
5814
|
+
/** Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. */
|
|
5815
|
+
prioritizedFields: PrioritizedFields;
|
|
5816
|
+
}
|
|
5817
|
+
|
|
5818
|
+
/** A field that is used as part of the semantic configuration. */
|
|
5819
|
+
export declare interface SemanticField {
|
|
5820
|
+
name?: string;
|
|
5821
|
+
}
|
|
5822
|
+
|
|
5823
|
+
/** Defines parameters for a search index that influence semantic capabilities. */
|
|
5824
|
+
export declare interface SemanticSettings {
|
|
5825
|
+
/** The semantic configurations for the index. */
|
|
5826
|
+
configurations?: SemanticConfiguration[];
|
|
5827
|
+
}
|
|
5828
|
+
|
|
5438
5829
|
/** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
|
|
5439
5830
|
export declare type SentimentSkill = BaseSearchIndexerSkill & {
|
|
5440
5831
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -5480,6 +5871,8 @@ export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
|
|
|
5480
5871
|
|
|
5481
5872
|
/** Represents service-level resource counters and quotas. */
|
|
5482
5873
|
export declare interface ServiceCounters {
|
|
5874
|
+
/** Total number of aliases. */
|
|
5875
|
+
aliasCounter?: ResourceCounter;
|
|
5483
5876
|
/** Total number of documents across all indexes in the service. */
|
|
5484
5877
|
documentCounter: ResourceCounter;
|
|
5485
5878
|
/** Total number of indexes. */
|