@azure/search-documents 12.2.0 → 12.3.0-alpha.20251031.1

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.
Files changed (717) hide show
  1. package/dist/browser/errorModels.d.ts +23 -17
  2. package/dist/browser/errorModels.d.ts.map +1 -1
  3. package/dist/browser/errorModels.js.map +1 -1
  4. package/dist/browser/generated/data/models/index.d.ts +593 -20
  5. package/dist/browser/generated/data/models/index.d.ts.map +1 -1
  6. package/dist/browser/generated/data/models/index.js +216 -6
  7. package/dist/browser/generated/data/models/index.js.map +1 -1
  8. package/dist/browser/generated/data/models/mappers.d.ts +18 -0
  9. package/dist/browser/generated/data/models/mappers.d.ts.map +1 -1
  10. package/dist/browser/generated/data/models/mappers.js +463 -4
  11. package/dist/browser/generated/data/models/mappers.js.map +1 -1
  12. package/dist/browser/generated/data/models/parameters.d.ts +6 -0
  13. package/dist/browser/generated/data/models/parameters.d.ts.map +1 -1
  14. package/dist/browser/generated/data/models/parameters.js +60 -0
  15. package/dist/browser/generated/data/models/parameters.js.map +1 -1
  16. package/dist/browser/generated/data/operations/documents.js +20 -3
  17. package/dist/browser/generated/data/operations/documents.js.map +1 -1
  18. package/dist/browser/generated/data/searchClient.d.ts +3 -3
  19. package/dist/browser/generated/data/searchClient.d.ts.map +1 -1
  20. package/dist/browser/generated/data/searchClient.js +1 -1
  21. package/dist/browser/generated/data/searchClient.js.map +1 -1
  22. package/dist/browser/generated/knowledgeBase/index.d.ts +4 -0
  23. package/dist/browser/generated/knowledgeBase/index.d.ts.map +1 -0
  24. package/dist/browser/generated/knowledgeBase/index.js +11 -0
  25. package/dist/browser/generated/knowledgeBase/index.js.map +1 -0
  26. package/dist/browser/generated/knowledgeBase/models/index.d.ts +561 -0
  27. package/dist/browser/generated/knowledgeBase/models/index.d.ts.map +1 -0
  28. package/dist/browser/generated/knowledgeBase/models/index.js +62 -0
  29. package/dist/browser/generated/knowledgeBase/models/index.js.map +1 -0
  30. package/dist/browser/generated/knowledgeBase/models/mappers.d.ts +88 -0
  31. package/dist/browser/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
  32. package/dist/browser/generated/knowledgeBase/models/mappers.js +1280 -0
  33. package/dist/browser/generated/knowledgeBase/models/mappers.js.map +1 -0
  34. package/dist/browser/generated/knowledgeBase/models/parameters.d.ts +9 -0
  35. package/dist/browser/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
  36. package/dist/browser/generated/knowledgeBase/models/parameters.js +75 -0
  37. package/dist/browser/generated/knowledgeBase/models/parameters.js.map +1 -0
  38. package/dist/browser/generated/knowledgeBase/operations/index.d.ts +2 -0
  39. package/dist/browser/generated/knowledgeBase/operations/index.d.ts.map +1 -0
  40. package/dist/browser/generated/knowledgeBase/operations/index.js +9 -0
  41. package/dist/browser/generated/knowledgeBase/operations/index.js.map +1 -0
  42. package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
  43. package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
  44. package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.js +57 -0
  45. package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
  46. package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
  47. package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
  48. package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.js +9 -0
  49. package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
  50. package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
  51. package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
  52. package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +9 -0
  53. package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
  54. package/dist/browser/generated/knowledgeBase/searchClient.d.ts +21 -0
  55. package/dist/browser/generated/knowledgeBase/searchClient.d.ts.map +1 -0
  56. package/dist/browser/generated/knowledgeBase/searchClient.js +88 -0
  57. package/dist/browser/generated/knowledgeBase/searchClient.js.map +1 -0
  58. package/dist/browser/generated/service/models/index.d.ts +1403 -131
  59. package/dist/browser/generated/service/models/index.d.ts.map +1 -1
  60. package/dist/browser/generated/service/models/index.js +274 -24
  61. package/dist/browser/generated/service/models/index.js.map +1 -1
  62. package/dist/browser/generated/service/models/mappers.d.ts +104 -17
  63. package/dist/browser/generated/service/models/mappers.d.ts.map +1 -1
  64. package/dist/browser/generated/service/models/mappers.js +3716 -1601
  65. package/dist/browser/generated/service/models/mappers.js.map +1 -1
  66. package/dist/browser/generated/service/models/parameters.d.ts +14 -2
  67. package/dist/browser/generated/service/models/parameters.d.ts.map +1 -1
  68. package/dist/browser/generated/service/models/parameters.js +89 -7
  69. package/dist/browser/generated/service/models/parameters.js.map +1 -1
  70. package/dist/browser/generated/service/operations/aliases.d.ts +43 -1
  71. package/dist/browser/generated/service/operations/aliases.d.ts.map +1 -1
  72. package/dist/browser/generated/service/operations/aliases.js +160 -200
  73. package/dist/browser/generated/service/operations/aliases.js.map +1 -1
  74. package/dist/browser/generated/service/operations/dataSources.js +4 -1
  75. package/dist/browser/generated/service/operations/dataSources.js.map +1 -1
  76. package/dist/browser/generated/service/operations/index.d.ts +3 -0
  77. package/dist/browser/generated/service/operations/index.d.ts.map +1 -1
  78. package/dist/browser/generated/service/operations/index.js +3 -0
  79. package/dist/browser/generated/service/operations/index.js.map +1 -1
  80. package/dist/browser/generated/service/operations/indexers.d.ts +14 -1
  81. package/dist/browser/generated/service/operations/indexers.d.ts.map +1 -1
  82. package/dist/browser/generated/service/operations/indexers.js +54 -1
  83. package/dist/browser/generated/service/operations/indexers.js.map +1 -1
  84. package/dist/browser/generated/service/operations/knowledgeBases.d.ts +43 -0
  85. package/dist/browser/generated/service/operations/knowledgeBases.d.ts.map +1 -0
  86. package/dist/browser/generated/service/operations/knowledgeBases.js +160 -0
  87. package/dist/browser/generated/service/operations/knowledgeBases.js.map +1 -0
  88. package/dist/browser/generated/service/operations/knowledgeSources.d.ts +49 -0
  89. package/dist/browser/generated/service/operations/knowledgeSources.d.ts.map +1 -0
  90. package/dist/browser/generated/service/operations/knowledgeSources.js +184 -0
  91. package/dist/browser/generated/service/operations/knowledgeSources.js.map +1 -0
  92. package/dist/browser/generated/service/operations/skillsets.d.ts +8 -1
  93. package/dist/browser/generated/service/operations/skillsets.d.ts.map +1 -1
  94. package/dist/browser/generated/service/operations/skillsets.js +30 -1
  95. package/dist/browser/generated/service/operations/skillsets.js.map +1 -1
  96. package/dist/browser/generated/service/operationsInterfaces/aliases.d.ts +35 -1
  97. package/dist/browser/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
  98. package/dist/browser/generated/service/operationsInterfaces/aliases.js +7 -66
  99. package/dist/browser/generated/service/operationsInterfaces/aliases.js.map +1 -1
  100. package/dist/browser/generated/service/operationsInterfaces/index.d.ts +3 -0
  101. package/dist/browser/generated/service/operationsInterfaces/index.d.ts.map +1 -1
  102. package/dist/browser/generated/service/operationsInterfaces/index.js +3 -0
  103. package/dist/browser/generated/service/operationsInterfaces/index.js.map +1 -1
  104. package/dist/browser/generated/service/operationsInterfaces/indexers.d.ts +14 -1
  105. package/dist/browser/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
  106. package/dist/browser/generated/service/operationsInterfaces/indexers.js.map +1 -1
  107. package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
  108. package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
  109. package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.js +9 -0
  110. package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
  111. package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
  112. package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
  113. package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.js +9 -0
  114. package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
  115. package/dist/browser/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
  116. package/dist/browser/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
  117. package/dist/browser/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  118. package/dist/browser/generated/service/searchServiceClient.d.ts +12 -4
  119. package/dist/browser/generated/service/searchServiceClient.d.ts.map +1 -1
  120. package/dist/browser/generated/service/searchServiceClient.js +31 -2
  121. package/dist/browser/generated/service/searchServiceClient.js.map +1 -1
  122. package/dist/browser/index.d.ts +7 -4
  123. package/dist/browser/index.d.ts.map +1 -1
  124. package/dist/browser/index.js +5 -3
  125. package/dist/browser/index.js.map +1 -1
  126. package/dist/browser/indexDocumentsBatch.d.ts +6 -5
  127. package/dist/browser/indexDocumentsBatch.d.ts.map +1 -1
  128. package/dist/browser/indexDocumentsBatch.js +5 -4
  129. package/dist/browser/indexDocumentsBatch.js.map +1 -1
  130. package/dist/browser/indexModels.d.ts +236 -30
  131. package/dist/browser/indexModels.d.ts.map +1 -1
  132. package/dist/browser/indexModels.js.map +1 -1
  133. package/dist/browser/knowledgeBaseModels.d.ts +44 -0
  134. package/dist/browser/knowledgeBaseModels.d.ts.map +1 -0
  135. package/dist/browser/knowledgeBaseModels.js +4 -0
  136. package/dist/browser/knowledgeBaseModels.js.map +1 -0
  137. package/dist/browser/knowledgeRetrievalClient.d.ts +68 -0
  138. package/dist/browser/knowledgeRetrievalClient.d.ts.map +1 -0
  139. package/dist/browser/knowledgeRetrievalClient.js +108 -0
  140. package/dist/browser/knowledgeRetrievalClient.js.map +1 -0
  141. package/dist/browser/odata.d.ts +5 -2
  142. package/dist/browser/odata.d.ts.map +1 -1
  143. package/dist/browser/odata.js +5 -2
  144. package/dist/browser/odata.js.map +1 -1
  145. package/dist/browser/odataMetadataPolicy.d.ts +1 -1
  146. package/dist/browser/odataMetadataPolicy.d.ts.map +1 -1
  147. package/dist/browser/odataMetadataPolicy.js.map +1 -1
  148. package/dist/browser/searchApiKeyCredentialPolicy.d.ts +4 -4
  149. package/dist/browser/searchApiKeyCredentialPolicy.d.ts.map +1 -1
  150. package/dist/browser/searchApiKeyCredentialPolicy.js +2 -2
  151. package/dist/browser/searchApiKeyCredentialPolicy.js.map +1 -1
  152. package/dist/browser/searchClient.d.ts +64 -53
  153. package/dist/browser/searchClient.d.ts.map +1 -1
  154. package/dist/browser/searchClient.js +113 -53
  155. package/dist/browser/searchClient.js.map +1 -1
  156. package/dist/browser/searchIndexClient.d.ts +157 -18
  157. package/dist/browser/searchIndexClient.d.ts.map +1 -1
  158. package/dist/browser/searchIndexClient.js +482 -17
  159. package/dist/browser/searchIndexClient.js.map +1 -1
  160. package/dist/browser/searchIndexerClient.d.ts +26 -11
  161. package/dist/browser/searchIndexerClient.d.ts.map +1 -1
  162. package/dist/browser/searchIndexerClient.js +62 -7
  163. package/dist/browser/searchIndexerClient.js.map +1 -1
  164. package/dist/browser/searchIndexingBufferedSender.d.ts +3 -3
  165. package/dist/browser/searchIndexingBufferedSender.d.ts.map +1 -1
  166. package/dist/browser/searchIndexingBufferedSender.js +1 -1
  167. package/dist/browser/searchIndexingBufferedSender.js.map +1 -1
  168. package/dist/browser/serviceModels.d.ts +1228 -220
  169. package/dist/browser/serviceModels.d.ts.map +1 -1
  170. package/dist/browser/serviceModels.js +8 -7
  171. package/dist/browser/serviceModels.js.map +1 -1
  172. package/dist/browser/serviceUtils.d.ts +14 -6
  173. package/dist/browser/serviceUtils.d.ts.map +1 -1
  174. package/dist/browser/serviceUtils.js +301 -45
  175. package/dist/browser/serviceUtils.js.map +1 -1
  176. package/dist/browser/synonymMapHelper-browser.d.mts.map +1 -1
  177. package/dist/browser/synonymMapHelper-browser.mjs.map +1 -1
  178. package/dist/browser/synonymMapHelper.d.ts +1 -1
  179. package/dist/commonjs/errorModels.d.ts +23 -17
  180. package/dist/commonjs/errorModels.d.ts.map +1 -1
  181. package/dist/commonjs/errorModels.js.map +1 -1
  182. package/dist/commonjs/generated/data/models/index.d.ts +593 -20
  183. package/dist/commonjs/generated/data/models/index.d.ts.map +1 -1
  184. package/dist/commonjs/generated/data/models/index.js +217 -7
  185. package/dist/commonjs/generated/data/models/index.js.map +1 -1
  186. package/dist/commonjs/generated/data/models/mappers.d.ts +18 -0
  187. package/dist/commonjs/generated/data/models/mappers.d.ts.map +1 -1
  188. package/dist/commonjs/generated/data/models/mappers.js +464 -5
  189. package/dist/commonjs/generated/data/models/mappers.js.map +1 -1
  190. package/dist/commonjs/generated/data/models/parameters.d.ts +6 -0
  191. package/dist/commonjs/generated/data/models/parameters.d.ts.map +1 -1
  192. package/dist/commonjs/generated/data/models/parameters.js +62 -2
  193. package/dist/commonjs/generated/data/models/parameters.js.map +1 -1
  194. package/dist/commonjs/generated/data/operations/documents.js +20 -3
  195. package/dist/commonjs/generated/data/operations/documents.js.map +1 -1
  196. package/dist/commonjs/generated/data/searchClient.d.ts +3 -3
  197. package/dist/commonjs/generated/data/searchClient.d.ts.map +1 -1
  198. package/dist/commonjs/generated/data/searchClient.js +1 -1
  199. package/dist/commonjs/generated/data/searchClient.js.map +1 -1
  200. package/dist/commonjs/generated/knowledgeBase/index.d.ts +4 -0
  201. package/dist/commonjs/generated/knowledgeBase/index.d.ts.map +1 -0
  202. package/dist/commonjs/generated/knowledgeBase/index.js +16 -0
  203. package/dist/commonjs/generated/knowledgeBase/index.js.map +1 -0
  204. package/dist/commonjs/generated/knowledgeBase/models/index.d.ts +561 -0
  205. package/dist/commonjs/generated/knowledgeBase/models/index.d.ts.map +1 -0
  206. package/dist/commonjs/generated/knowledgeBase/models/index.js +65 -0
  207. package/dist/commonjs/generated/knowledgeBase/models/index.js.map +1 -0
  208. package/dist/commonjs/generated/knowledgeBase/models/mappers.d.ts +88 -0
  209. package/dist/commonjs/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
  210. package/dist/commonjs/generated/knowledgeBase/models/mappers.js +1284 -0
  211. package/dist/commonjs/generated/knowledgeBase/models/mappers.js.map +1 -0
  212. package/dist/commonjs/generated/knowledgeBase/models/parameters.d.ts +9 -0
  213. package/dist/commonjs/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
  214. package/dist/commonjs/generated/knowledgeBase/models/parameters.js +78 -0
  215. package/dist/commonjs/generated/knowledgeBase/models/parameters.js.map +1 -0
  216. package/dist/commonjs/generated/knowledgeBase/operations/index.d.ts +2 -0
  217. package/dist/commonjs/generated/knowledgeBase/operations/index.d.ts.map +1 -0
  218. package/dist/commonjs/generated/knowledgeBase/operations/index.js +12 -0
  219. package/dist/commonjs/generated/knowledgeBase/operations/index.js.map +1 -0
  220. package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
  221. package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
  222. package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.js +62 -0
  223. package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
  224. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
  225. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
  226. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.js +12 -0
  227. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
  228. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
  229. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
  230. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +10 -0
  231. package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
  232. package/dist/commonjs/generated/knowledgeBase/searchClient.d.ts +21 -0
  233. package/dist/commonjs/generated/knowledgeBase/searchClient.d.ts.map +1 -0
  234. package/dist/commonjs/generated/knowledgeBase/searchClient.js +93 -0
  235. package/dist/commonjs/generated/knowledgeBase/searchClient.js.map +1 -0
  236. package/dist/commonjs/generated/service/models/index.d.ts +1403 -131
  237. package/dist/commonjs/generated/service/models/index.d.ts.map +1 -1
  238. package/dist/commonjs/generated/service/models/index.js +276 -25
  239. package/dist/commonjs/generated/service/models/index.js.map +1 -1
  240. package/dist/commonjs/generated/service/models/mappers.d.ts +104 -17
  241. package/dist/commonjs/generated/service/models/mappers.d.ts.map +1 -1
  242. package/dist/commonjs/generated/service/models/mappers.js +3721 -1605
  243. package/dist/commonjs/generated/service/models/mappers.js.map +1 -1
  244. package/dist/commonjs/generated/service/models/parameters.d.ts +14 -2
  245. package/dist/commonjs/generated/service/models/parameters.d.ts.map +1 -1
  246. package/dist/commonjs/generated/service/models/parameters.js +89 -7
  247. package/dist/commonjs/generated/service/models/parameters.js.map +1 -1
  248. package/dist/commonjs/generated/service/operations/aliases.d.ts +43 -1
  249. package/dist/commonjs/generated/service/operations/aliases.d.ts.map +1 -1
  250. package/dist/commonjs/generated/service/operations/aliases.js +163 -199
  251. package/dist/commonjs/generated/service/operations/aliases.js.map +1 -1
  252. package/dist/commonjs/generated/service/operations/dataSources.js +4 -1
  253. package/dist/commonjs/generated/service/operations/dataSources.js.map +1 -1
  254. package/dist/commonjs/generated/service/operations/index.d.ts +3 -0
  255. package/dist/commonjs/generated/service/operations/index.d.ts.map +1 -1
  256. package/dist/commonjs/generated/service/operations/index.js +3 -0
  257. package/dist/commonjs/generated/service/operations/index.js.map +1 -1
  258. package/dist/commonjs/generated/service/operations/indexers.d.ts +14 -1
  259. package/dist/commonjs/generated/service/operations/indexers.d.ts.map +1 -1
  260. package/dist/commonjs/generated/service/operations/indexers.js +54 -1
  261. package/dist/commonjs/generated/service/operations/indexers.js.map +1 -1
  262. package/dist/commonjs/generated/service/operations/knowledgeBases.d.ts +43 -0
  263. package/dist/commonjs/generated/service/operations/knowledgeBases.d.ts.map +1 -0
  264. package/dist/commonjs/generated/service/operations/knowledgeBases.js +165 -0
  265. package/dist/commonjs/generated/service/operations/knowledgeBases.js.map +1 -0
  266. package/dist/commonjs/generated/service/operations/knowledgeSources.d.ts +49 -0
  267. package/dist/commonjs/generated/service/operations/knowledgeSources.d.ts.map +1 -0
  268. package/dist/commonjs/generated/service/operations/knowledgeSources.js +189 -0
  269. package/dist/commonjs/generated/service/operations/knowledgeSources.js.map +1 -0
  270. package/dist/commonjs/generated/service/operations/skillsets.d.ts +8 -1
  271. package/dist/commonjs/generated/service/operations/skillsets.d.ts.map +1 -1
  272. package/dist/commonjs/generated/service/operations/skillsets.js +30 -1
  273. package/dist/commonjs/generated/service/operations/skillsets.js.map +1 -1
  274. package/dist/commonjs/generated/service/operationsInterfaces/aliases.d.ts +35 -1
  275. package/dist/commonjs/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
  276. package/dist/commonjs/generated/service/operationsInterfaces/aliases.js +7 -66
  277. package/dist/commonjs/generated/service/operationsInterfaces/aliases.js.map +1 -1
  278. package/dist/commonjs/generated/service/operationsInterfaces/index.d.ts +3 -0
  279. package/dist/commonjs/generated/service/operationsInterfaces/index.d.ts.map +1 -1
  280. package/dist/commonjs/generated/service/operationsInterfaces/index.js +3 -0
  281. package/dist/commonjs/generated/service/operationsInterfaces/index.js.map +1 -1
  282. package/dist/commonjs/generated/service/operationsInterfaces/indexers.d.ts +14 -1
  283. package/dist/commonjs/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
  284. package/dist/commonjs/generated/service/operationsInterfaces/indexers.js.map +1 -1
  285. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
  286. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
  287. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.js +10 -0
  288. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
  289. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
  290. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
  291. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.js +10 -0
  292. package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
  293. package/dist/commonjs/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
  294. package/dist/commonjs/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
  295. package/dist/commonjs/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  296. package/dist/commonjs/generated/service/searchServiceClient.d.ts +12 -4
  297. package/dist/commonjs/generated/service/searchServiceClient.d.ts.map +1 -1
  298. package/dist/commonjs/generated/service/searchServiceClient.js +30 -1
  299. package/dist/commonjs/generated/service/searchServiceClient.js.map +1 -1
  300. package/dist/commonjs/index.d.ts +7 -4
  301. package/dist/commonjs/index.d.ts.map +1 -1
  302. package/dist/commonjs/index.js +71 -44
  303. package/dist/commonjs/index.js.map +1 -1
  304. package/dist/commonjs/indexDocumentsBatch.d.ts +6 -5
  305. package/dist/commonjs/indexDocumentsBatch.d.ts.map +1 -1
  306. package/dist/commonjs/indexDocumentsBatch.js +5 -4
  307. package/dist/commonjs/indexDocumentsBatch.js.map +1 -1
  308. package/dist/commonjs/indexModels.d.ts +236 -30
  309. package/dist/commonjs/indexModels.d.ts.map +1 -1
  310. package/dist/commonjs/indexModels.js.map +1 -1
  311. package/dist/commonjs/knowledgeBaseModels.d.ts +44 -0
  312. package/dist/commonjs/knowledgeBaseModels.d.ts.map +1 -0
  313. package/dist/commonjs/knowledgeBaseModels.js +5 -0
  314. package/dist/commonjs/knowledgeBaseModels.js.map +1 -0
  315. package/dist/commonjs/knowledgeRetrievalClient.d.ts +68 -0
  316. package/dist/commonjs/knowledgeRetrievalClient.d.ts.map +1 -0
  317. package/dist/commonjs/knowledgeRetrievalClient.js +113 -0
  318. package/dist/commonjs/knowledgeRetrievalClient.js.map +1 -0
  319. package/dist/commonjs/odata.d.ts +5 -2
  320. package/dist/commonjs/odata.d.ts.map +1 -1
  321. package/dist/commonjs/odata.js +5 -2
  322. package/dist/commonjs/odata.js.map +1 -1
  323. package/dist/commonjs/odataMetadataPolicy.d.ts +1 -1
  324. package/dist/commonjs/odataMetadataPolicy.d.ts.map +1 -1
  325. package/dist/commonjs/odataMetadataPolicy.js.map +1 -1
  326. package/dist/commonjs/searchApiKeyCredentialPolicy.d.ts +4 -4
  327. package/dist/commonjs/searchApiKeyCredentialPolicy.d.ts.map +1 -1
  328. package/dist/commonjs/searchApiKeyCredentialPolicy.js +2 -2
  329. package/dist/commonjs/searchApiKeyCredentialPolicy.js.map +1 -1
  330. package/dist/commonjs/searchClient.d.ts +64 -53
  331. package/dist/commonjs/searchClient.d.ts.map +1 -1
  332. package/dist/commonjs/searchClient.js +113 -53
  333. package/dist/commonjs/searchClient.js.map +1 -1
  334. package/dist/commonjs/searchIndexClient.d.ts +157 -18
  335. package/dist/commonjs/searchIndexClient.d.ts.map +1 -1
  336. package/dist/commonjs/searchIndexClient.js +482 -17
  337. package/dist/commonjs/searchIndexClient.js.map +1 -1
  338. package/dist/commonjs/searchIndexerClient.d.ts +26 -11
  339. package/dist/commonjs/searchIndexerClient.d.ts.map +1 -1
  340. package/dist/commonjs/searchIndexerClient.js +62 -7
  341. package/dist/commonjs/searchIndexerClient.js.map +1 -1
  342. package/dist/commonjs/searchIndexingBufferedSender.d.ts +3 -3
  343. package/dist/commonjs/searchIndexingBufferedSender.d.ts.map +1 -1
  344. package/dist/commonjs/searchIndexingBufferedSender.js +2 -2
  345. package/dist/commonjs/searchIndexingBufferedSender.js.map +1 -1
  346. package/dist/commonjs/serviceModels.d.ts +1228 -220
  347. package/dist/commonjs/serviceModels.d.ts.map +1 -1
  348. package/dist/commonjs/serviceModels.js +8 -7
  349. package/dist/commonjs/serviceModels.js.map +1 -1
  350. package/dist/commonjs/serviceUtils.d.ts +14 -6
  351. package/dist/commonjs/serviceUtils.d.ts.map +1 -1
  352. package/dist/commonjs/serviceUtils.js +306 -44
  353. package/dist/commonjs/serviceUtils.js.map +1 -1
  354. package/dist/commonjs/synonymMapHelper.d.ts +1 -1
  355. package/dist/commonjs/synonymMapHelper.d.ts.map +1 -1
  356. package/dist/commonjs/synonymMapHelper.js +3 -3
  357. package/dist/commonjs/synonymMapHelper.js.map +1 -1
  358. package/dist/commonjs/tsdoc-metadata.json +1 -1
  359. package/dist/esm/errorModels.d.ts +23 -17
  360. package/dist/esm/errorModels.d.ts.map +1 -1
  361. package/dist/esm/errorModels.js.map +1 -1
  362. package/dist/esm/generated/data/models/index.d.ts +593 -20
  363. package/dist/esm/generated/data/models/index.d.ts.map +1 -1
  364. package/dist/esm/generated/data/models/index.js +216 -6
  365. package/dist/esm/generated/data/models/index.js.map +1 -1
  366. package/dist/esm/generated/data/models/mappers.d.ts +18 -0
  367. package/dist/esm/generated/data/models/mappers.d.ts.map +1 -1
  368. package/dist/esm/generated/data/models/mappers.js +463 -4
  369. package/dist/esm/generated/data/models/mappers.js.map +1 -1
  370. package/dist/esm/generated/data/models/parameters.d.ts +6 -0
  371. package/dist/esm/generated/data/models/parameters.d.ts.map +1 -1
  372. package/dist/esm/generated/data/models/parameters.js +60 -0
  373. package/dist/esm/generated/data/models/parameters.js.map +1 -1
  374. package/dist/esm/generated/data/operations/documents.js +20 -3
  375. package/dist/esm/generated/data/operations/documents.js.map +1 -1
  376. package/dist/esm/generated/data/searchClient.d.ts +3 -3
  377. package/dist/esm/generated/data/searchClient.d.ts.map +1 -1
  378. package/dist/esm/generated/data/searchClient.js +1 -1
  379. package/dist/esm/generated/data/searchClient.js.map +1 -1
  380. package/dist/esm/generated/knowledgeBase/index.d.ts +4 -0
  381. package/dist/esm/generated/knowledgeBase/index.d.ts.map +1 -0
  382. package/dist/esm/generated/knowledgeBase/index.js +11 -0
  383. package/dist/esm/generated/knowledgeBase/index.js.map +1 -0
  384. package/dist/esm/generated/knowledgeBase/models/index.d.ts +561 -0
  385. package/dist/esm/generated/knowledgeBase/models/index.d.ts.map +1 -0
  386. package/dist/esm/generated/knowledgeBase/models/index.js +62 -0
  387. package/dist/esm/generated/knowledgeBase/models/index.js.map +1 -0
  388. package/dist/esm/generated/knowledgeBase/models/mappers.d.ts +88 -0
  389. package/dist/esm/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
  390. package/dist/esm/generated/knowledgeBase/models/mappers.js +1280 -0
  391. package/dist/esm/generated/knowledgeBase/models/mappers.js.map +1 -0
  392. package/dist/esm/generated/knowledgeBase/models/parameters.d.ts +9 -0
  393. package/dist/esm/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
  394. package/dist/esm/generated/knowledgeBase/models/parameters.js +75 -0
  395. package/dist/esm/generated/knowledgeBase/models/parameters.js.map +1 -0
  396. package/dist/esm/generated/knowledgeBase/operations/index.d.ts +2 -0
  397. package/dist/esm/generated/knowledgeBase/operations/index.d.ts.map +1 -0
  398. package/dist/esm/generated/knowledgeBase/operations/index.js +9 -0
  399. package/dist/esm/generated/knowledgeBase/operations/index.js.map +1 -0
  400. package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
  401. package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
  402. package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.js +57 -0
  403. package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
  404. package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
  405. package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
  406. package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.js +9 -0
  407. package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
  408. package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
  409. package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
  410. package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +9 -0
  411. package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
  412. package/dist/esm/generated/knowledgeBase/searchClient.d.ts +21 -0
  413. package/dist/esm/generated/knowledgeBase/searchClient.d.ts.map +1 -0
  414. package/dist/esm/generated/knowledgeBase/searchClient.js +88 -0
  415. package/dist/esm/generated/knowledgeBase/searchClient.js.map +1 -0
  416. package/dist/esm/generated/service/models/index.d.ts +1403 -131
  417. package/dist/esm/generated/service/models/index.d.ts.map +1 -1
  418. package/dist/esm/generated/service/models/index.js +274 -24
  419. package/dist/esm/generated/service/models/index.js.map +1 -1
  420. package/dist/esm/generated/service/models/mappers.d.ts +104 -17
  421. package/dist/esm/generated/service/models/mappers.d.ts.map +1 -1
  422. package/dist/esm/generated/service/models/mappers.js +3716 -1601
  423. package/dist/esm/generated/service/models/mappers.js.map +1 -1
  424. package/dist/esm/generated/service/models/parameters.d.ts +14 -2
  425. package/dist/esm/generated/service/models/parameters.d.ts.map +1 -1
  426. package/dist/esm/generated/service/models/parameters.js +89 -7
  427. package/dist/esm/generated/service/models/parameters.js.map +1 -1
  428. package/dist/esm/generated/service/operations/aliases.d.ts +43 -1
  429. package/dist/esm/generated/service/operations/aliases.d.ts.map +1 -1
  430. package/dist/esm/generated/service/operations/aliases.js +160 -200
  431. package/dist/esm/generated/service/operations/aliases.js.map +1 -1
  432. package/dist/esm/generated/service/operations/dataSources.js +4 -1
  433. package/dist/esm/generated/service/operations/dataSources.js.map +1 -1
  434. package/dist/esm/generated/service/operations/index.d.ts +3 -0
  435. package/dist/esm/generated/service/operations/index.d.ts.map +1 -1
  436. package/dist/esm/generated/service/operations/index.js +3 -0
  437. package/dist/esm/generated/service/operations/index.js.map +1 -1
  438. package/dist/esm/generated/service/operations/indexers.d.ts +14 -1
  439. package/dist/esm/generated/service/operations/indexers.d.ts.map +1 -1
  440. package/dist/esm/generated/service/operations/indexers.js +54 -1
  441. package/dist/esm/generated/service/operations/indexers.js.map +1 -1
  442. package/dist/esm/generated/service/operations/knowledgeBases.d.ts +43 -0
  443. package/dist/esm/generated/service/operations/knowledgeBases.d.ts.map +1 -0
  444. package/dist/esm/generated/service/operations/knowledgeBases.js +160 -0
  445. package/dist/esm/generated/service/operations/knowledgeBases.js.map +1 -0
  446. package/dist/esm/generated/service/operations/knowledgeSources.d.ts +49 -0
  447. package/dist/esm/generated/service/operations/knowledgeSources.d.ts.map +1 -0
  448. package/dist/esm/generated/service/operations/knowledgeSources.js +184 -0
  449. package/dist/esm/generated/service/operations/knowledgeSources.js.map +1 -0
  450. package/dist/esm/generated/service/operations/skillsets.d.ts +8 -1
  451. package/dist/esm/generated/service/operations/skillsets.d.ts.map +1 -1
  452. package/dist/esm/generated/service/operations/skillsets.js +30 -1
  453. package/dist/esm/generated/service/operations/skillsets.js.map +1 -1
  454. package/dist/esm/generated/service/operationsInterfaces/aliases.d.ts +35 -1
  455. package/dist/esm/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
  456. package/dist/esm/generated/service/operationsInterfaces/aliases.js +7 -66
  457. package/dist/esm/generated/service/operationsInterfaces/aliases.js.map +1 -1
  458. package/dist/esm/generated/service/operationsInterfaces/index.d.ts +3 -0
  459. package/dist/esm/generated/service/operationsInterfaces/index.d.ts.map +1 -1
  460. package/dist/esm/generated/service/operationsInterfaces/index.js +3 -0
  461. package/dist/esm/generated/service/operationsInterfaces/index.js.map +1 -1
  462. package/dist/esm/generated/service/operationsInterfaces/indexers.d.ts +14 -1
  463. package/dist/esm/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
  464. package/dist/esm/generated/service/operationsInterfaces/indexers.js.map +1 -1
  465. package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
  466. package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
  467. package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.js +9 -0
  468. package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
  469. package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
  470. package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
  471. package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.js +9 -0
  472. package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
  473. package/dist/esm/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
  474. package/dist/esm/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
  475. package/dist/esm/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  476. package/dist/esm/generated/service/searchServiceClient.d.ts +12 -4
  477. package/dist/esm/generated/service/searchServiceClient.d.ts.map +1 -1
  478. package/dist/esm/generated/service/searchServiceClient.js +31 -2
  479. package/dist/esm/generated/service/searchServiceClient.js.map +1 -1
  480. package/dist/esm/index.d.ts +7 -4
  481. package/dist/esm/index.d.ts.map +1 -1
  482. package/dist/esm/index.js +5 -3
  483. package/dist/esm/index.js.map +1 -1
  484. package/dist/esm/indexDocumentsBatch.d.ts +6 -5
  485. package/dist/esm/indexDocumentsBatch.d.ts.map +1 -1
  486. package/dist/esm/indexDocumentsBatch.js +5 -4
  487. package/dist/esm/indexDocumentsBatch.js.map +1 -1
  488. package/dist/esm/indexModels.d.ts +236 -30
  489. package/dist/esm/indexModels.d.ts.map +1 -1
  490. package/dist/esm/indexModels.js.map +1 -1
  491. package/dist/esm/knowledgeBaseModels.d.ts +44 -0
  492. package/dist/esm/knowledgeBaseModels.d.ts.map +1 -0
  493. package/dist/esm/knowledgeBaseModels.js +4 -0
  494. package/dist/esm/knowledgeBaseModels.js.map +1 -0
  495. package/dist/esm/knowledgeRetrievalClient.d.ts +68 -0
  496. package/dist/esm/knowledgeRetrievalClient.d.ts.map +1 -0
  497. package/dist/esm/knowledgeRetrievalClient.js +108 -0
  498. package/dist/esm/knowledgeRetrievalClient.js.map +1 -0
  499. package/dist/esm/odata.d.ts +5 -2
  500. package/dist/esm/odata.d.ts.map +1 -1
  501. package/dist/esm/odata.js +5 -2
  502. package/dist/esm/odata.js.map +1 -1
  503. package/dist/esm/odataMetadataPolicy.d.ts +1 -1
  504. package/dist/esm/odataMetadataPolicy.d.ts.map +1 -1
  505. package/dist/esm/odataMetadataPolicy.js.map +1 -1
  506. package/dist/esm/searchApiKeyCredentialPolicy.d.ts +4 -4
  507. package/dist/esm/searchApiKeyCredentialPolicy.d.ts.map +1 -1
  508. package/dist/esm/searchApiKeyCredentialPolicy.js +2 -2
  509. package/dist/esm/searchApiKeyCredentialPolicy.js.map +1 -1
  510. package/dist/esm/searchClient.d.ts +64 -53
  511. package/dist/esm/searchClient.d.ts.map +1 -1
  512. package/dist/esm/searchClient.js +113 -53
  513. package/dist/esm/searchClient.js.map +1 -1
  514. package/dist/esm/searchIndexClient.d.ts +157 -18
  515. package/dist/esm/searchIndexClient.d.ts.map +1 -1
  516. package/dist/esm/searchIndexClient.js +482 -17
  517. package/dist/esm/searchIndexClient.js.map +1 -1
  518. package/dist/esm/searchIndexerClient.d.ts +26 -11
  519. package/dist/esm/searchIndexerClient.d.ts.map +1 -1
  520. package/dist/esm/searchIndexerClient.js +62 -7
  521. package/dist/esm/searchIndexerClient.js.map +1 -1
  522. package/dist/esm/searchIndexingBufferedSender.d.ts +3 -3
  523. package/dist/esm/searchIndexingBufferedSender.d.ts.map +1 -1
  524. package/dist/esm/searchIndexingBufferedSender.js +1 -1
  525. package/dist/esm/searchIndexingBufferedSender.js.map +1 -1
  526. package/dist/esm/serviceModels.d.ts +1228 -220
  527. package/dist/esm/serviceModels.d.ts.map +1 -1
  528. package/dist/esm/serviceModels.js +8 -7
  529. package/dist/esm/serviceModels.js.map +1 -1
  530. package/dist/esm/serviceUtils.d.ts +14 -6
  531. package/dist/esm/serviceUtils.d.ts.map +1 -1
  532. package/dist/esm/serviceUtils.js +301 -45
  533. package/dist/esm/serviceUtils.js.map +1 -1
  534. package/dist/esm/synonymMapHelper.d.ts +1 -1
  535. package/dist/esm/synonymMapHelper.d.ts.map +1 -1
  536. package/dist/esm/synonymMapHelper.js +2 -2
  537. package/dist/esm/synonymMapHelper.js.map +1 -1
  538. package/dist/react-native/errorModels.d.ts +23 -17
  539. package/dist/react-native/errorModels.d.ts.map +1 -1
  540. package/dist/react-native/errorModels.js.map +1 -1
  541. package/dist/react-native/generated/data/models/index.d.ts +593 -20
  542. package/dist/react-native/generated/data/models/index.d.ts.map +1 -1
  543. package/dist/react-native/generated/data/models/index.js +216 -6
  544. package/dist/react-native/generated/data/models/index.js.map +1 -1
  545. package/dist/react-native/generated/data/models/mappers.d.ts +18 -0
  546. package/dist/react-native/generated/data/models/mappers.d.ts.map +1 -1
  547. package/dist/react-native/generated/data/models/mappers.js +463 -4
  548. package/dist/react-native/generated/data/models/mappers.js.map +1 -1
  549. package/dist/react-native/generated/data/models/parameters.d.ts +6 -0
  550. package/dist/react-native/generated/data/models/parameters.d.ts.map +1 -1
  551. package/dist/react-native/generated/data/models/parameters.js +60 -0
  552. package/dist/react-native/generated/data/models/parameters.js.map +1 -1
  553. package/dist/react-native/generated/data/operations/documents.js +20 -3
  554. package/dist/react-native/generated/data/operations/documents.js.map +1 -1
  555. package/dist/react-native/generated/data/searchClient.d.ts +3 -3
  556. package/dist/react-native/generated/data/searchClient.d.ts.map +1 -1
  557. package/dist/react-native/generated/data/searchClient.js +1 -1
  558. package/dist/react-native/generated/data/searchClient.js.map +1 -1
  559. package/dist/react-native/generated/knowledgeBase/index.d.ts +4 -0
  560. package/dist/react-native/generated/knowledgeBase/index.d.ts.map +1 -0
  561. package/dist/react-native/generated/knowledgeBase/index.js +11 -0
  562. package/dist/react-native/generated/knowledgeBase/index.js.map +1 -0
  563. package/dist/react-native/generated/knowledgeBase/models/index.d.ts +561 -0
  564. package/dist/react-native/generated/knowledgeBase/models/index.d.ts.map +1 -0
  565. package/dist/react-native/generated/knowledgeBase/models/index.js +62 -0
  566. package/dist/react-native/generated/knowledgeBase/models/index.js.map +1 -0
  567. package/dist/react-native/generated/knowledgeBase/models/mappers.d.ts +88 -0
  568. package/dist/react-native/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
  569. package/dist/react-native/generated/knowledgeBase/models/mappers.js +1280 -0
  570. package/dist/react-native/generated/knowledgeBase/models/mappers.js.map +1 -0
  571. package/dist/react-native/generated/knowledgeBase/models/parameters.d.ts +9 -0
  572. package/dist/react-native/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
  573. package/dist/react-native/generated/knowledgeBase/models/parameters.js +75 -0
  574. package/dist/react-native/generated/knowledgeBase/models/parameters.js.map +1 -0
  575. package/dist/react-native/generated/knowledgeBase/operations/index.d.ts +2 -0
  576. package/dist/react-native/generated/knowledgeBase/operations/index.d.ts.map +1 -0
  577. package/dist/react-native/generated/knowledgeBase/operations/index.js +9 -0
  578. package/dist/react-native/generated/knowledgeBase/operations/index.js.map +1 -0
  579. package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
  580. package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
  581. package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.js +57 -0
  582. package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
  583. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
  584. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
  585. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.js +9 -0
  586. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
  587. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
  588. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
  589. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +9 -0
  590. package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
  591. package/dist/react-native/generated/knowledgeBase/searchClient.d.ts +21 -0
  592. package/dist/react-native/generated/knowledgeBase/searchClient.d.ts.map +1 -0
  593. package/dist/react-native/generated/knowledgeBase/searchClient.js +88 -0
  594. package/dist/react-native/generated/knowledgeBase/searchClient.js.map +1 -0
  595. package/dist/react-native/generated/service/models/index.d.ts +1403 -131
  596. package/dist/react-native/generated/service/models/index.d.ts.map +1 -1
  597. package/dist/react-native/generated/service/models/index.js +274 -24
  598. package/dist/react-native/generated/service/models/index.js.map +1 -1
  599. package/dist/react-native/generated/service/models/mappers.d.ts +104 -17
  600. package/dist/react-native/generated/service/models/mappers.d.ts.map +1 -1
  601. package/dist/react-native/generated/service/models/mappers.js +3716 -1601
  602. package/dist/react-native/generated/service/models/mappers.js.map +1 -1
  603. package/dist/react-native/generated/service/models/parameters.d.ts +14 -2
  604. package/dist/react-native/generated/service/models/parameters.d.ts.map +1 -1
  605. package/dist/react-native/generated/service/models/parameters.js +89 -7
  606. package/dist/react-native/generated/service/models/parameters.js.map +1 -1
  607. package/dist/react-native/generated/service/operations/aliases.d.ts +43 -1
  608. package/dist/react-native/generated/service/operations/aliases.d.ts.map +1 -1
  609. package/dist/react-native/generated/service/operations/aliases.js +160 -200
  610. package/dist/react-native/generated/service/operations/aliases.js.map +1 -1
  611. package/dist/react-native/generated/service/operations/dataSources.js +4 -1
  612. package/dist/react-native/generated/service/operations/dataSources.js.map +1 -1
  613. package/dist/react-native/generated/service/operations/index.d.ts +3 -0
  614. package/dist/react-native/generated/service/operations/index.d.ts.map +1 -1
  615. package/dist/react-native/generated/service/operations/index.js +3 -0
  616. package/dist/react-native/generated/service/operations/index.js.map +1 -1
  617. package/dist/react-native/generated/service/operations/indexers.d.ts +14 -1
  618. package/dist/react-native/generated/service/operations/indexers.d.ts.map +1 -1
  619. package/dist/react-native/generated/service/operations/indexers.js +54 -1
  620. package/dist/react-native/generated/service/operations/indexers.js.map +1 -1
  621. package/dist/react-native/generated/service/operations/knowledgeBases.d.ts +43 -0
  622. package/dist/react-native/generated/service/operations/knowledgeBases.d.ts.map +1 -0
  623. package/dist/react-native/generated/service/operations/knowledgeBases.js +160 -0
  624. package/dist/react-native/generated/service/operations/knowledgeBases.js.map +1 -0
  625. package/dist/react-native/generated/service/operations/knowledgeSources.d.ts +49 -0
  626. package/dist/react-native/generated/service/operations/knowledgeSources.d.ts.map +1 -0
  627. package/dist/react-native/generated/service/operations/knowledgeSources.js +184 -0
  628. package/dist/react-native/generated/service/operations/knowledgeSources.js.map +1 -0
  629. package/dist/react-native/generated/service/operations/skillsets.d.ts +8 -1
  630. package/dist/react-native/generated/service/operations/skillsets.d.ts.map +1 -1
  631. package/dist/react-native/generated/service/operations/skillsets.js +30 -1
  632. package/dist/react-native/generated/service/operations/skillsets.js.map +1 -1
  633. package/dist/react-native/generated/service/operationsInterfaces/aliases.d.ts +35 -1
  634. package/dist/react-native/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
  635. package/dist/react-native/generated/service/operationsInterfaces/aliases.js +7 -66
  636. package/dist/react-native/generated/service/operationsInterfaces/aliases.js.map +1 -1
  637. package/dist/react-native/generated/service/operationsInterfaces/index.d.ts +3 -0
  638. package/dist/react-native/generated/service/operationsInterfaces/index.d.ts.map +1 -1
  639. package/dist/react-native/generated/service/operationsInterfaces/index.js +3 -0
  640. package/dist/react-native/generated/service/operationsInterfaces/index.js.map +1 -1
  641. package/dist/react-native/generated/service/operationsInterfaces/indexers.d.ts +14 -1
  642. package/dist/react-native/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
  643. package/dist/react-native/generated/service/operationsInterfaces/indexers.js.map +1 -1
  644. package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
  645. package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
  646. package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.js +9 -0
  647. package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
  648. package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
  649. package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
  650. package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.js +9 -0
  651. package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
  652. package/dist/react-native/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
  653. package/dist/react-native/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
  654. package/dist/react-native/generated/service/operationsInterfaces/skillsets.js.map +1 -1
  655. package/dist/react-native/generated/service/searchServiceClient.d.ts +12 -4
  656. package/dist/react-native/generated/service/searchServiceClient.d.ts.map +1 -1
  657. package/dist/react-native/generated/service/searchServiceClient.js +31 -2
  658. package/dist/react-native/generated/service/searchServiceClient.js.map +1 -1
  659. package/dist/react-native/index.d.ts +7 -4
  660. package/dist/react-native/index.d.ts.map +1 -1
  661. package/dist/react-native/index.js +5 -3
  662. package/dist/react-native/index.js.map +1 -1
  663. package/dist/react-native/indexDocumentsBatch.d.ts +6 -5
  664. package/dist/react-native/indexDocumentsBatch.d.ts.map +1 -1
  665. package/dist/react-native/indexDocumentsBatch.js +5 -4
  666. package/dist/react-native/indexDocumentsBatch.js.map +1 -1
  667. package/dist/react-native/indexModels.d.ts +236 -30
  668. package/dist/react-native/indexModels.d.ts.map +1 -1
  669. package/dist/react-native/indexModels.js.map +1 -1
  670. package/dist/react-native/knowledgeBaseModels.d.ts +44 -0
  671. package/dist/react-native/knowledgeBaseModels.d.ts.map +1 -0
  672. package/dist/react-native/knowledgeBaseModels.js +4 -0
  673. package/dist/react-native/knowledgeBaseModels.js.map +1 -0
  674. package/dist/react-native/knowledgeRetrievalClient.d.ts +68 -0
  675. package/dist/react-native/knowledgeRetrievalClient.d.ts.map +1 -0
  676. package/dist/react-native/knowledgeRetrievalClient.js +108 -0
  677. package/dist/react-native/knowledgeRetrievalClient.js.map +1 -0
  678. package/dist/react-native/odata.d.ts +5 -2
  679. package/dist/react-native/odata.d.ts.map +1 -1
  680. package/dist/react-native/odata.js +5 -2
  681. package/dist/react-native/odata.js.map +1 -1
  682. package/dist/react-native/odataMetadataPolicy.d.ts +1 -1
  683. package/dist/react-native/odataMetadataPolicy.d.ts.map +1 -1
  684. package/dist/react-native/odataMetadataPolicy.js.map +1 -1
  685. package/dist/react-native/searchApiKeyCredentialPolicy.d.ts +4 -4
  686. package/dist/react-native/searchApiKeyCredentialPolicy.d.ts.map +1 -1
  687. package/dist/react-native/searchApiKeyCredentialPolicy.js +2 -2
  688. package/dist/react-native/searchApiKeyCredentialPolicy.js.map +1 -1
  689. package/dist/react-native/searchClient.d.ts +64 -53
  690. package/dist/react-native/searchClient.d.ts.map +1 -1
  691. package/dist/react-native/searchClient.js +113 -53
  692. package/dist/react-native/searchClient.js.map +1 -1
  693. package/dist/react-native/searchIndexClient.d.ts +157 -18
  694. package/dist/react-native/searchIndexClient.d.ts.map +1 -1
  695. package/dist/react-native/searchIndexClient.js +482 -17
  696. package/dist/react-native/searchIndexClient.js.map +1 -1
  697. package/dist/react-native/searchIndexerClient.d.ts +26 -11
  698. package/dist/react-native/searchIndexerClient.d.ts.map +1 -1
  699. package/dist/react-native/searchIndexerClient.js +62 -7
  700. package/dist/react-native/searchIndexerClient.js.map +1 -1
  701. package/dist/react-native/searchIndexingBufferedSender.d.ts +3 -3
  702. package/dist/react-native/searchIndexingBufferedSender.d.ts.map +1 -1
  703. package/dist/react-native/searchIndexingBufferedSender.js +1 -1
  704. package/dist/react-native/searchIndexingBufferedSender.js.map +1 -1
  705. package/dist/react-native/serviceModels.d.ts +1228 -220
  706. package/dist/react-native/serviceModels.d.ts.map +1 -1
  707. package/dist/react-native/serviceModels.js +8 -7
  708. package/dist/react-native/serviceModels.js.map +1 -1
  709. package/dist/react-native/serviceUtils.d.ts +14 -6
  710. package/dist/react-native/serviceUtils.d.ts.map +1 -1
  711. package/dist/react-native/serviceUtils.js +301 -45
  712. package/dist/react-native/serviceUtils.js.map +1 -1
  713. package/dist/react-native/synonymMapHelper.d.ts +1 -1
  714. package/dist/react-native/synonymMapHelper.d.ts.map +1 -1
  715. package/dist/react-native/synonymMapHelper.js +2 -2
  716. package/dist/react-native/synonymMapHelper.js.map +1 -1
  717. package/package.json +13 -9
