Craft Vector Search 2.0

const { vectorSearch2 } = MODULES;

Table of Contents

• DenseVector
  • Properties
• SparseVector
  • Properties
• VectorValue
  • Properties
• OutputFields
  • Properties
• SearchQuery
  • Properties
• DataObject
  • Properties
• SearchResult
  • Properties
• get
  • Parameters
• create
  • Parameters
• update
  • Parameters
• delete
  • Parameters
• query
  • Parameters
• search
  • Parameters

DenseVector

Type: Object

Properties

• values Array<number> ベクトル値の配列

SparseVector

Type: Object

Properties

• values Array<number> ベクトル値の配列
• indices Array<number> インデックスの配列

VectorValue

Type: Object

Properties

• dense DenseVector? 密ベクトル
• sparse SparseVector? 疎ベクトル

OutputFields

Type: Object

Properties

• dataFields (string | Array<string>)? 出力するデータフィールド
• vectorFields (string | Array<string>)? 出力するベクターフィールド
• metadataFields (string | Array<string>)? 出力するメタデータフィールド

SearchQuery

Type: Object

Properties

• vectorField string? 検索対象のベクターフィールド名（ベクター検索・セマンティック検索時は必須）
• vector Array<number>? クエリベクトル（Bring Your Own Embeddings時）
• text string? 検索テキスト（Auto Embeddings時）
• taskType string? タスクタイプ（Auto Embeddings時のみ有効、デフォルト: ‘RETRIEVAL_QUERY’） 利用可能な値: RETRIEVAL_QUERY, RETRIEVAL_DOCUMENT, SEMANTIC_SIMILARITY, CLASSIFICATION, CLUSTERING, QUESTION_ANSWERING, FACT_VERIFICATION, CODE_RETRIEVAL_QUERY
• searchText string? 検索テキスト（全文検索時）
• searchFields Array<string>? 検索対象のデータフィールド名の配列（全文検索時は必須）

DataObject

Type: Object

Properties

• dataObjectId string Data Object ID
• data Object ユーザーデータ
• vectors Object<string, VectorValue>? ベクター値
• createTime string 作成日時
• updateTime string 更新日時

SearchResult

Type: Object

Properties

• dataObject DataObject Data Object
• distance number 類似度スコア

get

Data Objectを取得する

Parameters

• param Object

  • param.collectionId string コレクションID
  • param.dataObjectId string Data Object ID

Returns Promise<DataObject>

create

Data Objectを作成する

Parameters

• param Object

  • param.collectionId string コレクションID
  • param.dataObjectId string Data Object ID
  • param.data Object ユーザーデータ
  • param.vectors Object<string, VectorValue>? ベクター値（Bring Your Own Embeddings時）

Returns Promise<DataObject>

update

Data Objectを更新する（部分更新）

Parameters

• param Object

  • param.collectionId string コレクションID
  • param.dataObjectId string Data Object ID
  • param.data Object? ユーザーデータ
  • param.vectors Object<string, VectorValue>? ベクター値（Bring Your Own Embeddings時）

Returns Promise<DataObject>

delete

Data Objectを削除する

Parameters

• param Object

  • param.collectionId string コレクションID
  • param.dataObjectId string Data Object ID

Returns Promise<{}>

query

Data Objectをクエリする（フィルタ検索）

Parameters

• param Object

  • param.collectionId string コレクションID
  • param.pageSize number? 1ページあたりの件数
  • param.pageToken string? ページトークン
  • param.filter Object? フィルタ条件
  • param.outputFields OutputFields? 出力フィールド設定

search

検索を実行する（ベクター検索・セマンティック検索・全文検索）

Parameters

• param Object

  • param.collectionId string コレクションID
  • param.query SearchQuery 検索クエリ
  • param.topK number? 取得件数
  • param.filter Object? フィルタ条件
  • param.outputFields OutputFields? 出力フィールド設定（デフォルト: 全フィールド）

Returns Promise<{results: Array<SearchResult>}>