@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,8 +1,76 @@
|
|
|
1
|
-
import { SearchIndexerDataIdentityUnion, VectorSearchVectorizerKind, AzureOpenAIVectorizerParameters, KnowledgeBaseModelUnion, KnowledgeSourceKind, IndexingSchedule, KnowledgeSourceContentExtractionMode, KnowledgeSourceSynchronizationStatus } from "../indexes/models.js";
|
|
1
|
+
import type { SearchIndexerDataIdentityUnion, VectorSearchVectorizerKind, AzureOpenAIVectorizerParameters, KnowledgeBaseModelUnion, KnowledgeSourceKind, SearchIndexFieldReference, IndexingSchedule, KnowledgeSourceContentExtractionMode, KnowledgeSourceSynchronizationStatus, KnowledgeSourceIngestionPermissionOption } from "../indexes/models.js";
|
|
2
2
|
/**
|
|
3
3
|
* This file contains only generated model types and their (de)serializers.
|
|
4
4
|
* Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
|
|
5
5
|
*/
|
|
6
|
+
/** Base type for reasoning effort. */
|
|
7
|
+
export interface KnowledgeRetrievalReasoningEffort {
|
|
8
|
+
/** The kind of reasoning effort. */
|
|
9
|
+
/** The discriminator possible values: minimal, low, medium */
|
|
10
|
+
kind: KnowledgeRetrievalReasoningEffortKind;
|
|
11
|
+
}
|
|
12
|
+
export declare function knowledgeRetrievalReasoningEffortSerializer(item: KnowledgeRetrievalReasoningEffort): any;
|
|
13
|
+
export declare function knowledgeRetrievalReasoningEffortDeserializer(item: any): KnowledgeRetrievalReasoningEffort;
|
|
14
|
+
/** Alias for KnowledgeRetrievalReasoningEffortUnion */
|
|
15
|
+
export type KnowledgeRetrievalReasoningEffortUnion = KnowledgeRetrievalMinimalReasoningEffort | KnowledgeRetrievalLowReasoningEffort | KnowledgeRetrievalMediumReasoningEffort | KnowledgeRetrievalReasoningEffort;
|
|
16
|
+
export declare function knowledgeRetrievalReasoningEffortUnionSerializer(item: KnowledgeRetrievalReasoningEffortUnion): any;
|
|
17
|
+
export declare function knowledgeRetrievalReasoningEffortUnionDeserializer(item: any): KnowledgeRetrievalReasoningEffortUnion;
|
|
18
|
+
/** The amount of effort to use during retrieval. */
|
|
19
|
+
export declare enum KnownKnowledgeRetrievalReasoningEffortKind {
|
|
20
|
+
/** Does not perform any source selections, query planning, or iterative search. */
|
|
21
|
+
Minimal = "minimal",
|
|
22
|
+
/** Use low reasoning during retrieval. */
|
|
23
|
+
Low = "low",
|
|
24
|
+
/** Use a moderate amount of reasoning during retrieval. */
|
|
25
|
+
Medium = "medium"
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* The amount of effort to use during retrieval. \
|
|
29
|
+
* {@link KnownKnowledgeRetrievalReasoningEffortKind} can be used interchangeably with KnowledgeRetrievalReasoningEffortKind,
|
|
30
|
+
* this enum contains the known values that the service supports.
|
|
31
|
+
* ### Known values supported by the service
|
|
32
|
+
* **minimal**: Does not perform any source selections, query planning, or iterative search. \
|
|
33
|
+
* **low**: Use low reasoning during retrieval. \
|
|
34
|
+
* **medium**: Use a moderate amount of reasoning during retrieval.
|
|
35
|
+
*/
|
|
36
|
+
export type KnowledgeRetrievalReasoningEffortKind = string;
|
|
37
|
+
/** Run knowledge retrieval with minimal reasoning effort. */
|
|
38
|
+
export interface KnowledgeRetrievalMinimalReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
39
|
+
/** The discriminator value. */
|
|
40
|
+
kind: "minimal";
|
|
41
|
+
}
|
|
42
|
+
export declare function knowledgeRetrievalMinimalReasoningEffortSerializer(item: KnowledgeRetrievalMinimalReasoningEffort): any;
|
|
43
|
+
export declare function knowledgeRetrievalMinimalReasoningEffortDeserializer(item: any): KnowledgeRetrievalMinimalReasoningEffort;
|
|
44
|
+
/** Run knowledge retrieval with low reasoning effort. */
|
|
45
|
+
export interface KnowledgeRetrievalLowReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
46
|
+
/** The discriminator value. */
|
|
47
|
+
kind: "low";
|
|
48
|
+
}
|
|
49
|
+
export declare function knowledgeRetrievalLowReasoningEffortSerializer(item: KnowledgeRetrievalLowReasoningEffort): any;
|
|
50
|
+
export declare function knowledgeRetrievalLowReasoningEffortDeserializer(item: any): KnowledgeRetrievalLowReasoningEffort;
|
|
51
|
+
/** Run knowledge retrieval with medium reasoning effort. */
|
|
52
|
+
export interface KnowledgeRetrievalMediumReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
53
|
+
/** The discriminator value. */
|
|
54
|
+
kind: "medium";
|
|
55
|
+
}
|
|
56
|
+
export declare function knowledgeRetrievalMediumReasoningEffortSerializer(item: KnowledgeRetrievalMediumReasoningEffort): any;
|
|
57
|
+
export declare function knowledgeRetrievalMediumReasoningEffortDeserializer(item: any): KnowledgeRetrievalMediumReasoningEffort;
|
|
58
|
+
/** The output configuration for this retrieval. */
|
|
59
|
+
export declare enum KnownKnowledgeRetrievalOutputMode {
|
|
60
|
+
/** Return data from the knowledge sources directly without generative alteration. */
|
|
61
|
+
ExtractiveData = "extractiveData",
|
|
62
|
+
/** Synthesize an answer for the response payload. */
|
|
63
|
+
AnswerSynthesis = "answerSynthesis"
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* The output configuration for this retrieval. \
|
|
67
|
+
* {@link KnownKnowledgeRetrievalOutputMode} can be used interchangeably with KnowledgeRetrievalOutputMode,
|
|
68
|
+
* this enum contains the known values that the service supports.
|
|
69
|
+
* ### Known values supported by the service
|
|
70
|
+
* **extractiveData**: Return data from the knowledge sources directly without generative alteration. \
|
|
71
|
+
* **answerSynthesis**: Synthesize an answer for the response payload.
|
|
72
|
+
*/
|
|
73
|
+
export type KnowledgeRetrievalOutputMode = string;
|
|
6
74
|
/** Consolidates all general ingestion settings for knowledge sources. */
|
|
7
75
|
export interface KnowledgeSourceIngestionParameters {
|
|
8
76
|
/** An explicit identity to use for this knowledge source. */
|
|
@@ -15,10 +83,16 @@ export interface KnowledgeSourceIngestionParameters {
|
|
|
15
83
|
disableImageVerbalization?: boolean;
|
|
16
84
|
/** Optional schedule for data ingestion. */
|
|
17
85
|
ingestionSchedule?: IndexingSchedule;
|
|
86
|
+
/** Optional list of permission types to ingest together with document content. If specified, it will set the indexer permission options for the data source. */
|
|
87
|
+
ingestionPermissionOptions?: KnowledgeSourceIngestionPermissionOption[];
|
|
18
88
|
/** Optional content extraction mode. Default is 'minimal'. */
|
|
19
89
|
contentExtractionMode?: KnowledgeSourceContentExtractionMode;
|
|
20
90
|
/** Optional AI Services configuration for content processing. */
|
|
21
91
|
aiServices?: AIServices;
|
|
92
|
+
/** Optional asset store configuration for storing extracted assets such as images. */
|
|
93
|
+
assetStore?: AssetStore;
|
|
94
|
+
/** Optional freshness policy for biasing retrieval toward newer documents. */
|
|
95
|
+
freshnessPolicy?: FreshnessPolicy;
|
|
22
96
|
}
|
|
23
97
|
export declare function knowledgeSourceIngestionParametersSerializer(item: KnowledgeSourceIngestionParameters): any;
|
|
24
98
|
export declare function knowledgeSourceIngestionParametersDeserializer(item: any): KnowledgeSourceIngestionParameters;
|
|
@@ -52,6 +126,22 @@ export interface AIServices {
|
|
|
52
126
|
}
|
|
53
127
|
export declare function aiServicesSerializer(item: AIServices): any;
|
|
54
128
|
export declare function aiServicesDeserializer(item: any): AIServices;
|
|
129
|
+
/** Configuration for an asset store used to store extracted assets such as images. */
|
|
130
|
+
export interface AssetStore {
|
|
131
|
+
/** The connection string for the asset store. */
|
|
132
|
+
connectionString: string;
|
|
133
|
+
/** The name of the blob container within the asset store where extracted assets (for example, images) are stored. */
|
|
134
|
+
containerName: string;
|
|
135
|
+
}
|
|
136
|
+
export declare function assetStoreSerializer(item: AssetStore): any;
|
|
137
|
+
export declare function assetStoreDeserializer(item: any): AssetStore;
|
|
138
|
+
/** Configuration for freshness-aware retrieval. When set, newer documents receive a ranking boost during retrieval. */
|
|
139
|
+
export interface FreshnessPolicy {
|
|
140
|
+
/** ISO 8601 duration for the freshness boosting window (e.g. 'P90D' for 90 days). Documents newer than this duration receive a ranking boost during retrieval. */
|
|
141
|
+
boostingDuration?: string;
|
|
142
|
+
}
|
|
143
|
+
export declare function freshnessPolicySerializer(item: FreshnessPolicy): any;
|
|
144
|
+
export declare function freshnessPolicyDeserializer(item: any): FreshnessPolicy;
|
|
55
145
|
/** Represents the status and synchronization history of a knowledge source. */
|
|
56
146
|
export interface KnowledgeSourceStatus {
|
|
57
147
|
/** Identifies the Knowledge Source kind directly from the Status response. */
|
|
@@ -131,18 +221,94 @@ export declare function knowledgeSourceStatisticsSerializer(item: KnowledgeSourc
|
|
|
131
221
|
export declare function knowledgeSourceStatisticsDeserializer(item: any): KnowledgeSourceStatistics;
|
|
132
222
|
/** The input contract for the retrieval request. */
|
|
133
223
|
export interface KnowledgeBaseRetrievalRequest {
|
|
224
|
+
/** A list of chat message style input. */
|
|
225
|
+
messages?: KnowledgeBaseMessage[];
|
|
134
226
|
/** A list of intended queries to execute without model query planning. */
|
|
135
227
|
intents?: KnowledgeRetrievalIntentUnion[];
|
|
136
228
|
/** The maximum runtime in seconds. */
|
|
137
229
|
maxRuntimeInSeconds?: number;
|
|
138
230
|
/** Limits the maximum size of the content in the output. */
|
|
231
|
+
maxOutputSize?: number;
|
|
232
|
+
/** Limits the maximum number of documents in the output. */
|
|
233
|
+
maxOutputDocuments?: number;
|
|
234
|
+
/** Limits the maximum size of the content in the output. */
|
|
139
235
|
maxOutputSizeInTokens?: number;
|
|
236
|
+
/** The retrieval reasoning effort configuration. */
|
|
237
|
+
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;
|
|
140
238
|
/** Indicates retrieval results should include activity information. */
|
|
141
239
|
includeActivity?: boolean;
|
|
240
|
+
/** The output configuration for this retrieval. */
|
|
241
|
+
outputMode?: KnowledgeRetrievalOutputMode;
|
|
142
242
|
/** A list of runtime parameters for the knowledge sources. */
|
|
143
243
|
knowledgeSourceParams?: KnowledgeSourceParamsUnion[];
|
|
144
244
|
}
|
|
145
245
|
export declare function knowledgeBaseRetrievalRequestSerializer(item: KnowledgeBaseRetrievalRequest): any;
|
|
246
|
+
export declare function knowledgeBaseMessageArraySerializer(result: Array<KnowledgeBaseMessage>): any[];
|
|
247
|
+
export declare function knowledgeBaseMessageArrayDeserializer(result: Array<KnowledgeBaseMessage>): any[];
|
|
248
|
+
/** The natural language message style object. */
|
|
249
|
+
export interface KnowledgeBaseMessage {
|
|
250
|
+
/** The role of the tool response. */
|
|
251
|
+
role?: string;
|
|
252
|
+
/** The content of the message. */
|
|
253
|
+
content: KnowledgeBaseMessageContentUnion[];
|
|
254
|
+
}
|
|
255
|
+
export declare function knowledgeBaseMessageSerializer(item: KnowledgeBaseMessage): any;
|
|
256
|
+
export declare function knowledgeBaseMessageDeserializer(item: any): KnowledgeBaseMessage;
|
|
257
|
+
export declare function knowledgeBaseMessageContentUnionArraySerializer(result: Array<KnowledgeBaseMessageContentUnion>): any[];
|
|
258
|
+
export declare function knowledgeBaseMessageContentUnionArrayDeserializer(result: Array<KnowledgeBaseMessageContentUnion>): any[];
|
|
259
|
+
/** Specifies the type of the message content. */
|
|
260
|
+
export interface KnowledgeBaseMessageContent {
|
|
261
|
+
/** The type of the message */
|
|
262
|
+
/** The discriminator possible values: text, image */
|
|
263
|
+
type: KnowledgeBaseMessageContentType;
|
|
264
|
+
}
|
|
265
|
+
export declare function knowledgeBaseMessageContentSerializer(item: KnowledgeBaseMessageContent): any;
|
|
266
|
+
export declare function knowledgeBaseMessageContentDeserializer(item: any): KnowledgeBaseMessageContent;
|
|
267
|
+
/** Alias for KnowledgeBaseMessageContentUnion */
|
|
268
|
+
export type KnowledgeBaseMessageContentUnion = KnowledgeBaseMessageTextContent | KnowledgeBaseMessageImageContent | KnowledgeBaseMessageContent;
|
|
269
|
+
export declare function knowledgeBaseMessageContentUnionSerializer(item: KnowledgeBaseMessageContentUnion): any;
|
|
270
|
+
export declare function knowledgeBaseMessageContentUnionDeserializer(item: any): KnowledgeBaseMessageContentUnion;
|
|
271
|
+
/** The type of message content. */
|
|
272
|
+
export declare enum KnownKnowledgeBaseMessageContentType {
|
|
273
|
+
/** Text message content kind. */
|
|
274
|
+
Text = "text",
|
|
275
|
+
/** Image message content kind. */
|
|
276
|
+
Image = "image"
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* The type of message content. \
|
|
280
|
+
* {@link KnownKnowledgeBaseMessageContentType} can be used interchangeably with KnowledgeBaseMessageContentType,
|
|
281
|
+
* this enum contains the known values that the service supports.
|
|
282
|
+
* ### Known values supported by the service
|
|
283
|
+
* **text**: Text message content kind. \
|
|
284
|
+
* **image**: Image message content kind.
|
|
285
|
+
*/
|
|
286
|
+
export type KnowledgeBaseMessageContentType = string;
|
|
287
|
+
/** Text message type. */
|
|
288
|
+
export interface KnowledgeBaseMessageTextContent extends KnowledgeBaseMessageContent {
|
|
289
|
+
/** The discriminator value. */
|
|
290
|
+
type: "text";
|
|
291
|
+
/** The text content. */
|
|
292
|
+
text: string;
|
|
293
|
+
}
|
|
294
|
+
export declare function knowledgeBaseMessageTextContentSerializer(item: KnowledgeBaseMessageTextContent): any;
|
|
295
|
+
export declare function knowledgeBaseMessageTextContentDeserializer(item: any): KnowledgeBaseMessageTextContent;
|
|
296
|
+
/** Image message type. */
|
|
297
|
+
export interface KnowledgeBaseMessageImageContent extends KnowledgeBaseMessageContent {
|
|
298
|
+
/** The discriminator value. */
|
|
299
|
+
type: "image";
|
|
300
|
+
/** The image content. */
|
|
301
|
+
image: KnowledgeBaseImageContent;
|
|
302
|
+
}
|
|
303
|
+
export declare function knowledgeBaseMessageImageContentSerializer(item: KnowledgeBaseMessageImageContent): any;
|
|
304
|
+
export declare function knowledgeBaseMessageImageContentDeserializer(item: any): KnowledgeBaseMessageImageContent;
|
|
305
|
+
/** Image content. */
|
|
306
|
+
export interface KnowledgeBaseImageContent {
|
|
307
|
+
/** The url of the image. */
|
|
308
|
+
url: string;
|
|
309
|
+
}
|
|
310
|
+
export declare function knowledgeBaseImageContentSerializer(item: KnowledgeBaseImageContent): any;
|
|
311
|
+
export declare function knowledgeBaseImageContentDeserializer(item: any): KnowledgeBaseImageContent;
|
|
146
312
|
export declare function knowledgeRetrievalIntentUnionArraySerializer(result: Array<KnowledgeRetrievalIntentUnion>): any[];
|
|
147
313
|
/** An intended query to execute without model query planning. */
|
|
148
314
|
export interface KnowledgeRetrievalIntent {
|
|
@@ -184,15 +350,23 @@ export interface KnowledgeSourceParams {
|
|
|
184
350
|
includeReferences?: boolean;
|
|
185
351
|
/** Indicates whether references should include the structured data obtained during retrieval in their payload. */
|
|
186
352
|
includeReferenceSourceData?: boolean;
|
|
353
|
+
/** Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. */
|
|
354
|
+
alwaysQuerySource?: boolean;
|
|
355
|
+
/** Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false. */
|
|
356
|
+
failOnError?: boolean;
|
|
187
357
|
/** The reranker threshold all retrieved documents must meet to be included in the response. */
|
|
188
358
|
rerankerThreshold?: number;
|
|
359
|
+
/** Limits the maximum number of documents returned from this knowledge source. */
|
|
360
|
+
maxOutputDocuments?: number;
|
|
189
361
|
/** The type of the knowledge source. */
|
|
190
|
-
/** The discriminator possible values: searchIndex, azureBlob, indexedOneLake, web */
|
|
362
|
+
/** The discriminator possible values: searchIndex, azureBlob, indexedSharePoint, indexedOneLake, web, remoteSharePoint, workIQ, fabricDataAgent, fabricOntology, mcpServer, file, indexedSql */
|
|
191
363
|
kind: KnowledgeSourceKind;
|
|
364
|
+
/** Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models. */
|
|
365
|
+
enableImageServing?: boolean;
|
|
192
366
|
}
|
|
193
367
|
export declare function knowledgeSourceParamsSerializer(item: KnowledgeSourceParams): any;
|
|
194
368
|
/** Alias for KnowledgeSourceParamsUnion */
|
|
195
|
-
export type KnowledgeSourceParamsUnion = SearchIndexKnowledgeSourceParams | AzureBlobKnowledgeSourceParams | IndexedOneLakeKnowledgeSourceParams | WebKnowledgeSourceParams | KnowledgeSourceParams;
|
|
369
|
+
export type KnowledgeSourceParamsUnion = SearchIndexKnowledgeSourceParams | AzureBlobKnowledgeSourceParams | IndexedSharePointKnowledgeSourceParams | IndexedOneLakeKnowledgeSourceParams | WebKnowledgeSourceParams | RemoteSharePointKnowledgeSourceParams | WorkIQKnowledgeSourceParams | FabricDataAgentKnowledgeSourceParams | FabricOntologyKnowledgeSourceParams | McpServerKnowledgeSourceParams | FileKnowledgeSourceParams | IndexedSqlKnowledgeSourceParams | KnowledgeSourceParams;
|
|
196
370
|
export declare function knowledgeSourceParamsUnionSerializer(item: KnowledgeSourceParamsUnion): any;
|
|
197
371
|
/** Specifies runtime parameters for a search index knowledge source */
|
|
198
372
|
export interface SearchIndexKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
@@ -208,6 +382,12 @@ export interface AzureBlobKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
|
208
382
|
kind: "azureBlob";
|
|
209
383
|
}
|
|
210
384
|
export declare function azureBlobKnowledgeSourceParamsSerializer(item: AzureBlobKnowledgeSourceParams): any;
|
|
385
|
+
/** Specifies runtime parameters for a indexed SharePoint knowledge source */
|
|
386
|
+
export interface IndexedSharePointKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
387
|
+
/** The discriminator value. */
|
|
388
|
+
kind: "indexedSharePoint";
|
|
389
|
+
}
|
|
390
|
+
export declare function indexedSharePointKnowledgeSourceParamsSerializer(item: IndexedSharePointKnowledgeSourceParams): any;
|
|
211
391
|
/** Specifies runtime parameters for a indexed OneLake knowledge source */
|
|
212
392
|
export interface IndexedOneLakeKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
213
393
|
/** The discriminator value. */
|
|
@@ -228,6 +408,50 @@ export interface WebKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
|
228
408
|
freshness?: string;
|
|
229
409
|
}
|
|
230
410
|
export declare function webKnowledgeSourceParamsSerializer(item: WebKnowledgeSourceParams): any;
|
|
411
|
+
/** Specifies runtime parameters for a remote SharePoint knowledge source */
|
|
412
|
+
export interface RemoteSharePointKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
413
|
+
/** The discriminator value. */
|
|
414
|
+
kind: "remoteSharePoint";
|
|
415
|
+
/** A filter condition applied to the SharePoint data source. It must be specified in the Keyword Query Language syntax. It will be combined as a conjunction with the filter expression specified in the knowledge source definition. */
|
|
416
|
+
filterExpressionAddOn?: string;
|
|
417
|
+
}
|
|
418
|
+
export declare function remoteSharePointKnowledgeSourceParamsSerializer(item: RemoteSharePointKnowledgeSourceParams): any;
|
|
419
|
+
/** Specifies runtime parameters for a WorkIQ knowledge source */
|
|
420
|
+
export interface WorkIQKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
421
|
+
/** The discriminator value. */
|
|
422
|
+
kind: "workIQ";
|
|
423
|
+
}
|
|
424
|
+
export declare function workIQKnowledgeSourceParamsSerializer(item: WorkIQKnowledgeSourceParams): any;
|
|
425
|
+
/** Specifies runtime parameters for a Fabric Data Agent knowledge source */
|
|
426
|
+
export interface FabricDataAgentKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
427
|
+
/** The discriminator value. */
|
|
428
|
+
kind: "fabricDataAgent";
|
|
429
|
+
}
|
|
430
|
+
export declare function fabricDataAgentKnowledgeSourceParamsSerializer(item: FabricDataAgentKnowledgeSourceParams): any;
|
|
431
|
+
/** Specifies runtime parameters for a Fabric Ontology knowledge source */
|
|
432
|
+
export interface FabricOntologyKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
433
|
+
/** The discriminator value. */
|
|
434
|
+
kind: "fabricOntology";
|
|
435
|
+
}
|
|
436
|
+
export declare function fabricOntologyKnowledgeSourceParamsSerializer(item: FabricOntologyKnowledgeSourceParams): any;
|
|
437
|
+
/** Specifies runtime parameters for an MCP server knowledge source */
|
|
438
|
+
export interface McpServerKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
439
|
+
/** The discriminator value. */
|
|
440
|
+
kind: "mcpServer";
|
|
441
|
+
}
|
|
442
|
+
export declare function mcpServerKnowledgeSourceParamsSerializer(item: McpServerKnowledgeSourceParams): any;
|
|
443
|
+
/** Specifies runtime parameters for a File knowledge source */
|
|
444
|
+
export interface FileKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
445
|
+
/** The discriminator value. */
|
|
446
|
+
kind: "file";
|
|
447
|
+
}
|
|
448
|
+
export declare function fileKnowledgeSourceParamsSerializer(item: FileKnowledgeSourceParams): any;
|
|
449
|
+
/** Specifies runtime parameters for an indexed SQL knowledge source */
|
|
450
|
+
export interface IndexedSqlKnowledgeSourceParams extends KnowledgeSourceParams {
|
|
451
|
+
/** The discriminator value. */
|
|
452
|
+
kind: "indexedSql";
|
|
453
|
+
}
|
|
454
|
+
export declare function indexedSqlKnowledgeSourceParamsSerializer(item: IndexedSqlKnowledgeSourceParams): any;
|
|
231
455
|
/** The output contract for the retrieval response. */
|
|
232
456
|
export interface KnowledgeBaseRetrievalResponse {
|
|
233
457
|
/** The response messages. */
|
|
@@ -236,82 +460,28 @@ export interface KnowledgeBaseRetrievalResponse {
|
|
|
236
460
|
activity?: KnowledgeBaseActivityRecordUnion[];
|
|
237
461
|
/** The references for the retrieval data used in the response. */
|
|
238
462
|
references?: KnowledgeBaseReferenceUnion[];
|
|
463
|
+
/** The sensitivity label information for the overall response. */
|
|
464
|
+
responseSensitivityLabelInfo?: PurviewSensitivityLabelInfo;
|
|
239
465
|
}
|
|
240
466
|
export declare function knowledgeBaseRetrievalResponseDeserializer(item: any): KnowledgeBaseRetrievalResponse;
|
|
241
|
-
export declare function knowledgeBaseMessageArrayDeserializer(result: Array<KnowledgeBaseMessage>): any[];
|
|
242
|
-
/** The natural language message style object. */
|
|
243
|
-
export interface KnowledgeBaseMessage {
|
|
244
|
-
/** The role of the tool response. */
|
|
245
|
-
role?: string;
|
|
246
|
-
/** The content of the message. */
|
|
247
|
-
content: KnowledgeBaseMessageContentUnion[];
|
|
248
|
-
}
|
|
249
|
-
export declare function knowledgeBaseMessageDeserializer(item: any): KnowledgeBaseMessage;
|
|
250
|
-
export declare function knowledgeBaseMessageContentUnionArrayDeserializer(result: Array<KnowledgeBaseMessageContentUnion>): any[];
|
|
251
|
-
/** Specifies the type of the message content. */
|
|
252
|
-
export interface KnowledgeBaseMessageContent {
|
|
253
|
-
/** The type of the message */
|
|
254
|
-
/** The discriminator possible values: text, image */
|
|
255
|
-
type: KnowledgeBaseMessageContentType;
|
|
256
|
-
}
|
|
257
|
-
export declare function knowledgeBaseMessageContentDeserializer(item: any): KnowledgeBaseMessageContent;
|
|
258
|
-
/** Alias for KnowledgeBaseMessageContentUnion */
|
|
259
|
-
export type KnowledgeBaseMessageContentUnion = KnowledgeBaseMessageTextContent | KnowledgeBaseMessageImageContent | KnowledgeBaseMessageContent;
|
|
260
|
-
export declare function knowledgeBaseMessageContentUnionDeserializer(item: any): KnowledgeBaseMessageContentUnion;
|
|
261
|
-
/** The type of message content. */
|
|
262
|
-
export declare enum KnownKnowledgeBaseMessageContentType {
|
|
263
|
-
/** Text message content kind. */
|
|
264
|
-
Text = "text",
|
|
265
|
-
/** Image message content kind. */
|
|
266
|
-
Image = "image"
|
|
267
|
-
}
|
|
268
|
-
/**
|
|
269
|
-
* The type of message content. \
|
|
270
|
-
* {@link KnownKnowledgeBaseMessageContentType} can be used interchangeably with KnowledgeBaseMessageContentType,
|
|
271
|
-
* this enum contains the known values that the service supports.
|
|
272
|
-
* ### Known values supported by the service
|
|
273
|
-
* **text**: Text message content kind. \
|
|
274
|
-
* **image**: Image message content kind.
|
|
275
|
-
*/
|
|
276
|
-
export type KnowledgeBaseMessageContentType = string;
|
|
277
|
-
/** Text message type. */
|
|
278
|
-
export interface KnowledgeBaseMessageTextContent extends KnowledgeBaseMessageContent {
|
|
279
|
-
/** The discriminator value. */
|
|
280
|
-
type: "text";
|
|
281
|
-
/** The text content. */
|
|
282
|
-
text: string;
|
|
283
|
-
}
|
|
284
|
-
export declare function knowledgeBaseMessageTextContentDeserializer(item: any): KnowledgeBaseMessageTextContent;
|
|
285
|
-
/** Image message type. */
|
|
286
|
-
export interface KnowledgeBaseMessageImageContent extends KnowledgeBaseMessageContent {
|
|
287
|
-
/** The discriminator value. */
|
|
288
|
-
type: "image";
|
|
289
|
-
/** The image content. */
|
|
290
|
-
image: KnowledgeBaseImageContent;
|
|
291
|
-
}
|
|
292
|
-
export declare function knowledgeBaseMessageImageContentDeserializer(item: any): KnowledgeBaseMessageImageContent;
|
|
293
|
-
/** Image content. */
|
|
294
|
-
export interface KnowledgeBaseImageContent {
|
|
295
|
-
/** The url of the image. */
|
|
296
|
-
url: string;
|
|
297
|
-
}
|
|
298
|
-
export declare function knowledgeBaseImageContentDeserializer(item: any): KnowledgeBaseImageContent;
|
|
299
467
|
export declare function knowledgeBaseActivityRecordUnionArrayDeserializer(result: Array<KnowledgeBaseActivityRecordUnion>): any[];
|
|
300
468
|
/** Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations. */
|
|
301
469
|
export interface KnowledgeBaseActivityRecord {
|
|
302
470
|
/** The ID of the activity record. */
|
|
303
471
|
id: number;
|
|
304
472
|
/** The type of the activity record. */
|
|
305
|
-
/** The discriminator possible values: modelWebSummarization, agenticReasoning */
|
|
473
|
+
/** The discriminator possible values: searchIndex, azureBlob, indexedSharePoint, indexedOneLake, web, remoteSharePoint, workIQ, fabricDataAgent, fabricOntology, mcpServer, file, indexedSql, modelQueryPlanning, modelAnswerSynthesis, modelWebSummarization, agenticReasoning */
|
|
306
474
|
type: KnowledgeBaseActivityRecordType;
|
|
307
475
|
/** The elapsed time in milliseconds for the retrieval activity. */
|
|
308
476
|
elapsedInMs?: number;
|
|
309
477
|
/** The error detail explaining why the operation failed. This property is only included when the activity does not succeed. */
|
|
310
478
|
error?: KnowledgeBaseErrorDetail;
|
|
479
|
+
/** A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions. */
|
|
480
|
+
warning?: string;
|
|
311
481
|
}
|
|
312
482
|
export declare function knowledgeBaseActivityRecordDeserializer(item: any): KnowledgeBaseActivityRecord;
|
|
313
483
|
/** Alias for KnowledgeBaseActivityRecordUnion */
|
|
314
|
-
export type KnowledgeBaseActivityRecordUnion = KnowledgeBaseModelWebSummarizationActivityRecord | KnowledgeBaseAgenticReasoningActivityRecord | KnowledgeBaseActivityRecord;
|
|
484
|
+
export type KnowledgeBaseActivityRecordUnion = KnowledgeBaseSearchIndexActivityRecord | KnowledgeBaseAzureBlobActivityRecord | KnowledgeBaseIndexedSharePointActivityRecord | KnowledgeBaseIndexedOneLakeActivityRecord | KnowledgeBaseWebActivityRecord | KnowledgeBaseRemoteSharePointActivityRecord | KnowledgeBaseWorkIQActivityRecord | KnowledgeBaseFabricDataAgentActivityRecord | KnowledgeBaseFabricOntologyActivityRecord | KnowledgeBaseMcpServerActivityRecord | KnowledgeBaseFileActivityRecord | KnowledgeBaseIndexedSqlActivityRecord | KnowledgeBaseModelQueryPlanningActivityRecord | KnowledgeBaseModelAnswerSynthesisActivityRecord | KnowledgeBaseModelWebSummarizationActivityRecord | KnowledgeBaseAgenticReasoningActivityRecord | KnowledgeBaseActivityRecord;
|
|
315
485
|
export declare function knowledgeBaseActivityRecordUnionDeserializer(item: any): KnowledgeBaseActivityRecordUnion;
|
|
316
486
|
/** The type of activity record. */
|
|
317
487
|
export declare enum KnownKnowledgeBaseActivityRecordType {
|
|
@@ -319,10 +489,30 @@ export declare enum KnownKnowledgeBaseActivityRecordType {
|
|
|
319
489
|
SearchIndex = "searchIndex",
|
|
320
490
|
/** Azure Blob retrieval activity. */
|
|
321
491
|
AzureBlob = "azureBlob",
|
|
492
|
+
/** Indexed SharePoint retrieval activity. */
|
|
493
|
+
IndexedSharePoint = "indexedSharePoint",
|
|
322
494
|
/** Indexed OneLake retrieval activity. */
|
|
323
495
|
IndexedOneLake = "indexedOneLake",
|
|
324
496
|
/** Web retrieval activity. */
|
|
325
497
|
Web = "web",
|
|
498
|
+
/** Remote SharePoint retrieval activity. */
|
|
499
|
+
RemoteSharePoint = "remoteSharePoint",
|
|
500
|
+
/** WorkIQ retrieval activity. */
|
|
501
|
+
WorkIQ = "workIQ",
|
|
502
|
+
/** Fabric Data Agent retrieval activity. */
|
|
503
|
+
FabricDataAgent = "fabricDataAgent",
|
|
504
|
+
/** Fabric Ontology retrieval activity. */
|
|
505
|
+
FabricOntology = "fabricOntology",
|
|
506
|
+
/** MCP server retrieval activity. */
|
|
507
|
+
McpServer = "mcpServer",
|
|
508
|
+
/** File retrieval activity. */
|
|
509
|
+
File = "file",
|
|
510
|
+
/** Indexed SQL retrieval activity. */
|
|
511
|
+
IndexedSql = "indexedSql",
|
|
512
|
+
/** LLM query planning activity. */
|
|
513
|
+
ModelQueryPlanning = "modelQueryPlanning",
|
|
514
|
+
/** LLM answer synthesis activity. */
|
|
515
|
+
ModelAnswerSynthesis = "modelAnswerSynthesis",
|
|
326
516
|
/** LLM web summarization activity. */
|
|
327
517
|
ModelWebSummarization = "modelWebSummarization",
|
|
328
518
|
/** Agentic reasoning activity. */
|
|
@@ -335,8 +525,18 @@ export declare enum KnownKnowledgeBaseActivityRecordType {
|
|
|
335
525
|
* ### Known values supported by the service
|
|
336
526
|
* **searchIndex**: Search index retrieval activity. \
|
|
337
527
|
* **azureBlob**: Azure Blob retrieval activity. \
|
|
528
|
+
* **indexedSharePoint**: Indexed SharePoint retrieval activity. \
|
|
338
529
|
* **indexedOneLake**: Indexed OneLake retrieval activity. \
|
|
339
530
|
* **web**: Web retrieval activity. \
|
|
531
|
+
* **remoteSharePoint**: Remote SharePoint retrieval activity. \
|
|
532
|
+
* **workIQ**: WorkIQ retrieval activity. \
|
|
533
|
+
* **fabricDataAgent**: Fabric Data Agent retrieval activity. \
|
|
534
|
+
* **fabricOntology**: Fabric Ontology retrieval activity. \
|
|
535
|
+
* **mcpServer**: MCP server retrieval activity. \
|
|
536
|
+
* **file**: File retrieval activity. \
|
|
537
|
+
* **indexedSql**: Indexed SQL retrieval activity. \
|
|
538
|
+
* **modelQueryPlanning**: LLM query planning activity. \
|
|
539
|
+
* **modelAnswerSynthesis**: LLM answer synthesis activity. \
|
|
340
540
|
* **modelWebSummarization**: LLM web summarization activity. \
|
|
341
541
|
* **agenticReasoning**: Agentic reasoning activity.
|
|
342
542
|
*/
|
|
@@ -365,6 +565,326 @@ export interface KnowledgeBaseErrorAdditionalInfo {
|
|
|
365
565
|
readonly info?: Record<string, unknown>;
|
|
366
566
|
}
|
|
367
567
|
export declare function knowledgeBaseErrorAdditionalInfoDeserializer(item: any): KnowledgeBaseErrorAdditionalInfo;
|
|
568
|
+
/** Represents a search index retrieval activity record. */
|
|
569
|
+
export interface KnowledgeBaseSearchIndexActivityRecord extends KnowledgeBaseActivityRecord {
|
|
570
|
+
/** The knowledge source for the retrieval activity. */
|
|
571
|
+
knowledgeSourceName?: string;
|
|
572
|
+
/** The query time for this retrieval activity. */
|
|
573
|
+
queryTime?: Date;
|
|
574
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
575
|
+
count?: number;
|
|
576
|
+
/** Statistics about image serving for this retrieval activity */
|
|
577
|
+
imageServing?: ImageServingStatistics;
|
|
578
|
+
/** The discriminator value. */
|
|
579
|
+
type: "searchIndex";
|
|
580
|
+
/** The search index arguments for the retrieval activity. */
|
|
581
|
+
searchIndexArguments?: KnowledgeBaseSearchIndexActivityArguments;
|
|
582
|
+
}
|
|
583
|
+
export declare function knowledgeBaseSearchIndexActivityRecordDeserializer(item: any): KnowledgeBaseSearchIndexActivityRecord;
|
|
584
|
+
/** Statistics about image serving during a retrieval activity. */
|
|
585
|
+
export interface ImageServingStatistics {
|
|
586
|
+
/** The number of images retrieved from the asset store. */
|
|
587
|
+
imagesRetrieved?: number;
|
|
588
|
+
/** The number of images sent to the downstream model. */
|
|
589
|
+
imagesSentToModel?: number;
|
|
590
|
+
/** The total size in bytes of images sent to the model. */
|
|
591
|
+
totalImageSizeBytes?: number;
|
|
592
|
+
/** Indicates whether image verbalization was used instead of direct image serving. */
|
|
593
|
+
verbalizationUsed?: boolean;
|
|
594
|
+
}
|
|
595
|
+
export declare function imageServingStatisticsDeserializer(item: any): ImageServingStatistics;
|
|
596
|
+
/** Represents the arguments the search index retrieval activity was run with. */
|
|
597
|
+
export interface KnowledgeBaseSearchIndexActivityArguments {
|
|
598
|
+
/** The search string used to query the search index. */
|
|
599
|
+
search?: string;
|
|
600
|
+
/** The filter string. */
|
|
601
|
+
filter?: string;
|
|
602
|
+
/** What fields were selected for search. */
|
|
603
|
+
sourceDataFields?: SearchIndexFieldReference[];
|
|
604
|
+
/** What fields were searched against. */
|
|
605
|
+
searchFields?: SearchIndexFieldReference[];
|
|
606
|
+
/** What semantic configuration was used from the search index. */
|
|
607
|
+
semanticConfigurationName?: string;
|
|
608
|
+
}
|
|
609
|
+
export declare function knowledgeBaseSearchIndexActivityArgumentsDeserializer(item: any): KnowledgeBaseSearchIndexActivityArguments;
|
|
610
|
+
/** Represents a azure blob retrieval activity record. */
|
|
611
|
+
export interface KnowledgeBaseAzureBlobActivityRecord extends KnowledgeBaseActivityRecord {
|
|
612
|
+
/** The knowledge source for the retrieval activity. */
|
|
613
|
+
knowledgeSourceName?: string;
|
|
614
|
+
/** The query time for this retrieval activity. */
|
|
615
|
+
queryTime?: Date;
|
|
616
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
617
|
+
count?: number;
|
|
618
|
+
/** Statistics about image serving for this retrieval activity */
|
|
619
|
+
imageServing?: ImageServingStatistics;
|
|
620
|
+
/** The discriminator value. */
|
|
621
|
+
type: "azureBlob";
|
|
622
|
+
/** The azure blob arguments for the retrieval activity. */
|
|
623
|
+
azureBlobArguments?: KnowledgeBaseAzureBlobActivityArguments;
|
|
624
|
+
}
|
|
625
|
+
export declare function knowledgeBaseAzureBlobActivityRecordDeserializer(item: any): KnowledgeBaseAzureBlobActivityRecord;
|
|
626
|
+
/** Represents the arguments the azure blob retrieval activity was run with. */
|
|
627
|
+
export interface KnowledgeBaseAzureBlobActivityArguments {
|
|
628
|
+
/** The search string used to query blob contents. */
|
|
629
|
+
search?: string;
|
|
630
|
+
}
|
|
631
|
+
export declare function knowledgeBaseAzureBlobActivityArgumentsDeserializer(item: any): KnowledgeBaseAzureBlobActivityArguments;
|
|
632
|
+
/** Represents a indexed SharePoint retrieval activity record. */
|
|
633
|
+
export interface KnowledgeBaseIndexedSharePointActivityRecord extends KnowledgeBaseActivityRecord {
|
|
634
|
+
/** The knowledge source for the retrieval activity. */
|
|
635
|
+
knowledgeSourceName?: string;
|
|
636
|
+
/** The query time for this retrieval activity. */
|
|
637
|
+
queryTime?: Date;
|
|
638
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
639
|
+
count?: number;
|
|
640
|
+
/** Statistics about image serving for this retrieval activity */
|
|
641
|
+
imageServing?: ImageServingStatistics;
|
|
642
|
+
/** The discriminator value. */
|
|
643
|
+
type: "indexedSharePoint";
|
|
644
|
+
/** The indexed SharePoint arguments for the retrieval activity. */
|
|
645
|
+
indexedSharePointArguments?: KnowledgeBaseIndexedSharePointActivityArguments;
|
|
646
|
+
}
|
|
647
|
+
export declare function knowledgeBaseIndexedSharePointActivityRecordDeserializer(item: any): KnowledgeBaseIndexedSharePointActivityRecord;
|
|
648
|
+
/** Represents the arguments the indexed SharePoint retrieval activity was run with. */
|
|
649
|
+
export interface KnowledgeBaseIndexedSharePointActivityArguments {
|
|
650
|
+
/** The search string used to query indexed SharePoint contents. */
|
|
651
|
+
search?: string;
|
|
652
|
+
}
|
|
653
|
+
export declare function knowledgeBaseIndexedSharePointActivityArgumentsDeserializer(item: any): KnowledgeBaseIndexedSharePointActivityArguments;
|
|
654
|
+
/** Represents a indexed OneLake retrieval activity record. */
|
|
655
|
+
export interface KnowledgeBaseIndexedOneLakeActivityRecord extends KnowledgeBaseActivityRecord {
|
|
656
|
+
/** The knowledge source for the retrieval activity. */
|
|
657
|
+
knowledgeSourceName?: string;
|
|
658
|
+
/** The query time for this retrieval activity. */
|
|
659
|
+
queryTime?: Date;
|
|
660
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
661
|
+
count?: number;
|
|
662
|
+
/** Statistics about image serving for this retrieval activity */
|
|
663
|
+
imageServing?: ImageServingStatistics;
|
|
664
|
+
/** The discriminator value. */
|
|
665
|
+
type: "indexedOneLake";
|
|
666
|
+
/** The indexed OneLake arguments for the retrieval activity. */
|
|
667
|
+
indexedOneLakeArguments?: KnowledgeBaseIndexedOneLakeActivityArguments;
|
|
668
|
+
}
|
|
669
|
+
export declare function knowledgeBaseIndexedOneLakeActivityRecordDeserializer(item: any): KnowledgeBaseIndexedOneLakeActivityRecord;
|
|
670
|
+
/** Represents the arguments the indexed OneLake retrieval activity was run with. */
|
|
671
|
+
export interface KnowledgeBaseIndexedOneLakeActivityArguments {
|
|
672
|
+
/** The search string used to query indexed OneLake contents. */
|
|
673
|
+
search?: string;
|
|
674
|
+
}
|
|
675
|
+
export declare function knowledgeBaseIndexedOneLakeActivityArgumentsDeserializer(item: any): KnowledgeBaseIndexedOneLakeActivityArguments;
|
|
676
|
+
/** Represents a web retrieval activity record. */
|
|
677
|
+
export interface KnowledgeBaseWebActivityRecord extends KnowledgeBaseActivityRecord {
|
|
678
|
+
/** The knowledge source for the retrieval activity. */
|
|
679
|
+
knowledgeSourceName?: string;
|
|
680
|
+
/** The query time for this retrieval activity. */
|
|
681
|
+
queryTime?: Date;
|
|
682
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
683
|
+
count?: number;
|
|
684
|
+
/** Statistics about image serving for this retrieval activity */
|
|
685
|
+
imageServing?: ImageServingStatistics;
|
|
686
|
+
/** The discriminator value. */
|
|
687
|
+
type: "web";
|
|
688
|
+
/** The web arguments for the retrieval activity. */
|
|
689
|
+
webArguments?: KnowledgeBaseWebActivityArguments;
|
|
690
|
+
}
|
|
691
|
+
export declare function knowledgeBaseWebActivityRecordDeserializer(item: any): KnowledgeBaseWebActivityRecord;
|
|
692
|
+
/** Represents the arguments the web retrieval activity was run with. */
|
|
693
|
+
export interface KnowledgeBaseWebActivityArguments {
|
|
694
|
+
/** The search string used to query the web. */
|
|
695
|
+
search?: string;
|
|
696
|
+
/** The language for the retrieval activity. */
|
|
697
|
+
language?: string;
|
|
698
|
+
/** The market for the retrieval activity. */
|
|
699
|
+
market?: string;
|
|
700
|
+
/** The number of web results returned. */
|
|
701
|
+
count?: number;
|
|
702
|
+
/** The freshness for the retrieval activity. */
|
|
703
|
+
freshness?: string;
|
|
704
|
+
}
|
|
705
|
+
export declare function knowledgeBaseWebActivityArgumentsDeserializer(item: any): KnowledgeBaseWebActivityArguments;
|
|
706
|
+
/** Represents a remote SharePoint retrieval activity record. */
|
|
707
|
+
export interface KnowledgeBaseRemoteSharePointActivityRecord extends KnowledgeBaseActivityRecord {
|
|
708
|
+
/** The knowledge source for the retrieval activity. */
|
|
709
|
+
knowledgeSourceName?: string;
|
|
710
|
+
/** The query time for this retrieval activity. */
|
|
711
|
+
queryTime?: Date;
|
|
712
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
713
|
+
count?: number;
|
|
714
|
+
/** Statistics about image serving for this retrieval activity */
|
|
715
|
+
imageServing?: ImageServingStatistics;
|
|
716
|
+
/** The discriminator value. */
|
|
717
|
+
type: "remoteSharePoint";
|
|
718
|
+
/** The remote SharePoint arguments for the retrieval activity. */
|
|
719
|
+
remoteSharePointArguments?: KnowledgeBaseRemoteSharePointActivityArguments;
|
|
720
|
+
}
|
|
721
|
+
export declare function knowledgeBaseRemoteSharePointActivityRecordDeserializer(item: any): KnowledgeBaseRemoteSharePointActivityRecord;
|
|
722
|
+
/** Represents the arguments the remote SharePoint retrieval activity was run with. */
|
|
723
|
+
export interface KnowledgeBaseRemoteSharePointActivityArguments {
|
|
724
|
+
/** The search string used to query the remote SharePoint knowledge source. */
|
|
725
|
+
search?: string;
|
|
726
|
+
/** The filter expression add-on for the retrieval activity. */
|
|
727
|
+
filterExpressionAddOn?: string;
|
|
728
|
+
}
|
|
729
|
+
export declare function knowledgeBaseRemoteSharePointActivityArgumentsDeserializer(item: any): KnowledgeBaseRemoteSharePointActivityArguments;
|
|
730
|
+
/** Represents a WorkIQ retrieval activity record. */
|
|
731
|
+
export interface KnowledgeBaseWorkIQActivityRecord extends KnowledgeBaseActivityRecord {
|
|
732
|
+
/** The knowledge source for the retrieval activity. */
|
|
733
|
+
knowledgeSourceName?: string;
|
|
734
|
+
/** The query time for this retrieval activity. */
|
|
735
|
+
queryTime?: Date;
|
|
736
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
737
|
+
count?: number;
|
|
738
|
+
/** Statistics about image serving for this retrieval activity */
|
|
739
|
+
imageServing?: ImageServingStatistics;
|
|
740
|
+
/** The discriminator value. */
|
|
741
|
+
type: "workIQ";
|
|
742
|
+
/** The WorkIQ arguments for the retrieval activity. */
|
|
743
|
+
workIQArguments?: KnowledgeBaseWorkIQActivityArguments;
|
|
744
|
+
}
|
|
745
|
+
export declare function knowledgeBaseWorkIQActivityRecordDeserializer(item: any): KnowledgeBaseWorkIQActivityRecord;
|
|
746
|
+
/** Represents the arguments the WorkIQ retrieval activity was run with. */
|
|
747
|
+
export interface KnowledgeBaseWorkIQActivityArguments {
|
|
748
|
+
/** The search string used to query the WorkIQ knowledge source. */
|
|
749
|
+
search?: string;
|
|
750
|
+
}
|
|
751
|
+
export declare function knowledgeBaseWorkIQActivityArgumentsDeserializer(item: any): KnowledgeBaseWorkIQActivityArguments;
|
|
752
|
+
/** Represents a Fabric Data Agent retrieval activity record. */
|
|
753
|
+
export interface KnowledgeBaseFabricDataAgentActivityRecord extends KnowledgeBaseActivityRecord {
|
|
754
|
+
/** The knowledge source for the retrieval activity. */
|
|
755
|
+
knowledgeSourceName?: string;
|
|
756
|
+
/** The query time for this retrieval activity. */
|
|
757
|
+
queryTime?: Date;
|
|
758
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
759
|
+
count?: number;
|
|
760
|
+
/** Statistics about image serving for this retrieval activity */
|
|
761
|
+
imageServing?: ImageServingStatistics;
|
|
762
|
+
/** The discriminator value. */
|
|
763
|
+
type: "fabricDataAgent";
|
|
764
|
+
/** The Fabric Data Agent arguments for the retrieval activity. */
|
|
765
|
+
fabricDataAgentArguments?: KnowledgeBaseFabricDataAgentActivityArguments;
|
|
766
|
+
}
|
|
767
|
+
export declare function knowledgeBaseFabricDataAgentActivityRecordDeserializer(item: any): KnowledgeBaseFabricDataAgentActivityRecord;
|
|
768
|
+
/** Represents the arguments the Fabric Data Agent retrieval activity was run with. */
|
|
769
|
+
export interface KnowledgeBaseFabricDataAgentActivityArguments {
|
|
770
|
+
/** The search string used to query the Fabric Data Agent knowledge source. */
|
|
771
|
+
search?: string;
|
|
772
|
+
}
|
|
773
|
+
export declare function knowledgeBaseFabricDataAgentActivityArgumentsDeserializer(item: any): KnowledgeBaseFabricDataAgentActivityArguments;
|
|
774
|
+
/** Represents a Fabric Ontology retrieval activity record. */
|
|
775
|
+
export interface KnowledgeBaseFabricOntologyActivityRecord extends KnowledgeBaseActivityRecord {
|
|
776
|
+
/** The knowledge source for the retrieval activity. */
|
|
777
|
+
knowledgeSourceName?: string;
|
|
778
|
+
/** The query time for this retrieval activity. */
|
|
779
|
+
queryTime?: Date;
|
|
780
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
781
|
+
count?: number;
|
|
782
|
+
/** Statistics about image serving for this retrieval activity */
|
|
783
|
+
imageServing?: ImageServingStatistics;
|
|
784
|
+
/** The discriminator value. */
|
|
785
|
+
type: "fabricOntology";
|
|
786
|
+
/** The Fabric Ontology arguments for the retrieval activity. */
|
|
787
|
+
fabricOntologyArguments?: KnowledgeBaseFabricOntologyActivityArguments;
|
|
788
|
+
}
|
|
789
|
+
export declare function knowledgeBaseFabricOntologyActivityRecordDeserializer(item: any): KnowledgeBaseFabricOntologyActivityRecord;
|
|
790
|
+
/** Represents the arguments the Fabric Ontology retrieval activity was run with. */
|
|
791
|
+
export interface KnowledgeBaseFabricOntologyActivityArguments {
|
|
792
|
+
/** The search string used to query the Fabric Ontology knowledge source. */
|
|
793
|
+
search?: string;
|
|
794
|
+
}
|
|
795
|
+
export declare function knowledgeBaseFabricOntologyActivityArgumentsDeserializer(item: any): KnowledgeBaseFabricOntologyActivityArguments;
|
|
796
|
+
/** Represents an MCP server retrieval activity record. */
|
|
797
|
+
export interface KnowledgeBaseMcpServerActivityRecord extends KnowledgeBaseActivityRecord {
|
|
798
|
+
/** The knowledge source for the retrieval activity. */
|
|
799
|
+
knowledgeSourceName?: string;
|
|
800
|
+
/** The query time for this retrieval activity. */
|
|
801
|
+
queryTime?: Date;
|
|
802
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
803
|
+
count?: number;
|
|
804
|
+
/** Statistics about image serving for this retrieval activity */
|
|
805
|
+
imageServing?: ImageServingStatistics;
|
|
806
|
+
/** The discriminator value. */
|
|
807
|
+
type: "mcpServer";
|
|
808
|
+
/** The MCP server arguments for the retrieval activity. */
|
|
809
|
+
mcpServerArguments?: KnowledgeBaseMcpServerActivityArguments;
|
|
810
|
+
}
|
|
811
|
+
export declare function knowledgeBaseMcpServerActivityRecordDeserializer(item: any): KnowledgeBaseMcpServerActivityRecord;
|
|
812
|
+
/** Represents the arguments the MCP server retrieval activity was run with. */
|
|
813
|
+
export interface KnowledgeBaseMcpServerActivityArguments {
|
|
814
|
+
/** The name of the MCP server tool used for the retrieval activity. */
|
|
815
|
+
toolName?: string;
|
|
816
|
+
/** The arguments passed to the MCP server tool. */
|
|
817
|
+
toolArguments?: Record<string, any>;
|
|
818
|
+
}
|
|
819
|
+
export declare function knowledgeBaseMcpServerActivityArgumentsDeserializer(item: any): KnowledgeBaseMcpServerActivityArguments;
|
|
820
|
+
/** Represents a File retrieval activity record. */
|
|
821
|
+
export interface KnowledgeBaseFileActivityRecord extends KnowledgeBaseActivityRecord {
|
|
822
|
+
/** The knowledge source for the retrieval activity. */
|
|
823
|
+
knowledgeSourceName?: string;
|
|
824
|
+
/** The query time for this retrieval activity. */
|
|
825
|
+
queryTime?: Date;
|
|
826
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
827
|
+
count?: number;
|
|
828
|
+
/** Statistics about image serving for this retrieval activity */
|
|
829
|
+
imageServing?: ImageServingStatistics;
|
|
830
|
+
/** The discriminator value. */
|
|
831
|
+
type: "file";
|
|
832
|
+
/** The File arguments for the retrieval activity. */
|
|
833
|
+
fileArguments?: KnowledgeBaseFileActivityArguments;
|
|
834
|
+
}
|
|
835
|
+
export declare function knowledgeBaseFileActivityRecordDeserializer(item: any): KnowledgeBaseFileActivityRecord;
|
|
836
|
+
/** Represents the arguments the File retrieval activity was run with. */
|
|
837
|
+
export interface KnowledgeBaseFileActivityArguments {
|
|
838
|
+
/** The search string used to query file contents. */
|
|
839
|
+
search?: string;
|
|
840
|
+
}
|
|
841
|
+
export declare function knowledgeBaseFileActivityArgumentsDeserializer(item: any): KnowledgeBaseFileActivityArguments;
|
|
842
|
+
/** Represents an indexed SQL retrieval activity record. */
|
|
843
|
+
export interface KnowledgeBaseIndexedSqlActivityRecord extends KnowledgeBaseActivityRecord {
|
|
844
|
+
/** The knowledge source for the retrieval activity. */
|
|
845
|
+
knowledgeSourceName?: string;
|
|
846
|
+
/** The query time for this retrieval activity. */
|
|
847
|
+
queryTime?: Date;
|
|
848
|
+
/** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */
|
|
849
|
+
count?: number;
|
|
850
|
+
/** Statistics about image serving for this retrieval activity */
|
|
851
|
+
imageServing?: ImageServingStatistics;
|
|
852
|
+
/** The discriminator value. */
|
|
853
|
+
type: "indexedSql";
|
|
854
|
+
/** The indexed SQL arguments for the retrieval activity. */
|
|
855
|
+
indexedSqlArguments?: KnowledgeBaseIndexedSqlActivityArguments;
|
|
856
|
+
}
|
|
857
|
+
export declare function knowledgeBaseIndexedSqlActivityRecordDeserializer(item: any): KnowledgeBaseIndexedSqlActivityRecord;
|
|
858
|
+
/** Represents the arguments the indexed SQL retrieval activity was run with. */
|
|
859
|
+
export interface KnowledgeBaseIndexedSqlActivityArguments {
|
|
860
|
+
/** The search string used to query indexed SQL contents. */
|
|
861
|
+
search?: string;
|
|
862
|
+
}
|
|
863
|
+
export declare function knowledgeBaseIndexedSqlActivityArgumentsDeserializer(item: any): KnowledgeBaseIndexedSqlActivityArguments;
|
|
864
|
+
/** Represents an LLM query planning activity record. */
|
|
865
|
+
export interface KnowledgeBaseModelQueryPlanningActivityRecord extends KnowledgeBaseActivityRecord {
|
|
866
|
+
/** The discriminator value. */
|
|
867
|
+
type: "modelQueryPlanning";
|
|
868
|
+
/** The number of input tokens for the LLM query planning activity. */
|
|
869
|
+
inputTokens?: number;
|
|
870
|
+
/** The number of output tokens for the LLM query planning activity. */
|
|
871
|
+
outputTokens?: number;
|
|
872
|
+
/** The name of the model used for the LLM query planning activity. */
|
|
873
|
+
modelName?: string;
|
|
874
|
+
}
|
|
875
|
+
export declare function knowledgeBaseModelQueryPlanningActivityRecordDeserializer(item: any): KnowledgeBaseModelQueryPlanningActivityRecord;
|
|
876
|
+
/** Represents an LLM answer synthesis activity record. */
|
|
877
|
+
export interface KnowledgeBaseModelAnswerSynthesisActivityRecord extends KnowledgeBaseActivityRecord {
|
|
878
|
+
/** The discriminator value. */
|
|
879
|
+
type: "modelAnswerSynthesis";
|
|
880
|
+
/** The number of input tokens for the LLM answer synthesis activity. */
|
|
881
|
+
inputTokens?: number;
|
|
882
|
+
/** The number of output tokens for the LLM answer synthesis activity. */
|
|
883
|
+
outputTokens?: number;
|
|
884
|
+
/** The name of the model used for the LLM answer synthesis activity. */
|
|
885
|
+
modelName?: string;
|
|
886
|
+
}
|
|
887
|
+
export declare function knowledgeBaseModelAnswerSynthesisActivityRecordDeserializer(item: any): KnowledgeBaseModelAnswerSynthesisActivityRecord;
|
|
368
888
|
/** Represents an LLM web summarization activity record. */
|
|
369
889
|
export interface KnowledgeBaseModelWebSummarizationActivityRecord extends KnowledgeBaseActivityRecord {
|
|
370
890
|
/** The discriminator value. */
|
|
@@ -373,6 +893,8 @@ export interface KnowledgeBaseModelWebSummarizationActivityRecord extends Knowle
|
|
|
373
893
|
inputTokensCount?: number;
|
|
374
894
|
/** The number of output tokens for the LLM web summarization activity. */
|
|
375
895
|
outputTokensCount?: number;
|
|
896
|
+
/** The name of the model used for the LLM web summarization activity. */
|
|
897
|
+
modelName?: string;
|
|
376
898
|
}
|
|
377
899
|
export declare function knowledgeBaseModelWebSummarizationActivityRecordDeserializer(item: any): KnowledgeBaseModelWebSummarizationActivityRecord;
|
|
378
900
|
/** Represents an agentic reasoning activity record. */
|
|
@@ -385,40 +907,11 @@ export interface KnowledgeBaseAgenticReasoningActivityRecord extends KnowledgeBa
|
|
|
385
907
|
retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;
|
|
386
908
|
}
|
|
387
909
|
export declare function knowledgeBaseAgenticReasoningActivityRecordDeserializer(item: any): KnowledgeBaseAgenticReasoningActivityRecord;
|
|
388
|
-
/** Base type for reasoning effort. */
|
|
389
|
-
export interface KnowledgeRetrievalReasoningEffort {
|
|
390
|
-
/** The kind of reasoning effort. */
|
|
391
|
-
/** The discriminator possible values: minimal */
|
|
392
|
-
kind: KnowledgeRetrievalReasoningEffortKind;
|
|
393
|
-
}
|
|
394
|
-
export declare function knowledgeRetrievalReasoningEffortDeserializer(item: any): KnowledgeRetrievalReasoningEffort;
|
|
395
|
-
/** Alias for KnowledgeRetrievalReasoningEffortUnion */
|
|
396
|
-
export type KnowledgeRetrievalReasoningEffortUnion = KnowledgeRetrievalMinimalReasoningEffort | KnowledgeRetrievalReasoningEffort;
|
|
397
|
-
export declare function knowledgeRetrievalReasoningEffortUnionDeserializer(item: any): KnowledgeRetrievalReasoningEffortUnion;
|
|
398
|
-
/** The amount of effort to use during retrieval. */
|
|
399
|
-
export declare enum KnownKnowledgeRetrievalReasoningEffortKind {
|
|
400
|
-
/** Does not perform any source selections, query planning, or iterative search. */
|
|
401
|
-
Minimal = "minimal"
|
|
402
|
-
}
|
|
403
|
-
/**
|
|
404
|
-
* The amount of effort to use during retrieval. \
|
|
405
|
-
* {@link KnownKnowledgeRetrievalReasoningEffortKind} can be used interchangeably with KnowledgeRetrievalReasoningEffortKind,
|
|
406
|
-
* this enum contains the known values that the service supports.
|
|
407
|
-
* ### Known values supported by the service
|
|
408
|
-
* **minimal**: Does not perform any source selections, query planning, or iterative search.
|
|
409
|
-
*/
|
|
410
|
-
export type KnowledgeRetrievalReasoningEffortKind = string;
|
|
411
|
-
/** Run knowledge retrieval with minimal reasoning effort. */
|
|
412
|
-
export interface KnowledgeRetrievalMinimalReasoningEffort extends KnowledgeRetrievalReasoningEffort {
|
|
413
|
-
/** The discriminator value. */
|
|
414
|
-
kind: "minimal";
|
|
415
|
-
}
|
|
416
|
-
export declare function knowledgeRetrievalMinimalReasoningEffortDeserializer(item: any): KnowledgeRetrievalMinimalReasoningEffort;
|
|
417
910
|
export declare function knowledgeBaseReferenceUnionArrayDeserializer(result: Array<KnowledgeBaseReferenceUnion>): any[];
|
|
418
911
|
/** Base type for references. */
|
|
419
912
|
export interface KnowledgeBaseReference {
|
|
420
913
|
/** The type of the reference. */
|
|
421
|
-
/** The discriminator possible values: searchIndex, azureBlob, indexedOneLake, web */
|
|
914
|
+
/** The discriminator possible values: searchIndex, azureBlob, indexedSharePoint, indexedOneLake, web, remoteSharePoint, workIQ, fabricDataAgent, fabricOntology, mcpServer, file, indexedSql */
|
|
422
915
|
type: KnowledgeBaseReferenceType;
|
|
423
916
|
/** The ID of the reference. */
|
|
424
917
|
id: string;
|
|
@@ -431,7 +924,7 @@ export interface KnowledgeBaseReference {
|
|
|
431
924
|
}
|
|
432
925
|
export declare function knowledgeBaseReferenceDeserializer(item: any): KnowledgeBaseReference;
|
|
433
926
|
/** Alias for KnowledgeBaseReferenceUnion */
|
|
434
|
-
export type KnowledgeBaseReferenceUnion = KnowledgeBaseSearchIndexReference | KnowledgeBaseAzureBlobReference | KnowledgeBaseIndexedOneLakeReference | KnowledgeBaseWebReference | KnowledgeBaseReference;
|
|
927
|
+
export type KnowledgeBaseReferenceUnion = KnowledgeBaseSearchIndexReference | KnowledgeBaseAzureBlobReference | KnowledgeBaseIndexedSharePointReference | KnowledgeBaseIndexedOneLakeReference | KnowledgeBaseWebReference | KnowledgeBaseRemoteSharePointReference | KnowledgeBaseWorkIQReference | KnowledgeBaseFabricDataAgentReference | KnowledgeBaseFabricOntologyReference | KnowledgeBaseMcpServerReference | KnowledgeBaseFileReference | KnowledgeBaseIndexedSqlReference | KnowledgeBaseReference;
|
|
435
928
|
export declare function knowledgeBaseReferenceUnionDeserializer(item: any): KnowledgeBaseReferenceUnion;
|
|
436
929
|
/** The type of reference. */
|
|
437
930
|
export declare enum KnownKnowledgeBaseReferenceType {
|
|
@@ -439,10 +932,26 @@ export declare enum KnownKnowledgeBaseReferenceType {
|
|
|
439
932
|
SearchIndex = "searchIndex",
|
|
440
933
|
/** Azure Blob document reference. */
|
|
441
934
|
AzureBlob = "azureBlob",
|
|
935
|
+
/** Indexed SharePoint document reference. */
|
|
936
|
+
IndexedSharePoint = "indexedSharePoint",
|
|
442
937
|
/** Indexed OneLake document reference. */
|
|
443
938
|
IndexedOneLake = "indexedOneLake",
|
|
444
939
|
/** Web document reference. */
|
|
445
|
-
Web = "web"
|
|
940
|
+
Web = "web",
|
|
941
|
+
/** Remote SharePoint document reference. */
|
|
942
|
+
RemoteSharePoint = "remoteSharePoint",
|
|
943
|
+
/** Work IQ document reference. */
|
|
944
|
+
WorkIQ = "workIQ",
|
|
945
|
+
/** Fabric Data Agent document reference. */
|
|
946
|
+
FabricDataAgent = "fabricDataAgent",
|
|
947
|
+
/** Fabric Ontology document reference. */
|
|
948
|
+
FabricOntology = "fabricOntology",
|
|
949
|
+
/** MCP server document reference. */
|
|
950
|
+
McpServer = "mcpServer",
|
|
951
|
+
/** File document reference. */
|
|
952
|
+
File = "file",
|
|
953
|
+
/** Indexed SQL document reference. */
|
|
954
|
+
IndexedSql = "indexedSql"
|
|
446
955
|
}
|
|
447
956
|
/**
|
|
448
957
|
* The type of reference. \
|
|
@@ -451,8 +960,16 @@ export declare enum KnownKnowledgeBaseReferenceType {
|
|
|
451
960
|
* ### Known values supported by the service
|
|
452
961
|
* **searchIndex**: Search index document reference. \
|
|
453
962
|
* **azureBlob**: Azure Blob document reference. \
|
|
963
|
+
* **indexedSharePoint**: Indexed SharePoint document reference. \
|
|
454
964
|
* **indexedOneLake**: Indexed OneLake document reference. \
|
|
455
|
-
* **web**: Web document reference.
|
|
965
|
+
* **web**: Web document reference. \
|
|
966
|
+
* **remoteSharePoint**: Remote SharePoint document reference. \
|
|
967
|
+
* **workIQ**: Work IQ document reference. \
|
|
968
|
+
* **fabricDataAgent**: Fabric Data Agent document reference. \
|
|
969
|
+
* **fabricOntology**: Fabric Ontology document reference. \
|
|
970
|
+
* **mcpServer**: MCP server document reference. \
|
|
971
|
+
* **file**: File document reference. \
|
|
972
|
+
* **indexedSql**: Indexed SQL document reference.
|
|
456
973
|
*/
|
|
457
974
|
export type KnowledgeBaseReferenceType = string;
|
|
458
975
|
/** Represents an Azure Search document reference. */
|
|
@@ -461,22 +978,54 @@ export interface KnowledgeBaseSearchIndexReference extends KnowledgeBaseReferenc
|
|
|
461
978
|
type: "searchIndex";
|
|
462
979
|
/** The document key for the reference. */
|
|
463
980
|
docKey?: string;
|
|
981
|
+
/** The sensitivity label information for the reference. */
|
|
982
|
+
searchSensitivityLabelInfo?: PurviewSensitivityLabelInfo;
|
|
464
983
|
}
|
|
465
984
|
export declare function knowledgeBaseSearchIndexReferenceDeserializer(item: any): KnowledgeBaseSearchIndexReference;
|
|
985
|
+
/** Information about the sensitivity label applied to a document */
|
|
986
|
+
export interface PurviewSensitivityLabelInfo {
|
|
987
|
+
/** The display name for the sensitivity label. */
|
|
988
|
+
displayName?: string;
|
|
989
|
+
/** The ID of the sensitivity label. */
|
|
990
|
+
sensitivityLabelId?: string;
|
|
991
|
+
/** The tooltip that should be displayed for the label in a UI. */
|
|
992
|
+
toolTip?: string;
|
|
993
|
+
/** The priority in which the sensitivity label is applied. */
|
|
994
|
+
priority?: number;
|
|
995
|
+
/** The color that the UI should display for the label, if configured. */
|
|
996
|
+
color?: string;
|
|
997
|
+
/** Indicates whether the sensitivity label enforces encryption. */
|
|
998
|
+
isEncrypted?: boolean;
|
|
999
|
+
}
|
|
1000
|
+
export declare function purviewSensitivityLabelInfoDeserializer(item: any): PurviewSensitivityLabelInfo;
|
|
466
1001
|
/** Represents an Azure Blob Storage document reference. */
|
|
467
1002
|
export interface KnowledgeBaseAzureBlobReference extends KnowledgeBaseReference {
|
|
468
1003
|
/** The discriminator value. */
|
|
469
1004
|
type: "azureBlob";
|
|
470
1005
|
/** The blob URL for the reference. */
|
|
471
1006
|
blobUrl?: string;
|
|
1007
|
+
/** The sensitivity label information for the reference. */
|
|
1008
|
+
searchSensitivityLabelInfo?: PurviewSensitivityLabelInfo;
|
|
472
1009
|
}
|
|
473
1010
|
export declare function knowledgeBaseAzureBlobReferenceDeserializer(item: any): KnowledgeBaseAzureBlobReference;
|
|
1011
|
+
/** Represents an indexed SharePoint document reference. */
|
|
1012
|
+
export interface KnowledgeBaseIndexedSharePointReference extends KnowledgeBaseReference {
|
|
1013
|
+
/** The discriminator value. */
|
|
1014
|
+
type: "indexedSharePoint";
|
|
1015
|
+
/** The document URL for the reference. */
|
|
1016
|
+
docUrl?: string;
|
|
1017
|
+
/** The sensitivity label information for the reference. */
|
|
1018
|
+
searchSensitivityLabelInfo?: PurviewSensitivityLabelInfo;
|
|
1019
|
+
}
|
|
1020
|
+
export declare function knowledgeBaseIndexedSharePointReferenceDeserializer(item: any): KnowledgeBaseIndexedSharePointReference;
|
|
474
1021
|
/** Represents an indexed OneLake document reference. */
|
|
475
1022
|
export interface KnowledgeBaseIndexedOneLakeReference extends KnowledgeBaseReference {
|
|
476
1023
|
/** The discriminator value. */
|
|
477
1024
|
type: "indexedOneLake";
|
|
478
1025
|
/** The document URL for the reference. */
|
|
479
1026
|
docUrl?: string;
|
|
1027
|
+
/** The sensitivity label information for the reference. */
|
|
1028
|
+
searchSensitivityLabelInfo?: PurviewSensitivityLabelInfo;
|
|
480
1029
|
}
|
|
481
1030
|
export declare function knowledgeBaseIndexedOneLakeReferenceDeserializer(item: any): KnowledgeBaseIndexedOneLakeReference;
|
|
482
1031
|
/** Represents a web document reference. */
|
|
@@ -489,4 +1038,75 @@ export interface KnowledgeBaseWebReference extends KnowledgeBaseReference {
|
|
|
489
1038
|
title?: string;
|
|
490
1039
|
}
|
|
491
1040
|
export declare function knowledgeBaseWebReferenceDeserializer(item: any): KnowledgeBaseWebReference;
|
|
1041
|
+
/** Represents a remote SharePoint document reference. */
|
|
1042
|
+
export interface KnowledgeBaseRemoteSharePointReference extends KnowledgeBaseReference {
|
|
1043
|
+
/** The discriminator value. */
|
|
1044
|
+
type: "remoteSharePoint";
|
|
1045
|
+
/** The url the reference data originated from. */
|
|
1046
|
+
webUrl?: string;
|
|
1047
|
+
/** The sensitivity label information for the reference. */
|
|
1048
|
+
searchSensitivityLabelInfo?: PurviewSensitivityLabelInfo;
|
|
1049
|
+
}
|
|
1050
|
+
export declare function knowledgeBaseRemoteSharePointReferenceDeserializer(item: any): KnowledgeBaseRemoteSharePointReference;
|
|
1051
|
+
/** Represents a WorkIQ document reference. */
|
|
1052
|
+
export interface KnowledgeBaseWorkIQReference extends KnowledgeBaseReference {
|
|
1053
|
+
/** The discriminator value. */
|
|
1054
|
+
type: "workIQ";
|
|
1055
|
+
/** The attributions for the reference. */
|
|
1056
|
+
attributions?: WorkIQAttribution[];
|
|
1057
|
+
}
|
|
1058
|
+
export declare function knowledgeBaseWorkIQReferenceDeserializer(item: any): KnowledgeBaseWorkIQReference;
|
|
1059
|
+
export declare function workIQAttributionArrayDeserializer(result: Array<WorkIQAttribution>): any[];
|
|
1060
|
+
/** Attribution information for a WorkIQ reference. */
|
|
1061
|
+
export interface WorkIQAttribution {
|
|
1062
|
+
/** The URL for the attribution. */
|
|
1063
|
+
seeMoreWebUrl?: string;
|
|
1064
|
+
}
|
|
1065
|
+
export declare function workIQAttributionDeserializer(item: any): WorkIQAttribution;
|
|
1066
|
+
/** Represents a Fabric Data Agent document reference. */
|
|
1067
|
+
export interface KnowledgeBaseFabricDataAgentReference extends KnowledgeBaseReference {
|
|
1068
|
+
/** The discriminator value. */
|
|
1069
|
+
type: "fabricDataAgent";
|
|
1070
|
+
/** The Fabric workspace ID. */
|
|
1071
|
+
workspaceId?: string;
|
|
1072
|
+
/** The Fabric Data Agent ID. */
|
|
1073
|
+
dataAgentId?: string;
|
|
1074
|
+
}
|
|
1075
|
+
export declare function knowledgeBaseFabricDataAgentReferenceDeserializer(item: any): KnowledgeBaseFabricDataAgentReference;
|
|
1076
|
+
/** Represents a Fabric Ontology document reference. */
|
|
1077
|
+
export interface KnowledgeBaseFabricOntologyReference extends KnowledgeBaseReference {
|
|
1078
|
+
/** The discriminator value. */
|
|
1079
|
+
type: "fabricOntology";
|
|
1080
|
+
/** The Fabric workspace ID. */
|
|
1081
|
+
workspaceId?: string;
|
|
1082
|
+
/** The ontology ID within the workspace. */
|
|
1083
|
+
ontologyId?: string;
|
|
1084
|
+
}
|
|
1085
|
+
export declare function knowledgeBaseFabricOntologyReferenceDeserializer(item: any): KnowledgeBaseFabricOntologyReference;
|
|
1086
|
+
/** Represents an MCP server document reference. */
|
|
1087
|
+
export interface KnowledgeBaseMcpServerReference extends KnowledgeBaseReference {
|
|
1088
|
+
/** The discriminator value. */
|
|
1089
|
+
type: "mcpServer";
|
|
1090
|
+
/** The name of the MCP server tool that produced the reference. */
|
|
1091
|
+
toolName?: string;
|
|
1092
|
+
/** The title of the MCP server tool result. */
|
|
1093
|
+
title?: string;
|
|
1094
|
+
}
|
|
1095
|
+
export declare function knowledgeBaseMcpServerReferenceDeserializer(item: any): KnowledgeBaseMcpServerReference;
|
|
1096
|
+
/** Represents a file document reference. */
|
|
1097
|
+
export interface KnowledgeBaseFileReference extends KnowledgeBaseReference {
|
|
1098
|
+
/** The discriminator value. */
|
|
1099
|
+
type: "file";
|
|
1100
|
+
/** The document name for the reference. */
|
|
1101
|
+
docName?: string;
|
|
1102
|
+
}
|
|
1103
|
+
export declare function knowledgeBaseFileReferenceDeserializer(item: any): KnowledgeBaseFileReference;
|
|
1104
|
+
/** Represents an Azure SQL document reference. */
|
|
1105
|
+
export interface KnowledgeBaseIndexedSqlReference extends KnowledgeBaseReference {
|
|
1106
|
+
/** The discriminator value. */
|
|
1107
|
+
type: "indexedSql";
|
|
1108
|
+
/** The document URL for the reference. */
|
|
1109
|
+
docUrl?: string;
|
|
1110
|
+
}
|
|
1111
|
+
export declare function knowledgeBaseIndexedSqlReferenceDeserializer(item: any): KnowledgeBaseIndexedSqlReference;
|
|
492
1112
|
//# sourceMappingURL=models.d.ts.map
|