@@ -1,6 +1,7 @@
1
- import { OperationOptions } from "@azure/core-client";
2
- import { PagedAsyncIterableIterator } from "@azure/core-paging";
3
- import { AsciiFoldingTokenFilter, AzureOpenAIModelName, BaseLexicalNormalizer, BM25Similarity, BinaryQuantizationCompression, CharFilterName, CjkBigramTokenFilter, ClassicSimilarity, ClassicTokenizer, CognitiveServicesAccountKey, CommonGramTokenFilter, ConditionalSkill, CorsOptions, CustomEntity, CustomLexicalNormalizer, DefaultCognitiveServicesAccount, DictionaryDecompounderTokenFilter, DistanceScoringFunction, DocumentExtractionSkill, DocumentIntelligenceLayoutSkill, EdgeNGramTokenFilterSide, EdgeNGramTokenizer, ElisionTokenFilter, EntityLinkingSkill, EntityRecognitionSkillV3, FieldMapping, FreshnessScoringFunction, HighWaterMarkChangeDetectionPolicy, IndexProjectionMode, IndexingSchedule, KeepTokenFilter, KeywordMarkerTokenFilter, KnownBlobIndexerDataToExtract, KnownBlobIndexerImageAction, KnownBlobIndexerPDFTextRotationAlgorithm, KnownBlobIndexerParsingMode, KnownCharFilterName, KnownCustomEntityLookupSkillLanguage, KnownEntityCategory, KnownEntityRecognitionSkillLanguage, KnownImageAnalysisSkillLanguage, KnownImageDetail, KnownIndexerExecutionEnvironment, KnownKeyPhraseExtractionSkillLanguage, KnownLexicalAnalyzerName, KnownLexicalTokenizerName, KnownOcrSkillLanguage, KnownPIIDetectionSkillMaskingMode, KnownRegexFlags, KnownSearchFieldDataType, KnownSearchIndexerDataSourceType, KnownSentimentSkillLanguage, KnownSplitSkillLanguage, KnownTextSplitMode, KnownTextTranslationSkillLanguage, KnownTokenFilterName, KnownVectorSearchAlgorithmKind, KnownVectorSearchAlgorithmMetric, KnownVisualFeature, LanguageDetectionSkill, LengthTokenFilter, LexicalAnalyzerName, LexicalNormalizerName, LexicalTokenizerName, LimitTokenFilter, LuceneStandardAnalyzer, MagnitudeScoringFunction, MappingCharFilter, MergeSkill, MicrosoftLanguageStemmingTokenizer, MicrosoftLanguageTokenizer, NGramTokenizer, PathHierarchyTokenizerV2 as PathHierarchyTokenizer, PatternCaptureTokenFilter, PatternReplaceCharFilter, PatternReplaceTokenFilter, PhoneticTokenFilter, ScalarQuantizationCompression, ScoringFunctionAggregation, SearchIndexerDataContainer, SearchIndexerDataNoneIdentity, SearchIndexerDataUserAssignedIdentity, SearchIndexerIndexProjectionSelector, SearchIndexerKnowledgeStoreProjection, SearchIndexerSkill as BaseSearchIndexerSkill, SemanticSearch, SentimentSkillV3, ServiceCounters, ServiceLimits, ShaperSkill, ShingleTokenFilter, SnowballTokenFilter, SoftDeleteColumnDeletionDetectionPolicy, SqlIntegratedChangeTrackingPolicy, StemmerOverrideTokenFilter, StemmerTokenFilter, StopAnalyzer, StopwordsTokenFilter, Suggester as SearchSuggester, SynonymTokenFilter, TagScoringFunction, TextWeights, TokenFilterName, TruncateTokenFilter, UaxUrlEmailTokenizer, UniqueTokenFilter, VectorEncodingFormat, VectorSearchProfile, VectorSearchVectorizerKind, WordDelimiterTokenFilter } from "./generated/service/models/index.js";
1
+ import type { OperationOptions } from "@azure/core-client";
2
+ import type { PagedAsyncIterableIterator } from "@azure/core-paging";
3
+ import type { AIFoundryModelCatalogName, AIServices, AIServicesAccountKey, AsciiFoldingTokenFilter, AzureMachineLearningSkill, AzureOpenAIModelName, AzureOpenAITokenizerParameters, CognitiveServicesAccount as BaseCognitiveServicesAccount, KnowledgeBaseModel as BaseKnowledgeBaseModel, KnowledgeSourceVectorizer as BaseKnowledgeSourceVectorizer, SearchIndexerSkill as BaseSearchIndexerSkill, BinaryQuantizationCompression, BM25Similarity, CharFilterName, ChatCompletionExtraParametersBehavior, ChatCompletionResponseFormat, CjkBigramTokenFilter, ClassicSimilarity, ClassicTokenizer, CognitiveServicesAccountKey, CommonGramTokenFilter, CommonModelParameters, ConditionalSkill, ContentUnderstandingSkill, CorsOptions, CustomEntity, CustomNormalizer, DefaultCognitiveServicesAccount, DictionaryDecompounderTokenFilter, DistanceScoringFunction, DocumentExtractionSkill, DocumentIntelligenceLayoutSkillChunkingProperties, DocumentIntelligenceLayoutSkillExtractionOptions, DocumentIntelligenceLayoutSkillMarkdownHeaderDepth, DocumentIntelligenceLayoutSkillOutputFormat, DocumentIntelligenceLayoutSkillOutputMode, EdgeNGramTokenFilterSide, EdgeNGramTokenizer, ElisionTokenFilter, EntityLinkingSkill, EntityRecognitionSkillV3, FieldMapping, FreshnessScoringFunction, HighWaterMarkChangeDetectionPolicy, IndexedSharePointContainerName, IndexerPermissionOption, IndexingSchedule, IndexProjectionMode, IndexStatisticsSummary, KeepTokenFilter, KeywordMarkerTokenFilter, KnowledgeSourceContentExtractionMode, KnowledgeSourceIngestionPermissionOption, KnownBlobIndexerDataToExtract, KnownBlobIndexerImageAction, KnownBlobIndexerParsingMode, KnownBlobIndexerPDFTextRotationAlgorithm, KnownCharFilterName, KnownCustomEntityLookupSkillLanguage, KnownEntityCategory, KnownEntityRecognitionSkillLanguage, KnownImageAnalysisSkillLanguage, KnownImageDetail, KnownIndexerExecutionEnvironment, KnownKeyPhraseExtractionSkillLanguage, KnownLexicalAnalyzerName, KnownLexicalTokenizerName, KnownOcrSkillLanguage, KnownPIIDetectionSkillMaskingMode, KnownRegexFlags, KnownSearchFieldDataType, KnownSearchIndexerDataSourceType, KnownSentimentSkillLanguage, KnownSplitSkillLanguage, KnownTextSplitMode, KnownTextTranslationSkillLanguage, KnownTokenFilterName, KnownVectorSearchAlgorithmKind, KnownVectorSearchAlgorithmMetric, KnownVisualFeature, LanguageDetectionSkill, LengthTokenFilter, LexicalAnalyzerName, LexicalNormalizerName, LexicalTokenizerName, LimitTokenFilter, LuceneStandardAnalyzer, MagnitudeScoringFunction, MappingCharFilter, MarkdownHeaderDepth, MarkdownParsingSubmode, MergeSkill, MicrosoftLanguageStemmingTokenizer, MicrosoftLanguageTokenizer, NativeBlobSoftDeleteDeletionDetectionPolicy, NGramTokenizer, OcrLineEnding, PathHierarchyTokenizerV2 as PathHierarchyTokenizer, PatternCaptureTokenFilter, PatternReplaceCharFilter, PatternReplaceTokenFilter, PermissionFilter, PhoneticTokenFilter, RemoteSharePointKnowledgeSourceParameters, ScalarQuantizationCompression, ScoringFunctionAggregation, SearchAlias, SearchIndexerDataContainer, SearchIndexerDataNoneIdentity, SearchIndexerDataUserAssignedIdentity, SearchIndexerIndexProjectionSelector, SearchIndexerKnowledgeStoreProjection, SearchIndexKnowledgeSourceParameters, SearchIndexPermissionFilterOption, Suggester as SearchSuggester, SemanticSearch, SentimentSkillV3, ServiceCounters, ServiceLimits, ShaperSkill, ShingleTokenFilter, SnowballTokenFilter, SoftDeleteColumnDeletionDetectionPolicy, SplitSkillUnit, SqlIntegratedChangeTrackingPolicy, StemmerOverrideTokenFilter, StemmerTokenFilter, StopAnalyzer, StopwordsTokenFilter, SynonymTokenFilter, TagScoringFunction, TextWeights, TokenFilterName, TruncateTokenFilter, UaxUrlEmailTokenizer, UniqueTokenFilter, VectorEncodingFormat, VectorSearchProfile, VectorSearchVectorizerKind, WebKnowledgeSourceParameters, WordDelimiterTokenFilter } from "./generated/service/models/index.js";
4
+ import type { KnowledgeBase } from "./knowledgeBaseModels.js";
4
5
  /**
5
6
  * Options for a list skillsets operation.
6
7
  */
