SmartqQueryAbility - - Alibaba Cloud ドキュメントセンター

インテリジェントな Q&A クエリを実行します。

操作説明

備考：権限を持つユーザーは、ターゲットユーザーの 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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	任意	ユーザーの ID です。重要このパラメーターを指定しない場合、デフォルトで組織のオーナーとしてデータがクエリされます。	7c7223ae-****-3c744528014b
UserQuestion	string	必須	テキスト形式の質問です。	test
CubeId	string	任意	データセットの ID です。ID を取得するには、Quick BI コンソールの [ワークベンチ] > [データセット] に移動します。データセットを開き、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	1 行のデータ値です。
	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.
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.	%s パラメーターは必須です。
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
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.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.
400	RobotNl2sql.Moudle.NotPurchase	Please purchase Nl2sql module first.
500	Invalid.User.Organization	The user is not in your organization.

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

変更履歴

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