@azure/search-documents 12.0.0-alpha.20231009.1 → 12.0.0-alpha.20231011.3

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.
@@ -1106,6 +1106,13 @@ export const SearchIndexerSkillset = {
1106
1106
  className: "SearchIndexerKnowledgeStore"
1107
1107
  }
1108
1108
  },
1109
+ indexProjections: {
1110
+ serializedName: "indexProjections",
1111
+ type: {
1112
+ name: "Composite",
1113
+ className: "SearchIndexerIndexProjections"
1114
+ }
1115
+ },
1109
1116
  etag: {
1110
1117
  serializedName: "@odata\\.etag",
1111
1118
  type: {
@@ -1303,6 +1310,13 @@ export const SearchIndexerKnowledgeStore = {
1303
1310
  name: "Composite",
1304
1311
  className: "SearchIndexerDataIdentity"
1305
1312
  }
1313
+ },
1314
+ parameters: {
1315
+ serializedName: "parameters",
1316
+ type: {
1317
+ name: "Composite",
1318
+ className: "SearchIndexerKnowledgeStoreParameters"
1319
+ }
1306
1320
  }
1307
1321
  }
1308
1322
  }
@@ -1395,6 +1409,107 @@ export const SearchIndexerKnowledgeStoreProjectionSelector = {
1395
1409
  }
1396
1410
  }
1397
1411
  };
