Knowledge Retrieval - Retrieve

服務:: Search Service

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

知識庫會從支援存放區擷取相關資料。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	搜尋服務的端點 URL。
knowledgeBaseName	path	True	string	知識庫名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

名稱	類型	Description
Accept	Accept	接受標頭。
x-ms-query-source-authorization	string	識別正在執行查詢的使用者的權杖。此權杖可用來對文件強制執行安全性限制。
x-ms-query-work-iq-source-authorization	string (password)	用戶聲明令牌用於客戶擁有的 Entra 應用程式註冊，設定在 Work IQ 知識來源上。用於代表 Work IQ API 的認證。
x-ms-client-request-id	string (uuid)	要求不透明、全域唯一、用戶端產生的字串標識碼。

要求本文

名稱	類型	Description
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	檢索推理努力的配置。

回應

名稱	類型	Description
200 OK	KnowledgeBaseRetrievalResponse	成功取回。
Other Status Codes	KnowledgeBaseRetrievalResponse	部分取回反應。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

api-key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱	Description
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"
    }
  ]
}

定義

名稱	Description
Accept	接受標頭。
AzureBlobKnowledgeSourceParams	指定 Azure Blob 知識來源的執行階段參數
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager 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 Data Agent 文件參考。
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	代表網頁文件參照。
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

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Object

指定 Azure Blob 知識來源的執行階段參數

名稱	類型	Description
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

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info		其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤的其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error	ErrorDetail	error 物件。

FabricDataAgentKnowledgeSourceParams

Object

指定 Fabric Data Agent 知識來源的執行時參數

名稱	類型	Description
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

Object

指定 Fabric 本體知識來源的執行時參數

名稱	類型	Description
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

Object

指定檔案知識來源的執行時參數

名稱	類型	Description
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

Object

關於檢索活動期間影像服務的統計數據。

名稱	類型	Description
imagesRetrieved	integer (int32)	從資產商店取得的圖片數量。
imagesSentToModel	integer (int32)	傳送到下游模型的影像數量。
servedImages	ServedImage[]	模型選擇提供給下游模型進行此檢索活動的影像集合。
totalImageSizeBytes	integer (int64)	以位元組計，傳送到模型的影像總大小。
verbalizationUsed	boolean	表示是否使用了影像口述而非直接影像傳遞。

IndexedOneLakeKnowledgeSourceParams

Object

指定索引 OneLake 知識來源的執行階段參數

名稱	類型	Description
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

Object

指定已編製索引的 SharePoint 知識來源的執行階段參數

名稱	類型	Description
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

Object

指定索引 SQL 知識來源的執行時參數

名稱	類型	Description
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

Object

代表用於知識庫 LLM 活動的模型，包括其模型名稱與部署識別碼。

名稱	類型	Description
deploymentId	string	用於該活動的模型的部署識別碼。
modelName	string	活動所用的型號名稱。

KnowledgeBaseActivityRecordType

列舉型別

活動紀錄的類型。

值	Description
searchIndex	搜尋索引檢索活動。
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	索引 SharePoint 檢索活動。
indexedOneLake	索引 OneLake 檢索活動。
web	網路檢索活動。
remoteSharePoint	遠端 SharePoint 檢索活動。
workIQ	WorkIQ 檢索活動。
fabricDataAgent	Fabric Data Agent 檢索活動。
fabricOntology	Fabric 本體檢索活動。
mcpServer	MCP 伺服器檢索活動。
file	檔案檢索活動。
indexedSql	索引 SQL 檢索活動。
modelQueryPlanning	LLM 查詢規劃活動。
modelAnswerSynthesis	LLM 答案綜合活動。
modelWebSummarization	大型語言模型網頁摘要活動。
agenticReasoning	行動推理活動。

KnowledgeBaseAgenticReasoningActivityRecord

Object

代表代理推理活動記錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
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

Object

代表執行 Azure Blob 擷取活動時所使用的引數。

名稱	類型	Description
search	string	用來查詢 Blob 內容的搜尋字串。

KnowledgeBaseAzureBlobActivityRecord

Object

代表 Azure Blob 擷取活動記錄。

名稱	類型	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	擷取活動的 Azure Blob 引數。
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	關於此活動中查詢提示所產生表達式的詳細資訊。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: azureBlob	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseAzureBlobReference

Object

