ベクトルAtlas Searchのフィールドにインデックスを付ける方法

配置タイプ

インターフェース

vectorSearch タイプを使用して、$vectorSearch クエリを実行するためのフィールドにインデックスを作成できます。クエリするベクトル埋め込みのインデックスと、データを事前にフィルタリングするために使用する追加フィールドを定義できます。データをフィルタリングすると、セマンティック検索の範囲が絞り込まれ、マルチテナント環境などで特定のベクトル埋め込みを比較対象から排除するのに役立ちます。

MongoDB mongosh ベクトル検索インデックスを作成するには、 Atlas UI、 Atlas Admin API、Atlas CLI、、サポートされているMongoDBドライバーを使用できます。

注意

非推奨のknnBeta演算子を使用して、 vectorSearch型のインデックス定義を使用してインデックス付けされたフィールドをクエリすることはできません。

Considerations

vectorSearch 型のインデックス定義では、単一要素のみを含む配列のインデックスを作成できます。ドキュメントの配列内にフィールドを埋め込み、またはオブジェクトの配列内にフィールドを埋め込むインデックスはできません。ドット表記を使用して、ドキュメント内の埋め込みフィールドにインデックスことができます。同じ埋め込みフィールドを、同じインデックス定義内で複数回インデックスすることはできません。

埋め込みのインデックスを作成する前に、クラスターの効率的なストレージのために、埋め込みをサブタイプ float32、int1、または int8 を持つ BSON ベクトルに変換することをお勧めします。詳細については、埋め込みをBSONベクトルに変換する方法を参照してください。

MongoDB ベクトル検索インデックスを使用すると、Atlas クラスターのアイドルノードでリソース消費が上昇する可能性があります。これは、 MongoDB ベクトル検索のさまざまな重要な操作を実行する基礎の mongot プロセスによるものです。アイドルノードでの CPU 使用率は、インデックスの数、複雑さ、サイズによって異なる場合があります。

インデックスのサイズに関する考慮事項について詳しくは、「ベクトルのインデックス作成におけるメモリ要件」を参照してください。

MongoDB ベクトル検索インデックスを定義したコレクションに変更を加えた場合、クエリですぐに最新データを使用できない場合があります。ただし、mongot は変更ストリームをモニターし、保存されたデータのコピーをアップデートするため、 MongoDB ベクトル検索インデックスは結果一貫性を確保します。Atlas UIでインデックス作成された Documents の数を表示して、コレクションへの変更がインデックスに反映されていることを確認できます。

あるいは、コレクションに新しいドキュメントを追加した後に新しいインデックスを作成し、インデックスがクエリ可能になるまで待つこともできます。また、次のようなポーリングロジックを実装して、インデックスの使用を試みる前にインデックスの準備ができていることを確認することもできます。

例

console.log("Polling to check if the index is ready. This may take up to a minute.")
let isQueryable = false;
while (!isQueryable) {
  const cursor = collection.listSearchIndexes();
  for await (const index of cursor) {
    if (index.name === result) {
      if (index.queryable) {
        console.log(`${result} is ready for querying.`);
        isQueryable = true;
      } else {
        await new Promise(resolve => setTimeout(resolve, 5000));
      }
    }
  }
}

サポートされているクライアント

MongoDB ベクトル検索インデックスは、 Atlas UI、、Atlas CLI、 Atlasmongosh 管理API、および次のMongoDBドライバーを使用して作成、管理できます。

MongoDB ドライバー	バージョン
C	1.28.0 以上
C++	3.11.0 以上
C#	3.1.0 以上
Go	1.16.0 以上
Java	5.2.0 以上
Kotlin	5.2.0 以上
Node	6.6.0 以上
PHP	1.20.0 以上
Python	4.7 以上
Rust	3.1.0 以上
Scala	5.2.0 以上

構文

次の構文は、 vectorSearchインデックスタイプを定義します。

1 {
2   "fields":[
3     {
4       "type": "vector",
5       "path": "<field-to-index>",
6       "numDimensions": <number-of-dimensions>,
7       "similarity": "euclidean | cosine | dotProduct",
8       "quantization": "none | scalar | binary",
9       "hnswOptions": {
10         "maxEdges": <number-of-connected-neighbors>,
11         "numEdgeCandidates": <number-of-nearest-neighbors>
12       }
13     },
14     {
15       "type": "filter",
16       "path": "<field-to-index>"
17     },
18     ...
19   ]
20 }

