全部產品
Search

搜尋本產品

    OpenSearch：CreateModel - 建立模型

    文件中心

    OpenSearch：CreateModel - 建立模型

    更新時間：Sep 22, 2025

    建立模型資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    searchengine:CreateModel

    create

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 無 無

    請求文法

    POST /openapi/ha3/instances/{instanceId}/models HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    instanceId

    string

    是

    執行個體 ID

    ha-cn-pl32rf0****
    dryRun

    string

    否

    是否僅執行校正，預設為 False。

    true
    body

    object

    否

    請求體參數

    name

    string

    是

    模型名稱

    test
    content

    object

    否

    模型詳情

    modelType

    string

    否

    模型類別

    • a. 文本向量化：text_embedding

    • b. 文本稀疏向量化：text_sparse_embedding

    • c. 圖片向量化：image_embedding

    • d. 圖片內容解析：image_analyze

    text_embedding
    dimension

    integer

    否

    模型的維度。類型為 text_embedding 和 image_embedding 時需要填寫模型的維度。

    128
    url

    string

    否

    模型服務的訪問地址

    http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
    method

    string

    否

    模型服務訪問的 http method, 支援 PUT 和 POST

    POST
    request

    object

    否

    模型請求體

    header

    object

    否

    訪問模型服務的 http header

    Authorization

    string

    否

    認證資訊，格式:Bearer access_token

    Bearer OS-v0********6vvs
    Content-Type

    string

    否

    HTTP 要求內容類型。

    application/json
    urlParams

    object

    否

    url 中的參數，有限模型服務需要從 url 上傳遞參數。

    build

    object

    否

    構建索引時傳遞的參數

    key: value
    search

    object

    否

    查詢時傳遞的參數

    key: value
    parameters

    object

    否

    如果 body 中的參數需要區分 build 和 search 階段，可以定義在這個參數中。

    build

    object

    否

    索引構建階段的參數

    input_type

    string

    否

    輸入類型

    query
    search

    object

    否

    查詢階段的參數

    input_type

    string

    否

    輸入類型

    document
    requestBody

    string

    否

    請求 Body 體的模板字串

    {\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
    response

    object

    否

    如何解析結果資訊，使用 json path 格式描述

    embeddings

    string

    否

    如何解析結果資訊，使用 json path 格式描述

    $.result.embeddings[*].embedding

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    requestId

    string

    Id of the request

    022F36C7-9FB4-5D67-BEBC-3D14B0984463

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。