你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Knowledge Retrieval - Retrieve

服务:: Search Service

API 版本:: 2026-08-01-preview

知识库从备份存储中获取相关数据。

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	搜索服务的终结点 URL。
knowledgeBaseName	path	True	string	知识库的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	类型	说明
Accept	Accept	接受（Accept）首部。
x-ms-query-source-authorization	string	标识正在执行查询的用户的令牌。此令牌用于对文档实施安全限制。
x-ms-query-work-iq-source-authorization	string (password)	用户声明令牌用于在 Work IQ 知识源上配置的客户拥有的 Entra 应用注册。用于代表 Work IQ API 进行认证。
x-ms-client-request-id	string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

请求正文

名称	类型	说明
includeActivity	boolean	指示检索结果应包括活动信息。
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	无需模型查询规划即可执行的预期查询列表。
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	知识源的运行时参数列表。
maxOutputDocuments	integer (int32)	限制输出中最大文档数量。
maxOutputSize	integer (int32)	限制输出中内容的最大大小。
maxOutputSizeInTokens	integer (int32)	限制输出中内容的最大大小。
maxRuntimeInSeconds	integer (int32)	最大运行时间（以秒为单位）。
messages	KnowledgeBaseMessage[]	聊天消息样式输入的列表。
outputMode	KnowledgeRetrievalOutputMode	此检索的输出配置。
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	检索推理努力配置。

响应

名称	类型	说明
200 OK	KnowledgeBaseRetrievalResponse	成功取回。
Other Status Codes	KnowledgeBaseRetrievalResponse	部分提取反应。
Other Status Codes	ErrorResponse	未预期的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://search.azure.com/.default

示例

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

示例请求

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "neverQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

示例响应

状态代码:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

状态代码:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveAzureBlobImageServing

示例请求

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-azureblob-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "kind": "azureBlob",
      "enableImageServing": true
    }
  ]
}

示例响应

状态代码:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

状态代码:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

示例请求

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "intents": [
    {
      "type": "semantic",
      "search": "foo"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

示例响应

状态代码:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

状态代码:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithSourceExclusion

示例请求

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview




{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "Explain the SSO provisioning steps from the product documentation only.",
          "type": "text"
        }
      ]
    }
  ],
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "product-docs-ks",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "troubleshooting-ks",
      "neverQuerySource": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "release-notes-web",
      "neverQuerySource": true,
      "kind": "web"
    }
  ]
}

示例响应

状态代码:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 4,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

状态代码:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "Partial results were returned before the retrieval completed."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 1,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

定义

