QueryContent API を使用してベクトルとメタデータをクエリ - AnalyticDB for PostgreSQL - Alibaba Cloud -

自然言語クエリを使用して、指定されたドキュメントコレクションからベクターとメタデータを取得します。

今すぐお試しください

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

create

*Document

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。説明 DescribeDBInstances 操作を呼び出して、リージョン内のすべての AnalyticDB for PostgreSQL インスタンスの詳細（インスタンス ID を含む）をクエリできます。	gp-xxxxxxxxx
Namespace	string	任意	名前空間。デフォルト値: public。説明 CreateNamespace 操作を呼び出して名前空間を作成し、 ListNamespaces 操作を呼び出して名前空間をクエリできます。	mynamespace
Collection	string	必須	ドキュメントコレクションの名前。説明ドキュメントコレクションは CreateDocumentCollection 操作を呼び出して作成します。 ListDocumentCollections 操作を呼び出して既存のドキュメントコレクションをクエリできます。	document
RegionId	string	必須	インスタンスのリージョン ID。	cn-hangzhou
NamespacePassword	string	必須	名前空間のパスワード。説明この値は CreateNamespace 操作で指定されます。	testpassword
Content	string	任意	取得に使用するテキストコンテンツ。	What is AnalyticDB for PostgreSQL?
Filter	string	任意	クエリするデータのフィルター条件。SQL WHERE 句フォーマットで指定します。フィルターはブール値（true または false）を返す式です。条件には、等しい（=）、等しくない（<> または !=）、より大きい（>）、より小さい（<）、以上（>=）、以下（<=）などの単純な比較演算子を使用できます。また、論理演算子（AND、OR、NOT）で組み合わせたより複雑な式や、IN、BETWEEN、LIKE キーワードを使用した条件も使用できます。説明詳細な構文については、https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/ を参照してください。	title = 'test' AND name like 'test%'
RecallWindow	array	任意	再現率ウィンドウ。この値が空でない場合、取得結果の周囲の追加コンテキストが返されます。フォーマットは 2 要素の配列: List<A, B> で、-10<=A<=0 かつ 0<=B<=10 です。説明ドキュメントが過度に small なチャンクに分割され、取得時にコンテキスト情報が失われる可能性がある場合に、このパラメーターを使用します。再ランキングはウィンドウ処理より優先度が高くなります。再ランキングが先に実行され、その後にウィンドウ処理が実行されます。
	integer	任意	再現率ウィンドウサイズ。	[-5, 5]
