CreateFirstRank - 创建一个应用版本的粗排表达式配置

创建一个OpenSearch应用版本的粗排表达式配置。当 dryRun=true 时,表示进行粗排表达式校验,默认 dryRun不传为false。

调试

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

授权信息

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

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

请求语法

POST /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/first-ranks HTTP/1.1

请求参数

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

是否为空运行请求

true
appGroupIdentitystring

应用名称

my_app_group_name
appIdinteger

版本号

110157886
bodyFirstRank

请求体,基础排序信息

请求体

字段类型是否必要示例值描述
nameString"test"表达式名称
typeString"STRUCT"表达式类型
- STRUCT 结构化,默认值
- STRING 自定义公式
metaArray 或 String表达式信息
descriptionString"my_test"描述
activeBooleantrue是否是默认表达式

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultobject

粗排表达式信息

activeboolean

是否是默认表达式

true
namestring

名称

default
metaarray<object>

表达式信息

metaItemobject
argstring

表达式函数参数

1
attributestring

属性,算分特征或搜索字段

static_bm25()
weightfloat

权重 取值范围:-100000~100000 非 0 值

10

示例

正常返回示例

JSON格式

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "active": true,
    "name": "default",
    "meta": [
      {
        "arg": "1",
        "attribute": "static_bm25()",
        "weight": 10
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-24OpenAPI 入参发生变更查看变更详情