QueryCollectionData API を呼び出してベクトルと全文データをクエリ - AnalyticDB - Alibaba Cloud - AnalyticDB

ベクトルデータを取得します。

今すぐお試しください

この 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:QueryCollectionData

create

*Collection

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	任意	インスタンスの ID です。説明 DescribeDBInstances 操作を呼び出して、リージョン内のすべての AnalyticDB for PostgreSQL インスタンスの詳細 (インスタンス ID を含む) をクエリできます。	gp-xxxxxxxxx
Collection	string	必須	コレクションの名前です。説明 ListCollections 操作を呼び出して、利用可能なコレクションを一覧表示できます。	document
Namespace	string	任意	名前空間の名前です。説明 ListNamespaces 操作を呼び出して、利用可能な名前空間を一覧表示できます。	mynamespace
NamespacePassword	string	必須	名前空間のパスワードです。	testpassword
Content	string	任意	全文検索のコンテンツです。このパラメーターを省略すると、ベクトル検索のみが実行されます。このパラメーターを指定すると、システムはベクトル検索と全文検索のハイブリッド検索を実行します。説明 Content パラメーターと Vector パラメーターのいずれかを指定する必要があります。	hello_world
Filter	string	任意	データ取得のフィルター条件です。SQL の WHERE 句のフォーマットです。この式はブール値を返します。これは、`=`、`<>`、`!=`、`>`、`<`、`>=`、`<=` などの単純な比較演算子、または `AND`、`OR`、`NOT` などの論理演算子と `IN`、`BETWEEN`、`LIKE` などのキーワードを組み合わせた、より複雑な式にすることができます。説明構文の詳細については、「PostgreSQL WHERE」をご参照ください。	pipeline_id='1yhpmo0rbn' AND (spu='10025667796135' AND dept_id='226')
TopK	integer	必須	返す上位結果の数を指定します。	10
Vector	array	任意	ベクトルデータです。ベクトルデータの長さは、CreateCollection 操作で指定されたものと同じである必要があります。説明 `SparseVector` が空の場合、密ベクトル検索の結果のみが返されます。 `Vector` と `SparseVector` の両方が空の場合、全文検索の結果のみが返されます。
	number	任意	ベクトルデータです。	1.234
SparseVector	object	任意	疎ベクトルデータです。
Indices	array	任意	インデックスの配列です。説明配列内の要素数は 4,000 を超えることはできません。
	integer	任意	インデックス値です。	1
Values	array	任意	疎ベクトルの配列です。
	number	任意	疎ベクトルデータです。	1.2345
RegionId	string	必須	インスタンスのリージョン ID です。	cn-hangzhou
Metrics	string	任意	検索の類似度アルゴリズムです。有効な値： l2：ユークリッド距離。 ip：内積距離。 cosine：コサイン類似度。説明このパラメーターが指定されていない場合、インデックス作成時に指定されたアルゴリズムが使用されます。	cosine
IncludeValues	boolean	任意	密ベクトルデータを返すかどうかを指定します。有効な値： true：密ベクトルデータを返します。 false：密ベクトルデータを返しません。	true
HybridSearch	string	任意	ハイブリッド検索アルゴリズムです。このパラメーターが空の場合、システムはベクトル検索と全文検索のスコアを直接比較して結果をランク付けします。有効な値： `RRF`：逆順位融合 (Reciprocal Rank Fusion)。このアルゴリズムには、融合効果をコントロールするためのパラメーター k があります。詳細については、`HybridSearchArgs` パラメーターの説明をご参照ください。 `Weight`：加重ソート。このアルゴリズムは、パラメーター alpha を使用してベクトル検索と全文検索のスコア比をコントロールし、結果をソートします。パラメーターの詳細については、`HybridSearchArgs` パラメーターをご参照ください。 `Cascaded`：全文検索を実行し、その検索結果に対してベクトル検索を実行します。	RRF
HybridSearchArgs	object	任意	ハイブリッド検索アルゴリズムのパラメーターです。RRF と Weight のアルゴリズムがサポートされています。 RRF の場合、スコアリングアルゴリズム `1/(k+rank_i)` の定数 k を指定します。値は 1 より大きい正の整数である必要があります。フォーマットは次のとおりです： `{ "RRF": { "k": 60 } }` Weight の場合、数式 `alpha * vector_score + (1-alpha) * text_score` において、alpha パラメーターはベクトル検索と全文検索のスコア比を示します。値の範囲は 0 から 1 です。0 は全文検索のみが使用されることを示し、1 はベクトル検索のみが使用されることを示します。 `{ "Weight": { "alpha": 0.5 } }`
	object	任意	再現率アルゴリズムです。
	any	任意	再現率アルゴリズムの構成です。	{ "RRF": { "k": 60 } }
