OpenSearch:クエリ分析

• 認証情報の取得

  API を介して OpenSearch Search Development Console サービスを呼び出す場合は、呼び出し元の ID を認証する必要があります。

• サービスアクセスアドレスの取得

  パブリックネットワークと VPC の両方でサービスの呼び出しをサポートしています。詳細については、サービス登録アドレスの取得を参照してください。

概要

• リクエストボディは 8MB を超えてはなりません。

リクエストメソッド

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/query-analyze/{service_id}

• host: サービスを呼び出すためのアドレス。パブリックネットワークと VPC の両方を介した API サービスの呼び出しをサポートしています。詳細については、エンドポイントのクエリを参照してください。

• service_id: システム組み込みのサービス ID。例: ops-query-analyze-001。

リクエストパラメータ

ヘッダーパラメータ

API-KEY 認証

ボディパラメータ

レスポンスパラメータ

Curl リクエストの例

curl -XPOST -H"Content-Type: application/json" 
\http://****.opensearch.aliyuncs.com/v3/openapi/workspaces/default/query-analyze/ops-query-analyze-001\
    -H "Authorization: Bearer Your API-Key" \
    -d'{
      "query":"What class is Jack in", // Jack はどのクラスですか
      "history":[
          {
            "role":"user",
            "content":"Where is the capital of China" // 中国の首都はどこですか
          },
          {
            "role":"assistant",
            "content":"Beijing" // 北京
          }
        ],
        "functions":[
          {
            "name":"pre",
            "parameters":
              {
                "enable":true
              }
          },
          {
            "name":"intent",
            "parameters":
              {
                "enable":true
              }
            },
            {
              "name":"similar_query",
              "parameters":
                {
                  "enable":true
                }
              },
              {
                "name":"nl2sql",
                "parameters":
                  {
                    "enable":true,
                    "config_name":"n_1726047726"
                  }
                }
              ]
            }'

レスポンスの例

正常なレスポンスの例

{
  "request_id":"023FC760-E273-4163-B2DA-5CF28E2A****",
  "latency":6383,
  "usage":{
      "total_tokens":1082,
      "output_tokens":41,
      "input_tokens":1041
    },
    "result":{
      "query":"What class is Jack from", // Jack はどのクラス出身ですか
      "queries":[
          "The class Jack from" // Jack 出身のクラス
      ],
      "intent":"Q&A",
      "sql":{
          "text":"SELECT students.class FROM students WHERE students.name = 10002;"
      }
    }
}

異常なレスポンスの例

アクセスリクエストでエラーが発生した場合、出力結果は code と message によってエラーの理由を示します。

{
  "request_id":"19C54DAA-AD50-4B37-A48C-912A8F82****",
  "latency":0,
  "code":"InvalidParameter",
  "message":"Required parameter: query missing or invalid, please check the request parameter." // 必須パラメータ: query が欠落しているか無効です。リクエストパラメータを確認してください。
}

ステータスコードの説明