@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.
- package/dist/browser/errorModels.d.ts +23 -17
- package/dist/browser/errorModels.d.ts.map +1 -1
- package/dist/browser/errorModels.js.map +1 -1
- package/dist/browser/generated/data/models/index.d.ts +593 -20
- package/dist/browser/generated/data/models/index.d.ts.map +1 -1
- package/dist/browser/generated/data/models/index.js +216 -6
- package/dist/browser/generated/data/models/index.js.map +1 -1
- package/dist/browser/generated/data/models/mappers.d.ts +18 -0
- package/dist/browser/generated/data/models/mappers.d.ts.map +1 -1
- package/dist/browser/generated/data/models/mappers.js +463 -4
- package/dist/browser/generated/data/models/mappers.js.map +1 -1
- package/dist/browser/generated/data/models/parameters.d.ts +6 -0
- package/dist/browser/generated/data/models/parameters.d.ts.map +1 -1
- package/dist/browser/generated/data/models/parameters.js +60 -0
- package/dist/browser/generated/data/models/parameters.js.map +1 -1
- package/dist/browser/generated/data/operations/documents.js +20 -3
- package/dist/browser/generated/data/operations/documents.js.map +1 -1
- package/dist/browser/generated/data/searchClient.d.ts +3 -3
- package/dist/browser/generated/data/searchClient.d.ts.map +1 -1
- package/dist/browser/generated/data/searchClient.js +1 -1
- package/dist/browser/generated/data/searchClient.js.map +1 -1
- package/dist/browser/generated/knowledgeBase/index.d.ts +4 -0
- package/dist/browser/generated/knowledgeBase/index.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/index.js +11 -0
- package/dist/browser/generated/knowledgeBase/index.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/models/index.d.ts +561 -0
- package/dist/browser/generated/knowledgeBase/models/index.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/models/index.js +62 -0
- package/dist/browser/generated/knowledgeBase/models/index.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/models/mappers.d.ts +88 -0
- package/dist/browser/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/models/mappers.js +1280 -0
- package/dist/browser/generated/knowledgeBase/models/mappers.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/models/parameters.d.ts +9 -0
- package/dist/browser/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/models/parameters.js +75 -0
- package/dist/browser/generated/knowledgeBase/models/parameters.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/operations/index.d.ts +2 -0
- package/dist/browser/generated/knowledgeBase/operations/index.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/operations/index.js +9 -0
- package/dist/browser/generated/knowledgeBase/operations/index.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
- package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.js +57 -0
- package/dist/browser/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.js +9 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +9 -0
- package/dist/browser/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
- package/dist/browser/generated/knowledgeBase/searchClient.d.ts +21 -0
- package/dist/browser/generated/knowledgeBase/searchClient.d.ts.map +1 -0
- package/dist/browser/generated/knowledgeBase/searchClient.js +88 -0
- package/dist/browser/generated/knowledgeBase/searchClient.js.map +1 -0
- package/dist/browser/generated/service/models/index.d.ts +1403 -131
- package/dist/browser/generated/service/models/index.d.ts.map +1 -1
- package/dist/browser/generated/service/models/index.js +274 -24
- package/dist/browser/generated/service/models/index.js.map +1 -1
- package/dist/browser/generated/service/models/mappers.d.ts +104 -17
- package/dist/browser/generated/service/models/mappers.d.ts.map +1 -1
- package/dist/browser/generated/service/models/mappers.js +3716 -1601
- package/dist/browser/generated/service/models/mappers.js.map +1 -1
- package/dist/browser/generated/service/models/parameters.d.ts +14 -2
- package/dist/browser/generated/service/models/parameters.d.ts.map +1 -1
- package/dist/browser/generated/service/models/parameters.js +89 -7
- package/dist/browser/generated/service/models/parameters.js.map +1 -1
- package/dist/browser/generated/service/operations/aliases.d.ts +43 -1
- package/dist/browser/generated/service/operations/aliases.d.ts.map +1 -1
- package/dist/browser/generated/service/operations/aliases.js +160 -200
- package/dist/browser/generated/service/operations/aliases.js.map +1 -1
- package/dist/browser/generated/service/operations/dataSources.js +4 -1
- package/dist/browser/generated/service/operations/dataSources.js.map +1 -1
- package/dist/browser/generated/service/operations/index.d.ts +3 -0
- package/dist/browser/generated/service/operations/index.d.ts.map +1 -1
- package/dist/browser/generated/service/operations/index.js +3 -0
- package/dist/browser/generated/service/operations/index.js.map +1 -1
- package/dist/browser/generated/service/operations/indexers.d.ts +14 -1
- package/dist/browser/generated/service/operations/indexers.d.ts.map +1 -1
- package/dist/browser/generated/service/operations/indexers.js +54 -1
- package/dist/browser/generated/service/operations/indexers.js.map +1 -1
- package/dist/browser/generated/service/operations/knowledgeBases.d.ts +43 -0
- package/dist/browser/generated/service/operations/knowledgeBases.d.ts.map +1 -0
- package/dist/browser/generated/service/operations/knowledgeBases.js +160 -0
- package/dist/browser/generated/service/operations/knowledgeBases.js.map +1 -0
- package/dist/browser/generated/service/operations/knowledgeSources.d.ts +49 -0
- package/dist/browser/generated/service/operations/knowledgeSources.d.ts.map +1 -0
- package/dist/browser/generated/service/operations/knowledgeSources.js +184 -0
- package/dist/browser/generated/service/operations/knowledgeSources.js.map +1 -0
- package/dist/browser/generated/service/operations/skillsets.d.ts +8 -1
- package/dist/browser/generated/service/operations/skillsets.d.ts.map +1 -1
- package/dist/browser/generated/service/operations/skillsets.js +30 -1
- package/dist/browser/generated/service/operations/skillsets.js.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/aliases.d.ts +35 -1
- package/dist/browser/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/aliases.js +7 -66
- package/dist/browser/generated/service/operationsInterfaces/aliases.js.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/index.d.ts +3 -0
- package/dist/browser/generated/service/operationsInterfaces/index.d.ts.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/index.js +3 -0
- package/dist/browser/generated/service/operationsInterfaces/index.js.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/indexers.d.ts +14 -1
- package/dist/browser/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/indexers.js.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.js +9 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.js +9 -0
- package/dist/browser/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
- package/dist/browser/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
- package/dist/browser/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
- package/dist/browser/generated/service/operationsInterfaces/skillsets.js.map +1 -1
- package/dist/browser/generated/service/searchServiceClient.d.ts +12 -4
- package/dist/browser/generated/service/searchServiceClient.d.ts.map +1 -1
- package/dist/browser/generated/service/searchServiceClient.js +31 -2
- package/dist/browser/generated/service/searchServiceClient.js.map +1 -1
- package/dist/browser/index.d.ts +7 -4
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.js +5 -3
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/indexDocumentsBatch.d.ts +6 -5
- package/dist/browser/indexDocumentsBatch.d.ts.map +1 -1
- package/dist/browser/indexDocumentsBatch.js +5 -4
- package/dist/browser/indexDocumentsBatch.js.map +1 -1
- package/dist/browser/indexModels.d.ts +236 -30
- package/dist/browser/indexModels.d.ts.map +1 -1
- package/dist/browser/indexModels.js.map +1 -1
- package/dist/browser/knowledgeBaseModels.d.ts +44 -0
- package/dist/browser/knowledgeBaseModels.d.ts.map +1 -0
- package/dist/browser/knowledgeBaseModels.js +4 -0
- package/dist/browser/knowledgeBaseModels.js.map +1 -0
- package/dist/browser/knowledgeRetrievalClient.d.ts +68 -0
- package/dist/browser/knowledgeRetrievalClient.d.ts.map +1 -0
- package/dist/browser/knowledgeRetrievalClient.js +108 -0
- package/dist/browser/knowledgeRetrievalClient.js.map +1 -0
- package/dist/browser/odata.d.ts +5 -2
- package/dist/browser/odata.d.ts.map +1 -1
- package/dist/browser/odata.js +5 -2
- package/dist/browser/odata.js.map +1 -1
- package/dist/browser/odataMetadataPolicy.d.ts +1 -1
- package/dist/browser/odataMetadataPolicy.d.ts.map +1 -1
- package/dist/browser/odataMetadataPolicy.js.map +1 -1
- package/dist/browser/searchApiKeyCredentialPolicy.d.ts +4 -4
- package/dist/browser/searchApiKeyCredentialPolicy.d.ts.map +1 -1
- package/dist/browser/searchApiKeyCredentialPolicy.js +2 -2
- package/dist/browser/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist/browser/searchClient.d.ts +64 -53
- package/dist/browser/searchClient.d.ts.map +1 -1
- package/dist/browser/searchClient.js +113 -53
- package/dist/browser/searchClient.js.map +1 -1
- package/dist/browser/searchIndexClient.d.ts +157 -18
- package/dist/browser/searchIndexClient.d.ts.map +1 -1
- package/dist/browser/searchIndexClient.js +482 -17
- package/dist/browser/searchIndexClient.js.map +1 -1
- package/dist/browser/searchIndexerClient.d.ts +26 -11
- package/dist/browser/searchIndexerClient.d.ts.map +1 -1
- package/dist/browser/searchIndexerClient.js +62 -7
- package/dist/browser/searchIndexerClient.js.map +1 -1
- package/dist/browser/searchIndexingBufferedSender.d.ts +3 -3
- package/dist/browser/searchIndexingBufferedSender.d.ts.map +1 -1
- package/dist/browser/searchIndexingBufferedSender.js +1 -1
- package/dist/browser/searchIndexingBufferedSender.js.map +1 -1
- package/dist/browser/serviceModels.d.ts +1228 -220
- package/dist/browser/serviceModels.d.ts.map +1 -1
- package/dist/browser/serviceModels.js +8 -7
- package/dist/browser/serviceModels.js.map +1 -1
- package/dist/browser/serviceUtils.d.ts +14 -6
- package/dist/browser/serviceUtils.d.ts.map +1 -1
- package/dist/browser/serviceUtils.js +301 -45
- package/dist/browser/serviceUtils.js.map +1 -1
- package/dist/browser/synonymMapHelper-browser.d.mts.map +1 -1
- package/dist/browser/synonymMapHelper-browser.mjs.map +1 -1
- package/dist/browser/synonymMapHelper.d.ts +1 -1
- package/dist/commonjs/errorModels.d.ts +23 -17
- package/dist/commonjs/errorModels.d.ts.map +1 -1
- package/dist/commonjs/errorModels.js.map +1 -1
- package/dist/commonjs/generated/data/models/index.d.ts +593 -20
- package/dist/commonjs/generated/data/models/index.d.ts.map +1 -1
- package/dist/commonjs/generated/data/models/index.js +217 -7
- package/dist/commonjs/generated/data/models/index.js.map +1 -1
- package/dist/commonjs/generated/data/models/mappers.d.ts +18 -0
- package/dist/commonjs/generated/data/models/mappers.d.ts.map +1 -1
- package/dist/commonjs/generated/data/models/mappers.js +464 -5
- package/dist/commonjs/generated/data/models/mappers.js.map +1 -1
- package/dist/commonjs/generated/data/models/parameters.d.ts +6 -0
- package/dist/commonjs/generated/data/models/parameters.d.ts.map +1 -1
- package/dist/commonjs/generated/data/models/parameters.js +62 -2
- package/dist/commonjs/generated/data/models/parameters.js.map +1 -1
- package/dist/commonjs/generated/data/operations/documents.js +20 -3
- package/dist/commonjs/generated/data/operations/documents.js.map +1 -1
- package/dist/commonjs/generated/data/searchClient.d.ts +3 -3
- package/dist/commonjs/generated/data/searchClient.d.ts.map +1 -1
- package/dist/commonjs/generated/data/searchClient.js +1 -1
- package/dist/commonjs/generated/data/searchClient.js.map +1 -1
- package/dist/commonjs/generated/knowledgeBase/index.d.ts +4 -0
- package/dist/commonjs/generated/knowledgeBase/index.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/index.js +16 -0
- package/dist/commonjs/generated/knowledgeBase/index.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/models/index.d.ts +561 -0
- package/dist/commonjs/generated/knowledgeBase/models/index.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/models/index.js +65 -0
- package/dist/commonjs/generated/knowledgeBase/models/index.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/models/mappers.d.ts +88 -0
- package/dist/commonjs/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/models/mappers.js +1284 -0
- package/dist/commonjs/generated/knowledgeBase/models/mappers.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/models/parameters.d.ts +9 -0
- package/dist/commonjs/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/models/parameters.js +78 -0
- package/dist/commonjs/generated/knowledgeBase/models/parameters.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operations/index.d.ts +2 -0
- package/dist/commonjs/generated/knowledgeBase/operations/index.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operations/index.js +12 -0
- package/dist/commonjs/generated/knowledgeBase/operations/index.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
- package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.js +62 -0
- package/dist/commonjs/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.js +12 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +10 -0
- package/dist/commonjs/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/searchClient.d.ts +21 -0
- package/dist/commonjs/generated/knowledgeBase/searchClient.d.ts.map +1 -0
- package/dist/commonjs/generated/knowledgeBase/searchClient.js +93 -0
- package/dist/commonjs/generated/knowledgeBase/searchClient.js.map +1 -0
- package/dist/commonjs/generated/service/models/index.d.ts +1403 -131
- package/dist/commonjs/generated/service/models/index.d.ts.map +1 -1
- package/dist/commonjs/generated/service/models/index.js +276 -25
- package/dist/commonjs/generated/service/models/index.js.map +1 -1
- package/dist/commonjs/generated/service/models/mappers.d.ts +104 -17
- package/dist/commonjs/generated/service/models/mappers.d.ts.map +1 -1
- package/dist/commonjs/generated/service/models/mappers.js +3721 -1605
- package/dist/commonjs/generated/service/models/mappers.js.map +1 -1
- package/dist/commonjs/generated/service/models/parameters.d.ts +14 -2
- package/dist/commonjs/generated/service/models/parameters.d.ts.map +1 -1
- package/dist/commonjs/generated/service/models/parameters.js +89 -7
- package/dist/commonjs/generated/service/models/parameters.js.map +1 -1
- package/dist/commonjs/generated/service/operations/aliases.d.ts +43 -1
- package/dist/commonjs/generated/service/operations/aliases.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operations/aliases.js +163 -199
- package/dist/commonjs/generated/service/operations/aliases.js.map +1 -1
- package/dist/commonjs/generated/service/operations/dataSources.js +4 -1
- package/dist/commonjs/generated/service/operations/dataSources.js.map +1 -1
- package/dist/commonjs/generated/service/operations/index.d.ts +3 -0
- package/dist/commonjs/generated/service/operations/index.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operations/index.js +3 -0
- package/dist/commonjs/generated/service/operations/index.js.map +1 -1
- package/dist/commonjs/generated/service/operations/indexers.d.ts +14 -1
- package/dist/commonjs/generated/service/operations/indexers.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operations/indexers.js +54 -1
- package/dist/commonjs/generated/service/operations/indexers.js.map +1 -1
- package/dist/commonjs/generated/service/operations/knowledgeBases.d.ts +43 -0
- package/dist/commonjs/generated/service/operations/knowledgeBases.d.ts.map +1 -0
- package/dist/commonjs/generated/service/operations/knowledgeBases.js +165 -0
- package/dist/commonjs/generated/service/operations/knowledgeBases.js.map +1 -0
- package/dist/commonjs/generated/service/operations/knowledgeSources.d.ts +49 -0
- package/dist/commonjs/generated/service/operations/knowledgeSources.d.ts.map +1 -0
- package/dist/commonjs/generated/service/operations/knowledgeSources.js +189 -0
- package/dist/commonjs/generated/service/operations/knowledgeSources.js.map +1 -0
- package/dist/commonjs/generated/service/operations/skillsets.d.ts +8 -1
- package/dist/commonjs/generated/service/operations/skillsets.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operations/skillsets.js +30 -1
- package/dist/commonjs/generated/service/operations/skillsets.js.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/aliases.d.ts +35 -1
- package/dist/commonjs/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/aliases.js +7 -66
- package/dist/commonjs/generated/service/operationsInterfaces/aliases.js.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/index.d.ts +3 -0
- package/dist/commonjs/generated/service/operationsInterfaces/index.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/index.js +3 -0
- package/dist/commonjs/generated/service/operationsInterfaces/index.js.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/indexers.d.ts +14 -1
- package/dist/commonjs/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/indexers.js.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.js +10 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.js +10 -0
- package/dist/commonjs/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
- package/dist/commonjs/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
- package/dist/commonjs/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
- package/dist/commonjs/generated/service/operationsInterfaces/skillsets.js.map +1 -1
- package/dist/commonjs/generated/service/searchServiceClient.d.ts +12 -4
- package/dist/commonjs/generated/service/searchServiceClient.d.ts.map +1 -1
- package/dist/commonjs/generated/service/searchServiceClient.js +30 -1
- package/dist/commonjs/generated/service/searchServiceClient.js.map +1 -1
- package/dist/commonjs/index.d.ts +7 -4
- package/dist/commonjs/index.d.ts.map +1 -1
- package/dist/commonjs/index.js +71 -44
- package/dist/commonjs/index.js.map +1 -1
- package/dist/commonjs/indexDocumentsBatch.d.ts +6 -5
- package/dist/commonjs/indexDocumentsBatch.d.ts.map +1 -1
- package/dist/commonjs/indexDocumentsBatch.js +5 -4
- package/dist/commonjs/indexDocumentsBatch.js.map +1 -1
- package/dist/commonjs/indexModels.d.ts +236 -30
- package/dist/commonjs/indexModels.d.ts.map +1 -1
- package/dist/commonjs/indexModels.js.map +1 -1
- package/dist/commonjs/knowledgeBaseModels.d.ts +44 -0
- package/dist/commonjs/knowledgeBaseModels.d.ts.map +1 -0
- package/dist/commonjs/knowledgeBaseModels.js +5 -0
- package/dist/commonjs/knowledgeBaseModels.js.map +1 -0
- package/dist/commonjs/knowledgeRetrievalClient.d.ts +68 -0
- package/dist/commonjs/knowledgeRetrievalClient.d.ts.map +1 -0
- package/dist/commonjs/knowledgeRetrievalClient.js +113 -0
- package/dist/commonjs/knowledgeRetrievalClient.js.map +1 -0
- package/dist/commonjs/odata.d.ts +5 -2
- package/dist/commonjs/odata.d.ts.map +1 -1
- package/dist/commonjs/odata.js +5 -2
- package/dist/commonjs/odata.js.map +1 -1
- package/dist/commonjs/odataMetadataPolicy.d.ts +1 -1
- package/dist/commonjs/odataMetadataPolicy.d.ts.map +1 -1
- package/dist/commonjs/odataMetadataPolicy.js.map +1 -1
- package/dist/commonjs/searchApiKeyCredentialPolicy.d.ts +4 -4
- package/dist/commonjs/searchApiKeyCredentialPolicy.d.ts.map +1 -1
- package/dist/commonjs/searchApiKeyCredentialPolicy.js +2 -2
- package/dist/commonjs/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist/commonjs/searchClient.d.ts +64 -53
- package/dist/commonjs/searchClient.d.ts.map +1 -1
- package/dist/commonjs/searchClient.js +113 -53
- package/dist/commonjs/searchClient.js.map +1 -1
- package/dist/commonjs/searchIndexClient.d.ts +157 -18
- package/dist/commonjs/searchIndexClient.d.ts.map +1 -1
- package/dist/commonjs/searchIndexClient.js +482 -17
- package/dist/commonjs/searchIndexClient.js.map +1 -1
- package/dist/commonjs/searchIndexerClient.d.ts +26 -11
- package/dist/commonjs/searchIndexerClient.d.ts.map +1 -1
- package/dist/commonjs/searchIndexerClient.js +62 -7
- package/dist/commonjs/searchIndexerClient.js.map +1 -1
- package/dist/commonjs/searchIndexingBufferedSender.d.ts +3 -3
- package/dist/commonjs/searchIndexingBufferedSender.d.ts.map +1 -1
- package/dist/commonjs/searchIndexingBufferedSender.js +2 -2
- package/dist/commonjs/searchIndexingBufferedSender.js.map +1 -1
- package/dist/commonjs/serviceModels.d.ts +1228 -220
- package/dist/commonjs/serviceModels.d.ts.map +1 -1
- package/dist/commonjs/serviceModels.js +8 -7
- package/dist/commonjs/serviceModels.js.map +1 -1
- package/dist/commonjs/serviceUtils.d.ts +14 -6
- package/dist/commonjs/serviceUtils.d.ts.map +1 -1
- package/dist/commonjs/serviceUtils.js +306 -44
- package/dist/commonjs/serviceUtils.js.map +1 -1
- package/dist/commonjs/synonymMapHelper.d.ts +1 -1
- package/dist/commonjs/synonymMapHelper.d.ts.map +1 -1
- package/dist/commonjs/synonymMapHelper.js +3 -3
- package/dist/commonjs/synonymMapHelper.js.map +1 -1
- package/dist/commonjs/tsdoc-metadata.json +1 -1
- package/dist/esm/errorModels.d.ts +23 -17
- package/dist/esm/errorModels.d.ts.map +1 -1
- package/dist/esm/errorModels.js.map +1 -1
- package/dist/esm/generated/data/models/index.d.ts +593 -20
- package/dist/esm/generated/data/models/index.d.ts.map +1 -1
- package/dist/esm/generated/data/models/index.js +216 -6
- package/dist/esm/generated/data/models/index.js.map +1 -1
- package/dist/esm/generated/data/models/mappers.d.ts +18 -0
- package/dist/esm/generated/data/models/mappers.d.ts.map +1 -1
- package/dist/esm/generated/data/models/mappers.js +463 -4
- package/dist/esm/generated/data/models/mappers.js.map +1 -1
- package/dist/esm/generated/data/models/parameters.d.ts +6 -0
- package/dist/esm/generated/data/models/parameters.d.ts.map +1 -1
- package/dist/esm/generated/data/models/parameters.js +60 -0
- package/dist/esm/generated/data/models/parameters.js.map +1 -1
- package/dist/esm/generated/data/operations/documents.js +20 -3
- package/dist/esm/generated/data/operations/documents.js.map +1 -1
- package/dist/esm/generated/data/searchClient.d.ts +3 -3
- package/dist/esm/generated/data/searchClient.d.ts.map +1 -1
- package/dist/esm/generated/data/searchClient.js +1 -1
- package/dist/esm/generated/data/searchClient.js.map +1 -1
- package/dist/esm/generated/knowledgeBase/index.d.ts +4 -0
- package/dist/esm/generated/knowledgeBase/index.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/index.js +11 -0
- package/dist/esm/generated/knowledgeBase/index.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/models/index.d.ts +561 -0
- package/dist/esm/generated/knowledgeBase/models/index.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/models/index.js +62 -0
- package/dist/esm/generated/knowledgeBase/models/index.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/models/mappers.d.ts +88 -0
- package/dist/esm/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/models/mappers.js +1280 -0
- package/dist/esm/generated/knowledgeBase/models/mappers.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/models/parameters.d.ts +9 -0
- package/dist/esm/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/models/parameters.js +75 -0
- package/dist/esm/generated/knowledgeBase/models/parameters.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/operations/index.d.ts +2 -0
- package/dist/esm/generated/knowledgeBase/operations/index.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/operations/index.js +9 -0
- package/dist/esm/generated/knowledgeBase/operations/index.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
- package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.js +57 -0
- package/dist/esm/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.js +9 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +9 -0
- package/dist/esm/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
- package/dist/esm/generated/knowledgeBase/searchClient.d.ts +21 -0
- package/dist/esm/generated/knowledgeBase/searchClient.d.ts.map +1 -0
- package/dist/esm/generated/knowledgeBase/searchClient.js +88 -0
- package/dist/esm/generated/knowledgeBase/searchClient.js.map +1 -0
- package/dist/esm/generated/service/models/index.d.ts +1403 -131
- package/dist/esm/generated/service/models/index.d.ts.map +1 -1
- package/dist/esm/generated/service/models/index.js +274 -24
- package/dist/esm/generated/service/models/index.js.map +1 -1
- package/dist/esm/generated/service/models/mappers.d.ts +104 -17
- package/dist/esm/generated/service/models/mappers.d.ts.map +1 -1
- package/dist/esm/generated/service/models/mappers.js +3716 -1601
- package/dist/esm/generated/service/models/mappers.js.map +1 -1
- package/dist/esm/generated/service/models/parameters.d.ts +14 -2
- package/dist/esm/generated/service/models/parameters.d.ts.map +1 -1
- package/dist/esm/generated/service/models/parameters.js +89 -7
- package/dist/esm/generated/service/models/parameters.js.map +1 -1
- package/dist/esm/generated/service/operations/aliases.d.ts +43 -1
- package/dist/esm/generated/service/operations/aliases.d.ts.map +1 -1
- package/dist/esm/generated/service/operations/aliases.js +160 -200
- package/dist/esm/generated/service/operations/aliases.js.map +1 -1
- package/dist/esm/generated/service/operations/dataSources.js +4 -1
- package/dist/esm/generated/service/operations/dataSources.js.map +1 -1
- package/dist/esm/generated/service/operations/index.d.ts +3 -0
- package/dist/esm/generated/service/operations/index.d.ts.map +1 -1
- package/dist/esm/generated/service/operations/index.js +3 -0
- package/dist/esm/generated/service/operations/index.js.map +1 -1
- package/dist/esm/generated/service/operations/indexers.d.ts +14 -1
- package/dist/esm/generated/service/operations/indexers.d.ts.map +1 -1
- package/dist/esm/generated/service/operations/indexers.js +54 -1
- package/dist/esm/generated/service/operations/indexers.js.map +1 -1
- package/dist/esm/generated/service/operations/knowledgeBases.d.ts +43 -0
- package/dist/esm/generated/service/operations/knowledgeBases.d.ts.map +1 -0
- package/dist/esm/generated/service/operations/knowledgeBases.js +160 -0
- package/dist/esm/generated/service/operations/knowledgeBases.js.map +1 -0
- package/dist/esm/generated/service/operations/knowledgeSources.d.ts +49 -0
- package/dist/esm/generated/service/operations/knowledgeSources.d.ts.map +1 -0
- package/dist/esm/generated/service/operations/knowledgeSources.js +184 -0
- package/dist/esm/generated/service/operations/knowledgeSources.js.map +1 -0
- package/dist/esm/generated/service/operations/skillsets.d.ts +8 -1
- package/dist/esm/generated/service/operations/skillsets.d.ts.map +1 -1
- package/dist/esm/generated/service/operations/skillsets.js +30 -1
- package/dist/esm/generated/service/operations/skillsets.js.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/aliases.d.ts +35 -1
- package/dist/esm/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/aliases.js +7 -66
- package/dist/esm/generated/service/operationsInterfaces/aliases.js.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/index.d.ts +3 -0
- package/dist/esm/generated/service/operationsInterfaces/index.d.ts.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/index.js +3 -0
- package/dist/esm/generated/service/operationsInterfaces/index.js.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/indexers.d.ts +14 -1
- package/dist/esm/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/indexers.js.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.js +9 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.js +9 -0
- package/dist/esm/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
- package/dist/esm/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
- package/dist/esm/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
- package/dist/esm/generated/service/operationsInterfaces/skillsets.js.map +1 -1
- package/dist/esm/generated/service/searchServiceClient.d.ts +12 -4
- package/dist/esm/generated/service/searchServiceClient.d.ts.map +1 -1
- package/dist/esm/generated/service/searchServiceClient.js +31 -2
- package/dist/esm/generated/service/searchServiceClient.js.map +1 -1
- package/dist/esm/index.d.ts +7 -4
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +5 -3
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/indexDocumentsBatch.d.ts +6 -5
- package/dist/esm/indexDocumentsBatch.d.ts.map +1 -1
- package/dist/esm/indexDocumentsBatch.js +5 -4
- package/dist/esm/indexDocumentsBatch.js.map +1 -1
- package/dist/esm/indexModels.d.ts +236 -30
- package/dist/esm/indexModels.d.ts.map +1 -1
- package/dist/esm/indexModels.js.map +1 -1
- package/dist/esm/knowledgeBaseModels.d.ts +44 -0
- package/dist/esm/knowledgeBaseModels.d.ts.map +1 -0
- package/dist/esm/knowledgeBaseModels.js +4 -0
- package/dist/esm/knowledgeBaseModels.js.map +1 -0
- package/dist/esm/knowledgeRetrievalClient.d.ts +68 -0
- package/dist/esm/knowledgeRetrievalClient.d.ts.map +1 -0
- package/dist/esm/knowledgeRetrievalClient.js +108 -0
- package/dist/esm/knowledgeRetrievalClient.js.map +1 -0
- package/dist/esm/odata.d.ts +5 -2
- package/dist/esm/odata.d.ts.map +1 -1
- package/dist/esm/odata.js +5 -2
- package/dist/esm/odata.js.map +1 -1
- package/dist/esm/odataMetadataPolicy.d.ts +1 -1
- package/dist/esm/odataMetadataPolicy.d.ts.map +1 -1
- package/dist/esm/odataMetadataPolicy.js.map +1 -1
- package/dist/esm/searchApiKeyCredentialPolicy.d.ts +4 -4
- package/dist/esm/searchApiKeyCredentialPolicy.d.ts.map +1 -1
- package/dist/esm/searchApiKeyCredentialPolicy.js +2 -2
- package/dist/esm/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist/esm/searchClient.d.ts +64 -53
- package/dist/esm/searchClient.d.ts.map +1 -1
- package/dist/esm/searchClient.js +113 -53
- package/dist/esm/searchClient.js.map +1 -1
- package/dist/esm/searchIndexClient.d.ts +157 -18
- package/dist/esm/searchIndexClient.d.ts.map +1 -1
- package/dist/esm/searchIndexClient.js +482 -17
- package/dist/esm/searchIndexClient.js.map +1 -1
- package/dist/esm/searchIndexerClient.d.ts +26 -11
- package/dist/esm/searchIndexerClient.d.ts.map +1 -1
- package/dist/esm/searchIndexerClient.js +62 -7
- package/dist/esm/searchIndexerClient.js.map +1 -1
- package/dist/esm/searchIndexingBufferedSender.d.ts +3 -3
- package/dist/esm/searchIndexingBufferedSender.d.ts.map +1 -1
- package/dist/esm/searchIndexingBufferedSender.js +1 -1
- package/dist/esm/searchIndexingBufferedSender.js.map +1 -1
- package/dist/esm/serviceModels.d.ts +1228 -220
- package/dist/esm/serviceModels.d.ts.map +1 -1
- package/dist/esm/serviceModels.js +8 -7
- package/dist/esm/serviceModels.js.map +1 -1
- package/dist/esm/serviceUtils.d.ts +14 -6
- package/dist/esm/serviceUtils.d.ts.map +1 -1
- package/dist/esm/serviceUtils.js +301 -45
- package/dist/esm/serviceUtils.js.map +1 -1
- package/dist/esm/synonymMapHelper.d.ts +1 -1
- package/dist/esm/synonymMapHelper.d.ts.map +1 -1
- package/dist/esm/synonymMapHelper.js +2 -2
- package/dist/esm/synonymMapHelper.js.map +1 -1
- package/dist/react-native/errorModels.d.ts +23 -17
- package/dist/react-native/errorModels.d.ts.map +1 -1
- package/dist/react-native/errorModels.js.map +1 -1
- package/dist/react-native/generated/data/models/index.d.ts +593 -20
- package/dist/react-native/generated/data/models/index.d.ts.map +1 -1
- package/dist/react-native/generated/data/models/index.js +216 -6
- package/dist/react-native/generated/data/models/index.js.map +1 -1
- package/dist/react-native/generated/data/models/mappers.d.ts +18 -0
- package/dist/react-native/generated/data/models/mappers.d.ts.map +1 -1
- package/dist/react-native/generated/data/models/mappers.js +463 -4
- package/dist/react-native/generated/data/models/mappers.js.map +1 -1
- package/dist/react-native/generated/data/models/parameters.d.ts +6 -0
- package/dist/react-native/generated/data/models/parameters.d.ts.map +1 -1
- package/dist/react-native/generated/data/models/parameters.js +60 -0
- package/dist/react-native/generated/data/models/parameters.js.map +1 -1
- package/dist/react-native/generated/data/operations/documents.js +20 -3
- package/dist/react-native/generated/data/operations/documents.js.map +1 -1
- package/dist/react-native/generated/data/searchClient.d.ts +3 -3
- package/dist/react-native/generated/data/searchClient.d.ts.map +1 -1
- package/dist/react-native/generated/data/searchClient.js +1 -1
- package/dist/react-native/generated/data/searchClient.js.map +1 -1
- package/dist/react-native/generated/knowledgeBase/index.d.ts +4 -0
- package/dist/react-native/generated/knowledgeBase/index.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/index.js +11 -0
- package/dist/react-native/generated/knowledgeBase/index.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/models/index.d.ts +561 -0
- package/dist/react-native/generated/knowledgeBase/models/index.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/models/index.js +62 -0
- package/dist/react-native/generated/knowledgeBase/models/index.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/models/mappers.d.ts +88 -0
- package/dist/react-native/generated/knowledgeBase/models/mappers.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/models/mappers.js +1280 -0
- package/dist/react-native/generated/knowledgeBase/models/mappers.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/models/parameters.d.ts +9 -0
- package/dist/react-native/generated/knowledgeBase/models/parameters.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/models/parameters.js +75 -0
- package/dist/react-native/generated/knowledgeBase/models/parameters.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operations/index.d.ts +2 -0
- package/dist/react-native/generated/knowledgeBase/operations/index.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operations/index.js +9 -0
- package/dist/react-native/generated/knowledgeBase/operations/index.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts +19 -0
- package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.js +57 -0
- package/dist/react-native/generated/knowledgeBase/operations/knowledgeRetrieval.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.d.ts +2 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.js +9 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/index.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts +11 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js +9 -0
- package/dist/react-native/generated/knowledgeBase/operationsInterfaces/knowledgeRetrieval.js.map +1 -0
- package/dist/react-native/generated/knowledgeBase/searchClient.d.ts +21 -0
- package/dist/react-native/generated/knowledgeBase/searchClient.d.ts.map +1 -0
- package/dist/react-native/generated/knowledgeBase/searchClient.js +88 -0
- package/dist/react-native/generated/knowledgeBase/searchClient.js.map +1 -0
- package/dist/react-native/generated/service/models/index.d.ts +1403 -131
- package/dist/react-native/generated/service/models/index.d.ts.map +1 -1
- package/dist/react-native/generated/service/models/index.js +274 -24
- package/dist/react-native/generated/service/models/index.js.map +1 -1
- package/dist/react-native/generated/service/models/mappers.d.ts +104 -17
- package/dist/react-native/generated/service/models/mappers.d.ts.map +1 -1
- package/dist/react-native/generated/service/models/mappers.js +3716 -1601
- package/dist/react-native/generated/service/models/mappers.js.map +1 -1
- package/dist/react-native/generated/service/models/parameters.d.ts +14 -2
- package/dist/react-native/generated/service/models/parameters.d.ts.map +1 -1
- package/dist/react-native/generated/service/models/parameters.js +89 -7
- package/dist/react-native/generated/service/models/parameters.js.map +1 -1
- package/dist/react-native/generated/service/operations/aliases.d.ts +43 -1
- package/dist/react-native/generated/service/operations/aliases.d.ts.map +1 -1
- package/dist/react-native/generated/service/operations/aliases.js +160 -200
- package/dist/react-native/generated/service/operations/aliases.js.map +1 -1
- package/dist/react-native/generated/service/operations/dataSources.js +4 -1
- package/dist/react-native/generated/service/operations/dataSources.js.map +1 -1
- package/dist/react-native/generated/service/operations/index.d.ts +3 -0
- package/dist/react-native/generated/service/operations/index.d.ts.map +1 -1
- package/dist/react-native/generated/service/operations/index.js +3 -0
- package/dist/react-native/generated/service/operations/index.js.map +1 -1
- package/dist/react-native/generated/service/operations/indexers.d.ts +14 -1
- package/dist/react-native/generated/service/operations/indexers.d.ts.map +1 -1
- package/dist/react-native/generated/service/operations/indexers.js +54 -1
- package/dist/react-native/generated/service/operations/indexers.js.map +1 -1
- package/dist/react-native/generated/service/operations/knowledgeBases.d.ts +43 -0
- package/dist/react-native/generated/service/operations/knowledgeBases.d.ts.map +1 -0
- package/dist/react-native/generated/service/operations/knowledgeBases.js +160 -0
- package/dist/react-native/generated/service/operations/knowledgeBases.js.map +1 -0
- package/dist/react-native/generated/service/operations/knowledgeSources.d.ts +49 -0
- package/dist/react-native/generated/service/operations/knowledgeSources.d.ts.map +1 -0
- package/dist/react-native/generated/service/operations/knowledgeSources.js +184 -0
- package/dist/react-native/generated/service/operations/knowledgeSources.js.map +1 -0
- package/dist/react-native/generated/service/operations/skillsets.d.ts +8 -1
- package/dist/react-native/generated/service/operations/skillsets.d.ts.map +1 -1
- package/dist/react-native/generated/service/operations/skillsets.js +30 -1
- package/dist/react-native/generated/service/operations/skillsets.js.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/aliases.d.ts +35 -1
- package/dist/react-native/generated/service/operationsInterfaces/aliases.d.ts.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/aliases.js +7 -66
- package/dist/react-native/generated/service/operationsInterfaces/aliases.js.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/index.d.ts +3 -0
- package/dist/react-native/generated/service/operationsInterfaces/index.d.ts.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/index.js +3 -0
- package/dist/react-native/generated/service/operationsInterfaces/index.js.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/indexers.d.ts +14 -1
- package/dist/react-native/generated/service/operationsInterfaces/indexers.d.ts.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/indexers.js.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.d.ts +35 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.d.ts.map +1 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.js +9 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeBases.js.map +1 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.d.ts +41 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.d.ts.map +1 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.js +9 -0
- package/dist/react-native/generated/service/operationsInterfaces/knowledgeSources.js.map +1 -0
- package/dist/react-native/generated/service/operationsInterfaces/skillsets.d.ts +8 -1
- package/dist/react-native/generated/service/operationsInterfaces/skillsets.d.ts.map +1 -1
- package/dist/react-native/generated/service/operationsInterfaces/skillsets.js.map +1 -1
- package/dist/react-native/generated/service/searchServiceClient.d.ts +12 -4
- package/dist/react-native/generated/service/searchServiceClient.d.ts.map +1 -1
- package/dist/react-native/generated/service/searchServiceClient.js +31 -2
- package/dist/react-native/generated/service/searchServiceClient.js.map +1 -1
- package/dist/react-native/index.d.ts +7 -4
- package/dist/react-native/index.d.ts.map +1 -1
- package/dist/react-native/index.js +5 -3
- package/dist/react-native/index.js.map +1 -1
- package/dist/react-native/indexDocumentsBatch.d.ts +6 -5
- package/dist/react-native/indexDocumentsBatch.d.ts.map +1 -1
- package/dist/react-native/indexDocumentsBatch.js +5 -4
- package/dist/react-native/indexDocumentsBatch.js.map +1 -1
- package/dist/react-native/indexModels.d.ts +236 -30
- package/dist/react-native/indexModels.d.ts.map +1 -1
- package/dist/react-native/indexModels.js.map +1 -1
- package/dist/react-native/knowledgeBaseModels.d.ts +44 -0
- package/dist/react-native/knowledgeBaseModels.d.ts.map +1 -0
- package/dist/react-native/knowledgeBaseModels.js +4 -0
- package/dist/react-native/knowledgeBaseModels.js.map +1 -0
- package/dist/react-native/knowledgeRetrievalClient.d.ts +68 -0
- package/dist/react-native/knowledgeRetrievalClient.d.ts.map +1 -0
- package/dist/react-native/knowledgeRetrievalClient.js +108 -0
- package/dist/react-native/knowledgeRetrievalClient.js.map +1 -0
- package/dist/react-native/odata.d.ts +5 -2
- package/dist/react-native/odata.d.ts.map +1 -1
- package/dist/react-native/odata.js +5 -2
- package/dist/react-native/odata.js.map +1 -1
- package/dist/react-native/odataMetadataPolicy.d.ts +1 -1
- package/dist/react-native/odataMetadataPolicy.d.ts.map +1 -1
- package/dist/react-native/odataMetadataPolicy.js.map +1 -1
- package/dist/react-native/searchApiKeyCredentialPolicy.d.ts +4 -4
- package/dist/react-native/searchApiKeyCredentialPolicy.d.ts.map +1 -1
- package/dist/react-native/searchApiKeyCredentialPolicy.js +2 -2
- package/dist/react-native/searchApiKeyCredentialPolicy.js.map +1 -1
- package/dist/react-native/searchClient.d.ts +64 -53
- package/dist/react-native/searchClient.d.ts.map +1 -1
- package/dist/react-native/searchClient.js +113 -53
- package/dist/react-native/searchClient.js.map +1 -1
- package/dist/react-native/searchIndexClient.d.ts +157 -18
- package/dist/react-native/searchIndexClient.d.ts.map +1 -1
- package/dist/react-native/searchIndexClient.js +482 -17
- package/dist/react-native/searchIndexClient.js.map +1 -1
- package/dist/react-native/searchIndexerClient.d.ts +26 -11
- package/dist/react-native/searchIndexerClient.d.ts.map +1 -1
- package/dist/react-native/searchIndexerClient.js +62 -7
- package/dist/react-native/searchIndexerClient.js.map +1 -1
- package/dist/react-native/searchIndexingBufferedSender.d.ts +3 -3
- package/dist/react-native/searchIndexingBufferedSender.d.ts.map +1 -1
- package/dist/react-native/searchIndexingBufferedSender.js +1 -1
- package/dist/react-native/searchIndexingBufferedSender.js.map +1 -1
- package/dist/react-native/serviceModels.d.ts +1228 -220
- package/dist/react-native/serviceModels.d.ts.map +1 -1
- package/dist/react-native/serviceModels.js +8 -7
- package/dist/react-native/serviceModels.js.map +1 -1
- package/dist/react-native/serviceUtils.d.ts +14 -6
- package/dist/react-native/serviceUtils.d.ts.map +1 -1
- package/dist/react-native/serviceUtils.js +301 -45
- package/dist/react-native/serviceUtils.js.map +1 -1
- package/dist/react-native/synonymMapHelper.d.ts +1 -1
- package/dist/react-native/synonymMapHelper.d.ts.map +1 -1
- package/dist/react-native/synonymMapHelper.js +2 -2
- package/dist/react-native/synonymMapHelper.js.map +1 -1
- package/package.json +13 -9
|
@@ -1,73 +1,70 @@
|
|
|
1
1
|
import * as coreClient from "@azure/core-client";
|
|
2
2
|
import * as coreHttpCompat from "@azure/core-http-compat";
|
|
3
|
+
export type KnowledgeBaseModelUnion = KnowledgeBaseModel | KnowledgeBaseAzureOpenAIModel;
|
|
4
|
+
export type KnowledgeRetrievalReasoningEffortUnion = KnowledgeRetrievalReasoningEffort | KnowledgeRetrievalMinimalReasoningEffort | KnowledgeRetrievalLowReasoningEffort | KnowledgeRetrievalMediumReasoningEffort;
|
|
5
|
+
export type SearchIndexerDataIdentityUnion = SearchIndexerDataIdentity | SearchIndexerDataNoneIdentity | SearchIndexerDataUserAssignedIdentity;
|
|
6
|
+
export type KnowledgeSourceUnion = KnowledgeSource | SearchIndexKnowledgeSource | AzureBlobKnowledgeSource | IndexedSharePointKnowledgeSource | IndexedOneLakeKnowledgeSource | WebKnowledgeSource | RemoteSharePointKnowledgeSource;
|
|
3
7
|
export type DataChangeDetectionPolicyUnion = DataChangeDetectionPolicy | HighWaterMarkChangeDetectionPolicy | SqlIntegratedChangeTrackingPolicy;
|
|
4
|
-
export type DataDeletionDetectionPolicyUnion = DataDeletionDetectionPolicy | SoftDeleteColumnDeletionDetectionPolicy;
|
|
5
|
-
export type SearchIndexerSkillUnion = SearchIndexerSkill | ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SentimentSkillV3 | EntityLinkingSkill | EntityRecognitionSkillV3 | PIIDetectionSkill | SplitSkill | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill |
|
|
6
|
-
export type CognitiveServicesAccountUnion = CognitiveServicesAccount | DefaultCognitiveServicesAccount | CognitiveServicesAccountKey;
|
|
8
|
+
export type DataDeletionDetectionPolicyUnion = DataDeletionDetectionPolicy | SoftDeleteColumnDeletionDetectionPolicy | NativeBlobSoftDeleteDeletionDetectionPolicy;
|
|
9
|
+
export type SearchIndexerSkillUnion = SearchIndexerSkill | ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SentimentSkillV3 | EntityLinkingSkill | EntityRecognitionSkillV3 | PIIDetectionSkill | SplitSkill | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill | WebApiSkillUnion | ContentUnderstandingSkill | AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill | VisionVectorizeSkill;
|
|
10
|
+
export type CognitiveServicesAccountUnion = CognitiveServicesAccount | DefaultCognitiveServicesAccount | CognitiveServicesAccountKey | AIServicesAccountKey | AIServicesAccountIdentity;
|
|
7
11
|
export type ScoringFunctionUnion = ScoringFunction | DistanceScoringFunction | FreshnessScoringFunction | MagnitudeScoringFunction | TagScoringFunction;
|
|
8
12
|
export type LexicalAnalyzerUnion = LexicalAnalyzer | CustomAnalyzer | PatternAnalyzer | LuceneStandardAnalyzer | StopAnalyzer;
|
|
9
13
|
export type LexicalTokenizerUnion = LexicalTokenizer | ClassicTokenizer | EdgeNGramTokenizer | KeywordTokenizer | KeywordTokenizerV2 | MicrosoftLanguageTokenizer | MicrosoftLanguageStemmingTokenizer | NGramTokenizer | PathHierarchyTokenizerV2 | PatternTokenizer | LuceneStandardTokenizer | LuceneStandardTokenizerV2 | UaxUrlEmailTokenizer;
|
|
10
14
|
export type TokenFilterUnion = TokenFilter | AsciiFoldingTokenFilter | CjkBigramTokenFilter | CommonGramTokenFilter | DictionaryDecompounderTokenFilter | EdgeNGramTokenFilter | EdgeNGramTokenFilterV2 | ElisionTokenFilter | KeepTokenFilter | KeywordMarkerTokenFilter | LengthTokenFilter | LimitTokenFilter | NGramTokenFilter | NGramTokenFilterV2 | PatternCaptureTokenFilter | PatternReplaceTokenFilter | PhoneticTokenFilter | ShingleTokenFilter | SnowballTokenFilter | StemmerTokenFilter | StemmerOverrideTokenFilter | StopwordsTokenFilter | SynonymTokenFilter | TruncateTokenFilter | UniqueTokenFilter | WordDelimiterTokenFilter;
|
|
11
15
|
export type CharFilterUnion = CharFilter | MappingCharFilter | PatternReplaceCharFilter;
|
|
12
|
-
export type
|
|
16
|
+
export type LexicalNormalizerUnion = LexicalNormalizer | CustomNormalizer;
|
|
13
17
|
export type SimilarityUnion = Similarity | ClassicSimilarity | BM25Similarity;
|
|
14
18
|
export type VectorSearchAlgorithmConfigurationUnion = VectorSearchAlgorithmConfiguration | HnswAlgorithmConfiguration | ExhaustiveKnnAlgorithmConfiguration;
|
|
15
|
-
export type VectorSearchVectorizerUnion = VectorSearchVectorizer | AzureOpenAIVectorizer | WebApiVectorizer;
|
|
19
|
+
export type VectorSearchVectorizerUnion = VectorSearchVectorizer | AzureOpenAIVectorizer | WebApiVectorizer | AIServicesVisionVectorizer | AMLVectorizer;
|
|
16
20
|
export type VectorSearchCompressionUnion = VectorSearchCompression | ScalarQuantizationCompression | BinaryQuantizationCompression;
|
|
17
|
-
export type
|
|
18
|
-
|
|
19
|
-
export interface
|
|
20
|
-
/** The name of the
|
|
21
|
+
export type KnowledgeSourceVectorizerUnion = KnowledgeSourceVectorizer | KnowledgeSourceAzureOpenAIVectorizer;
|
|
22
|
+
export type WebApiSkillUnion = WebApiSkill | ChatCompletionSkill;
|
|
23
|
+
export interface KnowledgeBase {
|
|
24
|
+
/** The name of the knowledge knowledge base. */
|
|
21
25
|
name: string;
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
/**
|
|
27
|
-
|
|
28
|
-
/** The
|
|
29
|
-
container: SearchIndexerDataContainer;
|
|
30
|
-
/** The data change detection policy for the datasource. */
|
|
31
|
-
dataChangeDetectionPolicy?: DataChangeDetectionPolicyUnion;
|
|
32
|
-
/** The data deletion detection policy for the datasource. */
|
|
33
|
-
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicyUnion;
|
|
34
|
-
/** The ETag of the data source. */
|
|
26
|
+
knowledgeSources: KnowledgeSourceReference[];
|
|
27
|
+
/** Contains configuration options on how to connect to AI models. */
|
|
28
|
+
models?: KnowledgeBaseModelUnion[];
|
|
29
|
+
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;
|
|
30
|
+
/** The output configuration for this retrieval. */
|
|
31
|
+
outputMode?: KnowledgeRetrievalOutputMode;
|
|
32
|
+
/** The ETag of the knowledge base. */
|
|
35
33
|
etag?: string;
|
|
36
|
-
/** 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
|
|
34
|
+
/** 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. */
|
|
37
35
|
encryptionKey?: SearchResourceEncryptionKey;
|
|
36
|
+
/** The description of the knowledge base. */
|
|
37
|
+
description?: string;
|
|
38
|
+
/** Instructions considered by the knowledge knowledge base when developing query plan. */
|
|
39
|
+
retrievalInstructions?: string;
|
|
40
|
+
/** Instructions considered by the knowledge knowledge base when generating answers. */
|
|
41
|
+
answerInstructions?: string;
|
|
38
42
|
}
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
/** The connection string for the datasource. For Azure SQL, Azure Blob, ADLS Gen 2 and Azure Table, this would be the connection string or resource ID if using managed identity. For CosmosDB this would be a formatted connection string specifying ApiKind or resource ID for managed identity. For Onelake files, connection string would be either the workspace guid or workspace FQDN; Onelake only supports managed identity connections. Set to `<unchanged>` (with brackets) if you don't want the connection string updated. Set to `<redacted>` if you want to remove the connection string value from the datasource. */
|
|
42
|
-
connectionString?: string;
|
|
43
|
-
}
|
|
44
|
-
/** Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. */
|
|
45
|
-
export interface SearchIndexerDataContainer {
|
|
46
|
-
/** The name of the table or view (for Azure SQL datasource), collection (for CosmosDB datasource), container (for Azure Blob and ADLS Gen 2 datasources), Azure Table (for Azure Table datasource), or lakehouse (for Onelake datasource) that will be indexed. */
|
|
43
|
+
export interface KnowledgeSourceReference {
|
|
44
|
+
/** The name of the knowledge source. */
|
|
47
45
|
name: string;
|
|
48
|
-
/** A query that is applied to this data container. For CosmosDB datasource query can flatten and filter data. For Azure Blob and ADLS Gen 2 query can filter by folders. For Azure Table query can filter by row data. For Onelake query can filter by folder or shortcut. Not supported by Azure SQL datasources. */
|
|
49
|
-
query?: string;
|
|
50
46
|
}
|
|
51
|
-
/**
|
|
52
|
-
export interface
|
|
47
|
+
/** Specifies the connection parameters for the model to use for query planning. */
|
|
48
|
+
export interface KnowledgeBaseModel {
|
|
53
49
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
54
|
-
|
|
50
|
+
kind: "azureOpenAI";
|
|
55
51
|
}
|
|
56
|
-
|
|
57
|
-
export interface DataDeletionDetectionPolicy {
|
|
52
|
+
export interface KnowledgeRetrievalReasoningEffort {
|
|
58
53
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
59
|
-
|
|
54
|
+
kind: "minimal" | "low" | "medium";
|
|
60
55
|
}
|
|
61
56
|
/** A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps. */
|
|
62
57
|
export interface SearchResourceEncryptionKey {
|
|
63
58
|
/** The name of your Azure Key Vault key to be used to encrypt your data at rest. */
|
|
64
59
|
keyName: string;
|
|
65
60
|
/** The version of your Azure Key Vault key to be used to encrypt your data at rest. */
|
|
66
|
-
keyVersion
|
|
61
|
+
keyVersion?: string;
|
|
67
62
|
/** The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. */
|
|
68
63
|
vaultUri: string;
|
|
69
64
|
/** Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. */
|
|
70
65
|
accessCredentials?: AzureActiveDirectoryApplicationCredentials;
|
|
66
|
+
/** An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. */
|
|
67
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
71
68
|
}
|
|
72
69
|
/** Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault. */
|
|
73
70
|
export interface AzureActiveDirectoryApplicationCredentials {
|
|
@@ -76,6 +73,11 @@ export interface AzureActiveDirectoryApplicationCredentials {
|
|
|
76
73
|
/** The authentication key of the specified AAD application. */
|
|
77
74
|
applicationSecret?: string;
|
|
78
75
|
}
|
|
76
|
+
/** Abstract base type for data identities. */
|
|
77
|
+
export interface SearchIndexerDataIdentity {
|
|
78
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
79
|
+
odatatype: "#Microsoft.Azure.Search.DataNoneIdentity" | "#Microsoft.Azure.Search.DataUserAssignedIdentity";
|
|
80
|
+
}
|
|
79
81
|
/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
|
|
80
82
|
export interface ErrorResponse {
|
|
81
83
|
/** The error object. */
|
|
@@ -122,6 +124,123 @@ export interface ErrorAdditionalInfo {
|
|
|
122
124
|
*/
|
|
123
125
|
readonly info?: Record<string, unknown>;
|
|
124
126
|
}
|
|
127
|
+
export interface ListKnowledgeBasesResult {
|
|
128
|
+
knowledgeBases: KnowledgeBase[];
|
|
129
|
+
}
|
|
130
|
+
/** Represents a knowledge source definition. */
|
|
131
|
+
export interface KnowledgeSource {
|
|
132
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
133
|
+
kind: "searchIndex" | "azureBlob" | "indexedSharePoint" | "indexedOneLake" | "web" | "remoteSharePoint";
|
|
134
|
+
/** The name of the knowledge source. */
|
|
135
|
+
name: string;
|
|
136
|
+
/** Optional user-defined description. */
|
|
137
|
+
description?: string;
|
|
138
|
+
/** The ETag of the knowledge base. */
|
|
139
|
+
etag?: string;
|
|
140
|
+
/** 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. */
|
|
141
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
142
|
+
}
|
|
143
|
+
export interface ListKnowledgeSourcesResult {
|
|
144
|
+
knowledgeSources: KnowledgeSourceUnion[];
|
|
145
|
+
}
|
|
146
|
+
/** Represents the status and synchronization history of a knowledge source. */
|
|
147
|
+
export interface KnowledgeSourceStatus {
|
|
148
|
+
/** The current synchronization status of the knowledge source. */
|
|
149
|
+
synchronizationStatus: KnowledgeSourceSynchronizationStatus;
|
|
150
|
+
/** The synchronization interval (e.g., '1d' for daily). Null if no schedule is configured. */
|
|
151
|
+
synchronizationInterval?: string;
|
|
152
|
+
/** Current synchronization state that spans multiple indexer runs. */
|
|
153
|
+
currentSynchronizationState?: SynchronizationState;
|
|
154
|
+
/** Details of the last completed synchronization. Null on first sync. */
|
|
155
|
+
lastSynchronizationState?: CompletedSynchronizationState;
|
|
156
|
+
/** Statistical information about the knowledge source synchronization history. Null on first sync. */
|
|
157
|
+
statistics?: KnowledgeSourceStatistics;
|
|
158
|
+
}
|
|
159
|
+
/** Represents the current state of an ongoing synchronization that spans multiple indexer runs. */
|
|
160
|
+
export interface SynchronizationState {
|
|
161
|
+
/** The start time of the current synchronization. */
|
|
162
|
+
startTime: Date;
|
|
163
|
+
/** The number of item updates successfully processed in the current synchronization. */
|
|
164
|
+
itemsUpdatesProcessed: number;
|
|
165
|
+
/** The number of item updates that failed in the current synchronization. */
|
|
166
|
+
itemsUpdatesFailed: number;
|
|
167
|
+
/** The number of items skipped in the current synchronization. */
|
|
168
|
+
itemsSkipped: number;
|
|
169
|
+
}
|
|
170
|
+
/** Represents the completed state of the last synchronization. */
|
|
171
|
+
export interface CompletedSynchronizationState {
|
|
172
|
+
/** The start time of the last completed synchronization. */
|
|
173
|
+
startTime: Date;
|
|
174
|
+
/** The end time of the last completed synchronization. */
|
|
175
|
+
endTime: Date;
|
|
176
|
+
/** The number of item updates successfully processed in the last synchronization. */
|
|
177
|
+
itemsUpdatesProcessed: number;
|
|
178
|
+
/** The number of item updates that failed in the last synchronization. */
|
|
179
|
+
itemsUpdatesFailed: number;
|
|
180
|
+
/** The number of items skipped in the last synchronization. */
|
|
181
|
+
itemsSkipped: number;
|
|
182
|
+
}
|
|
183
|
+
/** Statistical information about knowledge source synchronization history. */
|
|
184
|
+
export interface KnowledgeSourceStatistics {
|
|
185
|
+
/** The total number of synchronizations completed. */
|
|
186
|
+
totalSynchronization: number;
|
|
187
|
+
/** The average duration of synchronizations in HH:MM:SS format. */
|
|
188
|
+
averageSynchronizationDuration: string;
|
|
189
|
+
/** The average number of items processed per synchronization. */
|
|
190
|
+
averageItemsProcessedPerSynchronization: number;
|
|
191
|
+
}
|
|
192
|
+
/** Represents a datasource definition, which can be used to configure an indexer. */
|
|
193
|
+
export interface SearchIndexerDataSource {
|
|
194
|
+
/** The name of the datasource. */
|
|
195
|
+
name: string;
|
|
196
|
+
/** The description of the datasource. */
|
|
197
|
+
description?: string;
|
|
198
|
+
/** The type of the datasource. */
|
|
199
|
+
type: SearchIndexerDataSourceType;
|
|
200
|
+
/**
|
|
201
|
+
* A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts.
|
|
202
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
203
|
+
*/
|
|
204
|
+
readonly subType?: string;
|
|
205
|
+
/** Credentials for the datasource. */
|
|
206
|
+
credentials: DataSourceCredentials;
|
|
207
|
+
/** The data container for the datasource. */
|
|
208
|
+
container: SearchIndexerDataContainer;
|
|
209
|
+
/** An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. */
|
|
210
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
211
|
+
/** Ingestion options with various types of permission data. */
|
|
212
|
+
indexerPermissionOptions?: IndexerPermissionOption[];
|
|
213
|
+
/** The data change detection policy for the datasource. */
|
|
214
|
+
dataChangeDetectionPolicy?: DataChangeDetectionPolicyUnion;
|
|
215
|
+
/** The data deletion detection policy for the datasource. */
|
|
216
|
+
dataDeletionDetectionPolicy?: DataDeletionDetectionPolicyUnion;
|
|
217
|
+
/** The ETag of the data source. */
|
|
218
|
+
etag?: string;
|
|
219
|
+
/** 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 datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source 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 datasource 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. */
|
|
220
|
+
encryptionKey?: SearchResourceEncryptionKey;
|
|
221
|
+
}
|
|
222
|
+
/** Represents credentials that can be used to connect to a datasource. */
|
|
223
|
+
export interface DataSourceCredentials {
|
|
224
|
+
/** The connection string for the datasource. Set to `<unchanged>` (with brackets) if you don't want the connection string updated. Set to `<redacted>` if you want to remove the connection string value from the datasource. */
|
|
225
|
+
connectionString?: string;
|
|
226
|
+
}
|
|
227
|
+
/** Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. */
|
|
228
|
+
export interface SearchIndexerDataContainer {
|
|
229
|
+
/** The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. */
|
|
230
|
+
name: string;
|
|
231
|
+
/** A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. */
|
|
232
|
+
query?: string;
|
|
233
|
+
}
|
|
234
|
+
/** Base type for data change detection policies. */
|
|
235
|
+
export interface DataChangeDetectionPolicy {
|
|
236
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
237
|
+
odatatype: "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" | "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy";
|
|
238
|
+
}
|
|
239
|
+
/** Base type for data deletion detection policies. */
|
|
240
|
+
export interface DataDeletionDetectionPolicy {
|
|
241
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
242
|
+
odatatype: "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" | "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy";
|
|
243
|
+
}
|
|
125
244
|
/** Response from a List Datasources request. If successful, it includes the full definitions of all datasources. */
|
|
126
245
|
export interface ListDataSourcesResult {
|
|
127
246
|
/**
|
|
@@ -130,6 +249,16 @@ export interface ListDataSourcesResult {
|
|
|
130
249
|
*/
|
|
131
250
|
readonly dataSources: SearchIndexerDataSource[];
|
|
132
251
|
}
|
|
252
|
+
export interface DocumentKeysOrIds {
|
|
253
|
+
/** document keys to be reset */
|
|
254
|
+
documentKeys?: string[];
|
|
255
|
+
/** datasource document identifiers to be reset */
|
|
256
|
+
datasourceDocumentIds?: string[];
|
|
257
|
+
}
|
|
258
|
+
export interface IndexerResyncBody {
|
|
259
|
+
/** Re-sync options that have been pre-defined from data source. */
|
|
260
|
+
options?: IndexerResyncOption[];
|
|
261
|
+
}
|
|
133
262
|
/** Represents an indexer. */
|
|
134
263
|
export interface SearchIndexer {
|
|
135
264
|
/** The name of the indexer. */
|
|
@@ -156,6 +285,8 @@ export interface SearchIndexer {
|
|
|
156
285
|
etag?: string;
|
|
157
286
|
/** 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 indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer 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 indexer definition (and indexer execution status) 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. */
|
|
158
287
|
encryptionKey?: SearchResourceEncryptionKey;
|
|
288
|
+
/** Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. */
|
|
289
|
+
cache?: SearchIndexerCache;
|
|
159
290
|
}
|
|
160
291
|
/** Represents a schedule for indexer execution. */
|
|
161
292
|
export interface IndexingSchedule {
|
|
@@ -197,6 +328,10 @@ export interface IndexingParametersConfiguration {
|
|
|
197
328
|
delimitedTextDelimiter?: string;
|
|
198
329
|
/** For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. */
|
|
199
330
|
firstLineContainsHeaders?: boolean;
|
|
331
|
+
/** Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. */
|
|
332
|
+
markdownParsingSubmode?: MarkdownParsingSubmode;
|
|
333
|
+
/** Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. */
|
|
334
|
+
markdownHeaderDepth?: MarkdownHeaderDepth;
|
|
200
335
|
/** For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. */
|
|
201
336
|
documentRoot?: string;
|
|
202
337
|
/** 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. */
|
|
@@ -230,6 +365,16 @@ export interface FieldMappingFunction {
|
|
|
230
365
|
[propertyName: string]: any;
|
|
231
366
|
};
|
|
232
367
|
}
|
|
368
|
+
export interface SearchIndexerCache {
|
|
369
|
+
/** A guid for the SearchIndexerCache. */
|
|
370
|
+
id?: string;
|
|
371
|
+
/** The connection string to the storage account where the cache data will be persisted. */
|
|
372
|
+
storageConnectionString?: string;
|
|
373
|
+
/** Specifies whether incremental reprocessing is enabled. */
|
|
374
|
+
enableReprocessing?: boolean;
|
|
375
|
+
/** The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) 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. */
|
|
376
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
377
|
+
}
|
|
233
378
|
/** Response from a List Indexers request. If successful, it includes the full definitions of all indexers. */
|
|
234
379
|
export interface ListIndexersResult {
|
|
235
380
|
/**
|
|
@@ -250,6 +395,11 @@ export interface SearchIndexerStatus {
|
|
|
250
395
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
251
396
|
*/
|
|
252
397
|
readonly status: IndexerStatus;
|
|
398
|
+
/**
|
|
399
|
+
* Snapshot of the indexer’s cumulative runtime consumption for the service over the current UTC period.
|
|
400
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
401
|
+
*/
|
|
402
|
+
readonly runtime: IndexerRuntime;
|
|
253
403
|
/**
|
|
254
404
|
* The result of the most recent or an in-progress indexer execution.
|
|
255
405
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -265,6 +415,22 @@ export interface SearchIndexerStatus {
|
|
|
265
415
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
266
416
|
*/
|
|
267
417
|
readonly limits: SearchIndexerLimits;
|
|
418
|
+
/**
|
|
419
|
+
* All of the state that defines and dictates the indexer's current execution.
|
|
420
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
421
|
+
*/
|
|
422
|
+
readonly currentState?: IndexerState;
|
|
423
|
+
}
|
|
424
|
+
/** Represents the indexer's cumulative runtime consumption in the service. */
|
|
425
|
+
export interface IndexerRuntime {
|
|
426
|
+
/** Cumulative runtime of the indexer from the beginningTime to endingTime, in seconds. */
|
|
427
|
+
usedSeconds: number;
|
|
428
|
+
/** Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds. */
|
|
429
|
+
remainingSeconds?: number;
|
|
430
|
+
/** Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
431
|
+
beginningTime: Date;
|
|
432
|
+
/** End UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
433
|
+
endingTime: Date;
|
|
268
434
|
}
|
|
269
435
|
/** Represents the result of an individual indexer execution. */
|
|
270
436
|
export interface IndexerExecutionResult {
|
|
@@ -273,6 +439,16 @@ export interface IndexerExecutionResult {
|
|
|
273
439
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
274
440
|
*/
|
|
275
441
|
readonly status: IndexerExecutionStatus;
|
|
442
|
+
/**
|
|
443
|
+
* The outcome of this indexer execution.
|
|
444
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
445
|
+
*/
|
|
446
|
+
readonly statusDetail?: IndexerExecutionStatusDetail;
|
|
447
|
+
/**
|
|
448
|
+
* The mode the indexer is running in.
|
|
449
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
450
|
+
*/
|
|
451
|
+
readonly mode?: IndexingMode;
|
|
276
452
|
/**
|
|
277
453
|
* The error message indicating the top-level error, if any.
|
|
278
454
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -397,6 +573,54 @@ export interface SearchIndexerLimits {
|
|
|
397
573
|
*/
|
|
398
574
|
readonly maxDocumentContentCharactersToExtract?: number;
|
|
399
575
|
}
|
|
576
|
+
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
577
|
+
export interface IndexerState {
|
|
578
|
+
/**
|
|
579
|
+
* The mode the indexer is running in.
|
|
580
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
581
|
+
*/
|
|
582
|
+
readonly mode?: IndexingMode;
|
|
583
|
+
/**
|
|
584
|
+
* Change tracking state used when indexing starts on all documents in the datasource.
|
|
585
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
586
|
+
*/
|
|
587
|
+
readonly allDocsInitialTrackingState?: string;
|
|
588
|
+
/**
|
|
589
|
+
* Change tracking state value when indexing finishes on all documents in the datasource.
|
|
590
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
591
|
+
*/
|
|
592
|
+
readonly allDocsFinalTrackingState?: string;
|
|
593
|
+
/**
|
|
594
|
+
* Change tracking state used when indexing starts on select, reset documents in the datasource.
|
|
595
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
596
|
+
*/
|
|
597
|
+
readonly resetDocsInitialTrackingState?: string;
|
|
598
|
+
/**
|
|
599
|
+
* Change tracking state value when indexing finishes on select, reset documents in the datasource.
|
|
600
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
601
|
+
*/
|
|
602
|
+
readonly resetDocsFinalTrackingState?: string;
|
|
603
|
+
/**
|
|
604
|
+
* The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
|
|
605
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
606
|
+
*/
|
|
607
|
+
readonly resetDocumentKeys?: string[];
|
|
608
|
+
/**
|
|
609
|
+
* The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
|
|
610
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
611
|
+
*/
|
|
612
|
+
readonly resetDatasourceDocumentIds?: string[];
|
|
613
|
+
/**
|
|
614
|
+
* Change tracking state used when indexing starts on selective options from the datasource.
|
|
615
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
616
|
+
*/
|
|
617
|
+
readonly resyncInitialTrackingState?: string;
|
|
618
|
+
/**
|
|
619
|
+
* Change tracking state value when indexing finishes on selective options from the datasource.
|
|
620
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
621
|
+
*/
|
|
622
|
+
readonly resyncFinalTrackingState?: string;
|
|
623
|
+
}
|
|
400
624
|
/** A list of skills. */
|
|
401
625
|
export interface SearchIndexerSkillset {
|
|
402
626
|
/** The name of the skillset. */
|
|
@@ -419,7 +643,7 @@ export interface SearchIndexerSkillset {
|
|
|
419
643
|
/** Base type for skills. */
|
|
420
644
|
export interface SearchIndexerSkill {
|
|
421
645
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
422
|
-
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill";
|
|
646
|
+
odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.ChatCompletionSkill" | "#Microsoft.Skills.Util.ContentUnderstandingSkill" | "#Microsoft.Skills.Custom.AmlSkill" | "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill" | "#Microsoft.Skills.Vision.VectorizeSkill";
|
|
423
647
|
/** The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. */
|
|
424
648
|
name?: string;
|
|
425
649
|
/** The description of the skill which describes the inputs, outputs, and usage of the skill. */
|
|
@@ -452,7 +676,7 @@ export interface OutputFieldMappingEntry {
|
|
|
452
676
|
/** Base type for describing any Azure AI service resource attached to a skillset. */
|
|
453
677
|
export interface CognitiveServicesAccount {
|
|
454
678
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
455
|
-
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices" | "#Microsoft.Azure.Search.CognitiveServicesByKey";
|
|
679
|
+
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices" | "#Microsoft.Azure.Search.CognitiveServicesByKey" | "#Microsoft.Azure.Search.AIServicesByKey" | "#Microsoft.Azure.Search.AIServicesByIdentity";
|
|
456
680
|
/** Description of the Azure AI service resource attached to a skillset. */
|
|
457
681
|
description?: string;
|
|
458
682
|
}
|
|
@@ -462,6 +686,10 @@ export interface SearchIndexerKnowledgeStore {
|
|
|
462
686
|
storageConnectionString: string;
|
|
463
687
|
/** A list of additional projections to perform during indexing. */
|
|
464
688
|
projections: SearchIndexerKnowledgeStoreProjection[];
|
|
689
|
+
/** The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) 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. */
|
|
690
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
691
|
+
/** 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. */
|
|
692
|
+
parameters?: SearchIndexerKnowledgeStoreParameters;
|
|
465
693
|
}
|
|
466
694
|
/** Container object for various projection selectors. */
|
|
467
695
|
export interface SearchIndexerKnowledgeStoreProjection {
|
|
@@ -485,6 +713,13 @@ export interface SearchIndexerKnowledgeStoreProjectionSelector {
|
|
|
485
713
|
/** Nested inputs for complex projections. */
|
|
486
714
|
inputs?: InputFieldMappingEntry[];
|
|
487
715
|
}
|
|
716
|
+
/** 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. */
|
|
717
|
+
export interface SearchIndexerKnowledgeStoreParameters {
|
|
718
|
+
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
719
|
+
[property: string]: any;
|
|
720
|
+
/** Whether or not projections should synthesize a generated key name if one isn't already present. */
|
|
721
|
+
synthesizeGeneratedKeyName?: boolean;
|
|
722
|
+
}
|
|
488
723
|
/** Definition of additional projections to secondary search indexes. */
|
|
489
724
|
export interface SearchIndexerIndexProjection {
|
|
490
725
|
/** A list of projections to be performed to secondary search indexes. */
|
|
@@ -518,6 +753,10 @@ export interface ListSkillsetsResult {
|
|
|
518
753
|
*/
|
|
519
754
|
readonly skillsets: SearchIndexerSkillset[];
|
|
520
755
|
}
|
|
756
|
+
export interface SkillNames {
|
|
757
|
+
/** the names of skills to be reset. */
|
|
758
|
+
skillNames?: string[];
|
|
759
|
+
}
|
|
521
760
|
/** Represents a synonym map definition. */
|
|
522
761
|
export interface SynonymMap {
|
|
523
762
|
/** The name of the synonym map. */
|
|
@@ -564,7 +803,7 @@ export interface SearchIndex {
|
|
|
564
803
|
/** The character filters for the index. */
|
|
565
804
|
charFilters?: CharFilterUnion[];
|
|
566
805
|
/** The normalizers for the index. */
|
|
567
|
-
normalizers?:
|
|
806
|
+
normalizers?: LexicalNormalizerUnion[];
|
|
568
807
|
/** 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 data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, 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 data 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. */
|
|
569
808
|
encryptionKey?: SearchResourceEncryptionKey;
|
|
570
809
|
/** The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. */
|
|
@@ -573,6 +812,10 @@ export interface SearchIndex {
|
|
|
573
812
|
semanticSearch?: SemanticSearch;
|
|
574
813
|
/** Contains configuration options related to vector search. */
|
|
575
814
|
vectorSearch?: VectorSearch;
|
|
815
|
+
/** A value indicating whether permission filtering is enabled for the index. */
|
|
816
|
+
permissionFilterOption?: SearchIndexPermissionFilterOption;
|
|
817
|
+
/** A value indicating whether the index is leveraging Purview-specific features. This property defaults to false and cannot be changed after index creation. */
|
|
818
|
+
purviewEnabled?: boolean;
|
|
576
819
|
/** The ETag of the index. */
|
|
577
820
|
etag?: string;
|
|
578
821
|
}
|
|
@@ -596,6 +839,10 @@ export interface SearchField {
|
|
|
596
839
|
sortable?: boolean;
|
|
597
840
|
/** A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. */
|
|
598
841
|
facetable?: boolean;
|
|
842
|
+
/** A value indicating whether the field should be used as a permission filter. */
|
|
843
|
+
permissionFilter?: PermissionFilter;
|
|
844
|
+
/** A value indicating whether the field should be used for sensitivity label filtering. This enables document-level filtering based on Microsoft Purview sensitivity labels. */
|
|
845
|
+
sensitivityLabel?: boolean;
|
|
599
846
|
/** The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. */
|
|
600
847
|
analyzer?: LexicalAnalyzerName;
|
|
601
848
|
/** The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. */
|
|
@@ -689,7 +936,7 @@ export interface CharFilter {
|
|
|
689
936
|
name: string;
|
|
690
937
|
}
|
|
691
938
|
/** Base type for normalizers. */
|
|
692
|
-
export interface
|
|
939
|
+
export interface LexicalNormalizer {
|
|
693
940
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
694
941
|
odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
|
|
695
942
|
/** The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. */
|
|
@@ -715,6 +962,8 @@ export interface SemanticConfiguration {
|
|
|
715
962
|
prioritizedFields: SemanticPrioritizedFields;
|
|
716
963
|
/** Specifies the score type to be used for the sort order of the search results. */
|
|
717
964
|
rankingOrder?: RankingOrder;
|
|
965
|
+
/** Determines which semantic or query rewrite models to use during model flighting/upgrades. */
|
|
966
|
+
flightingOptIn?: boolean;
|
|
718
967
|
}
|
|
719
968
|
/** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
|
|
720
969
|
export interface SemanticPrioritizedFields {
|
|
@@ -761,7 +1010,7 @@ export interface VectorSearchAlgorithmConfiguration {
|
|
|
761
1010
|
/** Specifies the vectorization method to be used during query time. */
|
|
762
1011
|
export interface VectorSearchVectorizer {
|
|
763
1012
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
764
|
-
kind: "azureOpenAI" | "customWebApi";
|
|
1013
|
+
kind: "azureOpenAI" | "customWebApi" | "aiServicesVision" | "aml";
|
|
765
1014
|
/** The name to associate with this particular vectorization method. */
|
|
766
1015
|
vectorizerName: string;
|
|
767
1016
|
}
|
|
@@ -771,14 +1020,14 @@ export interface VectorSearchCompression {
|
|
|
771
1020
|
kind: "scalarQuantization" | "binaryQuantization";
|
|
772
1021
|
/** The name to associate with this particular configuration. */
|
|
773
1022
|
compressionName: string;
|
|
774
|
-
/** Contains the options for rescoring. */
|
|
775
|
-
rescoringOptions?: RescoringOptions;
|
|
776
|
-
/** The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. */
|
|
777
|
-
truncationDimension?: number;
|
|
778
1023
|
/** If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. */
|
|
779
1024
|
rerankWithOriginalVectors?: boolean;
|
|
780
1025
|
/** Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. */
|
|
781
1026
|
defaultOversampling?: number;
|
|
1027
|
+
/** Contains the options for rescoring. */
|
|
1028
|
+
rescoringOptions?: RescoringOptions;
|
|
1029
|
+
/** The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. */
|
|
1030
|
+
truncationDimension?: number;
|
|
782
1031
|
}
|
|
783
1032
|
/** Contains the options for rescoring. */
|
|
784
1033
|
export interface RescoringOptions {
|
|
@@ -858,15 +1107,36 @@ export interface AnalyzedTokenInfo {
|
|
|
858
1107
|
*/
|
|
859
1108
|
readonly position: number;
|
|
860
1109
|
}
|
|
861
|
-
/**
|
|
1110
|
+
/** Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. */
|
|
1111
|
+
export interface SearchAlias {
|
|
1112
|
+
/** The name of the alias. */
|
|
1113
|
+
name: string;
|
|
1114
|
+
/** The name of the index this alias maps to. Only one index name may be specified. */
|
|
1115
|
+
indexes: string[];
|
|
1116
|
+
/** The ETag of the alias. */
|
|
1117
|
+
etag?: string;
|
|
1118
|
+
}
|
|
1119
|
+
/** Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases. */
|
|
1120
|
+
export interface ListAliasesResult {
|
|
1121
|
+
/**
|
|
1122
|
+
* The aliases in the Search service.
|
|
1123
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1124
|
+
*/
|
|
1125
|
+
readonly aliases: SearchAlias[];
|
|
1126
|
+
}
|
|
1127
|
+
/** Response from a get service statistics request. If successful, it includes service level counters, indexer runtime information, and limits. */
|
|
862
1128
|
export interface ServiceStatistics {
|
|
863
1129
|
/** Service level resource counters. */
|
|
864
1130
|
counters: ServiceCounters;
|
|
1131
|
+
/** Service level indexers runtime information. */
|
|
1132
|
+
indexersRuntime: ServiceIndexersRuntime;
|
|
865
1133
|
/** Service level general limits. */
|
|
866
1134
|
limits: ServiceLimits;
|
|
867
1135
|
}
|
|
868
1136
|
/** Represents service-level resource counters and quotas. */
|
|
869
1137
|
export interface ServiceCounters {
|
|
1138
|
+
/** Total number of aliases. */
|
|
1139
|
+
aliasCounter: ResourceCounter;
|
|
870
1140
|
/** Total number of documents across all indexes in the service. */
|
|
871
1141
|
documentCounter: ResourceCounter;
|
|
872
1142
|
/** Total number of indexes. */
|
|
@@ -891,6 +1161,17 @@ export interface ResourceCounter {
|
|
|
891
1161
|
/** The resource amount quota. */
|
|
892
1162
|
quota?: number;
|
|
893
1163
|
}
|
|
1164
|
+
/** Represents service level indexers runtime information. */
|
|
1165
|
+
export interface ServiceIndexersRuntime {
|
|
1166
|
+
/** Cumulative runtime of all indexers in the service from the beginningTime to endingTime, in seconds. */
|
|
1167
|
+
usedSeconds: number;
|
|
1168
|
+
/** Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds. */
|
|
1169
|
+
remainingSeconds?: number;
|
|
1170
|
+
/** Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
1171
|
+
beginningTime: Date;
|
|
1172
|
+
/** End UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
1173
|
+
endingTime: Date;
|
|
1174
|
+
}
|
|
894
1175
|
/** Represents various service level limits. */
|
|
895
1176
|
export interface ServiceLimits {
|
|
896
1177
|
/** The maximum allowed fields per index. */
|
|
@@ -903,6 +1184,181 @@ export interface ServiceLimits {
|
|
|
903
1184
|
maxComplexObjectsInCollectionsPerDocument?: number;
|
|
904
1185
|
/** The maximum amount of storage in bytes allowed per index. */
|
|
905
1186
|
maxStoragePerIndexInBytes?: number;
|
|
1187
|
+
/** The maximum cumulative runtime in seconds allowed for all indexers in the service over the current UTC period. */
|
|
1188
|
+
maxCumulativeIndexerRuntimeSeconds?: number;
|
|
1189
|
+
}
|
|
1190
|
+
/** Response from a request to retrieve stats summary of all indexes. If successful, it includes the stats of each index in the service. */
|
|
1191
|
+
export interface ListIndexStatsSummary {
|
|
1192
|
+
/**
|
|
1193
|
+
* The Statistics summary of all indexes in the Search service.
|
|
1194
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1195
|
+
*/
|
|
1196
|
+
readonly indexesStatistics: IndexStatisticsSummary[];
|
|
1197
|
+
}
|
|
1198
|
+
/** Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date. */
|
|
1199
|
+
export interface IndexStatisticsSummary {
|
|
1200
|
+
/** The name of the index. */
|
|
1201
|
+
name: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* The number of documents in the index.
|
|
1204
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1205
|
+
*/
|
|
1206
|
+
readonly documentCount: number;
|
|
1207
|
+
/**
|
|
1208
|
+
* The amount of storage in bytes consumed by the index.
|
|
1209
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1210
|
+
*/
|
|
1211
|
+
readonly storageSize: number;
|
|
1212
|
+
/**
|
|
1213
|
+
* The amount of memory in bytes consumed by vectors in the index.
|
|
1214
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1215
|
+
*/
|
|
1216
|
+
readonly vectorIndexSize: number;
|
|
1217
|
+
}
|
|
1218
|
+
/** Specifies the parameters for connecting to the Azure OpenAI resource. */
|
|
1219
|
+
export interface AzureOpenAIParameters {
|
|
1220
|
+
/** The resource URI of the Azure OpenAI resource. */
|
|
1221
|
+
resourceUrl?: string;
|
|
1222
|
+
/** ID of the Azure OpenAI model deployment on the designated resource. */
|
|
1223
|
+
deploymentId?: string;
|
|
1224
|
+
/** API key of the designated Azure OpenAI resource. */
|
|
1225
|
+
apiKey?: string;
|
|
1226
|
+
/** The user-assigned managed identity used for outbound connections. */
|
|
1227
|
+
authIdentity?: SearchIndexerDataIdentityUnion;
|
|
1228
|
+
/** The name of the embedding model that is deployed at the provided deploymentId path. */
|
|
1229
|
+
modelName?: AzureOpenAIModelName;
|
|
1230
|
+
}
|
|
1231
|
+
/** Parameters for search index knowledge source. */
|
|
1232
|
+
export interface SearchIndexKnowledgeSourceParameters {
|
|
1233
|
+
/** The name of the Search index. */
|
|
1234
|
+
searchIndexName: string;
|
|
1235
|
+
/** Used to request additional fields for referenced source data. */
|
|
1236
|
+
sourceDataFields?: SearchIndexKnowledgeSourceParametersSourceDataFieldsItem[];
|
|
1237
|
+
/** Used to restrict which fields to search on the search index. */
|
|
1238
|
+
searchFields?: SearchIndexKnowledgeSourceParametersSearchFieldsItem[];
|
|
1239
|
+
/** Used to specify a different semantic configuration on the target search index other than the default one. */
|
|
1240
|
+
semanticConfigurationName?: string;
|
|
1241
|
+
}
|
|
1242
|
+
export interface SearchIndexKnowledgeSourceParametersSourceDataFieldsItem {
|
|
1243
|
+
name: string;
|
|
1244
|
+
}
|
|
1245
|
+
export interface SearchIndexKnowledgeSourceParametersSearchFieldsItem {
|
|
1246
|
+
name: string;
|
|
1247
|
+
}
|
|
1248
|
+
/** Parameters for Azure Blob Storage knowledge source. */
|
|
1249
|
+
export interface AzureBlobKnowledgeSourceParameters {
|
|
1250
|
+
/** Key-based connection string or the ResourceId format if using a managed identity. */
|
|
1251
|
+
connectionString: string;
|
|
1252
|
+
/** The name of the blob storage container. */
|
|
1253
|
+
containerName: string;
|
|
1254
|
+
/** Optional folder path within the container. */
|
|
1255
|
+
folderPath?: string;
|
|
1256
|
+
/** Set to true if connecting to an ADLS Gen2 storage account. Default is false. */
|
|
1257
|
+
isAdlsGen2?: boolean;
|
|
1258
|
+
/** Consolidates all general ingestion settings. */
|
|
1259
|
+
ingestionParameters?: KnowledgeSourceIngestionParameters;
|
|
1260
|
+
/**
|
|
1261
|
+
* Resources created by the knowledge source.
|
|
1262
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1263
|
+
*/
|
|
1264
|
+
readonly createdResources?: {
|
|
1265
|
+
[propertyName: string]: string;
|
|
1266
|
+
};
|
|
1267
|
+
}
|
|
1268
|
+
/** Consolidates all general ingestion settings for knowledge sources. */
|
|
1269
|
+
export interface KnowledgeSourceIngestionParameters {
|
|
1270
|
+
/** An explicit identity to use for this knowledge source. */
|
|
1271
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
1272
|
+
/** Optional vectorizer configuration for vectorizing content. */
|
|
1273
|
+
embeddingModel?: KnowledgeSourceVectorizerUnion;
|
|
1274
|
+
/** Optional chat completion model for image verbalization or context extraction. */
|
|
1275
|
+
chatCompletionModel?: KnowledgeBaseModelUnion;
|
|
1276
|
+
/** Indicates whether image verbalization should be disabled. Default is false. */
|
|
1277
|
+
disableImageVerbalization?: boolean;
|
|
1278
|
+
/** Optional schedule for data ingestion. */
|
|
1279
|
+
ingestionSchedule?: IndexingSchedule;
|
|
1280
|
+
/** Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source. */
|
|
1281
|
+
ingestionPermissionOptions?: KnowledgeSourceIngestionPermissionOption[];
|
|
1282
|
+
/** Optional content extraction mode. Default is 'minimal'. */
|
|
1283
|
+
contentExtractionMode?: KnowledgeSourceContentExtractionMode;
|
|
1284
|
+
/** Optional AI Services configuration for content processing. */
|
|
1285
|
+
aiServices?: AIServices;
|
|
1286
|
+
}
|
|
1287
|
+
/** Specifies the vectorization method to be used for knowledge source embedding model, with optional name. */
|
|
1288
|
+
export interface KnowledgeSourceVectorizer {
|
|
1289
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1290
|
+
kind: "azureOpenAI";
|
|
1291
|
+
}
|
|
1292
|
+
/** Parameters for Azure Blob Storage knowledge source. */
|
|
1293
|
+
export interface AIServices {
|
|
1294
|
+
/** The URI of the AI Services endpoint. */
|
|
1295
|
+
uri: string;
|
|
1296
|
+
/** The API key for accessing AI Services. */
|
|
1297
|
+
apiKey?: string;
|
|
1298
|
+
}
|
|
1299
|
+
/** Parameters for SharePoint knowledge source. */
|
|
1300
|
+
export interface IndexedSharePointKnowledgeSourceParameters {
|
|
1301
|
+
/** 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] */
|
|
1302
|
+
connectionString: string;
|
|
1303
|
+
/** Specifies which SharePoint libraries to access. */
|
|
1304
|
+
containerName: IndexedSharePointContainerName;
|
|
1305
|
+
/** Optional query to filter SharePoint content. */
|
|
1306
|
+
query?: string;
|
|
1307
|
+
/** Consolidates all general ingestion settings. */
|
|
1308
|
+
ingestionParameters?: KnowledgeSourceIngestionParameters;
|
|
1309
|
+
/**
|
|
1310
|
+
* Resources created by the knowledge source.
|
|
1311
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1312
|
+
*/
|
|
1313
|
+
readonly createdResources?: {
|
|
1314
|
+
[propertyName: string]: string;
|
|
1315
|
+
};
|
|
1316
|
+
}
|
|
1317
|
+
/** Parameters for OneLake knowledge source. */
|
|
1318
|
+
export interface IndexedOneLakeKnowledgeSourceParameters {
|
|
1319
|
+
/** OneLake workspace ID. */
|
|
1320
|
+
fabricWorkspaceId: string;
|
|
1321
|
+
/** Specifies which OneLake lakehouse to access. */
|
|
1322
|
+
lakehouseId: string;
|
|
1323
|
+
/** Optional OneLakehouse folder or shortcut to filter OneLake content. */
|
|
1324
|
+
targetPath?: string;
|
|
1325
|
+
/** Consolidates all general ingestion settings. */
|
|
1326
|
+
ingestionParameters?: KnowledgeSourceIngestionParameters;
|
|
1327
|
+
/**
|
|
1328
|
+
* Resources created by the knowledge source.
|
|
1329
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1330
|
+
*/
|
|
1331
|
+
readonly createdResources?: {
|
|
1332
|
+
[propertyName: string]: string;
|
|
1333
|
+
};
|
|
1334
|
+
}
|
|
1335
|
+
/** Parameters for web knowledge source. */
|
|
1336
|
+
export interface WebKnowledgeSourceParameters {
|
|
1337
|
+
/** Domain allow/block configuration for web results. */
|
|
1338
|
+
domains?: WebKnowledgeSourceDomains;
|
|
1339
|
+
}
|
|
1340
|
+
/** Domain allow/block configuration for web knowledge source. */
|
|
1341
|
+
export interface WebKnowledgeSourceDomains {
|
|
1342
|
+
/** Domains that are allowed for web results */
|
|
1343
|
+
allowedDomains?: WebKnowledgeSourceDomain[];
|
|
1344
|
+
/** Domains that are blocked from web results */
|
|
1345
|
+
blockedDomains?: WebKnowledgeSourceDomain[];
|
|
1346
|
+
}
|
|
1347
|
+
/** Configuration for web knowledge source domain. */
|
|
1348
|
+
export interface WebKnowledgeSourceDomain {
|
|
1349
|
+
/** The address of the domain. */
|
|
1350
|
+
address: string;
|
|
1351
|
+
/** Whether or not to include subpages from this domain. */
|
|
1352
|
+
includeSubpages?: boolean;
|
|
1353
|
+
}
|
|
1354
|
+
/** Parameters for remote SharePoint knowledge source. */
|
|
1355
|
+
export interface RemoteSharePointKnowledgeSourceParameters {
|
|
1356
|
+
/** Keyword Query Language (KQL) expression with queryable SharePoint properties and attributes to scope the retrieval before the query runs. See documentation: https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference */
|
|
1357
|
+
filterExpression?: string;
|
|
1358
|
+
/** A list of metadata fields to be returned for each item in the response. Only retrievable metadata properties can be included in this list. By default, no metadata is returned. Optional. */
|
|
1359
|
+
resourceMetadata?: string[];
|
|
1360
|
+
/** Container ID for SharePoint Embedded connection. When this is null, it will use SharePoint Online. */
|
|
1361
|
+
containerTypeId?: string;
|
|
906
1362
|
}
|
|
907
1363
|
/** Contains the parameters specific to the HNSW algorithm. */
|
|
908
1364
|
export interface HnswParameters {
|
|
@@ -925,24 +1381,6 @@ export interface ScalarQuantizationParameters {
|
|
|
925
1381
|
/** The quantized data type of compressed vector values. */
|
|
926
1382
|
quantizedDataType?: VectorSearchCompressionTarget;
|
|
927
1383
|
}
|
|
928
|
-
/** Specifies the parameters for connecting to the Azure OpenAI resource. */
|
|
929
|
-
export interface AzureOpenAIParameters {
|
|
930
|
-
/** The resource URI of the Azure OpenAI resource. */
|
|
931
|
-
resourceUrl?: string;
|
|
932
|
-
/** ID of the Azure OpenAI model deployment on the designated resource. */
|
|
933
|
-
deploymentId?: string;
|
|
934
|
-
/** API key of the designated Azure OpenAI resource. */
|
|
935
|
-
apiKey?: string;
|
|
936
|
-
/** The user-assigned managed identity used for outbound connections. */
|
|
937
|
-
authIdentity?: SearchIndexerDataIdentityUnion;
|
|
938
|
-
/** The name of the embedding model that is deployed at the provided deploymentId path. */
|
|
939
|
-
modelName?: AzureOpenAIModelName;
|
|
940
|
-
}
|
|
941
|
-
/** Abstract base type for data identities. */
|
|
942
|
-
export interface SearchIndexerDataIdentity {
|
|
943
|
-
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
944
|
-
odatatype: "#Microsoft.Azure.Search.DataNoneIdentity" | "#Microsoft.Azure.Search.DataUserAssignedIdentity";
|
|
945
|
-
}
|
|
946
1384
|
/** Specifies the properties for connecting to a user-defined vectorizer. */
|
|
947
1385
|
export interface WebApiParameters {
|
|
948
1386
|
/** The URI of the Web API providing the vectorizer. */
|
|
@@ -960,6 +1398,32 @@ export interface WebApiParameters {
|
|
|
960
1398
|
/** 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. */
|
|
961
1399
|
authIdentity?: SearchIndexerDataIdentityUnion;
|
|
962
1400
|
}
|
|
1401
|
+
/** Specifies the AI Services Vision parameters for vectorizing a query image or text. */
|
|
1402
|
+
export interface AIServicesVisionParameters {
|
|
1403
|
+
/** The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified. */
|
|
1404
|
+
modelVersion: string | null;
|
|
1405
|
+
/** The resource URI of the AI Services resource. */
|
|
1406
|
+
resourceUri: string;
|
|
1407
|
+
/** API key of the designated AI Services resource. */
|
|
1408
|
+
apiKey?: string;
|
|
1409
|
+
/** 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 index, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. */
|
|
1410
|
+
authIdentity?: SearchIndexerDataIdentityUnion;
|
|
1411
|
+
}
|
|
1412
|
+
/** Specifies the properties for connecting to an AML vectorizer. */
|
|
1413
|
+
export interface AMLParameters {
|
|
1414
|
+
/** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
|
|
1415
|
+
scoringUri: string | null;
|
|
1416
|
+
/** (Required for key authentication) The key for the AML service. */
|
|
1417
|
+
authenticationKey?: string;
|
|
1418
|
+
/** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
|
|
1419
|
+
resourceId?: string;
|
|
1420
|
+
/** (Optional) When specified, indicates the timeout for the http client making the API call. */
|
|
1421
|
+
timeout?: string;
|
|
1422
|
+
/** (Optional for token authentication). The region the AML service is deployed in. */
|
|
1423
|
+
region?: string;
|
|
1424
|
+
/** The name of the embedding model from the Azure AI Foundry Catalog that is deployed at the provided endpoint. */
|
|
1425
|
+
modelName?: AIFoundryModelCatalogName;
|
|
1426
|
+
}
|
|
963
1427
|
/** Provides parameter values to a distance scoring function. */
|
|
964
1428
|
export interface DistanceScoringParameters {
|
|
965
1429
|
/** The name of the parameter passed in search queries to specify the reference location. */
|
|
@@ -986,13 +1450,6 @@ export interface TagScoringParameters {
|
|
|
986
1450
|
/** The name of the parameter passed in search queries to specify the list of tags to compare against the target field. */
|
|
987
1451
|
tagsParameter: string;
|
|
988
1452
|
}
|
|
989
|
-
/** 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. */
|
|
990
|
-
export interface SearchIndexerKnowledgeStoreParameters {
|
|
991
|
-
/** Describes unknown properties. The value of an unknown property can be of "any" type. */
|
|
992
|
-
[property: string]: any;
|
|
993
|
-
/** Whether or not projections should synthesize a generated key name if one isn't already present. */
|
|
994
|
-
synthesizeGeneratedKeyName?: boolean;
|
|
995
|
-
}
|
|
996
1453
|
/** An object that contains information about the matches that were found, and related metadata. */
|
|
997
1454
|
export interface CustomEntity {
|
|
998
1455
|
/** The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the "normalized" form of the text being found. */
|
|
@@ -1031,6 +1488,12 @@ export interface CustomEntityAlias {
|
|
|
1031
1488
|
/** Determine the fuzzy edit distance of the alias. */
|
|
1032
1489
|
fuzzyEditDistance?: number;
|
|
1033
1490
|
}
|
|
1491
|
+
export interface AzureOpenAITokenizerParameters {
|
|
1492
|
+
/** Only applies if the unit is set to azureOpenAITokens. Options include 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'. */
|
|
1493
|
+
encoderModelName?: SplitSkillEncoderModelName;
|
|
1494
|
+
/** (Optional) Only applies if the unit is set to azureOpenAITokens. This parameter defines a collection of special tokens that are permitted within the tokenization process. */
|
|
1495
|
+
allowedSpecialTokens?: string[];
|
|
1496
|
+
}
|
|
1034
1497
|
/** Controls the cardinality for chunking the content. */
|
|
1035
1498
|
export interface DocumentIntelligenceLayoutSkillChunkingProperties {
|
|
1036
1499
|
/** The unit of the chunk. */
|
|
@@ -1040,6 +1503,137 @@ export interface DocumentIntelligenceLayoutSkillChunkingProperties {
|
|
|
1040
1503
|
/** The length of overlap provided between two text chunks. Default is 0. */
|
|
1041
1504
|
overlapLength?: number;
|
|
1042
1505
|
}
|
|
1506
|
+
/** Common language model parameters for Chat Completions. If omitted, default values are used. */
|
|
1507
|
+
export interface CommonModelParameters {
|
|
1508
|
+
/** The name of the model to use (e.g., 'gpt-4o', etc.). Default is null if not specified. */
|
|
1509
|
+
model?: string;
|
|
1510
|
+
/** A float in the range [-2,2] that reduces or increases likelihood of repeated tokens. Default is 0. */
|
|
1511
|
+
frequencyPenalty?: number;
|
|
1512
|
+
/** A float in the range [-2,2] that penalizes new tokens based on their existing presence. Default is 0. */
|
|
1513
|
+
presencePenalty?: number;
|
|
1514
|
+
/** Maximum number of tokens to generate. */
|
|
1515
|
+
maxTokens?: number;
|
|
1516
|
+
/** Sampling temperature. Default is 0.7. */
|
|
1517
|
+
temperature?: number;
|
|
1518
|
+
/** Random seed for controlling deterministic outputs. If omitted, randomization is used. */
|
|
1519
|
+
seed?: number;
|
|
1520
|
+
/** List of stop sequences that will cut off text generation. Default is none. */
|
|
1521
|
+
stop?: string[];
|
|
1522
|
+
}
|
|
1523
|
+
/** Determines how the language model's response should be serialized. Defaults to 'text'. */
|
|
1524
|
+
export interface ChatCompletionResponseFormat {
|
|
1525
|
+
/** Specifies how the LLM should format the response. Possible values: 'text' (plain string), 'json_object' (arbitrary JSON), or 'json_schema' (adheres to provided schema). */
|
|
1526
|
+
type?: ChatCompletionResponseFormatType;
|
|
1527
|
+
/** An open dictionary for extended properties. Required if 'type' == 'json_schema' */
|
|
1528
|
+
chatCompletionSchemaProperties?: ChatCompletionResponseFormatJsonSchemaProperties;
|
|
1529
|
+
}
|
|
1530
|
+
/** An open dictionary for extended properties. Required if 'type' == 'json_schema' */
|
|
1531
|
+
export interface ChatCompletionResponseFormatJsonSchemaProperties {
|
|
1532
|
+
/** Name of the json schema the model will adhere to */
|
|
1533
|
+
name?: string;
|
|
1534
|
+
/** Description of the json schema the model will adhere to. */
|
|
1535
|
+
description?: string;
|
|
1536
|
+
/** Whether or not the model's response should use structured outputs. Default is true */
|
|
1537
|
+
strict?: boolean;
|
|
1538
|
+
/** Object defining the custom schema the model will use to structure its output. */
|
|
1539
|
+
schema?: ChatCompletionSchema;
|
|
1540
|
+
}
|
|
1541
|
+
/** Object defining the custom schema the model will use to structure its output. */
|
|
1542
|
+
export interface ChatCompletionSchema {
|
|
1543
|
+
/** Type of schema representation. Usually 'object'. Default is 'object'. */
|
|
1544
|
+
type?: string;
|
|
1545
|
+
/** A JSON-formatted string that defines the output schema's properties and constraints for the model. */
|
|
1546
|
+
properties?: string;
|
|
1547
|
+
/** An array of the property names that are required to be part of the model's response. All properties must be included for structured outputs. */
|
|
1548
|
+
required?: string[];
|
|
1549
|
+
/** Controls whether it is allowable for an object to contain additional keys / values that were not defined in the JSON Schema. Default is false. */
|
|
1550
|
+
additionalProperties?: boolean;
|
|
1551
|
+
}
|
|
1552
|
+
/** Controls the cardinality for chunking the content. */
|
|
1553
|
+
export interface ContentUnderstandingSkillChunkingProperties {
|
|
1554
|
+
/** The unit of the chunk. */
|
|
1555
|
+
unit?: ContentUnderstandingSkillChunkingUnit;
|
|
1556
|
+
/** The maximum chunk length in characters. Default is 500. */
|
|
1557
|
+
maximumLength?: number;
|
|
1558
|
+
/** The length of overlap provided between two text chunks. Default is 0. */
|
|
1559
|
+
overlapLength?: number;
|
|
1560
|
+
}
|
|
1561
|
+
/** Specifies the Azure OpenAI resource used to do query planning. */
|
|
1562
|
+
export interface KnowledgeBaseAzureOpenAIModel extends KnowledgeBaseModel {
|
|
1563
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1564
|
+
kind: "azureOpenAI";
|
|
1565
|
+
/** Contains the parameters specific to Azure OpenAI model endpoint. */
|
|
1566
|
+
azureOpenAIParameters: AzureOpenAIParameters;
|
|
1567
|
+
}
|
|
1568
|
+
/** Run knowledge retrieval with minimal reasoning effort. */
|
|
1569
|
+
export interface KnowledgeRetrievalMinimalReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
1570
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1571
|
+
kind: "minimal";
|
|
1572
|
+
}
|
|
1573
|
+
/** Run knowledge retrieval with low reasoning effort. */
|
|
1574
|
+
export interface KnowledgeRetrievalLowReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
1575
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1576
|
+
kind: "low";
|
|
1577
|
+
}
|
|
1578
|
+
/** Run knowledge retrieval with medium reasoning effort. */
|
|
1579
|
+
export interface KnowledgeRetrievalMediumReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
1580
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1581
|
+
kind: "medium";
|
|
1582
|
+
}
|
|
1583
|
+
/** Clears the identity property of a datasource. */
|
|
1584
|
+
export interface SearchIndexerDataNoneIdentity extends SearchIndexerDataIdentity {
|
|
1585
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1586
|
+
odatatype: "#Microsoft.Azure.Search.DataNoneIdentity";
|
|
1587
|
+
}
|
|
1588
|
+
/** Specifies the identity for a datasource to use. */
|
|
1589
|
+
export interface SearchIndexerDataUserAssignedIdentity extends SearchIndexerDataIdentity {
|
|
1590
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1591
|
+
odatatype: "#Microsoft.Azure.Search.DataUserAssignedIdentity";
|
|
1592
|
+
/** The fully qualified Azure resource Id of a user assigned managed identity typically in the form "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" that should have been assigned to the search service. */
|
|
1593
|
+
resourceId: string;
|
|
1594
|
+
}
|
|
1595
|
+
/** Knowledge Source targeting a search index. */
|
|
1596
|
+
export interface SearchIndexKnowledgeSource extends KnowledgeSource {
|
|
1597
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1598
|
+
kind: "searchIndex";
|
|
1599
|
+
/** The parameters for the knowledge source. */
|
|
1600
|
+
searchIndexParameters: SearchIndexKnowledgeSourceParameters;
|
|
1601
|
+
}
|
|
1602
|
+
/** Configuration for Azure Blob Storage knowledge source. */
|
|
1603
|
+
export interface AzureBlobKnowledgeSource extends KnowledgeSource {
|
|
1604
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1605
|
+
kind: "azureBlob";
|
|
1606
|
+
/** The type of the knowledge source. */
|
|
1607
|
+
azureBlobParameters: AzureBlobKnowledgeSourceParameters;
|
|
1608
|
+
}
|
|
1609
|
+
/** Configuration for SharePoint knowledge source. */
|
|
1610
|
+
export interface IndexedSharePointKnowledgeSource extends KnowledgeSource {
|
|
1611
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1612
|
+
kind: "indexedSharePoint";
|
|
1613
|
+
/** The parameters for the SharePoint knowledge source. */
|
|
1614
|
+
indexedSharePointParameters: IndexedSharePointKnowledgeSourceParameters;
|
|
1615
|
+
}
|
|
1616
|
+
/** Configuration for OneLake knowledge source. */
|
|
1617
|
+
export interface IndexedOneLakeKnowledgeSource extends KnowledgeSource {
|
|
1618
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1619
|
+
kind: "indexedOneLake";
|
|
1620
|
+
/** The parameters for the OneLake knowledge source. */
|
|
1621
|
+
indexedOneLakeParameters: IndexedOneLakeKnowledgeSourceParameters;
|
|
1622
|
+
}
|
|
1623
|
+
/** Knowledge Source targeting web results. */
|
|
1624
|
+
export interface WebKnowledgeSource extends KnowledgeSource {
|
|
1625
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1626
|
+
kind: "web";
|
|
1627
|
+
/** The parameters for the web knowledge source. */
|
|
1628
|
+
webParameters?: WebKnowledgeSourceParameters;
|
|
1629
|
+
}
|
|
1630
|
+
/** Configuration for remote SharePoint knowledge source. */
|
|
1631
|
+
export interface RemoteSharePointKnowledgeSource extends KnowledgeSource {
|
|
1632
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1633
|
+
kind: "remoteSharePoint";
|
|
1634
|
+
/** The parameters for the knowledge source. */
|
|
1635
|
+
remoteSharePointParameters: RemoteSharePointKnowledgeSourceParameters;
|
|
1636
|
+
}
|
|
1043
1637
|
/** Defines a data change detection policy that captures changes based on the value of a high water mark column. */
|
|
1044
1638
|
export interface HighWaterMarkChangeDetectionPolicy extends DataChangeDetectionPolicy {
|
|
1045
1639
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -1061,6 +1655,11 @@ export interface SoftDeleteColumnDeletionDetectionPolicy extends DataDeletionDet
|
|
|
1061
1655
|
/** The marker value that identifies an item as deleted. */
|
|
1062
1656
|
softDeleteMarkerValue?: string;
|
|
1063
1657
|
}
|
|
1658
|
+
/** Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection. */
|
|
1659
|
+
export interface NativeBlobSoftDeleteDeletionDetectionPolicy extends DataDeletionDetectionPolicy {
|
|
1660
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1661
|
+
odatatype: "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy";
|
|
1662
|
+
}
|
|
1064
1663
|
/** A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output. */
|
|
1065
1664
|
export interface ConditionalSkill extends SearchIndexerSkill {
|
|
1066
1665
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -1218,6 +1817,10 @@ export interface SplitSkill extends SearchIndexerSkill {
|
|
|
1218
1817
|
pageOverlapLength?: number;
|
|
1219
1818
|
/** Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document. */
|
|
1220
1819
|
maximumPagesToTake?: number;
|
|
1820
|
+
/** Only applies if textSplitMode is set to pages. There are two possible values. The choice of the values will decide the length (maximumPageLength and pageOverlapLength) measurement. The default is 'characters', which means the length will be measured by character. */
|
|
1821
|
+
unit?: SplitSkillUnit;
|
|
1822
|
+
/** Only applies if the unit is set to azureOpenAITokens. If specified, the splitSkill will use these parameters when performing the tokenization. The parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property. */
|
|
1823
|
+
azureOpenAITokenizerParameters?: AzureOpenAITokenizerParameters;
|
|
1221
1824
|
}
|
|
1222
1825
|
/** A skill looks for text from a custom, user-defined list of words and phrases. */
|
|
1223
1826
|
export interface CustomEntityLookupSkill extends SearchIndexerSkill {
|
|
@@ -1278,7 +1881,7 @@ export interface DocumentIntelligenceLayoutSkill extends SearchIndexerSkill {
|
|
|
1278
1881
|
/** A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code. */
|
|
1279
1882
|
export interface WebApiSkill extends SearchIndexerSkill {
|
|
1280
1883
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1281
|
-
odatatype: "#Microsoft.Skills.Custom.WebApiSkill";
|
|
1884
|
+
odatatype: "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.ChatCompletionSkill";
|
|
1282
1885
|
/** The url for the Web API. */
|
|
1283
1886
|
uri: string;
|
|
1284
1887
|
/** The headers required to make the http request. */
|
|
@@ -1298,6 +1901,32 @@ export interface WebApiSkill extends SearchIndexerSkill {
|
|
|
1298
1901
|
/** 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. */
|
|
1299
1902
|
authIdentity?: SearchIndexerDataIdentityUnion;
|
|
1300
1903
|
}
|
|
1904
|
+
/** A skill that leverages Azure AI Content Understanding to process and extract structured insights from documents, enabling enriched, searchable content for enhanced document indexing and retrieval */
|
|
1905
|
+
export interface ContentUnderstandingSkill extends SearchIndexerSkill {
|
|
1906
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1907
|
+
odatatype: "#Microsoft.Skills.Util.ContentUnderstandingSkill";
|
|
1908
|
+
/** Controls the cardinality of the content extracted from the document by the skill */
|
|
1909
|
+
extractionOptions?: ContentUnderstandingSkillExtractionOptions[];
|
|
1910
|
+
/** Controls the cardinality for chunking the content. */
|
|
1911
|
+
chunkingProperties?: ContentUnderstandingSkillChunkingProperties;
|
|
1912
|
+
}
|
|
1913
|
+
/** The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment. */
|
|
1914
|
+
export interface AzureMachineLearningSkill extends SearchIndexerSkill {
|
|
1915
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1916
|
+
odatatype: "#Microsoft.Skills.Custom.AmlSkill";
|
|
1917
|
+
/** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
|
|
1918
|
+
scoringUri?: string;
|
|
1919
|
+
/** (Required for key authentication) The key for the AML service. */
|
|
1920
|
+
authenticationKey?: string;
|
|
1921
|
+
/** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
|
|
1922
|
+
resourceId?: string;
|
|
1923
|
+
/** (Optional) When specified, indicates the timeout for the http client making the API call. */
|
|
1924
|
+
timeout?: string;
|
|
1925
|
+
/** (Optional for token authentication). The region the AML service is deployed in. */
|
|
1926
|
+
region?: string;
|
|
1927
|
+
/** (Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. */
|
|
1928
|
+
degreeOfParallelism?: number;
|
|
1929
|
+
}
|
|
1301
1930
|
/** Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource. */
|
|
1302
1931
|
export interface AzureOpenAIEmbeddingSkill extends SearchIndexerSkill, AzureOpenAIParameters {
|
|
1303
1932
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -1305,17 +1934,42 @@ export interface AzureOpenAIEmbeddingSkill extends SearchIndexerSkill, AzureOpen
|
|
|
1305
1934
|
/** The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models. */
|
|
1306
1935
|
dimensions?: number;
|
|
1307
1936
|
}
|
|
1937
|
+
/** Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API. */
|
|
1938
|
+
export interface VisionVectorizeSkill extends SearchIndexerSkill {
|
|
1939
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1940
|
+
odatatype: "#Microsoft.Skills.Vision.VectorizeSkill";
|
|
1941
|
+
/** The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified. */
|
|
1942
|
+
modelVersion: string | null;
|
|
1943
|
+
}
|
|
1308
1944
|
/** An empty object that represents the default Azure AI service resource for a skillset. */
|
|
1309
1945
|
export interface DefaultCognitiveServicesAccount extends CognitiveServicesAccount {
|
|
1310
1946
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1311
1947
|
odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices";
|
|
1312
1948
|
}
|
|
1313
|
-
/** The multi-region account key of an Azure AI service resource that's attached to a skillset. */
|
|
1314
|
-
export interface CognitiveServicesAccountKey extends CognitiveServicesAccount {
|
|
1949
|
+
/** The multi-region account key of an Azure AI service resource that's attached to a skillset. */
|
|
1950
|
+
export interface CognitiveServicesAccountKey extends CognitiveServicesAccount {
|
|
1951
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1952
|
+
odatatype: "#Microsoft.Azure.Search.CognitiveServicesByKey";
|
|
1953
|
+
/** The key used to provision the Azure AI service resource attached to a skillset. */
|
|
1954
|
+
key: string;
|
|
1955
|
+
}
|
|
1956
|
+
/** The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain. */
|
|
1957
|
+
export interface AIServicesAccountKey extends CognitiveServicesAccount {
|
|
1315
1958
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1316
|
-
odatatype: "#Microsoft.Azure.Search.
|
|
1959
|
+
odatatype: "#Microsoft.Azure.Search.AIServicesByKey";
|
|
1317
1960
|
/** The key used to provision the Azure AI service resource attached to a skillset. */
|
|
1318
1961
|
key: string;
|
|
1962
|
+
/** The subdomain url for the corresponding AI Service. */
|
|
1963
|
+
subdomainUrl: string;
|
|
1964
|
+
}
|
|
1965
|
+
/** The multi-region account of an Azure AI service resource that's attached to a skillset. */
|
|
1966
|
+
export interface AIServicesAccountIdentity extends CognitiveServicesAccount {
|
|
1967
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1968
|
+
odatatype: "#Microsoft.Azure.Search.AIServicesByIdentity";
|
|
1969
|
+
/** The user-assigned managed identity used for connections to AI Service. If not specified, the system-assigned managed identity is used. On updates to the skillset, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. */
|
|
1970
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
1971
|
+
/** The subdomain url for the corresponding AI Service. */
|
|
1972
|
+
subdomainUrl: string;
|
|
1319
1973
|
}
|
|
1320
1974
|
/** Description for what data to store in Azure Tables. */
|
|
1321
1975
|
export interface SearchIndexerKnowledgeStoreTableProjectionSelector extends SearchIndexerKnowledgeStoreProjectionSelector {
|
|
@@ -1777,7 +2431,7 @@ export interface PatternReplaceCharFilter extends CharFilter {
|
|
|
1777
2431
|
replacement: string;
|
|
1778
2432
|
}
|
|
1779
2433
|
/** Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored. */
|
|
1780
|
-
export interface
|
|
2434
|
+
export interface CustomNormalizer extends LexicalNormalizer {
|
|
1781
2435
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1782
2436
|
odatatype: "#Microsoft.Azure.Search.CustomNormalizer";
|
|
1783
2437
|
/** A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed. */
|
|
@@ -1827,6 +2481,20 @@ export interface WebApiVectorizer extends VectorSearchVectorizer {
|
|
|
1827
2481
|
/** Specifies the properties of the user-defined vectorizer. */
|
|
1828
2482
|
parameters?: WebApiParameters;
|
|
1829
2483
|
}
|
|
2484
|
+
/** Specifies the AI Services Vision parameters for vectorizing a query image or text. */
|
|
2485
|
+
export interface AIServicesVisionVectorizer extends VectorSearchVectorizer {
|
|
2486
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
2487
|
+
kind: "aiServicesVision";
|
|
2488
|
+
/** Contains the parameters specific to AI Services Vision embedding vectorization. */
|
|
2489
|
+
aIServicesVisionParameters?: AIServicesVisionParameters;
|
|
2490
|
+
}
|
|
2491
|
+
/** Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog for generating the vector embedding of a query string. */
|
|
2492
|
+
export interface AMLVectorizer extends VectorSearchVectorizer {
|
|
2493
|
+
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
2494
|
+
kind: "aml";
|
|
2495
|
+
/** Specifies the properties of the AML vectorizer. */
|
|
2496
|
+
aMLParameters?: AMLParameters;
|
|
2497
|
+
}
|
|
1830
2498
|
/** Contains configuration options specific to the scalar quantization compression method used during indexing and querying. */
|
|
1831
2499
|
export interface ScalarQuantizationCompression extends VectorSearchCompression {
|
|
1832
2500
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
@@ -1839,17 +2507,29 @@ export interface BinaryQuantizationCompression extends VectorSearchCompression {
|
|
|
1839
2507
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1840
2508
|
kind: "binaryQuantization";
|
|
1841
2509
|
}
|
|
1842
|
-
/**
|
|
1843
|
-
export interface
|
|
2510
|
+
/** Specifies the Azure OpenAI resource used to vectorize a query string. */
|
|
2511
|
+
export interface KnowledgeSourceAzureOpenAIVectorizer extends KnowledgeSourceVectorizer {
|
|
1844
2512
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1845
|
-
|
|
2513
|
+
kind: "azureOpenAI";
|
|
2514
|
+
/** Contains the parameters specific to Azure OpenAI embedding vectorization. */
|
|
2515
|
+
azureOpenAIParameters?: AzureOpenAIParameters;
|
|
1846
2516
|
}
|
|
1847
|
-
/**
|
|
1848
|
-
export interface
|
|
2517
|
+
/** A skill that calls a language model via Azure AI Foundry's Chat Completions endpoint. */
|
|
2518
|
+
export interface ChatCompletionSkill extends WebApiSkill {
|
|
1849
2519
|
/** Polymorphic discriminator, which specifies the different types this object can be */
|
|
1850
|
-
odatatype: "#Microsoft.
|
|
1851
|
-
/**
|
|
1852
|
-
|
|
2520
|
+
odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill";
|
|
2521
|
+
/** API key for authenticating to the model. Both apiKey and authIdentity cannot be specified at the same time. */
|
|
2522
|
+
apiKey?: string;
|
|
2523
|
+
/** Common language model parameters that customers can tweak. If omitted, reasonable defaults will be applied. */
|
|
2524
|
+
commonModelParameters?: CommonModelParameters;
|
|
2525
|
+
/** Open-type dictionary for model-specific parameters that should be appended to the chat completions call. Follows Azure AI Foundry’s extensibility pattern. */
|
|
2526
|
+
extraParameters?: {
|
|
2527
|
+
[propertyName: string]: any;
|
|
2528
|
+
};
|
|
2529
|
+
/** How extra parameters are handled by Azure AI Foundry. Default is 'error'. */
|
|
2530
|
+
extraParametersBehavior?: ChatCompletionExtraParametersBehavior;
|
|
2531
|
+
/** Determines how the LLM should format its response. Defaults to 'text' response type. */
|
|
2532
|
+
responseFormat?: ChatCompletionResponseFormat;
|
|
1853
2533
|
}
|
|
1854
2534
|
/** Projection definition for what data to store in Azure Blob. */
|
|
1855
2535
|
export interface SearchIndexerKnowledgeStoreObjectProjectionSelector extends SearchIndexerKnowledgeStoreBlobProjectionSelector {
|
|
@@ -1857,50 +2537,180 @@ export interface SearchIndexerKnowledgeStoreObjectProjectionSelector extends Sea
|
|
|
1857
2537
|
/** Projection definition for what data to store in Azure Files. */
|
|
1858
2538
|
export interface SearchIndexerKnowledgeStoreFileProjectionSelector extends SearchIndexerKnowledgeStoreBlobProjectionSelector {
|
|
1859
2539
|
}
|
|
1860
|
-
/** Known values of {@link
|
|
1861
|
-
export declare enum
|
|
1862
|
-
/** Api Version '2025-
|
|
1863
|
-
|
|
2540
|
+
/** Known values of {@link ApiVersion20251101Preview} that the service accepts. */
|
|
2541
|
+
export declare enum KnownApiVersion20251101Preview {
|
|
2542
|
+
/** Api Version '2025-11-01-preview' */
|
|
2543
|
+
TwoThousandTwentyFive1101Preview = "2025-11-01-preview"
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* Defines values for ApiVersion20251101Preview. \
|
|
2547
|
+
* {@link KnownApiVersion20251101Preview} can be used interchangeably with ApiVersion20251101Preview,
|
|
2548
|
+
* this enum contains the known values that the service supports.
|
|
2549
|
+
* ### Known values supported by the service
|
|
2550
|
+
* **2025-11-01-preview**: Api Version '2025-11-01-preview'
|
|
2551
|
+
*/
|
|
2552
|
+
export type ApiVersion20251101Preview = string;
|
|
2553
|
+
/** Known values of {@link KnowledgeBaseModelKind} that the service accepts. */
|
|
2554
|
+
export declare enum KnownKnowledgeBaseModelKind {
|
|
2555
|
+
/** Use Azure Open AI models for query planning. */
|
|
2556
|
+
AzureOpenAI = "azureOpenAI"
|
|
2557
|
+
}
|
|
2558
|
+
/**
|
|
2559
|
+
* Defines values for KnowledgeBaseModelKind. \
|
|
2560
|
+
* {@link KnownKnowledgeBaseModelKind} can be used interchangeably with KnowledgeBaseModelKind,
|
|
2561
|
+
* this enum contains the known values that the service supports.
|
|
2562
|
+
* ### Known values supported by the service
|
|
2563
|
+
* **azureOpenAI**: Use Azure Open AI models for query planning.
|
|
2564
|
+
*/
|
|
2565
|
+
export type KnowledgeBaseModelKind = string;
|
|
2566
|
+
/** Known values of {@link KnowledgeRetrievalReasoningEffortKind} that the service accepts. */
|
|
2567
|
+
export declare enum KnownKnowledgeRetrievalReasoningEffortKind {
|
|
2568
|
+
/** Does not perform any source selections, any query planning, or any iterative search. */
|
|
2569
|
+
Minimal = "minimal",
|
|
2570
|
+
/** Use low reasoning during retrieval. */
|
|
2571
|
+
Low = "low",
|
|
2572
|
+
/** Use a moderate amount of reasoning during retrieval. */
|
|
2573
|
+
Medium = "medium"
|
|
2574
|
+
}
|
|
2575
|
+
/**
|
|
2576
|
+
* Defines values for KnowledgeRetrievalReasoningEffortKind. \
|
|
2577
|
+
* {@link KnownKnowledgeRetrievalReasoningEffortKind} can be used interchangeably with KnowledgeRetrievalReasoningEffortKind,
|
|
2578
|
+
* this enum contains the known values that the service supports.
|
|
2579
|
+
* ### Known values supported by the service
|
|
2580
|
+
* **minimal**: Does not perform any source selections, any query planning, or any iterative search. \
|
|
2581
|
+
* **low**: Use low reasoning during retrieval. \
|
|
2582
|
+
* **medium**: Use a moderate amount of reasoning during retrieval.
|
|
2583
|
+
*/
|
|
2584
|
+
export type KnowledgeRetrievalReasoningEffortKind = string;
|
|
2585
|
+
/** Known values of {@link KnowledgeRetrievalOutputMode} that the service accepts. */
|
|
2586
|
+
export declare enum KnownKnowledgeRetrievalOutputMode {
|
|
2587
|
+
/** Return data from the knowledge sources directly without generative alteration. */
|
|
2588
|
+
ExtractiveData = "extractiveData",
|
|
2589
|
+
/** Synthesize an answer for the response payload. */
|
|
2590
|
+
AnswerSynthesis = "answerSynthesis"
|
|
2591
|
+
}
|
|
2592
|
+
/**
|
|
2593
|
+
* Defines values for KnowledgeRetrievalOutputMode. \
|
|
2594
|
+
* {@link KnownKnowledgeRetrievalOutputMode} can be used interchangeably with KnowledgeRetrievalOutputMode,
|
|
2595
|
+
* this enum contains the known values that the service supports.
|
|
2596
|
+
* ### Known values supported by the service
|
|
2597
|
+
* **extractiveData**: Return data from the knowledge sources directly without generative alteration. \
|
|
2598
|
+
* **answerSynthesis**: Synthesize an answer for the response payload.
|
|
2599
|
+
*/
|
|
2600
|
+
export type KnowledgeRetrievalOutputMode = string;
|
|
2601
|
+
/** Known values of {@link KnowledgeSourceKind} that the service accepts. */
|
|
2602
|
+
export declare enum KnownKnowledgeSourceKind {
|
|
2603
|
+
/** A knowledge source that retrieves data from a Search Index. */
|
|
2604
|
+
SearchIndex = "searchIndex",
|
|
2605
|
+
/** A knowledge source that retrieves and ingests data from Azure Blob Storage to a Search Index. */
|
|
2606
|
+
AzureBlob = "azureBlob",
|
|
2607
|
+
/** A knowledge source that retrieves data from the web. */
|
|
2608
|
+
Web = "web",
|
|
2609
|
+
/** A knowledge source that retrieves data from a remote SharePoint endpoint. */
|
|
2610
|
+
RemoteSharePoint = "remoteSharePoint",
|
|
2611
|
+
/** A knowledge source that retrieves and ingests data from SharePoint to a Search Index. */
|
|
2612
|
+
IndexedSharePoint = "indexedSharePoint",
|
|
2613
|
+
/** A knowledge source that retrieves and ingests data from OneLake to a Search Index. */
|
|
2614
|
+
IndexedOneLake = "indexedOneLake"
|
|
2615
|
+
}
|
|
2616
|
+
/**
|
|
2617
|
+
* Defines values for KnowledgeSourceKind. \
|
|
2618
|
+
* {@link KnownKnowledgeSourceKind} can be used interchangeably with KnowledgeSourceKind,
|
|
2619
|
+
* this enum contains the known values that the service supports.
|
|
2620
|
+
* ### Known values supported by the service
|
|
2621
|
+
* **searchIndex**: A knowledge source that retrieves data from a Search Index. \
|
|
2622
|
+
* **azureBlob**: A knowledge source that retrieves and ingests data from Azure Blob Storage to a Search Index. \
|
|
2623
|
+
* **web**: A knowledge source that retrieves data from the web. \
|
|
2624
|
+
* **remoteSharePoint**: A knowledge source that retrieves data from a remote SharePoint endpoint. \
|
|
2625
|
+
* **indexedSharePoint**: A knowledge source that retrieves and ingests data from SharePoint to a Search Index. \
|
|
2626
|
+
* **indexedOneLake**: A knowledge source that retrieves and ingests data from OneLake to a Search Index.
|
|
2627
|
+
*/
|
|
2628
|
+
export type KnowledgeSourceKind = string;
|
|
2629
|
+
/** Known values of {@link KnowledgeSourceSynchronizationStatus} that the service accepts. */
|
|
2630
|
+
export declare enum KnownKnowledgeSourceSynchronizationStatus {
|
|
2631
|
+
/** The knowledge source is being provisioned. */
|
|
2632
|
+
Creating = "creating",
|
|
2633
|
+
/** The knowledge source is active and synchronization runs are occurring. */
|
|
2634
|
+
Active = "active",
|
|
2635
|
+
/** The knowledge source is being deleted and synchronization is paused. */
|
|
2636
|
+
Deleting = "deleting"
|
|
1864
2637
|
}
|
|
1865
2638
|
/**
|
|
1866
|
-
* Defines values for
|
|
1867
|
-
* {@link
|
|
2639
|
+
* Defines values for KnowledgeSourceSynchronizationStatus. \
|
|
2640
|
+
* {@link KnownKnowledgeSourceSynchronizationStatus} can be used interchangeably with KnowledgeSourceSynchronizationStatus,
|
|
1868
2641
|
* this enum contains the known values that the service supports.
|
|
1869
2642
|
* ### Known values supported by the service
|
|
1870
|
-
* **
|
|
2643
|
+
* **creating**: The knowledge source is being provisioned. \
|
|
2644
|
+
* **active**: The knowledge source is active and synchronization runs are occurring. \
|
|
2645
|
+
* **deleting**: The knowledge source is being deleted and synchronization is paused.
|
|
1871
2646
|
*/
|
|
1872
|
-
export type
|
|
2647
|
+
export type KnowledgeSourceSynchronizationStatus = string;
|
|
1873
2648
|
/** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
|
|
1874
2649
|
export declare enum KnownSearchIndexerDataSourceType {
|
|
1875
|
-
/**
|
|
2650
|
+
/** Indicates an Azure SQL datasource. */
|
|
1876
2651
|
AzureSql = "azuresql",
|
|
1877
|
-
/**
|
|
2652
|
+
/** Indicates a CosmosDB datasource. */
|
|
1878
2653
|
CosmosDb = "cosmosdb",
|
|
1879
|
-
/**
|
|
2654
|
+
/** Indicates an Azure Blob datasource. */
|
|
1880
2655
|
AzureBlob = "azureblob",
|
|
1881
|
-
/**
|
|
2656
|
+
/** Indicates an Azure Table datasource. */
|
|
1882
2657
|
AzureTable = "azuretable",
|
|
1883
|
-
/**
|
|
2658
|
+
/** Indicates a MySql datasource. */
|
|
1884
2659
|
MySql = "mysql",
|
|
1885
|
-
/**
|
|
2660
|
+
/** Indicates an ADLS Gen2 datasource. */
|
|
1886
2661
|
AdlsGen2 = "adlsgen2",
|
|
1887
|
-
/**
|
|
1888
|
-
OneLake = "onelake"
|
|
2662
|
+
/** Indicates a Microsoft Fabric OneLake datasource. */
|
|
2663
|
+
OneLake = "onelake",
|
|
2664
|
+
/** Indicates a SharePoint datasource. */
|
|
2665
|
+
SharePoint = "sharepoint"
|
|
1889
2666
|
}
|
|
1890
2667
|
/**
|
|
1891
2668
|
* Defines values for SearchIndexerDataSourceType. \
|
|
1892
2669
|
* {@link KnownSearchIndexerDataSourceType} can be used interchangeably with SearchIndexerDataSourceType,
|
|
1893
2670
|
* this enum contains the known values that the service supports.
|
|
1894
2671
|
* ### Known values supported by the service
|
|
1895
|
-
* **azuresql**:
|
|
1896
|
-
* **cosmosdb**:
|
|
1897
|
-
* **azureblob**:
|
|
1898
|
-
* **azuretable**:
|
|
1899
|
-
* **mysql**:
|
|
1900
|
-
* **adlsgen2**:
|
|
1901
|
-
* **onelake**:
|
|
2672
|
+
* **azuresql**: Indicates an Azure SQL datasource. \
|
|
2673
|
+
* **cosmosdb**: Indicates a CosmosDB datasource. \
|
|
2674
|
+
* **azureblob**: Indicates an Azure Blob datasource. \
|
|
2675
|
+
* **azuretable**: Indicates an Azure Table datasource. \
|
|
2676
|
+
* **mysql**: Indicates a MySql datasource. \
|
|
2677
|
+
* **adlsgen2**: Indicates an ADLS Gen2 datasource. \
|
|
2678
|
+
* **onelake**: Indicates a Microsoft Fabric OneLake datasource. \
|
|
2679
|
+
* **sharepoint**: Indicates a SharePoint datasource.
|
|
1902
2680
|
*/
|
|
1903
2681
|
export type SearchIndexerDataSourceType = string;
|
|
2682
|
+
/** Known values of {@link IndexerPermissionOption} that the service accepts. */
|
|
2683
|
+
export declare enum KnownIndexerPermissionOption {
|
|
2684
|
+
/** Indexer to ingest ACL userIds from data source to index. */
|
|
2685
|
+
UserIds = "userIds",
|
|
2686
|
+
/** Indexer to ingest ACL groupIds from data source to index. */
|
|
2687
|
+
GroupIds = "groupIds",
|
|
2688
|
+
/** Indexer to ingest Azure RBAC scope from data source to index. */
|
|
2689
|
+
RbacScope = "rbacScope"
|
|
2690
|
+
}
|
|
2691
|
+
/**
|
|
2692
|
+
* Defines values for IndexerPermissionOption. \
|
|
2693
|
+
* {@link KnownIndexerPermissionOption} can be used interchangeably with IndexerPermissionOption,
|
|
2694
|
+
* this enum contains the known values that the service supports.
|
|
2695
|
+
* ### Known values supported by the service
|
|
2696
|
+
* **userIds**: Indexer to ingest ACL userIds from data source to index. \
|
|
2697
|
+
* **groupIds**: Indexer to ingest ACL groupIds from data source to index. \
|
|
2698
|
+
* **rbacScope**: Indexer to ingest Azure RBAC scope from data source to index.
|
|
2699
|
+
*/
|
|
2700
|
+
export type IndexerPermissionOption = string;
|
|
2701
|
+
/** Known values of {@link IndexerResyncOption} that the service accepts. */
|
|
2702
|
+
export declare enum KnownIndexerResyncOption {
|
|
2703
|
+
/** Indexer to re-ingest pre-selected permissions data from data source to index. */
|
|
2704
|
+
Permissions = "permissions"
|
|
2705
|
+
}
|
|
2706
|
+
/**
|
|
2707
|
+
* Defines values for IndexerResyncOption. \
|
|
2708
|
+
* {@link KnownIndexerResyncOption} can be used interchangeably with IndexerResyncOption,
|
|
2709
|
+
* this enum contains the known values that the service supports.
|
|
2710
|
+
* ### Known values supported by the service
|
|
2711
|
+
* **permissions**: Indexer to re-ingest pre-selected permissions data from data source to index.
|
|
2712
|
+
*/
|
|
2713
|
+
export type IndexerResyncOption = string;
|
|
1904
2714
|
/** Known values of {@link BlobIndexerParsingMode} that the service accepts. */
|
|
1905
2715
|
export declare enum KnownBlobIndexerParsingMode {
|
|
1906
2716
|
/** Set to default for normal file processing. */
|
|
@@ -1914,7 +2724,9 @@ export declare enum KnownBlobIndexerParsingMode {
|
|
|
1914
2724
|
/** Set to jsonArray to extract individual elements of a JSON array as separate documents. */
|
|
1915
2725
|
JsonArray = "jsonArray",
|
|
1916
2726
|
/** Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. */
|
|
1917
|
-
JsonLines = "jsonLines"
|
|
2727
|
+
JsonLines = "jsonLines",
|
|
2728
|
+
/** Set to markdown to extract content from markdown files. */
|
|
2729
|
+
Markdown = "markdown"
|
|
1918
2730
|
}
|
|
1919
2731
|
/**
|
|
1920
2732
|
* Defines values for BlobIndexerParsingMode. \
|
|
@@ -1926,9 +2738,54 @@ export declare enum KnownBlobIndexerParsingMode {
|
|
|
1926
2738
|
* **delimitedText**: Set to delimitedText when blobs are plain CSV files. \
|
|
1927
2739
|
* **json**: Set to json to extract structured content from JSON files. \
|
|
1928
2740
|
* **jsonArray**: Set to jsonArray to extract individual elements of a JSON array as separate documents. \
|
|
1929
|
-
* **jsonLines**: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents.
|
|
2741
|
+
* **jsonLines**: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. \
|
|
2742
|
+
* **markdown**: Set to markdown to extract content from markdown files.
|
|
1930
2743
|
*/
|
|
1931
2744
|
export type BlobIndexerParsingMode = string;
|
|
2745
|
+
/** Known values of {@link MarkdownParsingSubmode} that the service accepts. */
|
|
2746
|
+
export declare enum KnownMarkdownParsingSubmode {
|
|
2747
|
+
/** Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. */
|
|
2748
|
+
OneToMany = "oneToMany",
|
|
2749
|
+
/** Indicates that each markdown file will be parsed into a single search document. */
|
|
2750
|
+
OneToOne = "oneToOne"
|
|
2751
|
+
}
|
|
2752
|
+
/**
|
|
2753
|
+
* Defines values for MarkdownParsingSubmode. \
|
|
2754
|
+
* {@link KnownMarkdownParsingSubmode} can be used interchangeably with MarkdownParsingSubmode,
|
|
2755
|
+
* this enum contains the known values that the service supports.
|
|
2756
|
+
* ### Known values supported by the service
|
|
2757
|
+
* **oneToMany**: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. \
|
|
2758
|
+
* **oneToOne**: Indicates that each markdown file will be parsed into a single search document.
|
|
2759
|
+
*/
|
|
2760
|
+
export type MarkdownParsingSubmode = string;
|
|
2761
|
+
/** Known values of {@link MarkdownHeaderDepth} that the service accepts. */
|
|
2762
|
+
export declare enum KnownMarkdownHeaderDepth {
|
|
2763
|
+
/** Indicates that headers up to a level of h1 will be considered while grouping markdown content. */
|
|
2764
|
+
H1 = "h1",
|
|
2765
|
+
/** Indicates that headers up to a level of h2 will be considered while grouping markdown content. */
|
|
2766
|
+
H2 = "h2",
|
|
2767
|
+
/** Indicates that headers up to a level of h3 will be considered while grouping markdown content. */
|
|
2768
|
+
H3 = "h3",
|
|
2769
|
+
/** Indicates that headers up to a level of h4 will be considered while grouping markdown content. */
|
|
2770
|
+
H4 = "h4",
|
|
2771
|
+
/** Indicates that headers up to a level of h5 will be considered while grouping markdown content. */
|
|
2772
|
+
H5 = "h5",
|
|
2773
|
+
/** Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. */
|
|
2774
|
+
H6 = "h6"
|
|
2775
|
+
}
|
|
2776
|
+
/**
|
|
2777
|
+
* Defines values for MarkdownHeaderDepth. \
|
|
2778
|
+
* {@link KnownMarkdownHeaderDepth} can be used interchangeably with MarkdownHeaderDepth,
|
|
2779
|
+
* this enum contains the known values that the service supports.
|
|
2780
|
+
* ### Known values supported by the service
|
|
2781
|
+
* **h1**: Indicates that headers up to a level of h1 will be considered while grouping markdown content. \
|
|
2782
|
+
* **h2**: Indicates that headers up to a level of h2 will be considered while grouping markdown content. \
|
|
2783
|
+
* **h3**: Indicates that headers up to a level of h3 will be considered while grouping markdown content. \
|
|
2784
|
+
* **h4**: Indicates that headers up to a level of h4 will be considered while grouping markdown content. \
|
|
2785
|
+
* **h5**: Indicates that headers up to a level of h5 will be considered while grouping markdown content. \
|
|
2786
|
+
* **h6**: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default.
|
|
2787
|
+
*/
|
|
2788
|
+
export type MarkdownHeaderDepth = string;
|
|
1932
2789
|
/** Known values of {@link BlobIndexerDataToExtract} that the service accepts. */
|
|
1933
2790
|
export declare enum KnownBlobIndexerDataToExtract {
|
|
1934
2791
|
/** Indexes just the standard blob properties and user-specified metadata. */
|
|
@@ -1999,6 +2856,41 @@ export declare enum KnownIndexerExecutionEnvironment {
|
|
|
1999
2856
|
* **private**: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources.
|
|
2000
2857
|
*/
|
|
2001
2858
|
export type IndexerExecutionEnvironment = string;
|
|
2859
|
+
/** Known values of {@link IndexerExecutionStatusDetail} that the service accepts. */
|
|
2860
|
+
export declare enum KnownIndexerExecutionStatusDetail {
|
|
2861
|
+
/** Indicates that the reset that occurred was for a call to ResetDocs. */
|
|
2862
|
+
ResetDocs = "resetDocs",
|
|
2863
|
+
/** Indicates to selectively resync based on option(s) from data source. */
|
|
2864
|
+
Resync = "resync"
|
|
2865
|
+
}
|
|
2866
|
+
/**
|
|
2867
|
+
* Defines values for IndexerExecutionStatusDetail. \
|
|
2868
|
+
* {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
|
|
2869
|
+
* this enum contains the known values that the service supports.
|
|
2870
|
+
* ### Known values supported by the service
|
|
2871
|
+
* **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs. \
|
|
2872
|
+
* **resync**: Indicates to selectively resync based on option(s) from data source.
|
|
2873
|
+
*/
|
|
2874
|
+
export type IndexerExecutionStatusDetail = string;
|
|
2875
|
+
/** Known values of {@link IndexingMode} that the service accepts. */
|
|
2876
|
+
export declare enum KnownIndexingMode {
|
|
2877
|
+
/** The indexer is indexing all documents in the datasource. */
|
|
2878
|
+
IndexingAllDocs = "indexingAllDocs",
|
|
2879
|
+
/** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
|
|
2880
|
+
IndexingResetDocs = "indexingResetDocs",
|
|
2881
|
+
/** The indexer is resyncing and indexing selective option(s) from the datasource. */
|
|
2882
|
+
IndexingResync = "indexingResync"
|
|
2883
|
+
}
|
|
2884
|
+
/**
|
|
2885
|
+
* Defines values for IndexingMode. \
|
|
2886
|
+
* {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
|
|
2887
|
+
* this enum contains the known values that the service supports.
|
|
2888
|
+
* ### Known values supported by the service
|
|
2889
|
+
* **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
|
|
2890
|
+
* **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. \
|
|
2891
|
+
* **indexingResync**: The indexer is resyncing and indexing selective option(s) from the datasource.
|
|
2892
|
+
*/
|
|
2893
|
+
export type IndexingMode = string;
|
|
2002
2894
|
/** Known values of {@link IndexProjectionMode} that the service accepts. */
|
|
2003
2895
|
export declare enum KnownIndexProjectionMode {
|
|
2004
2896
|
/** The source document will be skipped from writing into the indexer's target index. */
|
|
@@ -2064,6 +2956,25 @@ export declare enum KnownSearchFieldDataType {
|
|
|
2064
2956
|
* **Edm.Byte**: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte).
|
|
2065
2957
|
*/
|
|
2066
2958
|
export type SearchFieldDataType = string;
|
|
2959
|
+
/** Known values of {@link PermissionFilter} that the service accepts. */
|
|
2960
|
+
export declare enum KnownPermissionFilter {
|
|
2961
|
+
/** Field represents user IDs that should be used to filter document access on queries. */
|
|
2962
|
+
UserIds = "userIds",
|
|
2963
|
+
/** Field represents group IDs that should be used to filter document access on queries. */
|
|
2964
|
+
GroupIds = "groupIds",
|
|
2965
|
+
/** Field represents an RBAC scope that should be used to filter document access on queries. */
|
|
2966
|
+
RbacScope = "rbacScope"
|
|
2967
|
+
}
|
|
2968
|
+
/**
|
|
2969
|
+
* Defines values for PermissionFilter. \
|
|
2970
|
+
* {@link KnownPermissionFilter} can be used interchangeably with PermissionFilter,
|
|
2971
|
+
* this enum contains the known values that the service supports.
|
|
2972
|
+
* ### Known values supported by the service
|
|
2973
|
+
* **userIds**: Field represents user IDs that should be used to filter document access on queries. \
|
|
2974
|
+
* **groupIds**: Field represents group IDs that should be used to filter document access on queries. \
|
|
2975
|
+
* **rbacScope**: Field represents an RBAC scope that should be used to filter document access on queries.
|
|
2976
|
+
*/
|
|
2977
|
+
export type PermissionFilter = string;
|
|
2067
2978
|
/** Known values of {@link LexicalAnalyzerName} that the service accepts. */
|
|
2068
2979
|
export declare enum KnownLexicalAnalyzerName {
|
|
2069
2980
|
/** Microsoft analyzer for Arabic. */
|
|
@@ -2396,7 +3307,7 @@ export declare enum KnownRankingOrder {
|
|
|
2396
3307
|
/** Sets sort order as BoostedRerankerScore */
|
|
2397
3308
|
BoostedRerankerScore = "BoostedRerankerScore",
|
|
2398
3309
|
/** Sets sort order as ReRankerScore */
|
|
2399
|
-
|
|
3310
|
+
ReRankerScore = "RerankerScore"
|
|
2400
3311
|
}
|
|
2401
3312
|
/**
|
|
2402
3313
|
* Defines values for RankingOrder. \
|
|
@@ -2428,7 +3339,11 @@ export declare enum KnownVectorSearchVectorizerKind {
|
|
|
2428
3339
|
/** Generate embeddings using an Azure OpenAI resource at query time. */
|
|
2429
3340
|
AzureOpenAI = "azureOpenAI",
|
|
2430
3341
|
/** Generate embeddings using a custom web endpoint at query time. */
|
|
2431
|
-
CustomWebApi = "customWebApi"
|
|
3342
|
+
CustomWebApi = "customWebApi",
|
|
3343
|
+
/** Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. */
|
|
3344
|
+
AIServicesVision = "aiServicesVision",
|
|
3345
|
+
/** Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. */
|
|
3346
|
+
AML = "aml"
|
|
2432
3347
|
}
|
|
2433
3348
|
/**
|
|
2434
3349
|
* Defines values for VectorSearchVectorizerKind. \
|
|
@@ -2436,7 +3351,9 @@ export declare enum KnownVectorSearchVectorizerKind {
|
|
|
2436
3351
|
* this enum contains the known values that the service supports.
|
|
2437
3352
|
* ### Known values supported by the service
|
|
2438
3353
|
* **azureOpenAI**: Generate embeddings using an Azure OpenAI resource at query time. \
|
|
2439
|
-
* **customWebApi**: Generate embeddings using a custom web endpoint at query time.
|
|
3354
|
+
* **customWebApi**: Generate embeddings using a custom web endpoint at query time. \
|
|
3355
|
+
* **aiServicesVision**: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. \
|
|
3356
|
+
* **aml**: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time.
|
|
2440
3357
|
*/
|
|
2441
3358
|
export type VectorSearchVectorizerKind = string;
|
|
2442
3359
|
/** Known values of {@link VectorSearchCompressionKind} that the service accepts. */
|
|
@@ -2471,6 +3388,119 @@ export declare enum KnownVectorSearchCompressionRescoreStorageMethod {
|
|
|
2471
3388
|
* **discardOriginals**: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality.
|
|
2472
3389
|
*/
|
|
2473
3390
|
export type VectorSearchCompressionRescoreStorageMethod = string;
|
|
3391
|
+
/** Known values of {@link SearchIndexPermissionFilterOption} that the service accepts. */
|
|
3392
|
+
export declare enum KnownSearchIndexPermissionFilterOption {
|
|
3393
|
+
/** Enabled */
|
|
3394
|
+
Enabled = "enabled",
|
|
3395
|
+
/** Disabled */
|
|
3396
|
+
Disabled = "disabled"
|
|
3397
|
+
}
|
|
3398
|
+
/**
|
|
3399
|
+
* Defines values for SearchIndexPermissionFilterOption. \
|
|
3400
|
+
* {@link KnownSearchIndexPermissionFilterOption} can be used interchangeably with SearchIndexPermissionFilterOption,
|
|
3401
|
+
* this enum contains the known values that the service supports.
|
|
3402
|
+
* ### Known values supported by the service
|
|
3403
|
+
* **enabled** \
|
|
3404
|
+
* **disabled**
|
|
3405
|
+
*/
|
|
3406
|
+
export type SearchIndexPermissionFilterOption = string;
|
|
3407
|
+
/** Known values of {@link AzureOpenAIModelName} that the service accepts. */
|
|
3408
|
+
export declare enum KnownAzureOpenAIModelName {
|
|
3409
|
+
/** TextEmbeddingAda002 */
|
|
3410
|
+
TextEmbeddingAda002 = "text-embedding-ada-002",
|
|
3411
|
+
/** TextEmbedding3Large */
|
|
3412
|
+
TextEmbedding3Large = "text-embedding-3-large",
|
|
3413
|
+
/** TextEmbedding3Small */
|
|
3414
|
+
TextEmbedding3Small = "text-embedding-3-small",
|
|
3415
|
+
/** Gpt4O */
|
|
3416
|
+
Gpt4O = "gpt-4o",
|
|
3417
|
+
/** Gpt4OMini */
|
|
3418
|
+
Gpt4OMini = "gpt-4o-mini",
|
|
3419
|
+
/** Gpt41 */
|
|
3420
|
+
Gpt41 = "gpt-4.1",
|
|
3421
|
+
/** Gpt41Mini */
|
|
3422
|
+
Gpt41Mini = "gpt-4.1-mini",
|
|
3423
|
+
/** Gpt41Nano */
|
|
3424
|
+
Gpt41Nano = "gpt-4.1-nano",
|
|
3425
|
+
/** Gpt5 */
|
|
3426
|
+
Gpt5 = "gpt-5",
|
|
3427
|
+
/** Gpt5Mini */
|
|
3428
|
+
Gpt5Mini = "gpt-5-mini",
|
|
3429
|
+
/** Gpt5Nano */
|
|
3430
|
+
Gpt5Nano = "gpt-5-nano"
|
|
3431
|
+
}
|
|
3432
|
+
/**
|
|
3433
|
+
* Defines values for AzureOpenAIModelName. \
|
|
3434
|
+
* {@link KnownAzureOpenAIModelName} can be used interchangeably with AzureOpenAIModelName,
|
|
3435
|
+
* this enum contains the known values that the service supports.
|
|
3436
|
+
* ### Known values supported by the service
|
|
3437
|
+
* **text-embedding-ada-002** \
|
|
3438
|
+
* **text-embedding-3-large** \
|
|
3439
|
+
* **text-embedding-3-small** \
|
|
3440
|
+
* **gpt-4o** \
|
|
3441
|
+
* **gpt-4o-mini** \
|
|
3442
|
+
* **gpt-4.1** \
|
|
3443
|
+
* **gpt-4.1-mini** \
|
|
3444
|
+
* **gpt-4.1-nano** \
|
|
3445
|
+
* **gpt-5** \
|
|
3446
|
+
* **gpt-5-mini** \
|
|
3447
|
+
* **gpt-5-nano**
|
|
3448
|
+
*/
|
|
3449
|
+
export type AzureOpenAIModelName = string;
|
|
3450
|
+
/** Known values of {@link KnowledgeSourceIngestionPermissionOption} that the service accepts. */
|
|
3451
|
+
export declare enum KnownKnowledgeSourceIngestionPermissionOption {
|
|
3452
|
+
/** Ingest explicit user identifiers alongside document content. */
|
|
3453
|
+
UserIds = "userIds",
|
|
3454
|
+
/** Ingest group identifiers alongside document content. */
|
|
3455
|
+
GroupIds = "groupIds",
|
|
3456
|
+
/** Ingest RBAC scope information alongside document content. */
|
|
3457
|
+
RbacScope = "rbacScope"
|
|
3458
|
+
}
|
|
3459
|
+
/**
|
|
3460
|
+
* Defines values for KnowledgeSourceIngestionPermissionOption. \
|
|
3461
|
+
* {@link KnownKnowledgeSourceIngestionPermissionOption} can be used interchangeably with KnowledgeSourceIngestionPermissionOption,
|
|
3462
|
+
* this enum contains the known values that the service supports.
|
|
3463
|
+
* ### Known values supported by the service
|
|
3464
|
+
* **userIds**: Ingest explicit user identifiers alongside document content. \
|
|
3465
|
+
* **groupIds**: Ingest group identifiers alongside document content. \
|
|
3466
|
+
* **rbacScope**: Ingest RBAC scope information alongside document content.
|
|
3467
|
+
*/
|
|
3468
|
+
export type KnowledgeSourceIngestionPermissionOption = string;
|
|
3469
|
+
/** Known values of {@link KnowledgeSourceContentExtractionMode} that the service accepts. */
|
|
3470
|
+
export declare enum KnownKnowledgeSourceContentExtractionMode {
|
|
3471
|
+
/** Extracts only essential metadata while deferring most content processing. */
|
|
3472
|
+
Minimal = "minimal",
|
|
3473
|
+
/** Performs the full default content extraction pipeline. */
|
|
3474
|
+
Standard = "standard"
|
|
3475
|
+
}
|
|
3476
|
+
/**
|
|
3477
|
+
* Defines values for KnowledgeSourceContentExtractionMode. \
|
|
3478
|
+
* {@link KnownKnowledgeSourceContentExtractionMode} can be used interchangeably with KnowledgeSourceContentExtractionMode,
|
|
3479
|
+
* this enum contains the known values that the service supports.
|
|
3480
|
+
* ### Known values supported by the service
|
|
3481
|
+
* **minimal**: Extracts only essential metadata while deferring most content processing. \
|
|
3482
|
+
* **standard**: Performs the full default content extraction pipeline.
|
|
3483
|
+
*/
|
|
3484
|
+
export type KnowledgeSourceContentExtractionMode = string;
|
|
3485
|
+
/** Known values of {@link IndexedSharePointContainerName} that the service accepts. */
|
|
3486
|
+
export declare enum KnownIndexedSharePointContainerName {
|
|
3487
|
+
/** Index content from the site's default document library. */
|
|
3488
|
+
DefaultSiteLibrary = "defaultSiteLibrary",
|
|
3489
|
+
/** Index content from every document library in the site. */
|
|
3490
|
+
AllSiteLibraries = "allSiteLibraries",
|
|
3491
|
+
/** Index only content that matches the query specified in the knowledge source. */
|
|
3492
|
+
UseQuery = "useQuery"
|
|
3493
|
+
}
|
|
3494
|
+
/**
|
|
3495
|
+
* Defines values for IndexedSharePointContainerName. \
|
|
3496
|
+
* {@link KnownIndexedSharePointContainerName} can be used interchangeably with IndexedSharePointContainerName,
|
|
3497
|
+
* this enum contains the known values that the service supports.
|
|
3498
|
+
* ### Known values supported by the service
|
|
3499
|
+
* **defaultSiteLibrary**: Index content from the site's default document library. \
|
|
3500
|
+
* **allSiteLibraries**: Index content from every document library in the site. \
|
|
3501
|
+
* **useQuery**: Index only content that matches the query specified in the knowledge source.
|
|
3502
|
+
*/
|
|
3503
|
+
export type IndexedSharePointContainerName = string;
|
|
2474
3504
|
/** Known values of {@link TokenFilterName} that the service accepts. */
|
|
2475
3505
|
export declare enum KnownTokenFilterName {
|
|
2476
3506
|
/** A token filter that applies the Arabic normalizer to normalize the orthography. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/ar\/ArabicNormalizationFilter.html */
|
|
@@ -2631,25 +3661,37 @@ export declare enum KnownVectorSearchCompressionTarget {
|
|
|
2631
3661
|
* **int8**
|
|
2632
3662
|
*/
|
|
2633
3663
|
export type VectorSearchCompressionTarget = string;
|
|
2634
|
-
/** Known values of {@link
|
|
2635
|
-
export declare enum
|
|
2636
|
-
/**
|
|
2637
|
-
|
|
2638
|
-
/**
|
|
2639
|
-
|
|
2640
|
-
/**
|
|
2641
|
-
|
|
3664
|
+
/** Known values of {@link AIFoundryModelCatalogName} that the service accepts. */
|
|
3665
|
+
export declare enum KnownAIFoundryModelCatalogName {
|
|
3666
|
+
/** OpenAIClipImageTextEmbeddingsVitBasePatch32 */
|
|
3667
|
+
OpenAIClipImageTextEmbeddingsVitBasePatch32 = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32",
|
|
3668
|
+
/** OpenAIClipImageTextEmbeddingsViTLargePatch14336 */
|
|
3669
|
+
OpenAIClipImageTextEmbeddingsViTLargePatch14336 = "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336",
|
|
3670
|
+
/** FacebookDinoV2ImageEmbeddingsViTBase */
|
|
3671
|
+
FacebookDinoV2ImageEmbeddingsViTBase = "Facebook-DinoV2-Image-Embeddings-ViT-Base",
|
|
3672
|
+
/** FacebookDinoV2ImageEmbeddingsViTGiant */
|
|
3673
|
+
FacebookDinoV2ImageEmbeddingsViTGiant = "Facebook-DinoV2-Image-Embeddings-ViT-Giant",
|
|
3674
|
+
/** CohereEmbedV3English */
|
|
3675
|
+
CohereEmbedV3English = "Cohere-embed-v3-english",
|
|
3676
|
+
/** CohereEmbedV3Multilingual */
|
|
3677
|
+
CohereEmbedV3Multilingual = "Cohere-embed-v3-multilingual",
|
|
3678
|
+
/** Cohere embed v4 model for generating embeddings from both text and images. */
|
|
3679
|
+
CohereEmbedV4 = "Cohere-embed-v4"
|
|
2642
3680
|
}
|
|
2643
3681
|
/**
|
|
2644
|
-
* Defines values for
|
|
2645
|
-
* {@link
|
|
3682
|
+
* Defines values for AIFoundryModelCatalogName. \
|
|
3683
|
+
* {@link KnownAIFoundryModelCatalogName} can be used interchangeably with AIFoundryModelCatalogName,
|
|
2646
3684
|
* this enum contains the known values that the service supports.
|
|
2647
3685
|
* ### Known values supported by the service
|
|
2648
|
-
* **
|
|
2649
|
-
* **
|
|
2650
|
-
* **
|
|
3686
|
+
* **OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32** \
|
|
3687
|
+
* **OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336** \
|
|
3688
|
+
* **Facebook-DinoV2-Image-Embeddings-ViT-Base** \
|
|
3689
|
+
* **Facebook-DinoV2-Image-Embeddings-ViT-Giant** \
|
|
3690
|
+
* **Cohere-embed-v3-english** \
|
|
3691
|
+
* **Cohere-embed-v3-multilingual** \
|
|
3692
|
+
* **Cohere-embed-v4**: Cohere embed v4 model for generating embeddings from both text and images.
|
|
2651
3693
|
*/
|
|
2652
|
-
export type
|
|
3694
|
+
export type AIFoundryModelCatalogName = string;
|
|
2653
3695
|
/** Known values of {@link KeyPhraseExtractionSkillLanguage} that the service accepts. */
|
|
2654
3696
|
export declare enum KnownKeyPhraseExtractionSkillLanguage {
|
|
2655
3697
|
/** Danish */
|
|
@@ -3769,6 +4811,44 @@ export declare enum KnownTextSplitMode {
|
|
|
3769
4811
|
* **sentences**: Split the text into individual sentences.
|
|
3770
4812
|
*/
|
|
3771
4813
|
export type TextSplitMode = string;
|
|
4814
|
+
/** Known values of {@link SplitSkillUnit} that the service accepts. */
|
|
4815
|
+
export declare enum KnownSplitSkillUnit {
|
|
4816
|
+
/** The length will be measured by character. */
|
|
4817
|
+
Characters = "characters",
|
|
4818
|
+
/** The length will be measured by an AzureOpenAI tokenizer from the tiktoken library. */
|
|
4819
|
+
AzureOpenAITokens = "azureOpenAITokens"
|
|
4820
|
+
}
|
|
4821
|
+
/**
|
|
4822
|
+
* Defines values for SplitSkillUnit. \
|
|
4823
|
+
* {@link KnownSplitSkillUnit} can be used interchangeably with SplitSkillUnit,
|
|
4824
|
+
* this enum contains the known values that the service supports.
|
|
4825
|
+
* ### Known values supported by the service
|
|
4826
|
+
* **characters**: The length will be measured by character. \
|
|
4827
|
+
* **azureOpenAITokens**: The length will be measured by an AzureOpenAI tokenizer from the tiktoken library.
|
|
4828
|
+
*/
|
|
4829
|
+
export type SplitSkillUnit = string;
|
|
4830
|
+
/** Known values of {@link SplitSkillEncoderModelName} that the service accepts. */
|
|
4831
|
+
export declare enum KnownSplitSkillEncoderModelName {
|
|
4832
|
+
/** Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks. */
|
|
4833
|
+
R50KBase = "r50k_base",
|
|
4834
|
+
/** A base model with a 50,000 token vocabulary, optimized for prompt-based tasks. */
|
|
4835
|
+
P50KBase = "p50k_base",
|
|
4836
|
+
/** Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary. */
|
|
4837
|
+
P50KEdit = "p50k_edit",
|
|
4838
|
+
/** A base model with a 100,000 token vocabulary. */
|
|
4839
|
+
CL100KBase = "cl100k_base"
|
|
4840
|
+
}
|
|
4841
|
+
/**
|
|
4842
|
+
* Defines values for SplitSkillEncoderModelName. \
|
|
4843
|
+
* {@link KnownSplitSkillEncoderModelName} can be used interchangeably with SplitSkillEncoderModelName,
|
|
4844
|
+
* this enum contains the known values that the service supports.
|
|
4845
|
+
* ### Known values supported by the service
|
|
4846
|
+
* **r50k_base**: Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks. \
|
|
4847
|
+
* **p50k_base**: A base model with a 50,000 token vocabulary, optimized for prompt-based tasks. \
|
|
4848
|
+
* **p50k_edit**: Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary. \
|
|
4849
|
+
* **cl100k_base**: A base model with a 100,000 token vocabulary.
|
|
4850
|
+
*/
|
|
4851
|
+
export type SplitSkillEncoderModelName = string;
|
|
3772
4852
|
/** Known values of {@link CustomEntityLookupSkillLanguage} that the service accepts. */
|
|
3773
4853
|
export declare enum KnownCustomEntityLookupSkillLanguage {
|
|
3774
4854
|
/** Danish */
|
|
@@ -4118,6 +5198,73 @@ export declare enum KnownDocumentIntelligenceLayoutSkillChunkingUnit {
|
|
|
4118
5198
|
* **characters**: Specifies chunk by characters.
|
|
4119
5199
|
*/
|
|
4120
5200
|
export type DocumentIntelligenceLayoutSkillChunkingUnit = string;
|
|
5201
|
+
/** Known values of {@link ChatCompletionExtraParametersBehavior} that the service accepts. */
|
|
5202
|
+
export declare enum KnownChatCompletionExtraParametersBehavior {
|
|
5203
|
+
/** Passes any extra parameters directly to the model. */
|
|
5204
|
+
PassThrough = "passThrough",
|
|
5205
|
+
/** Drops all extra parameters. */
|
|
5206
|
+
Drop = "drop",
|
|
5207
|
+
/** Raises an error if any extra parameter is present. */
|
|
5208
|
+
Error = "error"
|
|
5209
|
+
}
|
|
5210
|
+
/**
|
|
5211
|
+
* Defines values for ChatCompletionExtraParametersBehavior. \
|
|
5212
|
+
* {@link KnownChatCompletionExtraParametersBehavior} can be used interchangeably with ChatCompletionExtraParametersBehavior,
|
|
5213
|
+
* this enum contains the known values that the service supports.
|
|
5214
|
+
* ### Known values supported by the service
|
|
5215
|
+
* **passThrough**: Passes any extra parameters directly to the model. \
|
|
5216
|
+
* **drop**: Drops all extra parameters. \
|
|
5217
|
+
* **error**: Raises an error if any extra parameter is present.
|
|
5218
|
+
*/
|
|
5219
|
+
export type ChatCompletionExtraParametersBehavior = string;
|
|
5220
|
+
/** Known values of {@link ChatCompletionResponseFormatType} that the service accepts. */
|
|
5221
|
+
export declare enum KnownChatCompletionResponseFormatType {
|
|
5222
|
+
/** Text */
|
|
5223
|
+
Text = "text",
|
|
5224
|
+
/** JsonObject */
|
|
5225
|
+
JsonObject = "jsonObject",
|
|
5226
|
+
/** JsonSchema */
|
|
5227
|
+
JsonSchema = "jsonSchema"
|
|
5228
|
+
}
|
|
5229
|
+
/**
|
|
5230
|
+
* Defines values for ChatCompletionResponseFormatType. \
|
|
5231
|
+
* {@link KnownChatCompletionResponseFormatType} can be used interchangeably with ChatCompletionResponseFormatType,
|
|
5232
|
+
* this enum contains the known values that the service supports.
|
|
5233
|
+
* ### Known values supported by the service
|
|
5234
|
+
* **text** \
|
|
5235
|
+
* **jsonObject** \
|
|
5236
|
+
* **jsonSchema**
|
|
5237
|
+
*/
|
|
5238
|
+
export type ChatCompletionResponseFormatType = string;
|
|
5239
|
+
/** Known values of {@link ContentUnderstandingSkillExtractionOptions} that the service accepts. */
|
|
5240
|
+
export declare enum KnownContentUnderstandingSkillExtractionOptions {
|
|
5241
|
+
/** Specify that image content should be extracted from the document. */
|
|
5242
|
+
Images = "images",
|
|
5243
|
+
/** Specify that location metadata should be extracted from the document. */
|
|
5244
|
+
LocationMetadata = "locationMetadata"
|
|
5245
|
+
}
|
|
5246
|
+
/**
|
|
5247
|
+
* Defines values for ContentUnderstandingSkillExtractionOptions. \
|
|
5248
|
+
* {@link KnownContentUnderstandingSkillExtractionOptions} can be used interchangeably with ContentUnderstandingSkillExtractionOptions,
|
|
5249
|
+
* this enum contains the known values that the service supports.
|
|
5250
|
+
* ### Known values supported by the service
|
|
5251
|
+
* **images**: Specify that image content should be extracted from the document. \
|
|
5252
|
+
* **locationMetadata**: Specify that location metadata should be extracted from the document.
|
|
5253
|
+
*/
|
|
5254
|
+
export type ContentUnderstandingSkillExtractionOptions = string;
|
|
5255
|
+
/** Known values of {@link ContentUnderstandingSkillChunkingUnit} that the service accepts. */
|
|
5256
|
+
export declare enum KnownContentUnderstandingSkillChunkingUnit {
|
|
5257
|
+
/** Specifies chunk by characters. */
|
|
5258
|
+
Characters = "characters"
|
|
5259
|
+
}
|
|
5260
|
+
/**
|
|
5261
|
+
* Defines values for ContentUnderstandingSkillChunkingUnit. \
|
|
5262
|
+
* {@link KnownContentUnderstandingSkillChunkingUnit} can be used interchangeably with ContentUnderstandingSkillChunkingUnit,
|
|
5263
|
+
* this enum contains the known values that the service supports.
|
|
5264
|
+
* ### Known values supported by the service
|
|
5265
|
+
* **characters**: Specifies chunk by characters.
|
|
5266
|
+
*/
|
|
5267
|
+
export type ContentUnderstandingSkillChunkingUnit = string;
|
|
4121
5268
|
/** Known values of {@link LexicalTokenizerName} that the service accepts. */
|
|
4122
5269
|
export declare enum KnownLexicalTokenizerName {
|
|
4123
5270
|
/** Grammar-based tokenizer that is suitable for processing most European-language documents. See http:\//lucene.apache.org\/core\/4_10_3\/analyzers-common\/org\/apache\/lucene\/analysis\/standard\/ClassicTokenizer.html */
|
|
@@ -4208,7 +5355,7 @@ export type IndexerExecutionStatus = "transientFailure" | "success" | "inProgres
|
|
|
4208
5355
|
/** Defines values for ScoringFunctionInterpolation. */
|
|
4209
5356
|
export type ScoringFunctionInterpolation = "linear" | "constant" | "quadratic" | "logarithmic";
|
|
4210
5357
|
/** Defines values for ScoringFunctionAggregation. */
|
|
4211
|
-
export type ScoringFunctionAggregation = "sum" | "average" | "minimum" | "maximum" | "firstMatching";
|
|
5358
|
+
export type ScoringFunctionAggregation = "sum" | "average" | "minimum" | "maximum" | "firstMatching" | "product";
|
|
4212
5359
|
/** Defines values for TokenCharacterKind. */
|
|
4213
5360
|
export type TokenCharacterKind = "letter" | "digit" | "whitespace" | "punctuation" | "symbol";
|
|
4214
5361
|
/** Defines values for MicrosoftTokenizerLanguage. */
|
|
@@ -4228,11 +5375,80 @@ export type StemmerTokenFilterLanguage = "arabic" | "armenian" | "basque" | "bra
|
|
|
4228
5375
|
/** Defines values for StopwordsList. */
|
|
4229
5376
|
export type StopwordsList = "arabic" | "armenian" | "basque" | "brazilian" | "bulgarian" | "catalan" | "czech" | "danish" | "dutch" | "english" | "finnish" | "french" | "galician" | "german" | "greek" | "hindi" | "hungarian" | "indonesian" | "irish" | "italian" | "latvian" | "norwegian" | "persian" | "portuguese" | "romanian" | "russian" | "sorani" | "spanish" | "swedish" | "thai" | "turkish";
|
|
4230
5377
|
/** Optional parameters. */
|
|
5378
|
+
export interface KnowledgeBasesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
5379
|
+
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
5380
|
+
ifMatch?: string;
|
|
5381
|
+
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
5382
|
+
ifNoneMatch?: string;
|
|
5383
|
+
}
|
|
5384
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
5385
|
+
export type KnowledgeBasesCreateOrUpdateResponse = KnowledgeBase;
|
|
5386
|
+
/** Optional parameters. */
|
|
5387
|
+
export interface KnowledgeBasesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
5388
|
+
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
5389
|
+
ifMatch?: string;
|
|
5390
|
+
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
5391
|
+
ifNoneMatch?: string;
|
|
5392
|
+
}
|
|
5393
|
+
/** Optional parameters. */
|
|
5394
|
+
export interface KnowledgeBasesGetOptionalParams extends coreClient.OperationOptions {
|
|
5395
|
+
}
|
|
5396
|
+
/** Contains response data for the get operation. */
|
|
5397
|
+
export type KnowledgeBasesGetResponse = KnowledgeBase;
|
|
5398
|
+
/** Optional parameters. */
|
|
5399
|
+
export interface KnowledgeBasesListOptionalParams extends coreClient.OperationOptions {
|
|
5400
|
+
}
|
|
5401
|
+
/** Contains response data for the list operation. */
|
|
5402
|
+
export type KnowledgeBasesListResponse = ListKnowledgeBasesResult;
|
|
5403
|
+
/** Optional parameters. */
|
|
5404
|
+
export interface KnowledgeBasesCreateOptionalParams extends coreClient.OperationOptions {
|
|
5405
|
+
}
|
|
5406
|
+
/** Contains response data for the create operation. */
|
|
5407
|
+
export type KnowledgeBasesCreateResponse = KnowledgeBase;
|
|
5408
|
+
/** Optional parameters. */
|
|
5409
|
+
export interface KnowledgeSourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
5410
|
+
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
5411
|
+
ifMatch?: string;
|
|
5412
|
+
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
5413
|
+
ifNoneMatch?: string;
|
|
5414
|
+
}
|
|
5415
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
5416
|
+
export type KnowledgeSourcesCreateOrUpdateResponse = KnowledgeSourceUnion;
|
|
5417
|
+
/** Optional parameters. */
|
|
5418
|
+
export interface KnowledgeSourcesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
5419
|
+
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
5420
|
+
ifMatch?: string;
|
|
5421
|
+
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
5422
|
+
ifNoneMatch?: string;
|
|
5423
|
+
}
|
|
5424
|
+
/** Optional parameters. */
|
|
5425
|
+
export interface KnowledgeSourcesGetOptionalParams extends coreClient.OperationOptions {
|
|
5426
|
+
}
|
|
5427
|
+
/** Contains response data for the get operation. */
|
|
5428
|
+
export type KnowledgeSourcesGetResponse = KnowledgeSourceUnion;
|
|
5429
|
+
/** Optional parameters. */
|
|
5430
|
+
export interface KnowledgeSourcesListOptionalParams extends coreClient.OperationOptions {
|
|
5431
|
+
}
|
|
5432
|
+
/** Contains response data for the list operation. */
|
|
5433
|
+
export type KnowledgeSourcesListResponse = ListKnowledgeSourcesResult;
|
|
5434
|
+
/** Optional parameters. */
|
|
5435
|
+
export interface KnowledgeSourcesCreateOptionalParams extends coreClient.OperationOptions {
|
|
5436
|
+
}
|
|
5437
|
+
/** Contains response data for the create operation. */
|
|
5438
|
+
export type KnowledgeSourcesCreateResponse = KnowledgeSourceUnion;
|
|
5439
|
+
/** Optional parameters. */
|
|
5440
|
+
export interface KnowledgeSourcesGetStatusOptionalParams extends coreClient.OperationOptions {
|
|
5441
|
+
}
|
|
5442
|
+
/** Contains response data for the getStatus operation. */
|
|
5443
|
+
export type KnowledgeSourcesGetStatusResponse = KnowledgeSourceStatus;
|
|
5444
|
+
/** Optional parameters. */
|
|
4231
5445
|
export interface DataSourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
4232
5446
|
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
4233
5447
|
ifMatch?: string;
|
|
4234
5448
|
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
4235
5449
|
ifNoneMatch?: string;
|
|
5450
|
+
/** Ignores cache reset requirements. */
|
|
5451
|
+
skipIndexerResetRequirementForCache?: boolean;
|
|
4236
5452
|
}
|
|
4237
5453
|
/** Contains response data for the createOrUpdate operation. */
|
|
4238
5454
|
export type DataSourcesCreateOrUpdateResponse = SearchIndexerDataSource;
|
|
@@ -4264,6 +5480,15 @@ export type DataSourcesCreateResponse = SearchIndexerDataSource;
|
|
|
4264
5480
|
export interface IndexersResetOptionalParams extends coreClient.OperationOptions {
|
|
4265
5481
|
}
|
|
4266
5482
|
/** Optional parameters. */
|
|
5483
|
+
export interface IndexersResetDocsOptionalParams extends coreClient.OperationOptions {
|
|
5484
|
+
keysOrIds?: DocumentKeysOrIds;
|
|
5485
|
+
/** 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. */
|
|
5486
|
+
overwrite?: boolean;
|
|
5487
|
+
}
|
|
5488
|
+
/** Optional parameters. */
|
|
5489
|
+
export interface IndexersResyncOptionalParams extends coreClient.OperationOptions {
|
|
5490
|
+
}
|
|
5491
|
+
/** Optional parameters. */
|
|
4267
5492
|
export interface IndexersRunOptionalParams extends coreClient.OperationOptions {
|
|
4268
5493
|
}
|
|
4269
5494
|
/** Optional parameters. */
|
|
@@ -4272,6 +5497,10 @@ export interface IndexersCreateOrUpdateOptionalParams extends coreClient.Operati
|
|
|
4272
5497
|
ifMatch?: string;
|
|
4273
5498
|
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
4274
5499
|
ifNoneMatch?: string;
|
|
5500
|
+
/** Ignores cache reset requirements. */
|
|
5501
|
+
skipIndexerResetRequirementForCache?: boolean;
|
|
5502
|
+
/** Disables cache reprocessing change detection. */
|
|
5503
|
+
disableCacheReprocessingChangeDetection?: boolean;
|
|
4275
5504
|
}
|
|
4276
5505
|
/** Contains response data for the createOrUpdate operation. */
|
|
4277
5506
|
export type IndexersCreateOrUpdateResponse = SearchIndexer;
|
|
@@ -4310,6 +5539,10 @@ export interface SkillsetsCreateOrUpdateOptionalParams extends coreClient.Operat
|
|
|
4310
5539
|
ifMatch?: string;
|
|
4311
5540
|
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
4312
5541
|
ifNoneMatch?: string;
|
|
5542
|
+
/** Ignores cache reset requirements. */
|
|
5543
|
+
skipIndexerResetRequirementForCache?: boolean;
|
|
5544
|
+
/** Disables cache reprocessing change detection. */
|
|
5545
|
+
disableCacheReprocessingChangeDetection?: boolean;
|
|
4313
5546
|
}
|
|
4314
5547
|
/** Contains response data for the createOrUpdate operation. */
|
|
4315
5548
|
export type SkillsetsCreateOrUpdateResponse = SearchIndexerSkillset;
|
|
@@ -4338,6 +5571,9 @@ export interface SkillsetsCreateOptionalParams extends coreClient.OperationOptio
|
|
|
4338
5571
|
/** Contains response data for the create operation. */
|
|
4339
5572
|
export type SkillsetsCreateResponse = SearchIndexerSkillset;
|
|
4340
5573
|
/** Optional parameters. */
|
|
5574
|
+
export interface SkillsetsResetSkillsOptionalParams extends coreClient.OperationOptions {
|
|
5575
|
+
}
|
|
5576
|
+
/** Optional parameters. */
|
|
4341
5577
|
export interface SynonymMapsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
4342
5578
|
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
4343
5579
|
ifMatch?: string;
|
|
@@ -4416,11 +5652,47 @@ export interface IndexesAnalyzeOptionalParams extends coreClient.OperationOption
|
|
|
4416
5652
|
/** Contains response data for the analyze operation. */
|
|
4417
5653
|
export type IndexesAnalyzeResponse = AnalyzeResult;
|
|
4418
5654
|
/** Optional parameters. */
|
|
5655
|
+
export interface AliasesCreateOptionalParams extends coreClient.OperationOptions {
|
|
5656
|
+
}
|
|
5657
|
+
/** Contains response data for the create operation. */
|
|
5658
|
+
export type AliasesCreateResponse = SearchAlias;
|
|
5659
|
+
/** Optional parameters. */
|
|
5660
|
+
export interface AliasesListOptionalParams extends coreClient.OperationOptions {
|
|
5661
|
+
}
|
|
5662
|
+
/** Contains response data for the list operation. */
|
|
5663
|
+
export type AliasesListResponse = ListAliasesResult;
|
|
5664
|
+
/** Optional parameters. */
|
|
5665
|
+
export interface AliasesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
5666
|
+
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
5667
|
+
ifMatch?: string;
|
|
5668
|
+
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
5669
|
+
ifNoneMatch?: string;
|
|
5670
|
+
}
|
|
5671
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
5672
|
+
export type AliasesCreateOrUpdateResponse = SearchAlias;
|
|
5673
|
+
/** Optional parameters. */
|
|
5674
|
+
export interface AliasesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
5675
|
+
/** Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. */
|
|
5676
|
+
ifMatch?: string;
|
|
5677
|
+
/** Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. */
|
|
5678
|
+
ifNoneMatch?: string;
|
|
5679
|
+
}
|
|
5680
|
+
/** Optional parameters. */
|
|
5681
|
+
export interface AliasesGetOptionalParams extends coreClient.OperationOptions {
|
|
5682
|
+
}
|
|
5683
|
+
/** Contains response data for the get operation. */
|
|
5684
|
+
export type AliasesGetResponse = SearchAlias;
|
|
5685
|
+
/** Optional parameters. */
|
|
4419
5686
|
export interface GetServiceStatisticsOptionalParams extends coreClient.OperationOptions {
|
|
4420
5687
|
}
|
|
4421
5688
|
/** Contains response data for the getServiceStatistics operation. */
|
|
4422
5689
|
export type GetServiceStatisticsResponse = ServiceStatistics;
|
|
4423
5690
|
/** Optional parameters. */
|
|
5691
|
+
export interface GetIndexStatsSummaryOptionalParams extends coreClient.OperationOptions {
|
|
5692
|
+
}
|
|
5693
|
+
/** Contains response data for the getIndexStatsSummary operation. */
|
|
5694
|
+
export type GetIndexStatsSummaryResponse = ListIndexStatsSummary;
|
|
5695
|
+
/** Optional parameters. */
|
|
4424
5696
|
export interface SearchServiceClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
|
|
4425
5697
|
/** Overrides client endpoint. */
|
|
4426
5698
|
endpoint?: string;
|