Skip to main content

同期 API

汎用テキスト埋め込みモデルは、テキストデータを数値ベクトルに変換し、セマンティック検索、推奨、クラスタリング、分類などの後続タスクに利用します。

モデル概要

  • シンガポール
  • 中国 (北京)
  • 中国 (香港)
モデル埋め込み次元最大行数1 行あたりの最大トークン数(注)価格 (入力トークン 100 万個あたり)サポート言語無料クォータ(注)
qwen3.7-text-embedding2,560、2,048、1,536、1,024 (デフォルト)、768、512、25620128,000$0.07中国語、英語、スペイン語、フランス語、ポルトガル語、インドネシア語、日本語、韓国語、ドイツ語、ロシア語、その他 200 以上の主要言語および方言100 万トークン有効期間:Model Studio をアクティベートしてから 90 日間
text-embedding-v4
Qwen3-Embedding シリーズの一部
2,048、1,536、1,024 (デフォルト)、768、512、256、128、64108,192$0.07中国語、英語、スペイン語、フランス語、ポルトガル語、インドネシア語、日本語、韓国語、ドイツ語、ロシア語、その他 100 以上の主要言語100 万トークン有効期間:Model Studio をアクティベートしてから 90 日間
text-embedding-v31,024 (デフォルト)、768、512中国語、英語、スペイン語、フランス語、ポルトガル語、インドネシア語、日本語、韓国語、ドイツ語、ロシア語、その他 50 以上の主要言語50 万トークン有効期間:Model Studio をアクティベートしてから 90 日間
モデルのレート制限については、「レート制限」をご参照ください。

前提条件

OpenAI エコシステムに精通しているユーザーは、OpenAI 互換 API を使用して迅速に移行できます。DashScope API は、より独自の機能を提供します。 API キーを取得し、API キーを環境変数としてエクスポートします。SDK を使用して呼び出しを行う場合は、DashScope SDK をインストールします。

OpenAI 互換性

SDK 呼び出し用に設定するbase_url:
  • シンガポール:https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
  • 中国 (北京):https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1
  • 中国 (香港):https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
HTTP 呼び出し用に設定するendpoint:
  • シンガポール:POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/embeddings。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
  • 中国 (北京):POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1/embeddings
  • 中国 (香港):POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/compatible-mode/v1/embeddings。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
ご利用の実際のワークスペース ID で {WorkspaceId} を置き換えてください。

リクエストボディ

modelstring必須呼び出すモデルの名前。モデル名については、「モデル概要」の表をご参照ください。inputarray<string> or string or file必須処理する入力テキスト。入力は、文字列、文字列の配列、またはファイルが可能です。 テキスト長とバッチサイズの制限は、モデルのバージョンによって異なります:
  • qwen3.7-text-embedding モデル:
    • 文字列入力:最大 128,000 トークン。
    • 文字列リストまたはファイル入力:最大 20 アイテム (行)、各アイテム (行) は最大 128,000 トークン。
  • text-embedding-v3 / v4 モデル:
    • 文字列入力:最大長 8,192 トークン。
    • 文字列リストまたはファイル入力:最大 10 アイテム (行)、各アイテム (行) は最大 8,192 トークン。
dimensions integer 任意出力される埋め込みベクトルの次元。次の値のいずれかである必要があります:2560 (qwen3.7-text-embedding のみ)、2048 (text-embedding-v4 のみ)、1536 (text-embedding-v4 のみ)、1024、768、512、256、128、または 64。デフォルト値は 1024 です。encoding_format string 任意返される埋め込みフォーマット。現在、float のみがサポートされています。
  • 入力文字列
  • 入力文字列リスト
  • 入力ファイル
  • Python
  • Java
  • curl
import os
from openai import OpenAI

client = OpenAI(
    # 中国 (北京) リージョンのモデルを使用する場合、そのリージョンの API キーを使用する必要があります。取得先: https://modelstudio.console.alibabacloud.com/?tab=model#/api-key
    api_key=os.getenv("DASHSCOPE_API_KEY"),  # 環境変数が設定されていない場合は、プレースホルダーをご利用の API キーに置き換えてください。
    # これはシンガポールリージョンの URL です。ご利用の実際のワークスペース ID で {WorkspaceId} を置き換えてください。URL はリージョンによって異なります。
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)