名称	说明
Accept	接受（Accept）首部。
AzureBlobKnowledgeSourceParams	指定 Azure Blob 知识源的运行时参数
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详情
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。
FabricDataAgentKnowledgeSourceParams	指定 Fabric Data Agent 知识源的运行时参数
FabricOntologyKnowledgeSourceParams	指定 Fabric 本体知识源的运行时参数
FileKnowledgeSourceParams	指定文件知识源的运行时参数
ImageServingStatistics	关于检索活动中图像服务的统计数据。
IndexedOneLakeKnowledgeSourceParams	指定索引 OneLake 知识源的运行时参数
IndexedSharePointKnowledgeSourceParams	指定索引 SharePoint 知识源的运行时参数
IndexedSqlKnowledgeSourceParams	指定索引SQL知识源的运行时参数
KnowledgeBaseActivityRecordModel	表示用于知识库LLM活动的模型，包括其模型名称和部署标识符。
KnowledgeBaseActivityRecordType	活动记录的类型。
KnowledgeBaseAgenticReasoningActivityRecord	表示代理推理活动记录。
KnowledgeBaseAzureBlobActivityArguments	表示运行 Azure Blob 检索活动时使用的参数。
KnowledgeBaseAzureBlobActivityRecord	表示 Azure Blob 检索活动记录。
KnowledgeBaseAzureBlobReference	表示 Azure Blob 存储文档引用。
KnowledgeBaseErrorAdditionalInfo	资源管理错误附加信息。
KnowledgeBaseErrorDetail	错误详情。
KnowledgeBaseFabricDataAgentActivityArguments	表示 Fabric Data Agent 检索活动所使用的参数。
KnowledgeBaseFabricDataAgentActivityRecord	表示 Fabric Data Agent 检索活动记录。
KnowledgeBaseFabricDataAgentReference	表示Fabric数据代理文档引用。
KnowledgeBaseFabricOntologyActivityArguments	代表 Fabric 本体检索活动所用的参数。
KnowledgeBaseFabricOntologyActivityRecord	表示 Fabric 本体检索活动记录。
KnowledgeBaseFabricOntologyReference	表示 Fabric 本体文档引用。
KnowledgeBaseFileActivityArguments	表示文件检索活动所用的参数。
KnowledgeBaseFileActivityRecord	表示文件检索活动记录。
KnowledgeBaseFileReference	表示文件文档引用。
KnowledgeBaseImageContent	图片内容。
KnowledgeBaseIndexedOneLakeActivityArguments	表示索引 OneLake 检索活动所用的参数。
KnowledgeBaseIndexedOneLakeActivityRecord	表示一个索引化的OneLake检索活动记录。
KnowledgeBaseIndexedOneLakeReference	表示一个索引的OneLake文档引用。
KnowledgeBaseIndexedSharePointActivityArguments	表示索引后的 SharePoint 检索活动所使用的参数。
KnowledgeBaseIndexedSharePointActivityRecord	表示一个索引化的 SharePoint 检索活动记录。
KnowledgeBaseIndexedSharePointReference	表示一个索引化的SharePoint文档引用。
KnowledgeBaseIndexedSqlActivityArguments	表示执行索引SQL检索活动时所使用参数。
KnowledgeBaseIndexedSqlActivityRecord	表示一个索引的SQL检索活动记录。
KnowledgeBaseIndexedSqlReference	代表Azure SQL文档引用。
KnowledgeBaseMcpServerActivityArguments	表示MCP服务器检索活动所使用的参数。
KnowledgeBaseMcpServerActivityRecord	表示MCP服务器检索活动记录。
KnowledgeBaseMcpServerReference	表示MCP服务器文档引用。
KnowledgeBaseMessage	自然语言消息样式对象。
KnowledgeBaseMessageContentType	消息内容的类型。
KnowledgeBaseMessageImageContent	图像消息类型。
KnowledgeBaseMessageTextContent	短信类型。
KnowledgeBaseModelAnswerSynthesisActivityRecord	表示 LLM 答案合成活动记录。
KnowledgeBaseModelQueryPlanningActivityRecord	表示 LLM 查询计划活动记录。
KnowledgeBaseModelWebSummarizationActivityRecord	表示一个大型语言模型（LLM）网络摘要活动记录。
KnowledgeBaseQueryHintProcessing	关于检索活动查询提示生成表达式的详细信息。
KnowledgeBaseReferenceType	引用的类型。
KnowledgeBaseRemoteSharePointActivityArguments	表示远程 SharePoint 检索活动所用的参数。
KnowledgeBaseRemoteSharePointActivityRecord	表示远程 SharePoint 检索活动记录。
KnowledgeBaseRemoteSharePointReference	表示远程 SharePoint 文档引用。
KnowledgeBaseRetrievalRequest	检索请求的输入协定。
KnowledgeBaseRetrievalResponse	检索响应的输出协定。
KnowledgeBaseSearchIndexActivityArguments	表示运行搜索索引检索活动时使用的参数。
KnowledgeBaseSearchIndexActivityRecord	表示搜索索引检索活动记录。
KnowledgeBaseSearchIndexReference	表示 Azure 搜索文档引用。
KnowledgeBaseWebActivityArguments	表示网页检索活动所用的参数。
KnowledgeBaseWebActivityRecord	表示网络检索活动记录。
KnowledgeBaseWebReference	表示 Web 文档引用。
KnowledgeBaseWorkIQActivityArguments	表示WorkIQ检索活动所用的参数。
KnowledgeBaseWorkIQActivityRecord	表示WorkIQ检索活动记录。
KnowledgeBaseWorkIQReference	表示 WorkIQ 文档引用。
KnowledgeRetrievalAutoReasoningEffort	检索时自动选择推理努力。服务会在最低层级为每个请求做种，并只在需要时逐步升级，直到服务的最高可用层级。
KnowledgeRetrievalIntentType	要使用的知识库配置类型。
KnowledgeRetrievalLowReasoningEffort	以较低的推理工作量运行知识检索。
KnowledgeRetrievalMediumReasoningEffort	以中等推理工作量运行知识检索。
KnowledgeRetrievalMinimalReasoningEffort	以最少的推理工作运行知识检索。
KnowledgeRetrievalOutputMode	此检索的输出配置。
KnowledgeRetrievalReasoningEffortKind	检索期间要使用的工作量。
KnowledgeRetrievalSemanticIntent	语义查询意图。
KnowledgeSourceKind	知识来源的那种。
KnowledgeSourceResultsProcessing	控制知识源的结果是否会被重新排序。
McpServerKnowledgeSourceParams	指定MCP服务器知识源的运行时参数
PurviewSensitivityLabelInfo	关于应用到文档上的敏感性标签的信息
QueryType	指定搜索查询的语法。默认值为“simple”。如果查询使用 Lucene 查询语法，请使用“full”，如果不需要查询语法，请使用“semantic”。
RemoteSharePointKnowledgeSourceParams	指定远程 SharePoint 知识源的运行时参数
SearchIndexFieldReference	搜索索引字段参考。
SearchIndexKnowledgeSourceBoostKind	这正是搜索索引知识源的提升提示。
SearchIndexKnowledgeSourceFieldValueBoost	一个基于字段值提升文档的提示。
SearchIndexKnowledgeSourceFilterHint	一个提示，用于识别字段和代表值，查询规划器可以在构建过滤器时使用。
SearchIndexKnowledgeSourceMultiWordExpressionBoost	一个基于多词表达式提升文档的提示。
SearchIndexKnowledgeSourceParams	指定搜索索引知识源的运行时参数
SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，使搜索索引知识源获得有用的筛选和提升。
ServedImage	描述模型在检索活动中选择服务的单一图像。
WebKnowledgeSourceParams	指定 Web 知识源的运行时参数
WorkIQKnowledgeSourceParams	指定WorkIQ知识源的运行时参数