代表 Azure Blob 儲存體檔參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
blobUrl	string	參考的 Blob URL。
citationUrl	string (uri)	一個由搜尋擁有的網址，指向此參考文獻的後盾文件，可用作引用目標。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	參考文獻的敏感度標籤資訊。
sourceData		參考資料的來源資料。
type	string: azureBlob	參考的類型。

KnowledgeBaseErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info		其他資訊。
type	string	其他信息類型。

KnowledgeBaseErrorDetail

Object

錯誤詳情

名稱	類型	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	錯誤的其他資訊。
code	string	錯誤碼。
details	KnowledgeBaseErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

KnowledgeBaseFabricDataAgentActivityArguments

Object

代表 Fabric Data Agent 檢索活動所使用的參數。

名稱	類型	Description
search	string	用於查詢 Fabric Data Agent 知識來源的搜尋字串。

KnowledgeBaseFabricDataAgentActivityRecord

Object

代表 Fabric Data Agent 的檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	Fabric Data Agent 為檢索活動提供參數。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: fabricDataAgent	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseFabricDataAgentReference

Object

代表 Fabric Data Agent 文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
dataAgentId	string	Fabric 資料代理 ID。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
sourceData		參考資料的來源資料。
type	string: fabricDataAgent	參考的類型。
workspaceId	string	Fabric 工作區的 ID。

KnowledgeBaseFabricOntologyActivityArguments

Object

代表 Fabric 本體檢索活動所用的論點。

名稱	類型	Description
search	string	用於查詢 Fabric 本體知識來源的搜尋字串。

KnowledgeBaseFabricOntologyActivityRecord

Object

代表 Fabric 本體檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	Fabric 本體論對檢索活動的論證。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: fabricOntology	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseFabricOntologyReference

Object

代表 Fabric 本體文件的參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
id	string	參考的 ID。
ontologyId	string	工作空間內的本體 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
sourceData		參考資料的來源資料。
type	string: fabricOntology	參考的類型。
workspaceId	string	Fabric 工作區的 ID。

KnowledgeBaseFileActivityArguments

Object

代表檔案擷取活動所使用的參數。

名稱	類型	Description
search	string	用於查詢檔案內容的搜尋字串。

KnowledgeBaseFileActivityRecord

Object

代表檔案檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
fileArguments	KnowledgeBaseFileActivityArguments	檔案中擷取活動的論點。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	關於此活動中查詢提示所產生表達式的詳細資訊。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: file	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseFileReference

Object

代表檔案文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
citationUrl	string (uri)	一個由搜尋擁有的網址，指向此參考文獻的後盾文件，可用作引用目標。
docName	string	參考文件名稱。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
sourceData		參考資料的來源資料。
type	string: file	參考的類型。

KnowledgeBaseImageContent

Object

圖片內容。

名稱	類型	Description
url	string (uri)	影像的網址。

KnowledgeBaseIndexedOneLakeActivityArguments

Object

代表索引 OneLake 檢索活動所使用的參數。

名稱	類型	Description
search	string	用於查詢索引 OneLake 內容的搜尋字串。

KnowledgeBaseIndexedOneLakeActivityRecord

Object

代表一個索引的 OneLake 檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	索引 OneLake 的檢索活動論證。
knowledgeSourceName	string	擷取活動的知識來源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	關於此活動中查詢提示所產生表達式的詳細資訊。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: indexedOneLake	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseIndexedOneLakeReference

Object

代表一個索引 OneLake 文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
citationUrl	string (uri)	一個由搜尋擁有的網址，指向此參考文獻的後盾文件，可用作引用目標。
docUrl	string	參考的文件 URL。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	參考文獻的敏感度標籤資訊。
sourceData		參考資料的來源資料。
type	string: indexedOneLake	參考的類型。

KnowledgeBaseIndexedSharePointActivityArguments

Object

代表索引 SharePoint 檢索活動所使用的參數。

名稱	類型	Description
search	string	用來查詢已索引的 SharePoint 內容的搜尋字串。

KnowledgeBaseIndexedSharePointActivityRecord

Object

代表一個索引化的 SharePoint 檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	索引的 SharePoint 參數用於檢索活動。
knowledgeSourceName	string	擷取活動的知識來源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	關於此活動中查詢提示所產生表達式的詳細資訊。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: indexedSharePoint	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseIndexedSharePointReference

