GetProperties
Retrieves configuration information, such as intelligent configuration styles and inference-related metadata configurations.
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.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
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 |
|---|---|---|---|---|
aimiaobi:GetProperties | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | Unique identifier for the workspace: AgentKey | xxx_efm |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | PlainResult | ||
| Code | string | Status code | DataNotExists |
| Data | object | Business data | |
| ChatConfig | object | Call configuration | |
| ConsoleConfig | object | Console configuration | |
| TipContent | string | Prompt content | xx |
| Title | string | Title | AI Miaobi |
| GeneralConfigMap | object | General configurations map | |
| IntelligentSearchConfig | object | Intelligent search configuration | |
| ProductDescription | string | Homepage product description | xxx |
| SearchSamples | array<object> | Intelligent search recommendations | |
array<object> | sample | ||
| Articles | array<object> | Article list | |
object | Article | ||
| Select | boolean | Whether manually selected when passed from the frontend | true |
| Stared | boolean | Whether it is a starred article | false |
| Title | string | Title | xx |
| Url | string | Article URL | |
| Prompt | string | Prompt | xx |
| Text | string | Generated content | xxx |
| SearchSources | array<object> | Search source list | |
object | Search source | ||
| Code | string | Unique identifier for the dataset: code+datasetName | xx |
| DatasetName | string | Unique identifier for the dataset: code+datasetName | xx |
| Name | string | Search source name: Chinese | xx |
| CopilotPreciseSearchSources | array<object> | Miaosou: Search source configuration | |
object | |||
| Code | string | Unique identifier for the dataset: code+datasetName | x |
| DatasetName | string | Unique identifier for the dataset: code+datasetName | x |
| Name | string | Search source name: Chinese | x |
| SearchSources | array<object> | Search source dropdown list | |
object | Search source | ||
| Label | string | Search source name | Quark general search |
| Value | string | Search source code | SystemSearch |
| SlrAuthorized | boolean | Whether SLR is authorized | true |
| UserInfo | object | User configuration | |
| AgentId | string | Unique identifier for the workspace | 1 |
| TenantId | string | Unique identifier for the tenant | 1 |
| UserId | string | User ID | 1 |
| Username | string | Username | admin |
| WanxiangImageSizeConfig | array<object> | Wanxiang images | |
object | Wanxiang image size | ||
| Name | string | Image aspect ratio | 1:1 |
| Value | string | Image size in pixels | 1024*1024 |
| WanxiangImageStyleConfig | array<object> | Wanxiang image style configuration | |
object | |||
| Name | string | Style name | Default |
| Pic | string | Style image URL | https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png |
| Value | string | Style code | |
| SearchSourceList | array<object> | Specified search source list | |
object | |||
| Code | string | Search source type: corresponds to (SystemSearch: system-built-in search, CustomSemanticSearch: custom semantic index search, ThirdSearch: third-party API search) | SystemSearch |
| Name | string | Search source description | Internet search |
| DatasetName | string | Unique identifier for the data source | QuarkCommonNews |
| MiaosouConfig | object | Miaosou configuration | |
| UseDocSize | integer | Number of documents used in the dataset | 1 |
| MaxDocSize | integer | The number of active documents in the dataset. | 1 |
| ModelInfos | array<object> | Model list supported by intelligent search | |
object | Model supported by intelligent search | ||
| ModelName | string | Model name | Quanmiao-Max |
| ModelId | string | Model ID | quanmiao-max |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Error description | Data does not exist |
| RequestId | string | Unique request identifier | 3f7045e099474ba28ceca1b4eb6d6e21 |
| Success | boolean | Whether successful: true for success, false for failure | true |
Examples
Success response
JSON format
{
"Code": "DataNotExists",
"Data": {
"ChatConfig": {
"test": "test",
"test2": 1
},
"ConsoleConfig": {
"TipContent": "xx",
"Title": "AI Miaobi"
},
"GeneralConfigMap": {
"test": "test",
"test2": 1
},
"IntelligentSearchConfig": {
"ProductDescription": "xxx",
"SearchSamples": [
{
"Articles": [
{
"Select": true,
"Stared": false,
"Title": "xx",
"Url": "http://xxx.com"
}
],
"Prompt": "xx",
"Text": "xxx"
}
],
"SearchSources": [
{
"Code": "xx",
"DatasetName": "xx",
"Name": "xx"
}
],
"CopilotPreciseSearchSources": [
{
"Code": "x",
"DatasetName": "x",
"Name": "x"
}
]
},
"SearchSources": [
{
"Label": "Quark general search",
"Value": "SystemSearch"
}
],
"SlrAuthorized": true,
"UserInfo": {
"AgentId": "1",
"TenantId": "1",
"UserId": "1",
"Username": "admin"
},
"WanxiangImageSizeConfig": [
{
"Name": "1:1",
"Value": "1024*1024"
}
],
"WanxiangImageStyleConfig": [
{
"Name": "Default",
"Pic": "https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png",
"Value": ""
}
],
"SearchSourceList": [
{
"Code": "SystemSearch",
"Name": "Internet search",
"DatasetName": "QuarkCommonNews"
}
],
"MiaosouConfig": {
"UseDocSize": 1,
"MaxDocSize": 1,
"ModelInfos": [
{
"ModelName": "Quanmiao-Max",
"ModelId": "quanmiao-max"
}
]
}
},
"HttpStatusCode": 200,
"Message": "Data does not exist",
"RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.