@@ -134,6 +135,10 @@ export type GetAliasOptions = OperationOptions;
134
135
  * Options for list aliases operation.
135
136
  */
136
137
  export type ListAliasesOptions = OperationOptions;
138
+ /**
139
+ * Search Alias object.
140
+ */
141
+ export type SearchIndexAlias = SearchAlias;
137
142
  /**
138
143
  * Options for create synonymmap operation.
139
144
  */
@@ -166,18 +171,27 @@ export interface CreateOrUpdateIndexOptions extends OperationOptions {
166
171
  * Options for reset docs operation.
167
172
  */
168
173
  export interface ResetDocumentsOptions extends OperationOptions {
169
- /** document keys to be reset */
174
+ /**
175
+ * document keys to be reset
176
+ */
170
177
  documentKeys?: string[];
171
- /** datasource document identifiers to be reset */
178
+ /**
179
+ * datasource document identifiers to be reset
180
+ */
172
181
  datasourceDocumentIds?: string[];
173
- /** If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested. */
182
+ /**
183
+ * If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this
184
+ * payload will be queued to be re-ingested.
185
+ */
174
186
  overwrite?: boolean;
175
187
  }
176
188
  /**
177
189
  * Options for reset skills operation.
178
190
  */
179
191
  export interface ResetSkillsOptions extends OperationOptions {
180
- /** the names of skills to be reset. */
192
+ /**
193
+ * the names of skills to be reset.
194
+ */
181
195
  skillNames?: string[];
182
196
  }
183
197
  /**
@@ -188,6 +202,14 @@ export interface CreateOrUpdateSkillsetOptions extends OperationOptions {
188
202
  * If set to true, Resource will be updated only if the etag matches.
189
203
  */
190
204
  onlyIfUnchanged?: boolean;
205
+ /**
206
+ * Ignores cache reset requirements.
207
+ */
208
+ skipIndexerResetRequirementForCache?: boolean;
209
+ /**
210
+ * Disables cache reprocessing change detection.
211
+ */
212
+ disableCacheReprocessingChangeDetection?: boolean;
191
213
  }