Object

代表一個索引化的 SharePoint 文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
citationUrl	string (uri)	一個由搜尋擁有的網址，指向此參考文獻的後盾文件，可用作引用目標。
docUrl	string	參考的文件 URL。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	參考文獻的敏感度標籤資訊。
sourceData		參考資料的來源資料。
type	string: indexedSharePoint	參考的類型。

KnowledgeBaseIndexedSqlActivityArguments

Object

代表索引 SQL 檢索活動所使用的參數。

名稱	類型	Description
search	string	用來查詢索引 SQL 內容的搜尋字串。

KnowledgeBaseIndexedSqlActivityRecord

Object

代表一個索引化的 SQL 檢索活動記錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	索引的 SQL 參數用於擷取活動。
knowledgeSourceName	string	擷取活動的知識來源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	關於此活動中查詢提示所產生表達式的詳細資訊。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: indexedSql	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseIndexedSqlReference

Object

代表一個 Azure SQL 文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
citationUrl	string (uri)	一個由搜尋擁有的網址，指向此參考文獻的後盾文件，可用作引用目標。
docUrl	string	參考的文件 URL。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
sourceData		參考資料的來源資料。
type	string: indexedSql	參考的類型。

KnowledgeBaseMcpServerActivityArguments

Object

代表 MCP 伺服器擷取活動所使用的參數。

名稱	類型	Description
toolArguments		參數會傳給 MCP 伺服器工具。
toolName	string	用於檢索活動的 MCP 伺服器工具名稱。

KnowledgeBaseMcpServerActivityRecord

Object

代表 MCP 伺服器檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	MCP 伺服器為擷取活動提供參數。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: mcpServer	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseMcpServerReference

Object

代表 MCP 伺服器文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
sourceData		參考資料的來源資料。
title	string	MCP 伺服器工具的標題。
toolName	string	產生參考的 MCP 伺服器工具名稱。
type	string: mcpServer	參考的類型。

KnowledgeBaseMessage

Object

自然語言訊息樣式物件。

名稱	類型	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	訊息的內容。
role	string	工具回應的作用。

KnowledgeBaseMessageContentType

列舉型別

訊息內容的類型。

值	Description
text	短信內容類型。
image	圖像訊息內容類型。

KnowledgeBaseMessageImageContent

Object

影像訊息類型。

名稱	類型	Description
image	KnowledgeBaseImageContent	圖片內容。
type	string: image	訊息的類型

KnowledgeBaseMessageTextContent

Object

簡訊類型。

名稱	類型	Description
text	string	文字內容。
type	string: text	訊息的類型

KnowledgeBaseModelAnswerSynthesisActivityRecord

Object

代表 LLM 答案綜合活動記錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
inputTokens	integer (int32)	LLM 答案合成活動的輸入權杖數目。
model	KnowledgeBaseActivityRecordModel	用於大型語言模型答案綜合活動的模型。
outputTokens	integer (int32)	LLM 答案綜合活動的輸出權杖數目。
startedAt	string (date-time)	活動開始的時間。
type	string: modelAnswerSynthesis	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseModelQueryPlanningActivityRecord

Object

代表 LLM 查詢規劃活動記錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
inputTokens	integer (int32)	LLM 查詢規劃活動的輸入權杖數目。
model	KnowledgeBaseActivityRecordModel	用於大型語言模型查詢規劃活動的模型。
outputTokens	integer (int32)	LLM 查詢規劃活動的輸出權杖數目。
startedAt	string (date-time)	活動開始的時間。
type	string: modelQueryPlanning	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseModelWebSummarizationActivityRecord

Object

代表一個大型語言模型（LLM）網頁摘要活動記錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
inputTokens	integer (int32)	LLM 網頁摘要活動的輸入標記數量。
model	KnowledgeBaseActivityRecordModel	用於大型語言模型網頁摘要活動的模型。
outputTokens	integer (int32)	LLM 網頁摘要活動的輸出代幣數量。
startedAt	string (date-time)	活動開始的時間。
type	string: modelWebSummarization	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseQueryHintProcessing

Object

關於查詢提示產生的運算式的詳細資訊，用於檢索活動。

名稱	類型	Description
generatedBoost	string	搜尋條款是從提升提示產生的。
generatedFilter	string	由過濾提示產生的過濾表達式用於此活動。

