Knowledge Retrieval - Retrieve

サービス:: Search Service

API バージョン:: 2026-04-01

ナレッジベースは、バッキングストアから関連データを取得します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
knowledgeBaseName	path	True	string	ナレッジベースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	型	説明
includeActivity	boolean	取得結果にアクティビティ情報を含める必要があることを示します。
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	モデルクエリの計画なしで実行する目的のクエリのリスト。
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	ナレッジソースのランタイムパラメーターの一覧。
maxOutputSizeInTokens	integer (int32)	出力内のコンテンツの最大サイズを制限します。
maxRuntimeInSeconds	integer (int32)	最大実行時間 (秒単位)。

応答

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

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

要求のサンプル

HTTP

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

状態コード:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

要求のサンプル

HTTP

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

状態コード:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

定義

名前	説明
Accept	Acceptヘッダーです。
AzureBlobKnowledgeSourceParams	Azure BLOB ナレッジソースのランタイムパラメーターを指定します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
IndexedOneLakeKnowledgeSourceParams	インデックス付き OneLake ナレッジソースのランタイムパラメーターを指定します
KnowledgeBaseActivityRecordType	活動の種類。
KnowledgeBaseAgenticReasoningActivityRecord	エージェント推論アクティビティー・レコードを表します。
KnowledgeBaseAzureBlobActivityArguments	Azure BLOB 取得アクティビティが実行された引数を表します。
KnowledgeBaseAzureBlobActivityRecord	Azure BLOB 取得アクティビティレコードを表します。
KnowledgeBaseAzureBlobReference	Azure Blob Storage ドキュメント参照を表します。
KnowledgeBaseErrorAdditionalInfo	リソース管理エラーの追加情報。
KnowledgeBaseErrorDetail	エラーの詳細。
KnowledgeBaseImageContent	画像の内容。
KnowledgeBaseIndexedOneLakeActivityArguments	インデックス化されたOneLakeの検索活動が実行された引数を表しています。
KnowledgeBaseIndexedOneLakeActivityRecord	インデックス化されたOneLakeの検索活動記録を表しています。
KnowledgeBaseIndexedOneLakeReference	インデックス付きOneLakeドキュメント参照を表します。
KnowledgeBaseMessage	自然言語メッセージスタイルオブジェクト。
KnowledgeBaseMessageContentType	メッセージコンテンツの種類。
KnowledgeBaseMessageImageContent	画像メッセージの種類。
KnowledgeBaseMessageTextContent	テキストメッセージの種類。
KnowledgeBaseModelWebSummarizationActivityRecord	LLMのウェブ要約活動レコードを表します。
KnowledgeBaseReferenceType	参照の種類。
KnowledgeBaseRetrievalRequest	取得要求の入力コントラクト。
KnowledgeBaseRetrievalResponse	取得応答の出力コントラクト。
KnowledgeBaseSearchIndexActivityArguments	検索インデックス取得アクティビティが実行された引数を表します。
KnowledgeBaseSearchIndexActivityRecord	検索索引取得アクティビティー・レコードを表します。
KnowledgeBaseSearchIndexReference	Azure Search ドキュメント参照を表します。
KnowledgeBaseWebActivityArguments	ウェブ検索活動が実行された引数を表しています。
KnowledgeBaseWebActivityRecord	ウェブ検索活動記録を表します。
KnowledgeBaseWebReference	Web ドキュメント参照を表します。
KnowledgeRetrievalIntentType	使用するナレッジベースの構成の種類。
KnowledgeRetrievalMinimalReasoningEffort	最小限の推論で知識検索を実行しましょう。
KnowledgeRetrievalReasoningEffortKind	取得中に使用する作業量。
KnowledgeRetrievalSemanticIntent	意味論的なクエリの意図です。
KnowledgeSourceKind	知識源の種類。
SearchIndexFieldReference	検索インデックスのフィールド参照。
SearchIndexKnowledgeSourceParams	検索インデックスナレッジソースのランタイムパラメータを指定します
WebKnowledgeSourceParams	Web ナレッジソースのランタイムパラメーターを指定します

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Object

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

名前	型	説明
includeReferenceSourceData	boolean	参照に、取得中に取得した構造化データをペイロードに含める必要があるかどうかを示します。
includeReferences	boolean	このソースから取得したデータに参照を含める必要があるかどうかを示します。
kind	string: azureBlob	ナレッジソースのタイプ。
knowledgeSourceName	string	パラメータが適用されるインデックスの名前。
rerankerThreshold	number (float)	レスポンスに含めるために、取得されたすべてのドキュメントが満たす必要があるリランカーのしきい値。

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	エラーオブジェクト。

