SmartqQueryAbility - - Alibaba Cloud Dokümantasyon Merkezi

Akıllı Soru-Cevap özelliğini kullanarak veri sorgular.

Operation description

Not: Bir kullanıcı bu API'yi çağırma yetkisine sahip olduğunda, userId parametresini ileterek belirtilen bir kullanıcı olarak veri sorgulayabilir.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:SmartqQueryAbility

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	No	Kullanıcı kimliği. Önemli Bu parametre belirtilmezse, varsayılan olarak kuruluş sahibi olarak veri sorgulanır.	7c7223ae-****-3c744528014b
UserQuestion	string	Yes	Soru metni.	test
CubeId	string	No	Veri kümesi kimliği. Çalışma Tezgahı > Veri Kümeleri'ne gidin, istediğiniz veri kümesini açın ve URL'de cubeId değerini bulun. Çoklu tablo senaryolarında bu parametreyi boş bırakın.	7c7223ae-****-3c744528014b
MultipleCubeIds	string	No	Birden fazla veri kümesi kimliğinin listesi. Model, bir yanıt oluşturmak için soruya dayalı olarak listeden bir veya daha fazla tablo seçer. Bu parametre çoklu tablo senaryolarında gereklidir ve tek tablo senaryolarında gerekli değildir.	7c7**-3c744528014b,a876asd*yhashd2

Response elements

Element	Type	Description	Example
	object	Yanıt şeması.
RequestId	string	İstek kimliği.	D787E1A3-A************2B05DF8D885
Result	object	Döndürülen sonuç.
ChartType	string	Önerilen grafik türü.	NEW_TABLE
MetaType	array<object>	Sütun demeti türlerinin listesi.
	object	Meta veri nesnesi.
Key	string	Sütun demeti adı.	Polar***STPS
Value	string	Sütun demeti türü.	string
Type	string	Meta veri satır veya sütun türü. Dimension: boyut Measure: ölçü	Dimension
Values	array<object>	Veri değeri listelerinin dizisi.
	object	Veri değeri listesi nesnesi.
Row	array	Her satır için veri değerleri.
	string	Her alan için veri değeri.	199
LogicSql	string	Görselleştirme mantığı SQL'i.	select * ****
ConclusionText	string	Özet bilgileri.	test
DataList	array	Yalnızca çok adımlı senaryolarda döndürülen veri listesi. Her öğe bir grafik veri kümesine karşılık gelir.
	string	Grafik verileri.	test
Success	boolean	İsteğin başarılı olup olmadığını gösterir.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message
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.
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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.