Accept

枚举

接受（Accept）首部。

值	说明
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

对象

指定 Azure Blob 知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: azureBlob	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，帮助你进行有用的筛选和提升。如果指定，该对象将替换知识源上配置的完整查询提示集合。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详情

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误的附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详情。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

FabricDataAgentKnowledgeSourceParams

对象

指定 Fabric Data Agent 知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: fabricDataAgent	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

FabricOntologyKnowledgeSourceParams

对象

指定 Fabric 本体知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: fabricOntology	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

FileKnowledgeSourceParams

对象

指定文件知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: file	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，帮助你进行有用的筛选和提升。如果指定，该对象将替换知识源上配置的完整查询提示集合。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

ImageServingStatistics

对象

关于检索活动中图像服务的统计数据。

名称	类型	说明
imagesRetrieved	integer (int32)	从资源商店检索的图片数量。
imagesSentToModel	integer (int32)	发送到下游模型的图像数量。
servedImages	ServedImage[]	模型选择提供给下游模型进行此检索活动的图像集合。
totalImageSizeBytes	integer (int64)	以字节计，发送给模型的图像总大小。
verbalizationUsed	boolean	表示是否使用了图像语言化而非直接图像传递。

IndexedOneLakeKnowledgeSourceParams

对象

指定索引 OneLake 知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: indexedOneLake	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，帮助你进行有用的筛选和提升。如果指定，该对象将替换知识源上配置的完整查询提示集合。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

IndexedSharePointKnowledgeSourceParams

对象

指定索引 SharePoint 知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: indexedSharePoint	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，帮助你进行有用的筛选和提升。如果指定，该对象将替换知识源上配置的完整查询提示集合。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

IndexedSqlKnowledgeSourceParams

对象

指定索引SQL知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: indexedSql	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，帮助你进行有用的筛选和提升。如果指定，该对象将替换知识源上配置的完整查询提示集合。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

KnowledgeBaseActivityRecordModel

对象

表示用于知识库LLM活动的模型，包括其模型名称和部署标识符。

名称	类型	说明
deploymentId	string	用于该活动的模型的部署标识符。
modelName	string	活动所用的模型名称。

KnowledgeBaseActivityRecordType

枚举

活动记录的类型。

值	说明
searchIndex	搜索索引检索活动。
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	索引的SharePoint检索活动。
indexedOneLake	索引 OneLake 检索活动。
web	网络检索活动。
remoteSharePoint	远程SharePoint检索活动。
workIQ	WorkIQ 检索活动。
fabricDataAgent	Fabric 数据代理检索活动。
fabricOntology	Fabric 本体检索活动。
mcpServer	MCP服务器检索活动。
file	文件检索活动。
indexedSql	索引SQL检索活动。
modelQueryPlanning	LLM 查询规划活动。
modelAnswerSynthesis	LLM 答案综合活动。
modelWebSummarization	LLM 网络摘要活动。
agenticReasoning	能动推理活动。

KnowledgeBaseAgenticReasoningActivityRecord

对象

表示代理推理活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
logicalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	客户要求的逻辑推理努力。这与 `retrievalReasoningEffort`报告计费所用推理努力的函数不同。
reasoningTokens	integer (int32)	代理推理的输入标记数。
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	检索推理努力配置。
startedAt	string (date-time)	活动开始的时间。
type	string: agenticReasoning	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseAzureBlobActivityArguments

对象

表示运行 Azure Blob 检索活动时使用的参数。

