@azure/search-documents 11.3.0-alpha.20211104.2 → 11.3.0-alpha.20211119.2

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 CHANGED
@@ -1,7 +1,26 @@
1
1
  # Release History
2
2
 
3
+ ## 11.3.0-beta.6 (Unreleased)
4
+
5
+ ### Features Added
6
+
7
+ ### Breaking Changes
8
+
9
+ ### Bugs Fixed
10
+
11
+ ### Other Changes
12
+
13
+ - Deprecated `SearchClientOptions.apiVersion` in favor of `SearchClientOptions.serviceVersion`.
14
+ - `apiVersion` will continue to be supported in version 11.x; however, customers are encouraged to migrate to `serviceVersion` instead which is more consistent with the rest of our client libraries.
15
+
3
16
  ## 11.3.0-beta.5 (2021-11-09)
4
17
 
18
+ ### Features Added
19
+
20
+ - Added `semanticConfiguration` property to `SearchRequest` object.
21
+ - Several new languages are added to the `KnownQueryLanguage` object.
22
+ - Added `semanticSettings` property to `SearchIndex` object.
23
+
5
24
  ### Breaking Changes
6
25
 
7
26
  - Renamed `IndexerCurrentState` property to `IndexerState` property.
@@ -12,6 +31,12 @@
12
31
  - Renamed `SkillNames` property to `ResetSkillsOptions` (with a `SkillNames` property)
13
32
  - Renamed `ResetDocs` method to `ResetDocuments` in the SDK client.
14
33
 
34
+ ### Bugs Fixed
35
+
36
+ - Fixed the issue with the presence of recursive structure while uploading documents. Please refer [#15656](https://github.com/Azure/azure-sdk-for-js/issues/15656) for further details.
37
+
38
+ ## 11.3.0-beta.4 (2021-10-05)
39
+
15
40
  ### Features Added
16
41
 
17
42
  - Added properties `currentState` & `statusDetail` to the `IndexerExecutionResult` object.
package/dist/index.js CHANGED
@@ -286,6 +286,12 @@ const SearchRequest = {
286
286
  name: "String"
287
287
  }
288
288
  },
289
+ semanticConfiguration: {
290
+ serializedName: "semanticConfiguration",
291
+ type: {
292
+ name: "String"
293
+ }
294
+ },
289
295
  searchText: {
290
296
  serializedName: "search",
291
297
  type: {
@@ -987,6 +993,15 @@ const scoringProfile = {
987
993
  }
988
994
  }
989
995
  };
