自訂模型 - OpenSearch

OpenSearch向量檢索版已支援使用者調用自有模型。您可在此頁面新增自訂模型並進行查看/編輯、調試及禁用/恢複使用等管理工作。

新增模型

在模型管理>自訂模型中點擊新增模型，按照自訂模型格式完成配置。

自訂模型格式

{
  "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_embedding和image_embedding時需要填寫模型的維度。
url	模型服務的訪問地址。
method	模型服務訪問的HTTP方式，支援PUT和POST。
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中的參數需要區分build和search階段，可以定義在這個參數中。 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"]

模型管理

調試：
在模型列表>自訂模型操作欄中點擊調試，可對選定的自訂模型進行效果測試。
禁用：
模型禁用後，正在調用此模型的表將不再進行相關的資料與查詢處理，請您謹慎處理。
刪除：
只能對已禁用的模型進行刪除。
恢複使用：
可對已禁用的模型進行恢複使用操作。

模型調用

配置表時，欄位配置頁面對需資料預先處理的欄位點擊去配置，在模型中可選擇已完成建立的自訂模型。