名称	类型	说明
search	string	用于查询 blob 内容的搜索字符串。

KnowledgeBaseAzureBlobActivityRecord

对象

表示 Azure Blob 检索活动记录。

名称	类型	说明
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	检索活动的 azure blob 参数。
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	关于该活动中查询提示生成表达式的详细信息。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: azureBlob	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseAzureBlobReference

对象

表示 Azure Blob 存储文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
blobUrl	string	引用的 blob URL。
citationUrl	string (uri)	一个由搜索拥有的URL，指向该参考文献的背书，可用作引用目标。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参考的敏感性标签信息。
sourceData		参考文献的来源数据。
type	string: azureBlob	引用的类型。

KnowledgeBaseErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	其他信息类型。

KnowledgeBaseErrorDetail

对象

错误详情。

名称	类型	说明
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	错误的附加信息。
code	string	错误代码。
details	KnowledgeBaseErrorDetail[]	错误详情。
message	string	错误消息。
target	string	错误的目标。

KnowledgeBaseFabricDataAgentActivityArguments

对象

表示 Fabric Data Agent 检索活动所使用的参数。

名称	类型	说明
search	string	用于查询 Fabric 数据代理知识源的搜索字符串。

KnowledgeBaseFabricDataAgentActivityRecord

对象

表示 Fabric Data Agent 检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	检索活动的 Fabric 数据代理参数。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: fabricDataAgent	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseFabricDataAgentReference

对象

表示Fabric数据代理文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
dataAgentId	string	Fabric 数据代理 ID。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
sourceData		参考文献的来源数据。
type	string: fabricDataAgent	引用的类型。
workspaceId	string	Fabric工作区 ID。

KnowledgeBaseFabricOntologyActivityArguments

对象

代表 Fabric 本体检索活动所用的参数。

名称	类型	说明
search	string	用于查询 Fabric 本体知识源的搜索字符串。

KnowledgeBaseFabricOntologyActivityRecord

对象

表示 Fabric 本体检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	检索活动的Fabric本体论证。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: fabricOntology	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseFabricOntologyReference

对象

表示 Fabric 本体文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
id	string	引用的 ID。
ontologyId	string	工作区内的本体ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
sourceData		参考文献的来源数据。
type	string: fabricOntology	引用的类型。
workspaceId	string	Fabric工作区 ID。

KnowledgeBaseFileActivityArguments

对象

表示文件检索活动所用的参数。

名称	类型	说明
search	string	用于查询文件内容的搜索字符串。

KnowledgeBaseFileActivityRecord

对象

表示文件检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
fileArguments	KnowledgeBaseFileActivityArguments	文件为检索活动提供了论据。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	关于该活动中查询提示生成表达式的详细信息。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: file	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseFileReference

对象

表示文件文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
citationUrl	string (uri)	一个由搜索拥有的URL，指向该参考文献的背书，可用作引用目标。
docName	string	参考文献的名称。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
sourceData		参考文献的来源数据。
type	string: file	引用的类型。

KnowledgeBaseImageContent

对象

图片内容。

名称	类型	说明
url	string (uri)	图像的 URL。

KnowledgeBaseIndexedOneLakeActivityArguments

对象

表示索引 OneLake 检索活动所用的参数。

名称	类型	说明
search	string	用于查询索引 OneLake 内容的搜索字符串。

KnowledgeBaseIndexedOneLakeActivityRecord

对象

表示一个索引化的OneLake检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	索引的OneLake检索活动论证。
knowledgeSourceName	string	检索活动的知识源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	关于该活动中查询提示生成表达式的详细信息。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: indexedOneLake	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseIndexedOneLakeReference

对象

表示一个索引的OneLake文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
citationUrl	string (uri)	一个由搜索拥有的URL，指向该参考文献的背书，可用作引用目标。
docUrl	string	用于参考的文档 URL。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参考的敏感性标签信息。
sourceData		参考文献的来源数据。
type	string: indexedOneLake	引用的类型。

KnowledgeBaseIndexedSharePointActivityArguments

对象

表示索引后的 SharePoint 检索活动所使用的参数。

名称	类型	说明
search	string	用于查询已索引的SharePoint内容的搜索字符串。

KnowledgeBaseIndexedSharePointActivityRecord

对象

表示一个索引化的 SharePoint 检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	索引的SharePoint参数用于检索活动。
knowledgeSourceName	string	检索活动的知识源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	关于该活动中查询提示生成表达式的详细信息。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: indexedSharePoint	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseIndexedSharePointReference

对象