MongoDB ベクトル検索インデックスフィールド

MongoDB ベクトル検索インデックス定義には次のフィールドがあります。

オプション	タイプ	必要性	目的
`fields`	フィールド定義ドキュメントの配列	必須	インデックスへのベクトルフィールドとフィルターフィールドの定義。ドキュメントごとに 1 つの定義。各フィールド定義ドキュメントは、インデックスを作成するフィールドの `type`、`path`などの構成オプションを指定します。 `fields` 配列には少なくとも 1 つの `vector` タイプのフィールド定義が含まれている必要があります。配列に追加の `filter` タイプのフィールド定義を追加して、データを事前にフィルタリングできます。
`fields.` `type`	文字列	必須	`$vectorSearch`のフィールドをインデックス化するために使用するフィールドタイプ。次のいずれかの値を指定できます。 `vector` - ベクトル埋め込みを含むフィールドの場合。 `filter` - フィルタリングする追加のフィールド用。ブール値、date、objectId、numeric、string、UUID の値（これらの型の配列を含む）をフィルタリングできます。詳しくは、「型について`vector` 」と「 `filter`型について」を参照してください。
`fields.` `path`	文字列	必須	インデックスを作成するフィールドの名前。ネストされたフィールドの場合は、ドット表記を使用して埋め込みフィールドへのパスを指定します。
`fields.` `numDimensions`	Int	必須	MongoDB ベクトル検索がインデックス作成時およびクエリ時に強制されるベクトル次元の数。このフィールドは`vector` タイプのフィールドにのみ設定できます。`8192` 以下の値を指定する必要があります。量子化ベクトルまたは BinData のインデックス作成には、次のいずれかの値を指定できます。 `1` 取り込み用の `int8` ベクトルの場合は `8192` へ取り込み用の `int1` ベクトルに対する `8` の複数形。 `1` 自動スカラー量子化の場合は `binData(float32)` ベクトルは `8192` に、`array(float32)` ベクトルは自動バイナリ量子化用の `binData(float32)` ベクトルと `array(float32)` ベクトルの `8` の倍数。選択した埋め込みモデルによってベクトル埋め込みの次元数が決まります。出力の次元数に関して複数のオプションを持つモデルもあります。詳細については、「埋め込みを作成する方法の選択」を参照してください。
`fields.` `similarity`	文字列	必須	上位 K 近傍の検索に使用するベクトル類似度関数。このフィールドは`vector` タイプのフィールドにのみ設定できます。次のいずれかの値を指定できます。 `euclidean` - ベクトルの端点間の距離を測定します。 `cosine` - ベクトル間の角度に基づいて類似性を測定します。 `dotProduct` - は `cosine` と同様の類似性を測定しますが、ベクトルの大きさを考慮します。詳細については、「類似性関数について」を参照してください。
`fields.` `quantization`	文字列	任意	ベクトルの自動ベクトル量子化のタイプ。埋め込みが `float` または `double` ベクトルである場合にのみ、この設定を使用してください。次のいずれかの値を指定できます。 `none` -ベクトル埋め込みの自動量子化がないことを示します。取り込み用に事前に量子化されたベクトルがある場合は、この設定を使用します。省略した場合、これはデフォルト値になります。 `scalar` - 値を 1 バイト整数に変換するスカラー量子化を示します。 `binary` - 値を単一ビットに変換するバイナリ量子化を示します。この値を使用するには、`numDimensions` は 8 の倍数である必要があります。精度が重要な場合は、`binary` の代わりに `none` または `scalar` を選択します。詳細については、「ベクトル量子化」を参照してください。
`fields.` `hnswOptions`	オブジェクト	任意	Hierarchical Navigable Small Worldsグラフの構築に使用するパラメーター。省略した場合、は `maxEdges` パラメーターと `numEdgeCandidates` パラメーターにデフォルト値を使用します。重要: これはプレビュー機能として利用できます。デフォルト値を変更すると、 MongoDB ベクトル検索インデックスとクエリに悪影響を影響可能性があります。
`fields.` `hnswOptions.` `maxEdges`	Int	任意	Hierarchical Navigable Small Worldsグラフでノードが持つことができるエッジ（または接続）の最大数。値は、両端を含む `16` から `64` までです。省略した場合、デフォルトは `16` になります。例、の値が `16` の場合、各ノードはHierarchical Navigable Small Worldsグラフのレイヤーに最大 60 個の出力エッジを持つことができます。数値が大きいほど、グラフの接続がより適切になるため、再現率（検索結果の精度）が向上します。ただし、グラフノードごとに評価する近傍の数であるため、クエリ速度は低下し、各ノードがより多くの接続を保存するためHierarchical Navigable Small Worldsグラフのメモリが増加し、 MongoDB ベクトル検索がより多くの近傍を評価し、を調整するためインデックス作成が遅くなります。グラフに追加されたすべての新しいノード。
`fields.` `hnswOptions.` `numEdgeCandidates`	Int	任意	クエリ時の `numCandidates` と同様に、このパラメータは、新しいノードに接続する上で最も近い隣接ノードを見つけるため、評価するノードの最大数を制御します。値は、`100` から `3200` の範囲で、両端を含みます。省略した場合、デフォルトは `100` になります。数値が大きいほど、高品質な接続を持つグラフが提供され、検索品質（リコール）が向上しますが、クエリのレイテンシに悪影響を与える可能性もあります。

