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)	顧客所有のEntraアプリ登録のためのユーザーアサーショントークンは、Work IQナレッジソース上で設定されています。 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
Authorization URL (承認 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 Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
FabricDataAgentKnowledgeSourceParams	Fabric Data Agentの知識ソースの実行時パラメータを指定します
FabricOntologyKnowledgeSourceParams	Fabric Ontologyの知識ソースの実行パラメータを指定します
FileKnowledgeSourceParams	ファイル知識ソースの実行時パラメータを指定します
ImageServingStatistics	検索活動中の画像供給に関する統計。
IndexedOneLakeKnowledgeSourceParams	インデックス付き OneLake ナレッジソースのランタイムパラメーターを指定します
IndexedSharePointKnowledgeSourceParams	インデックス付き SharePoint ナレッジソースのランタイムパラメーターを指定します
IndexedSqlKnowledgeSourceParams	インデックス化されたSQL知識ソースのランタイムパラメータを指定します
KnowledgeBaseActivityRecordModel	ナレッジベースLLM活動に使用されるモデルを表し、モデル名および展開識別子を含みます。
KnowledgeBaseActivityRecordType	活動の種類。
KnowledgeBaseAgenticReasoningActivityRecord	エージェント推論アクティビティー・レコードを表します。
KnowledgeBaseAzureBlobActivityArguments	Azure BLOB 取得アクティビティが実行された引数を表します。
KnowledgeBaseAzureBlobActivityRecord	Azure BLOB 取得アクティビティレコードを表します。
KnowledgeBaseAzureBlobReference	Azure Blob Storage ドキュメント参照を表します。
KnowledgeBaseErrorAdditionalInfo	リソース管理エラーの追加情報
KnowledgeBaseErrorDetail	エラーの詳細。
KnowledgeBaseFabricDataAgentActivityArguments	Fabric Data Agentの取得活動が実行された引数を表します。
KnowledgeBaseFabricDataAgentActivityRecord	Fabric Data Agentの取得活動レコードを表します。
KnowledgeBaseFabricDataAgentReference	Fabric Data Agentのドキュメント参照を表します。
KnowledgeBaseFabricOntologyActivityArguments	Fabric Ontologyの検索活動が実行された引数を表しています。
KnowledgeBaseFabricOntologyActivityRecord	Fabric Ontologyの検索活動レコードを表します。
KnowledgeBaseFabricOntologyReference	Fabric Ontologyドキュメント参照を表します。
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 Search ドキュメント参照を表します。
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

Object

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

Object

リソース管理エラーの追加情報

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

FabricDataAgentKnowledgeSourceParams

Object

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

Object

Fabric Ontologyの知識ソースの実行パラメータを指定します

名前	型	説明
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

ファイル知識ソースの実行時パラメータを指定します

名前	型	説明
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

検索活動中の画像供給に関する統計。

名前	型	説明
imagesRetrieved	integer (int32)	アセットストアから取得した画像の数。
imagesSentToModel	integer (int32)	下流モデルに送信される画像の数。
servedImages	ServedImage[]	モデルが選択して下流モデルに提供した画像のセット。
totalImageSizeBytes	integer (int64)	モデルに送られた画像の総サイズ(バイト単位)。
verbalizationUsed	boolean	画像の言語化が直接的な画像提供ではなく使用されたかどうかを示します。

IndexedOneLakeKnowledgeSourceParams

Object

インデックス付き 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

Object

インデックス付き 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

Object

インデックス化された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

Object

ナレッジベースLLM活動に使用されるモデルを表し、モデル名および展開識別子を含みます。

名前	型	説明
deploymentId	string	アクティビティに使用されるモデルのデプロイメント識別子。
modelName	string	この活動に使われたモデルの名前。

KnowledgeBaseActivityRecordType

列挙

活動の種類。

値	説明
searchIndex	検索インデックス検索活動。
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	インデックス化されたSharePointの検索活動。
indexedOneLake	インデックス化されたOneLake検索活動。
web	ウェブ検索活動。
remoteSharePoint	リモートSharePointの取得活動。
workIQ	WorkIQの検索活動。
fabricDataAgent	Fabric Data Agentの取得活動。
fabricOntology	Fabric Ontologyの検索活動。
mcpServer	MCPサーバーの検索活動。
file	ファイル検索活動。
indexedSql	インデックス化されたSQL検索活動。
modelQueryPlanning	LLMクエリ計画活動。
modelAnswerSynthesis	LLMの回答統合活動。
modelWebSummarization	LLMのウェブ要約活動。
agenticReasoning	主体的推論活動。

KnowledgeBaseAgenticReasoningActivityRecord

Object

エージェント推論アクティビティー・レコードを表します。

名前	型	説明
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

Object

Azure BLOB 取得アクティビティが実行された引数を表します。

名前	型	説明
search	string	BLOB コンテンツのクエリに使用される検索文字列。

KnowledgeBaseAzureBlobActivityRecord

Object

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

Object

Azure Blob Storage ドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
blobUrl	string	参照の BLOB URL。
citationUrl	string (uri)	この参考文献の裏付けとなるSearch所有のURLで、引用対象として使えます。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参照の感度ラベル情報。
sourceData		参考文献の出典データ。
type	string: azureBlob	参照のタイプ。

KnowledgeBaseErrorAdditionalInfo

Object

リソース管理エラーの追加情報

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

KnowledgeBaseErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラーコード。
details	KnowledgeBaseErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーの対象。

KnowledgeBaseFabricDataAgentActivityArguments

Object

Fabric Data Agentの取得活動が実行された引数を表します。

名前	型	説明
search	string	Fabric Data Agentの知識ソースをクエリするために使われる検索文字列。

KnowledgeBaseFabricDataAgentActivityRecord

Object

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

Object

Fabric Data Agentのドキュメント参照を表します。

名前	型	説明
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 Ontologyの検索活動が実行された引数を表しています。

名前	型	説明
search	string	Fabric Ontologyの知識ソースをクエリするために使われる検索文字列。

KnowledgeBaseFabricOntologyActivityRecord

Object

Fabric Ontologyの検索活動レコードを表します。

名前	型	説明
completedAt	string (date-time)	活動が完了した時刻。
count	integer (int32)	リランカーのしきい値を超えるのに十分な関連性を持つ取得されたドキュメントの数。
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	検索活動のためのFabric Ontologyの議論。
id	integer (int32)	アクティビティレコードの ID。
imageServing	ImageServingStatistics	この検索活動における画像供給に関する統計
knowledgeSourceName	string	取得アクティビティのナレッジソース。
queryTime	string (date-time)	この取得アクティビティのクエリ時間。
startedAt	string (date-time)	活動が始まった時間。
type	string: fabricOntology	アクティビティレコードのタイプ。
warning	string	アクティビティ中に観察された可能性のある設定問題、例えばスコア閾値による文書のドロップ、トークン制限の切断、タイムアウト条件などを提示する警告メッセージ。

KnowledgeBaseFabricOntologyReference

Object

Fabric Ontologyドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
id	string	参照の ID。
ontologyId	string	ワークスペース内のオントロジーIDです。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
sourceData		参考文献の出典データ。
type	string: fabricOntology	参照のタイプ。
workspaceId	string	Fabric ワークスペースの IDです。

KnowledgeBaseFileActivityArguments

Object

ファイル取得活動が実行された引数を表しています。

名前	型	説明
search	string	ファイルの内容を照会するための検索文字列。

KnowledgeBaseFileActivityRecord

Object

ファイル取得活動記録を表します。

名前	型	説明
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

Object

ファイルドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
citationUrl	string (uri)	この参考文献の裏付けとなるSearch所有のURLで、引用対象として使えます。
docName	string	参照の文書名。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
sourceData		参考文献の出典データ。
type	string: file	参照のタイプ。

KnowledgeBaseImageContent

Object

画像の内容。

名前	型	説明
url	string (uri)	画像の URL。

KnowledgeBaseIndexedOneLakeActivityArguments

Object

インデックス化されたOneLakeの検索活動が実行された引数を表しています。

名前	型	説明
search	string	OneLakeのインデックス付きコンテンツにクエリを出すために使われる検索文字列。

KnowledgeBaseIndexedOneLakeActivityRecord

Object

インデックス化された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

Object

インデックス付きOneLakeドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
citationUrl	string (uri)	この参考文献の裏付けとなるSearch所有のURLで、引用対象として使えます。
docUrl	string	参照用のドキュメント URL。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参照の感度ラベル情報。
sourceData		参考文献の出典データ。
type	string: indexedOneLake	参照のタイプ。

KnowledgeBaseIndexedSharePointActivityArguments

Object

インデックス化されたSharePointの検索活動が実行された引数を表します。

名前	型	説明
search	string	インデックス化されたSharePointのコンテンツをクエリするために使われる検索文字列。

KnowledgeBaseIndexedSharePointActivityRecord

Object

インデックス化された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

Object

インデックス化されたSharePointドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
citationUrl	string (uri)	この参考文献の裏付けとなるSearch所有のURLで、引用対象として使えます。
docUrl	string	参照用のドキュメント URL。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参照の感度ラベル情報。
sourceData		参考文献の出典データ。
type	string: indexedSharePoint	参照のタイプ。

KnowledgeBaseIndexedSqlActivityArguments

Object

インデックス化されたSQL検索活動が実行された引数を表します。

名前	型	説明
search	string	インデックスされたSQL内容をクエリするために使われる検索文字列。

KnowledgeBaseIndexedSqlActivityRecord

Object

インデックス化された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

Object

Azure SQL ドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
citationUrl	string (uri)	この参考文献の裏付けとなるSearch所有のURLで、引用対象として使えます。
docUrl	string	参照用のドキュメント URL。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
sourceData		参考文献の出典データ。
type	string: indexedSql	参照のタイプ。

KnowledgeBaseMcpServerActivityArguments

Object

MCPサーバーの取得活動が実行された引数を表します。

名前	型	説明
toolArguments		引数はMCPサーバーツールに渡されます。
toolName	string	この検索活動に使用されたMCPサーバーツールの名前です。

KnowledgeBaseMcpServerActivityRecord

Object

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

Object

MCPサーバードキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
sourceData		参考文献の出典データ。
title	string	MCPサーバーツールのタイトルが結果として現れました。
toolName	string	参照を生成したMCPサーバーツールの名前。
type	string: mcpServer	参照のタイプ。

KnowledgeBaseMessage

Object

自然言語メッセージスタイルオブジェクト。

名前	型	説明
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	メッセージの内容。
role	string	ツール応答の役割。

KnowledgeBaseMessageContentType

列挙

メッセージコンテンツの種類。

値	説明
text	テキストメッセージコンテンツの種類。
image	画像メッセージコンテンツの種類。

KnowledgeBaseMessageImageContent

Object

画像メッセージの種類。

名前	型	説明
image	KnowledgeBaseImageContent	画像の内容。
type	string: image	メッセージのタイプ

KnowledgeBaseMessageTextContent

Object

テキストメッセージの種類。

名前	型	説明
text	string	文章内容。
type	string: text	メッセージのタイプ

KnowledgeBaseModelAnswerSynthesisActivityRecord

Object

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: modelAnswerSynthesis	アクティビティレコードのタイプ。
warning	string	アクティビティ中に観察された可能性のある設定問題、例えばスコア閾値による文書のドロップ、トークン制限の切断、タイムアウト条件などを提示する警告メッセージ。

KnowledgeBaseModelQueryPlanningActivityRecord

Object

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

Object

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: modelWebSummarization	アクティビティレコードのタイプ。
warning	string	アクティビティ中に観察された可能性のある設定問題、例えばスコア閾値による文書のドロップ、トークン制限の切断、タイムアウト条件などを提示する警告メッセージ。

KnowledgeBaseQueryHintProcessing

Object

検索活動のクエリヒントから生成される式の詳細。

名前	型	説明
generatedBoost	string	この活動のヒントから生成された検索条項。
generatedFilter	string	この活動のフィルターヒントから生成されるフィルター式。

KnowledgeBaseReferenceType

列挙

参照の種類。

値	説明
searchIndex	検索インデックス文書参照。
azureBlob	Azure Blob document reference.
indexedSharePoint	インデックス化されたSharePointドキュメント参照。
indexedOneLake	インデックス化されたOneLake文書参照。
web	ウェブ文書参照。
remoteSharePoint	リモートSharePointドキュメント参照。
workIQ	ワークIQ文書参照。
fabricDataAgent	Fabric Data Agent ドキュメント参照。
fabricOntology	Fabric Ontologyドキュメント参照。
mcpServer	MCPサーバードキュメント参照。
file	ファイルドキュメント参照。
indexedSql	インデックス化されたSQLドキュメント参照。

KnowledgeBaseRemoteSharePointActivityArguments

Object

リモートSharePointの取得アクティビティが実行された引数を表しています。

名前	型	説明
filterExpressionAddOn	string	検索活動用のフィルター式アドオンです。
search	string	リモートのSharePointナレッジソースをクエリするために使われる検索文字列。

KnowledgeBaseRemoteSharePointActivityRecord

Object

リモートの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

Object

リモート SharePoint ドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参照の感度ラベル情報。
sourceData		参考文献の出典データ。
type	string: remoteSharePoint	参照のタイプ。
webUrl	string (uri)	参照データの発信元の URL。

KnowledgeBaseRetrievalRequest

Object

取得要求の入力コントラクト。

名前	型	説明
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

取得応答の出力コントラクト。

名前	型	説明
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

検索インデックス取得アクティビティが実行された引数を表します。

名前	型	説明
filter	string	フィルター文字列。
queryType	QueryType	検索を実行するために使われたクエリ構文。クエリヒントは、セマンティック検索に完全なクエリ構文を使う原因となることがあります。
search	string	検索インデックスを問い合わせるための検索文字列。
searchFields	SearchIndexFieldReference[]	どのフィールドが検索されたか。
semanticConfigurationName	string	検索インデックスからどのような意味構成が使われたか。
sourceDataFields	SearchIndexFieldReference[]	検索のために選択されたフィールド。

KnowledgeBaseSearchIndexActivityRecord

Object

検索索引取得アクティビティー・レコードを表します。

名前	型	説明
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

Object

Azure Search ドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
citationUrl	string (uri)	この参考文献の裏付けとなるSearch所有のURLで、引用対象として使えます。
docKey	string	参照のドキュメントキー。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参照の感度ラベル情報。
sourceData		参考文献の出典データ。
type	string: searchIndex	参照のタイプ。

KnowledgeBaseWebActivityArguments

Object

ウェブ検索活動が実行された引数を表しています。

名前	型	説明
count	integer (int32)	返されたウェブ結果の数。
freshness	string	回収活動のための新鮮さ。
language	string	検索活動の言語。
market	string	回収活動の市場。
search	string	ウェブ検索に使われる検索文字列。

KnowledgeBaseWebActivityRecord

Object

ウェブ検索活動記録を表します。

名前	型	説明
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

Object

Web ドキュメント参照を表します。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
sourceData		参考文献の出典データ。
title	string	Web ドキュメントのタイトル。
type	string: web	参照のタイプ。
url	string (uri)	参照データの発信元の URL。

KnowledgeBaseWorkIQActivityArguments

Object

WorkIQ検索活動が実行された引数を表しています。

名前	型	説明
search	string	WorkIQの知識ソースをクエリするために使われる検索文字列。

KnowledgeBaseWorkIQActivityRecord

Object

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

Object

WorkIQドキュメント参照を表しています。

名前	型	説明
activitySource	integer (int32)	参照のソース・アクティビティー ID。
id	string	参照の ID。
rerankerScore	number (float)	ドキュメント参照のリランカースコア。
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	参照の感度ラベル情報。
sourceData		参考文献の出典データ。
type	string: workIQ	参照のタイプ。

KnowledgeRetrievalAutoReasoningEffort

Object

検索時に自動的に推論努力を選択します。サービスはすべてのリクエストを最も安価なティアでシードし、サービスの最大利用可能なティアまで必要な範囲でのみエスカレーションします。

名前	型	説明
kind	string: auto	推論の努力のようなものです。

KnowledgeRetrievalIntentType

列挙

使用するナレッジベースの構成の種類。

値	説明
semantic	自然言語セマンティッククエリインテント。

KnowledgeRetrievalLowReasoningEffort

Object

知識検索は、推論の手間を抑えて実行しましょう。

名前	型	説明
kind	string: low	推論の努力のようなものです。

KnowledgeRetrievalMediumReasoningEffort

Object

中程度の推論作業で知識検索を実行します。

名前	型	説明
kind	string: medium	推論の努力のようなものです。

KnowledgeRetrievalMinimalReasoningEffort

Object

最小限の推論で知識検索を実行しましょう。

名前	型	説明
kind	string: minimal	推論の努力のようなものです。

KnowledgeRetrievalOutputMode

列挙

この取得の出力設定。

値	説明
extractiveData	生成変更なしでナレッジソースから直接データを返します。
answerSynthesis	応答ペイロードの回答を合成します。

KnowledgeRetrievalReasoningEffortKind

列挙

取得中に使用する作業量。

値	説明
minimal	ソースの選択、クエリの計画、または反復検索は実行しません。
low	検索中は低い推論を使用します。
medium	検索中は適度な量の推論を使用します。
auto	回収時に自動的に理由付けの努力を選択し、最も安い階層から必要な範囲だけエスカレーションします。

KnowledgeRetrievalSemanticIntent

Object

意味論的なクエリの意図です。

名前	型	説明
search	string	実行するセマンティッククエリ
type	string: semantic	インテントのタイプ。

KnowledgeSourceKind

列挙

知識源の種類。

値	説明
searchIndex	検索インデックスからデータを読み取るナレッジソース。
azureBlob	Azure Blob Storage から検索インデックスにデータを読み取り、取り込むナレッジソース。
indexedSharePoint	インデックス化されたSharePointからデータを読み取る知識ソース。
indexedOneLake	インデックス化されたOneLakeからデータを読み取る知識源です。
indexedSql	Azure SQL DatabaseやSQL Managed Instanceからデータを検索インデックスに取り込み、取得する知識ソースです。
web	ウェブからデータを読み取る知識源です。
remoteSharePoint	リモートのSharePointからデータを読み取る知識ソース。
workIQ	仕事IQからデータを読み取る知識源
file	直接ファイルのアップロードとインデックス作成をサポートする知識源です。
mcpServer	MCP(モデルコンテキストプロトコル)サーバーによって裏付けられた知識源です。
fabricDataAgent	Fabric Data Agentからデータを取得する知識ソースです。
fabricOntology	Microsoft Fabricのオントロジーからデータを取得する知識ソースです。

KnowledgeSourceResultsProcessing

列挙

知識ソースの結果が再ランク付けされるかどうかを制御します。

値	説明
rerank	この知識源から得られる結果は、ランキング再評価のパイプラインを通過します。これが既定の動作です。
none	この知識源から得られる結果は、再ランク付けを回避し、その基礎となる順序を保持します。

McpServerKnowledgeSourceParams

Object

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

Object

文書に適用される感度ラベルに関する情報

名前	型	説明
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

Object

リモート 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

Object

検索インデックスのフィールド参照。

名前	型	説明
name	string	フィールドの名前。

SearchIndexKnowledgeSourceBoostKind

列挙

検索インデックスの知識源のためのブーストヒントのようなものです。

値	説明
fieldValue	フィールド値に基づいて文書をブーストします。
multiWordExpression	複数語の表現に基づいて文書を強化しましょう。

SearchIndexKnowledgeSourceFieldValueBoost

Object

フィールド値に基づいて文書を強化するヒントです。

名前	型	説明
boost	number (double)	文書スコアの乗算器です。 1.0 に等しくない正の数値を指定する必要があります。
boostInstructions	string	ブーストをいつどのように適用するかを説明する自然言語の指示。
field	string minLength: 1	検索インデックスフィールドの名前です。
fieldValues	string[]	フィールドの代表的な価値。
kind	string: fieldValue	いわゆるブーストのヒントです。

SearchIndexKnowledgeSourceFilterHint

Object

フィールドと代表値を示すヒントで、クエリプランナーがフィルターを構築する際に利用できます。

名前	型	説明
field	string minLength: 1	フィルタリング可能な検索インデックスフィールドの名前です。
fieldValues	string[]	フィールドの代表的な価値。
filterInstructions	string	フィールドでいつどのようにフィルタリングするかを説明する自然言語の指示。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Object

複数の単語表現に基づいて文書を強化するヒントです。

名前	型	説明
boost	number (double)	文書スコアの乗算器です。 1.0 に等しくない正の数値を指定する必要があります。
boostInstructions	string	ブーストをいつどのように適用するかを説明する自然言語の指示。
fieldValues	string[]	ブーストの代表値。
kind	string: multiWordExpression	いわゆるブーストのヒントです。

SearchIndexKnowledgeSourceParams

Object

検索インデックスナレッジソースのランタイムパラメータを指定します

名前	型	説明
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

検索インデックスの知識ソースのための有用なフィルターやブーストに向けたクエリ計画を導くヒント。

名前	型	説明
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	クエリプランナーが文書ランキングに影響を与えるために使える条件を特定するヒントを強化しましょう。
filters	SearchIndexKnowledgeSourceFilterHint[]	フィールドや代表的な値を特定するフィルターヒントをクエリプランナーがフィルター構築時に使えるようにします。

ServedImage

Object

モデルが検索活動中に選択した単一の画像を記述します。

名前	型	説明
imageId	string	Content Understanding Enrichmentによってソースドキュメントから抽出された画像ラベル。これは元の文書の数字番号に対応しています。
imagePath	string	アセットストア内で画像への相対的な経路。
sizeBytes	integer (int64)	この画像のバイト単位でモデルに送信されるサイズ。

WebKnowledgeSourceParams

Object

Web ナレッジソースのランタイムパラメーターを指定します

名前	型	説明
alwaysQuerySource	boolean	このナレッジソースはソースの選択をバイパスし、取得時に常にクエリを実行する必要があることを示します。
count	integer (int32)	返される Web 結果の数。
enableImageServing	boolean	この知識ソースに対して画像提供を有効にするべきかどうかを示します。もし真実の場合、取り込み中に抽出された画像は下流モデルに提供されます。
failOnError	boolean	この知識ソースからの取得がエラーが発生した場合、検索リクエスト全体が失敗するはずです。既定値は false です。
freshness	string	Web 結果の鮮度。
includeReferenceSourceData	boolean	参照に、取得中に取得した構造化データをペイロードに含める必要があるかどうかを示します。
includeReferences	boolean	このソースから取得したデータに参照を含める必要があるかどうかを示します。
kind	string: web	ナレッジソースのタイプ。
knowledgeSourceName	string	パラメータが適用されるインデックスの名前。
language	string	Web 結果の言語。
market	string	ウェブ結果の市場。
maxOutputDocuments	integer (int32)	この知識ソースから返される文書の最大数を制限します。
neverQuerySource	boolean	この知識ソースはリクエストの候補セットから除外し、検索時に問い合わせてはならないことを示します。除外はリクエストローカルであり、ナレッジベースのメンバーシップは変更しません。同じ知識ソース上でalwaysQuerySourceと組み合わせることはできません。
rerankerThreshold	number (float)	レスポンスに含めるために、取得されたすべてのドキュメントが満たす必要があるリランカーのしきい値。
resultsProcessing	KnowledgeSourceResultsProcessing	このリトリーブコールのみを処理し、知識ソースの保存された結果を上書きします。省略した場合、保存された知識源の値が適用されます。

WorkIQKnowledgeSourceParams

Object

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	このリトリーブコールのみを処理し、知識ソースの保存された結果を上書きします。省略した場合、保存された知識源の値が適用されます。