表示一个索引化的SharePoint文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
citationUrl	string (uri)	一个由搜索拥有的URL，指向该参考文献的背书，可用作引用目标。
docUrl	string	用于参考的文档 URL。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参考的敏感性标签信息。
sourceData		参考文献的来源数据。
type	string: indexedSharePoint	引用的类型。

KnowledgeBaseIndexedSqlActivityArguments

对象

表示执行索引SQL检索活动时所使用参数。

名称	类型	说明
search	string	用于查询索引SQL内容的搜索字符串。

KnowledgeBaseIndexedSqlActivityRecord

对象

表示一个索引的SQL检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	索引的SQL参数用于检索活动。
knowledgeSourceName	string	检索活动的知识源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	关于该活动中查询提示生成表达式的详细信息。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: indexedSql	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseIndexedSqlReference

对象

代表Azure SQL文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
citationUrl	string (uri)	一个由搜索拥有的URL，指向该参考文献的背书，可用作引用目标。
docUrl	string	用于参考的文档 URL。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
sourceData		参考文献的来源数据。
type	string: indexedSql	引用的类型。

KnowledgeBaseMcpServerActivityArguments

对象

表示MCP服务器检索活动所使用的参数。

名称	类型	说明
toolArguments		参数传递给MCP服务器工具。
toolName	string	用于检索活动的MCP服务器工具名称。

KnowledgeBaseMcpServerActivityRecord

对象

表示MCP服务器检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	MCP服务器为检索活动提供参数。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: mcpServer	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseMcpServerReference

对象

表示MCP服务器文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
sourceData		参考文献的来源数据。
title	string	MCP 服务器工具的标题。
toolName	string	生成该引用的MCP服务器工具名称。
type	string: mcpServer	引用的类型。

KnowledgeBaseMessage

对象

自然语言消息样式对象。

名称	类型	说明
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	消息的内容。
role	string	工具响应的作用。

KnowledgeBaseMessageContentType

枚举

消息内容的类型。

值	说明
text	短信内容类型。
image	图像消息内容类型。

KnowledgeBaseMessageImageContent

对象

图像消息类型。

名称	类型	说明
image	KnowledgeBaseImageContent	图片内容。
type	string: image	消息的类型

KnowledgeBaseMessageTextContent

对象

短信类型。

名称	类型	说明
text	string	文本内容。
type	string: text	消息的类型

KnowledgeBaseModelAnswerSynthesisActivityRecord

对象

表示 LLM 答案合成活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
inputTokens	integer (int32)	LLM 答案合成活动的输入令牌数。
model	KnowledgeBaseActivityRecordModel	用于大型语言模型答案综合活动的模型。
outputTokens	integer (int32)	LLM 答案合成活动的输出令牌数。
startedAt	string (date-time)	活动开始的时间。
type	string: modelAnswerSynthesis	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseModelQueryPlanningActivityRecord

对象

表示 LLM 查询计划活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
inputTokens	integer (int32)	LLM 查询规划活动的输入标记数。
model	KnowledgeBaseActivityRecordModel	用于LLM查询规划活动的模型。
outputTokens	integer (int32)	LLM 查询规划活动的输出令牌数。
startedAt	string (date-time)	活动开始的时间。
type	string: modelQueryPlanning	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseModelWebSummarizationActivityRecord

对象

表示一个大型语言模型（LLM）网络摘要活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
inputTokens	integer (int32)	LLM网络摘要活动的输入标记数量。
model	KnowledgeBaseActivityRecordModel	用于大型语言模型网页摘要活动的模型。
outputTokens	integer (int32)	LLM网络摘要活动的输出令牌数量。
startedAt	string (date-time)	活动开始的时间。
type	string: modelWebSummarization	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseQueryHintProcessing

对象

关于检索活动查询提示生成表达式的详细信息。

名称	类型	说明
generatedBoost	string	搜索条款是通过该活动的提升提示生成的。
generatedFilter	string	过滤提示生成的过滤器表达式用于该活动。

KnowledgeBaseReferenceType

枚举

引用的类型。

值	说明
searchIndex	搜索索引文档参考。
azureBlob	Azure Blob document reference.
indexedSharePoint	索引化的SharePoint文档引用。
indexedOneLake	索引 OneLake 文档参考。
web	网页文档引用。
remoteSharePoint	远程SharePoint文档参考。
workIQ	工作智商文档参考。
fabricDataAgent	Fabric 数据代理文档引用。
fabricOntology	Fabric 本体论文档参考。
mcpServer	MCP 服务器文档参考。
file	文件文档参考。
indexedSql	索引SQL文档引用。

KnowledgeBaseRemoteSharePointActivityArguments

对象

表示远程 SharePoint 检索活动所用的参数。

