Upstash Vector Store
UpstashVectorクラスは、Upstash Vector を使用したベクトル検索を提供します。Upstash Vectorは、メタデータフィルタリング機能を備えたベクトル類似性検索を提供するサーバーレスベクトルデータベースサービスです。
コンストラクタオプション
url:
string
Upstash Vectorデータベース URL
token:
string
Upstash Vector APIトークン
メソッド
createIndex()
注意:Upstashではインデックスは自動的に作成されるため、このメソッドは何も実行しません。
indexName:
string
作成するインデックスの名前
dimension:
number
ベクトルの次元数(埋め込みモデルと一致する必要があります)
metric?:
'cosine' | 'euclidean' | 'dotproduct'
= cosine
類似性検索の距離メトリック
upsert()
indexName:
string
アップサートするインデックスの名前
vectors:
number[][]
埋め込みベクトルの配列
metadata?:
Record<string, any>[]
各ベクトルのメタデータ
ids?:
string[]
オプションのベクトルID(提供されない場合は自動生成されます)
query()
indexName:
string
クエリを実行するインデックスの名前
queryVector:
number[]
類似ベクトルを検索するためのクエリベクトル
topK?:
number
= 10
返す結果の数
filter?:
Record<string, any>
クエリのメタデータフィルター
includeVector?:
boolean
= false
結果にベクトルを含めるかどうか
listIndexes()
インデックス名(名前空間)の文字列配列を返します。
describeIndex()
indexName:
string
説明するインデックスの名前
戻り値:
interface IndexStats {
dimension: number;
count: number;
metric: "cosine" | "euclidean" | "dotproduct";
}
deleteIndex()
indexName:
string
削除するインデックス(名前空間)の名前
updateVector()
indexName:
string
更新するインデックスの名前
id:
string
更新するアイテムのID
update:
object
ベクトルやメタデータを含む更新オブジェクト
update
オブジェクトは以下のプロパティを持つことができます:
vector
(オプション):新しいベクトルを表す数値の配列。metadata
(オプション):メタデータのキーと値のペアのレコード。
vector
もmetadata
も提供されない場合、またはmetadata
のみが提供される場合はエラーがスローされます。
deleteVector()
indexName:
string
アイテムを削除するインデックスの名前
id:
string
削除するアイテムのID
指定されたインデックスからIDによってアイテムを削除しようとします。削除に失敗した場合はエラーメッセージをログに記録します。
レスポンスタイプ
クエリ結果は以下の形式で返されます:
interface QueryResult {
id: string;
score: number;
metadata: Record<string, any>;
vector?: number[]; // Only included if includeVector is true
}
エラー処理
ストアは捕捉可能な型付きエラーをスローします:
try {
await store.query({
indexName: "index_name",
queryVector: queryVector,
});
} catch (error) {
if (error instanceof VectorStoreError) {
console.log(error.code); // 'connection_failed' | 'invalid_dimension' | etc
console.log(error.details); // Additional error context
}
}
環境変数
必要な環境変数:
UPSTASH_VECTOR_URL
: あなたのUpstash VectorデータベースのURLUPSTASH_VECTOR_TOKEN
: あなたのUpstash Vector APIトークン