自定义模型

更新时间:2025-03-11 02:33:50

OpenSearch向量检索版已支持用户调用自有模型。您可在此页面新增自定义模型并进行查看/编辑、调试及禁用/恢复使用等管理工作。

新增模型

模型管理>自定义模型中点击新增模型,按照自定义模型格式完成配置。

image

自定义模型格式

{
  "modelName": "custom_model",
  "modelType": "text_embedding",
  "dimension": 1536,
  "url": "http://xxx/api/v2/services/embeddings",
  "method": "POST"
  "request": {
    "header": {
      "Authorization": "fj42091fjlgnlsvu023nva",
      "Content-Type": "application/json"
    },
    "urlParams": {
      "build": {},
      "search": {}
    },
    "requestBody": "{\"input\": [\"%{input}\"],\"input_type\": \"${input_type}\"}",
    "parameters": {
      "build": {
        "input_type": "document"
      },
      "search": {
        "input_type": "query"
      }
    }
  },
  "response": {
    "embeddings": "$.result.embeddings[*].embedding"
  }
}

参数说明

参数名称

描述

参数名称

描述

modelName

模型名称

modelType

模型类型,支持配置以下4

  • text_embedding:文本稠密模型

  • text_sparse_embedding:文本稀疏向量模型

  • image_embedding:图片向量模型

  • image_analyze:图片内容分析模型

dimension

模型维度。类型为text_embeddingimage_embedding时需要填写模型的维度。

url

模型服务的访问地址。

method

模型服务访问的HTTP方式,支持PUTPOST。

request

请求方式。

request.header

访问模型服务的HTTP header,原样传给模型服务。

request.urlParams

URL中的参数,有些模型服务需要从URL上传递参数,如:?abc=123。

request.urlParams.build

构建索引时传递的参数。

request.urlParams.search

查询时传递的参数。

request.requestBody

请求Body的模板字符串。

  • 模板变量格式:

    %{参数名称} 。如:{ "input": "%{input}" }

  • 内置变量:

    • %{input}:表示输入文本。

    • %{modal}:表示模态,使用多模态模型时,可以在查询query中指定使用的模态。

request.parameters

如果body中的参数需要区分buildsearch阶段,可以定义在这个参数中。

  • build:索引构建阶段的参数。

  • search:查询阶段的参数。

response

如何解析结果信息,使用json path格式描述。

json path描述

操作符

操作符

说明

操作符

说明

$

表示根元素,路径必须以$开始。

*

通配符,表示任意值。可以出现在需要名称或者数字的地方。

.<name>

用于访问对象的属性。

[<number>]

用于访问数组特性下标的元素。

示例

{
  "store": {
    "books": [
      {
        "title": "java",
        "price": 56
      },
      {
        "title": "c++",
        "price": 99
      }
    ]
  }
}
  • 提取所有书的标题

    • json path: $.store.books[*].title

    • 结果:["java", "c++"]

  • 提取第一本书的标题

    • json path: $.store.books[0].title

    • 结果:["java"]

模型管理

  • 调试:

    模型列表>自定义模型操作栏中点击调试,可对选定的自定义模型进行效果测试。

    image

  • 禁用:

    模型禁用后,正在调用此模型的表将不再进行相关的数据与查询处理,请您谨慎处理。

  • 删除:

    只能对已禁用的模型进行删除。

  • 恢复使用:

    可对已禁用的模型进行恢复使用操作。

模型调用

配置表时,字段配置页面对需数据预处理的字段点击去配置,在模型中可选择已完成创建的自定义模型。

image

image

  • 本页导读 (1)
  • 新增模型
  • 自定义模型格式
  • 参数说明
  • json path描述
  • 模型管理
  • 模型调用