`vector` 型について

インデックス定義の vector フィールドには、次のいずれかのタイプの数値の配列が含まれている必要があります。

BSON double
BSON BinData vector サブタイプ float32
BSON BinData vector サブタイプ int1
BSON BinData vector サブタイプ int8

注意

データ用にサブタイプfloat32 int1 またはint8 を持つ BSON BinData ベクトルの生成の詳細については、「事前に量子化されたベクトルを取り込む方法」をご覧ください。

ベクトルフィールドは、fields 配列内の vector タイプとしてインデックスする必要があります。

次の構文は、 vectorフィールド型を定義します。

1 {
2   "fields":[
3     {
4       "type": "vector",
5       "path": <field-to-index>,
6       "numDimensions": <number-of-dimensions>,
7       "similarity": "euclidean | cosine | dotProduct",
8       "quantization": "none | scalar | binary",
9       "hnswOptions": {
10         "maxEdges": <number-of-connected-neighbors>,
11         "numEdgeCandidates": <number-of-nearest-neighbors>
12       }
13     },
14     ...
15   ]
16 }

類似度関数について

MongoDB ベクトル検索は次の類似性関数をサポートしています。

euclidean - ベクトルの端点間の距離を測定します。この値により、さまざまな次元に基づいて類似性を測定できます。詳しくは、「Euclidean」を参照してください。
cosine - ベクトル間の角度に基づいて類似性を測定します。この値により、大きさでスケーリングされない類似性を測定できます。 cosine では絶対値ゼロのベクトルは使用できません。コサイン類似度を測定するには、ベクトルを正規化し、代わりに dotProduct を使用することをお勧めします。
dotProduct - cosineと同様の類似性を測定しますが、ベクトルの大きさを考慮します。大きさを正規化すると、類似性の測定においてcosineとdotProductはほぼ同じになります。
dotProduct を使用するには、インデックス作成時とクエリ時にベクトルを単位の長さで正規化する必要があります。

次の表は、さまざまなタイプの類似性関数を示しています。

ベクトル埋め込みタイプ	`euclidean`	`cosine`	`dotProduct`
`binData(int1)`	✓
`binData(int8)`	✓	✓	✓
`binData(float32)`	✓	✓	✓
`array(float32)`	✓	✓	✓

ベクトル取り込み用。

自動スカラーまたはバイナリ定量化用。

最高のパフォーマンスを得るには、埋め込みモデルをチェックして、どの類似度関数が埋め込みモデルの訓練プロセスと一致するかを判断します。ガイダンスがない場合は、dotProduct から開始してください。 fields.similarity を dotProduct の値に設定すると、角度と大きさの両方に基づいて類似性を効率的に測定できます。 dotProduct は cosine よりも計算リソースの消費量が少なく、ベクトルが単位の長さの場合に効率的です。ただし、ベクトルが正規化されていない場合は、サンプルクエリの結果の類似性スコアを euclidean 距離と cosine 類似性について評価して、どれが妥当な結果に対応しているかを判断してください。

`filter` 型について

データを事前にフィルタリングするために追加フィールドにインデックスを作成することもオプションで可能です。ブール値、date、objectId、numeric、string、UUID の値（これらの型の配列を含む）をフィルタリングできます。データをフィルタリングすると、セマンティック検索の範囲が絞り込まれ、すべてのベクトルが比較対象とならないように徹底するのに役立ちます。類似性比較の実行対象となるドキュメント数が減るため、クエリのレイテンシの短縮と検索結果の精度向上を図ることができます。