KnowledgeBaseReferenceType

列舉型別

參照的類型。

值	Description
searchIndex	搜尋索引文件參考。
azureBlob	Azure Blob document reference.
indexedSharePoint	索引化的 SharePoint 文件參考。
indexedOneLake	索引 OneLake 文件參考。
web	網頁文件參考。
remoteSharePoint	遠端 SharePoint 文件參考。
workIQ	工作智商文件參考。
fabricDataAgent	Fabric 資料代理文件參考。
fabricOntology	Fabric 本體文件參考。
mcpServer	MCP 伺服器文件參考。
file	檔案文件參考。
indexedSql	索引 SQL 文件參考。

KnowledgeBaseRemoteSharePointActivityArguments

Object

代表遠端 SharePoint 檢索活動所使用的參數。

名稱	類型	Description
filterExpressionAddOn	string	篩選式外掛用於擷取活動。
search	string	用來查詢遠端 SharePoint 知識來源的搜尋字串。

KnowledgeBaseRemoteSharePointActivityRecord

Object

代表遠端 SharePoint 檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryTime	string (date-time)	此擷取活動的查詢時間。
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	遠端 SharePoint 參數用於擷取活動。
startedAt	string (date-time)	活動開始的時間。
type	string: remoteSharePoint	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseRemoteSharePointReference

Object

代表遠端 SharePoint 文件參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	參考文獻的敏感度標籤資訊。
sourceData		參考資料的來源資料。
type	string: remoteSharePoint	參考的類型。
webUrl	string (uri)	參考資料的來源 URL。

KnowledgeBaseRetrievalRequest

Object

擷取要求的輸入合約。

名稱	類型	Description
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

Object

擷取回應的輸出合約。

名稱	類型	Description
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

Object

代表執行搜尋索引擷取活動時所使用的引數。

名稱	類型	Description
filter	string	篩選字串。
queryType	QueryType	執行搜尋所使用的查詢語法。查詢提示可能導致語意查詢使用完整的查詢語法。
search	string	用來查詢搜尋索引的搜尋字串。
searchFields	SearchIndexFieldReference[]	搜尋的欄位是哪些。
semanticConfigurationName	string	搜尋索引中使用了什麼語意配置？
sourceDataFields	SearchIndexFieldReference[]	選取了哪些欄位進行搜尋。

KnowledgeBaseSearchIndexActivityRecord

Object

代表搜尋索引擷取活動記錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryHintProcessing	KnowledgeBaseQueryHintProcessing	關於此活動中查詢提示所產生表達式的詳細資訊。
queryTime	string (date-time)	此擷取活動的查詢時間。
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	擷取活動的搜尋索引引數。
startedAt	string (date-time)	活動開始的時間。
type	string: searchIndex	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。

KnowledgeBaseSearchIndexReference

Object

代表 Azure 搜尋服務檔參考。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
citationUrl	string (uri)	一個由搜尋擁有的網址，指向此參考文獻的後盾文件，可用作引用目標。
docKey	string	參考的文件索引鍵。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	參考文獻的敏感度標籤資訊。
sourceData		參考資料的來源資料。
type	string: searchIndex	參考的類型。

KnowledgeBaseWebActivityArguments

Object

代表網頁檢索活動所用的論點。

名稱	類型	Description
count	integer (int32)	回傳的網頁結果數量。
freshness	string	取回活動的新鮮度。
language	string	取回活動的語言。
market	string	這是回收活動的市場。
search	string	用來查詢網路的搜尋字串。

KnowledgeBaseWebActivityRecord

Object

代表網路檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: web	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。
webArguments	KnowledgeBaseWebActivityArguments	網路上的論點支持檢索活動。

KnowledgeBaseWebReference

Object

代表網頁文件參照。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
sourceData		參考資料的來源資料。
title	string	Web 文件的標題。
type	string: web	參考的類型。
url	string (uri)	參考資料的來源 URL。

KnowledgeBaseWorkIQActivityArguments

Object

代表 WorkIQ 檢索活動所用的參數。

名稱	類型	Description
search	string	用來查詢 WorkIQ 知識來源的搜尋字串。

KnowledgeBaseWorkIQActivityRecord

Object

代表 WorkIQ 檢索活動紀錄。