completion = client.embeddings.create(
    model="qwen3.7-text-embedding",
    input='The clothes are of good quality and look good, definitely worth the wait. I love them.',
    dimensions=1024,
    encoding_format="float"
)

print(completion.model_dump_json())

レスポンスオブジェクト

dataarray結果として得られる埋め込みオブジェクトのリスト。

プロパティ

embeddinglist埋め込みベクトル。浮動小数点数の配列として返されます。indexinteger入力配列内の対応する入力テキストのインデックス。objectstringオブジェクトタイプ。値は常に embedding です。
modelstringこの呼び出しで使用されたモデルの名前。objectstringオブジェクトタイプ。値は常に list です。usageobject

プロパティ

prompt_tokensinteger入力テキスト内のトークン数。total_tokens integer入力の合計トークン数。この数は、モデルのトークナイザーが入力文字列をどのように解析するかによって決まります。
idstringリクエストの一意の識別子。トレースとトラブルシューティングに使用されます。
{
  "data": [
    {
      "embedding": [
        -0.0695386752486229, 0.030681096017360687, ...
      ],
      "index": 0,
      "object": "embedding"
    },
    ...
    {
      "embedding": [
        -0.06348952651023865, 0.060446035116910934, ...
      ],
      "index": 5,
      "object": "embedding"
    }
  ],
  "model": "qwen3.7-text-embedding",
  "object": "list",
  "usage": {
    "prompt_tokens": 184,
    "total_tokens": 184
  },
  "id": "73591b79-d194-9bca-8bb5-xxxxxxxxxxxx"
}

DashScope

SDK 呼び出し用の base_url:
  • シンガポール:https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
  • 中国 (北京):https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1
  • 中国 (香港):https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
HTTP 呼び出し用のエンドポイント:
  • シンガポール:POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/services/embeddings/text-embedding/text-embedding。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
  • 中国 (北京):POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/embeddings/text-embedding/text-embedding
  • 中国 (香港):POST https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com/api/v1/services/embeddings/text-embedding/text-embedding。ご利用の実際のワークスペース ID で WorkspaceId を置き換えてください。
ご利用の実際のワークスペース ID で {WorkspaceId} を置き換えてください。

リクエストボディ

modelstring必須使用するモデル。「モデル概要」の表で利用可能なモデルのリストをご参照ください。inputstringまたはarray<string>必須処理するテキスト。入力は、文字列、文字列の配列、またはファイルが可能です。 サポートされるテキスト長とバッチサイズは、モデルのバージョンによって異なります。
  • qwen3.7-text-embedding モデル:
    • 文字列入力:最大 128,000 トークン。
    • 文字列リストまたはファイル入力:最大 20 アイテム (行)、各アイテム (行) は最大 128,000 トークン。
  • text-embedding-v3 / v4 モデル:
    • 文字列入力:最大長 8,192 トークン。
    • 文字列リストまたはファイル入力:最大 10 アイテム (行)、各アイテム (行) は最大 8,192 トークン。
text_type string任意
HTTP 呼び出しを行う場合、text_typeは parameters オブジェクト内に配置します。
埋め込みに変換されたテキストは、取得、クラスタリング、分類などの後続タスクに適用できます。取得などの非対称タスクでは、より良い取得パフォーマンスを達成するために、クエリテキスト (query) とドキュメントテキスト (document) を区別することを推奨します。インデックス作成、クラスタリング、分類などの対称タスクでは、システムのデフォルト値である document を使用できます。dimension integer 任意
HTTP 呼び出しを行う場合、dimensionは parameters オブジェクト内に配置します。
出力ベクトルの埋め込み次元を指定します。有効な値は 2560 (qwen3.7-text-embedding のみ)、2048 (text-embedding-v4 のみ)、1536 (text-embedding-v4 のみ)、1024、768、512、256、128、または 64 です。デフォルトは 1024 です。output_type string 任意
HTTP 呼び出しを行う場合、output_typeは parameters オブジェクト内に配置します。
出力ベクトルのタイプを指定します。このパラメーターは qwen3.7-text-embedding、``text-embedding-v3、および text-embedding-v4 モデルにのみ適用されます。有効な値は dense、sparse、および dense&sparse です。デフォルトは dense で、密ベクトル表現のみを返します。instruct string 任意モデルがクエリの意図を理解するのをガイドするためのカスタム命令を提供します。英語の命令は通常、パフォーマンスを 1% から 5% 向上させるため、推奨されます。
  • 入力文字列
  • 入力文字列リスト
  • 入力ファイル
  • Python
  • Java
  • curl
