SmartqQueryAbility API によるインテリジェント Q&A の呼び出し - Quick BI - Alibaba Cloud -

スマート Q&A 機能を使用してデータのクエリを実行します。

操作説明

注意: ユーザーがこの API を呼び出す権限を付与されている場合、userId パラメーターを渡すことで、指定されたユーザーとしてデータのクエリを実行できます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:SmartqQueryAbility

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	任意	ユーザーの ID。重要このパラメーターが指定されていない場合、デフォルトで組織のオーナーとしてデータのクエリが実行されます。	7c7223ae-****-3c744528014b
UserQuestion	string	必須	質問のテキスト。	test
CubeId	string	任意	データセットの ID。ワークベンチ > データセットに移動し、目的のデータセットを開き、URL で cubeId を確認します。複数テーブルのシナリオでは、このパラメーターを空のままにしてください。	7c7223ae-****-3c744528014b
MultipleCubeIds	string	任意	複数のデータセット ID のリスト。モデルは質問に基づいてリストから 1 つ以上のテーブルを選択し、回答を生成します。このパラメーターは複数テーブルのシナリオでは必須であり、単一テーブルのシナリオでは不要です。	7c7**-3c744528014b,a876asd*yhashd2

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエストの ID。	D787E1A3-A************2B05DF8D885
Result	object	返された結果。
ChartType	string	推奨されるチャートのタイプ。	NEW_TABLE
MetaType	array<object>	列タプルタイプのリスト。
	object	メタデータオブジェクト。
Key	string	列タプルの名前。	Polar***STPS
Value	string	列タプルのタイプ。	string
Type	string	メタデータの行または列のタイプ。 Dimension: ディメンション Measure: メジャー	Dimension
Values	array<object>	データ値リストの配列。
	object	データ値リストオブジェクト。
Row	array	各行のデータ値。
	string	各フィールドのデータ値。	199
LogicSql	string	可視化ロジック SQL。	select * ****
ConclusionText	string	まとめの情報。	test
DataList	array	マルチステップシナリオでのみ返されるデータリスト。各要素はチャートデータセットに対応します。
	string	チャートのデータ。	test
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D787E1A3-A************2B05DF8D885",
  "Result": {
    "ChartType": "NEW_TABLE",
    "MetaType": [
      {
        "Key": "Polar***STPS",
        "Value": "string",
        "Type": "Dimension"
      }
    ],
    "Values": [
      {
        "Row": [
          "199"
        ]
      }
    ],
    "LogicSql": "select * ****",
    "ConclusionText": "test",
    "DataList": [
      "test"
    ]
  },
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Internal.System.Error	An internal system error occurred.	内部システムエラーが発生しました。
400	Query.Auth.Error	Query is not permitted.	クエリ権限がありません。
400	Instance.Expired	Your instance has expired.	購入したインスタンスが有効期限切れです。
400	Instance.Not.Exist	The specified instance does not exist.	アカウントに一致する購入済みインスタンスが見つかりませんでした。
400	Invalid.Organization	The specified organizational unit does not exist.	組織が存在しません。
400	User.Not.In.Organization	The specified user is not in the organizational unit.	ユーザーが組織に属していません。
400	Invalid.Parameter	An error occurred while verifying parameters.	パラメーターの検証に失敗しました。
400	Invalid.Parameter.Error	The parameter is invalid:%s.	無効なパラメーター: %s。
400	Invalid.Param.Error	The parameter is invalid.	無効なパラメーターです。
400	Invalid.User.Admin	You are not an administrator of this organization.	権限がありません。組織管理者ではありません。
400	System.Param.Empty	You must specify the %s parameter.
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.	お使いのインスタンスエディションまたは AccessKey に、この API を呼び出す権限が付与されていません。この API 呼び出しは Professional Edition でのみサポートされています。
400	UserInfo.Error	The personal information is invalid.	個人情報が無効です。
400	ApiUser.Not.Exists	The specified user does not exist.	ユーザーが存在しません。
400	User.Not.WorkspaceAdmin	Only administrators of the group workspace can perform this operation.	必須の権限がありません。あなたはこのワークスペースの管理者ではありません。
400	Application.Object.NotExist	The object you are operating does not exist or has been deleted.	操作コンポーネントが存在しないか、削除されています。
400	Not.ApiCall.AuthUser	You are not an administrator or API call auth user of this organization.	ユーザーは組織の管理者または API 許可されるユーザーではありません。
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	ユーザー %s にはこの操作を実行する権限がありません。
400	RobotNl2sql.Moudle.NotPurchase	Please purchase Nl2sql module first.	先に AI チャットモジュールを購入してください。
400	LlmCopilotQuestion.NotRelatedData.Error	The question you raised is not related to data queries, or the relevant field information could not be found in the dataset. Please try again.	ご質問の内容はデータクエリに関連していないか、データセットに関連するフィールド情報が見つかりませんでした。もう一度お試しください。
500	Invalid.User.Organization	The user is not in your organization.

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

変更履歴

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