名称	类型	说明
filterExpressionAddOn	string	检索活动的过滤器表达式插件。
search	string	用于查询远程SharePoint知识源的搜索字符串。

KnowledgeBaseRemoteSharePointActivityRecord

对象

表示远程 SharePoint 检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryTime	string (date-time)	此检索活动的查询时间。
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	远程 SharePoint 参数用于检索活动。
startedAt	string (date-time)	活动开始的时间。
type	string: remoteSharePoint	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseRemoteSharePointReference

对象

表示远程 SharePoint 文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参考的敏感性标签信息。
sourceData		参考文献的来源数据。
type	string: remoteSharePoint	引用的类型。
webUrl	string (uri)	引用数据的来源 URL。

KnowledgeBaseRetrievalRequest

对象

检索请求的输入协定。

名称	类型	说明
includeActivity	boolean	指示检索结果应包括活动信息。
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	无需模型查询规划即可执行的预期查询列表。
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	知识源的运行时参数列表。
maxOutputDocuments	integer (int32)	限制输出中最大文档数量。
maxOutputSize	integer (int32)	限制输出中内容的最大大小。
maxOutputSizeInTokens	integer (int32)	限制输出中内容的最大大小。
maxRuntimeInSeconds	integer (int32)	最大运行时间（以秒为单位）。
messages	KnowledgeBaseMessage[]	聊天消息样式输入的列表。
outputMode	KnowledgeRetrievalOutputMode	此检索的输出配置。
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	检索推理努力配置。

KnowledgeBaseRetrievalResponse

对象

检索响应的输出协定。

名称	类型	说明
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	用于跟踪进度和计费影响的活动记录。
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	响应中使用的检索数据的引用。
response	KnowledgeBaseMessage[]	回复消息。
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	整体反应的敏感性标签信息。

KnowledgeBaseSearchIndexActivityArguments

对象

表示运行搜索索引检索活动时使用的参数。

名称	类型	说明
filter	string	筛选器字符串。
queryType	QueryType	执行搜索所使用的查询语法。查询提示可能导致语义查询使用完整的查询语法。
search	string	用于查询搜索索引的搜索字符串。
searchFields	SearchIndexFieldReference[]	搜索了哪些字段。
semanticConfigurationName	string	搜索索引中使用了什么语义配置？
sourceDataFields	SearchIndexFieldReference[]	搜索时选择了哪些字段。

KnowledgeBaseSearchIndexActivityRecord

对象

表示搜索索引检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	关于该活动中查询提示生成表达式的详细信息。
queryTime	string (date-time)	此检索活动的查询时间。
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	检索活动的搜索索引参数。
startedAt	string (date-time)	活动开始的时间。
type	string: searchIndex	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。

KnowledgeBaseSearchIndexReference

对象

表示 Azure 搜索文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
citationUrl	string (uri)	一个由搜索拥有的URL，指向该参考文献的背书，可用作引用目标。
docKey	string	引用的文档密钥。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参考的敏感性标签信息。
sourceData		参考文献的来源数据。
type	string: searchIndex	引用的类型。

KnowledgeBaseWebActivityArguments

对象

表示网页检索活动所用的参数。

名称	类型	说明
count	integer (int32)	返回的网页结果数量。
freshness	string	取回活动的新鲜度。
language	string	检索活动的语言。
market	string	回收活动的市场。
search	string	用于查询网络的搜索字符串。

KnowledgeBaseWebActivityRecord

对象

表示网络检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: web	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。
webArguments	KnowledgeBaseWebActivityArguments	网络论证支持检索活动。

KnowledgeBaseWebReference

对象

表示 Web 文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
sourceData		参考文献的来源数据。
title	string	Web 文档的标题。
type	string: web	引用的类型。
url	string (uri)	引用数据的来源 URL。

KnowledgeBaseWorkIQActivityArguments

对象

表示WorkIQ检索活动所用的参数。

名称	类型	说明
search	string	用于查询 WorkIQ 知识源的搜索字符串。

KnowledgeBaseWorkIQActivityRecord

对象

表示WorkIQ检索活动记录。

名称	类型	说明
completedAt	string (date-time)	活动结束的时间。
count	integer (int32)	检索到的足够相关以通过重新排序阈值的文档计数。
elapsedMs	integer (int32)	检索活动的经过时间（以毫秒为单位）。
error	KnowledgeBaseErrorDetail	解释作失败原因的错误详细信息。仅当活动不成功时，才会包含此属性。
id	integer (int32)	活动记录的 ID。
imageServing	ImageServingStatistics	关于该检索活动图像服务的统计数据
knowledgeSourceName	string	检索活动的知识源。
queryTime	string (date-time)	此检索活动的查询时间。
startedAt	string (date-time)	活动开始的时间。
type	string: workIQ	作业记录的类型。
warning	string	警告信息显示活动中可能出现的配置问题，如因分数阈值、令牌限制截断或超时条件导致文档丢弃。
workIQArguments	KnowledgeBaseWorkIQActivityArguments	WorkIQ关于检索活动的论证。

