すべてのプロダクト
Search
ドキュメントセンター

PolarDB:AnswerKnowledgeBase

最終更新日:Sep 17, 2026

単一ターンのナレッジベース質問応答を実行します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:AnswerKnowledgeBase

get

*すべてのリソース。

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

リージョン ID。

cn-beijing

KnowledgeBaseId

string

必須

ナレッジベースの一意の ID。

pkb-xxxxx

QueryText

string

必須

ユーザーの質問。

今年の財務レポートを要約してください

TopK

integer

任意

取得する再現率の結果数。

10

ScoreThreshold

number

任意

類似度スコアのしきい値。

0.7

RerankEnabled

boolean

任意

再ランキングを有効にするかどうかを指定します。デフォルトでは無効です。

false

SearchMode

string

任意

検索モード。有効な値: knn、rrf、precise、semantic、balanced。

semantic

ReturnSources

boolean

任意

引用元を返すかどうかを指定します。デフォルトでは有効です。

true

SystemPrompt

string

任意

システムプロンプト。

これはセキュリティ検証用の最小限のテストプロンプトです

UserInstructions

string

任意

ユーザーの補足指示。

短い要約とテスト結果を返してください

MaxContextChars

integer

任意

コンテキスト文字数の最大値。有効な値: 1000 から 32000。

16000

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

QueryId

string

質問応答タスクの一意の ID。

R3BGbnBqcXN******.2a5a23c9-******-179970533d30

RequestId

string

リクエストの ID。

A7E6A8FD-C50B-46B2-BA85-D8B8D3******

Status

string

質問応答タスクのステータス。

Running

例

成功レスポンス

JSONJSON

{
  "QueryId": "R3BGbnBqcXN******.2a5a23c9-******-179970533d30",
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "Status": "Running"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。