名稱	類型	Description
completedAt	string (date-time)	活動結束的時間。
count	integer (int32)	檢索到的足夠相關的文件計數，足以通過重新排名閾值。
elapsedMs	integer (int32)	擷取活動的經過時間（以毫秒為單位）。
error	KnowledgeBaseErrorDetail	說明作業失敗原因的錯誤詳細資料。只有在活動未成功時，才會包含此屬性。
id	integer (int32)	活動記錄的識別碼。
imageServing	ImageServingStatistics	關於此檢索活動影像服務的統計資料
knowledgeSourceName	string	擷取活動的知識來源。
queryTime	string (date-time)	此擷取活動的查詢時間。
startedAt	string (date-time)	活動開始的時間。
type	string: workIQ	活動記錄的類型。
warning	string	警告訊息顯示活動中可能出現的設定問題，例如因分數閾值、令牌限制截斷或逾時條件而丟棄文件。
workIQArguments	KnowledgeBaseWorkIQActivityArguments	WorkIQ 關於檢索活動的論證。

KnowledgeBaseWorkIQReference

Object

代表 WorkIQ 文件引用。

名稱	類型	Description
activitySource	integer (int32)	參考的來源活動 ID。
id	string	參考的 ID。
rerankerScore	number (float)	文件參考的重新排名者分數。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	參考文獻的敏感度標籤資訊。
sourceData		參考資料的來源資料。
type	string: workIQ	參考的類型。

KnowledgeRetrievalAutoReasoningEffort

Object

檢索時自動選擇推理努力。服務會將每個請求放在最便宜的層級，並只會在需要時逐步升級，直到服務最高可用層級。

名稱	類型	Description
kind	string: auto	那種推理努力。

KnowledgeRetrievalIntentType

列舉型別

要使用的知識庫組態類型。

值	Description
semantic	自然語言語意查詢意圖。

KnowledgeRetrievalLowReasoningEffort

Object

以低推理工作量運行知識檢索。

名稱	類型	Description
kind	string: low	那種推理努力。

KnowledgeRetrievalMediumReasoningEffort

Object

以中等推理努力運行知識檢索。

名稱	類型	Description
kind	string: medium	那種推理努力。

KnowledgeRetrievalMinimalReasoningEffort

Object

以最少的推理工作執行知識檢索。

名稱	類型	Description
kind	string: minimal	那種推理努力。

KnowledgeRetrievalOutputMode

列舉型別

此擷取的輸出組態。

值	Description
extractiveData	直接從知識來源傳回資料，無需生成式變更。
answerSynthesis	合成回應承載的答案。

KnowledgeRetrievalReasoningEffortKind

列舉型別

擷取期間要使用的工作量。

值	Description
minimal	不會執行任何來源選取、查詢規劃或反覆搜尋。
low	在檢索期間使用低推理。
medium	在檢索過程中使用適量的推理。
auto	在取回時自動選擇推理努力，從最低層級逐步升級到所需程度。

KnowledgeRetrievalSemanticIntent

Object

語意查詢意圖。

名稱	類型	Description
search	string	要執行的語意查詢
type	string: semantic	意圖的類型。

KnowledgeSourceKind

列舉型別

知識來源的那種。

值	Description
searchIndex	從搜尋索引讀取資料的知識來源。
azureBlob	從 Azure Blob 儲存體讀取資料並將其擷取至搜尋索引的知識來源。
indexedSharePoint	一個讀取索引 SharePoint 資料的知識來源。
indexedOneLake	一個讀取索引 OneLake 資料的知識來源。
indexedSql	一個知識來源，能從 Azure SQL Database 或 SQL 受管理執行個體擷取並匯入資料到搜尋索引。
web	一個能從網路讀取資料的知識來源。
remoteSharePoint	一個能從遠端 SharePoint 讀取資料的知識來源。
workIQ	一個讀取工作智商數據的知識來源
file	一個支援直接檔案上傳與索引的知識來源。
mcpServer	一個由MCP（模型情境協定）伺服器支持的知識來源。
fabricDataAgent	一個從 Fabric 資料代理擷取資料的知識來源。
fabricOntology	一個從 Microsoft Fabric 本體論中擷取資料的知識來源。

KnowledgeSourceResultsProcessing

列舉型別

控制知識來源的結果是否會被重新排序。

值	Description
rerank	這些知識來源的成果會經過重新排序的流程。此為預設行為。
none	這些知識來源的結果可繞過重新排序，保留其底層順序。

