リファレンス: Embeddings | Azure Machine Learning
入力テキストを表す埋め込みベクトルを作成します。
POST /embeddings?api-version=2024-04-01-preview
URI パラメーター
名前 | / | 必須 | タイプ | 説明 |
---|---|---|---|---|
api-version |
クエリ | ○ | string | "YYYY-MM-DD" または "YYYY-MM-DD-preview" 形式の API のバージョン。 |
要求ヘッダー
名前 | Required | タイプ | 説明 |
---|---|---|---|
extra-parameters | string | ペイロードに追加のパラメーターが指定されている場合の API の動作。 pass-through を使用すると、この API は、基になるモデルにパラメーターを渡すことができます。 この値は、基になるモデルがサポートできるとわかっているパラメーターを渡す場合に使用します。 ignore を使用すると、この API は、サポートされていないパラメーターを削除します。 この値は、異なるモデル間で同じペイロードを使用する必要があり、モデルでサポートされていない場合にエラーになる可能性がある追加のパラメーターの 1 つを使用する場合に使用します。 error を使用すると、この API はペイロード内の追加のパラメーターを拒否します。 この API で指定されたパラメーターのみを指定できます。それ以外の場合は 400 エラーが返されます。 |
|
azureml-model-deployment | string | 要求のルーティング先のデプロイの名前。 複数のデプロイをサポートするエンドポイントでサポートされます。 |
要求本文
名前 | Required | タイプ | 説明 |
---|---|---|---|
input | True | string[] | 埋め込むテキストを入力します。トークンの文字列または配列としてエンコードされます。 1 回の要求で複数の入力を埋め込むには、文字列の配列またはトークン配列の配列を渡します。 |
dimensions | integer | 結果として出力される埋め込みに必要なディメンションの数。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 | |
encoding_format | EmbeddingEncodingFormat | 埋め込みを返す形式。 base64、float、int8、uint8、binary、または ubinary のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 | |
input_type | EmbeddingInputType | 入力の "種類"。 text 、query 、または document のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 |
応答
名前 | 種類 | 説明 |
---|---|---|
200 OK | CreateEmbeddingResponse | [OK] |
401 権限がありません | UnauthorizedError | アクセス トークンが見つからないか無効です ヘッダー x-ms-error-code: string |
404 見つかりません | NotFoundError | モダリティがモデルによってサポートされていません。 モデルのドキュメントを確認して、どのルートが利用可能であるかを確認します。 ヘッダー x-ms-error-code: string |
422 処理できなかったエンティティ | UnprocessableContentError | 要求に処理できないコンテンツが含まれています ヘッダー x-ms-error-code: string |
429 要求が多すぎます | TooManyRequestsError | 割り当てられたレート制限に達したため、要求のペースを調整する必要があります。 ヘッダー x-ms-error-code: string |
その他の状態コード | ContentFilterError | Bad request ヘッダー x-ms-error-code: string |
セキュリティ
承認
Bearer: prefix
が付いたトークン (例: Bearer abcde12345
)
種類: apiKey 入力: ヘッダー
AADToken
Azure Active Directory OAuth2 認証
種類: oauth2 フロー: アプリケーション トークン URL: https://login.microsoftonline.com/common/oauth2/v2.0/token
例
入力テキストを表す埋め込みベクトルを作成します
サンプル要求
POST /embeddings?api-version=2024-04-01-preview
{
"input": [
"This is a very good text"
],
"input_type": "text",
"encoding_format": "float",
"dimensions": 1024
}
サンプル応答
状態コード:200
{
"data": [
{
"index": 0,
"object": "embedding",
"embedding": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
],
"object": "list",
"model": "BERT",
"usage": {
"prompt_tokens": 15,
"total_tokens": 15
}
}
定義
名前 | 説明 |
---|---|
ContentFilterError | プロンプトが構成どおりにコンテンツ フィルターをトリガーすると、API 呼び出しは失敗します。 プロンプトを変更して、もう一度やり直してください。 |
CreateEmbeddingRequest | 埋め込み作成の要求。 |
CreateEmbeddingResponse | 埋め込み要求からの応答。 |
詳細 | エラーの詳細。 |
埋め込み | 生成された埋め込みオブジェクトを表します。 |
EmbeddingEncodingFormat | 埋め込みを返す形式。 base64、float、int8、uint8、binary、または ubinary のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 |
EmbeddingInputType | 入力の "種類"。 text 、query 、または document のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 |
EmbeddingObject | オブジェクトの種類。これは常に "embedding" です。 |
ListObject | オブジェクトの種類。常に "list" です。 |
NotFoundError | デプロイされたモデルに対してルートが無効です。 |
TooManyRequestsError | 割り当てられたレート制限に達したため、要求のペースを調整する必要があります。 |
UnauthorizedError | 認証が見つからないか、無効です。 |
UnprocessableContentError | 要求に処理できないコンテンツが含まれています。 指定されたペイロードがこの仕様に従って有効な場合、エラーが返されます。 ただし、ペイロードに示されている命令の一部は、基になるモデルではサポートされていません。 details セクションは、問題のあるパラメーターを理解するために使用します。 |
使用方法 | 要求の使用状況に関する情報。 |
ContentFilterError
プロンプトが構成どおりにコンテンツ フィルターをトリガーすると、API 呼び出しは失敗します。 プロンプトを変更して、もう一度やり直してください。
名前 | 種類 | 説明 |
---|---|---|
code | string | エラー コード。 |
エラー | string | エラーの説明。 |
message | string | エラー メッセージ。 |
param | string | コンテンツ フィルターをトリガーしたパラメーター。 |
status | integer | HTTP 状態コード。 |
CreateEmbeddingRequest
埋め込み作成の要求。
名前 | Required | タイプ | 説明 |
---|---|---|---|
input | True | string[] | 埋め込むテキストを入力します。トークンの文字列または配列としてエンコードされます。 1 回の要求で複数の入力を埋め込むには、文字列の配列またはトークン配列の配列を渡します。 |
dimensions | integer | 結果として出力される埋め込みに必要なディメンションの数。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 | |
encoding_format | EmbeddingEncodingFormat | 埋め込みを返す形式。 base64、float、int8、uint8、binary、または ubinary のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 | |
input_type | EmbeddingInputType | 入力の "種類"。 text 、query 、または document のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。 |
CreateEmbeddingResponse
埋め込み要求からの応答。
名前 | 種類 | 説明 |
---|---|---|
data | Embedding[] | モデルによって生成された埋め込みの一覧。 |
モデル | string | 埋め込みを生成するために使われるモデルの名前。 |
オブジェクト | ListObject | オブジェクトの種類。常に "list" です。 |
使用量 | 使用方法 | 要求の使用状況に関する情報。 |
詳細
UnprocessableContentError エラーの詳細。
名前 | 種類 | 説明 |
---|---|---|
loc | string[] | 問題の原因となっているパラメーター |
値 | string | 問題の原因となっているパラメーターに渡される値。 |
埋め込み
生成された埋め込みを表します。
名前 | 種類 | 説明 |
---|---|---|
埋め込み | [] | 埋め込みベクトル。 ベクターの長さは使用されるモデルによって異なり、型は使用される encoding_format によって異なります。 |
インデックス | integer | 埋め込みリスト内の埋め込みのインデックス。 |
オブジェクト | EmbeddingObject | オブジェクトの種類。これは常に "embedding" です。 |
EmbeddingEncodingFormat
埋め込みを返す形式。 base64、float、int8、uint8、binary、または ubinary のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。
名前 | 種類 | 説明 |
---|---|---|
base64 | string | |
binary | string | |
float | string | |
int8 | string | |
ubinary | string | |
uint8 | string |
EmbeddingInputType
入力の "種類"。 text
、query
、または document
のいずれか。 モデルが値またはパラメーターをサポートしていない場合は、422 エラーを返します。
名前 | 種類 | 説明 |
---|---|---|
ドキュメント | string | ベクター データベースに格納されているドキュメントを入力が表していることを示します。 |
クエリ | string | ベクター データベース内の最も関連性の高いドキュメントを検索するための検索クエリを入力が表していることを示します。 |
text | string | 入力が一般的なテキスト入力であることを示します。 |
EmbeddingObject
名前 | 種類 | 説明 |
---|---|---|
埋め込み | string |
ListObject
オブジェクトの種類。常に "list" です。
名前 | 種類 | 説明設定 |
---|---|---|
list | string |
NotFoundError
名前 | 種類 | 説明 |
---|---|---|
エラー | string | エラーの説明。 |
message | string | エラー メッセージ。 |
status | integer | HTTP 状態コード。 |
TooManyRequestsError
名前 | 種類 | 説明 |
---|---|---|
エラー | string | エラーの説明。 |
message | string | エラー メッセージ。 |
status | integer | HTTP 状態コード。 |
UnauthorizedError
名前 | 種類 | 説明 |
---|---|---|
エラー | string | エラーの説明。 |
message | string | エラー メッセージ。 |
status | integer | HTTP 状態コード。 |
UnprocessableContentError
要求に処理できないコンテンツが含まれています。 指定されたペイロードがこの仕様に従って有効な場合、エラーが返されます。 ただし、ペイロードに示されている命令の一部は、基になるモデルではサポートされていません。 details
セクションは、問題のあるパラメーターを理解するために使用します。
名前 | 種類 | 説明 |
---|---|---|
code | string | エラー コード。 |
詳細 | 詳細 | |
エラー | string | エラーの説明。 |
message | string | エラー メッセージ。 |
status | integer | HTTP 状態コード。 |
使用方法
要求の使用状況に関する情報。
名前 | 種類 | 説明 |
---|---|---|
prompt_tokens | integer | プロンプトで使用されるトークンの数。 |
total_tokens | integer | 要求によって使用されるトークンの合計数。 |