fields 配列内で filter タイプを使用して、フィルタリングするフィールドをインデックス必要があります。

次の構文は、 filterフィールド型を定義します。

1 {
2   "fields":[
3     {
4       "type": "vector",
5       ...
6     },
7     {
8       "type": "filter",
9       "path": "<field-to-index>"
10     },
11     ...
12   ]
13 }

注意

データを事前にフィルタリングしても、 MongoDB ベクトル検索がクエリに$vectorSearchScore $vectorSearchを使用して返すスコアには影響しません。

MongoDB ベクトル検索インデックスの作成

Atlas UI、 Atlas 管理API 、 Atlas CLI を使用して、クラスター上の任意の種類のデータに対して、長さが 8192 次元以下のベクトル埋め込みを含むすべてのコレクションに対するMongoDB ベクトル検索インデックスを作成できます。mongosh、またはサポートされているMongoDBドライバー。

前提条件

MongoDB ベクトル検索インデックスを作成するには、次の前提条件を持つクラスターが必要です。

MongoDB バージョン6.0.11 、 7.0.2 、または以上
MongoDB ベクトル検索インデックスの作成対象のコレクション

注意

mongosh コマンドまたはドライバーヘルパーメソッドを使用して、すべての Atlas クラスター階層にMongoDB ベクトル検索インデックスを作成できます。サポートされているドライバーバージョンのリストについては、サポートされているクライアントを参照してください。

必要なアクセス権

Project Data Access AdminMongoDB ベクトル検索インデックスを作成および管理するには、以上のロールが必要です。

インデックスの制限

インデックス作成数の上限は以下のとおりです。

M0クラスターの3インデックス (タイプに関係なく、searchまたはvector)。
Flex クラスターで 10 インデックス。

単一の M10+ クラスターには、2,500 以下の検索インデックスを作成することを推奨します。

手順

注意

この手順には、sample_mflixデータベース内の embedded_moviesコレクションのインデックス定義の例が含まれています。サンプルデータをクラスターにロードし、このコレクションの例MongoDB ベクトル検索インデックスを作成すると、このコレクションに対してサンプル$vectorSearch クエリを実行できます。実行できるサンプルクエリの詳細については、$vectorSearch の例を参照してください。

MongoDB ベクトル検索インデックスの表示

Atlas UI、 Atlas 管理API、 Atlas CLI、 mongosh、またはサポートされているMongoDBドライバーから、すべてのコレクションのMongoDB ベクトル検索インデックスを表示できます。

必要なアクセス権

MongoDB ベクトル検索インデックスを表示するには、Project Search Index Editor 以上のロールが必要です。

注意

mongosh コマンドまたはドライバーヘルパーメソッドを使用して、すべての Atlas クラスター階層のMongoDB ベクトル検索インデックスを検索できます。サポートされているドライバーバージョンのリストについては、サポートされているクライアントを参照してください。

手順

MongoDB ベクトル検索インデックスの編集

既存のMongoDB ベクトル検索インデックスのインデックス定義は、 Atlas UI、 Atlas 管理API、 Atlas CLI、mongosh 、またはサポートされているMongoDBドライバーから変更できます。インデックスの名前を変更したり、インデックスタイプを変更したりすることはできません。インデックスの名前またはタイプを変更する必要がある場合は、新しいインデックスを作成し、古いインデックスを削除する必要があります。

重要

インデックスを編集すると、 MongoDB ベクトル検索はそのインデックスを再構築します。インデックスの再ビルド中も、古いインデックス定義を使用してベクトル検索クエリを引き続き実行できます。インデックスの再構築が完了すると、古いインデックスは自動的に置き換えられます。このプロセスはMongoDB Search インデックスと同様です。詳しくは、「 MongoDB Search インデックスの作成と更新」を参照してください。

必要なアクセス権

MongoDB ベクトル検索インデックスを編集するには、Project Search Index Editor 以上のロールが必要です。

注意

mongosh コマンドまたはドライバーヘルパーメソッドを使用して、すべての Atlas クラスター階層のMongoDB ベクトル検索インデックスを編集できます。サポートされているドライバーバージョンのリストについては、サポートされているクライアントを参照してください。

手順