OrderBy	string	任意	このパラメーターはデフォルトで空です。結果をソートする基準となるフィールドを指定します。このパラメーターはハイブリッド検索ではサポートされていません。フィールドは、メタデータフィールドまたはテーブルのデフォルトフィールド (`id` など) である必要があります。次のフォーマットがサポートされています：単一のフィールド (例：`chunk_id`)。カンマ (,) で区切られた複数のフィールド (例：`block_id, chunk_id`)。降順 (例：`block_id DESC, chunk_id DESC`)。	chunk_id
Offset	integer	任意	このパラメーターはデフォルトで空です。ページングクエリの開始位置を指定します。このパラメーターはハイブリッド検索ではサポートされていません。値は 0 以上である必要があります。このパラメーターが空でない場合、応答の Total はヒット総数を示します。このパラメーターは TopK と一緒に使用されます。たとえば、ページサイズ 20 でチャンク 0 から 44 を取得したい場合、3 つのリクエストを送信する必要があります： `Offset=0, TopK=20` はチャンク 0 から 19 を返します。 `Offset=20, TopK=20` はチャンク 20 から 39 を返します。 `Offset=40, TopK=20` はチャンク 40 から 44 を返します。	0
IncludeMetadataFields	string	任意	このパラメーターはデフォルトで空です。返すメタデータフィールドを指定します。複数のフィールドを指定し、カンマ (,) で区切ることができます。	title,content
WorkspaceId	string	任意	複数のデータベースインスタンスで構成されるワークスペースの ID です。このパラメーターまたは DBInstanceId パラメーターを指定する必要があります。このパラメーターと DBInstanceId の両方が指定された場合、このパラメーターが使用されます。	gp-ws-*****
RelationalTableFilter	object	任意	JOIN 操作と同様に、別のリレーショナルテーブルを使用してベクトルデータをフィルターします。説明リレーショナルテーブルのデータは、IncludeMetadataFields パラメーターを設定することで返すことができます。たとえば、`rds_table_name.id` は、リレーショナルテーブルの id フィールドが返されることを示します。
CollectionMetadataField	string	任意	ベクトルテーブルのフィールドと関連付けるために使用される、ベクトルコレクションのメタデータフィールドです。	doc_id
TableField	string	任意	ベクトルコレクションのメタデータフィールドと関連付けるために使用される、リレーショナルテーブルのフィールドです。	id
TableName	string	任意	リレーショナルテーブルの名前です。	my_rds_table
Condition	string	任意	リレーショナルテーブルのフィルター条件です。	tags @> ARRAY['art']
IncludeSparseValues	boolean	任意	疎ベクトルデータを返すかどうかを指定します。有効な値： true：疎ベクトルデータを返します。 false：疎ベクトルデータを返しません。	false

レスポンスフィールド

フィールド

型

説明

例

object

再現結果です。

Matches

object

match

array<object>

一致した項目の配列です。

array<object>

一致した単一のレコードです。

string

ベクトルデータの一意の ID です。

doca-1234

Metadata

object

関連付けられたメタデータです。

string

メタデータキーの値です。

{"title":"test title", "content": "test content"}

Values

object

value

array

密ベクトルを表す浮動小数点数の配列です。

number

密ベクトル内の値です。

1.234

Score

number

データレコードの類似度スコアです。スコアは、インデックス作成時に指定されたアルゴリズム (l2/ip/cosine) に基づいています。

0.12345

SparseValues

object

疎ベクトルデータです。

Indices

object

Indice

array

疎ベクトルのインデックスの配列です。

integer

単一のインデックス値です。

Values

object

Value

array

疎ベクトル内のインデックスに対応する値の配列です。

number

疎ベクトルからの単一の値です。

0.222

MetadataV2

object

メタデータです。このフィールドは Metadata と同じ値を持ちますが、SDK が値をネイティブデータ型に逆シリアル化できるように、異なる要素型を使用します。

any

SDK は、次のルールに従ってこのフィールドの値を逆シリアル化します。

説明

逆シリアル化ルール

ADBPG 型	Java SDK 型	Python SDK 型
整数 (integer, bigint)	Long	int
浮動小数点数 (real, double precision)	Double	float
ブール値 (boolean)	Boolean	bool
文字列 (text, character varying)	String	str
配列 (例：int[], text[])	ArrayList<T> (T はこの表のルールに従ってマッピングされます)	list
json	String	str

{'array_field': [15.5, 25.5, 35.5], 'float_field': 128.45, 'long_field': 123456789017, 'bool_field': False, 'json_field': '{"key1":"value1","num":999.0}', 'char_array_field': '[c, h, a, r, s, 5]', 'int_field': 128, 'source': 0, 'double_field': 12350.6789, 'string_field': 'test_string_5'}

RequestId

string

リクエスト ID です。

ABB39CC3-4488-4857-905D-2E4A051D0521

Status

string

リクエストのステータスです。有効な値：

success：リクエストは成功しました。
fail：リクエストは失敗しました。

success

Message

string

リクエストが失敗した場合に返されるエラーの詳細です。

0.1234

Total

integer

検索のヒット総数です。このパラメーターは、リクエストの Offset パラメーターが 0 でない場合にのみ返されます。

100

例

成功レスポンス

JSONJSON

{
  "Matches": {
    "match": [
      {
        "Id": "doca-1234",
        "Metadata": {
          "key": "{\"title\":\"test title\", \"content\":  \"test content\"}"
        },
        "Values": {
          "value": [
            1.234
          ]
        },
        "Score": 0.12345,
        "SparseValues": {
          "Indices": {
            "Indice": [
              20
            ]
          },
          "Values": {
            "Value": [
              0.222
            ]
          }
        },
        "MetadataV2": {
          "key": "{'array_field': [15.5, 25.5, 35.5], 'float_field': 128.45, 'long_field': 123456789017, 'bool_field': False, 'json_field': '{\"key1\":\"value1\",\"num\":999.0}', 'char_array_field': '[c, h, a, r, s, 5]', 'int_field': 128, 'source': 0, 'double_field': 12350.6789, 'string_field': 'test_string_5'}"
        }
      }
    ]
  },
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "0.1234",
  "Total": 100
}

エラーコード

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

変更履歴

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