QueryCollectionData API を呼び出してベクトルと全文データをクエリ - 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	任意	全文検索のコンテンツ。このパラメーターを指定すると、ハイブリッド検索が実行されます。このパラメーターが空の場合、ベクトル検索のみが実行されます。説明このパラメーターと `Vector` パラメーターの両方を空にすることはできません。	hello_world
Filter	string	任意	クエリのフィルター条件。SQL の WHERE 句のフォーマットで指定します。式はブール値 (`true` または `false`) を返す必要があり、比較演算子 (`=`、`!=`、`>`、`<`、`>=`、`<=`)、論理演算子 (`AND`、`OR`、`NOT`)、および `IN`、`BETWEEN`、`LIKE` などのキーワードを含めることができます。説明構文の詳細については、「PostgreSQL WHERE」をご参照ください。	pipeline_id='1yhpmo0rbn' AND (spu='10025667796135' AND dept_id='226')
TopK	integer	必須	返す上位の結果の数。	10
Vector	array	任意	クエリの密ベクトル。ディメンションの数は、CreateCollection API を呼び出すときに指定したディメンションと一致する必要があります。説明 `SparseVector` パラメーターが指定されていない場合、密ベクトル検索の結果のみが返されます。 `Vector` または `SparseVector` を指定しない場合、(`Content` が指定されていると仮定して) 全文検索の結果のみが返されます。
	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：Weighted Ranking。このアルゴリズムは、パラメーター `alpha` を使用して、ソート前のベクトル検索と全文検索のスコアの重みを制御します。詳細については、`HybridSearchArgs` パラメーターをご参照ください。 Cascaded：全文検索を実行し、その結果に対してベクトル検索を実行します。	RRF
HybridSearchArgs	object	任意	指定されたハイブリッド検索アルゴリズムのパラメーター。次のアルゴリズムがサポートされています： 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	任意		{ "Weight": { "alpha": 0.5 } }
OrderBy	string	任意	ソートに使用されるフィールド。このパラメーターは、ハイブリッド検索シナリオではサポートされていません。デフォルトでは、このパラメーターは空です。フィールドは、`id` などのテーブル内のメタデータフィールドまたはデフォルトフィールドである必要があります。次のフォーマットがサポートされています： `chunk_id` などの単一フィールド。 `block_id, chunk_id` などのカンマで区切られた複数フィールド。 `block_id DESC, chunk_id DESC` などの降順。	chunk_id
Offset	integer	任意	ページ分割クエリの開始点。デフォルトでは、このパラメーターは空です。このパラメーターは、ハイブリッド検索シナリオではサポートされていません。値は 0 以上である必要があります。このパラメーターを指定すると、応答には一致した合計数を示す `Total` フィールドが含まれます。このパラメーターは `TopK` と一緒に使用されます。たとえば、20 ページで 45 個のチャンクを取得するには、3 つのリクエストを送信する必要があります： `Offset=0, TopK=20`：1 番目から 20 番目のチャンクを返します。 `Offset=20, TopK=20`：21 番目から 40 番目のチャンクを返します。 `Offset=40, TopK=20`：41 番目から 45 番目のチャンクを返します。	0
IncludeMetadataFields	string	任意	返すメタデータフィールド。デフォルトでは、このパラメーターは空です。複数のフィールドを返すには、カンマで区切ります。	title,content
WorkspaceId	string	任意	複数のデータベースインスタンスで構成されるワークスペースの ID。このパラメーターと `DBInstanceId` パラメーターの両方を空にすることはできません。両方のパラメーターを指定した場合、このパラメーターが優先されます。	gp-ws-*****
RelationalTableFilter	object	任意	リレーショナルテーブルと結合して、ベクトル検索の結果をフィルタリングします。説明リレーショナルテーブルからデータを返すには、`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：疎ベクトルデータを返しません。

レスポンスフィールド

フィールド

型

説明

例

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

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

MetadataV2

object

メタデータ。このフィールドは Metadata フィールドと同じ値を持ちますが、Software Development Kit (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	String

{'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": [
              0
            ]
          },
          "Values": {
            "Value": [
              0
            ]
          }
        },
        "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
}

エラーコード

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

変更履歴

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