IndexedOneLakeKnowledgeSourceParams

Object

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

名前	型	説明
includeReferenceSourceData	boolean	参照に、取得中に取得した構造化データをペイロードに含める必要があるかどうかを示します。
includeReferences	boolean	このソースから取得したデータに参照を含める必要があるかどうかを示します。
kind	string: indexedOneLake	ナレッジソースのタイプ。
knowledgeSourceName	string	パラメータが適用されるインデックスの名前。
rerankerThreshold	number (float)	レスポンスに含めるために、取得されたすべてのドキュメントが満たす必要があるリランカーのしきい値。

KnowledgeBaseActivityRecordType

列挙

活動の種類。

値	説明
searchIndex	検索インデックス検索活動。
azureBlob	Azure Blob retrieval activity.
indexedOneLake	インデックス化されたOneLake検索活動。
web	ウェブ検索活動。
modelWebSummarization	LLMのウェブ要約活動。
agenticReasoning	主体的推論活動。

KnowledgeBaseAgenticReasoningActivityRecord

Object

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

名前	型	説明
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
id	integer (int32)	アクティビティレコードの ID。
reasoningTokens	integer (int32)	エージェント推論の入力トークンの数。
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalMinimalReasoningEffort	検索推論の努力構成。
type	string: agenticReasoning	アクティビティレコードのタイプ。

KnowledgeBaseAzureBlobActivityArguments

Object

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

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

KnowledgeBaseAzureBlobActivityRecord

Object

Azure BLOB 取得アクティビティレコードを表します。

名前	型	説明
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	取得アクティビティの Azure BLOB 引数。
count	integer (int32)	リランカーのしきい値を超えるのに十分な関連性を持つ取得されたドキュメントの数。
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
id	integer (int32)	アクティビティレコードの ID。
knowledgeSourceName	string	取得アクティビティのナレッジソース。
queryTime	string (date-time)	この取得アクティビティのクエリ時間。
type	string: azureBlob	アクティビティレコードのタイプ。

KnowledgeBaseAzureBlobReference

Object

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

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

KnowledgeBaseErrorAdditionalInfo

Object

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

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

KnowledgeBaseErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	KnowledgeBaseErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

KnowledgeBaseImageContent

Object

画像の内容。

名前	型	説明
url	string (uri)	イメージの URL。

KnowledgeBaseIndexedOneLakeActivityArguments

Object

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

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

KnowledgeBaseIndexedOneLakeActivityRecord

Object

インデックス化されたOneLakeの検索活動記録を表しています。

名前	型	説明
count	integer (int32)	リランカーのしきい値を超えるのに十分な関連性を持つ取得されたドキュメントの数。
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
id	integer (int32)	アクティビティレコードの ID。
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	検索活動に関するインデックス化されたOneLakeの引数。
knowledgeSourceName	string	取得アクティビティのナレッジソース。
queryTime	string (date-time)	この取得アクティビティのクエリ時間。
type	string: indexedOneLake	アクティビティレコードのタイプ。

KnowledgeBaseIndexedOneLakeReference

Object

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

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

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	メッセージの種類

KnowledgeBaseModelWebSummarizationActivityRecord

Object

LLMのウェブ要約活動レコードを表します。

名前	型	説明
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
id	integer (int32)	アクティビティレコードの ID。
inputTokens	integer (int32)	LLMウェブ要約活動の入力トークン数。
outputTokens	integer (int32)	LLMウェブ要約活動の出力トークン数。
type	string: modelWebSummarization	アクティビティレコードのタイプ。

KnowledgeBaseReferenceType

列挙

参照の種類。

値	説明
searchIndex	検索インデックス文書参照。
azureBlob	Azure Blob document reference.
indexedOneLake	インデックス化されたOneLake文書参照。
web	ウェブ文書参照。

KnowledgeBaseRetrievalRequest

Object

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

名前	型	説明
includeActivity	boolean	取得結果にアクティビティ情報を含める必要があることを示します。
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	モデルクエリの計画なしで実行する目的のクエリのリスト。
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	ナレッジソースのランタイムパラメーターの一覧。
maxOutputSizeInTokens	integer (int32)	出力内のコンテンツの最大サイズを制限します。
maxRuntimeInSeconds	integer (int32)	最大実行時間 (秒単位)。

