マルチラウンドChat2Queryを開始する

v3 以降、Chat2Query API では、セッション関連のエンドポイントを呼び出して、複数ラウンドのチャットを開始できます。3 エンドポイントによって返されるsession_id使用して、次/v3/chat2dataラウンドで会話を続行できます。

あなたが始める前に

マルチラウンド Chat2Query を開始する前に、次のものを用意してください。

ステップ1.セッションを開始する

セッションを開始するには、Chat2Query データアプリの/v3/sessionsエンドポイントを呼び出します。

以下は、このエンドポイントを呼び出すための一般的なコード例です。

ヒント：
エンドポイントの特定のコード例を取得するには、データアプリの左側のペインでエンドポイント名をクリックし、 [コード例の表示]をクリックします。詳細については、エンドポイントのサンプルコードを取得するを参照してください。

curl --digest --user ${PUBLIC_KEY}:${PRIVATE_KEY} --request POST 'https://<region>.data.tidbcloud.com/api/v1beta/app/chat2query-<ID>/endpoint/v3/sessions'\
    --header 'content-type: application/json'\
    --data-raw '{
    "cluster_id": "10140100115280519574",
    "database": "sp500insight",
    "name": "<Your session name>"
}'

上記のコードでは、リクエスト本文は次のプロパティを持つ JSON オブジェクトです。

cluster_id :文字列。TiDB クラスターの一意の識別子。
database :文字列。データベースの名前。
name :文字列。セッションの名前。

応答の例は次のとおりです。

{
    "code": 200,
    "msg": "",
    "result": {
    "messages": [],
    "meta": {
        "created_at": 1718948875, // A UNIX timestamp indicating when the session is created
        "creator": "<Your email>", // The creator of the session
        "name": "<Your session name>", // The name of the session
        "org_id": "1", // The organization ID
        "updated_at": 1718948875 // A UNIX timestamp indicating when the session is updated
    },
    "session_id": 305685 // The session ID
    }
}

ステップ2. セッションでChat2Dataエンドポイントを呼び出す

セッションを開始した後、 /v3/sessions/{session_id}/chat2data電話して次のラウンドで会話を続けることができます。

以下は一般的なコード例です。

curl --digest --user ${PUBLIC_KEY}:${PRIVATE_KEY} --request POST 'https://eu-central-1.data.tidbcloud.com/api/v1beta/app/chat2query-YqAvnlRj/endpoint/v3/sessions/{session_id}/chat2data'\
 --header 'content-type: application/json'\
 --data-raw '{
    "question": "<Your question to generate data>",
    "feedback_answer_id": "",
    "feedback_task_id": "",
    "sql_generate_mode": "direct"
}'