1412
+ export const SearchIndexerKnowledgeStoreParameters = {
1413
+ type: {
1414
+ name: "Composite",
1415
+ className: "SearchIndexerKnowledgeStoreParameters",
1416
+ additionalProperties: { type: { name: "Object" } },
1417
+ modelProperties: {
1418
+ synthesizeGeneratedKeyName: {
1419
+ defaultValue: false,
1420
+ serializedName: "synthesizeGeneratedKeyName",
1421
+ type: {
1422
+ name: "Boolean"
1423
+ }
1424
+ }
1425
+ }
1426
+ }
1427
+ };
1428
+ export const SearchIndexerIndexProjections = {
1429
+ type: {
1430
+ name: "Composite",
1431
+ className: "SearchIndexerIndexProjections",
1432
+ modelProperties: {
1433
+ selectors: {
1434
+ serializedName: "selectors",
1435
+ required: true,
1436
+ type: {
1437
+ name: "Sequence",
1438
+ element: {
1439
+ type: {
1440
+ name: "Composite",
1441
+ className: "SearchIndexerIndexProjectionSelector"
1442
+ }
1443
+ }
1444
+ }
1445
+ },
1446
+ parameters: {
1447
+ serializedName: "parameters",
1448
+ type: {
1449
+ name: "Composite",
1450
+ className: "SearchIndexerIndexProjectionsParameters"
1451
+ }
1452
+ }
1453
+ }
1454
+ }
1455
+ };
1456
+ export const SearchIndexerIndexProjectionSelector = {
1457
+ type: {
1458
+ name: "Composite",
1459
+ className: "SearchIndexerIndexProjectionSelector",
1460
+ modelProperties: {
1461
+ targetIndexName: {
1462
+ serializedName: "targetIndexName",
1463
+ required: true,
1464
+ type: {
1465
+ name: "String"
1466
+ }
1467
+ },
1468
+ parentKeyFieldName: {
1469
+ serializedName: "parentKeyFieldName",
1470
+ required: true,
1471
+ type: {
1472
+ name: "String"
1473
+ }
1474
+ },
1475
+ sourceContext: {
1476
+ serializedName: "sourceContext",
1477
+ required: true,
1478
+ type: {
1479
+ name: "String"
1480
+ }
1481
+ },
1482
+ mappings: {
1483
+ serializedName: "mappings",
1484
+ required: true,
1485
+ type: {
1486
+ name: "Sequence",
1487
+ element: {
1488
+ type: {
1489
+ name: "Composite",
1490
+ className: "InputFieldMappingEntry"
1491
+ }
1492
+ }
1493
+ }
1494
+ }
1495
+ }
1496
+ }
1497
+ };
1498
+ export const SearchIndexerIndexProjectionsParameters = {
1499
+ type: {
1500
+ name: "Composite",
1501
+ className: "SearchIndexerIndexProjectionsParameters",
1502
+ additionalProperties: { type: { name: "Object" } },
1503
+ modelProperties: {
1504
+ projectionMode: {
1505
+ serializedName: "projectionMode",
1506
+ type: {
1507
+ name: "String"
1508
+ }
1509
+ }
1510
+ }
1511
+ }
1512
+ };
1398
1513
  export const ListSkillsetsResult = {
1399
1514
  type: {
1400
1515
  name: "Composite",
@@ -1754,8 +1869,8 @@ export const SearchField = {
1754
1869
  name: "Number"
1755
1870
  }
1756
1871
  },
1757
- vectorSearchConfiguration: {
1758
- serializedName: "vectorSearchConfiguration",
1872
+ vectorSearchProfile: {
1873
+ serializedName: "vectorSearchProfile",
1759
1874
  nullable: true,
1760
1875
  type: {
1761
1876
  name: "String"
@@ -2214,8 +2329,20 @@ export const VectorSearch = {
2214
2329
  name: "Composite",
2215
2330
  className: "VectorSearch",
2216
2331
  modelProperties: {
2217
- algorithmConfigurations: {
2218
- serializedName: "algorithmConfigurations",
2332
+ profiles: {
2333
+ serializedName: "profiles",
2334
+ type: {
2335
+ name: "Sequence",
2336
+ element: {
2337
+ type: {
2338
+ name: "Composite",
2339
+ className: "VectorSearchProfile"
2340
+ }
2341
+ }
2342
+ }
2343
+ },
2344
+ algorithms: {
2345
+ serializedName: "algorithms",
2219
2346
  type: {
2220
2347
  name: "Sequence",
2221
2348
  element: {
@@ -2225,6 +2352,46 @@ export const VectorSearch = {
2225
2352
  }
2226
2353
  }
2227
2354
  }
2355
+ },
2356
+ vectorizers: {
2357
+ serializedName: "vectorizers",
2358
+ type: {
2359
+ name: "Sequence",
2360
+ element: {
2361
+ type: {
2362
+ name: "Composite",
2363
+ className: "VectorSearchVectorizer"
2364
+ }
2365
+ }
2366
+ }
2367
+ }
2368
+ }
2369
+ }
2370
+ };
2371
+ export const VectorSearchProfile = {
2372
+ type: {
2373
+ name: "Composite",
2374
+ className: "VectorSearchProfile",
2375
+ modelProperties: {
2376
+ name: {
2377
+ serializedName: "name",
2378
+ required: true,
2379
+ type: {
2380
+ name: "String"
2381
+ }
2382
+ },
2383
+ algorithm: {
2384
+ serializedName: "algorithm",
2385
+ required: true,
2386
+ type: {
2387
+ name: "String"
2388
+ }
2389
+ },
2390
+ vectorizer: {
2391
+ serializedName: "vectorizer",
2392
+ type: {
2393
+ name: "String"
2394
+ }
2228
2395
  }
2229
2396
  }
2230
2397
  }
@@ -2256,6 +2423,33 @@ export const VectorSearchAlgorithmConfiguration = {
2256
2423
  }
2257
2424
  }
2258
2425
  };
2426
+ export const VectorSearchVectorizer = {
2427
+ type: {
2428
+ name: "Composite",
2429
+ className: "VectorSearchVectorizer",
2430
+ uberParent: "VectorSearchVectorizer",
2431
+ polymorphicDiscriminator: {
2432
+ serializedName: "kind",
2433
+ clientName: "kind"
2434
+ },
2435
+ modelProperties: {
2436
+ name: {
2437
+ serializedName: "name",
2438
+ required: true,
2439
+ type: {
2440
+ name: "String"
2441
+ }
2442
+ },
2443
+ kind: {
2444
+ serializedName: "kind",
2445
+ required: true,
2446
+ type: {
2447
+ name: "String"
2448
+ }
2449
+ }
2450
+ }
2451
+ }
2452
+ };
2259
2453
  export const ListIndexesResult = {
2260
2454
  type: {
2261
2455
  name: "Composite",
@@ -2301,6 +2495,7 @@ export const GetIndexStatisticsResult = {
2301
2495
  },
2302
2496
  vectorIndexSize: {
2303
2497
  serializedName: "vectorIndexSize",
2498
+ required: true,
2304
2499
  readOnly: true,
2305
2500
  type: {
2306
2501
  name: "Number"
@@ -2682,6 +2877,101 @@ export const HnswParameters = {
2682
2877
  }
2683
2878
  }
2684
2879
  };
2880
+ export const ExhaustiveKnnParameters = {
2881
+ type: {
2882
+ name: "Composite",
2883
+ className: "ExhaustiveKnnParameters",
2884
+ modelProperties: {
2885
+ metric: {
2886
+ serializedName: "metric",
2887
+ nullable: true,
2888
+ type: {
2889
+ name: "String"
2890
+ }
2891
+ }
2892
+ }
2893
+ }
2894
+ };
2895
+ export const AzureOpenAIParameters = {
2896
+ type: {
2897
+ name: "Composite",
2898
+ className: "AzureOpenAIParameters",
2899
+ modelProperties: {
2900
+ resourceUri: {
2901
+ serializedName: "resourceUri",
2902
+ type: {
2903
+ name: "String"
2904
+ }
2905
+ },
2906
+ deploymentId: {
2907
+ serializedName: "deploymentId",
2908
+ type: {
2909
+ name: "String"
2910
+ }
2911
+ },
2912
+ apiKey: {
2913
+ serializedName: "apiKey",
2914
+ type: {
2915
+ name: "String"
2916
+ }
2917
+ },
2918
+ authIdentity: {
2919
+ serializedName: "authIdentity",
2920
+ type: {
2921
+ name: "Composite",
2922
+ className: "SearchIndexerDataIdentity"
2923
+ }
2924
+ }
2925
+ }
2926
+ }
2927
+ };
2928
+ export const CustomVectorizerParameters = {
2929
+ type: {
2930
+ name: "Composite",
2931
+ className: "CustomVectorizerParameters",
2932
+ modelProperties: {
2933
+ uri: {
2934
+ serializedName: "uri",
2935
+ type: {
2936
+ name: "String"
2937
+ }
2938
+ },
2939
+ httpHeaders: {
2940
+ serializedName: "httpHeaders",
2941
+ type: {
2942
+ name: "Dictionary",
2943
+ value: { type: { name: "String" } }
2944
+ }
2945
+ },
2946
+ httpMethod: {
2947
+ serializedName: "httpMethod",
2948
+ type: {
2949
+ name: "String"
2950
+ }
2951
+ },
2952
+ timeout: {
2953
+ serializedName: "timeout",
2954
+ type: {
2955
+ name: "TimeSpan"
2956
+ }
2957
+ },
2958
+ authResourceId: {
2959
+ serializedName: "authResourceId",
2960
+ nullable: true,
2961
+ type: {
2962
+ name: "String"
2963
+ }
2964
+ },
2965
+ authIdentity: {
2966
+ serializedName: "authIdentity",
2967
+ type: {
2968
+ name: "Composite",
2969
+ className: "SearchIndexerDataIdentity"
2970
+ }
2971
+ }
2972
+ }
2973
+ }
2974
+ };
2685
2975
  export const DistanceScoringParameters = {
2686
2976
  type: {
2687
2977
  name: "Composite",
@@ -2968,6 +3258,16 @@ export const SoftDeleteColumnDeletionDetectionPolicy = {
2968
3258
  } })
2969
3259
  }
2970
3260
  };
3261
+ export const NativeBlobSoftDeleteDeletionDetectionPolicy = {
3262
+ serializedName: "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy",
3263
+ type: {
3264
+ name: "Composite",
3265
+ className: "NativeBlobSoftDeleteDeletionDetectionPolicy",
3266
+ uberParent: "DataDeletionDetectionPolicy",
3267
+ polymorphicDiscriminator: DataDeletionDetectionPolicy.type.polymorphicDiscriminator,
3268
+ modelProperties: Object.assign({}, DataDeletionDetectionPolicy.type.modelProperties)
3269
+ }
3270
+ };
2971
3271
  export const ConditionalSkill = {
2972
3272
  serializedName: "#Microsoft.Skills.Util.ConditionalSkill",
2973
3273
  type: {
@@ -3359,6 +3659,18 @@ export const SplitSkill = {
3359
3659
  type: {
3360
3660
  name: "Number"
3361
3661
  }
3662
+ }, pageOverlapLength: {
3663
+ serializedName: "pageOverlapLength",
3664
+ nullable: true,
3665
+ type: {
3666
+ name: "Number"
3667
+ }
3668
+ }, maximumPagesToTake: {
3669
+ serializedName: "maximumPagesToTake",
3670
+ nullable: true,
3671
+ type: {
3672
+ name: "Number"
3673
+ }
3362
3674
  } })
3363
3675
  }
3364
3676
  };
@@ -3572,6 +3884,37 @@ export const AzureMachineLearningSkill = {
3572
3884
  } })