192
214
  /**
193
215
  * Options for create/update synonymmap operation.
@@ -206,6 +228,14 @@ export interface CreateorUpdateIndexerOptions extends OperationOptions {
206
228
  * If set to true, Resource will be updated only if the etag matches.
207
229
  */
208
230
  onlyIfUnchanged?: boolean;
231
+ /**
232
+ * Ignores cache reset requirements.
233
+ */
234
+ skipIndexerResetRequirementForCache?: boolean;
235
+ /**
236
+ * Disables cache reprocessing change detection.
237
+ */
238
+ disableCacheReprocessingChangeDetection?: boolean;
209
239
  }
210
240
  /**
211
241
  * Options for create/update datasource operation.
@@ -215,6 +245,10 @@ export interface CreateorUpdateDataSourceConnectionOptions extends OperationOpti
215
245
  * If set to true, Resource will be updated only if the etag matches.
216
246
  */
217
247
  onlyIfUnchanged?: boolean;
248
+ /**
249
+ * Ignores cache reset requirements.
250
+ */
251
+ skipIndexerResetRequirementForCache?: boolean;
218
252
  }
219
253
  /**
220
254
  * Options for delete index operation.
@@ -283,6 +317,11 @@ export interface AnalyzeRequest {
283
317
  * NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
284
318
  */
285
319
  tokenizerName?: LexicalTokenizerName;
320
+ /**
321
+ * The name of the normalizer to use to normalize the given text. {@link KnownNormalizerNames} is
322
+ * an enum containing built-in analyzer names.
323
+ */
324
+ normalizerName?: LexicalNormalizerName;
286
325
  /**
287
326
  * An optional list of token filters to use when breaking the given text. This parameter can only
288
327
  * be set when using the tokenizer parameter.
@@ -349,7 +388,8 @@ export interface CustomAnalyzer {
349
388
  name: string;
350
389
  /**
351
390
  * The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as
352
- * breaking a sentence into words. {@link KnownTokenizerNames} is an enum containing built-in tokenizer names.
391
+ * breaking a sentence into words. {@link KnownTokenizerNames} is an enum containing built-in
392
+ * tokenizer names.
353
393
  */
354
394
  tokenizerName: LexicalTokenizerName;
355
395
  /**
@@ -370,9 +410,39 @@ export interface CustomAnalyzer {
370
410
  */
371
411
  export type LexicalAnalyzer = CustomAnalyzer | PatternAnalyzer | LuceneStandardAnalyzer | StopAnalyzer;
372
412
  /**
373
- * Contains the possible cases for LexicalNormalizer.
413
+ * A skill that calls a language model via Azure AI Foundry's Chat Completions endpoint.
374
414
  */
375
- export type LexicalNormalizer = BaseLexicalNormalizer | CustomLexicalNormalizer;
415
+ export interface ChatCompletionSkill extends WebApiSkill {
416
+ /**
417
+ * Polymorphic discriminator, which specifies the different types this object can be
418
+ */
419
+ odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill";
420
+ /**
421
+ * API key for authenticating to the model. Both apiKey and authIdentity cannot be specified at
422
+ * the same time.
423
+ */
424
+ apiKey?: string;
425
+ /**
426
+ * Common language model parameters that customers can tweak. If omitted, reasonable defaults will
427
+ * be applied.
428
+ */
429
+ commonModelParameters?: CommonModelParameters;
430
+ /**
431
+ * Open-type dictionary for model-specific parameters that should be appended to the chat
432
+ * completions call. Follows Azure AI Foundry’s extensibility pattern.
433
+ */
434
+ extraParameters?: {
435
+ [propertyName: string]: unknown;
436
+ };
437
+ /**
438
+ * How extra parameters are handled by Azure AI Foundry. Default is 'error'.
439
+ */
440
+ extraParametersBehavior?: ChatCompletionExtraParametersBehavior;
441
+ /**
442
+ * Determines how the LLM should format its response. Defaults to 'text' response type.
443
+ */
444
+ responseFormat?: ChatCompletionResponseFormat;
445
+ }
376
446
  /**
377
447
  * A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call
378
448
  * your custom code.
@@ -381,7 +451,7 @@ export interface WebApiSkill extends BaseSearchIndexerSkill {
381
451
  /**
382
452
  * Polymorphic discriminator, which specifies the different types this object can be
383
453
  */
384
- odatatype: "#Microsoft.Skills.Custom.WebApiSkill";
454
+ odatatype: "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.ChatCompletionSkill";
385
455
  /**
386
456
  * The url for the Web API.
387
457
  */
@@ -410,29 +480,95 @@ export interface WebApiSkill extends BaseSearchIndexerSkill {
410
480
  degreeOfParallelism?: number;
411
481
  /**
412
482
  * Applies to custom skills that connect to external code in an Azure function or some other
413
- * application that provides the transformations. This value should be the application ID
414
- * created for the function or app when it was registered with Azure Active Directory. When
415
- * specified, the custom skill connects to the function or app using a managed ID (either system
416
- * or user-assigned) of the search service and the access token of the function or app, using
417
- * this value as the resource id for creating the scope of the access token.
483
+ * application that provides the transformations. This value should be the application ID created
484
+ * for the function or app when it was registered with Azure Active Directory. When specified, the
485
+ * custom skill connects to the function or app using a managed ID (either system or
486
+ * user-assigned) of the search service and the access token of the function or app, using this
487
+ * value as the resource id for creating the scope of the access token.
418
488
  */
419
489
  authResourceId?: string;
420
490
  /**
421
491
  * The user-assigned managed identity used for outbound connections. If an authResourceId is
422
492
  * provided and it's not specified, the system-assigned managed identity is used. On updates to
423
- * the indexer, if the identity is unspecified, the value remains unchanged. If undefined, the
493
+ * the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the
424
494
  * value of this property is cleared.
425
495
  */
426
496
  authIdentity?: SearchIndexerDataIdentity;
427
497
  }
498
+ export type WebApiSkills = WebApiSkill | ChatCompletionSkill;
499
+ /**
500
+ * Allows you to generate a vector embedding for a given image or text input using the Azure AI
501
+ * Services Vision Vectorize API.
502
+ */
503
+ export interface VisionVectorizeSkill extends BaseSearchIndexerSkill {
504
+ /**
505
+ * Polymorphic discriminator, which specifies the different types this object can be
506
+ */
507
+ odatatype: "#Microsoft.Skills.Vision.VectorizeSkill";
508
+ /**
509
+ * The version of the model to use when calling the AI Services Vision service. It will default to
510
+ * the latest available when not specified.
511
+ */
512
+ modelVersion?: string;
513
+ }
428
514
  /**
429
515
  * Contains the possible cases for Skill.
430
516
  */
431
- export type SearchIndexerSkill = AzureOpenAIEmbeddingSkill | ConditionalSkill | CustomEntityLookupSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill | EntityLinkingSkill | EntityRecognitionSkill | EntityRecognitionSkillV3 | ImageAnalysisSkill | KeyPhraseExtractionSkill | LanguageDetectionSkill | MergeSkill | OcrSkill | PIIDetectionSkill | SentimentSkill | SentimentSkillV3 | ShaperSkill | SplitSkill | TextTranslationSkill | WebApiSkill;
517
+ export type SearchIndexerSkill = AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill | ConditionalSkill | CustomEntityLookupSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill | ContentUnderstandingSkill | EntityLinkingSkill | EntityRecognitionSkill | EntityRecognitionSkillV3 | ImageAnalysisSkill | KeyPhraseExtractionSkill | LanguageDetectionSkill | MergeSkill | OcrSkill | PIIDetectionSkill | SentimentSkill | SentimentSkillV3 | ShaperSkill | SplitSkill | TextTranslationSkill | VisionVectorizeSkill | WebApiSkills;
518
+ /**
519
+ * A skill that extracts content and layout information (as markdown), via Azure AI Services, from
520
+ * files within the enrichment pipeline.
521
+ */
522
+ export interface DocumentIntelligenceLayoutSkill extends BaseSearchIndexerSkill {
523
+ /**
524
+ * Polymorphic discriminator, which specifies the different types this object can be
525
+ */
526
+ odatatype: "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill";
527
+ /**
528
+ * Controls the cardinality of the output format. Default is 'markdown'.
529
+ */
530
+ outputFormat?: DocumentIntelligenceLayoutSkillOutputFormat;
531
+ /**
532
+ * Controls the cardinality of the output produced by the skill. Default is 'oneToMany'.
533
+ */
534
+ outputMode?: DocumentIntelligenceLayoutSkillOutputMode;
535
+ /**
536
+ * The depth of headers in the markdown output. Default is h6.
537
+ */
538
+ markdownHeaderDepth?: DocumentIntelligenceLayoutSkillMarkdownHeaderDepth;
539
+ /**
540
+ * Controls the cardinality of the content extracted from the document by the skill
541
+ */
542
+ extractionOptions?: DocumentIntelligenceLayoutSkillExtractionOptions[];
543
+ /**
544
+ * Controls the cardinality for chunking the content.
545
+ */
546
+ chunkingProperties?: DocumentIntelligenceLayoutSkillChunkingProperties;
547
+ }
432
548
  /**
433
549
  * Contains the possible cases for CognitiveServicesAccount.
434
550
  */
435
- export type CognitiveServicesAccount = DefaultCognitiveServicesAccount | CognitiveServicesAccountKey;
551
+ export type CognitiveServicesAccount = DefaultCognitiveServicesAccount | CognitiveServicesAccountKey | AIServicesAccountKey | AIServicesAccountIdentity;
552
+ /**
553
+ * The multi-region account of an Azure AI service resource that's attached to a skillset.
554
+ */
555
+ export interface AIServicesAccountIdentity extends BaseCognitiveServicesAccount {
556
+ /**
557
+ * Polymorphic discriminator, which specifies the different types this object can be
558
+ */
559
+ odatatype: "#Microsoft.Azure.Search.AIServicesByIdentity";
560
+ /**
561
+ * The user-assigned managed identity used for connections to AI Service. If not specified, the
562
+ * system-assigned managed identity is used. On updates to the skillset, if the identity is
563
+ * unspecified, the value remains unchanged. If set to "none", the value of this property is
564
+ * cleared.
565
+ */
566
+ identity?: SearchIndexerDataIdentity;
567
+ /**
568
+ * The subdomain url for the corresponding AI Service.
569
+ */
570
+ subdomainUrl: string;
571
+ }
436
572
  /**
437
573
  * Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is
438
574
  * implemented using Apache Lucene.
@@ -597,6 +733,10 @@ export type TokenFilter = AsciiFoldingTokenFilter | CjkBigramTokenFilter | Commo
597
733
  * Contains the possible cases for CharFilter.
598
734
  */
599
735
  export type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
736
+ /**
737
+ * Contains the possible cases for LexicalNormalizer.
738
+ */
739
+ export type LexicalNormalizer = CustomNormalizer;
600
740
  /**
601
741
  * Contains the possible cases for ScoringFunction.
602
742
  */