McpServerKnowledgeSourceParams

Object

指定 MCP 伺服器知識來源的執行參數

名稱	類型	Description
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

Object

關於套用於文件上的敏感性標籤資訊

名稱	類型	Description
color	string	如果已設定，UI 應該針對標籤顯示的色彩。
displayName	string	敏感度標籤的顯示名稱。
isEncrypted	boolean	指出敏感度標籤是否強制執行加密。
priority	integer (int32)	套用敏感度標籤的優先順序。
sensitivityLabelId	string	敏感度標籤的識別碼。
toolTip	string	應在 UI 中針對標籤顯示的工具提示。

QueryType

列舉型別

指定搜尋查詢的語法。預設值為『simple』。如果您的查詢使用 Lucene 查詢語法，請使用 'full'，如果不需要查詢語法，請使用 'semantic'。

值	Description
simple	使用簡單的查詢語法進行搜尋。搜尋文字是使用簡單的查詢語言來解譯，該語言允許 +、* 和 “” 等符號。依預設，除非指定 searchFields 參數，否則會在所有可搜尋欄位中評估查詢。
full	使用完整的 Lucene 查詢語法進行搜尋。搜尋文字會使用 Lucene 查詢語言解譯，該語言允許欄位特定和加權搜尋，以及其他進階功能。
semantic	最適合以自然語言而不是關鍵字表達的查詢。通過使用在 Web 語料庫上訓練的排名模型重新排名排名排名，提高搜索結果的準確性。

RemoteSharePointKnowledgeSourceParams

Object

指定遠端 SharePoint 知識來源的執行階段參數

名稱	類型	Description
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

Object

搜尋索引的欄位參考。

名稱	類型	Description
name	string	欄位的名稱。

SearchIndexKnowledgeSourceBoostKind

列舉型別

這是搜尋索引資訊來源的提升提示。

值	Description
fieldValue	根據欄位值提升文件。
multiWordExpression	根據多詞表達式提升文件。

SearchIndexKnowledgeSourceFieldValueBoost

Object

一個提示，根據欄位值提升文件。

名稱	類型	Description
boost	number (double)	文件分數的乘數。必須是不等於 1.0 的正數。
boostInstructions	string	自然語言說明何時以及如何施加加成。
field	string minLength: 1	搜尋索引欄位的名稱。
fieldValues	string[]	該場的代表性值。
kind	string: fieldValue	那種加速提示。

SearchIndexKnowledgeSourceFilterHint

Object

一個提示，標示欄位及代表性值，查詢規劃器在建構過濾器時可以使用。

名稱	類型	Description
field	string minLength: 1	可篩選搜尋索引欄位的名稱。
fieldValues	string[]	該場的代表性值。
filterInstructions	string	自然語言教學，說明何時以及如何在場上篩選。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Object

一個基於多字表達式提升文件的提示。

名稱	類型	Description
boost	number (double)	文件分數的乘數。必須是不等於 1.0 的正數。
boostInstructions	string	自然語言說明何時以及如何施加加成。
fieldValues	string[]	代表性的加速值。
kind	string: multiWordExpression	那種加速提示。

SearchIndexKnowledgeSourceParams

Object

指定搜尋索引知識來源的執行階段參數

名稱	類型	Description
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

Object

指引查詢規劃，為搜尋索引知識來源提供有用的篩選與提升。

名稱	類型	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	提升提示，指出查詢規劃者可用來影響文件排名的條件。
filters	SearchIndexKnowledgeSourceFilterHint[]	篩選提示，識別欄位與代表性值，查詢規劃器在構建篩選時可用。

ServedImage

Object

描述模型在檢索活動中選擇提供的單一影像。

名稱	類型	Description
imageId	string	圖片標籤是透過內容理解豐富從原始文件擷取的。與原始文件中的數字編號相符。
imagePath	string	資產商店中圖片的相對路徑。
sizeBytes	integer (int64)	此影像的大小（以位元組計）傳送給模型。

WebKnowledgeSourceParams

Object

指定 Web 知識來源的執行階段參數

名稱	類型	Description
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

Object

指定 WorkIQ 知識來源的執行時參數

名稱	類型	Description
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	僅覆蓋知識來源儲存的結果，處理此擷取呼叫。若省略，則適用儲存的知識來源值。