KnowledgeBaseRetrievalResponse

Object

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

名前	型	説明
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	進捗状況と請求への影響を追跡するためのアクティビティレコード。
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	応答で使用される取得データの参照。
response	KnowledgeBaseMessage[]	返信メッセージ。

KnowledgeBaseSearchIndexActivityArguments

Object

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

名前	型	説明
filter	string	フィルター文字列。
search	string	検索インデックスを問い合わせるための検索文字列。
searchFields	SearchIndexFieldReference[]	どのフィールドが検索されたか。
semanticConfigurationName	string	検索インデックスからどのような意味構成が使われたか。
sourceDataFields	SearchIndexFieldReference[]	検索のために選択されたフィールド。

KnowledgeBaseSearchIndexActivityRecord

Object

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

名前	型	説明
count	integer (int32)	リランカーのしきい値を超えるのに十分な関連性を持つ取得されたドキュメントの数。
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
id	integer (int32)	アクティビティレコードの ID。
knowledgeSourceName	string	取得アクティビティのナレッジソース。
queryTime	string (date-time)	この取得アクティビティのクエリ時間。
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	検索アクティビティの検索インデックス引数。
type	string: searchIndex	アクティビティレコードのタイプ。

KnowledgeBaseSearchIndexReference

Object

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

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

KnowledgeBaseWebActivityArguments

Object

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

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

KnowledgeBaseWebActivityRecord

Object

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

名前	型	説明
count	integer (int32)	リランカーのしきい値を超えるのに十分な関連性を持つ取得されたドキュメントの数。
elapsedMs	integer (int32)	取得アクティビティの経過時間(ミリ秒単位)。
error	KnowledgeBaseErrorDetail	操作が失敗した理由を説明するエラーの詳細。このプロパティは、アクティビティが成功しない場合にのみ含まれます。
id	integer (int32)	アクティビティレコードの ID。
knowledgeSourceName	string	取得アクティビティのナレッジソース。
queryTime	string (date-time)	この取得アクティビティのクエリ時間。
type	string: web	アクティビティレコードのタイプ。
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。

KnowledgeRetrievalIntentType

列挙

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

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

KnowledgeRetrievalMinimalReasoningEffort

Object

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

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

KnowledgeRetrievalReasoningEffortKind

列挙

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

値	説明
minimal	ソースの選択、クエリの計画、または反復検索は実行しません。

KnowledgeRetrievalSemanticIntent

Object

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

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

KnowledgeSourceKind

列挙

知識源の種類。

値	説明
searchIndex	検索インデックスからデータを読み取るナレッジソース。
azureBlob	Azure Blob Storage から検索インデックスにデータを読み取り、取り込むナレッジソース。
indexedOneLake	インデックス化されたOneLakeからデータを読み取る知識源です。
web	ウェブからデータを読み取る知識源です。

SearchIndexFieldReference

Object

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

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

SearchIndexKnowledgeSourceParams

Object

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

名前	型	説明
filterAddOn	string	インデックスに適用されるフィルター条件 (例: 'State eq VA')。
includeReferenceSourceData	boolean	参照に、取得中に取得した構造化データをペイロードに含める必要があるかどうかを示します。
includeReferences	boolean	このソースから取得したデータに参照を含める必要があるかどうかを示します。
kind	string: searchIndex	ナレッジソースのタイプ。
knowledgeSourceName	string	パラメータが適用されるインデックスの名前。
rerankerThreshold	number (float)	レスポンスに含めるために、取得されたすべてのドキュメントが満たす必要があるリランカーのしきい値。

WebKnowledgeSourceParams

Object

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

名前	型	説明
count	integer (int32)	返される Web 結果の数。
freshness	string	Web 結果の鮮度。
includeReferenceSourceData	boolean	参照に、取得中に取得した構造化データをペイロードに含める必要があるかどうかを示します。
includeReferences	boolean	このソースから取得したデータに参照を含める必要があるかどうかを示します。
kind	string: web	ナレッジソースのタイプ。
knowledgeSourceName	string	パラメータが適用されるインデックスの名前。
language	string	Web 結果の言語。
market	string	ウェブ結果の市場。
rerankerThreshold	number (float)	レスポンスに含めるために、取得されたすべてのドキュメントが満たす必要があるリランカーのしきい値。