3573
3885
  }
3574
3886
  };
3887
+ export const AzureOpenAIEmbeddingSkill = {
3888
+ serializedName: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill",
3889
+ type: {
3890
+ name: "Composite",
3891
+ className: "AzureOpenAIEmbeddingSkill",
3892
+ uberParent: "SearchIndexerSkill",
3893
+ polymorphicDiscriminator: SearchIndexerSkill.type.polymorphicDiscriminator,
3894
+ modelProperties: Object.assign(Object.assign({}, SearchIndexerSkill.type.modelProperties), { resourceUri: {
3895
+ serializedName: "resourceUri",
3896
+ type: {
3897
+ name: "String"
3898
+ }
3899
+ }, deploymentId: {
3900
+ serializedName: "deploymentId",
3901
+ type: {
3902
+ name: "String"
3903
+ }
3904
+ }, apiKey: {
3905
+ serializedName: "apiKey",
3906
+ type: {
3907
+ name: "String"
3908
+ }
3909
+ }, authIdentity: {
3910
+ serializedName: "authIdentity",
3911
+ type: {
3912
+ name: "Composite",
3913
+ className: "SearchIndexerDataIdentity"
3914
+ }
3915
+ } })
3916
+ }
3917
+ };
3575
3918
  export const DefaultCognitiveServicesAccount = {
3576
3919
  serializedName: "#Microsoft.Azure.Search.DefaultCognitiveServices",
3577
3920
  type: {
@@ -5196,6 +5539,54 @@ export const HnswVectorSearchAlgorithmConfiguration = {
5196
5539
  } })