996
+ const semanticConfiguration = {
997
+ parameterPath: ["options", "searchOptions", "semanticConfiguration"],
998
+ mapper: {
999
+ serializedName: "semanticConfiguration",
1000
+ type: {
1001
+ name: "String"
1002
+ }
1003
+ }
1004
+ };
990
1005
  const searchFields = {
991
1006
  parameterPath: ["options", "searchOptions", "searchFields"],
992
1007
  mapper: {
@@ -1501,6 +1516,7 @@ const searchGetOperationSpec = {
1501
1516
  queryType,
1502
1517
  scoringParameters,
1503
1518
  scoringProfile,
1519
+ semanticConfiguration,
1504
1520
  searchFields,
1505
1521
  queryLanguage,
1506
1522
  speller,
@@ -1718,7 +1734,7 @@ class SearchClientContext extends coreClient.ServiceClient {
1718
1734
  const defaults = {
1719
1735
  requestContentType: "application/json; charset=utf-8"
1720
1736
  };
1721
- const packageDetails = `azsdk-js-search-documents/11.3.0-beta.4`;
1737
+ const packageDetails = `azsdk-js-search-documents/11.3.0-beta.5`;
1722
1738
  const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
1723
1739
  ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
1724
1740
  : `${packageDetails}`;
@@ -1852,7 +1868,7 @@ function walk(start, mapper) {
1852
1868
  const current = queue.shift();
1853
1869
  if (typeof current.value === "object" && current.value !== null) {
1854
1870
  if (seenMarker.has(current.value)) {
1855
- throw new Error("Cannot map a recusive structure.");
1871
+ continue;
1856
1872
  }
1857
1873
  else {
1858
1874
  seenMarker.set(current.value, true);
@@ -3015,7 +3031,8 @@ function generatedIndexToPublicIndex(generatedIndex) {
3015
3031
  normalizers: generatedIndex.normalizers,
3016
3032
  scoringProfiles: generatedIndex.scoringProfiles,
3017
3033
  fields: convertFieldsToPublic(generatedIndex.fields),
3018
- similarity: convertSimilarityToPublic(generatedIndex.similarity)
3034
+ similarity: convertSimilarityToPublic(generatedIndex.similarity),
3035
+ semanticSettings: generatedIndex.semanticSettings
3019
3036
  };
3020
3037
  }
3021
3038
  function generatedSearchResultToPublicSearchResult(results) {
@@ -3064,7 +3081,8 @@ function publicIndexToGeneratedIndex(index) {
3064
3081
  analyzers: convertAnalyzersToGenerated(index.analyzers),
3065
3082
  tokenizers: convertTokenizersToGenerated(index.tokenizers),
3066
3083
  fields: convertFieldsToGenerated(index.fields),
3067
- similarity: convertSimilarityToGenerated(index.similarity)
3084
+ similarity: convertSimilarityToGenerated(index.similarity),
3085
+ semanticSettings: index.semanticSettings
3068
3086
  };
3069
3087
  }
3070
3088
  function generatedSkillsetToPublicSkillset(generatedSkillset) {
@@ -3225,9 +3243,9 @@ class SearchClient$1 {
3225
3243
  /// Maintenance note: when updating supported API versions,
3226
3244
  /// the ContinuationToken logic will need to be updated below.
3227
3245
  /**
3228
- * The API version to use when communicating with the service.
3246
+ * The service version to use when communicating with the service.
3229
3247
  */
3230
- this.apiVersion = "2020-06-30-Preview";
3248
+ this.serviceVersion = "2020-06-30-Preview";
3231
3249
  this.endpoint = endpoint;
3232
3250
  this.indexName = indexName;
3233
3251
  const libInfo = `azsdk-js-search-documents/${SDK_VERSION}`;
@@ -3253,14 +3271,19 @@ class SearchClient$1 {
3253
3271
  ]
3254
3272
  }
3255
3273
  });
3256
- let apiVersion = this.apiVersion;
3257
3274
  if (options.apiVersion) {
3258
3275
  if (!["2020-06-30", "2021-04-30-Preview"].includes(options.apiVersion)) {
3259
3276
  throw new Error(`Invalid Api Version: ${options.apiVersion}`);
3260
3277
  }
3261
- apiVersion = options.apiVersion;
3278
+ this.serviceVersion = options.apiVersion;
3279
+ }
3280
+ if (options.serviceVersion) {
3281
+ if (!["2020-06-30", "2021-04-30-Preview"].includes(options.serviceVersion)) {
3282
+ throw new Error(`Invalid Service Version: ${options.serviceVersion}`);
3283
+ }
3284
+ this.serviceVersion = options.serviceVersion;
3262
3285
  }
3263
- this.client = new SearchClient(this.endpoint, this.indexName, apiVersion, internalClientPipelineOptions);
3286
+ this.client = new SearchClient(this.endpoint, this.indexName, this.serviceVersion, internalClientPipelineOptions);
3264
3287
  if (coreAuth.isTokenCredential(credential)) {
3265
3288
  this.client.pipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({ credential, scopes: DEFAULT_SEARCH_SCOPE }));
3266
3289
  }
@@ -3269,6 +3292,13 @@ class SearchClient$1 {
3269
3292
  }
3270
3293
  this.client.pipeline.addPolicy(createOdataMetadataPolicy("none"));
3271
3294
  }
3295
+ /**
3296
+ * The API version to use when communicating with the service.
3297
+ * @deprecated use {@Link serviceVersion} instead
3298
+ */
3299
+ get apiVersion() {
3300
+ return this.serviceVersion;
3301
+ }
3272
3302
  /**
3273
3303
  * Retrieves the number of documents in the index.
3274
3304
  * @param options - Options to the count operation.
@@ -5594,6 +5624,13 @@ const SearchIndex = {
5594
5624
  className: "Similarity"
5595
5625
  }
5596
5626
  },
5627
+ semanticSettings: {
5628
+ serializedName: "semantic",
5629
+ type: {
5630
+ name: "Composite",
5631
+ className: "SemanticSettings"
5632
+ }
5633
+ },
5597
5634
  etag: {
5598
5635
  serializedName: "@odata\\.etag",
5599
5636
  type: {
@@ -6033,6 +6070,101 @@ const Similarity = {
6033
6070
  }
6034
6071
  }
6035
6072
  };
6073
+ const SemanticSettings = {
6074
+ type: {
6075
+ name: "Composite",
6076
+ className: "SemanticSettings",
6077
+ modelProperties: {
6078
+ configurations: {
6079
+ serializedName: "configurations",
6080
+ type: {
6081
+ name: "Sequence",
6082
+ element: {
6083
+ type: {
6084
+ name: "Composite",
6085
+ className: "SemanticConfiguration"
6086
+ }
6087
+ }
6088
+ }
6089
+ }
6090
+ }
6091
+ }
6092
+ };
6093
+ const SemanticConfiguration = {
6094
+ type: {
6095
+ name: "Composite",
6096
+ className: "SemanticConfiguration",
6097
+ modelProperties: {
6098
+ name: {
6099
+ serializedName: "name",
6100
+ required: true,
6101
+ type: {
6102
+ name: "String"
6103
+ }
6104
+ },
6105
+ prioritizedFields: {
6106
+ serializedName: "prioritizedFields",
6107
+ type: {
6108
+ name: "Composite",
6109
+ className: "PrioritizedFields"
6110
+ }
6111
+ }
6112
+ }
6113
+ }
6114
+ };
6115
+ const PrioritizedFields = {
6116
+ type: {
6117
+ name: "Composite",
6118
+ className: "PrioritizedFields",
6119
+ modelProperties: {
6120
+ titleField: {
6121
+ serializedName: "titleField",
6122
+ type: {
6123
+ name: "Composite",
6124
+ className: "SemanticField"
6125
+ }
6126
+ },
6127
+ prioritizedContentFields: {
6128
+ serializedName: "prioritizedContentFields",
6129
+ type: {
6130
+ name: "Sequence",
6131
+ element: {
6132
+ type: {
6133
+ name: "Composite",
6134
+ className: "SemanticField"
6135
+ }
6136
+ }
6137
+ }
6138
+ },
6139
+ prioritizedKeywordsFields: {
6140
+ serializedName: "prioritizedKeywordsFields",
6141
+ type: {
6142
+ name: "Sequence",
6143
+ element: {
6144
+ type: {
6145
+ name: "Composite",
6146
+ className: "SemanticField"
6147
+ }
6148
+ }
6149
+ }
6150
+ }
6151
+ }
6152
+ }
6153
+ };
6154
+ const SemanticField = {
6155
+ type: {
6156
+ name: "Composite",
6157
+ className: "SemanticField",
6158
+ modelProperties: {
6159
+ name: {
6160
+ serializedName: "fieldName",
6161
+ type: {
6162
+ name: "String"
6163
+ }
6164
+ }
6165
+ }
6166
+ }
6167
+ };
6036
6168
  const ListIndexesResult = {
6037
6169
  type: {
6038
6170
  name: "Composite",
@@ -8930,6 +9062,10 @@ var Mappers$1 = /*#__PURE__*/Object.freeze({
8930
9062
  CharFilter: CharFilter,
8931
9063
  LexicalNormalizer: LexicalNormalizer,
8932
9064
  Similarity: Similarity,
9065
+ SemanticSettings: SemanticSettings,
9066
+ SemanticConfiguration: SemanticConfiguration,
9067
+ PrioritizedFields: PrioritizedFields,
9068
+ SemanticField: SemanticField,
8933
9069
  ListIndexesResult: ListIndexesResult,
8934
9070
  GetIndexStatisticsResult: GetIndexStatisticsResult,
8935
9071
  AnalyzeRequest: AnalyzeRequest,
@@ -11482,8 +11618,148 @@ var KnownApiVersion20210430Preview;
11482
11618
  (function (KnownQueryLanguage) {
11483
11619
  /** Query language not specified. */
11484
11620
  KnownQueryLanguage["None"] = "none";
11485
- /** English */
11621
+ /** Query language value for English (United States). */
11486
11622
  KnownQueryLanguage["EnUs"] = "en-us";
11623
+ /** Query language value for English (Great Britain). */
11624
+ KnownQueryLanguage["EnGb"] = "en-gb";
11625
+ /** Query language value for English (India). */
11626
+ KnownQueryLanguage["EnIn"] = "en-in";
11627
+ /** Query language value for English (Canada). */
11628
+ KnownQueryLanguage["EnCa"] = "en-ca";
11629
+ /** Query language value for English (Australia). */
11630
+ KnownQueryLanguage["EnAu"] = "en-au";
11631
+ /** Query language value for French (France). */
11632
+ KnownQueryLanguage["FrFr"] = "fr-fr";
11633
+ /** Query language value for French (Canada). */
11634
+ KnownQueryLanguage["FrCa"] = "fr-ca";
11635
+ /** Query language value for German (Germany). */
11636
+ KnownQueryLanguage["DeDe"] = "de-de";
11637
+ /** Query language value for Spanish (Spain). */
11638
+ KnownQueryLanguage["EsEs"] = "es-es";
11639
+ /** Query language value for Spanish (Mexico). */
11640
+ KnownQueryLanguage["EsMx"] = "es-mx";
11641
+ /** Query language value for Chinese (China). */
11642
+ KnownQueryLanguage["ZhCn"] = "zh-cn";
11643
+ /** Query language value for Chinese (Taiwan). */
11644
+ KnownQueryLanguage["ZhTw"] = "zh-tw";
11645
+ /** Query language value for Portuguese (Brazil). */
11646
+ KnownQueryLanguage["PtBr"] = "pt-br";
11647
+ /** Query language value for Portuguese (Portugal). */
11648
+ KnownQueryLanguage["PtPt"] = "pt-pt";
11649
+ /** Query language value for Italian (Italy). */
11650
+ KnownQueryLanguage["ItIt"] = "it-it";
11651
+ /** Query language value for Japanese (Japan). */
11652
+ KnownQueryLanguage["JaJp"] = "ja-jp";
11653
+ /** Query language value for Korean (Korea). */
11654
+ KnownQueryLanguage["KoKr"] = "ko-kr";
11655
+ /** Query language value for Russian (Russia). */
11656
+ KnownQueryLanguage["RuRu"] = "ru-ru";
11657
+ /** Query language value for Czech (Czech Republic). */
11658
+ KnownQueryLanguage["CsCz"] = "cs-cz";
11659
+ /** Query language value for Dutch (Belgium). */
11660
+ KnownQueryLanguage["NlBe"] = "nl-be";
11661
+ /** Query language value for Dutch (Netherlands). */
11662
+ KnownQueryLanguage["NlNl"] = "nl-nl";
11663
+ /** Query language value for Hungarian (Hungary). */
11664
+ KnownQueryLanguage["HuHu"] = "hu-hu";
11665
+ /** Query language value for Polish (Poland). */
11666
+ KnownQueryLanguage["PlPl"] = "pl-pl";
11667
+ /** Query language value for Swedish (Sweden). */
11668
+ KnownQueryLanguage["SvSe"] = "sv-se";
11669
+ /** Query language value for Turkish (Turkey). */
11670
+ KnownQueryLanguage["TrTr"] = "tr-tr";
11671
+ /** Query language value for Hindi (India). */
11672
+ KnownQueryLanguage["HiIn"] = "hi-in";
11673
+ /** Query language value for Arabic (Saudi Arabia). */
11674
+ KnownQueryLanguage["ArSa"] = "ar-sa";
11675
+ /** Query language value for Arabic (Egypt). */
11676
+ KnownQueryLanguage["ArEg"] = "ar-eg";
11677
+ /** Query language value for Arabic (Morocco). */
11678
+ KnownQueryLanguage["ArMa"] = "ar-ma";
11679
+ /** Query language value for Arabic (Kuwait). */
11680
+ KnownQueryLanguage["ArKw"] = "ar-kw";
11681
+ /** Query language value for Arabic (Jordan). */
11682
+ KnownQueryLanguage["ArJo"] = "ar-jo";
11683
+ /** Query language value for Danish (Denmark). */
11684
+ KnownQueryLanguage["DaDk"] = "da-dk";
11685
+ /** Query language value for Norwegian (Normway). */
11686
+ KnownQueryLanguage["NoNo"] = "no-no";
11687
+ /** Query language value for Bulgarian (Bulgary). */
11688
+ KnownQueryLanguage["BgBg"] = "bg-bg";
11689
+ /** Query language value for Croatian (Croatia). */
11690
+ KnownQueryLanguage["HrHr"] = "hr-hr";
11691
+ /** Query language value for Croatian (Bosnia and Herzegovina). */
11692
+ KnownQueryLanguage["HrBa"] = "hr-ba";
11693
+ /** Query language value for Malay (Malaysia). */
11694
+ KnownQueryLanguage["MsMy"] = "ms-my";
11695
+ /** Query language value for Malay (Brunei Darussalam). */
11696
+ KnownQueryLanguage["MsBn"] = "ms-bn";
11697
+ /** Query language value for Slovenian (Slovenia). */
11698
+ KnownQueryLanguage["SlSl"] = "sl-sl";
11699
+ /** Query language value for Tamil (India). */
11700
+ KnownQueryLanguage["TaIn"] = "ta-in";
11701
+ /** Query language value for Vietnamese (Viet Nam). */
11702
+ KnownQueryLanguage["ViVn"] = "vi-vn";
11703
+ /** Query language value for Greek (Greece). */
11704
+ KnownQueryLanguage["ElGr"] = "el-gr";
11705
+ /** Query language value for Romanian (Romania). */
11706
+ KnownQueryLanguage["RoRo"] = "ro-ro";
11707
+ /** Query language value for Icelandic (Iceland). */
11708
+ KnownQueryLanguage["IsIs"] = "is-is";
11709
+ /** Query language value for Indonesian (Indonesia). */
11710
+ KnownQueryLanguage["IdId"] = "id-id";
11711
+ /** Query language value for Thai (Thailand). */
11712
+ KnownQueryLanguage["ThTh"] = "th-th";
11713
+ /** Query language value for Lithuanian (Lithuania). */
11714
+ KnownQueryLanguage["LtLt"] = "lt-lt";
11715
+ /** Query language value for Ukrainian (Ukraine). */
11716
+ KnownQueryLanguage["UkUa"] = "uk-ua";
11717
+ /** Query language value for Latvian (Latvia). */
11718
+ KnownQueryLanguage["LvLv"] = "lv-lv";
11719
+ /** Query language value for Estonian (Estonia). */
11720
+ KnownQueryLanguage["EtEe"] = "et-ee";
11721
+ /** Query language value for Catalan (Spain). */
11722
+ KnownQueryLanguage["CaEs"] = "ca-es";
11723
+ /** Query language value for Finnish (Finland). */
11724
+ KnownQueryLanguage["FiFi"] = "fi-fi";
11725
+ /** Query language value for Serbian (Bosnia and Herzegovina). */
11726
+ KnownQueryLanguage["SrBa"] = "sr-ba";
11727
+ /** Query language value for Serbian (Montenegro). */
11728
+ KnownQueryLanguage["SrMe"] = "sr-me";
11729
+ /** Query language value for Serbian (Serbia). */
11730
+ KnownQueryLanguage["SrRs"] = "sr-rs";
11731
+ /** Query language value for Slovak (Slovakia). */
11732
+ KnownQueryLanguage["SkSk"] = "sk-sk";
11733
+ /** Query language value for Norwegian (Norway). */
11734
+ KnownQueryLanguage["NbNo"] = "nb-no";
11735
+ /** Query language value for Armenian (Armenia). */
11736
+ KnownQueryLanguage["HyAm"] = "hy-am";
11737
+ /** Query language value for Bengali (India). */
11738
+ KnownQueryLanguage["BnIn"] = "bn-in";
11739
+ /** Query language value for Basque (Spain). */
11740
+ KnownQueryLanguage["EuEs"] = "eu-es";
11741
+ /** Query language value for Galician (Spain). */
11742
+ KnownQueryLanguage["GlEs"] = "gl-es";
11743
+ /** Query language value for Gujarati (India). */
11744
+ KnownQueryLanguage["GuIn"] = "gu-in";
11745
+ /** Query language value for Hebrew (Israel). */
11746
+ KnownQueryLanguage["HeIl"] = "he-il";
11747
+ /** Query language value for Irish (Ireland). */
11748
+ KnownQueryLanguage["GaIe"] = "ga-ie";
11749
+ /** Query language value for Kannada (India). */
11750
+ KnownQueryLanguage["KnIn"] = "kn-in";
11751
+ /** Query language value for Malayalam (India). */
11752
+ KnownQueryLanguage["MlIn"] = "ml-in";
11753
+ /** Query language value for Marathi (India). */
11754
+ KnownQueryLanguage["MrIn"] = "mr-in";
11755
+ /** Query language value for Persian (U.A.E.). */
11756
+ KnownQueryLanguage["FaAe"] = "fa-ae";
11757
+ /** Query language value for Punjabi (India). */
11758
+ KnownQueryLanguage["PaIn"] = "pa-in";
11759
+ /** Query language value for Telugu (India). */
11760
+ KnownQueryLanguage["TeIn"] = "te-in";
11761
+ /** Query language value for Urdu (Pakistan). */
11762
+ KnownQueryLanguage["UrPk"] = "ur-pk";
11487
11763
  })(exports.KnownQueryLanguage || (exports.KnownQueryLanguage = {}));
11488
11764
  (function (KnownSpeller) {
11489
11765
  /** Speller not enabled. */