ナレッジベースから情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:RetrievalKnowledgeBase |
get |
*All Resource
|
なし | なし |
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-beijing |
| KnowledgeBaseId |
string |
必須 |
ナレッジベースの一意な識別子。複数のナレッジベースをカンマ区切りで指定できます。最大 50 個を指定できます。 |
pkb-1xxxxx,pkb-2xxxxx |
| QueryText |
string |
必須 |
クエリテキスト。 |
財務レポート |
| TopK |
integer |
任意 |
返される結果の数。 |
5 |
| ScoreThreshold |
number |
任意 |
類似度スコアのしきい値。 |
0.7 |
| RerankEnabled |
boolean |
任意 |
再ランキングを有効にするかどうかを指定します。デフォルト値: true。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| QueryText |
string |
クエリテキスト。 |
財務レポート |
| RequestId |
string |
リクエストの ID。 |
CD35F3-F3-44CA-AFFF-BAF869****** |
| ResultCount |
integer |
結果の数。 |
5 |
| Results |
array<object> |
検索結果。 |
|
|
array<object> |
検索結果。 |
||
| Captions |
array |
チャンクに関連する図または表の字幕のリスト。 |
|
|
string |
図または表の字幕。 |
システムアーキテクチャ図 |
|
| DocItems |
array |
チャンクに関連する Docling ソースドキュメントの構造化要素リファレンスのリスト。これらのリファレンスを使用して、元のドキュメント内の要素を正確に特定できます。 |
|
|
string |
Docling ソースドキュメントの構造化要素リファレンス。 |
#/texts/2 |
|
| FileId |
string |
ファイルの一意な識別子。 |
91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc |
| FileName |
string |
ファイル名。 |
2024FinancialReport.pdf |
| Headings |
array |
チャンクが属するセクション見出しのチェーン。 |
|
|
string |
見出し。 |
財務レポート |
|
| ImageResources |
array<object> |
チャンクによってリファレンスされるイメージリソースのリスト。 |
|
|
object |
イメージリソース。 |
||
| DocumentIndex |
integer |
イメージが属するソースドキュメントのインデックス。0 から始まります。 |
0 |
| Id |
string |
イメージリソースの一意な識別子。 |
ドキュメント-0/pictures/1 |
| ItemRef |
string |
Docling ソースドキュメント構造内のイメージの要素リファレンス。 |
#/pictures/1 |
| MimeType |
string |
イメージリソースのメディアタイプ。 |
イメージ/png |
| Uri |
string |
イメージリソースの OSS URI。 |
oss://my-bucket/results/my-space/doc-001/artifacts/イメージ-1.png |
| Metadata |
string |
メタデータ。 |
{} |
| PageNumbers |
array |
チャンクが属するページ番号のリスト。 |
|
|
integer |
チャンクが属するページ番号。 |
1 |
|
| ShardContent |
string |
チャンクのテキストコンテンツ。 |
財務レポート |
| ShardIndex |
integer |
チャンクのインデックス。 |
1 |
| SimilarityScore |
number |
類似度スコア。 |
0.8 |
例
成功レスポンス
JSONJSON
{
"QueryText": "財務レポート",
"RequestId": "CD35F3-F3-44CA-AFFF-BAF869******",
"ResultCount": 5,
"Results": [
{
"Captions": [
"システムアーキテクチャ図"
],
"DocItems": [
"#/texts/2"
],
"FileId": "91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc",
"FileName": "2024FinancialReport.pdf",
"Headings": [
"財務レポート"
],
"ImageResources": [
{
"DocumentIndex": 0,
"Id": "ドキュメント-0/pictures/1",
"ItemRef": "#/pictures/1",
"MimeType": "イメージ/png",
"Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/イメージ-1.png"
}
],
"Metadata": "{}",
"PageNumbers": [
1
],
"ShardContent": "財務レポート",
"ShardIndex": 1,
"SimilarityScore": 0.8
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。