5197
5540
  }
5198
5541
  };
5542
+ export const ExhaustiveKnnVectorSearchAlgorithmConfiguration = {
5543
+ serializedName: "exhaustiveKnn",
5544
+ type: {
5545
+ name: "Composite",
5546
+ className: "ExhaustiveKnnVectorSearchAlgorithmConfiguration",
5547
+ uberParent: "VectorSearchAlgorithmConfiguration",
5548
+ polymorphicDiscriminator: VectorSearchAlgorithmConfiguration.type.polymorphicDiscriminator,
5549
+ modelProperties: Object.assign(Object.assign({}, VectorSearchAlgorithmConfiguration.type.modelProperties), { parameters: {
5550
+ serializedName: "exhaustiveKnnParameters",
5551
+ type: {
5552
+ name: "Composite",
5553
+ className: "ExhaustiveKnnParameters"
5554
+ }
5555
+ } })
5556
+ }
5557
+ };
5558
+ export const AzureOpenAIVectorizer = {
5559
+ serializedName: "azureOpenAI",
5560
+ type: {
5561
+ name: "Composite",
5562
+ className: "AzureOpenAIVectorizer",
5563
+ uberParent: "VectorSearchVectorizer",
5564
+ polymorphicDiscriminator: VectorSearchVectorizer.type.polymorphicDiscriminator,
5565
+ modelProperties: Object.assign(Object.assign({}, VectorSearchVectorizer.type.modelProperties), { azureOpenAIParameters: {
5566
+ serializedName: "azureOpenAIParameters",
5567
+ type: {
5568
+ name: "Composite",
5569
+ className: "AzureOpenAIParameters"
5570
+ }
5571
+ } })
5572
+ }
5573
+ };
5574
+ export const CustomVectorizer = {
5575
+ serializedName: "customWebApi",
5576
+ type: {
5577
+ name: "Composite",
5578
+ className: "CustomVectorizer",
5579
+ uberParent: "VectorSearchVectorizer",
5580
+ polymorphicDiscriminator: VectorSearchVectorizer.type.polymorphicDiscriminator,
5581
+ modelProperties: Object.assign(Object.assign({}, VectorSearchVectorizer.type.modelProperties), { customVectorizerParameters: {
5582
+ serializedName: "customVectorizerParameters",
5583
+ type: {
5584
+ name: "Composite",
5585
+ className: "CustomVectorizerParameters"
5586
+ }
5587
+ } })
5588
+ }
5589
+ };
5199
5590
  export const SearchIndexerKnowledgeStoreObjectProjectionSelector = {
5200
5591
  type: {
5201
5592
  name: "Composite",
@@ -5224,11 +5615,13 @@ export let discriminators = {
5224
5615
  LexicalNormalizer: LexicalNormalizer,
5225
5616
  Similarity: Similarity,
5226
5617
  VectorSearchAlgorithmConfiguration: VectorSearchAlgorithmConfiguration,
5618
+ VectorSearchVectorizer: VectorSearchVectorizer,
5227
5619
  "SearchIndexerDataIdentity.#Microsoft.Azure.Search.DataNoneIdentity": SearchIndexerDataNoneIdentity,
5228
5620
  "SearchIndexerDataIdentity.#Microsoft.Azure.Search.DataUserAssignedIdentity": SearchIndexerDataUserAssignedIdentity,
5229
5621
  "DataChangeDetectionPolicy.#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy": HighWaterMarkChangeDetectionPolicy,
5230
5622
  "DataChangeDetectionPolicy.#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy": SqlIntegratedChangeTrackingPolicy,
5231
5623
  "DataDeletionDetectionPolicy.#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy": SoftDeleteColumnDeletionDetectionPolicy,
5624
+ "DataDeletionDetectionPolicy.#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy": NativeBlobSoftDeleteDeletionDetectionPolicy,
5232
5625
  "SearchIndexerSkill.#Microsoft.Skills.Util.ConditionalSkill": ConditionalSkill,
5233
5626
  "SearchIndexerSkill.#Microsoft.Skills.Text.KeyPhraseExtractionSkill": KeyPhraseExtractionSkill,
5234
5627
  "SearchIndexerSkill.#Microsoft.Skills.Vision.OcrSkill": OcrSkill,
@@ -5248,6 +5641,7 @@ export let discriminators = {
5248
5641
  "SearchIndexerSkill.#Microsoft.Skills.Util.DocumentExtractionSkill": DocumentExtractionSkill,
5249
5642
  "SearchIndexerSkill.#Microsoft.Skills.Custom.WebApiSkill": WebApiSkill,
5250
5643
  "SearchIndexerSkill.#Microsoft.Skills.Custom.AmlSkill": AzureMachineLearningSkill,
5644
+ "SearchIndexerSkill.#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill": AzureOpenAIEmbeddingSkill,
5251
5645
  "CognitiveServicesAccount.#Microsoft.Azure.Search.DefaultCognitiveServices": DefaultCognitiveServicesAccount,
5252
5646
  "CognitiveServicesAccount.#Microsoft.Azure.Search.CognitiveServicesByKey": CognitiveServicesAccountKey,
5253
5647
  "ScoringFunction.distance": DistanceScoringFunction,
@@ -5300,6 +5694,9 @@ export let discriminators = {
5300
5694
  "LexicalNormalizer.#Microsoft.Azure.Search.CustomNormalizer": CustomNormalizer,
5301
5695
  "Similarity.#Microsoft.Azure.Search.ClassicSimilarity": ClassicSimilarity,
5302
5696
  "Similarity.#Microsoft.Azure.Search.BM25Similarity": BM25Similarity,
5303
- "VectorSearchAlgorithmConfiguration.hnsw": HnswVectorSearchAlgorithmConfiguration
5697
+ "VectorSearchAlgorithmConfiguration.hnsw": HnswVectorSearchAlgorithmConfiguration,
5698
+ "VectorSearchAlgorithmConfiguration.exhaustiveKnn": ExhaustiveKnnVectorSearchAlgorithmConfiguration,
5699
+ "VectorSearchVectorizer.azureOpenAI": AzureOpenAIVectorizer,
5700
+ "VectorSearchVectorizer.customWebApi": CustomVectorizer
5304
5701
  };
5305
5702
  //# sourceMappingURL=mappers.js.map