すべてのプロダクト
Search

このプロダクト

    :ModifyModel

    ドキュメントセンター

    :ModifyModel

    最終更新日:Sep 22, 2025

    モデルの詳細とステータスを変更します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:ModifyModel

    update

    *Instance

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

    		 なし なし

    リクエスト構文

    PUT /openapi/ha3/instances/{instanceId}/models/{modelName} HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****
    modelName

    string

    必須

    モデル名。

    test
    dryRun

    string

    任意

    チェックのみを実行するかどうかを指定します。デフォルト値は false です。

    true
    body

    object

    任意

    リクエストボディ。

    content

    object

    任意

    モデルの詳細。

    method

    string

    任意

    モデルサービスにアクセスするための HTTP メソッド。有効な値は PUT と POST です。

    POST

    modelType

    string

    任意

    モデルタイプ。

    • テキスト埋め込み: text_embedding

    • テキストスパース埋め込み: text_sparse_embedding

    • 画像埋め込み: image_embedding

    • 画像コンテンツ解析: image_analyze

    text_embedding
    dimension

    integer

    任意

    モデルのディメンション。

    128
    request

    object

    任意

    モデルのリクエストボディ。

    header

    object

    任意

    モデルサービスにアクセスするための HTTP ヘッダー。

    Authorization

    string

    任意

    認証情報。フォーマット: Bearer access_token

    Bearer OS-v0********6vvs

    Content-Type

    string

    任意

    HTTP リクエストのコンテンツタイプ。

    application/json

    parameters

    object

    任意

    ビルドフェーズと検索フェーズで異なるパラメーターを指定します。

    build

    object

    任意

    インデックス構築フェーズのパラメーター。

    input_type

    string

    任意

    入力タイプ。

    query

    search

    object

    任意

    クエリフェーズのパラメーター。

    input_type

    string

    任意

    入力タイプ。

    document

    requestBody

    string

    任意

    リクエストボディのテンプレート文字列。

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

    urlParams

    object

    任意

    URL 内のパラメーター。一部のモデルサービスでは、URL でパラメーターを渡す必要があります。

    build

    object

    任意

    インデックス構築フェーズのパラメーター。

    key: value

    search

    object

    任意

    クエリフェーズのパラメーター。

    key: value

    response

    object

    任意

    結果を解析するために使用される JSONPath 式。

    embeddings

    string

    任意

    結果から埋め込みを解析するために使用される JSONPath 式。

    $.result.embeddings[*].embedding

    url

    string

    任意

    モデルサービスのエンドポイント。

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

    string

    任意

    モデルのステータス。

    • ok: モデルはアクティブです。

    • forbidden: モデルは利用できません。

    ok

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    requestId

    string

    リクエスト ID。

    D39EE0F1-D7EF-5F46-B781-6BF4185308B0

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。