@@ -647,9 +787,10 @@ export interface SimpleField {
647
787
  * returned in a search result. You can disable this option if you don't plan to return the field
648
788
  * contents in a search response to save on storage overhead. This can only be set during index
649
789
  * creation and only for vector fields. This property cannot be changed for existing fields or set
650
- * as false for new fields. If this property is set as false, the property 'hidden' must be set to
651
- * 'true'. This property must be true or unset for key fields, for new fields, and for non-vector
652
- * fields. Disabling this property will reduce index storage requirements. The default is true for vector fields.
790
+ * as false for new fields. If this property is set to `false`, the property `hidden` must be set
791
+ * to `true`. This property must be true or unset for key fields, for new fields, and for
792
+ * non-vector fields, and it must be null for complex fields. Disabling this property will reduce
793
+ * index storage requirements. The default is true for vector fields.
653
794
  */
654
795
  stored?: boolean;
655
796
  /**
@@ -657,16 +798,16 @@ export interface SimpleField {
657
798
  * analysis such as word-breaking during indexing. If you set a searchable field to a value like
658
799
  * "sunny day", internally it will be split into the individual tokens "sunny" and "day". This
659
800
  * enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String)
660
- * are searchable by default. This property must be false for simple fields of other non-string
661
- * data types. Note: searchable fields consume extra space
662
- * in your index to accommodate additional tokenized versions of the field value for full-text
663
- * searches. If you want to save space in your index and you don't need a field to be included in
664
- * searches, set searchable to false. Default is false.
801
+ * are searchable by default. This property must be false for simple
802
+ * fields of other non-string data types.
803
+ * Note: searchable fields consume extra space in your index to accommodate additional tokenized
804
+ * versions of the field value for full-text searches. If you want to save space in your index and
805
+ * you don't need a field to be included in searches, set searchable to false. Default is false.
665
806
  */
666
807
  searchable?: boolean;
667
808
  /**
668
- * A value indicating whether to enable the field to be referenced in $filter queries. filterable
669
- * differs from searchable in how strings are handled. Fields of type Edm.String or
809
+ * A value indicating whether to enable the field to be referenced in $filter queries.
810
+ * `filterable` differs from `searchable` in how strings are handled. Fields of type Edm.String or
670
811
  * Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for
671
812
  * exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny'
672
813
  * will find no matches, but $filter=f eq 'sunny day' will. Default is false.
@@ -674,27 +815,30 @@ export interface SimpleField {
674
815
  filterable?: boolean;
675
816
  /**
676
817
  * A value indicating whether to enable the field to be referenced in $orderby expressions. By
677
- * default, the search engine sorts results by score, but in many experiences users will want to
678
- * sort by fields in the documents. A simple field can be sortable only if it is single-valued (it
679
- * has a single value in the scope of the parent document). Simple collection fields cannot be
680
- * sortable, since they are multi-valued. Simple sub-fields of complex collections are also
818
+ * default, the service sorts results by score, but in many experiences users will want
819
+ * to sort by fields in the documents. A simple field can be sortable only if it is single-valued
820
+ * (it has a single value in the scope of the parent document). Simple collection fields cannot
821
+ * be sortable, since they are multi-valued. Simple sub-fields of complex collections are also
681
822
  * multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent
682
823
  * field, or an ancestor field, that's the complex collection. The default is false.
683
- *
684
824
  */
685
825
  sortable?: boolean;
686
826
  /**
687
827
  * A value indicating whether to enable the field to be referenced in facet queries. Typically
688
828
  * used in a presentation of search results that includes hit count by category (for example,
689
- * search for digital cameras and see hits by brand, by megapixels, by price, and so on). Fields
690
- * of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is
691
- * false.
829
+ * search for digital cameras and see hits by brand, by megapixels, by price, and so on).
830
+ * Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable.
831
+ * Default is false for all other simple fields.
692
832
  */
693
833
  facetable?: boolean;
694
834
  /**
695
- * The name of the analyzer to use for the field. This option can be used only with searchable
696
- * fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the
697
- * analyzer is chosen, it cannot be changed for the field.
835
+ * A value indicating whether the field should be used as a permission filter.
836
+ */
837
+ permissionFilter?: PermissionFilter;
838
+ /**
839
+ * The name of the analyzer to use for the field. This option can be used only with
840
+ * searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer.
841
+ * Once the analyzer is chosen, it cannot be changed for the field.
698
842
  */
699
843
  analyzerName?: LexicalAnalyzerName;
700
844
  /**
@@ -706,20 +850,24 @@ export interface SimpleField {
706
850
  */
707
851
  searchAnalyzerName?: LexicalAnalyzerName;
708
852
  /**
709
- * The name of the analyzer used at indexing time for the field. This option can be used only
710
- * with searchable fields. It must be set together with searchAnalyzer and it cannot be set
711
- * together with the analyzer option. This property cannot be set to the name of a language
712
- * analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer
713
- * is chosen, it cannot be changed for the field.
853
+ * The name of the analyzer used at indexing time for the field. This option can be used only with
854
+ * searchable fields. It must be set together with searchAnalyzer and it cannot be set together
855
+ * with the `analyzerName` option. Once the analyzer is chosen, it cannot be changed for the
856
+ * field. KnownAnalyzerNames is an enum containing known values.
714
857
  */
715
858
  indexAnalyzerName?: LexicalAnalyzerName;
716
859
  /**
717
860
  * A list of the names of synonym maps to associate with this field. This option can be used only
718
861
  * with searchable fields. Currently only one synonym map per field is supported. Assigning a
719
- * synonym map to a field ensures that query terms targeting that field are expanded at query-time
720
- * using the rules in the synonym map. This attribute can be changed on existing fields.
862
+ * synonym map to a field ensures that query terms targeting that field are expanded at
863
+ * query-time using the rules in the synonym map. This attribute can be changed on existing
864
+ * fields.
721
865
  */
722
866
  synonymMapNames?: string[];
867
+ /**
868
+ * The name of the normalizer used at indexing time for the field.
869
+ */
870
+ normalizerName?: LexicalNormalizerName;
723
871
  /**
724
872
  * The dimensionality of the vector field.
725
873
  */
@@ -733,11 +881,6 @@ export interface SimpleField {
733
881
  * The encoding format to interpret the field contents.
734
882
  */
735
883
  vectorEncodingFormat?: VectorEncodingFormat;
736
- /** The name of the normalizer to use for the field. This option can be used only with fields with
737
- * filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed
738
- * for the field. Must be null for complex fields.
739
- */
740
- normalizerName?: LexicalNormalizerName;
741
884
  }
742
885
  export declare function isComplexField(field: SearchField): field is ComplexField;
743
886
  /**
@@ -775,8 +918,8 @@ export interface SynonymMap {
775
918
  /**
776
919
  * A description of an encryption key that you create in Azure Key Vault. This key is used to
777
920
  * provide an additional level of encryption-at-rest for your data when you want full assurance
778
- * that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you
779
- * have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore
921
+ * that no one, not even Microsoft, can decrypt your data in Azure AI Search. Once you
922
+ * have encrypted your data, it will always remain encrypted. Azure AI Search will ignore
780
923
  * attempts to set this property to null. You can change this property as needed if you want to
781
924
  * rotate your encryption key; Your data will be unaffected. Encryption with customer-managed
782
925
  * keys is not available for free search services, and is only available for paid services
@@ -794,6 +937,27 @@ export interface SynonymMap {
794
937
  * per iteration.
795
938
  */
796
939
  export type IndexIterator = PagedAsyncIterableIterator<SearchIndex, SearchIndex[], {}>;
940
+ /**
941
+ * An iterator for statistics summaries for each index in the Search service. Will make requests as
942
+ * needed during iteration. Use .byPage() to make one request to the server per iteration.
943
+ */
944
+ export type IndexStatisticsSummaryIterator = PagedAsyncIterableIterator<IndexStatisticsSummary, IndexStatisticsSummary[], {}>;
945
+ /**
946
+ * An iterator for listing the knowledge bases that exist in the Search service. Will make requests
947
+ * as needed during iteration. Use .byPage() to make one request to the server per iteration.
948
+ */
949
+ export type KnowledgeBaseIterator = PagedAsyncIterableIterator<KnowledgeBase, KnowledgeBase[], {}>;
950
+ /**
951
+ * An iterator for listing the knowledge sources that exist in the Search service. Will make requests
952
+ * as needed during iteration. Use .byPage() to make one request to the server per iteration.
953
+ */
954
+ export type KnowledgeSourceIterator = PagedAsyncIterableIterator<KnowledgeSource, KnowledgeSource[], {}>;
955
+ /**
956
+ * An iterator for listing the aliases that exist in the Search service. This will make requests
957
+ * as needed during iteration. Use .byPage() to make one request to the server
958
+ * per iteration.
959
+ */
960
+ export type AliasIterator = PagedAsyncIterableIterator<SearchIndexAlias, SearchIndexAlias[], {}>;
797
961
  /**
798
962
  * An iterator for listing the indexes that exist in the Search service. Will make requests
799
963
  * as needed during iteration. Use .byPage() to make one request to the server
@@ -843,10 +1007,6 @@ export interface SearchIndex {
843
1007
  * The tokenizers for the index.
844
1008
  */
845
1009
  tokenizers?: LexicalTokenizer[];
846
- /**
847
- * The normalizers for the index.
848
- */
849
- normalizers?: LexicalNormalizer[];
850
1010
  /**
851
1011
  * The token filters for the index.
852
1012
  */
@@ -855,11 +1015,15 @@ export interface SearchIndex {
855
1015
  * The character filters for the index.
856
1016
  */
857
1017
  charFilters?: CharFilter[];
1018
+ /**
1019
+ * The normalizers for the index.
1020
+ */
1021
+ normalizers?: LexicalNormalizer[];
858
1022
  /**
859
1023
  * A description of an encryption key that you create in Azure Key Vault. This key is used to
860
1024
  * provide an additional level of encryption-at-rest for your data when you want full assurance
861
- * that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you
862
- * have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore
1025
+ * that no one, not even Microsoft, can decrypt your data in Azure AI Search. Once you
1026
+ * have encrypted your data, it will always remain encrypted. Azure AI Search will ignore
863
1027
  * attempts to set this property to null. You can change this property as needed if you want to
864
1028
  * rotate your encryption key; Your data will be unaffected. Encryption with customer-managed
865
1029
  * keys is not available for free search services, and is only available for paid services
@@ -880,12 +1044,20 @@ export interface SearchIndex {
880
1044
  * Contains configuration options related to vector search.
881
1045
  */
882
1046
  vectorSearch?: VectorSearch;
1047
+ /**
1048
+ * A value indicating whether permission filtering is enabled for the index.
1049
+ */
1050
+ permissionFilterOption?: SearchIndexPermissionFilterOption;
883
1051
  /**
884
1052
  * The ETag of the index.
885
1053
  */
886
1054
  etag?: string;
887
1055
  }
888
1056
  export interface SearchIndexerCache {
1057
+ /**
1058
+ * A guid for the SearchIndexerCache.
1059
+ */
1060
+ id?: string;
889
1061
  /**
890
1062
  * The connection string to the storage account where the cache data will be persisted.
891
1063
  */
@@ -894,7 +1066,8 @@ export interface SearchIndexerCache {
894
1066
  * Specifies whether incremental reprocessing is enabled.
895
1067
  */
896
1068
  enableReprocessing?: boolean;
897
- /** The user-assigned managed identity used for connections to the enrichment cache. If the
1069
+ /**
1070
+ * The user-assigned managed identity used for connections to the enrichment cache. If the
898
1071
  * connection string indicates an identity (ResourceId) and it's not specified, the
899
1072
  * system-assigned managed identity is used. On updates to the indexer, if the identity is
900
1073
  * unspecified, the value remains unchanged. If set to "none", the value of this property is
@@ -955,18 +1128,23 @@ export interface SearchIndexer {
955
1128
  * A description of an encryption key that you create in Azure Key Vault. This key is used to
956
1129
  * provide an additional level of encryption-at-rest for your indexer definition (as well as
957
1130
  * indexer execution status) when you want full assurance that no one, not even Microsoft, can
958
- * decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it
959
- * will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property
1131
+ * decrypt them in Azure AI Search. Once you have encrypted your indexer definition, it
1132
+ * will always remain encrypted. Azure AI Search will ignore attempts to set this property
960
1133
  * to null. You can change this property as needed if you want to rotate your encryption key;
961
1134
  * Your indexer definition (and indexer execution status) will be unaffected. Encryption with
962
1135
  * customer-managed keys is not available for free search services, and is only available for
963
1136
  * paid services created on or after January 1, 2019.
964
1137
  */
965
1138
  encryptionKey?: SearchResourceEncryptionKey;
1139
+ /**
1140
+ * Adds caching to an enrichment pipeline to allow for incremental modification steps without
1141
+ * having to rebuild the index every time.
1142
+ */
1143
+ cache?: SearchIndexerCache;
966
1144
  }
967
1145
  /**
968
1146
  * A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be
969
- * used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym
1147
+ * used to encrypt or decrypt data-at-rest in Azure AI Search, such as indexes and synonym
970
1148
  * maps.
971
1149
  */
972
1150
  export interface SearchResourceEncryptionKey {
@@ -977,7 +1155,7 @@ export interface SearchResourceEncryptionKey {
977
1155
  /**
978
1156
  * The version of your Azure Key Vault key to be used to encrypt your data at rest.
979
1157
  */
980
- keyVersion: string;
1158
+ keyVersion?: string;
981
1159
  /**
982
1160
  * The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be
983
1161
  * used to encrypt your data at rest. An example URI might be
@@ -1038,8 +1216,8 @@ export interface SearchIndexerSkillset {
1038
1216
  * A description of an encryption key that you create in Azure Key Vault. This key is used to
1039
1217
  * provide an additional level of encryption-at-rest for your skillset definition when you want
1040
1218
  * full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure
1041
- * Cognitive Search. Once you have encrypted your skillset definition, it will always remain
1042
- * encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can
1219
+ * AI Search. Once you have encrypted your skillset definition, it will always remain
1220
+ * encrypted. Azure AI Search will ignore attempts to set this property to null. You can
1043
1221
  * change this property as needed if you want to rotate your encryption key; Your skillset
1044
1222
  * definition will be unaffected. Encryption with customer-managed keys is not available for free
1045
1223
  * search services, and is only available for paid services created on or after January 1, 2019.
@@ -1288,7 +1466,7 @@ export declare enum KnownTokenFilterNames {
1288
1466
  SoraniNormalization = "sorani_normalization",
1289
1467
  /**
1290
1468
  * Language specific stemming filter. See
1291
- * https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters
1469
+ * https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters
1292
1470
  */
1293
1471
  Stemmer = "stemmer",
1294
1472
  /**
@@ -1334,7 +1512,7 @@ export declare enum KnownCharFilterNames {
1334
1512
  }
1335
1513
  /**
1336
1514
  * Defines values for AnalyzerName.
1337
- * See https://docs.microsoft.com/rest/api/searchservice/Language-support
1515
+ * See https://learn.microsoft.com/rest/api/searchservice/Language-support
1338
1516
  * @readonly
1339
1517
  */
1340
1518
  export declare enum KnownAnalyzerNames {
@@ -1682,15 +1860,18 @@ export declare enum KnownAnalyzerNames {
1682
1860
  */
1683
1861
  ViMicrosoft = "vi.microsoft",
1684
1862
  /**
1685
- * See: https://lucene.apache.org/core/6_6_1/core/org/apache/lucene/analysis/standard/StandardAnalyzer.html
1863
+ * See:
1864
+ * https://lucene.apache.org/core/6_6_1/core/org/apache/lucene/analysis/standard/StandardAnalyzer.html
1686
1865
  */
1687
1866
  StandardLucene = "standard.lucene",
1688
1867
  /**
1689
- * See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html
1868
+ * See
1869
+ * https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html
1690
1870
  */
1691
1871
  StandardAsciiFoldingLucene = "standardasciifolding.lucene",
1692
1872
  /**
1693
- * Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names.
1873
+ * Treats the entire content of a field as a single token. This is useful for data like zip codes,
1874
+ * ids, and some product names.
1694
1875
  */
1695
1876
  Keyword = "keyword",
1696
1877
  /**
@@ -1721,7 +1902,7 @@ export type SearchIndexerDataIdentity = SearchIndexerDataNoneIdentity | SearchIn
1721
1902
  /**
1722
1903
  * Contains the possible cases for DataDeletionDetectionPolicy.
1723
1904
  */
1724
- export type DataDeletionDetectionPolicy = SoftDeleteColumnDeletionDetectionPolicy;
1905
+ export type DataDeletionDetectionPolicy = SoftDeleteColumnDeletionDetectionPolicy | NativeBlobSoftDeleteDeletionDetectionPolicy;
1725
1906
  /**
1726
1907
  * Represents a datasource definition, which can be used to configure an indexer.
1727
1908
  */
@@ -1739,6 +1920,11 @@ export interface SearchIndexerDataSourceConnection {
1739
1920
  * 'AzureTable', 'MySql', 'AdlsGen2'
1740
1921
  */
1741
1922
  type: SearchIndexerDataSourceType;
1923
+ /**
1924
+ * A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts.
1925
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1926
+ */
1927
+ readonly subType?: string;
1742
1928
  /**
1743
1929
  * The connection string for the datasource.
1744
1930
  */
@@ -1753,6 +1939,10 @@ export interface SearchIndexerDataSourceConnection {
1753
1939
  * the value remains unchanged. If "none" is specified, the value of this property is cleared.
1754
1940
  */
1755
1941
  identity?: SearchIndexerDataIdentity;
1942
+ /**
1943
+ * Ingestion options with various types of permission data.
1944
+ */
1945
+ indexerPermissionOptions?: IndexerPermissionOption[];
1756
1946
  /**
1757
1947
  * The data change detection policy for the datasource.
1758
1948
  */
@@ -1769,8 +1959,8 @@ export interface SearchIndexerDataSourceConnection {
1769
1959
  * A description of an encryption key that you create in Azure Key Vault. This key is used to
1770
1960
  * provide an additional level of encryption-at-rest for your datasource definition when you want
1771
1961
  * full assurance that no one, not even Microsoft, can decrypt your data source definition in
1772
- * Azure Cognitive Search. Once you have encrypted your data source definition, it will always
1773
- * remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null.
1962
+ * Azure AI Search. Once you have encrypted your data source definition, it will always
1963
+ * remain encrypted. Azure AI Search will ignore attempts to set this property to null.
1774
1964
  * You can change this property as needed if you want to rotate your encryption key; Your
1775
1965
  * datasource definition will be unaffected. Encryption with customer-managed keys is not
1776
1966
  * available for free search services, and is only available for paid services created on or
@@ -1778,24 +1968,43 @@ export interface SearchIndexerDataSourceConnection {
1778
1968
  */
1779
1969
  encryptionKey?: SearchResourceEncryptionKey;
1780
1970
  }
1781
- /** Contains configuration options related to vector search. */
1971
+ /**
1972
+ * Contains configuration options related to vector search.
1973
+ */
1782
1974
  export interface VectorSearch {
1783
- /** Defines combinations of configurations to use with vector search. */
1975
+ /**
1976
+ * Defines combinations of configurations to use with vector search.
1977
+ */
1784
1978
  profiles?: VectorSearchProfile[];
1785
- /** Contains configuration options specific to the algorithm used during indexing or querying. */
1979
+ /**
1980
+ * Contains configuration options specific to the algorithm used during indexing and/or querying.
1981
+ */
1786
1982
  algorithms?: VectorSearchAlgorithmConfiguration[];
1787
- /** Contains configuration options on how to vectorize text vector queries. */
1983
+ /**
1984
+ * Contains configuration options on how to vectorize text vector queries.
1985
+ */
1788
1986
  vectorizers?: VectorSearchVectorizer[];
1789
- /** Contains configuration options specific to the compression method used during indexing or querying. */
1987
+ /**
1988
+ * Contains configuration options specific to the compression method used during indexing or
1989
+ * querying.
1990
+ */
1790
1991
  compressions?: VectorSearchCompression[];
1791
1992
  }
1792
- /** Contains configuration options specific to the algorithm used during indexing and/or querying. */
1993
+ /**
1994
+ * Contains configuration options specific to the algorithm used during indexing and/or querying.
1995
+ */
1793
1996
  export type VectorSearchAlgorithmConfiguration = HnswAlgorithmConfiguration | ExhaustiveKnnAlgorithmConfiguration;
1794
- /** Contains configuration options specific to the algorithm used during indexing and/or querying. */
1997
+ /**
1998
+ * Contains configuration options specific to the algorithm used during indexing and/or querying.
1999
+ */
1795
2000
  export interface BaseVectorSearchAlgorithmConfiguration {
1796
- /** Polymorphic discriminator, which specifies the different types this object can be */
2001
+ /**
2002
+ * Polymorphic discriminator, which specifies the different types this object can be
2003
+ */
1797
2004
  kind: VectorSearchAlgorithmKind;
1798
- /** The name to associate with this particular configuration. */
2005
+ /**
2006
+ * The name to associate with this particular configuration.
2007
+ */
1799
2008
  name: string;
1800
2009
  }
1801
2010
  /**
@@ -1841,162 +2050,479 @@ export interface HnswParameters {
1841
2050
  */
1842
2051
  metric?: VectorSearchAlgorithmMetric;
1843
2052
  }
1844
- /** Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index. */
2053
+ /**
2054
+ * Contains configuration options specific to the exhaustive KNN algorithm used during querying,
2055
+ * which will perform brute-force search across the entire vector index.
2056
+ */
1845
2057
  export type ExhaustiveKnnAlgorithmConfiguration = BaseVectorSearchAlgorithmConfiguration & {
1846
- /** Polymorphic discriminator, which specifies the different types this object can be */
2058
+ /**
2059
+ * Polymorphic discriminator, which specifies the different types this object can be
2060
+ */
1847
2061
  kind: "exhaustiveKnn";
1848
- /** Contains the parameters specific to exhaustive KNN algorithm. */
2062
+ /**
2063
+ * Contains the parameters specific to exhaustive KNN algorithm.
2064
+ */
1849
2065
  parameters?: ExhaustiveKnnParameters;
1850
2066
  };
1851
- /** Contains the parameters specific to exhaustive KNN algorithm. */
2067
+ /**
2068
+ * Contains the parameters specific to exhaustive KNN algorithm.
2069
+ */
1852
2070
  export interface ExhaustiveKnnParameters {
1853
- /** The similarity metric to use for vector comparisons. */
2071
+ /**
2072
+ * The similarity metric to use for vector comparisons.
2073
+ */
1854
2074
  metric?: VectorSearchAlgorithmMetric;
1855
2075
  }
1856
- /** A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
2076
+ /**
2077
+ * A dictionary of index projection-specific configuration properties. Each name is the name of a
2078
+ * specific property. Each value must be of a primitive type.
2079
+ */
1857
2080
  export interface SearchIndexerIndexProjectionParameters {
1858
- /** Describes unknown properties.*/
2081
+ /**
2082
+ * Describes unknown properties.
2083
+ */
1859
2084
  [property: string]: unknown;
1860
- /** Defines behavior of the index projections in relation to the rest of the indexer. */
2085
+ /**
2086
+ * Defines behavior of the index projections in relation to the rest of the indexer.
2087
+ */
1861
2088
  projectionMode?: IndexProjectionMode;
1862
2089
  }
1863
- /** Definition of additional projections to secondary search indexes. */
2090
+ /**
2091
+ * Definition of additional projections to secondary search indexes.
2092
+ */
1864
2093
  export interface SearchIndexerIndexProjection {
1865
- /** A list of projections to be performed to secondary search indexes. */
2094
+ /**
2095
+ * A list of projections to be performed to secondary search indexes.
2096
+ */
1866
2097
  selectors: SearchIndexerIndexProjectionSelector[];
1867
- /** A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
2098
+ /**
2099
+ * A dictionary of index projection-specific configuration properties. Each name is the name of a
2100
+ * specific property. Each value must be of a primitive type.
2101
+ */
1868
2102
  parameters?: SearchIndexerIndexProjectionParameters;
1869
2103
  }
1870
- /** Contains specific details for a vectorization method to be used during query time. */
2104
+ /**
2105
+ * Contains specific details for a vectorization method to be used during query time.
2106
+ */
1871
2107
  export interface BaseVectorSearchVectorizer {
1872
- /** Polymorphic discriminator, which specifies the different types this object can be */
2108
+ /**
2109
+ * Polymorphic discriminator, which specifies the different types this object can be
2110
+ */
1873
2111
  kind: VectorSearchVectorizerKind;
1874
- /** The name to associate with this particular vectorization method. */
2112
+ /**
2113
+ * The name to associate with this particular vectorization method.
2114
+ */
1875
2115
  vectorizerName: string;
1876
2116
  }
1877
- /** Contains the parameters specific to using an Azure Open AI service for vectorization at query time. */
2117
+ /**
2118
+ * Contains the parameters specific to using an Azure Open AI service for vectorization at query
2119
+ * time.
2120
+ */
1878
2121
  export interface AzureOpenAIVectorizer extends BaseVectorSearchVectorizer {
1879
- /** Polymorphic discriminator, which specifies the different types this object can be */
2122
+ /**
2123
+ * Polymorphic discriminator, which specifies the different types this object can be
2124
+ */
1880
2125
  kind: "azureOpenAI";
1881
- /** Contains the parameters specific to Azure Open AI embedding vectorization. */
2126
+ /**
2127
+ * Contains the parameters specific to Azure Open AI embedding vectorization.
2128
+ */
1882
2129
  parameters?: AzureOpenAIParameters;
1883
2130
  }
1884
- /** Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset. */
2131
+ /**
2132
+ * Specifies a user-defined vectorizer for generating the vector embedding of a query string.
2133
+ * Integration of an external vectorizer is achieved using the custom Web API interface of a
2134
+ * skillset.
2135
+ */
1885
2136
  export interface WebApiVectorizer extends BaseVectorSearchVectorizer {
1886
- /** Polymorphic discriminator, which specifies the different types this object can be */
2137
+ /**
2138
+ * Polymorphic discriminator, which specifies the different types this object can be
2139
+ */
1887
2140
  kind: "customWebApi";
1888
- /** Specifies the properties of the user-defined vectorizer. */
2141
+ /**
2142
+ * Specifies the properties of the user-defined vectorizer.
2143
+ */
1889
2144
  parameters?: WebApiParameters;
1890
2145
  }
1891
- /** Specifies the properties for connecting to a user-defined vectorizer. */
2146
+ /**
2147
+ * Specifies the properties for connecting to a user-defined vectorizer.
2148
+ */
1892
2149
  export interface WebApiParameters {
1893
- /** The URI of the Web API providing the vectorizer. */
2150
+ /**
2151
+ * The URI of the Web API providing the vectorizer.
2152
+ */
1894
2153
  uri?: string;
1895
- /** The headers required to make the HTTP request. */
2154
+ /**
2155
+ * The headers required to make the HTTP request.
2156
+ */
1896
2157
  httpHeaders?: {
1897
2158
  [propertyName: string]: string;
1898
2159
  };
1899
- /** The method for the HTTP request. */
2160
+ /**
2161
+ * The method for the HTTP request.
2162
+ */
1900
2163
  httpMethod?: string;
1901
- /** The desired timeout for the request. Default is 30 seconds. */
2164
+ /**
2165
+ * The desired timeout for the request. Default is 30 seconds.
2166
+ */
1902
2167
  timeout?: string;
1903
- /** Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token. */
2168
+ /**
2169
+ * Applies to custom endpoints that connect to external code in an Azure function or some other
2170
+ * application that provides the transformations. This value should be the application ID created
2171
+ * for the function or app when it was registered with Azure Active Directory. When specified, the
2172
+ * vectorization connects to the function or app using a managed ID (either system or
2173
+ * user-assigned) of the search service and the access token of the function or app, using this
2174
+ * value as the resource id for creating the scope of the access token.
2175
+ */
1904
2176
  authResourceId?: string;
1905
- /** The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. */
2177
+ /**
2178
+ * The user-assigned managed identity used for outbound connections. If an authResourceId is
2179
+ * provided and it's not specified, the system-assigned managed identity is used. On updates to
2180
+ * the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the
2181
+ * value of this property is cleared.
2182
+ */
1906
2183
  authIdentity?: SearchIndexerDataIdentity;
1907
2184
  }
1908
- /** Contains configuration options on how to vectorize text vector queries. */
1909
- export type VectorSearchVectorizer = AzureOpenAIVectorizer | WebApiVectorizer;
1910
- /** Contains the parameters specific to using an Azure Open AI service for vectorization at query time. */
1911
- export interface AzureOpenAIParameters {
1912
- /** The resource uri for your Azure Open AI resource. */
1913
- resourceUrl?: string;
1914
- /** ID of your Azure Open AI model deployment on the designated resource. */
1915
- deploymentId?: string;
1916
- /** API key for the designated Azure Open AI resource. */
2185
+ /**
2186
+ * Contains configuration options on how to vectorize text vector queries.
2187
+ */
2188
+ export type VectorSearchVectorizer = AIServicesVisionVectorizer | AzureMachineLearningVectorizer | AzureOpenAIVectorizer | WebApiVectorizer;
2189
+ /**
2190
+ * Specifies the AI Services Vision parameters for vectorizing a query image or text.
2191
+ */
2192
+ export interface AIServicesVisionVectorizer extends BaseVectorSearchVectorizer {
2193
+ /**
2194
+ * Polymorphic discriminator, which specifies the different types this object can be
2195
+ */
2196
+ kind: "aiServicesVision";
2197
+ /**
2198
+ * Contains the parameters specific to AI Services Vision embedding vectorization.
2199
+ */
2200
+ parameters?: AIServicesVisionParameters;
2201
+ }
2202
+ /**
2203
+ * Specifies the AI Services Vision parameters for vectorizing a query image or text.
2204
+ */
2205
+ export interface AIServicesVisionParameters {
2206
+ /**
2207
+ * The version of the model to use when calling the AI Services Vision service. It will default to
2208
+ * the latest available when not specified.
2209
+ */
2210
+ modelVersion?: string;
2211
+ /**
2212
+ * The resource URI of the AI Services resource.
2213
+ */
2214
+ resourceUri: string;
2215
+ /**
2216
+ * API key of the designated AI Services resource.
2217
+ */
1917
2218
  apiKey?: string;
1918
- /** The user-assigned managed identity used for outbound connections. */
2219
+ /**
2220
+ * The user-assigned managed identity used for outbound connections. If an authResourceId is
2221
+ * provided and it's not specified, the system-assigned managed identity is used. On updates to
2222
+ * the index, if the identity is unspecified, the value remains unchanged. If set to "none", the
2223
+ * value of this property is cleared.
2224
+ */
1919
2225
  authIdentity?: SearchIndexerDataIdentity;
1920
- /** The name of the embedding model that is deployed at the provided deploymentId path. */
1921
- modelName?: AzureOpenAIModelName;
1922
- }
1923
- /** Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource. */
1924
- export interface AzureOpenAIEmbeddingSkill extends BaseSearchIndexerSkill, AzureOpenAIParameters {
1925
- /** Polymorphic discriminator, which specifies the different types this object can be */
1926
- odatatype: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
1927
- /** The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models. */
1928
- dimensions?: number;
1929
2226
  }
1930
- /** A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
1931
- export interface SearchIndexerKnowledgeStoreParameters {
1932
- /** Describes unknown properties. The value of an unknown property can be of "any" type. */
1933
- [property: string]: unknown;
1934
- /** Whether or not projections should synthesize a generated key name if one isn't already present. */
1935
- synthesizeGeneratedKeyName?: boolean;
2227
+ /**
2228
+ * Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog for
2229
+ * generating the vector embedding of a query string.
2230
+ */
2231
+ export interface AzureMachineLearningVectorizer extends BaseVectorSearchVectorizer {
2232
+ /**
2233
+ * Polymorphic discriminator, which specifies the different types this object can be
2234
+ */
2235
+ kind: "aml";
2236
+ /**
2237
+ * Specifies the properties of the AML vectorizer.
2238
+ */
2239
+ amlParameters?: AzureMachineLearningVectorizerParameters;
1936
2240
  }
1937
- /** A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
1938
- export interface IndexingParametersConfiguration {
1939
- /** Describes unknown properties. The value of an unknown property can be of "any" type. */
1940
- [property: string]: any;
1941
- /** Represents the parsing mode for indexing from an Azure blob data source. */
1942
- parsingMode?: BlobIndexerParsingMode;
1943
- /** Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. */
1944
- excludedFileNameExtensions?: string;
1945
- /** Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. */
1946
- indexedFileNameExtensions?: string;
1947
- /** For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. */
1948
- failOnUnsupportedContentType?: boolean;
1949
- /** For Azure blobs, set to false if you want to continue indexing if a document fails indexing. */
2241
+ /**
2242
+ * Specifies the properties for connecting to an AML vectorizer.
2243
+ */
2244
+ export type AzureMachineLearningVectorizerParameters = NoAuthAzureMachineLearningVectorizerParameters | KeyAuthAzureMachineLearningVectorizerParameters | TokenAuthAzureMachineLearningVectorizerParameters;
2245
+ /**
2246
+ * Specifies the properties common between all AML vectorizer auth types.
2247
+ */
2248
+ export interface BaseAzureMachineLearningVectorizerParameters {
2249
+ /**
2250
+ * When specified, indicates the timeout for the http client making the API call.
2251
+ */
2252
+ timeout?: string;
2253
+ /**
2254
+ * The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the
2255
+ * provided endpoint.
2256
+ */
2257
+ modelName?: AIFoundryModelCatalogName;
2258
+ }
2259
+ /**
2260
+ * Specifies the properties for connecting to an AML vectorizer with no authentication.
2261
+ */
2262
+ export interface NoAuthAzureMachineLearningVectorizerParameters extends BaseAzureMachineLearningVectorizerParameters {
2263
+ /**
2264
+ * Indicates how the service should attempt to identify itself to the AML instance
2265
+ */
2266
+ authKind: "none";
2267
+ /**
2268
+ * The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI
2269
+ * scheme is allowed.
2270
+ */
2271
+ scoringUri: string;
2272
+ }
2273
+ /**
2274
+ * Specifies the properties for connecting to an AML vectorizer with an authentication key.
2275
+ */
2276
+ export interface KeyAuthAzureMachineLearningVectorizerParameters extends BaseAzureMachineLearningVectorizerParameters {
2277
+ /**
2278
+ * Indicates how the service should attempt to identify itself to the AML instance
2279
+ */
2280
+ authKind: "key";
2281
+ /**
2282
+ * The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI
2283
+ * scheme is allowed.
2284
+ */
2285
+ scoringUri: string;
2286
+ /**
2287
+ * The key for the AML service.
2288
+ */
2289
+ authenticationKey: string;
2290
+ }
2291
+ /**
2292
+ * Specifies the properties for connecting to an AML vectorizer with a managed identity.
2293
+ */
2294
+ export interface TokenAuthAzureMachineLearningVectorizerParameters extends BaseAzureMachineLearningVectorizerParameters {
2295
+ /**
2296
+ * Indicates how the service should attempt to identify itself to the AML instance
2297
+ */
2298
+ authKind: "token";
2299
+ /**
2300
+ * The Azure Resource Manager resource ID of the AML service. It should be in the format
2301
+ * subscriptions/\{guid\}/resourceGroups/\{resource-group-name\}/Microsoft.MachineLearningServices/workspaces/\{workspace-name\}/services/\{service_name\}.
2302
+ */
2303
+ resourceId: string;
2304
+ /**
2305
+ * The region the AML service is deployed in.
2306
+ */
2307
+ region?: string;
2308
+ }
2309
+ /**
2310
+ * Specifies the parameters for connecting to the Azure OpenAI resource.
2311
+ */
2312
+ export interface AzureOpenAIParameters {
2313
+ /**
2314
+ * The resource URI of the Azure OpenAI resource.
2315
+ */
2316
+ resourceUrl?: string;
2317
+ /**
2318
+ * ID of the Azure OpenAI model deployment on the designated resource.
2319
+ */
2320
+ deploymentId?: string;
2321
+ /**
2322
+ * API key of the designated Azure OpenAI resource.
2323
+ */
2324
+ apiKey?: string;
2325
+ /**
2326
+ * The user-assigned managed identity used for outbound connections.
2327
+ */
2328
+ authIdentity?: SearchIndexerDataIdentity;
2329
+ /**
2330
+ * The name of the embedding model that is deployed at the provided deploymentId path.
2331
+ */
2332
+ modelName?: AzureOpenAIModelName;
2333
+ }
2334
+ /**
2335
+ * Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource.
2336
+ */
2337
+ export interface AzureOpenAIEmbeddingSkill extends BaseSearchIndexerSkill, AzureOpenAIParameters {
2338
+ /**
2339
+ * Polymorphic discriminator, which specifies the different types this object can be
2340
+ */
2341
+ odatatype: "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
2342
+ /**
2343
+ * The number of dimensions the resulting output embeddings should have. Only supported in
2344
+ * text-embedding-3 and later models.
2345
+ */
2346
+ dimensions?: number;
2347
+ }
2348
+ /**
2349
+ * A dictionary of knowledge store-specific configuration properties. Each name is the name of a
2350
+ * specific property. Each value must be of a primitive type.
2351
+ */
2352
+ export interface SearchIndexerKnowledgeStoreParameters {
2353
+ /**
2354
+ * Describes unknown properties. The value of an unknown property can be of "any" type.
2355
+ */
2356
+ [property: string]: unknown;
2357
+ /**
2358
+ * Whether or not projections should synthesize a generated key name if one isn't already present.
2359
+ */
2360
+ synthesizeGeneratedKeyName?: boolean;
2361
+ }
2362
+ /**
2363
+ * A dictionary of indexer-specific configuration properties. Each name is the name of a specific
2364
+ * property. Each value must be of a primitive type.
2365
+ */
2366
+ export interface IndexingParametersConfiguration {
2367
+ /**
2368
+ * Describes unknown properties. The value of an unknown property can be of "any" type.
2369
+ */
2370
+ [property: string]: any;
2371
+ /**
2372
+ * Represents the parsing mode for indexing from an Azure blob data source.
2373
+ */
2374
+ parsingMode?: BlobIndexerParsingMode;
2375
+ /**
2376
+ * Comma-delimited list of filename extensions to ignore when processing from Azure blob storage.
2377
+ * For example, you could exclude ".png, .mp4" to skip over those files during indexing.
2378
+ */
2379
+ excludedFileNameExtensions?: string;
2380
+ /**
2381
+ * Comma-delimited list of filename extensions to select when processing from Azure blob storage.
2382
+ * For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to
2383
+ * specifically include those file types.
2384
+ */
2385
+ indexedFileNameExtensions?: string;
2386
+ /**
2387
+ * For Azure blobs, set to false if you want to continue indexing when an unsupported content type
2388
+ * is encountered, and you don't know all the content types (file extensions) in advance.
2389
+ */
2390
+ failOnUnsupportedContentType?: boolean;
2391
+ /**
2392
+ * For Azure blobs, set to false if you want to continue indexing if a document fails indexing.
2393
+ */
1950
2394
  failOnUnprocessableDocument?: boolean;
1951
- /** For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity. */
2395
+ /**
2396
+ * For Azure blobs, set this property to true to still index storage metadata for blob content
2397
+ * that is too large to process. Oversized blobs are treated as errors by default. For limits on
2398
+ * blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity.
2399
+ */
1952
2400
  indexStorageMetadataOnlyForOversizedDocuments?: boolean;
1953
- /** For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. */
2401
+ /**
2402
+ * For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source
2403
+ * fields to destination fields in an index.
2404
+ */
1954
2405
  delimitedTextHeaders?: string;
1955
- /** For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). */
2406
+ /**
2407
+ * For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each
2408
+ * line starts a new document (for example, "|").
2409
+ */
1956
2410
  delimitedTextDelimiter?: string;
1957
- /** For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. */
2411
+ /**
2412
+ * For CSV blobs, indicates that the first (non-blank) line of each blob contains headers.
2413
+ */
1958
2414
  firstLineContainsHeaders?: boolean;
1959
- /** For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. */
2415
+ /**
2416
+ * Specifies the submode that will determine whether a markdown file will be parsed into exactly
2417
+ * one search document or multiple search documents. Default is `oneToMany`.
2418
+ */
2419
+ markdownParsingSubmode?: MarkdownParsingSubmode;
2420
+ /**
2421
+ * Specifies the max header depth that will be considered while grouping markdown content. Default
2422
+ * is `h6`.
2423
+ */
2424
+ markdownHeaderDepth?: MarkdownHeaderDepth;
2425
+ /**
2426
+ * For JSON arrays, given a structured or semi-structured document, you can specify a path to the
2427
+ * array using this property.
2428
+ */
1960
2429
  documentRoot?: string;
1961
- /** Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. */
2430
+ /**
2431
+ * Specifies the data to extract from Azure blob storage and tells the indexer which data to
2432
+ * extract from image content when "imageAction" is set to a value other than "none". This
2433
+ * applies to embedded image content in a .PDF or other application, or image files such as .jpg
2434
+ * and .png, in Azure blobs.
2435
+ */
1962
2436
  dataToExtract?: BlobIndexerDataToExtract;
1963
- /** Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. */
2437
+ /**
2438
+ * Determines how to process embedded images and image files in Azure blob storage. Setting the
2439
+ * "imageAction" configuration to any value other than "none" requires that a skillset also be
2440
+ * attached to that indexer.
2441
+ */
1964
2442
  imageAction?: BlobIndexerImageAction;
1965
- /** If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. */
2443
+ /**
2444
+ * If true, will create a path //document//file_data that is an object representing the original
2445
+ * file data downloaded from your blob data source. This allows you to pass the original file
2446
+ * data to a custom skill for processing within the enrichment pipeline, or to the Document
2447
+ * Extraction skill.
2448
+ */
1966
2449
  allowSkillsetToReadFileData?: boolean;
1967
- /** Determines algorithm for text extraction from PDF files in Azure blob storage. */
2450
+ /**
2451
+ * Determines algorithm for text extraction from PDF files in Azure blob storage.
2452
+ */
1968
2453
  pdfTextRotationAlgorithm?: BlobIndexerPDFTextRotationAlgorithm;
1969
- /** Specifies the environment in which the indexer should execute. */
2454
+ /**
2455
+ * Specifies the environment in which the indexer should execute.
2456
+ */
1970
2457
  executionEnvironment?: IndexerExecutionEnvironment;
1971
- /** Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". */
2458
+ /**
2459
+ * Increases the timeout beyond the 5-minute default for Azure SQL database data sources,
2460
+ * specified in the format "hh:mm:ss".
2461
+ */
1972
2462
  queryTimeout?: string;
1973
2463
  }
1974
- /** Represents parameters for indexer execution. */
2464
+ /**
2465
+ * Represents parameters for indexer execution.
2466
+ */
1975
2467
  export interface IndexingParameters {
1976
- /** The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. */
2468
+ /**
2469
+ * The number of items that are read from the data source and indexed as a single batch in order
2470
+ * to improve performance. The default depends on the data source type.
2471
+ */
1977
2472
  batchSize?: number;
1978
- /** The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. */
2473
+ /**
2474
+ * The maximum number of items that can fail indexing for indexer execution to still be considered
2475
+ * successful. -1 means no limit. Default is 0.
2476
+ */
1979
2477
  maxFailedItems?: number;
1980
- /** The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. */
2478
+ /**
2479
+ * The maximum number of items in a single batch that can fail indexing for the batch to still be
2480
+ * considered successful. -1 means no limit. Default is 0.
2481
+ */
1981
2482
  maxFailedItemsPerBatch?: number;
1982
- /** A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. */
2483
+ /**
2484
+ * A dictionary of indexer-specific configuration properties. Each name is the name of a specific
2485
+ * property. Each value must be of a primitive type.
2486
+ */
1983
2487
  configuration?: IndexingParametersConfiguration;
1984
2488
  }
1985
- /** A skill looks for text from a custom, user-defined list of words and phrases. */
2489
+ /**
2490
+ * A skill looks for text from a custom, user-defined list of words and phrases.
2491
+ */
1986
2492
  export interface CustomEntityLookupSkill extends BaseSearchIndexerSkill {
1987
- /** Polymorphic discriminator, which specifies the different types this object can be */
2493
+ /**
2494
+ * Polymorphic discriminator, which specifies the different types this object can be
2495
+ */
1988
2496
  odatatype: "#Microsoft.Skills.Text.CustomEntityLookupSkill";
1989
- /** A value indicating which language code to use. Default is en. */
2497
+ /**
2498
+ * A value indicating which language code to use. Default is en.
2499
+ */
1990
2500
  defaultLanguageCode?: CustomEntityLookupSkillLanguage;
1991
- /** Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS. */
2501
+ /**
2502
+ * Path to a JSON or CSV file containing all the target text to match against. This entity
2503
+ * definition is read at the beginning of an indexer run. Any updates to this file during an
2504
+ * indexer run will not take effect until subsequent runs. This config must be accessible over
2505
+ * HTTPS.
2506
+ */
1992
2507
  entitiesDefinitionUri?: string;
1993
- /** The inline CustomEntity definition. */
2508
+ /**
2509
+ * The inline CustomEntity definition.
2510
+ */
1994
2511
  inlineEntitiesDefinition?: CustomEntity[];
1995
- /** A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. */
2512
+ /**
2513
+ * A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will
2514
+ * be the default value.
2515
+ */
1996
2516
  globalDefaultCaseSensitive?: boolean;
1997
- /** A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value. */
2517
+ /**
2518
+ * A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value
2519
+ * will be the default value.
2520
+ */
1998
2521
  globalDefaultAccentSensitive?: boolean;
1999
- /** A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value. */
2522
+ /**
2523
+ * A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this
2524
+ * value will be the default value.
2525
+ */
2000
2526
  globalDefaultFuzzyEditDistance?: number;
2001
2527
  }
2002
2528
  /**
@@ -2005,113 +2531,595 @@ export interface CustomEntityLookupSkill extends BaseSearchIndexerSkill {
2005
2531
  * @deprecated This skill has been deprecated.
2006
2532
  */
2007
2533
  export interface EntityRecognitionSkill extends BaseSearchIndexerSkill {
2008
- /** Polymorphic discriminator, which specifies the different types this object can be */
2534
+ /**
2535
+ * Polymorphic discriminator, which specifies the different types this object can be
2536
+ */
2009
2537
  odatatype: "#Microsoft.Skills.Text.EntityRecognitionSkill";
2010
- /** A list of entity categories that should be extracted. */
2538
+ /**
2539
+ * A list of entity categories that should be extracted.
2540
+ */
2011
2541
  categories?: EntityCategory[];
2012
- /** A value indicating which language code to use. Default is en. */
2542
+ /**
2543
+ * A value indicating which language code to use. Default is en.
2544
+ */
2013
2545
  defaultLanguageCode?: EntityRecognitionSkillLanguage;
2014
- /** Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced. */
2546
+ /**
2547
+ * Determines whether or not to include entities which are well known but don't conform to a
2548
+ * pre-defined type. If this configuration is not set (default), set to null or set to false,
2549
+ * entities which don't conform to one of the pre-defined types will not be surfaced.
2550
+ */
2015
2551
  includeTypelessEntities?: boolean;
2016
- /** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
2552
+ /**
2553
+ * A value between 0 and 1 that be used to only include entities whose confidence score is greater
2554
+ * than the value specified. If not set (default), or if explicitly set to null, all entities will
2555
+ * be included.
2556
+ */
2017
2557
  minimumPrecision?: number;
2018
2558
  }
2019
- /** A skill that analyzes image files. It extracts a rich set of visual features based on the image content. */
2559
+ /**
2560
+ * A skill that analyzes image files. It extracts a rich set of visual features based on the image
2561
+ * content.
2562
+ */
2020
2563
  export interface ImageAnalysisSkill extends BaseSearchIndexerSkill {
2021
- /** Polymorphic discriminator, which specifies the different types this object can be */
2564
+ /**
2565
+ * Polymorphic discriminator, which specifies the different types this object can be
2566
+ */
2022
2567
  odatatype: "#Microsoft.Skills.Vision.ImageAnalysisSkill";
2023
- /** A value indicating which language code to use. Default is en. */
2568
+ /**
2569
+ * A value indicating which language code to use. Default is en.
2570
+ */
2024
2571
  defaultLanguageCode?: ImageAnalysisSkillLanguage;
2025
- /** A list of visual features. */
2572
+ /**
2573
+ * A list of visual features.
2574
+ */
2026
2575
  visualFeatures?: VisualFeature[];
2027
- /** A string indicating which domain-specific details to return. */
2576
+ /**
2577
+ * A string indicating which domain-specific details to return.
2578
+ */
2028
2579
  details?: ImageDetail[];
2029
2580
  }
2030
- /** A skill that uses text analytics for key phrase extraction. */
2581
+ /**
2582
+ * A skill that uses text analytics for key phrase extraction.
2583
+ */
2031
2584
  export interface KeyPhraseExtractionSkill extends BaseSearchIndexerSkill {
2032
- /** Polymorphic discriminator, which specifies the different types this object can be */
2585
+ /**
2586
+ * Polymorphic discriminator, which specifies the different types this object can be
2587
+ */
2033
2588
  odatatype: "#Microsoft.Skills.Text.KeyPhraseExtractionSkill";
2034
- /** A value indicating which language code to use. Default is en. */
2589
+ /**
2590
+ * A value indicating which language code to use. Default is en.
2591
+ */
2035
2592
  defaultLanguageCode?: KeyPhraseExtractionSkillLanguage;
2036
- /** A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. */
2593
+ /**
2594
+ * A number indicating how many key phrases to return. If absent, all identified key phrases will
2595
+ * be returned.
2596
+ */
2037
2597
  maxKeyPhraseCount?: number;
2038
- /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
2598
+ /**
2599
+ * The version of the model to use when calling the Text Analytics service. It will default to the
2600
+ * latest available when not specified. We recommend you do not specify this value unless
2601
+ * absolutely necessary.
2602
+ */
2039
2603
  modelVersion?: string;
2040
2604
  }
2041
- /** A skill that extracts text from image files. */
2605
+ /**
2606
+ * A skill that extracts text from image files.
2607
+ */
2042
2608
  export interface OcrSkill extends BaseSearchIndexerSkill {
2043
- /** Polymorphic discriminator, which specifies the different types this object can be */
2609
+ /**
2610
+ * Polymorphic discriminator, which specifies the different types this object can be
2611
+ */
2044
2612
  odatatype: "#Microsoft.Skills.Vision.OcrSkill";
2045
- /** A value indicating which language code to use. Default is en. */
2613
+ /**
2614
+ * A value indicating which language code to use. Default is `en`.
2615
+ */
2046
2616
  defaultLanguageCode?: OcrSkillLanguage;
2047
- /** A value indicating to turn orientation detection on or not. Default is false. */
2617
+ /**
2618
+ * A value indicating to turn orientation detection on or not. Default is false.
2619
+ */
2048
2620
  shouldDetectOrientation?: boolean;
2621
+ /**
2622
+ * Defines the sequence of characters to use between the lines of text recognized by the OCR
2623
+ * skill. The default value is "space".
2624
+ */
2625
+ lineEnding?: OcrLineEnding;
2049
2626
  }
2050
- /** Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it. */
2627
+ /**
2628
+ * Using the Text Analytics API, extracts personal information from an input text and gives you the
2629
+ * option of masking it.
2630
+ */
2051
2631
  export interface PIIDetectionSkill extends BaseSearchIndexerSkill {
2052
- /** Polymorphic discriminator, which specifies the different types this object can be */
2632
+ /**
2633
+ * Polymorphic discriminator, which specifies the different types this object can be
2634
+ */
2053
2635
  odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill";
2054
- /** A value indicating which language code to use. Default is en. */
2636
+ /**
2637
+ * A value indicating which language code to use. Default is en.
2638
+ */
2055
2639
  defaultLanguageCode?: string;
2056
- /** A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. */
2640
+ /**
2641
+ * A value between 0 and 1 that be used to only include entities whose confidence score is greater
2642
+ * than the value specified. If not set (default), or if explicitly set to null, all entities will
2643
+ * be included.
2644
+ */
2057
2645
  minimumPrecision?: number;
2058
- /** A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. */
2646
+ /**
2647
+ * A parameter that provides various ways to mask the personal information detected in the input
2648
+ * text. Default is 'none'.
2649
+ */
2059
2650
  maskingMode?: PIIDetectionSkillMaskingMode;
2060
- /** The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. */
2651
+ /**
2652
+ * The character used to mask the text if the maskingMode parameter is set to replace. Default is
2653
+ * '*'.
2654
+ */
2061
2655
  maskingCharacter?: string;
2062
- /** The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. */
2656
+ /**
2657
+ * The version of the model to use when calling the Text Analytics service. It will default to the
2658
+ * latest available when not specified. We recommend you do not specify this value unless
2659
+ * absolutely necessary.
2660
+ */
2063
2661
  modelVersion?: string;
2064
- /** A list of PII entity categories that should be extracted and masked. */
2662
+ /**
2663
+ * A list of PII entity categories that should be extracted and masked.
2664
+ */
2065
2665
  categories?: string[];
2066
- /** If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'. */
2666
+ /**
2667
+ * If specified, will set the PII domain to include only a subset of the entity categories.
2668
+ * Possible values include: 'phi', 'none'. Default is 'none'.
2669
+ */
2067
2670
  domain?: string;
2068
2671
  }
2069
2672
  /**
2070
- * Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.
2673
+ * Text analytics positive-negative sentiment analysis, scored as a floating point value in a range
2674
+ * of zero to 1.
2071
2675
  *
2072
2676
  * @deprecated This skill has been deprecated.
2073
2677
  */
2074
2678
  export interface SentimentSkill extends BaseSearchIndexerSkill {
2075
- /** Polymorphic discriminator, which specifies the different types this object can be */
2679
+ /**
2680
+ * Polymorphic discriminator, which specifies the different types this object can be
2681
+ */
2076
2682
  odatatype: "#Microsoft.Skills.Text.SentimentSkill";
2077
- /** A value indicating which language code to use. Default is en. */
2683
+ /**
2684
+ * A value indicating which language code to use. Default is en.
2685
+ */
2078
2686
  defaultLanguageCode?: SentimentSkillLanguage;
2079
2687
  }
2080
- /** A skill to split a string into chunks of text. */
2688
+ /**
2689
+ * A skill to split a string into chunks of text.
2690
+ */
2081
2691
  export interface SplitSkill extends BaseSearchIndexerSkill {
2082
- /** Polymorphic discriminator, which specifies the different types this object can be */
2692
+ /**
2693
+ * Polymorphic discriminator, which specifies the different types this object can be
2694
+ */
2083
2695
  odatatype: "#Microsoft.Skills.Text.SplitSkill";
2084
- /** A value indicating which language code to use. Default is en. */
2696
+ /**
2697
+ * A value indicating which language code to use. Default is `en`.
2698
+ */
2085
2699
  defaultLanguageCode?: SplitSkillLanguage;
2086
- /** A value indicating which split mode to perform. */
2700
+ /**
2701
+ * A value indicating which split mode to perform.
2702
+ */
2087
2703
  textSplitMode?: TextSplitMode;
2088
- /** The desired maximum page length. Default is 10000. */
2704
+ /**
2705
+ * The desired maximum page length. Default is 10000.
2706
+ */
2089
2707
  maxPageLength?: number;
2708
+ /**
2709
+ * Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with
2710
+ * this number of characters/tokens from the end of the nth chunk.
2711
+ */
2712
+ pageOverlapLength?: number;
2713
+ /**
2714
+ * Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will
2715
+ * discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to
2716
+ * improve performance when only a few initial pages are needed from each document.
2717
+ */
2718
+ maximumPagesToTake?: number;
2719
+ /**
2720
+ * Only applies if textSplitMode is set to pages. There are two possible values. The choice of the
2721
+ * values will decide the length (maximumPageLength and pageOverlapLength) measurement. The
2722
+ * default is 'characters', which means the length will be measured by character.
2723
+ */
2724
+ unit?: SplitSkillUnit;
2725
+ /**
2726
+ * Only applies if the unit is set to azureOpenAITokens. If specified, the splitSkill will use
2727
+ * these parameters when performing the tokenization. The parameters are a valid
2728
+ * 'encoderModelName' and an optional 'allowedSpecialTokens' property.
2729
+ */
2730
+ azureOpenAITokenizerParameters?: AzureOpenAITokenizerParameters;
2090
2731
  }
2091
- /** A skill to translate text from one language to another. */
2732
+ /**
2733
+ * A skill to translate text from one language to another.
2734
+ */
2092
2735
  export interface TextTranslationSkill extends BaseSearchIndexerSkill {
2093
- /** Polymorphic discriminator, which specifies the different types this object can be */
2736
+ /**
2737
+ * Polymorphic discriminator, which specifies the different types this object can be
2738
+ */
2094
2739
  odatatype: "#Microsoft.Skills.Text.TranslationSkill";
2095
- /** The language code to translate documents into for documents that don't specify the to language explicitly. */
2740
+ /**
2741
+ * The language code to translate documents into for documents that don't specify the to language
2742
+ * explicitly.
2743
+ */
2096
2744
  defaultToLanguageCode: TextTranslationSkillLanguage;
2097
- /** The language code to translate documents from for documents that don't specify the from language explicitly. */
2745
+ /**
2746
+ * The language code to translate documents from for documents that don't specify the from
2747
+ * language explicitly.
2748
+ */
2098
2749
  defaultFromLanguageCode?: TextTranslationSkillLanguage;
2099
- /** The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en. */
2750
+ /**
2751
+ * The language code to translate documents from when neither the fromLanguageCode input nor the
2752
+ * defaultFromLanguageCode parameter are provided, and the automatic language detection is
2753
+ * unsuccessful. Default is en.
2754
+ */
2100
2755
  suggestedFrom?: TextTranslationSkillLanguage;
2101
2756
  }
2102
- /** A skill that analyzes image files. It extracts a rich set of visual features based on the image content. */
2757
+ /**
2758
+ * A skill that analyzes image files. It extracts a rich set of visual features based on the image
2759
+ * content.
2760
+ */
2103
2761
  export interface ImageAnalysisSkill extends BaseSearchIndexerSkill {
2104
- /** Polymorphic discriminator, which specifies the different types this object can be */
2762
+ /**
2763
+ * Polymorphic discriminator, which specifies the different types this object can be
2764
+ */
2105
2765
  odatatype: "#Microsoft.Skills.Vision.ImageAnalysisSkill";
2106
- /** A value indicating which language code to use. Default is en. */
2766
+ /**
2767
+ * A value indicating which language code to use. Default is en.
2768
+ */
2107
2769
  defaultLanguageCode?: ImageAnalysisSkillLanguage;
2108
- /** A list of visual features. */
2770
+ /**
2771
+ * A list of visual features.
2772
+ */
2109
2773
  visualFeatures?: VisualFeature[];
2110
- /** A string indicating which domain-specific details to return. */
2774
+ /**
2775
+ * A string indicating which domain-specific details to return.
2776
+ */
2111
2777
  details?: ImageDetail[];
2112
2778
  }
2113
- /** Contains configuration options specific to the compression method used during indexing or querying. */
2779
+ export type KnowledgeSource = BaseKnowledgeSource | SearchIndexKnowledgeSource | AzureBlobKnowledgeSource | IndexedSharePointKnowledgeSource | IndexedOneLakeKnowledgeSource | WebKnowledgeSource | RemoteSharePointKnowledgeSource;
2780
+ /**
2781
+ * Represents a knowledge source definition.
2782
+ */
2783
+ export interface BaseKnowledgeSource {
2784
+ /**
2785
+ * Polymorphic discriminator, which specifies the different types this object can be
2786
+ */
2787
+ kind: "searchIndex" | "azureBlob" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint";
2788
+ /**
2789
+ * The name of the knowledge source.
2790
+ */
2791
+ name: string;
2792
+ /**
2793
+ * Optional user-defined description.
2794
+ */
2795
+ description?: string;
2796
+ /**
2797
+ * The ETag of the knowledge base.
2798
+ */
2799
+ etag?: string;
2800
+ /**
2801
+ * A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
2802
+ */
2803
+ encryptionKey?: SearchResourceEncryptionKey;
2804
+ }
2805
+ /**
2806
+ * Knowledge Source targeting a search index.
2807
+ */
2808
+ export interface SearchIndexKnowledgeSource extends BaseKnowledgeSource {
2809
+ /**
2810
+ * Polymorphic discriminator, which specifies the different types this object can be
2811
+ */
2812
+ kind: "searchIndex";
2813
+ /**
2814
+ * The parameters for the knowledge source.
2815
+ */
2816
+ searchIndexParameters: SearchIndexKnowledgeSourceParameters;
2817
+ }
2818
+ /**
2819
+ * Configuration for Azure Blob Storage knowledge source.
2820
+ */
2821
+ export interface AzureBlobKnowledgeSource extends BaseKnowledgeSource {
2822
+ /**
2823
+ * Polymorphic discriminator, which specifies the different types this object can be
2824
+ */
2825
+ kind: "azureBlob";
2826
+ /**
2827
+ * The type of the knowledge source.
2828
+ */
2829
+ azureBlobParameters: AzureBlobKnowledgeSourceParameters;
2830
+ }
2831
+ /**
2832
+ * Parameters for Azure Blob Storage knowledge source.
2833
+ */
2834
+ export interface AzureBlobKnowledgeSourceParameters {
2835
+ /**
2836
+ * Key-based connection string or the ResourceId format if using a managed identity.
2837
+ */
2838
+ connectionString: string;
2839
+ /**
2840
+ * The name of the blob storage container.
2841
+ */
2842
+ containerName: string;
2843
+ /**
2844
+ * Optional folder path within the container.
2845
+ */
2846
+ folderPath?: string;
2847
+ /**
2848
+ * Resources created by the knowledge source.
2849
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2850
+ */
2851
+ readonly createdResources?: {
2852
+ [propertyName: string]: string;
2853
+ };
2854
+ /** Consolidates all general ingestion settings. */
2855
+ ingestionParameters?: KnowledgeSourceIngestionParameters;
2856
+ }
2857
+ /**
2858
+ * Configuration for SharePoint knowledge source.
2859
+ */
2860
+ export interface IndexedSharePointKnowledgeSource extends BaseKnowledgeSource {
2861
+ /**
2862
+ * Polymorphic discriminator, which specifies the different types this object can be
2863
+ */
2864
+ kind: "indexedSharePoint";
2865
+ /**
2866
+ * The parameters for the SharePoint knowledge source.
2867
+ */
2868
+ indexedSharePointParameters: IndexedSharePointKnowledgeSourceParameters;
2869
+ }
2870
+ /** Parameters for SharePoint knowledge source. */
2871
+ export interface IndexedSharePointKnowledgeSourceParameters {
2872
+ /** SharePoint connection string with format: SharePointOnlineEndpoint=[SharePoint site url];ApplicationId=[Azure AD App ID];ApplicationSecret=[Azure AD App client secret];TenantId=[SharePoint site tenant id] */
2873
+ connectionString: string;
2874
+ /** Specifies which SharePoint libraries to access. */
2875
+ containerName: IndexedSharePointContainerName;
2876
+ /** Optional query to filter SharePoint content. */
2877
+ query?: string;
2878
+ /** Consolidates all general ingestion settings. */
2879
+ ingestionParameters?: KnowledgeSourceIngestionParameters;
2880
+ /**
2881
+ * Resources created by the knowledge source.
2882
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2883
+ */
2884
+ readonly createdResources?: {
2885
+ [propertyName: string]: string;
2886
+ };
2887
+ }
2888
+ /**
2889
+ * Configuration for OneLake knowledge source.
2890
+ */
2891
+ export interface IndexedOneLakeKnowledgeSource extends BaseKnowledgeSource {
2892
+ /**
2893
+ * Polymorphic discriminator, which specifies the different types this object can be
2894
+ */
2895
+ kind: "indexedOneLake";
2896
+ /**
2897
+ * The parameters for the OneLake knowledge source.
2898
+ */
2899
+ indexedOneLakeParameters: IndexedOneLakeKnowledgeSourceParameters;
2900
+ }
2901
+ /** Parameters for OneLake knowledge source. */
2902
+ export interface IndexedOneLakeKnowledgeSourceParameters {
2903
+ /** OneLake workspace ID. */
2904
+ fabricWorkspaceId: string;
2905
+ /** Specifies which OneLake lakehouse to access. */
2906
+ lakehouseId: string;
2907
+ /** Optional OneLakehouse folder or shortcut to filter OneLake content. */
2908
+ targetPath?: string;
2909
+ /** Consolidates all general ingestion settings. */
2910
+ ingestionParameters?: KnowledgeSourceIngestionParameters;
2911
+ /**
2912
+ * Resources created by the knowledge source.
2913
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2914
+ */
2915
+ readonly createdResources?: {
2916
+ [propertyName: string]: string;
2917
+ };
2918
+ }
2919
+ /**
2920
+ * Knowledge Source targeting web results.
2921
+ */
2922
+ export interface WebKnowledgeSource extends BaseKnowledgeSource {
2923
+ /**
2924
+ * Polymorphic discriminator, which specifies the different types this object can be
2925
+ */
2926
+ kind: "web";
2927
+ /**
2928
+ * The parameters for the web knowledge source.
2929
+ */
2930
+ webParameters?: WebKnowledgeSourceParameters;
2931
+ }
2932
+ /**
2933
+ * Configuration for remote SharePoint knowledge source.
2934
+ */
2935
+ export interface RemoteSharePointKnowledgeSource extends BaseKnowledgeSource {
2936
+ /**
2937
+ * Polymorphic discriminator, which specifies the different types this object can be
2938
+ */
2939
+ kind: "remoteSharePoint";
2940
+ /**
2941
+ * The parameters for the knowledge source.
2942
+ */
2943
+ remoteSharePointParameters: RemoteSharePointKnowledgeSourceParameters;
2944
+ }
2945
+ /** Consolidates all general ingestion settings for knowledge sources. */
2946
+ export interface KnowledgeSourceIngestionParameters {
2947
+ /** An explicit identity to use for this knowledge source. */
2948
+ identity?: SearchIndexerDataIdentity;
2949
+ /** Optional vectorizer configuration for vectorizing content. */
2950
+ embeddingModel?: KnowledgeSourceVectorizer;
2951
+ /** Optional chat completion model for image verbalization or context extraction. */
2952
+ chatCompletionModel?: KnowledgeBaseModel;
2953
+ /** Indicates whether image verbalization should be disabled. Default is false. */
2954
+ disableImageVerbalization?: boolean;
2955
+ /** Optional schedule for data ingestion. */
2956
+ ingestionSchedule?: IndexingSchedule;
2957
+ /** Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source. */
2958
+ ingestionPermissionOptions?: KnowledgeSourceIngestionPermissionOption[];
2959
+ /** Optional content extraction mode. Default is 'minimal'. */
2960
+ contentExtractionMode?: KnowledgeSourceContentExtractionMode;
2961
+ /** Optional AI Services configuration for content processing. */
2962
+ aiServices?: AIServices;
2963
+ }
2964
+ export type KnowledgeBaseModel = KnowledgeBaseAzureOpenAIModel;
2965
+ /** Specifies the Azure OpenAI resource used to do query planning. */
2966
+ export interface KnowledgeBaseAzureOpenAIModel extends BaseKnowledgeBaseModel {
2967
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2968
+ kind: "azureOpenAI";
2969
+ /** Contains the parameters specific to Azure OpenAI model endpoint. */
2970
+ azureOpenAIParameters: AzureOpenAIParameters;
2971
+ }
2972
+ export type KnowledgeSourceVectorizer = KnowledgeSourceAzureOpenAIVectorizer;
2973
+ /** Specifies the Azure OpenAI resource used to vectorize a query string. */
2974
+ export interface KnowledgeSourceAzureOpenAIVectorizer extends BaseKnowledgeSourceVectorizer {
2975
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2976
+ kind: "azureOpenAI";
2977
+ /** Contains the parameters specific to Azure OpenAI embedding vectorization. */
2978
+ azureOpenAIParameters?: AzureOpenAIParameters;
2979
+ }
2980
+ /**
2981
+ * Contains configuration options specific to the compression method used during indexing or querying.
2982
+ */
2114
2983
  export type VectorSearchCompression = BinaryQuantizationCompression | ScalarQuantizationCompression;
2984
+ export interface GetIndexStatsSummaryOptions extends OperationOptions {
2985
+ }
2986
+ export interface CreateOrUpdateKnowledgeBaseOptions extends OperationOptions {
2987
+ /**
2988
+ * If set to true, Resource will be deleted only if the etag matches.
2989
+ */
2990
+ onlyIfUnchanged?: boolean;
2991
+ }
2992
+ export interface DeleteKnowledgeBaseOptions extends OperationOptions {
2993
+ /**
2994
+ * If set to true, Resource will be deleted only if the etag matches.
2995
+ */
2996
+ onlyIfUnchanged?: boolean;
2997
+ }
2998
+ export interface GetKnowledgeBaseOptions extends OperationOptions {
2999
+ }
3000
+ export interface ListKnowledgeBasesOptions extends OperationOptions {
3001
+ }
3002
+ export interface CreateKnowledgeBaseOptions extends OperationOptions {
3003
+ }
3004
+ export interface CreateOrUpdateKnowledgeSourceOptions extends OperationOptions {
3005
+ /**
3006
+ * If set to true, Resource will be deleted only if the etag matches.
3007
+ */
3008
+ onlyIfUnchanged?: boolean;
3009
+ }
3010
+ export interface DeleteKnowledgeSourceOptions extends OperationOptions {
3011
+ /**
3012
+ * If set to true, Resource will be deleted only if the etag matches.
3013
+ */
3014
+ onlyIfUnchanged?: boolean;
3015
+ }
3016
+ export interface GetKnowledgeSourceOptions extends OperationOptions {
3017
+ }
3018
+ export interface ListKnowledgeSourcesOptions extends OperationOptions {
3019
+ }
3020
+ export interface CreateKnowledgeSourceOptions extends OperationOptions {
3021
+ }
3022
+ export interface GetKnowledgeSourceStatusOptions extends OperationOptions {
3023
+ }
3024
+ /**
3025
+ * Defines values for LexicalAnalyzerName.
3026
+ * {@link KnownLexicalAnalyzerName} can be used interchangeably with LexicalAnalyzerName,
3027
+ * this enum contains the known values that the service supports.
3028
+ * ### Known values supported by the service
3029
+ * **ar.microsoft**: Microsoft analyzer for Arabic.
3030
+ * **ar.lucene**: Lucene analyzer for Arabic.
3031
+ * **hy.lucene**: Lucene analyzer for Armenian.
3032
+ * **bn.microsoft**: Microsoft analyzer for Bangla.
3033
+ * **eu.lucene**: Lucene analyzer for Basque.
3034
+ * **bg.microsoft**: Microsoft analyzer for Bulgarian.
3035
+ * **bg.lucene**: Lucene analyzer for Bulgarian.
3036
+ * **ca.microsoft**: Microsoft analyzer for Catalan.
3037
+ * **ca.lucene**: Lucene analyzer for Catalan.
3038
+ * **zh-Hans.microsoft**: Microsoft analyzer for Chinese (Simplified).
3039
+ * **zh-Hans.lucene**: Lucene analyzer for Chinese (Simplified).
3040
+ * **zh-Hant.microsoft**: Microsoft analyzer for Chinese (Traditional).
3041
+ * **zh-Hant.lucene**: Lucene analyzer for Chinese (Traditional).
3042
+ * **hr.microsoft**: Microsoft analyzer for Croatian.
3043
+ * **cs.microsoft**: Microsoft analyzer for Czech.
3044
+ * **cs.lucene**: Lucene analyzer for Czech.
3045
+ * **da.microsoft**: Microsoft analyzer for Danish.
3046
+ * **da.lucene**: Lucene analyzer for Danish.
3047
+ * **nl.microsoft**: Microsoft analyzer for Dutch.
3048
+ * **nl.lucene**: Lucene analyzer for Dutch.
3049
+ * **en.microsoft**: Microsoft analyzer for English.
3050
+ * **en.lucene**: Lucene analyzer for English.
3051
+ * **et.microsoft**: Microsoft analyzer for Estonian.
3052
+ * **fi.microsoft**: Microsoft analyzer for Finnish.
3053
+ * **fi.lucene**: Lucene analyzer for Finnish.
3054
+ * **fr.microsoft**: Microsoft analyzer for French.
3055
+ * **fr.lucene**: Lucene analyzer for French.
3056
+ * **gl.lucene**: Lucene analyzer for Galician.
3057
+ * **de.microsoft**: Microsoft analyzer for German.
3058
+ * **de.lucene**: Lucene analyzer for German.
3059
+ * **el.microsoft**: Microsoft analyzer for Greek.
3060
+ * **el.lucene**: Lucene analyzer for Greek.
3061
+ * **gu.microsoft**: Microsoft analyzer for Gujarati.
3062
+ * **he.microsoft**: Microsoft analyzer for Hebrew.
3063
+ * **hi.microsoft**: Microsoft analyzer for Hindi.
3064
+ * **hi.lucene**: Lucene analyzer for Hindi.
3065
+ * **hu.microsoft**: Microsoft analyzer for Hungarian.
3066
+ * **hu.lucene**: Lucene analyzer for Hungarian.
3067
+ * **is.microsoft**: Microsoft analyzer for Icelandic.
3068
+ * **id.microsoft**: Microsoft analyzer for Indonesian (Bahasa).
3069
+ * **id.lucene**: Lucene analyzer for Indonesian.
3070
+ * **ga.lucene**: Lucene analyzer for Irish.
3071
+ * **it.microsoft**: Microsoft analyzer for Italian.
3072
+ * **it.lucene**: Lucene analyzer for Italian.
3073
+ * **ja.microsoft**: Microsoft analyzer for Japanese.
3074
+ * **ja.lucene**: Lucene analyzer for Japanese.
3075
+ * **kn.microsoft**: Microsoft analyzer for Kannada.
3076
+ * **ko.microsoft**: Microsoft analyzer for Korean.
3077
+ * **ko.lucene**: Lucene analyzer for Korean.
3078
+ * **lv.microsoft**: Microsoft analyzer for Latvian.
3079
+ * **lv.lucene**: Lucene analyzer for Latvian.
3080
+ * **lt.microsoft**: Microsoft analyzer for Lithuanian.
3081
+ * **ml.microsoft**: Microsoft analyzer for Malayalam.
3082
+ * **ms.microsoft**: Microsoft analyzer for Malay (Latin).
3083
+ * **mr.microsoft**: Microsoft analyzer for Marathi.
3084
+ * **nb.microsoft**: Microsoft analyzer for Norwegian (Bokmål).
3085
+ * **no.lucene**: Lucene analyzer for Norwegian.
3086
+ * **fa.lucene**: Lucene analyzer for Persian.
3087
+ * **pl.microsoft**: Microsoft analyzer for Polish.
3088
+ * **pl.lucene**: Lucene analyzer for Polish.
3089
+ * **pt-BR.microsoft**: Microsoft analyzer for Portuguese (Brazil).
3090
+ * **pt-BR.lucene**: Lucene analyzer for Portuguese (Brazil).
3091
+ * **pt-PT.microsoft**: Microsoft analyzer for Portuguese (Portugal).
3092
+ * **pt-PT.lucene**: Lucene analyzer for Portuguese (Portugal).
3093
+ * **pa.microsoft**: Microsoft analyzer for Punjabi.
3094
+ * **ro.microsoft**: Microsoft analyzer for Romanian.
3095
+ * **ro.lucene**: Lucene analyzer for Romanian.
3096
+ * **ru.microsoft**: Microsoft analyzer for Russian.
3097
+ * **ru.lucene**: Lucene analyzer for Russian.
3098
+ * **sr-cyrillic.microsoft**: Microsoft analyzer for Serbian (Cyrillic).
3099
+ * **sr-latin.microsoft**: Microsoft analyzer for Serbian (Latin).
3100
+ * **sk.microsoft**: Microsoft analyzer for Slovak.
3101
+ * **sl.microsoft**: Microsoft analyzer for Slovenian.
3102
+ * **es.microsoft**: Microsoft analyzer for Spanish.
3103
+ * **es.lucene**: Lucene analyzer for Spanish.
3104
+ * **sv.microsoft**: Microsoft analyzer for Swedish.
3105
+ * **sv.lucene**: Lucene analyzer for Swedish.
3106
+ * **ta.microsoft**: Microsoft analyzer for Tamil.
3107
+ * **te.microsoft**: Microsoft analyzer for Telugu.
3108
+ * **th.microsoft**: Microsoft analyzer for Thai.
3109
+ * **th.lucene**: Lucene analyzer for Thai.
3110
+ * **tr.microsoft**: Microsoft analyzer for Turkish.
3111
+ * **tr.lucene**: Lucene analyzer for Turkish.
3112
+ * **uk.microsoft**: Microsoft analyzer for Ukrainian.
3113
+ * **ur.microsoft**: Microsoft analyzer for Urdu.
3114
+ * **vi.microsoft**: Microsoft analyzer for Vietnamese.
3115
+ * **standard.lucene**: Standard Lucene analyzer.
3116
+ * **standardasciifolding.lucene**: Standard ASCII Folding Lucene analyzer. See https:\/\/learn.microsoft.com\/rest\/api\/searchservice\/Custom-analyzers-in-Azure-Search#Analyzers
3117
+ * **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
3118
+ * **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
3119
+ * **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
3120
+ * **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
3121
+ * **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
3122
+ */
2115
3123
  export type AnalyzerNames = `${KnownLexicalAnalyzerName}`;
2116
3124
  export type BlobIndexerDataToExtract = `${KnownBlobIndexerDataToExtract}`;
2117
3125
  export type BlobIndexerImageAction = `${KnownBlobIndexerImageAction}`;