KnowledgeBaseWorkIQReference

对象

表示 WorkIQ 文档引用。

名称	类型	说明
activitySource	integer (int32)	引用的源活动 ID。
id	string	引用的 ID。
rerankerScore	number (float)	文档引用的重新排序器分数。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参考的敏感性标签信息。
sourceData		参考文献的来源数据。
type	string: workIQ	引用的类型。

KnowledgeRetrievalAutoReasoningEffort

对象

检索时自动选择推理努力。服务会在最低层级为每个请求做种，并只在需要时逐步升级，直到服务的最高可用层级。

名称	类型	说明
kind	string: auto	那种推理努力。

KnowledgeRetrievalIntentType

枚举

要使用的知识库配置类型。

值	说明
semantic	自然语言语义查询意向。

KnowledgeRetrievalLowReasoningEffort

对象

以较低的推理工作量运行知识检索。

名称	类型	说明
kind	string: low	那种推理努力。

KnowledgeRetrievalMediumReasoningEffort

对象

以中等推理工作量运行知识检索。

名称	类型	说明
kind	string: medium	那种推理努力。

KnowledgeRetrievalMinimalReasoningEffort

对象

以最少的推理工作运行知识检索。

名称	类型	说明
kind	string: minimal	那种推理努力。

KnowledgeRetrievalOutputMode

枚举

此检索的输出配置。

值	说明
extractiveData	直接从知识源返回数据，无需生成更改。
answerSynthesis	合成响应有效负载的答案。

KnowledgeRetrievalReasoningEffortKind

枚举

检索期间要使用的工作量。

值	说明
minimal	不执行任何源选择、查询规划或迭代搜索。
low	在检索过程中使用低推理。
medium	在检索过程中使用适量的推理。
auto	检索时自动选择推理努力，从最低层级逐步升级到所需范围。

KnowledgeRetrievalSemanticIntent

对象

语义查询意图。

名称	类型	说明
search	string	要执行的语义查询
type	string: semantic	意向的类型。

KnowledgeSourceKind

枚举

知识来源的那种。

值	说明
searchIndex	从搜索索引中读取数据的知识源。
azureBlob	用于读取数据并将其从 Azure Blob 存储引入搜索索引的知识源。
indexedSharePoint	一个读取索引 SharePoint 数据的知识源。
indexedOneLake	一个读取索引 OneLake 数据的知识源。
indexedSql	一个知识源，可以从Azure SQL 数据库或SQL 托管实例获取数据到搜索索引。
web	一个从网络读取数据的知识源。
remoteSharePoint	一个读取远程SharePoint数据的知识源。
workIQ	一个读取工作智商数据的知识源
file	一个支持直接文件上传和索引的知识源。
mcpServer	一个由MCP（模型上下文协议）服务器支持的知识源。
fabricDataAgent	一个从Fabric数据代理获取数据的知识源。
fabricOntology	一个从Microsoft Fabric本体中提取数据的知识源。

KnowledgeSourceResultsProcessing

枚举

控制知识源的结果是否会被重新排序。

值	说明
rerank	这些知识源的成果会经过重新排序流程。这是默认行为。
none	该知识源的结果绕过重新排序，保持其底层顺序。

McpServerKnowledgeSourceParams

对象

指定MCP服务器知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: mcpServer	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

PurviewSensitivityLabelInfo

对象

关于应用到文档上的敏感性标签的信息

名称	类型	说明
color	string	UI 应为标签显示的颜色（如果配置）。
displayName	string	敏感度标签的显示名称。
isEncrypted	boolean	指示敏感度标签是否强制加密。
priority	integer (int32)	应用敏感度标签的优先级。
sensitivityLabelId	string	敏感度标签的 ID。
toolTip	string	应为 UI 中的标签显示的工具提示。

QueryType

枚举

指定搜索查询的语法。默认值为“simple”。如果查询使用 Lucene 查询语法，请使用“full”，如果不需要查询语法，请使用“semantic”。

