文档

GetProperties - 获取配置信息

更新时间:

获取配置信息。包括不限于智能配置的风格,推理相关元数据配置等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:GetPropertiesget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AgentKeystring

业务空间唯一标识: AgentKey

xxx_efm

返回参数

名称类型描述示例值
object

PlainResult

Codestring

状态码

DataNotExists
Dataobject

业务数据

ChatConfigobject

通话配置

ConsoleConfigobject

控制台配置

TipContentstring

提示内容

xx
Titlestring

标题

AI妙笔
GeneralConfigMapobject

通用配置表

IntelligentSearchConfigobject

智搜配置

ProductDescriptionstring

首页产品描述

xxx
SearchSamplesarray<object>

智搜推荐

object

sample

Articlesarray<object>

文章列表

object

文章

Selectboolean

前端传递时是否手动选择

true
Staredboolean

是否为星标文章

false
Titlestring

标题

xx
Urlstring

文章 URL

http://xxx.com
Promptstring

提示词

xx
Textstring

生成内容

xxx
SearchSourcesarray<object>

搜索源列表

object

搜索源

Codestring

数据集唯一标识: code+datasetName

xx
DatasetNamestring

数据集唯一标识: code+datasetName

xx
Namestring

搜索源名称:中文

xx
SearchSourcesarray<object>

搜索源下拉列表

object

搜索源

Labelstring

搜索源名称

夸克通用搜索
Valuestring

搜索源 code

SystemSearch
SlrAuthorizedboolean

SLR 是否已经授权

true
UserInfoobject

用户配置

AgentIdstring

业务空间唯一标识

1
TenantIdstring

租户唯一标识

1
UserIdstring

用户 id

1
Usernamestring

用户名称

admin
WanxiangImageSizeConfigarray<object>

万相图片

object

万相图片尺寸

Namestring

图片尺寸比例

1:1
Valuestring

图片尺寸像素

1024*1024
WanxiangImageStyleConfigarray<object>

万相图片风格配置

object
Namestring

风格名称

默认
Picstring

风格图片地址

https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png
Valuestring

风格 code

<auto>
HttpStatusCodeinteger

http 状态码

200
Messagestring

错误说明

数据不存在
RequestIdstring

请求唯一标识

3f7045e099474ba28ceca1b4eb6d6e21
Successboolean

是否成功:true 成功,false 失败

true

示例

正常返回示例

JSON格式

{
  "Code": "DataNotExists",
  "Data": {
    "ChatConfig": {
      "test": "test",
      "test2": 1
    },
    "ConsoleConfig": {
      "TipContent": "xx",
      "Title": "AI妙笔"
    },
    "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"
        }
      ]
    },
    "SearchSources": [
      {
        "Label": "夸克通用搜索",
        "Value": "SystemSearch"
      }
    ],
    "SlrAuthorized": true,
    "UserInfo": {
      "AgentId": "1",
      "TenantId": "1",
      "UserId": "1",
      "Username": "admin"
    },
    "WanxiangImageSizeConfig": [
      {
        "Name": "1:1",
        "Value": "1024*1024"
      }
    ],
    "WanxiangImageStyleConfig": [
      {
        "Name": "默认",
        "Pic": "https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png",
        "Value": "<auto>"
      }
    ]
  },
  "HttpStatusCode": 200,
  "Message": "数据不存在",
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Success": true
}

错误码

访问错误中心查看更多错误码。