import os
import dashscope

# これはシンガポールリージョンの設定です。リージョンによって region の値は異なります。呼び出し時は、{WorkspaceId} をお使いのワークスペース ID に置き換えてください。
client = dashscope.Client(
    # 環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えてください: api_key="sk-xxx"
    # API キーはリージョン固有です。API キーを取得するには、https://www.alibabacloud.com/help/model-studio/get-api-key をご参照ください
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    workspace="{WorkspaceId}",
    region="ap-southeast-1",
)

resp = client.embeddings.create(
    model="qwen3.7-text-embedding",
    input='A swift wind, a high sky, and the gibbons cry mournfully. A clear islet, white sand, and the birds fly back. Boundless rustling woods shed their leaves. The endless Yangtze River comes rolling in.',
    dimension=1024,  # ベクトルの次元を指定します(qwen3.7-text-embedding、text-embedding-v3、text-embedding-v4 のみサポート)
    output_type="dense&sparse"
)

print(resp)

レスポンスオブジェクト

status_code stringHTTP ステータスコード。値が 200 の場合は成功を示します。request_id stringリクエストの一意の識別子。この ID を使用してリクエストのトレースとトラブルシューティングを行います。code stringリクエストが失敗した場合に返されるエラーコード。成功したリクエストの場合、このフィールドは空です。message stringリクエストが失敗した場合の詳細なエラーメッセージ。成功したリクエストの場合、このフィールドは空です。outputobjectタスクの結果。

プロパティ

embeddingsarrayリクエストに対するモデルの出力。これはオブジェクトの配列で、各オブジェクトは入力テキストに対応します。
sparse_embedding array対応する文字列の疎ベクトル表現。これは text-embedding-v3 および text-embedding-v4 にのみ適用されます。
index integerボキャブラリー内のトークンのインデックス。value floatToken の重みまたは重要度スコアを示します。値が高いほど、現在のテキストコンテキストにおける Token の重要性または関連性が高くなります。token stringトークンのテキスト。
embedding array対応する文字列の密ベクトル表現。text_index integer入力配列内の対応するテキストのインデックス。
usageobject

プロパティ

total_tokens integerモデルのトークナイザーによって計算された、入力のトークン数。
{
    "request_id": "1ba94ac8-e058-99bc-9cc1-7fdb37940a46",
    "embeddings": [
      {
         "index": 0,
         "sparse_embedding":[
           {"index":7149,"value":0.829,"token":"swift"},
           .....
           {"index":111290,"value":0.9004,"token":"mournfully"}],
         "embedding": [-0.006929283495992422,-0.005336422007530928, ...]
      },
      {
         "index": 1,
         "sparse_embedding":[
           {"index":246351,"value":1.0483,"token":"islet"},
           .....
           {"index":2490,"value":0.8579,"token":"back"}],
         "embedding": [-0.006929283495992422,-0.005336422007530928, ...]
      },
      {
         "index": 2,
         "sparse_embedding":[
           {"index":3759,"value":0.7065,"token":"Boundless"},
           .....
           {"index":1130,"value":0.815,"token":"leaves"}],
         "embedding": [-0.006929283495992422,-0.005336422007530928, ...]
      },
      {
         "index": 3,
         "sparse_embedding":[
           {"index":562,"value":0.6752,"token":"endless"},
           .....
           {"index":1589,"value":0.7097,"token":"in"}],
         "embedding": [-0.001945948973298072,-0.005336422007530928, ...]
      }
    ],
    "usage":{
        "total_tokens":27
    }
}

エラーコード

モデルの呼び出しが失敗した場合は、「エラーメッセージ」をご参照ください。