TopK	integer	任意	返す上位結果の数。	10
RerankFactor	number	任意	再ランキングファクター。この値が空でない場合、取得結果が再ランキングされます。有効な値: 1 < RerankFactor <= 5。説明ドキュメントのチャンクが疎な場合、再ランキングは遅くなります。再ランキングされる結果の合計数（TopK × Factor、切り上げ）は 50 を超えないようにしてください。	2
UseFullTextRetrieval	boolean	任意	（非推奨）全文取得（デュアルパス再現率）を使用するかどうかを指定します。デフォルト値: false。ベクター取得のみを使用することを示します。	true
Metrics	string	任意	取得に使用する類似度アルゴリズム。この値が空の場合、ナレッジベース作成時に指定されたアルゴリズムが使用されます。特定の要件がない限り、このパラメーターは空のままにしてください。説明有効な値: l2: ユークリッド距離。 ip: 内積距離。 cosine: 余弦類似度。	cosine
FileName	string	任意	イメージからイメージへの検索シナリオで検索するソースイメージファイルの名前。説明イメージファイルにはファイル拡張子が必要です。サポートされるイメージ拡張子: bmp、jpg、jpeg、png、tiff。	test.jpg
FileUrl	string	任意	イメージからイメージへの検索シナリオにおけるイメージファイルのパブリックアクセス可能な URL。説明イメージファイルにはファイル拡張子が必要です。サポートされるイメージ拡張子: bmp、jpg、jpeg、png、tiff。	https://xx/myImage.jpg
IncludeVector	boolean	任意	ベクターを返すかどうかを指定します。デフォルト値: false。説明 false: ベクターを返しません。 true: ベクターを返します。	true
HybridSearch	string	任意	マルチチャンネル再現率アルゴリズム。デフォルト値: 空。密ベクトルと全文インデックスのスコアを直接比較してソートすることを示します。有効な値: RRF: Reciprocal Rank Fusion。パラメーター k が融合効果をコントロールします。詳細については、HybridSearchArgs 構成を参照してください。 Weight: 重み付きソート。パラメーターがソート前のベクター取得と全文インデックス結果のスコアの重みをコントロールします。詳細については、HybridSearchArgs 構成を参照してください。 Cascaded: 全文インデックス取得が最初に実行され、その後全文インデックス結果に基づいてベクター取得が実行されます。	RRF
HybridSearchArgs	object	任意	マルチチャンネル再現率のアルゴリズムパラメーター。RRF と Weight がサポートされています。HybridPathsSetting は再現率パスを指定します: 密ベクトル（dense）、疎ベクター（sparse）、全文インデックス（fulltext）。この値が空の場合、デフォルトで密ベクトル（dense）と全文インデックス（fulltext）が使用されます。 RRF: スコア計算数式 `1/(k+rank_i)` の定数 k を指定します。値は 1 より大きい正の整数である必要があります。フォーマット: `{ "HybridPathsSetting": { "paths": "dense,fulltext" }, "RRF": { "k": 60 } }` Weight: デュアルパス再現率（HybridPathsSetting を指定せず、alpha のみを指定）: 数式: alpha * dense_score + (1-alpha) * fulltext_score。alpha パラメーターは密ベクトルと全文インデックス取得間のスコアの重みを指定します。有効な値: 0 から 1。0 は全文インデックスのみ、1 は密ベクトルのみを示します: `{ "Weight": { "alpha": 0.5 } }` 3 パス再現率パターン: 数式: normalized_dense * dense_score + normalized_sparse * sparse_score + normalized_fulltext * fulltext_score。dense、sparse、fulltext の値はそれぞれ密ベクトル、疎ベクター、全文インデックス取得の重みを表します。有効な値: 0 以上。システムは重みを 0 から 1 に自動的に正規化します（normalized_x = x / (dense + sparse + fulltext)）。 { "HybridPathsSetting": { "paths": "dense,sparse,fulltext" }, "Weight": { "dense": 0.5, "sparse": 0.3, "fulltext": 0.2 } } ```.
	object	任意	The multi-channel recall parameter name.
	any	任意	The parameter value.	{ "HybridPathsSetting": { "paths": "dense,fulltext" }, "RRF": { "k": 60 } }
IncludeMetadataFields	string	任意	返すメタデータフィールド。デフォルト値: 空。複数のフィールドはカンマで区切ります。	title,page
IncludeFileUrl	boolean	任意	ドキュメントの URL を同期的に返すかどうかを指定します。デフォルトでは URL は返されません。	false
UrlExpiration	string	任意	返されるイメージ URL の有効期間。説明有効な値: 秒（s）と日（d）を単位としてサポートします。例えば、300s は有効期間 300 秒、60d は有効期間 60 日を示します。有効な値: 60s から 365d。デフォルト値: 7200s（2 時間）。	7200s
GraphEnhance	boolean	任意	知識グラフエッジ拡張を有効にするかどうかを指定します。デフォルト値: false。	false
GraphSearchArgs	object	任意	知識グラフ取得パラメーター。
GraphTopK	integer	任意	返す上位エンティティおよび関係エッジの数。デフォルト値: 60。	60
RerankModel	object	任意	再ランキングモデルパラメーター。
Name	string	任意	再ランキングモデルの名前。有効な値: qwen3-rerank、gte-rerank-v2。	qwen3-rerank
Instruct	string	任意	RerankModel.Name が qwen3-rerank の場合に設定できるパラメーターです。カスタムソートタスクタイプの説明を追加します。このパラメーターはモデルに異なるソート戦略を採用するよう指示します。	Given a web search query, retrieve relevant passages that answer the query
RerankMetadataFields	string	任意
OrderBy	string	任意	ソートに使用するフィールド。デフォルト値: 空。フィールドはメタデータまたはテーブルのデフォルトフィールド（id など）に属する必要があります。サポートされるフォーマット: 単一フィールド（chunk_id など）。カンマで区切られた複数フィールド（block_id, chunk_id など）。降順（block_id DESC, chunk_id DESC など）。	created_at
Offset	integer	任意	ページングクエリのオフセット。結果のページングに使用されます。	0

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返されたメッセージ。	success
Status	string	ステータス。有効な値: success: 成功。 fail: 失敗。	success
Matches	object
MatchList	array<object>	一致した結果のリスト。
	array<object>	単一の Record。
Id	string	一意のベクター ID。	doca-1234
Content	string	テキストコンテンツ。	AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.
Metadata	object	メタデータ。
	string	キーと値のペアとしてのカスタムメタデータ。	{"title":"test"}
Vector	object
VectorList	array	ベクター値。
	number	ベクター内の浮動小数点数。	[1.2123,-0.12314,...]
FileName	string	ファイル名。	my_doc.txt
Score	number	レコードの類似度スコア。スコアリングアルゴリズムは、インデックス作成時に指定されたメトリック (例：`l2`、`ip`、`cosine`) に依存します。	0.12345
RetrievalSource	integer	取得元。値 `1` はベクトル取得、`2` は全文検索、`3` はデュアルチャネルリコールを示します。	1
LoaderMetadata	string	ドキュメントローダーがドキュメントをロードするときにキャプチャされたメタデータ。	{"page_pos": 1}
FileURL	string	クエリ結果内のファイルのパブリック URL。デフォルトでは、URL は 2 時間有効です。 `UrlExpiration` パラメーターを使用して、カスタムの有効期間を指定できます。	https://xxx-cn-beijing.aliyuncs.com/image/test.png
RerankScore	number	再ランキングスコア。	6.2345
WindowMatches	object
windowMatches	array<object>	ウィンドウ処理された一致結果のリスト。
	array<object>
WindowMatch	object
windowMatch	array<object>	単一ウィンドウ内の一致。
	array<object>
Id	string	一意のベクター ID。	doca-2345
Content	string	テキストコンテンツ。	AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.
Metadata	object	メタデータ。
	string	キーと値のペアとしてのカスタムメタデータ。	{"title":"test"}
FileName	string	ファイル名。	my_doc.txt
LoaderMetadata	string	ドキュメントローダーがドキュメントをロードするときにキャプチャされたメタデータ。	{"page_pos": 2}
EmbeddingTokens	string	ベクトル化中に使用されたトークン数。説明トークンは、入力テキストが分割される最小単位です。トークンは単語、フレーズ、句読点、または文字です。	100
Usage	object	このクエリのリソース使用量。
EmbeddingTokens	string	ベクトル化中に使用されたトークン数。説明トークンは、入力テキストが分割される最小単位です。トークンは単語、フレーズ、句読点、または文字です。	100
EmbeddingEntries	string	ベクトル化中に使用されたエントリ数。説明エントリとは、テキストまたはイメージのベクトル化中に処理されたアイテムの数を指します。例えば、テキストを 1 回処理すると 1 エントリ、イメージを 1 回処理すると 2 エントリとしてカウントされます。	10
Entities	object
entities	array<object>	エンティティのリスト。
	object	エンティティの詳細。
Id	string	エンティティ ID。	1
Entity	string	エンティティ名。	Dr. Wang
Type	string	エンティティタイプ。	person
Description	string	エンティティの説明。	A former advisor at DeepMind.
FileName	string	ファイル名。	my_doc.txt
Relations	object
relations	array<object>	関係エッジのリスト。
	object	関係エッジの詳細。
Id	string	関係エッジ ID。	1
SourceEntity	string	ソースエンティティ。	DeepMind consultant
TargetEntity	string	ターゲットエンティティ。	Dr. Wang
Description	string	関係エッジの説明。	Dr. Wang previously served as an advisor at DeepMind.
FileName	string	ファイル名。	my_doc.txt

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Matches": {
    "MatchList": [
      {
        "Id": "doca-1234",
        "Content": "AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.",
        "Metadata": {
          "key": "{\"title\":\"test\"}"
        },
        "Vector": {
          "VectorList": [
            0
          ]
        },
        "FileName": "my_doc.txt",
        "Score": 0.12345,
        "RetrievalSource": 1,
        "LoaderMetadata": "{\"page_pos\": 1}",
        "FileURL": "https://xxx-cn-beijing.aliyuncs.com/image/test.png",
        "RerankScore": 6.2345
      }
    ]
  },
  "WindowMatches": {
    "windowMatches": [
      {
        "WindowMatch": {
          "windowMatch": [
            {
              "Id": "doca-2345",
              "Content": "AnalyticDB for PostgreSQL is a massively parallel processing (MPP) data warehouse service compatible with ANSI SQL 2003, the PostgreSQL ecosystem, and the Oracle database ecosystem.",
              "Metadata": {
                "key": "{\"title\":\"test\"}"
              },
              "FileName": "my_doc.txt",
              "LoaderMetadata": "{\"page_pos\": 2}"
            }
          ]
        }
      }
    ]
  },
  "EmbeddingTokens": "100",
  "Usage": {
    "EmbeddingTokens": "100",
    "EmbeddingEntries": "10"
  },
  "Entities": {
    "entities": [
      {
        "Id": "1",
        "Entity": "Dr. Wang",
        "Type": "person",
        "Description": "A former advisor at DeepMind.",
        "FileName": "my_doc.txt"
      }
    ]
  },
  "Relations": {
    "relations": [
      {
        "Id": "1",
        "SourceEntity": "DeepMind consultant",
        "TargetEntity": "Dr. Wang",
        "Description": "Dr. Wang previously served as an advisor at DeepMind.",
        "FileName": "my_doc.txt\n"
      }
    ]
  }
}

エラーコード

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

変更履歴

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