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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /v4/openapi/app-groups/[appGroupIdentity]/apps/[appId]/first-ranks HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
appGroupIdentity String Path my_app_group_name

应用名称

appId Integer Path 110157886

版本号

dryRun Boolean Query true

是否为空运行请求

请求体

字段

类型

是否必要

示例值

描述

name

String

"test"

表达式名称

type

String

"STRUCT"

表达式类型 

  • STRUCT  结构化,默认值
  • STRING  自定义公式

meta

Array 或 String

表达式信息

description

String

"my_test"

描述

active

Boolean

true

是否是默认表达式

返回数据

名称 类型 示例值 描述
requestId String 0A6EB64B-B4C8-CF02-810F-E660812972FF

请求ID

result Struct

粗排表达式信息

active Boolean true

是否是默认表达式

meta Array of metaItem

表达式信息

arg String 1

表达式函数参数

attribute String static_bm25()

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

weight Float 10

权重

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

name String defaul

名称

示例

请求示例

POST /v4/openapi/app-groups/os_function_test_v1/apps/150024378/first-ranks

struct 类型表达式
{
    "name": "general_default",
    "active": false,
    "type": "STRUCT",
    "meta": [
        {
            "attribute": "static_bm25()",
            "arg": "",
            "weight": 2
        },
        {
            "attribute": "hot_score",
            "arg": "",
            "weight": 0.000001
        }
    ]
}

string 类型自定义公式
{
    "name": "test_formula",
    "active": false,
    "type": "STRING",
    "meta": "now()+random()"
}

正常返回示例

XML格式

<requestId>0A6EB64B-B4C8-CF02-810F-E660812972FF</requestId>
<result>
    <name>general_default</name>
    <description/>
    <active>false</active>
    <type>STRUCT</type>
    <meta>
        <attribute>static_bm25()</attribute>
        <arg/>
        <weight>2</weight>
    </meta>
    <meta>
        <attribute>hot_score</attribute>
        <arg/>
        <weight>0.000001</weight>
    </meta>
    <created>0</created>
    <updated>0</updated>
</result>

JSON格式

{
    "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
    "result": {
        "name": "general_default",
        "description": "",
        "active": false,
        "type": "STRUCT",
        "meta": [
            {
                "attribute": "static_bm25()",
                "arg": "",
                "weight": 2
            },
            {
                "attribute": "hot_score",
                "arg": "",
                "weight": 0.000001
            }
        ],
        "created": 0,
        "updated": 0
    }
}

错误码

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