值	说明
simple	使用简单的查询语法进行搜索。搜索文本使用允许 +、* 和“”等符号的简单查询语言进行解释。默认情况下，查询会跨所有可搜索字段进行评估，除非指定了 searchFields 参数。
full	使用完整的 Lucene 查询语法进行搜索。使用 Lucene 查询语言解释搜索文本，该语言允许特定于字段的加权搜索以及其他高级功能。
semantic	最适合用自然语言而不是关键字表达的查询。通过使用在 Web 语料库上训练的排名模型对排名靠前的搜索结果进行重新排名，提高搜索结果的精度。

RemoteSharePointKnowledgeSourceParams

对象

指定远程 SharePoint 知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
filterExpressionAddOn	string	应用于 SharePoint 数据源的筛选条件。必须在关键字查询语言语法中指定它。它将与知识源定义中指定的筛选器表达式结合使用。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: remoteSharePoint	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

SearchIndexFieldReference

对象

搜索索引字段参考。

名称	类型	说明
name	string	字段的名称。

SearchIndexKnowledgeSourceBoostKind

枚举

这正是搜索索引知识源的提升提示。

值	说明
fieldValue	根据字段值提升文档。
multiWordExpression	基于多词表达式提升文档。

SearchIndexKnowledgeSourceFieldValueBoost

对象

一个基于字段值提升文档的提示。

名称	类型	说明
boost	number (double)	文档评分的乘数。必须是不等于 1.0 的正数。
boostInstructions	string	自然语言说明，说明何时以及如何应用加成。
field	string minLength: 1	搜索索引字段的名称。
fieldValues	string[]	场的代表性值。
kind	string: fieldValue	那种提升提示。

SearchIndexKnowledgeSourceFilterHint

对象

一个提示，用于识别字段和代表值，查询规划器可以在构建过滤器时使用。

名称	类型	说明
field	string minLength: 1	可筛选的搜索索引字段名称。
fieldValues	string[]	场的代表性值。
filterInstructions	string	自然语言说明，解释何时以及如何在场上过滤。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

对象

一个基于多词表达式提升文档的提示。

名称	类型	说明
boost	number (double)	文档评分的乘数。必须是不等于 1.0 的正数。
boostInstructions	string	自然语言说明，说明何时以及如何应用加成。
fieldValues	string[]	提升的代表性值。
kind	string: multiWordExpression	那种提升提示。

SearchIndexKnowledgeSourceParams

对象

指定搜索索引知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
filterAddOn	string	应用于索引的筛选条件（例如，“State eq VA”）。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: searchIndex	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，帮助你进行有用的筛选和提升。如果指定，该对象将替换知识源上配置的完整查询提示集合。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

SearchIndexKnowledgeSourceQueryHints

对象

指导查询规划的提示，使搜索索引知识源获得有用的筛选和提升。

名称	类型	说明
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	提升提示，识别查询规划器可用来影响文档排名的条件。
filters	SearchIndexKnowledgeSourceFilterHint[]	筛选提示，识别字段和代表性值，查询规划器在构建筛选时可以使用。

ServedImage

对象

描述模型在检索活动中选择服务的单一图像。

名称	类型	说明
imageId	string	图片标签是通过内容理解丰富从源文档中提取的。对应原始文档中的数字编号。
imagePath	string	资产商店中图像的相对路径。
sizeBytes	integer (int64)	该图像的字节大小（以字节计）发送给模型。

WebKnowledgeSourceParams

对象

指定 Web 知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
count	integer (int32)	要返回的 Web 结果数。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
freshness	string	网络结果的新鲜度。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: web	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
language	string	网络结果的语言。
market	string	网络结果的市场。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。

WorkIQKnowledgeSourceParams

对象

指定WorkIQ知识源的运行时参数

名称	类型	说明
alwaysQuerySource	boolean	指示此知识源应绕过源选择，并始终在检索时进行查询。
enableImageServing	boolean	指示在检索时是否应启用该知识源的图像服务。当为真时，在导入过程中提取的图像会传递给下游模型。
failOnError	boolean	表示如果从该知识源的检索遇到错误，整个检索请求应当失败。默认值为 false。
includeReferenceSourceData	boolean	指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferences	boolean	指示是否应为从此源检索的数据包含引用。
kind	string: workIQ	知识源的类型。
knowledgeSourceName	string	参数应用到的索引的名称。
maxOutputDocuments	integer (int32)	限制从该知识源返回的最大文档数量。
neverQuerySource	boolean	表示该知识源应从请求的候选集中排除，且检索时绝不查询。该排除是请求本地的，不会修改知识库成员资格。不能在同一知识源上与 alwaysQuerySource 合并使用。
rerankerThreshold	number (float)	所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
resultsProcessing	KnowledgeSourceResultsProcessing	覆盖知识源存储的结果，仅处理此检索调用。省略时，存储的知识源值适用。