@azure/search-documents 13.0.0 → 13.1.0-beta.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/index.d.ts +5 -5
- package/dist/browser/index.d.ts.map +1 -1
- package/dist/browser/index.js +3 -2
- package/dist/browser/index.js.map +1 -1
- package/dist/browser/indexModels.d.ts +35 -1
- package/dist/browser/indexModels.d.ts.map +1 -1
- package/dist/browser/indexModels.js.map +1 -1
- package/dist/browser/knowledgeBaseModels.d.ts +27 -1
- package/dist/browser/knowledgeBaseModels.d.ts.map +1 -1
- package/dist/browser/knowledgeBaseModels.js.map +1 -1
- package/dist/browser/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js +1 -1
- package/dist/browser/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js.map +1 -1
- package/dist/browser/knowledgeBaseRetrieval/api/operations.d.ts.map +1 -1
- package/dist/browser/knowledgeBaseRetrieval/api/operations.js +4 -1
- package/dist/browser/knowledgeBaseRetrieval/api/operations.js.map +1 -1
- package/dist/browser/knowledgeBaseRetrieval/api/options.d.ts +2 -0
- package/dist/browser/knowledgeBaseRetrieval/api/options.d.ts.map +1 -1
- package/dist/browser/knowledgeBaseRetrieval/api/options.js.map +1 -1
- package/dist/browser/models/azure/search/documents/index.d.ts +2 -2
- package/dist/browser/models/azure/search/documents/index.d.ts.map +1 -1
- package/dist/browser/models/azure/search/documents/index.js +1 -1
- package/dist/browser/models/azure/search/documents/index.js.map +1 -1
- package/dist/browser/models/azure/search/documents/indexes/index.d.ts +2 -2
- package/dist/browser/models/azure/search/documents/indexes/index.d.ts.map +1 -1
- package/dist/browser/models/azure/search/documents/indexes/index.js +1 -1
- package/dist/browser/models/azure/search/documents/indexes/index.js.map +1 -1
- package/dist/browser/models/azure/search/documents/indexes/models.d.ts +994 -155
- package/dist/browser/models/azure/search/documents/indexes/models.d.ts.map +1 -1
- package/dist/browser/models/azure/search/documents/indexes/models.js +1267 -159
- package/dist/browser/models/azure/search/documents/indexes/models.js.map +1 -1
- package/dist/browser/models/azure/search/documents/knowledgeBases/index.d.ts +2 -2
- package/dist/browser/models/azure/search/documents/knowledgeBases/index.d.ts.map +1 -1
- package/dist/browser/models/azure/search/documents/knowledgeBases/index.js +1 -1
- package/dist/browser/models/azure/search/documents/knowledgeBases/index.js.map +1 -1
- package/dist/browser/models/azure/search/documents/knowledgeBases/models.d.ts +716 -96
- package/dist/browser/models/azure/search/documents/knowledgeBases/models.d.ts.map +1 -1
- package/dist/browser/models/azure/search/documents/knowledgeBases/models.js +899 -77
- package/dist/browser/models/azure/search/documents/knowledgeBases/models.js.map +1 -1
- package/dist/browser/models/azure/search/documents/models.d.ts +467 -3
- package/dist/browser/models/azure/search/documents/models.d.ts.map +1 -1
- package/dist/browser/models/azure/search/documents/models.js +435 -7
- package/dist/browser/models/azure/search/documents/models.js.map +1 -1
- package/dist/browser/models/index.d.ts +2 -1
- package/dist/browser/models/index.d.ts.map +1 -1
- package/dist/browser/models/index.js +1 -1
- package/dist/browser/models/index.js.map +1 -1
- package/dist/browser/models/models.d.ts +37 -2
- package/dist/browser/models/models.d.ts.map +1 -1
- package/dist/browser/models/models.js +29 -1
- package/dist/browser/models/models.js.map +1 -1
- package/dist/browser/search/api/operations.d.ts.map +1 -1
- package/dist/browser/search/api/operations.js +48 -11
- package/dist/browser/search/api/operations.js.map +1 -1
- package/dist/browser/search/api/options.d.ts +31 -1
- package/dist/browser/search/api/options.d.ts.map +1 -1
- package/dist/browser/search/api/options.js.map +1 -1
- package/dist/browser/search/api/searchContext.js +1 -1
- package/dist/browser/search/api/searchContext.js.map +1 -1
- package/dist/browser/searchClient.d.ts +1 -0
- package/dist/browser/searchClient.d.ts.map +1 -1
- package/dist/browser/searchClient.js +12 -1
- package/dist/browser/searchClient.js.map +1 -1
- package/dist/browser/searchIndex/api/index.d.ts +2 -2
- package/dist/browser/searchIndex/api/index.d.ts.map +1 -1
- package/dist/browser/searchIndex/api/index.js +1 -1
- package/dist/browser/searchIndex/api/index.js.map +1 -1
- package/dist/browser/searchIndex/api/operations.d.ts +18 -2
- package/dist/browser/searchIndex/api/operations.d.ts.map +1 -1
- package/dist/browser/searchIndex/api/operations.js +200 -38
- package/dist/browser/searchIndex/api/operations.js.map +1 -1
- package/dist/browser/searchIndex/api/options.d.ts +46 -0
- package/dist/browser/searchIndex/api/options.d.ts.map +1 -1
- package/dist/browser/searchIndex/api/options.js.map +1 -1
- package/dist/browser/searchIndex/api/searchIndexContext.js +1 -1
- package/dist/browser/searchIndex/api/searchIndexContext.js.map +1 -1
- package/dist/browser/searchIndex/index.d.ts +1 -1
- package/dist/browser/searchIndex/index.d.ts.map +1 -1
- package/dist/browser/searchIndex/index.js.map +1 -1
- package/dist/browser/searchIndex/searchIndexClient.d.ts +10 -2
- package/dist/browser/searchIndex/searchIndexClient.d.ts.map +1 -1
- package/dist/browser/searchIndex/searchIndexClient.js +17 -1
- package/dist/browser/searchIndex/searchIndexClient.js.map +1 -1
- package/dist/browser/searchIndexClient.d.ts +29 -2
- package/dist/browser/searchIndexClient.d.ts.map +1 -1
- package/dist/browser/searchIndexClient.js +38 -0
- package/dist/browser/searchIndexClient.js.map +1 -1
- package/dist/browser/searchIndexer/api/index.d.ts +2 -2
- package/dist/browser/searchIndexer/api/index.d.ts.map +1 -1
- package/dist/browser/searchIndexer/api/index.js +1 -1
- package/dist/browser/searchIndexer/api/index.js.map +1 -1
- package/dist/browser/searchIndexer/api/operations.d.ts +14 -2
- package/dist/browser/searchIndexer/api/operations.d.ts.map +1 -1
- package/dist/browser/searchIndexer/api/operations.js +144 -22
- package/dist/browser/searchIndexer/api/operations.js.map +1 -1
- package/dist/browser/searchIndexer/api/options.d.ts +36 -0
- package/dist/browser/searchIndexer/api/options.d.ts.map +1 -1
- package/dist/browser/searchIndexer/api/options.js.map +1 -1
- package/dist/browser/searchIndexer/api/searchIndexerContext.js +1 -1
- package/dist/browser/searchIndexer/api/searchIndexerContext.js.map +1 -1
- package/dist/browser/searchIndexer/index.d.ts +1 -1
- package/dist/browser/searchIndexer/index.d.ts.map +1 -1
- package/dist/browser/searchIndexer/index.js.map +1 -1
- package/dist/browser/searchIndexer/searchIndexerClient.d.ts +8 -2
- package/dist/browser/searchIndexer/searchIndexerClient.d.ts.map +1 -1
- package/dist/browser/searchIndexer/searchIndexerClient.js +13 -1
- package/dist/browser/searchIndexer/searchIndexerClient.js.map +1 -1
- package/dist/browser/searchIndexerClient.d.ts +21 -1
- package/dist/browser/searchIndexerClient.d.ts.map +1 -1
- package/dist/browser/searchIndexerClient.js +40 -0
- package/dist/browser/searchIndexerClient.js.map +1 -1
- package/dist/browser/searchIndexingBufferedSender.js +1 -1
- package/dist/browser/searchIndexingBufferedSender.js.map +1 -1
- package/dist/browser/serviceModels.d.ts +251 -4
- package/dist/browser/serviceModels.d.ts.map +1 -1
- package/dist/browser/serviceModels.js.map +1 -1
- package/dist/browser/serviceUtils.d.ts +1 -1
- package/dist/browser/serviceUtils.d.ts.map +1 -1
- package/dist/browser/serviceUtils.js +32 -1
- package/dist/browser/serviceUtils.js.map +1 -1
- package/dist/commonjs/index.d.ts +5 -5
- package/dist/commonjs/index.d.ts.map +1 -1
- package/dist/commonjs/index.js +29 -0
- package/dist/commonjs/index.js.map +2 -2
- package/dist/commonjs/indexModels.d.ts +35 -1
- package/dist/commonjs/indexModels.d.ts.map +1 -1
- package/dist/commonjs/indexModels.js.map +1 -1
- package/dist/commonjs/knowledgeBaseModels.d.ts +27 -1
- package/dist/commonjs/knowledgeBaseModels.d.ts.map +1 -1
- package/dist/commonjs/knowledgeBaseModels.js.map +1 -1
- package/dist/commonjs/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js +1 -1
- package/dist/commonjs/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js.map +1 -1
- package/dist/commonjs/knowledgeBaseRetrieval/api/operations.d.ts.map +1 -1
- package/dist/commonjs/knowledgeBaseRetrieval/api/operations.js +2 -1
- package/dist/commonjs/knowledgeBaseRetrieval/api/operations.js.map +2 -2
- package/dist/commonjs/knowledgeBaseRetrieval/api/options.d.ts +2 -0
- package/dist/commonjs/knowledgeBaseRetrieval/api/options.d.ts.map +1 -1
- package/dist/commonjs/knowledgeBaseRetrieval/api/options.js.map +1 -1
- package/dist/commonjs/models/azure/search/documents/index.d.ts +2 -2
- package/dist/commonjs/models/azure/search/documents/index.d.ts.map +1 -1
- package/dist/commonjs/models/azure/search/documents/index.js +16 -2
- package/dist/commonjs/models/azure/search/documents/index.js.map +2 -2
- package/dist/commonjs/models/azure/search/documents/indexes/index.d.ts +2 -2
- package/dist/commonjs/models/azure/search/documents/indexes/index.d.ts.map +1 -1
- package/dist/commonjs/models/azure/search/documents/indexes/index.js +24 -0
- package/dist/commonjs/models/azure/search/documents/indexes/index.js.map +2 -2
- package/dist/commonjs/models/azure/search/documents/indexes/models.d.ts +994 -155
- package/dist/commonjs/models/azure/search/documents/indexes/models.d.ts.map +1 -1
- package/dist/commonjs/models/azure/search/documents/indexes/models.js +1334 -166
- package/dist/commonjs/models/azure/search/documents/indexes/models.js.map +3 -3
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/index.d.ts +2 -2
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/index.d.ts.map +1 -1
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/index.js +2 -0
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/index.js.map +2 -2
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/models.d.ts +716 -96
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/models.d.ts.map +1 -1
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/models.js +995 -90
- package/dist/commonjs/models/azure/search/documents/knowledgeBases/models.js.map +3 -3
- package/dist/commonjs/models/azure/search/documents/models.d.ts +467 -3
- package/dist/commonjs/models/azure/search/documents/models.d.ts.map +1 -1
- package/dist/commonjs/models/azure/search/documents/models.js +360 -13
- package/dist/commonjs/models/azure/search/documents/models.js.map +3 -3
- package/dist/commonjs/models/index.d.ts +2 -1
- package/dist/commonjs/models/index.d.ts.map +1 -1
- package/dist/commonjs/models/index.js +2 -0
- package/dist/commonjs/models/index.js.map +2 -2
- package/dist/commonjs/models/models.d.ts +37 -2
- package/dist/commonjs/models/models.d.ts.map +1 -1
- package/dist/commonjs/models/models.js +32 -3
- package/dist/commonjs/models/models.js.map +3 -3
- package/dist/commonjs/search/api/operations.d.ts.map +1 -1
- package/dist/commonjs/search/api/operations.js +33 -12
- package/dist/commonjs/search/api/operations.js.map +2 -2
- package/dist/commonjs/search/api/options.d.ts +31 -1
- package/dist/commonjs/search/api/options.d.ts.map +1 -1
- package/dist/commonjs/search/api/options.js.map +1 -1
- package/dist/commonjs/search/api/searchContext.js +1 -1
- package/dist/commonjs/search/api/searchContext.js.map +1 -1
- package/dist/commonjs/searchClient.d.ts +1 -0
- package/dist/commonjs/searchClient.d.ts.map +1 -1
- package/dist/commonjs/searchClient.js +12 -0
- package/dist/commonjs/searchClient.js.map +2 -2
- package/dist/commonjs/searchIndex/api/index.d.ts +2 -2
- package/dist/commonjs/searchIndex/api/index.d.ts.map +1 -1
- package/dist/commonjs/searchIndex/api/index.js +10 -2
- package/dist/commonjs/searchIndex/api/index.js.map +2 -2
- package/dist/commonjs/searchIndex/api/operations.d.ts +18 -2
- package/dist/commonjs/searchIndex/api/operations.d.ts.map +1 -1
- package/dist/commonjs/searchIndex/api/operations.js +242 -40
- package/dist/commonjs/searchIndex/api/operations.js.map +2 -2
- package/dist/commonjs/searchIndex/api/options.d.ts +46 -0
- package/dist/commonjs/searchIndex/api/options.d.ts.map +1 -1
- package/dist/commonjs/searchIndex/api/options.js.map +1 -1
- package/dist/commonjs/searchIndex/api/searchIndexContext.js +1 -1
- package/dist/commonjs/searchIndex/api/searchIndexContext.js.map +1 -1
- package/dist/commonjs/searchIndex/index.d.ts +1 -1
- package/dist/commonjs/searchIndex/index.d.ts.map +1 -1
- package/dist/commonjs/searchIndex/index.js.map +1 -1
- package/dist/commonjs/searchIndex/searchIndexClient.d.ts +10 -2
- package/dist/commonjs/searchIndex/searchIndexClient.d.ts.map +1 -1
- package/dist/commonjs/searchIndex/searchIndexClient.js +16 -0
- package/dist/commonjs/searchIndex/searchIndexClient.js.map +2 -2
- package/dist/commonjs/searchIndexClient.d.ts +29 -2
- package/dist/commonjs/searchIndexClient.d.ts.map +1 -1
- package/dist/commonjs/searchIndexClient.js +51 -0
- package/dist/commonjs/searchIndexClient.js.map +2 -2
- package/dist/commonjs/searchIndexer/api/index.d.ts +2 -2
- package/dist/commonjs/searchIndexer/api/index.d.ts.map +1 -1
- package/dist/commonjs/searchIndexer/api/index.js +6 -0
- package/dist/commonjs/searchIndexer/api/index.js.map +2 -2
- package/dist/commonjs/searchIndexer/api/operations.d.ts +14 -2
- package/dist/commonjs/searchIndexer/api/operations.d.ts.map +1 -1
- package/dist/commonjs/searchIndexer/api/operations.js +156 -21
- package/dist/commonjs/searchIndexer/api/operations.js.map +2 -2
- package/dist/commonjs/searchIndexer/api/options.d.ts +36 -0
- package/dist/commonjs/searchIndexer/api/options.d.ts.map +1 -1
- package/dist/commonjs/searchIndexer/api/options.js.map +1 -1
- package/dist/commonjs/searchIndexer/api/searchIndexerContext.js +1 -1
- package/dist/commonjs/searchIndexer/api/searchIndexerContext.js.map +1 -1
- package/dist/commonjs/searchIndexer/index.d.ts +1 -1
- package/dist/commonjs/searchIndexer/index.d.ts.map +1 -1
- package/dist/commonjs/searchIndexer/index.js.map +1 -1
- package/dist/commonjs/searchIndexer/searchIndexerClient.d.ts +8 -2
- package/dist/commonjs/searchIndexer/searchIndexerClient.d.ts.map +1 -1
- package/dist/commonjs/searchIndexer/searchIndexerClient.js +12 -0
- package/dist/commonjs/searchIndexer/searchIndexerClient.js.map +2 -2
- package/dist/commonjs/searchIndexerClient.d.ts +21 -1
- package/dist/commonjs/searchIndexerClient.d.ts.map +1 -1
- package/dist/commonjs/searchIndexerClient.js +50 -0
- package/dist/commonjs/searchIndexerClient.js.map +2 -2
- package/dist/commonjs/searchIndexingBufferedSender.js +2 -12
- package/dist/commonjs/searchIndexingBufferedSender.js.map +3 -3
- package/dist/commonjs/serviceModels.d.ts +251 -4
- package/dist/commonjs/serviceModels.d.ts.map +1 -1
- package/dist/commonjs/serviceModels.js.map +2 -2
- package/dist/commonjs/serviceUtils.d.ts +1 -1
- package/dist/commonjs/serviceUtils.d.ts.map +1 -1
- package/dist/commonjs/serviceUtils.js +34 -3
- package/dist/commonjs/serviceUtils.js.map +2 -2
- package/dist/esm/index.d.ts +5 -5
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +3 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/indexModels.d.ts +35 -1
- package/dist/esm/indexModels.d.ts.map +1 -1
- package/dist/esm/indexModels.js.map +1 -1
- package/dist/esm/knowledgeBaseModels.d.ts +27 -1
- package/dist/esm/knowledgeBaseModels.d.ts.map +1 -1
- package/dist/esm/knowledgeBaseModels.js.map +1 -1
- package/dist/esm/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js +1 -1
- package/dist/esm/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js.map +1 -1
- package/dist/esm/knowledgeBaseRetrieval/api/operations.d.ts.map +1 -1
- package/dist/esm/knowledgeBaseRetrieval/api/operations.js +4 -1
- package/dist/esm/knowledgeBaseRetrieval/api/operations.js.map +1 -1
- package/dist/esm/knowledgeBaseRetrieval/api/options.d.ts +2 -0
- package/dist/esm/knowledgeBaseRetrieval/api/options.d.ts.map +1 -1
- package/dist/esm/knowledgeBaseRetrieval/api/options.js.map +1 -1
- package/dist/esm/models/azure/search/documents/index.d.ts +2 -2
- package/dist/esm/models/azure/search/documents/index.d.ts.map +1 -1
- package/dist/esm/models/azure/search/documents/index.js +1 -1
- package/dist/esm/models/azure/search/documents/index.js.map +1 -1
- package/dist/esm/models/azure/search/documents/indexes/index.d.ts +2 -2
- package/dist/esm/models/azure/search/documents/indexes/index.d.ts.map +1 -1
- package/dist/esm/models/azure/search/documents/indexes/index.js +1 -1
- package/dist/esm/models/azure/search/documents/indexes/index.js.map +1 -1
- package/dist/esm/models/azure/search/documents/indexes/models.d.ts +994 -155
- package/dist/esm/models/azure/search/documents/indexes/models.d.ts.map +1 -1
- package/dist/esm/models/azure/search/documents/indexes/models.js +1267 -159
- package/dist/esm/models/azure/search/documents/indexes/models.js.map +1 -1
- package/dist/esm/models/azure/search/documents/knowledgeBases/index.d.ts +2 -2
- package/dist/esm/models/azure/search/documents/knowledgeBases/index.d.ts.map +1 -1
- package/dist/esm/models/azure/search/documents/knowledgeBases/index.js +1 -1
- package/dist/esm/models/azure/search/documents/knowledgeBases/index.js.map +1 -1
- package/dist/esm/models/azure/search/documents/knowledgeBases/models.d.ts +716 -96
- package/dist/esm/models/azure/search/documents/knowledgeBases/models.d.ts.map +1 -1
- package/dist/esm/models/azure/search/documents/knowledgeBases/models.js +899 -77
- package/dist/esm/models/azure/search/documents/knowledgeBases/models.js.map +1 -1
- package/dist/esm/models/azure/search/documents/models.d.ts +467 -3
- package/dist/esm/models/azure/search/documents/models.d.ts.map +1 -1
- package/dist/esm/models/azure/search/documents/models.js +435 -7
- package/dist/esm/models/azure/search/documents/models.js.map +1 -1
- package/dist/esm/models/index.d.ts +2 -1
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +1 -1
- package/dist/esm/models/index.js.map +1 -1
- package/dist/esm/models/models.d.ts +37 -2
- package/dist/esm/models/models.d.ts.map +1 -1
- package/dist/esm/models/models.js +29 -1
- package/dist/esm/models/models.js.map +1 -1
- package/dist/esm/search/api/operations.d.ts.map +1 -1
- package/dist/esm/search/api/operations.js +48 -11
- package/dist/esm/search/api/operations.js.map +1 -1
- package/dist/esm/search/api/options.d.ts +31 -1
- package/dist/esm/search/api/options.d.ts.map +1 -1
- package/dist/esm/search/api/options.js.map +1 -1
- package/dist/esm/search/api/searchContext.js +1 -1
- package/dist/esm/search/api/searchContext.js.map +1 -1
- package/dist/esm/searchClient.d.ts +1 -0
- package/dist/esm/searchClient.d.ts.map +1 -1
- package/dist/esm/searchClient.js +12 -1
- package/dist/esm/searchClient.js.map +1 -1
- package/dist/esm/searchIndex/api/index.d.ts +2 -2
- package/dist/esm/searchIndex/api/index.d.ts.map +1 -1
- package/dist/esm/searchIndex/api/index.js +1 -1
- package/dist/esm/searchIndex/api/index.js.map +1 -1
- package/dist/esm/searchIndex/api/operations.d.ts +18 -2
- package/dist/esm/searchIndex/api/operations.d.ts.map +1 -1
- package/dist/esm/searchIndex/api/operations.js +200 -38
- package/dist/esm/searchIndex/api/operations.js.map +1 -1
- package/dist/esm/searchIndex/api/options.d.ts +46 -0
- package/dist/esm/searchIndex/api/options.d.ts.map +1 -1
- package/dist/esm/searchIndex/api/options.js.map +1 -1
- package/dist/esm/searchIndex/api/searchIndexContext.js +1 -1
- package/dist/esm/searchIndex/api/searchIndexContext.js.map +1 -1
- package/dist/esm/searchIndex/index.d.ts +1 -1
- package/dist/esm/searchIndex/index.d.ts.map +1 -1
- package/dist/esm/searchIndex/index.js.map +1 -1
- package/dist/esm/searchIndex/searchIndexClient.d.ts +10 -2
- package/dist/esm/searchIndex/searchIndexClient.d.ts.map +1 -1
- package/dist/esm/searchIndex/searchIndexClient.js +17 -1
- package/dist/esm/searchIndex/searchIndexClient.js.map +1 -1
- package/dist/esm/searchIndexClient.d.ts +29 -2
- package/dist/esm/searchIndexClient.d.ts.map +1 -1
- package/dist/esm/searchIndexClient.js +38 -0
- package/dist/esm/searchIndexClient.js.map +1 -1
- package/dist/esm/searchIndexer/api/index.d.ts +2 -2
- package/dist/esm/searchIndexer/api/index.d.ts.map +1 -1
- package/dist/esm/searchIndexer/api/index.js +1 -1
- package/dist/esm/searchIndexer/api/index.js.map +1 -1
- package/dist/esm/searchIndexer/api/operations.d.ts +14 -2
- package/dist/esm/searchIndexer/api/operations.d.ts.map +1 -1
- package/dist/esm/searchIndexer/api/operations.js +144 -22
- package/dist/esm/searchIndexer/api/operations.js.map +1 -1
- package/dist/esm/searchIndexer/api/options.d.ts +36 -0
- package/dist/esm/searchIndexer/api/options.d.ts.map +1 -1
- package/dist/esm/searchIndexer/api/options.js.map +1 -1
- package/dist/esm/searchIndexer/api/searchIndexerContext.js +1 -1
- package/dist/esm/searchIndexer/api/searchIndexerContext.js.map +1 -1
- package/dist/esm/searchIndexer/index.d.ts +1 -1
- package/dist/esm/searchIndexer/index.d.ts.map +1 -1
- package/dist/esm/searchIndexer/index.js.map +1 -1
- package/dist/esm/searchIndexer/searchIndexerClient.d.ts +8 -2
- package/dist/esm/searchIndexer/searchIndexerClient.d.ts.map +1 -1
- package/dist/esm/searchIndexer/searchIndexerClient.js +13 -1
- package/dist/esm/searchIndexer/searchIndexerClient.js.map +1 -1
- package/dist/esm/searchIndexerClient.d.ts +21 -1
- package/dist/esm/searchIndexerClient.d.ts.map +1 -1
- package/dist/esm/searchIndexerClient.js +40 -0
- package/dist/esm/searchIndexerClient.js.map +1 -1
- package/dist/esm/searchIndexingBufferedSender.js +1 -1
- package/dist/esm/searchIndexingBufferedSender.js.map +1 -1
- package/dist/esm/serviceModels.d.ts +251 -4
- package/dist/esm/serviceModels.d.ts.map +1 -1
- package/dist/esm/serviceModels.js.map +1 -1
- package/dist/esm/serviceUtils.d.ts +1 -1
- package/dist/esm/serviceUtils.d.ts.map +1 -1
- package/dist/esm/serviceUtils.js +32 -1
- package/dist/esm/serviceUtils.js.map +1 -1
- package/dist/react-native/index.d.ts +5 -5
- package/dist/react-native/index.d.ts.map +1 -1
- package/dist/react-native/index.js +3 -2
- package/dist/react-native/index.js.map +1 -1
- package/dist/react-native/indexModels.d.ts +35 -1
- 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 +27 -1
- package/dist/react-native/knowledgeBaseModels.d.ts.map +1 -1
- package/dist/react-native/knowledgeBaseModels.js.map +1 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js +1 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/knowledgeBaseRetrievalContext.js.map +1 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/operations.d.ts.map +1 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/operations.js +4 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/operations.js.map +1 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/options.d.ts +2 -0
- package/dist/react-native/knowledgeBaseRetrieval/api/options.d.ts.map +1 -1
- package/dist/react-native/knowledgeBaseRetrieval/api/options.js.map +1 -1
- package/dist/react-native/models/azure/search/documents/index.d.ts +2 -2
- package/dist/react-native/models/azure/search/documents/index.d.ts.map +1 -1
- package/dist/react-native/models/azure/search/documents/index.js +1 -1
- package/dist/react-native/models/azure/search/documents/index.js.map +1 -1
- package/dist/react-native/models/azure/search/documents/indexes/index.d.ts +2 -2
- package/dist/react-native/models/azure/search/documents/indexes/index.d.ts.map +1 -1
- package/dist/react-native/models/azure/search/documents/indexes/index.js +1 -1
- package/dist/react-native/models/azure/search/documents/indexes/index.js.map +1 -1
- package/dist/react-native/models/azure/search/documents/indexes/models.d.ts +994 -155
- package/dist/react-native/models/azure/search/documents/indexes/models.d.ts.map +1 -1
- package/dist/react-native/models/azure/search/documents/indexes/models.js +1267 -159
- package/dist/react-native/models/azure/search/documents/indexes/models.js.map +1 -1
- package/dist/react-native/models/azure/search/documents/knowledgeBases/index.d.ts +2 -2
- package/dist/react-native/models/azure/search/documents/knowledgeBases/index.d.ts.map +1 -1
- package/dist/react-native/models/azure/search/documents/knowledgeBases/index.js +1 -1
- package/dist/react-native/models/azure/search/documents/knowledgeBases/index.js.map +1 -1
- package/dist/react-native/models/azure/search/documents/knowledgeBases/models.d.ts +716 -96
- package/dist/react-native/models/azure/search/documents/knowledgeBases/models.d.ts.map +1 -1
- package/dist/react-native/models/azure/search/documents/knowledgeBases/models.js +899 -77
- package/dist/react-native/models/azure/search/documents/knowledgeBases/models.js.map +1 -1
- package/dist/react-native/models/azure/search/documents/models.d.ts +467 -3
- package/dist/react-native/models/azure/search/documents/models.d.ts.map +1 -1
- package/dist/react-native/models/azure/search/documents/models.js +435 -7
- package/dist/react-native/models/azure/search/documents/models.js.map +1 -1
- package/dist/react-native/models/index.d.ts +2 -1
- package/dist/react-native/models/index.d.ts.map +1 -1
- package/dist/react-native/models/index.js +1 -1
- package/dist/react-native/models/index.js.map +1 -1
- package/dist/react-native/models/models.d.ts +37 -2
- package/dist/react-native/models/models.d.ts.map +1 -1
- package/dist/react-native/models/models.js +29 -1
- package/dist/react-native/models/models.js.map +1 -1
- package/dist/react-native/search/api/operations.d.ts.map +1 -1
- package/dist/react-native/search/api/operations.js +48 -11
- package/dist/react-native/search/api/operations.js.map +1 -1
- package/dist/react-native/search/api/options.d.ts +31 -1
- package/dist/react-native/search/api/options.d.ts.map +1 -1
- package/dist/react-native/search/api/options.js.map +1 -1
- package/dist/react-native/search/api/searchContext.js +1 -1
- package/dist/react-native/search/api/searchContext.js.map +1 -1
- package/dist/react-native/searchClient.d.ts +1 -0
- package/dist/react-native/searchClient.d.ts.map +1 -1
- package/dist/react-native/searchClient.js +12 -1
- package/dist/react-native/searchClient.js.map +1 -1
- package/dist/react-native/searchIndex/api/index.d.ts +2 -2
- package/dist/react-native/searchIndex/api/index.d.ts.map +1 -1
- package/dist/react-native/searchIndex/api/index.js +1 -1
- package/dist/react-native/searchIndex/api/index.js.map +1 -1
- package/dist/react-native/searchIndex/api/operations.d.ts +18 -2
- package/dist/react-native/searchIndex/api/operations.d.ts.map +1 -1
- package/dist/react-native/searchIndex/api/operations.js +200 -38
- package/dist/react-native/searchIndex/api/operations.js.map +1 -1
- package/dist/react-native/searchIndex/api/options.d.ts +46 -0
- package/dist/react-native/searchIndex/api/options.d.ts.map +1 -1
- package/dist/react-native/searchIndex/api/options.js.map +1 -1
- package/dist/react-native/searchIndex/api/searchIndexContext.js +1 -1
- package/dist/react-native/searchIndex/api/searchIndexContext.js.map +1 -1
- package/dist/react-native/searchIndex/index.d.ts +1 -1
- package/dist/react-native/searchIndex/index.d.ts.map +1 -1
- package/dist/react-native/searchIndex/index.js.map +1 -1
- package/dist/react-native/searchIndex/searchIndexClient.d.ts +10 -2
- package/dist/react-native/searchIndex/searchIndexClient.d.ts.map +1 -1
- package/dist/react-native/searchIndex/searchIndexClient.js +17 -1
- package/dist/react-native/searchIndex/searchIndexClient.js.map +1 -1
- package/dist/react-native/searchIndexClient.d.ts +29 -2
- package/dist/react-native/searchIndexClient.d.ts.map +1 -1
- package/dist/react-native/searchIndexClient.js +38 -0
- package/dist/react-native/searchIndexClient.js.map +1 -1
- package/dist/react-native/searchIndexer/api/index.d.ts +2 -2
- package/dist/react-native/searchIndexer/api/index.d.ts.map +1 -1
- package/dist/react-native/searchIndexer/api/index.js +1 -1
- package/dist/react-native/searchIndexer/api/index.js.map +1 -1
- package/dist/react-native/searchIndexer/api/operations.d.ts +14 -2
- package/dist/react-native/searchIndexer/api/operations.d.ts.map +1 -1
- package/dist/react-native/searchIndexer/api/operations.js +144 -22
- package/dist/react-native/searchIndexer/api/operations.js.map +1 -1
- package/dist/react-native/searchIndexer/api/options.d.ts +36 -0
- package/dist/react-native/searchIndexer/api/options.d.ts.map +1 -1
- package/dist/react-native/searchIndexer/api/options.js.map +1 -1
- package/dist/react-native/searchIndexer/api/searchIndexerContext.js +1 -1
- package/dist/react-native/searchIndexer/api/searchIndexerContext.js.map +1 -1
- package/dist/react-native/searchIndexer/index.d.ts +1 -1
- package/dist/react-native/searchIndexer/index.d.ts.map +1 -1
- package/dist/react-native/searchIndexer/index.js.map +1 -1
- package/dist/react-native/searchIndexer/searchIndexerClient.d.ts +8 -2
- package/dist/react-native/searchIndexer/searchIndexerClient.d.ts.map +1 -1
- package/dist/react-native/searchIndexer/searchIndexerClient.js +13 -1
- package/dist/react-native/searchIndexer/searchIndexerClient.js.map +1 -1
- package/dist/react-native/searchIndexerClient.d.ts +21 -1
- package/dist/react-native/searchIndexerClient.d.ts.map +1 -1
- package/dist/react-native/searchIndexerClient.js +40 -0
- package/dist/react-native/searchIndexerClient.js.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 +251 -4
- package/dist/react-native/serviceModels.d.ts.map +1 -1
- package/dist/react-native/serviceModels.js.map +1 -1
- package/dist/react-native/serviceUtils.d.ts +1 -1
- package/dist/react-native/serviceUtils.d.ts.map +1 -1
- package/dist/react-native/serviceUtils.js +32 -1
- package/dist/react-native/serviceUtils.js.map +1 -1
- package/package.json +11 -6
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type { KnowledgeSourceIngestionParameters } from "../knowledgeBases/models.js";
|
|
1
|
+
import type { KnowledgeSourceIngestionParameters, KnowledgeRetrievalReasoningEffortUnion, KnowledgeRetrievalOutputMode } from "../knowledgeBases/models.js";
|
|
2
|
+
import type { SharePointConnectorAppRegistration, ContentUnderstandingSkillChunkingMethod } from "../../../../models.js";
|
|
2
3
|
/**
|
|
3
4
|
* This file contains only generated model types and their (de)serializers.
|
|
4
5
|
* Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
|
|
@@ -28,6 +29,8 @@ export interface SearchResourceEncryptionKey {
|
|
|
28
29
|
vaultUri: string;
|
|
29
30
|
/** 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. */
|
|
30
31
|
identity?: SearchIndexerDataIdentityUnion;
|
|
32
|
+
/** An optional value indicating whether this key is a service-level key. Default is false. */
|
|
33
|
+
isServiceLevelKey?: boolean;
|
|
31
34
|
/** An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. */
|
|
32
35
|
applicationId?: string;
|
|
33
36
|
/** The authentication key of the specified AAD application. */
|
|
@@ -69,6 +72,8 @@ export interface SearchIndexerDataUserAssignedIdentity extends SearchIndexerData
|
|
|
69
72
|
resourceId: string;
|
|
70
73
|
/** A URI fragment specifying the type of identity. */
|
|
71
74
|
odatatype: "#Microsoft.Azure.Search.DataUserAssignedIdentity";
|
|
75
|
+
/** Multi-tenant User-Assigned Managed Identity Support: The client id of the multi-tentant App that has been configured to federate with the user-assigned managed identity. */
|
|
76
|
+
federatedIdentityClientId?: string;
|
|
72
77
|
}
|
|
73
78
|
export declare function searchIndexerDataUserAssignedIdentitySerializer(item: SearchIndexerDataUserAssignedIdentity): any;
|
|
74
79
|
export declare function searchIndexerDataUserAssignedIdentityDeserializer(item: any): SearchIndexerDataUserAssignedIdentity;
|
|
@@ -114,6 +119,12 @@ export interface SearchIndex {
|
|
|
114
119
|
semanticSearch?: SemanticSearch;
|
|
115
120
|
/** Contains configuration options related to vector search. */
|
|
116
121
|
vectorSearch?: VectorSearch;
|
|
122
|
+
/** A value indicating whether permission filtering is enabled for the index. */
|
|
123
|
+
permissionFilterOption?: SearchIndexPermissionFilterOption;
|
|
124
|
+
/** A value indicating whether Purview is enabled for the index. */
|
|
125
|
+
purviewEnabled?: boolean;
|
|
126
|
+
/** Configures a SharePoint connector app registration for the index, enabling document-level permissions from SharePoint. If provided, the applicationId and federatedCredentialId properties are required. */
|
|
127
|
+
sharePointConnectorAppRegistration?: SharePointConnectorAppRegistration;
|
|
117
128
|
/** The ETag of the index. */
|
|
118
129
|
eTag?: string;
|
|
119
130
|
}
|
|
@@ -141,6 +152,16 @@ export interface SearchField {
|
|
|
141
152
|
sortable?: boolean;
|
|
142
153
|
/** 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. */
|
|
143
154
|
facetable?: boolean;
|
|
155
|
+
/** A value indicating whether the field should be used as a permission filter. */
|
|
156
|
+
permissionFilter?: PermissionFilter;
|
|
157
|
+
/** A value indicating whether the field should be used for sensitivity label ID filtering. This enables document-level filtering based on Microsoft Purview sensitivity label IDs. */
|
|
158
|
+
sensitivityLabelId?: boolean;
|
|
159
|
+
/** A value indicating whether the field contains the name of a Microsoft Purview sensitivity label applied to the document. */
|
|
160
|
+
sensitivityLabelName?: boolean;
|
|
161
|
+
/** A value indicating whether the field contains the source document identifier used for Purview audit tracking. */
|
|
162
|
+
sourceDocumentId?: boolean;
|
|
163
|
+
/** A value indicating whether the field contains a SharePoint site URL used for SharePoint group-based filtering. */
|
|
164
|
+
sharepointSiteUrl?: boolean;
|
|
144
165
|
/** 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. */
|
|
145
166
|
analyzerName?: LexicalAnalyzerName;
|
|
146
167
|
/** 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. */
|
|
@@ -211,6 +232,25 @@ export declare enum KnownSearchFieldDataType {
|
|
|
211
232
|
* **Edm.Byte**: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte).
|
|
212
233
|
*/
|
|
213
234
|
export type SearchFieldDataType = string;
|
|
235
|
+
/** A value indicating whether the field should be used as a permission filter. */
|
|
236
|
+
export declare enum KnownPermissionFilter {
|
|
237
|
+
/** Field represents user IDs that should be used to filter document access on queries. */
|
|
238
|
+
UserIds = "userIds",
|
|
239
|
+
/** Field represents group IDs that should be used to filter document access on queries. */
|
|
240
|
+
GroupIds = "groupIds",
|
|
241
|
+
/** Field represents an RBAC scope that should be used to filter document access on queries. */
|
|
242
|
+
RbacScope = "rbacScope"
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* A value indicating whether the field should be used as a permission filter. \
|
|
246
|
+
* {@link KnownPermissionFilter} can be used interchangeably with PermissionFilter,
|
|
247
|
+
* this enum contains the known values that the service supports.
|
|
248
|
+
* ### Known values supported by the service
|
|
249
|
+
* **userIds**: Field represents user IDs that should be used to filter document access on queries. \
|
|
250
|
+
* **groupIds**: Field represents group IDs that should be used to filter document access on queries. \
|
|
251
|
+
* **rbacScope**: Field represents an RBAC scope that should be used to filter document access on queries.
|
|
252
|
+
*/
|
|
253
|
+
export type PermissionFilter = string;
|
|
214
254
|
/** Defines the names of all text analyzers supported by the search engine. */
|
|
215
255
|
export declare enum KnownLexicalAnalyzerName {
|
|
216
256
|
/** Microsoft analyzer for Arabic. */
|
|
@@ -1549,6 +1589,8 @@ export interface SemanticConfiguration {
|
|
|
1549
1589
|
prioritizedFields: SemanticPrioritizedFields;
|
|
1550
1590
|
/** Specifies the score type to be used for the sort order of the search results. */
|
|
1551
1591
|
rankingOrder?: RankingOrder;
|
|
1592
|
+
/** Determines which semantic or query rewrite models to use during model flighting/upgrades. */
|
|
1593
|
+
flightingOptIn?: boolean;
|
|
1552
1594
|
}
|
|
1553
1595
|
export declare function semanticConfigurationSerializer(item: SemanticConfiguration): any;
|
|
1554
1596
|
export declare function semanticConfigurationDeserializer(item: any): SemanticConfiguration;
|
|
@@ -1715,13 +1757,13 @@ export interface VectorSearchVectorizer {
|
|
|
1715
1757
|
/** The name to associate with this particular vectorization method. */
|
|
1716
1758
|
vectorizerName: string;
|
|
1717
1759
|
/** Type of VectorSearchVectorizer. */
|
|
1718
|
-
/** The discriminator possible values: azureOpenAI, customWebApi, aml */
|
|
1760
|
+
/** The discriminator possible values: azureOpenAI, customWebApi, aiServicesVision, aml */
|
|
1719
1761
|
kind: VectorSearchVectorizerKind;
|
|
1720
1762
|
}
|
|
1721
1763
|
export declare function vectorSearchVectorizerSerializer(item: VectorSearchVectorizer): any;
|
|
1722
1764
|
export declare function vectorSearchVectorizerDeserializer(item: any): VectorSearchVectorizer;
|
|
1723
1765
|
/** Alias for VectorSearchVectorizerUnion */
|
|
1724
|
-
export type VectorSearchVectorizerUnion = AzureOpenAIVectorizer | WebApiVectorizer | AzureMachineLearningVectorizer | VectorSearchVectorizer;
|
|
1766
|
+
export type VectorSearchVectorizerUnion = AzureOpenAIVectorizer | WebApiVectorizer | AIServicesVisionVectorizer | AzureMachineLearningVectorizer | VectorSearchVectorizer;
|
|
1725
1767
|
export declare function vectorSearchVectorizerUnionSerializer(item: VectorSearchVectorizerUnion): any;
|
|
1726
1768
|
export declare function vectorSearchVectorizerUnionDeserializer(item: any): VectorSearchVectorizerUnion;
|
|
1727
1769
|
/** The vectorization method to be used during query time. */
|
|
@@ -1778,10 +1820,28 @@ export declare enum KnownAzureOpenAIModelName {
|
|
|
1778
1820
|
TextEmbedding3Large = "text-embedding-3-large",
|
|
1779
1821
|
/** TextEmbedding3Small model. */
|
|
1780
1822
|
TextEmbedding3Small = "text-embedding-3-small",
|
|
1823
|
+
/** Gpt4o model. */
|
|
1824
|
+
Gpt4O = "gpt-4o",
|
|
1825
|
+
/** Gpt4oMini model. */
|
|
1826
|
+
Gpt4OMini = "gpt-4o-mini",
|
|
1827
|
+
/** Gpt41 model. */
|
|
1828
|
+
Gpt41 = "gpt-4.1",
|
|
1829
|
+
/** Gpt41Mini model. */
|
|
1830
|
+
Gpt41Mini = "gpt-4.1-mini",
|
|
1831
|
+
/** Gpt41Nano model. */
|
|
1832
|
+
Gpt41Nano = "gpt-4.1-nano",
|
|
1833
|
+
/** Gpt5 model. */
|
|
1834
|
+
Gpt5 = "gpt-5",
|
|
1781
1835
|
/** Gpt5Mini model. */
|
|
1782
1836
|
Gpt5Mini = "gpt-5-mini",
|
|
1783
1837
|
/** Gpt5Nano model. */
|
|
1784
1838
|
Gpt5Nano = "gpt-5-nano",
|
|
1839
|
+
/** Gpt51 model. */
|
|
1840
|
+
Gpt51 = "gpt-5.1",
|
|
1841
|
+
/** Gpt52 model. */
|
|
1842
|
+
Gpt52 = "gpt-5.2",
|
|
1843
|
+
/** Gpt54 model. */
|
|
1844
|
+
Gpt54 = "gpt-5.4",
|
|
1785
1845
|
/** Gpt54Mini model. */
|
|
1786
1846
|
Gpt54Mini = "gpt-5.4-mini",
|
|
1787
1847
|
/** Gpt54Nano model. */
|
|
@@ -1795,8 +1855,17 @@ export declare enum KnownAzureOpenAIModelName {
|
|
|
1795
1855
|
* **text-embedding-ada-002**: TextEmbeddingAda002 model. \
|
|
1796
1856
|
* **text-embedding-3-large**: TextEmbedding3Large model. \
|
|
1797
1857
|
* **text-embedding-3-small**: TextEmbedding3Small model. \
|
|
1858
|
+
* **gpt-4o**: Gpt4o model. \
|
|
1859
|
+
* **gpt-4o-mini**: Gpt4oMini model. \
|
|
1860
|
+
* **gpt-4.1**: Gpt41 model. \
|
|
1861
|
+
* **gpt-4.1-mini**: Gpt41Mini model. \
|
|
1862
|
+
* **gpt-4.1-nano**: Gpt41Nano model. \
|
|
1863
|
+
* **gpt-5**: Gpt5 model. \
|
|
1798
1864
|
* **gpt-5-mini**: Gpt5Mini model. \
|
|
1799
1865
|
* **gpt-5-nano**: Gpt5Nano model. \
|
|
1866
|
+
* **gpt-5.1**: Gpt51 model. \
|
|
1867
|
+
* **gpt-5.2**: Gpt52 model. \
|
|
1868
|
+
* **gpt-5.4**: Gpt54 model. \
|
|
1800
1869
|
* **gpt-5.4-mini**: Gpt54Mini model. \
|
|
1801
1870
|
* **gpt-5.4-nano**: Gpt54Nano model.
|
|
1802
1871
|
*/
|
|
@@ -1827,6 +1896,28 @@ export interface WebApiVectorizerParameters {
|
|
|
1827
1896
|
}
|
|
1828
1897
|
export declare function webApiVectorizerParametersSerializer(item: WebApiVectorizerParameters): any;
|
|
1829
1898
|
export declare function webApiVectorizerParametersDeserializer(item: any): WebApiVectorizerParameters;
|
|
1899
|
+
/** Clears the identity property of a datasource. */
|
|
1900
|
+
export interface AIServicesVisionVectorizer extends VectorSearchVectorizer {
|
|
1901
|
+
/** Contains the parameters specific to AI Services Vision embedding vectorization. */
|
|
1902
|
+
aiServicesVisionParameters?: AIServicesVisionParameters;
|
|
1903
|
+
/** The name of the kind of vectorization method being configured for use with vector search. */
|
|
1904
|
+
kind: "aiServicesVision";
|
|
1905
|
+
}
|
|
1906
|
+
export declare function aiServicesVisionVectorizerSerializer(item: AIServicesVisionVectorizer): any;
|
|
1907
|
+
export declare function aiServicesVisionVectorizerDeserializer(item: any): AIServicesVisionVectorizer;
|
|
1908
|
+
/** Specifies the AI Services Vision parameters for vectorizing a query image or text. */
|
|
1909
|
+
export interface AIServicesVisionParameters {
|
|
1910
|
+
/** The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified. */
|
|
1911
|
+
modelVersion: string | null;
|
|
1912
|
+
/** The resource URI of the AI Services resource. */
|
|
1913
|
+
resourceUri: string;
|
|
1914
|
+
/** API key of the designated AI Services resource. */
|
|
1915
|
+
apiKey?: string;
|
|
1916
|
+
/** 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. */
|
|
1917
|
+
authIdentity?: SearchIndexerDataIdentityUnion;
|
|
1918
|
+
}
|
|
1919
|
+
export declare function aiServicesVisionParametersSerializer(item: AIServicesVisionParameters): any;
|
|
1920
|
+
export declare function aiServicesVisionParametersDeserializer(item: any): AIServicesVisionParameters;
|
|
1830
1921
|
/** Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog for generating the vector embedding of a query string. */
|
|
1831
1922
|
export interface AzureMachineLearningVectorizer extends VectorSearchVectorizer {
|
|
1832
1923
|
/** Specifies the properties of the AML vectorizer. */
|
|
@@ -1983,10 +2074,30 @@ export interface BinaryQuantizationCompression extends VectorSearchCompression {
|
|
|
1983
2074
|
}
|
|
1984
2075
|
export declare function binaryQuantizationCompressionSerializer(item: BinaryQuantizationCompression): any;
|
|
1985
2076
|
export declare function binaryQuantizationCompressionDeserializer(item: any): BinaryQuantizationCompression;
|
|
2077
|
+
/** A value indicating whether permission filtering is enabled for the index. */
|
|
2078
|
+
export declare enum KnownSearchIndexPermissionFilterOption {
|
|
2079
|
+
/** Permission filtering is enabled for the index. */
|
|
2080
|
+
Enabled = "enabled",
|
|
2081
|
+
/** Permission filtering is disabled for the index. */
|
|
2082
|
+
Disabled = "disabled"
|
|
2083
|
+
}
|
|
2084
|
+
/**
|
|
2085
|
+
* A value indicating whether permission filtering is enabled for the index. \
|
|
2086
|
+
* {@link KnownSearchIndexPermissionFilterOption} can be used interchangeably with SearchIndexPermissionFilterOption,
|
|
2087
|
+
* this enum contains the known values that the service supports.
|
|
2088
|
+
* ### Known values supported by the service
|
|
2089
|
+
* **enabled**: Permission filtering is enabled for the index. \
|
|
2090
|
+
* **disabled**: Permission filtering is disabled for the index.
|
|
2091
|
+
*/
|
|
2092
|
+
export type SearchIndexPermissionFilterOption = string;
|
|
1986
2093
|
/** Response from a List Indexes request. If successful, it includes the full definitions of all indexes. */
|
|
1987
2094
|
export interface _ListIndexesResult {
|
|
2095
|
+
/** The total count of indexes in the service, or null if the count was not requested. */
|
|
2096
|
+
readonly count?: number;
|
|
1988
2097
|
/** The indexes in the Search service. */
|
|
1989
2098
|
readonly indexes: SearchIndex[];
|
|
2099
|
+
/** The URL that can be used to fetch the next set of results. */
|
|
2100
|
+
readonly nextLink?: string;
|
|
1990
2101
|
}
|
|
1991
2102
|
export declare function _listIndexesResultDeserializer(item: any): _ListIndexesResult;
|
|
1992
2103
|
export declare function searchIndexArraySerializer(result: Array<SearchIndex>): any[];
|
|
@@ -2026,6 +2137,10 @@ export interface SearchIndexResponse {
|
|
|
2026
2137
|
semanticSearch?: SemanticSearch;
|
|
2027
2138
|
/** Contains configuration options related to vector search. */
|
|
2028
2139
|
vectorSearch?: VectorSearch;
|
|
2140
|
+
/** A value indicating whether permission filtering is enabled for the index. */
|
|
2141
|
+
permissionFilterOption?: SearchIndexPermissionFilterOption;
|
|
2142
|
+
/** A value indicating whether Purview is enabled for the index. */
|
|
2143
|
+
purviewEnabled?: boolean;
|
|
2029
2144
|
/** The ETag of the index. */
|
|
2030
2145
|
eTag?: string;
|
|
2031
2146
|
}
|
|
@@ -2039,7 +2154,7 @@ export interface GetIndexStatisticsResult {
|
|
|
2039
2154
|
/** The amount of memory in bytes consumed by vectors in the index. */
|
|
2040
2155
|
readonly vectorIndexSize: number;
|
|
2041
2156
|
}
|
|
2042
|
-
export declare function getIndexStatisticsResultSerializer(
|
|
2157
|
+
export declare function getIndexStatisticsResultSerializer(_item: GetIndexStatisticsResult): any;
|
|
2043
2158
|
export declare function getIndexStatisticsResultDeserializer(item: any): GetIndexStatisticsResult;
|
|
2044
2159
|
/** Specifies some text and analysis components used to break that text into tokens. */
|
|
2045
2160
|
export interface AnalyzeTextOptions {
|
|
@@ -2077,7 +2192,7 @@ export interface AnalyzedTokenInfo {
|
|
|
2077
2192
|
/** The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. */
|
|
2078
2193
|
readonly position: number;
|
|
2079
2194
|
}
|
|
2080
|
-
export declare function analyzedTokenInfoSerializer(
|
|
2195
|
+
export declare function analyzedTokenInfoSerializer(_item: AnalyzedTokenInfo): any;
|
|
2081
2196
|
export declare function analyzedTokenInfoDeserializer(item: any): AnalyzedTokenInfo;
|
|
2082
2197
|
/** 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. */
|
|
2083
2198
|
export interface SearchAlias {
|
|
@@ -2106,12 +2221,22 @@ export interface KnowledgeBase {
|
|
|
2106
2221
|
knowledgeSources: KnowledgeSourceReference[];
|
|
2107
2222
|
/** Contains configuration options on how to connect to AI models. */
|
|
2108
2223
|
models?: KnowledgeBaseModelUnion[];
|
|
2224
|
+
/** The retrieval reasoning effort configuration. */
|
|
2225
|
+
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;
|
|
2226
|
+
/** The output mode for the knowledge base. */
|
|
2227
|
+
outputMode?: KnowledgeRetrievalOutputMode;
|
|
2109
2228
|
/** The ETag of the knowledge base. */
|
|
2110
2229
|
etag?: string;
|
|
2111
2230
|
/** A description of an encryption key that you create in Azure Key Vault. */
|
|
2112
2231
|
encryptionKey?: SearchResourceEncryptionKey;
|
|
2113
2232
|
/** The description of the knowledge base. */
|
|
2114
2233
|
description?: string;
|
|
2234
|
+
/** Instructions considered by the knowledge base when developing query plan. */
|
|
2235
|
+
retrievalInstructions?: string;
|
|
2236
|
+
/** Instructions considered by the knowledge base when generating answers. */
|
|
2237
|
+
answerInstructions?: string;
|
|
2238
|
+
/** Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base. */
|
|
2239
|
+
corsOptions?: CorsOptions;
|
|
2115
2240
|
}
|
|
2116
2241
|
export declare function knowledgeBaseSerializer(item: KnowledgeBase): any;
|
|
2117
2242
|
export declare function knowledgeBaseDeserializer(item: any): KnowledgeBase;
|
|
@@ -2121,6 +2246,10 @@ export declare function knowledgeSourceReferenceArrayDeserializer(result: Array<
|
|
|
2121
2246
|
export interface KnowledgeSourceReference {
|
|
2122
2247
|
/** The name of the knowledge source. */
|
|
2123
2248
|
name: string;
|
|
2249
|
+
/** Indicates whether image serving should be enabled for this knowledge source. When true, images extracted during ingestion are delivered to downstream models at query time. */
|
|
2250
|
+
enableImageServing?: boolean;
|
|
2251
|
+
/** Indicates whether freshness-aware retrieval should be enabled for this knowledge source. When true, a freshness scoring profile is applied during retrieval to bias results toward newer documents. */
|
|
2252
|
+
enableFreshness?: boolean;
|
|
2124
2253
|
}
|
|
2125
2254
|
export declare function knowledgeSourceReferenceSerializer(item: KnowledgeSourceReference): any;
|
|
2126
2255
|
export declare function knowledgeSourceReferenceDeserializer(item: any): KnowledgeSourceReference;
|
|
@@ -2174,7 +2303,7 @@ export interface KnowledgeSource {
|
|
|
2174
2303
|
/** Optional user-defined description. */
|
|
2175
2304
|
description?: string;
|
|
2176
2305
|
/** The type of the knowledge source. */
|
|
2177
|
-
/** The discriminator possible values: searchIndex, azureBlob, indexedOneLake, web */
|
|
2306
|
+
/** The discriminator possible values: searchIndex, azureBlob, indexedSharePoint, indexedOneLake, indexedSql, file, web, remoteSharePoint, workIQ, mcpServer, fabricDataAgent, fabricOntology */
|
|
2178
2307
|
kind: KnowledgeSourceKind;
|
|
2179
2308
|
/** The ETag of the knowledge source. */
|
|
2180
2309
|
eTag?: string;
|
|
@@ -2184,7 +2313,7 @@ export interface KnowledgeSource {
|
|
|
2184
2313
|
export declare function knowledgeSourceSerializer(item: KnowledgeSource): any;
|
|
2185
2314
|
export declare function knowledgeSourceDeserializer(item: any): KnowledgeSource;
|
|
2186
2315
|
/** Alias for KnowledgeSourceUnion */
|
|
2187
|
-
export type KnowledgeSourceUnion = SearchIndexKnowledgeSource | AzureBlobKnowledgeSource | IndexedOneLakeKnowledgeSource | WebKnowledgeSource | KnowledgeSource;
|
|
2316
|
+
export type KnowledgeSourceUnion = SearchIndexKnowledgeSource | AzureBlobKnowledgeSource | IndexedSharePointKnowledgeSource | IndexedOneLakeKnowledgeSource | IndexedSqlKnowledgeSource | FileKnowledgeSource | WebKnowledgeSource | RemoteSharePointKnowledgeSource | WorkIQKnowledgeSource | McpServerKnowledgeSource | FabricDataAgentKnowledgeSource | FabricOntologyKnowledgeSource | KnowledgeSource;
|
|
2188
2317
|
export declare function knowledgeSourceUnionSerializer(item: KnowledgeSourceUnion): any;
|
|
2189
2318
|
export declare function knowledgeSourceUnionDeserializer(item: any): KnowledgeSourceUnion;
|
|
2190
2319
|
/** The kind of the knowledge source. */
|
|
@@ -2193,10 +2322,26 @@ export declare enum KnownKnowledgeSourceKind {
|
|
|
2193
2322
|
SearchIndex = "searchIndex",
|
|
2194
2323
|
/** A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. */
|
|
2195
2324
|
AzureBlob = "azureBlob",
|
|
2325
|
+
/** A knowledge source that reads data from indexed SharePoint. */
|
|
2326
|
+
IndexedSharePoint = "indexedSharePoint",
|
|
2196
2327
|
/** A knowledge source that reads data from indexed OneLake. */
|
|
2197
2328
|
IndexedOneLake = "indexedOneLake",
|
|
2329
|
+
/** A knowledge source that retrieves and ingests data from Azure SQL Database or SQL Managed Instance to a Search Index. */
|
|
2330
|
+
IndexedSql = "indexedSql",
|
|
2198
2331
|
/** A knowledge source that reads data from the web. */
|
|
2199
|
-
Web = "web"
|
|
2332
|
+
Web = "web",
|
|
2333
|
+
/** A knowledge source that reads data from remote SharePoint. */
|
|
2334
|
+
RemoteSharePoint = "remoteSharePoint",
|
|
2335
|
+
/** A knowledge source that reads data from work IQ */
|
|
2336
|
+
WorkIQ = "workIQ",
|
|
2337
|
+
/** A knowledge source that supports direct file upload and indexing. */
|
|
2338
|
+
File = "file",
|
|
2339
|
+
/** A knowledge source backed by an MCP (Model Context Protocol) server. */
|
|
2340
|
+
McpServer = "mcpServer",
|
|
2341
|
+
/** A knowledge source that retrieves data from a Fabric Data Agent. */
|
|
2342
|
+
FabricDataAgent = "fabricDataAgent",
|
|
2343
|
+
/** A knowledge source that retrieves data from Microsoft Fabric Ontology ontologies. */
|
|
2344
|
+
FabricOntology = "fabricOntology"
|
|
2200
2345
|
}
|
|
2201
2346
|
/**
|
|
2202
2347
|
* The kind of the knowledge source. \
|
|
@@ -2205,8 +2350,16 @@ export declare enum KnownKnowledgeSourceKind {
|
|
|
2205
2350
|
* ### Known values supported by the service
|
|
2206
2351
|
* **searchIndex**: A knowledge source that reads data from a Search Index. \
|
|
2207
2352
|
* **azureBlob**: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. \
|
|
2353
|
+
* **indexedSharePoint**: A knowledge source that reads data from indexed SharePoint. \
|
|
2208
2354
|
* **indexedOneLake**: A knowledge source that reads data from indexed OneLake. \
|
|
2209
|
-
* **
|
|
2355
|
+
* **indexedSql**: A knowledge source that retrieves and ingests data from Azure SQL Database or SQL Managed Instance to a Search Index. \
|
|
2356
|
+
* **web**: A knowledge source that reads data from the web. \
|
|
2357
|
+
* **remoteSharePoint**: A knowledge source that reads data from remote SharePoint. \
|
|
2358
|
+
* **workIQ**: A knowledge source that reads data from work IQ \
|
|
2359
|
+
* **file**: A knowledge source that supports direct file upload and indexing. \
|
|
2360
|
+
* **mcpServer**: A knowledge source backed by an MCP (Model Context Protocol) server. \
|
|
2361
|
+
* **fabricDataAgent**: A knowledge source that retrieves data from a Fabric Data Agent. \
|
|
2362
|
+
* **fabricOntology**: A knowledge source that retrieves data from Microsoft Fabric Ontology ontologies.
|
|
2210
2363
|
*/
|
|
2211
2364
|
export type KnowledgeSourceKind = string;
|
|
2212
2365
|
/** Knowledge Source targeting a search index. */
|
|
@@ -2227,6 +2380,8 @@ export interface SearchIndexKnowledgeSourceParameters {
|
|
|
2227
2380
|
searchFields?: SearchIndexFieldReference[];
|
|
2228
2381
|
/** Used to specify a different semantic configuration on the target search index other than the default one. */
|
|
2229
2382
|
semanticConfigurationName?: string;
|
|
2383
|
+
/** A default filter condition applied to the index at retrieval time (e.g., 'State eq VA'). Can be overridden at query time via knowledge source runtime parameters. */
|
|
2384
|
+
baseFilter?: string;
|
|
2230
2385
|
}
|
|
2231
2386
|
export declare function searchIndexKnowledgeSourceParametersSerializer(item: SearchIndexKnowledgeSourceParameters): any;
|
|
2232
2387
|
export declare function searchIndexKnowledgeSourceParametersDeserializer(item: any): SearchIndexKnowledgeSourceParameters;
|
|
@@ -2273,6 +2428,28 @@ export interface IndexingSchedule {
|
|
|
2273
2428
|
}
|
|
2274
2429
|
export declare function indexingScheduleSerializer(item: IndexingSchedule): any;
|
|
2275
2430
|
export declare function indexingScheduleDeserializer(item: any): IndexingSchedule;
|
|
2431
|
+
/** Permission types to ingest together with document content. */
|
|
2432
|
+
export declare enum KnownKnowledgeSourceIngestionPermissionOption {
|
|
2433
|
+
/** Ingest explicit user identifiers alongside document content. */
|
|
2434
|
+
UserIds = "userIds",
|
|
2435
|
+
/** Ingest group identifiers alongside document content. */
|
|
2436
|
+
GroupIds = "groupIds",
|
|
2437
|
+
/** Ingest RBAC scope information alongside document content. */
|
|
2438
|
+
RbacScope = "rbacScope",
|
|
2439
|
+
/** Ingest Microsoft Purview sensitivity labels alongside document content. */
|
|
2440
|
+
SensitivityLabels = "sensitivityLabels"
|
|
2441
|
+
}
|
|
2442
|
+
/**
|
|
2443
|
+
* Permission types to ingest together with document content. \
|
|
2444
|
+
* {@link KnownKnowledgeSourceIngestionPermissionOption} can be used interchangeably with KnowledgeSourceIngestionPermissionOption,
|
|
2445
|
+
* this enum contains the known values that the service supports.
|
|
2446
|
+
* ### Known values supported by the service
|
|
2447
|
+
* **userIds**: Ingest explicit user identifiers alongside document content. \
|
|
2448
|
+
* **groupIds**: Ingest group identifiers alongside document content. \
|
|
2449
|
+
* **rbacScope**: Ingest RBAC scope information alongside document content. \
|
|
2450
|
+
* **sensitivityLabels**: Ingest Microsoft Purview sensitivity labels alongside document content.
|
|
2451
|
+
*/
|
|
2452
|
+
export type KnowledgeSourceIngestionPermissionOption = string;
|
|
2276
2453
|
/** Optional content extraction mode. Default is 'minimal'. */
|
|
2277
2454
|
export declare enum KnownKnowledgeSourceContentExtractionMode {
|
|
2278
2455
|
/** Extracts only essential metadata while deferring most content processing. */
|
|
@@ -2295,6 +2472,48 @@ export interface CreatedResources {
|
|
|
2295
2472
|
additionalProperties?: Record<string, string>;
|
|
2296
2473
|
}
|
|
2297
2474
|
export declare function createdResourcesDeserializer(item: any): CreatedResources;
|
|
2475
|
+
/** Configuration for SharePoint knowledge source. */
|
|
2476
|
+
export interface IndexedSharePointKnowledgeSource extends KnowledgeSource {
|
|
2477
|
+
kind: "indexedSharePoint";
|
|
2478
|
+
/** The parameters for the knowledge source. */
|
|
2479
|
+
indexedSharePointParameters: IndexedSharePointKnowledgeSourceParameters;
|
|
2480
|
+
}
|
|
2481
|
+
export declare function indexedSharePointKnowledgeSourceSerializer(item: IndexedSharePointKnowledgeSource): any;
|
|
2482
|
+
export declare function indexedSharePointKnowledgeSourceDeserializer(item: any): IndexedSharePointKnowledgeSource;
|
|
2483
|
+
/** Parameters for SharePoint knowledge source. */
|
|
2484
|
+
export interface IndexedSharePointKnowledgeSourceParameters {
|
|
2485
|
+
/** 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] */
|
|
2486
|
+
connectionString: string;
|
|
2487
|
+
/** Specifies which SharePoint libraries to access. */
|
|
2488
|
+
containerName: IndexedSharePointContainerName;
|
|
2489
|
+
/** Optional query to filter SharePoint content. */
|
|
2490
|
+
query?: string;
|
|
2491
|
+
/** Consolidates all general ingestion settings. */
|
|
2492
|
+
ingestionParameters?: KnowledgeSourceIngestionParameters;
|
|
2493
|
+
/** Resources created by the knowledge source. */
|
|
2494
|
+
readonly createdResources?: CreatedResources;
|
|
2495
|
+
}
|
|
2496
|
+
export declare function indexedSharePointKnowledgeSourceParametersSerializer(item: IndexedSharePointKnowledgeSourceParameters): any;
|
|
2497
|
+
export declare function indexedSharePointKnowledgeSourceParametersDeserializer(item: any): IndexedSharePointKnowledgeSourceParameters;
|
|
2498
|
+
/** Specifies which SharePoint libraries to access. */
|
|
2499
|
+
export declare enum KnownIndexedSharePointContainerName {
|
|
2500
|
+
/** Index content from the site's default document library. */
|
|
2501
|
+
DefaultSiteLibrary = "defaultSiteLibrary",
|
|
2502
|
+
/** Index content from every document library in the site. */
|
|
2503
|
+
AllSiteLibraries = "allSiteLibraries",
|
|
2504
|
+
/** Use a query to filter SharePoint content. */
|
|
2505
|
+
UseQuery = "useQuery"
|
|
2506
|
+
}
|
|
2507
|
+
/**
|
|
2508
|
+
* Specifies which SharePoint libraries to access. \
|
|
2509
|
+
* {@link KnownIndexedSharePointContainerName} can be used interchangeably with IndexedSharePointContainerName,
|
|
2510
|
+
* this enum contains the known values that the service supports.
|
|
2511
|
+
* ### Known values supported by the service
|
|
2512
|
+
* **defaultSiteLibrary**: Index content from the site's default document library. \
|
|
2513
|
+
* **allSiteLibraries**: Index content from every document library in the site. \
|
|
2514
|
+
* **useQuery**: Use a query to filter SharePoint content.
|
|
2515
|
+
*/
|
|
2516
|
+
export type IndexedSharePointContainerName = string;
|
|
2298
2517
|
/** Configuration for OneLake knowledge source. */
|
|
2299
2518
|
export interface IndexedOneLakeKnowledgeSource extends KnowledgeSource {
|
|
2300
2519
|
kind: "indexedOneLake";
|
|
@@ -2318,6 +2537,98 @@ export interface IndexedOneLakeKnowledgeSourceParameters {
|
|
|
2318
2537
|
}
|
|
2319
2538
|
export declare function indexedOneLakeKnowledgeSourceParametersSerializer(item: IndexedOneLakeKnowledgeSourceParameters): any;
|
|
2320
2539
|
export declare function indexedOneLakeKnowledgeSourceParametersDeserializer(item: any): IndexedOneLakeKnowledgeSourceParameters;
|
|
2540
|
+
/** Configuration for indexed SQL knowledge source. */
|
|
2541
|
+
export interface IndexedSqlKnowledgeSource extends KnowledgeSource {
|
|
2542
|
+
/** The discriminator value. */
|
|
2543
|
+
kind: "indexedSql";
|
|
2544
|
+
/** The parameters for the SQL knowledge source. */
|
|
2545
|
+
indexedSqlParameters: IndexedSqlKnowledgeSourceParameters;
|
|
2546
|
+
}
|
|
2547
|
+
export declare function indexedSqlKnowledgeSourceSerializer(item: IndexedSqlKnowledgeSource): any;
|
|
2548
|
+
export declare function indexedSqlKnowledgeSourceDeserializer(item: any): IndexedSqlKnowledgeSource;
|
|
2549
|
+
/** Parameters for indexed SQL knowledge source. */
|
|
2550
|
+
export interface IndexedSqlKnowledgeSourceParameters {
|
|
2551
|
+
/** The connection string for the Azure SQL Database or SQL Managed Instance. */
|
|
2552
|
+
connectionString: string;
|
|
2553
|
+
/** The name of the table or view to index. Can be schema-qualified (e.g., 'dbo.MyTable'). */
|
|
2554
|
+
tableOrView: string;
|
|
2555
|
+
/** Optional column name for high water mark change detection. If provided, uses HighWaterMarkChangeDetectionPolicy. */
|
|
2556
|
+
highWaterMarkColumnName?: string;
|
|
2557
|
+
/** Optional column mappings for content fields. If omitted, all columns are auto-discovered. */
|
|
2558
|
+
contentColumns?: ContentColumnMapping[];
|
|
2559
|
+
/** Optional column mappings for embedding vector fields. If omitted, no vector fields are created. */
|
|
2560
|
+
embeddingColumns?: EmbeddingColumnMapping[];
|
|
2561
|
+
/** Consolidates all general ingestion settings including embedding model, schedule, and identity. */
|
|
2562
|
+
ingestionParameters?: KnowledgeSourceIngestionParameters;
|
|
2563
|
+
/** Resources created by the knowledge source. */
|
|
2564
|
+
readonly createdResources?: CreatedResources;
|
|
2565
|
+
}
|
|
2566
|
+
export declare function indexedSqlKnowledgeSourceParametersSerializer(item: IndexedSqlKnowledgeSourceParameters): any;
|
|
2567
|
+
export declare function indexedSqlKnowledgeSourceParametersDeserializer(item: any): IndexedSqlKnowledgeSourceParameters;
|
|
2568
|
+
export declare function contentColumnMappingArraySerializer(result: Array<ContentColumnMapping>): any[];
|
|
2569
|
+
export declare function contentColumnMappingArrayDeserializer(result: Array<ContentColumnMapping>): any[];
|
|
2570
|
+
/** Maps a SQL column to a search index field. */
|
|
2571
|
+
export interface ContentColumnMapping {
|
|
2572
|
+
/** Target index field name. */
|
|
2573
|
+
name: string;
|
|
2574
|
+
/** SQL column name. */
|
|
2575
|
+
sourceField: string;
|
|
2576
|
+
/** Azure AI Search field type (e.g., Edm.String, Edm.Int32). */
|
|
2577
|
+
searchFieldType: string;
|
|
2578
|
+
}
|
|
2579
|
+
export declare function contentColumnMappingSerializer(item: ContentColumnMapping): any;
|
|
2580
|
+
export declare function contentColumnMappingDeserializer(item: any): ContentColumnMapping;
|
|
2581
|
+
export declare function embeddingColumnMappingArraySerializer(result: Array<EmbeddingColumnMapping>): any[];
|
|
2582
|
+
export declare function embeddingColumnMappingArrayDeserializer(result: Array<EmbeddingColumnMapping>): any[];
|
|
2583
|
+
/** Maps a SQL column to a vector field for embedding. */
|
|
2584
|
+
export interface EmbeddingColumnMapping {
|
|
2585
|
+
/** Target vector field name in the search index. */
|
|
2586
|
+
name: string;
|
|
2587
|
+
/** SQL column used as input for embedding generation. */
|
|
2588
|
+
sourceField: string;
|
|
2589
|
+
}
|
|
2590
|
+
export declare function embeddingColumnMappingSerializer(item: EmbeddingColumnMapping): any;
|
|
2591
|
+
export declare function embeddingColumnMappingDeserializer(item: any): EmbeddingColumnMapping;
|
|
2592
|
+
/** Configuration for File knowledge source that supports direct file upload and indexing. */
|
|
2593
|
+
export interface FileKnowledgeSource extends KnowledgeSource {
|
|
2594
|
+
kind: "file";
|
|
2595
|
+
/** The parameters for the File knowledge source. */
|
|
2596
|
+
fileParameters: FileKnowledgeSourceParameters;
|
|
2597
|
+
}
|
|
2598
|
+
export declare function fileKnowledgeSourceSerializer(item: FileKnowledgeSource): any;
|
|
2599
|
+
export declare function fileKnowledgeSourceDeserializer(item: any): FileKnowledgeSource;
|
|
2600
|
+
/** Parameters for File knowledge source. */
|
|
2601
|
+
export interface FileKnowledgeSourceParameters {
|
|
2602
|
+
/** Consolidates all general ingestion settings. Only 'minimal' content extraction mode and embeddingModel are supported for file knowledge sources. */
|
|
2603
|
+
ingestionParameters?: KnowledgeSourceIngestionParameters;
|
|
2604
|
+
/** Resources created by the file knowledge source. */
|
|
2605
|
+
readonly createdResources?: CreatedResources;
|
|
2606
|
+
}
|
|
2607
|
+
export declare function fileKnowledgeSourceParametersSerializer(item: FileKnowledgeSourceParameters): any;
|
|
2608
|
+
export declare function fileKnowledgeSourceParametersDeserializer(item: any): FileKnowledgeSourceParameters;
|
|
2609
|
+
/** Metadata for a file uploaded to a File knowledge source. */
|
|
2610
|
+
export interface KnowledgeSourceFile {
|
|
2611
|
+
/** The unique identifier for the file. */
|
|
2612
|
+
readonly fileId?: string;
|
|
2613
|
+
/** The original file name. */
|
|
2614
|
+
readonly fileName?: string;
|
|
2615
|
+
/** The file size in bytes. */
|
|
2616
|
+
readonly fileSizeBytes?: number;
|
|
2617
|
+
/** The timestamp when the file was created. */
|
|
2618
|
+
readonly createdAt?: Date;
|
|
2619
|
+
/** The timestamp when the file was last updated. */
|
|
2620
|
+
readonly lastUpdatedAt?: Date;
|
|
2621
|
+
/** The error message if file processing failed, null otherwise. */
|
|
2622
|
+
readonly errorMessage?: string | null;
|
|
2623
|
+
}
|
|
2624
|
+
export declare function knowledgeSourceFileDeserializer(item: any): KnowledgeSourceFile;
|
|
2625
|
+
export declare function knowledgeSourceFileArrayDeserializer(result: Array<KnowledgeSourceFile>): any[];
|
|
2626
|
+
/** Response from a List Files request. */
|
|
2627
|
+
export interface _ListKnowledgeSourceFilesResult {
|
|
2628
|
+
/** The list of files. */
|
|
2629
|
+
value: KnowledgeSourceFile[];
|
|
2630
|
+
}
|
|
2631
|
+
export declare function _listKnowledgeSourceFilesResultDeserializer(item: any): _ListKnowledgeSourceFilesResult;
|
|
2321
2632
|
/** Knowledge Source targeting web results. */
|
|
2322
2633
|
export interface WebKnowledgeSource extends KnowledgeSource {
|
|
2323
2634
|
kind: "web";
|
|
@@ -2330,6 +2641,14 @@ export declare function webKnowledgeSourceDeserializer(item: any): WebKnowledgeS
|
|
|
2330
2641
|
export interface WebKnowledgeSourceParameters {
|
|
2331
2642
|
/** Domain allow/block configuration for web results. */
|
|
2332
2643
|
domains?: WebKnowledgeSourceDomains;
|
|
2644
|
+
/** The default language for web results. Can be overridden at query time via knowledge source runtime parameters. */
|
|
2645
|
+
language?: string;
|
|
2646
|
+
/** The default market for web results. Can be overridden at query time via knowledge source runtime parameters. */
|
|
2647
|
+
market?: string;
|
|
2648
|
+
/** The default number of web results to return. Can be overridden at query time via knowledge source runtime parameters. */
|
|
2649
|
+
count?: number;
|
|
2650
|
+
/** The default freshness filter for web results. Can be overridden at query time via knowledge source runtime parameters. */
|
|
2651
|
+
freshness?: string;
|
|
2333
2652
|
}
|
|
2334
2653
|
export declare function webKnowledgeSourceParametersSerializer(item: WebKnowledgeSourceParameters): any;
|
|
2335
2654
|
export declare function webKnowledgeSourceParametersDeserializer(item: any): WebKnowledgeSourceParameters;
|
|
@@ -2353,6 +2672,400 @@ export interface WebKnowledgeSourceDomain {
|
|
|
2353
2672
|
}
|
|
2354
2673
|
export declare function webKnowledgeSourceDomainSerializer(item: WebKnowledgeSourceDomain): any;
|
|
2355
2674
|
export declare function webKnowledgeSourceDomainDeserializer(item: any): WebKnowledgeSourceDomain;
|
|
2675
|
+
/** Configuration for remote SharePoint knowledge source. */
|
|
2676
|
+
export interface RemoteSharePointKnowledgeSource extends KnowledgeSource {
|
|
2677
|
+
kind: "remoteSharePoint";
|
|
2678
|
+
/** The parameters for the remote SharePoint knowledge source. */
|
|
2679
|
+
remoteSharePointParameters?: RemoteSharePointKnowledgeSourceParameters;
|
|
2680
|
+
}
|
|
2681
|
+
export declare function remoteSharePointKnowledgeSourceSerializer(item: RemoteSharePointKnowledgeSource): any;
|
|
2682
|
+
export declare function remoteSharePointKnowledgeSourceDeserializer(item: any): RemoteSharePointKnowledgeSource;
|
|
2683
|
+
/** Parameters for remote SharePoint knowledge source. */
|
|
2684
|
+
export interface RemoteSharePointKnowledgeSourceParameters {
|
|
2685
|
+
/** Keyword Query Language (KQL) expression with queryable SharePoint properties and attributes to scope the retrieval before the query runs. */
|
|
2686
|
+
filterExpression?: string;
|
|
2687
|
+
/** 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. */
|
|
2688
|
+
resourceMetadata?: string[];
|
|
2689
|
+
/** Container ID for SharePoint Embedded connection. When this is null, it will use SharePoint Online. */
|
|
2690
|
+
containerTypeId?: string;
|
|
2691
|
+
}
|
|
2692
|
+
export declare function remoteSharePointKnowledgeSourceParametersSerializer(item: RemoteSharePointKnowledgeSourceParameters): any;
|
|
2693
|
+
export declare function remoteSharePointKnowledgeSourceParametersDeserializer(item: any): RemoteSharePointKnowledgeSourceParameters;
|
|
2694
|
+
/** Configuration for WorkIQ knowledge source. */
|
|
2695
|
+
export interface WorkIQKnowledgeSource extends KnowledgeSource {
|
|
2696
|
+
kind: "workIQ";
|
|
2697
|
+
}
|
|
2698
|
+
export declare function workIQKnowledgeSourceSerializer(item: WorkIQKnowledgeSource): any;
|
|
2699
|
+
export declare function workIQKnowledgeSourceDeserializer(item: any): WorkIQKnowledgeSource;
|
|
2700
|
+
/** Configuration for a knowledge source backed by an MCP (Model Context Protocol) server. */
|
|
2701
|
+
export interface McpServerKnowledgeSource extends KnowledgeSource {
|
|
2702
|
+
/** The discriminator value. */
|
|
2703
|
+
kind: "mcpServer";
|
|
2704
|
+
/** The parameters for the MCP server knowledge source. */
|
|
2705
|
+
mcpServerParameters: McpServerKnowledgeSourceParameters;
|
|
2706
|
+
}
|
|
2707
|
+
export declare function mcpServerKnowledgeSourceSerializer(item: McpServerKnowledgeSource): any;
|
|
2708
|
+
export declare function mcpServerKnowledgeSourceDeserializer(item: any): McpServerKnowledgeSource;
|
|
2709
|
+
/** Parameters for an MCP server knowledge source. */
|
|
2710
|
+
export interface McpServerKnowledgeSourceParameters {
|
|
2711
|
+
/** The URL of the MCP server endpoint. */
|
|
2712
|
+
serverURL: string;
|
|
2713
|
+
/** The authentication configuration for the MCP server. */
|
|
2714
|
+
authentication?: McpServerAuthenticationUnion;
|
|
2715
|
+
/** The list of tools to invoke on the MCP server. */
|
|
2716
|
+
tools: McpServerTool[];
|
|
2717
|
+
}
|
|
2718
|
+
export declare function mcpServerKnowledgeSourceParametersSerializer(item: McpServerKnowledgeSourceParameters): any;
|
|
2719
|
+
export declare function mcpServerKnowledgeSourceParametersDeserializer(item: any): McpServerKnowledgeSourceParameters;
|
|
2720
|
+
/** Authentication configuration for an MCP server knowledge source. */
|
|
2721
|
+
export interface McpServerAuthentication {
|
|
2722
|
+
/** The kind of authentication to use. */
|
|
2723
|
+
/** The discriminator possible values: foundryConnection, storedHeaders */
|
|
2724
|
+
kind: McpServerAuthenticationKind;
|
|
2725
|
+
}
|
|
2726
|
+
export declare function mcpServerAuthenticationSerializer(item: McpServerAuthentication): any;
|
|
2727
|
+
export declare function mcpServerAuthenticationDeserializer(item: any): McpServerAuthentication;
|
|
2728
|
+
/** Alias for McpServerAuthenticationUnion */
|
|
2729
|
+
export type McpServerAuthenticationUnion = McpServerFoundryConnectionAuthentication | McpServerStoredHeadersAuthentication | McpServerAuthentication;
|
|
2730
|
+
export declare function mcpServerAuthenticationUnionSerializer(item: McpServerAuthenticationUnion): any;
|
|
2731
|
+
export declare function mcpServerAuthenticationUnionDeserializer(item: any): McpServerAuthenticationUnion;
|
|
2732
|
+
/** The kind of authentication for an MCP server. */
|
|
2733
|
+
export declare enum KnownMcpServerAuthenticationKind {
|
|
2734
|
+
/** Authenticate using an Azure AI Foundry connection. */
|
|
2735
|
+
FoundryConnection = "foundryConnection",
|
|
2736
|
+
/** Authenticate using stored HTTP headers. */
|
|
2737
|
+
StoredHeaders = "storedHeaders"
|
|
2738
|
+
}
|
|
2739
|
+
/**
|
|
2740
|
+
* The kind of authentication for an MCP server. \
|
|
2741
|
+
* {@link KnownMcpServerAuthenticationKind} can be used interchangeably with McpServerAuthenticationKind,
|
|
2742
|
+
* this enum contains the known values that the service supports.
|
|
2743
|
+
* ### Known values supported by the service
|
|
2744
|
+
* **foundryConnection**: Authenticate using an Azure AI Foundry connection. \
|
|
2745
|
+
* **storedHeaders**: Authenticate using stored HTTP headers.
|
|
2746
|
+
*/
|
|
2747
|
+
export type McpServerAuthenticationKind = string;
|
|
2748
|
+
/** Authentication using an Azure AI Foundry connection. */
|
|
2749
|
+
export interface McpServerFoundryConnectionAuthentication extends McpServerAuthentication {
|
|
2750
|
+
/** The discriminator value. */
|
|
2751
|
+
kind: "foundryConnection";
|
|
2752
|
+
/** Parameters for Foundry connection authentication. */
|
|
2753
|
+
foundryConnectionParameters: McpServerFoundryConnectionParameters;
|
|
2754
|
+
}
|
|
2755
|
+
export declare function mcpServerFoundryConnectionAuthenticationSerializer(item: McpServerFoundryConnectionAuthentication): any;
|
|
2756
|
+
export declare function mcpServerFoundryConnectionAuthenticationDeserializer(item: any): McpServerFoundryConnectionAuthentication;
|
|
2757
|
+
/** Parameters for Foundry connection authentication. */
|
|
2758
|
+
export interface McpServerFoundryConnectionParameters {
|
|
2759
|
+
/** The Azure AI Foundry connection identifier. */
|
|
2760
|
+
connectionId?: string;
|
|
2761
|
+
}
|
|
2762
|
+
export declare function mcpServerFoundryConnectionParametersSerializer(item: McpServerFoundryConnectionParameters): any;
|
|
2763
|
+
export declare function mcpServerFoundryConnectionParametersDeserializer(item: any): McpServerFoundryConnectionParameters;
|
|
2764
|
+
/** Authentication using stored HTTP headers. */
|
|
2765
|
+
export interface McpServerStoredHeadersAuthentication extends McpServerAuthentication {
|
|
2766
|
+
/** The discriminator value. */
|
|
2767
|
+
kind: "storedHeaders";
|
|
2768
|
+
/** Parameters for stored headers authentication. */
|
|
2769
|
+
storedHeadersParameters: McpServerStoredHeadersParameters;
|
|
2770
|
+
}
|
|
2771
|
+
export declare function mcpServerStoredHeadersAuthenticationSerializer(item: McpServerStoredHeadersAuthentication): any;
|
|
2772
|
+
export declare function mcpServerStoredHeadersAuthenticationDeserializer(item: any): McpServerStoredHeadersAuthentication;
|
|
2773
|
+
/** Parameters for stored headers authentication. */
|
|
2774
|
+
export interface McpServerStoredHeadersParameters {
|
|
2775
|
+
/** The stored HTTP headers to include in MCP server requests. */
|
|
2776
|
+
headers?: McpServerHeaders;
|
|
2777
|
+
}
|
|
2778
|
+
export declare function mcpServerStoredHeadersParametersSerializer(item: McpServerStoredHeadersParameters): any;
|
|
2779
|
+
export declare function mcpServerStoredHeadersParametersDeserializer(item: any): McpServerStoredHeadersParameters;
|
|
2780
|
+
/** A dictionary of HTTP header names and values. */
|
|
2781
|
+
export interface McpServerHeaders {
|
|
2782
|
+
/** Additional properties */
|
|
2783
|
+
additionalProperties?: Record<string, string>;
|
|
2784
|
+
}
|
|
2785
|
+
export declare function mcpServerHeadersSerializer(item: McpServerHeaders): any;
|
|
2786
|
+
export declare function mcpServerHeadersDeserializer(item: any): McpServerHeaders;
|
|
2787
|
+
export declare function mcpServerToolArraySerializer(result: Array<McpServerTool>): any[];
|
|
2788
|
+
export declare function mcpServerToolArrayDeserializer(result: Array<McpServerTool>): any[];
|
|
2789
|
+
/** Represents a single tool within an MCP server knowledge source. */
|
|
2790
|
+
export interface McpServerTool {
|
|
2791
|
+
/** The name of the MCP tool to invoke. */
|
|
2792
|
+
name?: string;
|
|
2793
|
+
/** Optional configuration for parsing the tool's output. */
|
|
2794
|
+
outputParsing?: McpServerOutputParsingUnion;
|
|
2795
|
+
/** Controls how the parsed results from this tool are integrated into the final result set. Defaults to 'reranked' when not specified. */
|
|
2796
|
+
inclusionMode?: McpServerToolInclusionMode;
|
|
2797
|
+
/** Optional post-parsing token cap for this tool's output. Must be greater than 0 when specified. */
|
|
2798
|
+
maxOutputTokens?: number;
|
|
2799
|
+
}
|
|
2800
|
+
export declare function mcpServerToolSerializer(item: McpServerTool): any;
|
|
2801
|
+
export declare function mcpServerToolDeserializer(item: any): McpServerTool;
|
|
2802
|
+
/** Output parsing configuration for an MCP server tool. */
|
|
2803
|
+
export interface McpServerOutputParsing {
|
|
2804
|
+
/** The kind of output parsing to apply. */
|
|
2805
|
+
/** The discriminator possible values: auto, json, split, none */
|
|
2806
|
+
kind: McpServerOutputParsingKind;
|
|
2807
|
+
}
|
|
2808
|
+
export declare function mcpServerOutputParsingSerializer(item: McpServerOutputParsing): any;
|
|
2809
|
+
export declare function mcpServerOutputParsingDeserializer(item: any): McpServerOutputParsing;
|
|
2810
|
+
/** Alias for McpServerOutputParsingUnion */
|
|
2811
|
+
export type McpServerOutputParsingUnion = McpServerAutoOutputParsing | McpServerJsonOutputParsing | McpServerSplitOutputParsing | McpServerNoneOutputParsing | McpServerOutputParsing;
|
|
2812
|
+
export declare function mcpServerOutputParsingUnionSerializer(item: McpServerOutputParsingUnion): any;
|
|
2813
|
+
export declare function mcpServerOutputParsingUnionDeserializer(item: any): McpServerOutputParsingUnion;
|
|
2814
|
+
/** The kind of output parsing for an MCP server tool. */
|
|
2815
|
+
export declare enum KnownMcpServerOutputParsingKind {
|
|
2816
|
+
/** Automatically detect the output format and parse accordingly. */
|
|
2817
|
+
Auto = "auto",
|
|
2818
|
+
/** Parse the output as a JSON document using the configured JSON parameters. */
|
|
2819
|
+
Json = "json",
|
|
2820
|
+
/** Split the output into pages using the configured split parameters. */
|
|
2821
|
+
Split = "split",
|
|
2822
|
+
/** Treat the output as a single block without any parsing. */
|
|
2823
|
+
None = "none"
|
|
2824
|
+
}
|
|
2825
|
+
/**
|
|
2826
|
+
* The kind of output parsing for an MCP server tool. \
|
|
2827
|
+
* {@link KnownMcpServerOutputParsingKind} can be used interchangeably with McpServerOutputParsingKind,
|
|
2828
|
+
* this enum contains the known values that the service supports.
|
|
2829
|
+
* ### Known values supported by the service
|
|
2830
|
+
* **auto**: Automatically detect the output format and parse accordingly. \
|
|
2831
|
+
* **json**: Parse the output as a JSON document using the configured JSON parameters. \
|
|
2832
|
+
* **split**: Split the output into pages using the configured split parameters. \
|
|
2833
|
+
* **none**: Treat the output as a single block without any parsing.
|
|
2834
|
+
*/
|
|
2835
|
+
export type McpServerOutputParsingKind = string;
|
|
2836
|
+
/** Automatically detect the output format and parse accordingly. */
|
|
2837
|
+
export interface McpServerAutoOutputParsing extends McpServerOutputParsing {
|
|
2838
|
+
/** The discriminator value. */
|
|
2839
|
+
kind: "auto";
|
|
2840
|
+
}
|
|
2841
|
+
export declare function mcpServerAutoOutputParsingSerializer(item: McpServerAutoOutputParsing): any;
|
|
2842
|
+
export declare function mcpServerAutoOutputParsingDeserializer(item: any): McpServerAutoOutputParsing;
|
|
2843
|
+
/** Parse the output as a JSON document using the configured JSON parameters. */
|
|
2844
|
+
export interface McpServerJsonOutputParsing extends McpServerOutputParsing {
|
|
2845
|
+
/** The discriminator value. */
|
|
2846
|
+
kind: "json";
|
|
2847
|
+
/** Parameters for JSON output parsing. Required when kind is 'json'. */
|
|
2848
|
+
jsonParameters: McpServerOutputParsingJsonParameters;
|
|
2849
|
+
}
|
|
2850
|
+
export declare function mcpServerJsonOutputParsingSerializer(item: McpServerJsonOutputParsing): any;
|
|
2851
|
+
export declare function mcpServerJsonOutputParsingDeserializer(item: any): McpServerJsonOutputParsing;
|
|
2852
|
+
/** Parameters for JSON output parsing. */
|
|
2853
|
+
export interface McpServerOutputParsingJsonParameters {
|
|
2854
|
+
/** The JSON path to the array of documents in the tool output. */
|
|
2855
|
+
documentsPath: string;
|
|
2856
|
+
/** Whether to include surrounding context from the JSON output alongside extracted documents. */
|
|
2857
|
+
includeContext?: boolean;
|
|
2858
|
+
}
|
|
2859
|
+
export declare function mcpServerOutputParsingJsonParametersSerializer(item: McpServerOutputParsingJsonParameters): any;
|
|
2860
|
+
export declare function mcpServerOutputParsingJsonParametersDeserializer(item: any): McpServerOutputParsingJsonParameters;
|
|
2861
|
+
/** Split the output into pages using the configured split parameters. */
|
|
2862
|
+
export interface McpServerSplitOutputParsing extends McpServerOutputParsing {
|
|
2863
|
+
/** The discriminator value. */
|
|
2864
|
+
kind: "split";
|
|
2865
|
+
/** Parameters for split output parsing. */
|
|
2866
|
+
splitParameters?: McpServerOutputParsingSplitParameters;
|
|
2867
|
+
}
|
|
2868
|
+
export declare function mcpServerSplitOutputParsingSerializer(item: McpServerSplitOutputParsing): any;
|
|
2869
|
+
export declare function mcpServerSplitOutputParsingDeserializer(item: any): McpServerSplitOutputParsing;
|
|
2870
|
+
/** Parameters for split output parsing. */
|
|
2871
|
+
export interface McpServerOutputParsingSplitParameters {
|
|
2872
|
+
/** The text split mode to use. */
|
|
2873
|
+
textSplitMode?: TextSplitMode;
|
|
2874
|
+
/** The maximum number of characters per page. */
|
|
2875
|
+
maximumPageLength?: number;
|
|
2876
|
+
/** The number of characters to overlap between pages. */
|
|
2877
|
+
pageOverlapLength?: number;
|
|
2878
|
+
/** The maximum number of pages to take from the output. */
|
|
2879
|
+
maximumPagesToTake?: number;
|
|
2880
|
+
/** A value indicating which language code to use. Default is `en`. */
|
|
2881
|
+
defaultLanguageCode?: SplitSkillLanguage;
|
|
2882
|
+
}
|
|
2883
|
+
export declare function mcpServerOutputParsingSplitParametersSerializer(item: McpServerOutputParsingSplitParameters): any;
|
|
2884
|
+
export declare function mcpServerOutputParsingSplitParametersDeserializer(item: any): McpServerOutputParsingSplitParameters;
|
|
2885
|
+
/** A value indicating which split mode to perform. */
|
|
2886
|
+
export declare enum KnownTextSplitMode {
|
|
2887
|
+
/** Split the text into individual pages. */
|
|
2888
|
+
Pages = "pages",
|
|
2889
|
+
/** Split the text into individual sentences. */
|
|
2890
|
+
Sentences = "sentences"
|
|
2891
|
+
}
|
|
2892
|
+
/**
|
|
2893
|
+
* A value indicating which split mode to perform. \
|
|
2894
|
+
* {@link KnownTextSplitMode} can be used interchangeably with TextSplitMode,
|
|
2895
|
+
* this enum contains the known values that the service supports.
|
|
2896
|
+
* ### Known values supported by the service
|
|
2897
|
+
* **pages**: Split the text into individual pages. \
|
|
2898
|
+
* **sentences**: Split the text into individual sentences.
|
|
2899
|
+
*/
|
|
2900
|
+
export type TextSplitMode = string;
|
|
2901
|
+
/** The language codes supported for input text by SplitSkill. */
|
|
2902
|
+
export declare enum KnownSplitSkillLanguage {
|
|
2903
|
+
/** Amharic */
|
|
2904
|
+
Am = "am",
|
|
2905
|
+
/** Bosnian */
|
|
2906
|
+
Bs = "bs",
|
|
2907
|
+
/** Czech */
|
|
2908
|
+
Cs = "cs",
|
|
2909
|
+
/** Danish */
|
|
2910
|
+
Da = "da",
|
|
2911
|
+
/** German */
|
|
2912
|
+
De = "de",
|
|
2913
|
+
/** English */
|
|
2914
|
+
En = "en",
|
|
2915
|
+
/** Spanish */
|
|
2916
|
+
Es = "es",
|
|
2917
|
+
/** Estonian */
|
|
2918
|
+
Et = "et",
|
|
2919
|
+
/** Finnish */
|
|
2920
|
+
Fi = "fi",
|
|
2921
|
+
/** French */
|
|
2922
|
+
Fr = "fr",
|
|
2923
|
+
/** Hebrew */
|
|
2924
|
+
He = "he",
|
|
2925
|
+
/** Hindi */
|
|
2926
|
+
Hi = "hi",
|
|
2927
|
+
/** Croatian */
|
|
2928
|
+
Hr = "hr",
|
|
2929
|
+
/** Hungarian */
|
|
2930
|
+
Hu = "hu",
|
|
2931
|
+
/** Indonesian */
|
|
2932
|
+
Id = "id",
|
|
2933
|
+
/** Icelandic */
|
|
2934
|
+
Is = "is",
|
|
2935
|
+
/** Italian */
|
|
2936
|
+
It = "it",
|
|
2937
|
+
/** Japanese */
|
|
2938
|
+
Ja = "ja",
|
|
2939
|
+
/** Korean */
|
|
2940
|
+
Ko = "ko",
|
|
2941
|
+
/** Latvian */
|
|
2942
|
+
Lv = "lv",
|
|
2943
|
+
/** Norwegian */
|
|
2944
|
+
Nb = "nb",
|
|
2945
|
+
/** Dutch */
|
|
2946
|
+
Nl = "nl",
|
|
2947
|
+
/** Polish */
|
|
2948
|
+
Pl = "pl",
|
|
2949
|
+
/** Portuguese (Portugal) */
|
|
2950
|
+
Pt = "pt",
|
|
2951
|
+
/** Portuguese (Brazil) */
|
|
2952
|
+
PtBr = "pt-br",
|
|
2953
|
+
/** Russian */
|
|
2954
|
+
Ru = "ru",
|
|
2955
|
+
/** Slovak */
|
|
2956
|
+
Sk = "sk",
|
|
2957
|
+
/** Slovenian */
|
|
2958
|
+
Sl = "sl",
|
|
2959
|
+
/** Serbian */
|
|
2960
|
+
Sr = "sr",
|
|
2961
|
+
/** Swedish */
|
|
2962
|
+
Sv = "sv",
|
|
2963
|
+
/** Turkish */
|
|
2964
|
+
Tr = "tr",
|
|
2965
|
+
/** Urdu */
|
|
2966
|
+
Ur = "ur",
|
|
2967
|
+
/** Chinese (Simplified) */
|
|
2968
|
+
Zh = "zh"
|
|
2969
|
+
}
|
|
2970
|
+
/**
|
|
2971
|
+
* The language codes supported for input text by SplitSkill. \
|
|
2972
|
+
* {@link KnownSplitSkillLanguage} can be used interchangeably with SplitSkillLanguage,
|
|
2973
|
+
* this enum contains the known values that the service supports.
|
|
2974
|
+
* ### Known values supported by the service
|
|
2975
|
+
* **am**: Amharic \
|
|
2976
|
+
* **bs**: Bosnian \
|
|
2977
|
+
* **cs**: Czech \
|
|
2978
|
+
* **da**: Danish \
|
|
2979
|
+
* **de**: German \
|
|
2980
|
+
* **en**: English \
|
|
2981
|
+
* **es**: Spanish \
|
|
2982
|
+
* **et**: Estonian \
|
|
2983
|
+
* **fi**: Finnish \
|
|
2984
|
+
* **fr**: French \
|
|
2985
|
+
* **he**: Hebrew \
|
|
2986
|
+
* **hi**: Hindi \
|
|
2987
|
+
* **hr**: Croatian \
|
|
2988
|
+
* **hu**: Hungarian \
|
|
2989
|
+
* **id**: Indonesian \
|
|
2990
|
+
* **is**: Icelandic \
|
|
2991
|
+
* **it**: Italian \
|
|
2992
|
+
* **ja**: Japanese \
|
|
2993
|
+
* **ko**: Korean \
|
|
2994
|
+
* **lv**: Latvian \
|
|
2995
|
+
* **nb**: Norwegian \
|
|
2996
|
+
* **nl**: Dutch \
|
|
2997
|
+
* **pl**: Polish \
|
|
2998
|
+
* **pt**: Portuguese (Portugal) \
|
|
2999
|
+
* **pt-br**: Portuguese (Brazil) \
|
|
3000
|
+
* **ru**: Russian \
|
|
3001
|
+
* **sk**: Slovak \
|
|
3002
|
+
* **sl**: Slovenian \
|
|
3003
|
+
* **sr**: Serbian \
|
|
3004
|
+
* **sv**: Swedish \
|
|
3005
|
+
* **tr**: Turkish \
|
|
3006
|
+
* **ur**: Urdu \
|
|
3007
|
+
* **zh**: Chinese (Simplified)
|
|
3008
|
+
*/
|
|
3009
|
+
export type SplitSkillLanguage = string;
|
|
3010
|
+
/** Treat the output as a single block without any parsing. */
|
|
3011
|
+
export interface McpServerNoneOutputParsing extends McpServerOutputParsing {
|
|
3012
|
+
/** The discriminator value. */
|
|
3013
|
+
kind: "none";
|
|
3014
|
+
}
|
|
3015
|
+
export declare function mcpServerNoneOutputParsingSerializer(item: McpServerNoneOutputParsing): any;
|
|
3016
|
+
export declare function mcpServerNoneOutputParsingDeserializer(item: any): McpServerNoneOutputParsing;
|
|
3017
|
+
/** Controls how parsed MCP tool results are integrated into the final result set. */
|
|
3018
|
+
export declare enum KnownMcpServerToolInclusionMode {
|
|
3019
|
+
/** Tool results go through the reranking and aggregation pipeline alongside results from other knowledge sources. This is the default behavior. */
|
|
3020
|
+
Reranked = "reranked",
|
|
3021
|
+
/** Tool results bypass reranking and are always included in the agent context. */
|
|
3022
|
+
Always = "always"
|
|
3023
|
+
}
|
|
3024
|
+
/**
|
|
3025
|
+
* Controls how parsed MCP tool results are integrated into the final result set. \
|
|
3026
|
+
* {@link KnownMcpServerToolInclusionMode} can be used interchangeably with McpServerToolInclusionMode,
|
|
3027
|
+
* this enum contains the known values that the service supports.
|
|
3028
|
+
* ### Known values supported by the service
|
|
3029
|
+
* **reranked**: Tool results go through the reranking and aggregation pipeline alongside results from other knowledge sources. This is the default behavior. \
|
|
3030
|
+
* **always**: Tool results bypass reranking and are always included in the agent context.
|
|
3031
|
+
*/
|
|
3032
|
+
export type McpServerToolInclusionMode = string;
|
|
3033
|
+
/** Configuration for Fabric Data Agent knowledge source. */
|
|
3034
|
+
export interface FabricDataAgentKnowledgeSource extends KnowledgeSource {
|
|
3035
|
+
/** The discriminator value. */
|
|
3036
|
+
kind: "fabricDataAgent";
|
|
3037
|
+
/** The parameters for the Fabric Data Agent knowledge source. */
|
|
3038
|
+
fabricDataAgentParameters: FabricDataAgentKnowledgeSourceParameters;
|
|
3039
|
+
}
|
|
3040
|
+
export declare function fabricDataAgentKnowledgeSourceSerializer(item: FabricDataAgentKnowledgeSource): any;
|
|
3041
|
+
export declare function fabricDataAgentKnowledgeSourceDeserializer(item: any): FabricDataAgentKnowledgeSource;
|
|
3042
|
+
/** Parameters for Fabric Data Agent knowledge source. */
|
|
3043
|
+
export interface FabricDataAgentKnowledgeSourceParameters {
|
|
3044
|
+
/** Fabric workspace ID. */
|
|
3045
|
+
workspaceId: string;
|
|
3046
|
+
/** Specifies which Fabric Data Agent to access. */
|
|
3047
|
+
dataAgentId: string;
|
|
3048
|
+
}
|
|
3049
|
+
export declare function fabricDataAgentKnowledgeSourceParametersSerializer(item: FabricDataAgentKnowledgeSourceParameters): any;
|
|
3050
|
+
export declare function fabricDataAgentKnowledgeSourceParametersDeserializer(item: any): FabricDataAgentKnowledgeSourceParameters;
|
|
3051
|
+
/** Configuration for Fabric Ontology knowledge source. */
|
|
3052
|
+
export interface FabricOntologyKnowledgeSource extends KnowledgeSource {
|
|
3053
|
+
/** The discriminator value. */
|
|
3054
|
+
kind: "fabricOntology";
|
|
3055
|
+
/** The parameters for the Fabric Ontology knowledge source. */
|
|
3056
|
+
fabricOntologyParameters: FabricOntologyKnowledgeSourceParameters;
|
|
3057
|
+
}
|
|
3058
|
+
export declare function fabricOntologyKnowledgeSourceSerializer(item: FabricOntologyKnowledgeSource): any;
|
|
3059
|
+
export declare function fabricOntologyKnowledgeSourceDeserializer(item: any): FabricOntologyKnowledgeSource;
|
|
3060
|
+
/** Parameters for Fabric Ontology knowledge source. */
|
|
3061
|
+
export interface FabricOntologyKnowledgeSourceParameters {
|
|
3062
|
+
/** The Fabric workspace ID containing the ontology. */
|
|
3063
|
+
workspaceId: string;
|
|
3064
|
+
/** The ID of the ontology to use from the Fabric workspace. */
|
|
3065
|
+
ontologyId: string;
|
|
3066
|
+
}
|
|
3067
|
+
export declare function fabricOntologyKnowledgeSourceParametersSerializer(item: FabricOntologyKnowledgeSourceParameters): any;
|
|
3068
|
+
export declare function fabricOntologyKnowledgeSourceParametersDeserializer(item: any): FabricOntologyKnowledgeSourceParameters;
|
|
2356
3069
|
/** Result from listing knowledge sources. */
|
|
2357
3070
|
export interface _ListKnowledgeSourcesResult {
|
|
2358
3071
|
/** The knowledge sources in the service. */
|
|
@@ -2386,6 +3099,8 @@ export interface SearchServiceStatistics {
|
|
|
2386
3099
|
counters: ServiceCounters;
|
|
2387
3100
|
/** Service level general limits. */
|
|
2388
3101
|
limits: ServiceLimits;
|
|
3102
|
+
/** Service level indexer runtime consumption. */
|
|
3103
|
+
indexersRuntime: ServiceIndexersRuntime;
|
|
2389
3104
|
}
|
|
2390
3105
|
export declare function searchServiceStatisticsDeserializer(item: any): SearchServiceStatistics;
|
|
2391
3106
|
/** Represents service-level resource counters and quotas. */
|
|
@@ -2408,6 +3123,10 @@ export interface ServiceCounters {
|
|
|
2408
3123
|
skillsetCounter: ResourceCounter;
|
|
2409
3124
|
/** Total memory consumption of all vector indexes within the service, in bytes. */
|
|
2410
3125
|
vectorIndexSizeCounter: ResourceCounter;
|
|
3126
|
+
/** Total number of knowledge bases. */
|
|
3127
|
+
knowledgeBaseCounter: ResourceCounter;
|
|
3128
|
+
/** Total number of knowledge sources. */
|
|
3129
|
+
knowledgeSourceCounter: ResourceCounter;
|
|
2411
3130
|
}
|
|
2412
3131
|
export declare function serviceCountersDeserializer(item: any): ServiceCounters;
|
|
2413
3132
|
/** Represents a resource's usage and quota. */
|
|
@@ -2434,6 +3153,41 @@ export interface ServiceLimits {
|
|
|
2434
3153
|
maxCumulativeIndexerRuntimeSeconds?: number;
|
|
2435
3154
|
}
|
|
2436
3155
|
export declare function serviceLimitsDeserializer(item: any): ServiceLimits;
|
|
3156
|
+
/** Represents service-level indexer runtime counters. */
|
|
3157
|
+
export interface ServiceIndexersRuntime {
|
|
3158
|
+
/** Cumulative runtime of all indexers in the service from the beginningTime to endingTime, in seconds. */
|
|
3159
|
+
usedSeconds: number;
|
|
3160
|
+
/** Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds. */
|
|
3161
|
+
remainingSeconds?: number;
|
|
3162
|
+
/** Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
3163
|
+
beginningTime: Date;
|
|
3164
|
+
/** End UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
3165
|
+
endingTime: Date;
|
|
3166
|
+
}
|
|
3167
|
+
export declare function serviceIndexersRuntimeDeserializer(item: any): ServiceIndexersRuntime;
|
|
3168
|
+
/** Response from a request to retrieve stats summary of all indexes. If successful, it includes the stats of each index in the service. */
|
|
3169
|
+
export interface _ListIndexStatsSummary {
|
|
3170
|
+
/** The total count of index statistics in the service, or null if the count was not requested. */
|
|
3171
|
+
readonly count?: number;
|
|
3172
|
+
/** The Statistics summary of all indexes in the Search service. */
|
|
3173
|
+
readonly indexesStatistics: IndexStatisticsSummary[];
|
|
3174
|
+
/** The URL that can be used to fetch the next set of results. */
|
|
3175
|
+
readonly nextLink?: string;
|
|
3176
|
+
}
|
|
3177
|
+
export declare function _listIndexStatsSummaryDeserializer(item: any): _ListIndexStatsSummary;
|
|
3178
|
+
export declare function indexStatisticsSummaryArrayDeserializer(result: Array<IndexStatisticsSummary>): any[];
|
|
3179
|
+
/** Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date. */
|
|
3180
|
+
export interface IndexStatisticsSummary {
|
|
3181
|
+
/** The name of the index. */
|
|
3182
|
+
name: string;
|
|
3183
|
+
/** The number of documents in the index. */
|
|
3184
|
+
readonly documentCount: number;
|
|
3185
|
+
/** The amount of storage in bytes consumed by the index. */
|
|
3186
|
+
readonly storageSize: number;
|
|
3187
|
+
/** The amount of memory in bytes consumed by vectors in the index. */
|
|
3188
|
+
readonly vectorIndexSize: number;
|
|
3189
|
+
}
|
|
3190
|
+
export declare function indexStatisticsSummaryDeserializer(item: any): IndexStatisticsSummary;
|
|
2437
3191
|
/** Represents a datasource definition, which can be used to configure an indexer. */
|
|
2438
3192
|
export interface SearchIndexerDataSourceConnection {
|
|
2439
3193
|
/** The name of the datasource. */
|
|
@@ -2442,10 +3196,14 @@ export interface SearchIndexerDataSourceConnection {
|
|
|
2442
3196
|
description?: string;
|
|
2443
3197
|
/** The type of the datasource. */
|
|
2444
3198
|
type: SearchIndexerDataSourceType;
|
|
3199
|
+
/** A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. */
|
|
3200
|
+
readonly subType?: string;
|
|
2445
3201
|
/** The data container for the datasource. */
|
|
2446
3202
|
container: SearchIndexerDataContainer;
|
|
2447
3203
|
/** 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. */
|
|
2448
3204
|
identity?: SearchIndexerDataIdentityUnion;
|
|
3205
|
+
/** Ingestion options with various types of permission data. */
|
|
3206
|
+
indexerPermissionOptions?: IndexerPermissionOption[];
|
|
2449
3207
|
/** The data change detection policy for the datasource. */
|
|
2450
3208
|
dataChangeDetectionPolicy?: DataChangeDetectionPolicyUnion;
|
|
2451
3209
|
/** The data deletion detection policy for the datasource. */
|
|
@@ -2509,6 +3267,25 @@ export interface SearchIndexerDataContainer {
|
|
|
2509
3267
|
}
|
|
2510
3268
|
export declare function searchIndexerDataContainerSerializer(item: SearchIndexerDataContainer): any;
|
|
2511
3269
|
export declare function searchIndexerDataContainerDeserializer(item: any): SearchIndexerDataContainer;
|
|
3270
|
+
/** Options with various types of permission data to index. */
|
|
3271
|
+
export declare enum KnownIndexerPermissionOption {
|
|
3272
|
+
/** Indexer to ingest ACL userIds from data source to index. */
|
|
3273
|
+
UserIds = "userIds",
|
|
3274
|
+
/** Indexer to ingest ACL groupIds from data source to index. */
|
|
3275
|
+
GroupIds = "groupIds",
|
|
3276
|
+
/** Indexer to ingest Azure RBAC scope from data source to index. */
|
|
3277
|
+
RbacScope = "rbacScope"
|
|
3278
|
+
}
|
|
3279
|
+
/**
|
|
3280
|
+
* Options with various types of permission data to index. \
|
|
3281
|
+
* {@link KnownIndexerPermissionOption} can be used interchangeably with IndexerPermissionOption,
|
|
3282
|
+
* this enum contains the known values that the service supports.
|
|
3283
|
+
* ### Known values supported by the service
|
|
3284
|
+
* **userIds**: Indexer to ingest ACL userIds from data source to index. \
|
|
3285
|
+
* **groupIds**: Indexer to ingest ACL groupIds from data source to index. \
|
|
3286
|
+
* **rbacScope**: Indexer to ingest Azure RBAC scope from data source to index.
|
|
3287
|
+
*/
|
|
3288
|
+
export type IndexerPermissionOption = string;
|
|
2512
3289
|
/** Base type for data change detection policies. */
|
|
2513
3290
|
export interface DataChangeDetectionPolicy {
|
|
2514
3291
|
/** The discriminator for derived types. */
|
|
@@ -2575,6 +3352,33 @@ export interface ListDataSourcesResult {
|
|
|
2575
3352
|
export declare function listDataSourcesResultDeserializer(item: any): ListDataSourcesResult;
|
|
2576
3353
|
export declare function searchIndexerDataSourceConnectionArraySerializer(result: Array<SearchIndexerDataSourceConnection>): any[];
|
|
2577
3354
|
export declare function searchIndexerDataSourceConnectionArrayDeserializer(result: Array<SearchIndexerDataSourceConnection>): any[];
|
|
3355
|
+
/** Request body for resync indexer operation. */
|
|
3356
|
+
export interface IndexerResyncBody {
|
|
3357
|
+
/** Re-sync options that have been pre-defined from data source. */
|
|
3358
|
+
options?: IndexerResyncOption[];
|
|
3359
|
+
}
|
|
3360
|
+
export declare function indexerResyncBodySerializer(item: IndexerResyncBody): any;
|
|
3361
|
+
/** Options with various types of permission data to index. */
|
|
3362
|
+
export declare enum KnownIndexerResyncOption {
|
|
3363
|
+
/** Indexer to re-ingest pre-selected permissions data from data source to index. */
|
|
3364
|
+
Permissions = "permissions"
|
|
3365
|
+
}
|
|
3366
|
+
/**
|
|
3367
|
+
* Options with various types of permission data to index. \
|
|
3368
|
+
* {@link KnownIndexerResyncOption} can be used interchangeably with IndexerResyncOption,
|
|
3369
|
+
* this enum contains the known values that the service supports.
|
|
3370
|
+
* ### Known values supported by the service
|
|
3371
|
+
* **permissions**: Indexer to re-ingest pre-selected permissions data from data source to index.
|
|
3372
|
+
*/
|
|
3373
|
+
export type IndexerResyncOption = string;
|
|
3374
|
+
/** The type of the keysOrIds. */
|
|
3375
|
+
export interface DocumentKeysOrIds {
|
|
3376
|
+
/** document keys to be reset */
|
|
3377
|
+
documentKeys?: string[];
|
|
3378
|
+
/** datasource document identifiers to be reset */
|
|
3379
|
+
dataSourceDocumentIds?: string[];
|
|
3380
|
+
}
|
|
3381
|
+
export declare function documentKeysOrIdsSerializer(item: DocumentKeysOrIds): any;
|
|
2578
3382
|
/** Represents an indexer. */
|
|
2579
3383
|
export interface SearchIndexer {
|
|
2580
3384
|
/** The name of the indexer. */
|
|
@@ -2601,6 +3405,8 @@ export interface SearchIndexer {
|
|
|
2601
3405
|
eTag?: string;
|
|
2602
3406
|
/** 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. */
|
|
2603
3407
|
encryptionKey?: SearchResourceEncryptionKey;
|
|
3408
|
+
/** Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. */
|
|
3409
|
+
cache?: SearchIndexerCache;
|
|
2604
3410
|
}
|
|
2605
3411
|
export declare function searchIndexerSerializer(item: SearchIndexer): any;
|
|
2606
3412
|
export declare function searchIndexerDeserializer(item: any): SearchIndexer;
|
|
@@ -2827,6 +3633,19 @@ export interface FieldMappingFunction {
|
|
|
2827
3633
|
}
|
|
2828
3634
|
export declare function fieldMappingFunctionSerializer(item: FieldMappingFunction): any;
|
|
2829
3635
|
export declare function fieldMappingFunctionDeserializer(item: any): FieldMappingFunction;
|
|
3636
|
+
/** The type of the cache. */
|
|
3637
|
+
export interface SearchIndexerCache {
|
|
3638
|
+
/** A guid for the SearchIndexerCache. */
|
|
3639
|
+
id?: string;
|
|
3640
|
+
/** The connection string to the storage account where the cache data will be persisted. */
|
|
3641
|
+
storageConnectionString?: string;
|
|
3642
|
+
/** Specifies whether incremental reprocessing is enabled. */
|
|
3643
|
+
enableReprocessing?: boolean;
|
|
3644
|
+
/** 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. */
|
|
3645
|
+
identity?: SearchIndexerDataIdentityUnion;
|
|
3646
|
+
}
|
|
3647
|
+
export declare function searchIndexerCacheSerializer(item: SearchIndexerCache): any;
|
|
3648
|
+
export declare function searchIndexerCacheDeserializer(item: any): SearchIndexerCache;
|
|
2830
3649
|
/** Response from a List Indexers request. If successful, it includes the full definitions of all indexers. */
|
|
2831
3650
|
export interface ListIndexersResult {
|
|
2832
3651
|
/** The indexers in the Search service. */
|
|
@@ -2841,20 +3660,40 @@ export interface SearchIndexerStatus {
|
|
|
2841
3660
|
readonly name: string;
|
|
2842
3661
|
/** Overall indexer status. */
|
|
2843
3662
|
readonly status: IndexerStatus;
|
|
3663
|
+
/** Snapshot of the indexer's cumulative runtime consumption for the service over the current UTC period. */
|
|
3664
|
+
readonly runtime: IndexerRuntime;
|
|
2844
3665
|
/** The result of the most recent or an in-progress indexer execution. */
|
|
2845
3666
|
readonly lastResult?: IndexerExecutionResult;
|
|
2846
3667
|
/** History of the recent indexer executions, sorted in reverse chronological order. */
|
|
2847
3668
|
readonly executionHistory: IndexerExecutionResult[];
|
|
2848
3669
|
/** The execution limits for the indexer. */
|
|
2849
3670
|
readonly limits: SearchIndexerLimits;
|
|
3671
|
+
/** All of the state that defines and dictates the indexer's current execution. */
|
|
3672
|
+
readonly currentState?: IndexerCurrentState;
|
|
2850
3673
|
}
|
|
2851
3674
|
export declare function searchIndexerStatusDeserializer(item: any): SearchIndexerStatus;
|
|
2852
3675
|
/** Represents the overall indexer status. */
|
|
2853
3676
|
export type IndexerStatus = "unknown" | "error" | "running";
|
|
3677
|
+
/** Represents the indexer's cumulative runtime consumption in the service. */
|
|
3678
|
+
export interface IndexerRuntime {
|
|
3679
|
+
/** Cumulative runtime of the indexer from the beginningTime to endingTime, in seconds. */
|
|
3680
|
+
usedSeconds: number;
|
|
3681
|
+
/** Cumulative runtime remaining for all indexers in the service from the beginningTime to endingTime, in seconds. */
|
|
3682
|
+
remainingSeconds?: number;
|
|
3683
|
+
/** Beginning UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
3684
|
+
beginningTime: Date;
|
|
3685
|
+
/** End UTC time of the 24-hour period considered for indexer runtime usage (inclusive). */
|
|
3686
|
+
endingTime: Date;
|
|
3687
|
+
}
|
|
3688
|
+
export declare function indexerRuntimeDeserializer(item: any): IndexerRuntime;
|
|
2854
3689
|
/** Represents the result of an individual indexer execution. */
|
|
2855
3690
|
export interface IndexerExecutionResult {
|
|
2856
3691
|
/** The outcome of this indexer execution. */
|
|
2857
3692
|
readonly status: IndexerExecutionStatus;
|
|
3693
|
+
/** The outcome of this indexer execution. */
|
|
3694
|
+
readonly statusDetail?: IndexerExecutionStatusDetail;
|
|
3695
|
+
/** The mode the indexer is running in. */
|
|
3696
|
+
readonly mode?: IndexingMode;
|
|
2858
3697
|
/** The error message indicating the top-level error, if any. */
|
|
2859
3698
|
readonly errorMessage?: string;
|
|
2860
3699
|
/** The start time of this indexer execution. */
|
|
@@ -2877,6 +3716,41 @@ export interface IndexerExecutionResult {
|
|
|
2877
3716
|
export declare function indexerExecutionResultDeserializer(item: any): IndexerExecutionResult;
|
|
2878
3717
|
/** Represents the status of an individual indexer execution. */
|
|
2879
3718
|
export type IndexerExecutionStatus = "transientFailure" | "success" | "inProgress" | "reset";
|
|
3719
|
+
/** Details the status of an individual indexer execution. */
|
|
3720
|
+
export declare enum KnownIndexerExecutionStatusDetail {
|
|
3721
|
+
/** Indicates that the reset that occurred was for a call to ResetDocs. */
|
|
3722
|
+
ResetDocs = "resetDocs",
|
|
3723
|
+
/** Indicates to selectively resync based on option(s) from data source. */
|
|
3724
|
+
Resync = "resync"
|
|
3725
|
+
}
|
|
3726
|
+
/**
|
|
3727
|
+
* Details the status of an individual indexer execution. \
|
|
3728
|
+
* {@link KnownIndexerExecutionStatusDetail} can be used interchangeably with IndexerExecutionStatusDetail,
|
|
3729
|
+
* this enum contains the known values that the service supports.
|
|
3730
|
+
* ### Known values supported by the service
|
|
3731
|
+
* **resetDocs**: Indicates that the reset that occurred was for a call to ResetDocs. \
|
|
3732
|
+
* **resync**: Indicates to selectively resync based on option(s) from data source.
|
|
3733
|
+
*/
|
|
3734
|
+
export type IndexerExecutionStatusDetail = string;
|
|
3735
|
+
/** Represents the mode the indexer is executing in. */
|
|
3736
|
+
export declare enum KnownIndexingMode {
|
|
3737
|
+
/** The indexer is indexing all documents in the datasource. */
|
|
3738
|
+
IndexingAllDocs = "indexingAllDocs",
|
|
3739
|
+
/** The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. */
|
|
3740
|
+
IndexingResetDocs = "indexingResetDocs",
|
|
3741
|
+
/** The indexer is resyncing and indexing selective option(s) from the datasource. */
|
|
3742
|
+
IndexingResync = "indexingResync"
|
|
3743
|
+
}
|
|
3744
|
+
/**
|
|
3745
|
+
* Represents the mode the indexer is executing in. \
|
|
3746
|
+
* {@link KnownIndexingMode} can be used interchangeably with IndexingMode,
|
|
3747
|
+
* this enum contains the known values that the service supports.
|
|
3748
|
+
* ### Known values supported by the service
|
|
3749
|
+
* **indexingAllDocs**: The indexer is indexing all documents in the datasource. \
|
|
3750
|
+
* **indexingResetDocs**: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. \
|
|
3751
|
+
* **indexingResync**: The indexer is resyncing and indexing selective option(s) from the datasource.
|
|
3752
|
+
*/
|
|
3753
|
+
export type IndexingMode = string;
|
|
2880
3754
|
export declare function searchIndexerErrorArrayDeserializer(result: Array<SearchIndexerError>): any[];
|
|
2881
3755
|
/** Represents an item- or document-level indexing error. */
|
|
2882
3756
|
export interface SearchIndexerError {
|
|
@@ -2920,6 +3794,28 @@ export interface SearchIndexerLimits {
|
|
|
2920
3794
|
readonly maxDocumentContentCharactersToExtract?: number;
|
|
2921
3795
|
}
|
|
2922
3796
|
export declare function searchIndexerLimitsDeserializer(item: any): SearchIndexerLimits;
|
|
3797
|
+
/** Represents all of the state that defines and dictates the indexer's current execution. */
|
|
3798
|
+
export interface IndexerCurrentState {
|
|
3799
|
+
/** The mode the indexer is running in. */
|
|
3800
|
+
readonly mode?: IndexingMode;
|
|
3801
|
+
/** Change tracking state used when indexing starts on all documents in the datasource. */
|
|
3802
|
+
readonly allDocsInitialTrackingState?: string;
|
|
3803
|
+
/** Change tracking state value when indexing finishes on all documents in the datasource. */
|
|
3804
|
+
readonly allDocsFinalTrackingState?: string;
|
|
3805
|
+
/** Change tracking state used when indexing starts on select, reset documents in the datasource. */
|
|
3806
|
+
readonly resetDocsInitialTrackingState?: string;
|
|
3807
|
+
/** Change tracking state value when indexing finishes on select, reset documents in the datasource. */
|
|
3808
|
+
readonly resetDocsFinalTrackingState?: string;
|
|
3809
|
+
/** Change tracking state used when indexing starts on selective options from the datasource. */
|
|
3810
|
+
readonly resyncInitialTrackingState?: string;
|
|
3811
|
+
/** Change tracking state value when indexing finishes on selective options from the datasource. */
|
|
3812
|
+
readonly resyncFinalTrackingState?: string;
|
|
3813
|
+
/** 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. */
|
|
3814
|
+
readonly resetDocumentKeys?: string[];
|
|
3815
|
+
/** 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. */
|
|
3816
|
+
readonly resetDatasourceDocumentIds?: string[];
|
|
3817
|
+
}
|
|
3818
|
+
export declare function indexerCurrentStateDeserializer(item: any): IndexerCurrentState;
|
|
2923
3819
|
/** A list of skills. */
|
|
2924
3820
|
export interface SearchIndexerSkillset {
|
|
2925
3821
|
/** The name of the skillset. */
|
|
@@ -2946,7 +3842,7 @@ export declare function searchIndexerSkillUnionArrayDeserializer(result: Array<S
|
|
|
2946
3842
|
/** Base type for skills. */
|
|
2947
3843
|
export interface SearchIndexerSkill {
|
|
2948
3844
|
/** The discriminator for derived types. */
|
|
2949
|
-
/** The discriminator possible values: #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.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, #Microsoft.Skills.Util.ContentUnderstandingSkill, #Microsoft.Skills.Custom.ChatCompletionSkill */
|
|
3845
|
+
/** The discriminator possible values: #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.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.AmlSkill, #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill, #Microsoft.Skills.Vision.VectorizeSkill, #Microsoft.Skills.Util.ContentUnderstandingSkill, #Microsoft.Skills.Custom.ChatCompletionSkill */
|
|
2950
3846
|
odatatype: string;
|
|
2951
3847
|
/** 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 '#'. */
|
|
2952
3848
|
name?: string;
|
|
@@ -2962,7 +3858,7 @@ export interface SearchIndexerSkill {
|
|
|
2962
3858
|
export declare function searchIndexerSkillSerializer(item: SearchIndexerSkill): any;
|
|
2963
3859
|
export declare function searchIndexerSkillDeserializer(item: any): SearchIndexerSkill;
|
|
2964
3860
|
/** Alias for SearchIndexerSkillUnion */
|
|
2965
|
-
export type SearchIndexerSkillUnion = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | SentimentSkillV3 | EntityLinkingSkill | EntityRecognitionSkillV3 | PIIDetectionSkill | SplitSkill | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill | WebApiSkill | AzureOpenAIEmbeddingSkill | ContentUnderstandingSkill | ChatCompletionSkill | SearchIndexerSkill;
|
|
3861
|
+
export type SearchIndexerSkillUnion = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | SentimentSkillV3 | EntityLinkingSkill | EntityRecognitionSkillV3 | PIIDetectionSkill | SplitSkill | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | DocumentIntelligenceLayoutSkill | WebApiSkill | AzureMachineLearningSkill | AzureOpenAIEmbeddingSkill | VisionVectorizeSkill | ContentUnderstandingSkill | ChatCompletionSkill | SearchIndexerSkill;
|
|
2966
3862
|
export declare function searchIndexerSkillUnionSerializer(item: SearchIndexerSkillUnion): any;
|
|
2967
3863
|
export declare function searchIndexerSkillUnionDeserializer(item: any): SearchIndexerSkillUnion;
|
|
2968
3864
|
export declare function inputFieldMappingEntryArraySerializer(result: Array<InputFieldMappingEntry>): any[];
|
|
@@ -4134,136 +5030,62 @@ export interface SplitSkill extends SearchIndexerSkill {
|
|
|
4134
5030
|
pageOverlapLength?: number;
|
|
4135
5031
|
/** 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. */
|
|
4136
5032
|
maximumPagesToTake?: number;
|
|
5033
|
+
/** 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. */
|
|
5034
|
+
unit?: SplitSkillUnit;
|
|
5035
|
+
/** 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. */
|
|
5036
|
+
azureOpenAITokenizerParameters?: AzureOpenAITokenizerParameters;
|
|
4137
5037
|
/** A URI fragment specifying the type of skill. */
|
|
4138
5038
|
odatatype: "#Microsoft.Skills.Text.SplitSkill";
|
|
4139
5039
|
}
|
|
4140
5040
|
export declare function splitSkillSerializer(item: SplitSkill): any;
|
|
4141
5041
|
export declare function splitSkillDeserializer(item: any): SplitSkill;
|
|
4142
|
-
/**
|
|
4143
|
-
export declare enum
|
|
4144
|
-
/**
|
|
4145
|
-
|
|
4146
|
-
/**
|
|
4147
|
-
|
|
4148
|
-
/** Czech */
|
|
4149
|
-
Cs = "cs",
|
|
4150
|
-
/** Danish */
|
|
4151
|
-
Da = "da",
|
|
4152
|
-
/** German */
|
|
4153
|
-
De = "de",
|
|
4154
|
-
/** English */
|
|
4155
|
-
En = "en",
|
|
4156
|
-
/** Spanish */
|
|
4157
|
-
Es = "es",
|
|
4158
|
-
/** Estonian */
|
|
4159
|
-
Et = "et",
|
|
4160
|
-
/** Finnish */
|
|
4161
|
-
Fi = "fi",
|
|
4162
|
-
/** French */
|
|
4163
|
-
Fr = "fr",
|
|
4164
|
-
/** Hebrew */
|
|
4165
|
-
He = "he",
|
|
4166
|
-
/** Hindi */
|
|
4167
|
-
Hi = "hi",
|
|
4168
|
-
/** Croatian */
|
|
4169
|
-
Hr = "hr",
|
|
4170
|
-
/** Hungarian */
|
|
4171
|
-
Hu = "hu",
|
|
4172
|
-
/** Indonesian */
|
|
4173
|
-
Id = "id",
|
|
4174
|
-
/** Icelandic */
|
|
4175
|
-
Is = "is",
|
|
4176
|
-
/** Italian */
|
|
4177
|
-
It = "it",
|
|
4178
|
-
/** Japanese */
|
|
4179
|
-
Ja = "ja",
|
|
4180
|
-
/** Korean */
|
|
4181
|
-
Ko = "ko",
|
|
4182
|
-
/** Latvian */
|
|
4183
|
-
Lv = "lv",
|
|
4184
|
-
/** Norwegian */
|
|
4185
|
-
Nb = "nb",
|
|
4186
|
-
/** Dutch */
|
|
4187
|
-
Nl = "nl",
|
|
4188
|
-
/** Polish */
|
|
4189
|
-
Pl = "pl",
|
|
4190
|
-
/** Portuguese (Portugal) */
|
|
4191
|
-
Pt = "pt",
|
|
4192
|
-
/** Portuguese (Brazil) */
|
|
4193
|
-
PtBr = "pt-br",
|
|
4194
|
-
/** Russian */
|
|
4195
|
-
Ru = "ru",
|
|
4196
|
-
/** Slovak */
|
|
4197
|
-
Sk = "sk",
|
|
4198
|
-
/** Slovenian */
|
|
4199
|
-
Sl = "sl",
|
|
4200
|
-
/** Serbian */
|
|
4201
|
-
Sr = "sr",
|
|
4202
|
-
/** Swedish */
|
|
4203
|
-
Sv = "sv",
|
|
4204
|
-
/** Turkish */
|
|
4205
|
-
Tr = "tr",
|
|
4206
|
-
/** Urdu */
|
|
4207
|
-
Ur = "ur",
|
|
4208
|
-
/** Chinese (Simplified) */
|
|
4209
|
-
Zh = "zh"
|
|
5042
|
+
/** A value indicating which unit to use. */
|
|
5043
|
+
export declare enum KnownSplitSkillUnit {
|
|
5044
|
+
/** The length will be measured by character. */
|
|
5045
|
+
Characters = "characters",
|
|
5046
|
+
/** The length will be measured by an AzureOpenAI tokenizer from the tiktoken library. */
|
|
5047
|
+
AzureOpenAITokens = "azureOpenAITokens"
|
|
4210
5048
|
}
|
|
4211
5049
|
/**
|
|
4212
|
-
*
|
|
4213
|
-
* {@link
|
|
5050
|
+
* A value indicating which unit to use. \
|
|
5051
|
+
* {@link KnownSplitSkillUnit} can be used interchangeably with SplitSkillUnit,
|
|
4214
5052
|
* this enum contains the known values that the service supports.
|
|
4215
5053
|
* ### Known values supported by the service
|
|
4216
|
-
* **
|
|
4217
|
-
* **
|
|
4218
|
-
* **cs**: Czech \
|
|
4219
|
-
* **da**: Danish \
|
|
4220
|
-
* **de**: German \
|
|
4221
|
-
* **en**: English \
|
|
4222
|
-
* **es**: Spanish \
|
|
4223
|
-
* **et**: Estonian \
|
|
4224
|
-
* **fi**: Finnish \
|
|
4225
|
-
* **fr**: French \
|
|
4226
|
-
* **he**: Hebrew \
|
|
4227
|
-
* **hi**: Hindi \
|
|
4228
|
-
* **hr**: Croatian \
|
|
4229
|
-
* **hu**: Hungarian \
|
|
4230
|
-
* **id**: Indonesian \
|
|
4231
|
-
* **is**: Icelandic \
|
|
4232
|
-
* **it**: Italian \
|
|
4233
|
-
* **ja**: Japanese \
|
|
4234
|
-
* **ko**: Korean \
|
|
4235
|
-
* **lv**: Latvian \
|
|
4236
|
-
* **nb**: Norwegian \
|
|
4237
|
-
* **nl**: Dutch \
|
|
4238
|
-
* **pl**: Polish \
|
|
4239
|
-
* **pt**: Portuguese (Portugal) \
|
|
4240
|
-
* **pt-br**: Portuguese (Brazil) \
|
|
4241
|
-
* **ru**: Russian \
|
|
4242
|
-
* **sk**: Slovak \
|
|
4243
|
-
* **sl**: Slovenian \
|
|
4244
|
-
* **sr**: Serbian \
|
|
4245
|
-
* **sv**: Swedish \
|
|
4246
|
-
* **tr**: Turkish \
|
|
4247
|
-
* **ur**: Urdu \
|
|
4248
|
-
* **zh**: Chinese (Simplified)
|
|
5054
|
+
* **characters**: The length will be measured by character. \
|
|
5055
|
+
* **azureOpenAITokens**: The length will be measured by an AzureOpenAI tokenizer from the tiktoken library.
|
|
4249
5056
|
*/
|
|
4250
|
-
export type
|
|
4251
|
-
/**
|
|
4252
|
-
export
|
|
4253
|
-
/**
|
|
4254
|
-
|
|
4255
|
-
/**
|
|
4256
|
-
|
|
5057
|
+
export type SplitSkillUnit = string;
|
|
5058
|
+
/** Azure OpenAI Tokenizer parameters. */
|
|
5059
|
+
export interface AzureOpenAITokenizerParameters {
|
|
5060
|
+
/** 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'. */
|
|
5061
|
+
encoderModelName?: SplitSkillEncoderModelName;
|
|
5062
|
+
/** (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. */
|
|
5063
|
+
allowedSpecialTokens?: string[];
|
|
5064
|
+
}
|
|
5065
|
+
export declare function azureOpenAITokenizerParametersSerializer(item: AzureOpenAITokenizerParameters): any;
|
|
5066
|
+
export declare function azureOpenAITokenizerParametersDeserializer(item: any): AzureOpenAITokenizerParameters;
|
|
5067
|
+
/** A value indicating which tokenizer to use. */
|
|
5068
|
+
export declare enum KnownSplitSkillEncoderModelName {
|
|
5069
|
+
/** Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks. */
|
|
5070
|
+
R50KBase = "r50k_base",
|
|
5071
|
+
/** A base model with a 50,000 token vocabulary, optimized for prompt-based tasks. */
|
|
5072
|
+
P50KBase = "p50k_base",
|
|
5073
|
+
/** Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary. */
|
|
5074
|
+
P50KEdit = "p50k_edit",
|
|
5075
|
+
/** A base model with a 100,000 token vocabulary. */
|
|
5076
|
+
CL100KBase = "cl100k_base"
|
|
4257
5077
|
}
|
|
4258
5078
|
/**
|
|
4259
|
-
* A value indicating which
|
|
4260
|
-
* {@link
|
|
5079
|
+
* A value indicating which tokenizer to use. \
|
|
5080
|
+
* {@link KnownSplitSkillEncoderModelName} can be used interchangeably with SplitSkillEncoderModelName,
|
|
4261
5081
|
* this enum contains the known values that the service supports.
|
|
4262
5082
|
* ### Known values supported by the service
|
|
4263
|
-
* **
|
|
4264
|
-
* **
|
|
5083
|
+
* **r50k_base**: Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks. \
|
|
5084
|
+
* **p50k_base**: A base model with a 50,000 token vocabulary, optimized for prompt-based tasks. \
|
|
5085
|
+
* **p50k_edit**: Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary. \
|
|
5086
|
+
* **cl100k_base**: A base model with a 100,000 token vocabulary.
|
|
4265
5087
|
*/
|
|
4266
|
-
export type
|
|
5088
|
+
export type SplitSkillEncoderModelName = string;
|
|
4267
5089
|
/** A skill looks for text from a custom, user-defined list of words and phrases. */
|
|
4268
5090
|
export interface CustomEntityLookupSkill extends SearchIndexerSkill {
|
|
4269
5091
|
/** A value indicating which language code to use. Default is `en`. */
|
|
@@ -4762,6 +5584,25 @@ export interface WebApiHttpHeaders {
|
|
|
4762
5584
|
}
|
|
4763
5585
|
export declare function webApiHttpHeadersSerializer(item: WebApiHttpHeaders): any;
|
|
4764
5586
|
export declare function webApiHttpHeadersDeserializer(item: any): WebApiHttpHeaders;
|
|
5587
|
+
/** 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. */
|
|
5588
|
+
export interface AzureMachineLearningSkill extends SearchIndexerSkill {
|
|
5589
|
+
/** (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. */
|
|
5590
|
+
scoringUri?: string;
|
|
5591
|
+
/** (Required for key authentication) The key for the AML service. */
|
|
5592
|
+
authenticationKey?: string;
|
|
5593
|
+
/** (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}. */
|
|
5594
|
+
resourceId?: string;
|
|
5595
|
+
/** (Optional) When specified, indicates the timeout for the http client making the API call. */
|
|
5596
|
+
timeout?: string;
|
|
5597
|
+
/** (Optional for token authentication). The region the AML service is deployed in. */
|
|
5598
|
+
region?: string;
|
|
5599
|
+
/** (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. */
|
|
5600
|
+
degreeOfParallelism?: number;
|
|
5601
|
+
/** A URI fragment specifying the type of skill. */
|
|
5602
|
+
odatatype: "#Microsoft.Skills.Custom.AmlSkill";
|
|
5603
|
+
}
|
|
5604
|
+
export declare function azureMachineLearningSkillSerializer(item: AzureMachineLearningSkill): any;
|
|
5605
|
+
export declare function azureMachineLearningSkillDeserializer(item: any): AzureMachineLearningSkill;
|
|
4765
5606
|
/** Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource. */
|
|
4766
5607
|
export interface AzureOpenAIEmbeddingSkill extends SearchIndexerSkill {
|
|
4767
5608
|
/** The resource URI of the Azure OpenAI resource. */
|
|
@@ -4781,6 +5622,15 @@ export interface AzureOpenAIEmbeddingSkill extends SearchIndexerSkill {
|
|
|
4781
5622
|
}
|
|
4782
5623
|
export declare function azureOpenAIEmbeddingSkillSerializer(item: AzureOpenAIEmbeddingSkill): any;
|
|
4783
5624
|
export declare function azureOpenAIEmbeddingSkillDeserializer(item: any): AzureOpenAIEmbeddingSkill;
|
|
5625
|
+
/** Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API. */
|
|
5626
|
+
export interface VisionVectorizeSkill extends SearchIndexerSkill {
|
|
5627
|
+
/** The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified. */
|
|
5628
|
+
modelVersion: string | null;
|
|
5629
|
+
/** A URI fragment specifying the type of skill. */
|
|
5630
|
+
odatatype: "#Microsoft.Skills.Vision.VectorizeSkill";
|
|
5631
|
+
}
|
|
5632
|
+
export declare function visionVectorizeSkillSerializer(item: VisionVectorizeSkill): any;
|
|
5633
|
+
export declare function visionVectorizeSkillDeserializer(item: any): VisionVectorizeSkill;
|
|
4784
5634
|
/** 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. */
|
|
4785
5635
|
export interface ContentUnderstandingSkill extends SearchIndexerSkill {
|
|
4786
5636
|
/** Controls the cardinality of the content extracted from the document by the skill. */
|
|
@@ -4810,6 +5660,8 @@ export declare enum KnownContentUnderstandingSkillExtractionOptions {
|
|
|
4810
5660
|
export type ContentUnderstandingSkillExtractionOptions = string;
|
|
4811
5661
|
/** Controls the cardinality for chunking the content. */
|
|
4812
5662
|
export interface ContentUnderstandingSkillChunkingProperties {
|
|
5663
|
+
/** The chunking strategy. 'fixedSize' (default) or 'semantic'. */
|
|
5664
|
+
method?: ContentUnderstandingSkillChunkingMethod;
|
|
4813
5665
|
/** The unit of the chunk. */
|
|
4814
5666
|
unit?: ContentUnderstandingSkillChunkingUnit;
|
|
4815
5667
|
/** The maximum chunk length in characters. Default is 500. */
|
|
@@ -4822,14 +5674,17 @@ export declare function contentUnderstandingSkillChunkingPropertiesDeserializer(
|
|
|
4822
5674
|
/** Controls the cardinality of the chunk unit. Default is 'characters' */
|
|
4823
5675
|
export declare enum KnownContentUnderstandingSkillChunkingUnit {
|
|
4824
5676
|
/** Specifies chunk by characters. */
|
|
4825
|
-
Characters = "characters"
|
|
5677
|
+
Characters = "characters",
|
|
5678
|
+
/** Specifies chunk by tokens. */
|
|
5679
|
+
Tokens = "tokens"
|
|
4826
5680
|
}
|
|
4827
5681
|
/**
|
|
4828
5682
|
* Controls the cardinality of the chunk unit. Default is 'characters' \
|
|
4829
5683
|
* {@link KnownContentUnderstandingSkillChunkingUnit} can be used interchangeably with ContentUnderstandingSkillChunkingUnit,
|
|
4830
5684
|
* this enum contains the known values that the service supports.
|
|
4831
5685
|
* ### Known values supported by the service
|
|
4832
|
-
* **characters**: Specifies chunk by characters.
|
|
5686
|
+
* **characters**: Specifies chunk by characters. \
|
|
5687
|
+
* **tokens**: Specifies chunk by tokens.
|
|
4833
5688
|
*/
|
|
4834
5689
|
export type ContentUnderstandingSkillChunkingUnit = string;
|
|
4835
5690
|
/** A skill that calls a language model via Azure AI Foundry's Chat Completions endpoint. */
|
|
@@ -5005,6 +5860,8 @@ export interface SearchIndexerKnowledgeStore {
|
|
|
5005
5860
|
projections: SearchIndexerKnowledgeStoreProjection[];
|
|
5006
5861
|
/** 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. */
|
|
5007
5862
|
identity?: SearchIndexerDataIdentityUnion;
|
|
5863
|
+
/** 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. */
|
|
5864
|
+
parameters?: SearchIndexerKnowledgeStoreParameters;
|
|
5008
5865
|
}
|
|
5009
5866
|
export declare function searchIndexerKnowledgeStoreSerializer(item: SearchIndexerKnowledgeStore): any;
|
|
5010
5867
|
export declare function searchIndexerKnowledgeStoreDeserializer(item: any): SearchIndexerKnowledgeStore;
|
|
@@ -5046,6 +5903,15 @@ export interface SearchIndexerKnowledgeStoreFileProjectionSelector extends Searc
|
|
|
5046
5903
|
}
|
|
5047
5904
|
export declare function searchIndexerKnowledgeStoreFileProjectionSelectorSerializer(item: SearchIndexerKnowledgeStoreFileProjectionSelector): any;
|
|
5048
5905
|
export declare function searchIndexerKnowledgeStoreFileProjectionSelectorDeserializer(item: any): SearchIndexerKnowledgeStoreFileProjectionSelector;
|
|
5906
|
+
/** 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. */
|
|
5907
|
+
export interface SearchIndexerKnowledgeStoreParameters {
|
|
5908
|
+
/** Whether or not projections should synthesize a generated key name if one isn't already present. */
|
|
5909
|
+
synthesizeGeneratedKeyName?: boolean;
|
|
5910
|
+
/** Additional properties */
|
|
5911
|
+
additionalProperties?: Record<string, any>;
|
|
5912
|
+
}
|
|
5913
|
+
export declare function searchIndexerKnowledgeStoreParametersSerializer(item: SearchIndexerKnowledgeStoreParameters): any;
|
|
5914
|
+
export declare function searchIndexerKnowledgeStoreParametersDeserializer(item: any): SearchIndexerKnowledgeStoreParameters;
|
|
5049
5915
|
/** Definition of additional projections to secondary search indexes. */
|
|
5050
5916
|
export interface SearchIndexerIndexProjection {
|
|
5051
5917
|
/** A list of projections to be performed to secondary search indexes. */
|
|
@@ -5125,33 +5991,6 @@ export interface ListSkillsetsResult {
|
|
|
5125
5991
|
export declare function listSkillsetsResultDeserializer(item: any): ListSkillsetsResult;
|
|
5126
5992
|
export declare function searchIndexerSkillsetArraySerializer(result: Array<SearchIndexerSkillset>): any[];
|
|
5127
5993
|
export declare function searchIndexerSkillsetArrayDeserializer(result: Array<SearchIndexerSkillset>): any[];
|
|
5128
|
-
/** Request body for resync indexer operation. */
|
|
5129
|
-
export interface IndexerResyncBody {
|
|
5130
|
-
/** Re-sync options that have been pre-defined from data source. */
|
|
5131
|
-
options?: IndexerResyncOption[];
|
|
5132
|
-
}
|
|
5133
|
-
export declare function indexerResyncBodySerializer(item: IndexerResyncBody): any;
|
|
5134
|
-
/** Options with various types of permission data to index. */
|
|
5135
|
-
export declare enum KnownIndexerResyncOption {
|
|
5136
|
-
/** Indexer to re-ingest pre-selected permissions data from data source to index. */
|
|
5137
|
-
Permissions = "permissions"
|
|
5138
|
-
}
|
|
5139
|
-
/**
|
|
5140
|
-
* Options with various types of permission data to index. \
|
|
5141
|
-
* {@link KnownIndexerResyncOption} can be used interchangeably with IndexerResyncOption,
|
|
5142
|
-
* this enum contains the known values that the service supports.
|
|
5143
|
-
* ### Known values supported by the service
|
|
5144
|
-
* **permissions**: Indexer to re-ingest pre-selected permissions data from data source to index.
|
|
5145
|
-
*/
|
|
5146
|
-
export type IndexerResyncOption = string;
|
|
5147
|
-
/** The type of the keysOrIds. */
|
|
5148
|
-
export interface DocumentKeysOrIds {
|
|
5149
|
-
/** document keys to be reset */
|
|
5150
|
-
documentKeys?: string[];
|
|
5151
|
-
/** datasource document identifiers to be reset */
|
|
5152
|
-
dataSourceDocumentIds?: string[];
|
|
5153
|
-
}
|
|
5154
|
-
export declare function documentKeysOrIdsSerializer(item: DocumentKeysOrIds): any;
|
|
5155
5994
|
/** The type of the skill names. */
|
|
5156
5995
|
export interface SkillNames {
|
|
5157
5996
|
/** the names of skills to be reset. */
|