TextEmbedding API で AI セマンティック検索を構築 - AnalyticDB for PostgreSQL

埋め込みモデルを用いてテキスト埋め込みを生成します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:TextEmbedding

none

*DBInstance

acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	クラスターの ID です。	gp-xxxxxxxxx
RegionId	string	必須	クラスターのリージョン ID です。	cn-hangzhou
Model	string	任意	テキスト埋め込みモデルです。有効な値は以下のとおりです。 text-embedding-v1：1536 次元 text-embedding-v2：1536 次元 text-embedding-v3（デフォルト）：1024、768、および 512 次元 text2vec：1024 次元 m3e-base：768 次元 m3e-small：512 次元	text-embedding-v3
Input	array	必須	埋め込み対象のテキスト内容のリストです。リストの長さは 100 を超えてはなりません。
	string	任意	埋め込み対象のテキストの内容です。テキストの長さは 2,048 トークンを超えてはなりません。	ADBPG是什么？
Dimension	integer	任意	埋め込み次元数です。デフォルト値は、埋め込みアルゴリズムがサポートする次元数です。説明 text-embedding-v3 では、1024、768、および 512 次元がサポートされています。デフォルト値は 1024 です。	1024

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの一意の ID です。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返されたメッセージです。	Successful
Status	string	操作のステータスです。有効な値は以下のとおりです。 success fail	success
TextTokens	integer	消費されたトークンの合計数です。	1000
Results	object
Results	array<object>	埋め込み結果です。
	array<object>	埋め込み結果です。
Embedding	object
Embedding	array	埋め込み値です。
	number	埋め込み値です。	0.1234
Index	integer	リクエストパラメーター Input 内の埋め込みの順番（0 から始まる）です。	0

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "TextTokens": 1000,
  "Results": {
    "Results": [
      {
        "Embedding": {
          "Embedding": [
            0.1234
          ]
        },
        "Index": 0
      }
    ]
  }
}

エラーコード

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

変更履歴

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