MongoDB ベクトル検索インデックスの削除

MongoDB ベクトル検索インデックスは、 Atlas UI、 Atlas 管理API、Atlas CLI、mongosh、またはサポートされているMongoDBドライバーからいつでも削除できます。

必要なアクセス権

MongoDB ベクトル検索インデックスを削除するには、Project Search Index Editor 以上のロールが必要です。

注意

mongosh コマンドまたはドライバーヘルパーメソッドを使用して、すべての Atlas クラスター階層上のMongoDB ベクトル検索インデックスを削除できます。サポートされているドライバーバージョンのリストについては、サポートされているクライアントを参照してください。

手順

インデックスのステータス

MongoDB ベクトル検索インデックスを作成すると、Status 列にはクラスターのプライマリノードにおけるインデックスの現在の状態が表示されます。クラスタ内のすべてのノードにおけるインデックスの状態を表示するには、ステータスの下にある View status details リンクをクリックします。

Status 列が Active の場合、インデックスは使用可能です。そのほかの状態の場合は、インデックスに対するクエリに不完全な結果が返される場合があります。

ステータス	説明
開始前	Atlas によるインデックスの構築は開始されていません。
最初の同期	Atlas はインデックスを構築中、または編集したインデックスを再構築中です。インデックスがこの状態のとき、次の状況が発生します。新しいインデックスの場合、 MongoDB ベクトル検索はインデックス構築が完了するまでクエリを処理しません。既存のインデックスの場合、インデックスの再構築が完了するまで、ユーザーは古いインデックスを引き続き使用して既存のクエリと新しいクエリを処理できます。
アクティブ	インデックスをいつでも使用できます。
リカバリ中	レプリケーションでエラーが発生しました。この状態は通常、現在のレプリケーション点が`mongod` oplogで使用できなくなった場合に発生します。既存のインデックスがアップデートされ、ステータスが Active に変わるまで、引き続き既存のインデックスをクエリできます。View status details モーダルウィンドウのエラーを使用して、問題のトラブルシューティングを行います。詳しくは、「問題の修正」を参照してください。
失敗	Atlas によるインデックスのビルドは失敗しました。View status details モーダルウィンドウのエラーを使用して、問題のトラブルシューティングを行います。詳しくは、「問題の修正」を参照してください。
削除中	Atlas はクラスターノードからインデックスを削除しています。

Atlas によるインデックスの構築中および構築の完了後、Documents 列にはインデックス済みドキュメントの割合と数が表示されます。また、この列には、コレクション内の総ドキュメント数も表示されます。

戻る

埋め込みの作成

クエリ参照

1	{
2	"fields":[
3	{
4	"type": "vector",
5	"path": "<field-to-index>",
6	"numDimensions": <number-of-dimensions>,
7	"similarity": "euclidean \| cosine \| dotProduct",
8	"quantization": "none \| scalar \| binary",
9	"hnswOptions": {
10	"maxEdges": <number-of-connected-neighbors>,
11	"numEdgeCandidates": <number-of-nearest-neighbors>
12	}
13	},
14	{
15	"type": "filter",
16	"path": "<field-to-index>"
17	},
18	...
19	]
20	}

1	{
2	"fields":[
3	{
4	"type": "vector",
5	"path": <field-to-index>,
6	"numDimensions": <number-of-dimensions>,
7	"similarity": "euclidean \| cosine \| dotProduct",
8	"quantization": "none \| scalar \| binary",
9	"hnswOptions": {
10	"maxEdges": <number-of-connected-neighbors>,
11	"numEdgeCandidates": <number-of-nearest-neighbors>
12	}
13	},
14	...
15	]
16	}

注意

Considerations

例

サポートされているクライアント

構文

MongoDB ベクトル検索インデックス フィールド

vector 型について

注意

類似度関数について

filter 型について

注意

MongoDB ベクトル検索インデックスの作成

前提条件

注意

必要なアクセス権

インデックスの制限

手順

注意

MongoDB ベクトル検索インデックスの表示

必要なアクセス権

注意

手順

MongoDB ベクトル検索インデックスの編集

重要

必要なアクセス権

注意

手順

MongoDB ベクトル検索インデックスの削除

必要なアクセス権

注意

手順

インデックスのステータス

ルール バッジを取得する

MongoDB ベクトル検索インデックスフィールド

`vector` 型について

`filter` 型について

ルールバッジを取得する