Craft Vector Search

const { vectorSearch } = MODULES;

Table of Contents

• Query
  • Properties
• SparseEmbedding
  • Properties
• SearchResultValue
  • Properties
• Restricts
  • Properties
• NumericRestrictsInt
  • Properties
• NumericRestrictsFloat
  • Properties
• NumericRestrictsDouble
  • Properties
• Datapoint
  • Properties
• DatapointForQuery
  • Properties
• Data
  • Properties
• upsert
  • Parameters
• remove
  • Parameters
• findNeighbors
  • Parameters
• upsertWithKvs
  • Parameters
• removeWithKvs
  • Parameters
• findNeighborsWithKvs
  • Parameters

Query

Type: Object

Properties

• datapoint DatapointForQuery データポイント
• neighborCount number 近傍データの数

SparseEmbedding

Type: Object

Properties

• values Array<number> 値の配列
• dimensions Array<number> 次元の配列

SearchResultValue

Type: Object

Properties

• nearestNeighbors Array<Object> 近傍データ

  • nearestNeighbors[].neighbors Array<Object> 近傍データ
  • nearestNeighbors[].neighbors Object [].datapoint - データポイント
  • nearestNeighbors[].neighbors string [].datapoint.datapointId - データポイント ID
  • nearestNeighbors[].neighbors Object [].datapoint.crowdingTag - クラウディングタグ
  • nearestNeighbors[].neighbors string [].datapoint.crowdingTag.crowdingAttribute - クラウディング属性
  • nearestNeighbors[].neighbors number [].distance - 距離
  • nearestNeighbors[].neighbors number [].sparseDistance - スパース距離

Restricts

Type: Object

Properties

• namespace string 名前空間
• allow_list Array<string> 許可リスト
• deny_list Array<string> 拒否リスト

NumericRestrictsInt

Type: Object

Properties

• namespace string 名前空間
• value_int number 整数値の制限

NumericRestrictsFloat

Type: Object

Properties

• namespace string 名前空間
• value_float number 浮動小数点数値の制限

NumericRestrictsDouble

Type: Object

Properties

• namespace string 名前空間
• value_double number 倍精度浮動小数点数値の制限

Datapoint

Type: Object

Properties

• datapoint_id string データポイントの ID
• feature_vector Array<number> 特徴ベクトル
• restricts Restricts? 制約
• numeric_restricts (NumericRestrictsInt | NumericRestrictsFloat | NumericRestrictsDouble)? 数値的制限

DatapointForQuery

Type: Object

Properties

• datapoint_id string? データポイントの ID (feature_vector が未指定の場合必須)
• feature_vector Array<number>? 特徴ベクトル (datapoint_id が未指定の場合必須)
• sparse_embedding SparseEmbedding? スパース埋め込み (datapoint_id と feature_vector の両方が未指定の場合必須)
• restricts Restricts? 制約
• numeric_restricts (NumericRestrictsInt | NumericRestrictsFloat | NumericRestrictsDouble)? 数値的制限

• Throws Error datapoint_id と feature_vector の両方が未指定の場合エラー

Data

Type: Object

Properties

• datapoints Array<Datapoint> データポイントの配列

upsert

データを挿入または更新する

Parameters

• param Data

  • param.indexId string インデックス ID
  • param.datapoints Array<Datapoint> データポイントの配列
  • param.partition string? データの論理的な分割（複数アプリでインスタンスを共有する場合に指定）

Returns Promise<{}>

remove

データを削除する

Parameters

• param Object

  • param.indexId string インデックス ID
  • param.datapointIds Array<string> データポイント ID の配列
  • param.partition string? データの論理的な分割（複数アプリでインスタンスを共有する場合に指定）

Returns Promise<{}>

findNeighbors

近傍データを検索する

Parameters

• param Object

  • param.indexEndpointId string インデックスエンドポイント ID
  • param.queries Query クエリ
  • param.partition string? データの論理的な分割（複数アプリでインスタンスを共有する場合に指定）

Returns Promise<SearchResultValue>

upsertWithKvs

データを挿入または更新する（KVS 統合版）

Parameters

• param Object

  • param.indexId string インデックス ID
  • param.datapoints Array データポイントの配列（data プロパティを含むことができる）
  • param.kvsMinutesToExpire number? KVS データの有効期限（分）
  • param.partition string? データの論理的な分割（複数アプリでインスタンスを共有する場合に指定）

Returns Promise<{}>

removeWithKvs

データを削除する（KVS 統合版）

Parameters

• param Object

  • param.indexId string インデックス ID
  • param.datapointIds Array<string> データポイント ID の配列
  • param.partition string? データの論理的な分割（複数アプリでインスタンスを共有する場合に指定）

Returns Promise<{}>

findNeighborsWithKvs

近傍データを検索する（KVS 統合版）

Parameters

• param Object

  • param.indexEndpointId string インデックスエンドポイント ID
  • param.queries Array<Query> クエリ
  • param.partition string? データの論理的な分割（複数アプリでインスタンスを共有する場合に指定）

Returns Promise<SearchResultValue>