指定されたコレクションに 1 つの Atlas Search インデックスを作成します。Atlas Search インデックスは、インデックスを作成するフィールドと、インデックスを作成するときに使用するアナライザを定義します。MongoDB v4.2 以降を実行しているクラスターのみが Atlas Search を使用できます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセス管理者ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
Atlas Search インデックスを作成するコレクションを含むクラスターの名前。
形式は次のパターンと一致する必要があります:
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
オブジェクト
必須
指定されたコレクションに 1 つの Atlas Search インデックスを作成します。
-
1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。
-
1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。
-
このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。
-
インデックスパーティションの数。許可されている値は［1、2、4］です。
デフォルト値は
1です。 -
Atlas Search にすべてのフィールド （true） を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません（false）。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか（include）、または保存しないフィールドのリストを含む（exclude）オブジェクトを指定することもできます。ベクトル検索インデックスではすべてのフィールド（true）の保存は許可されていないことに注意してください。詳しく学ぶには、ドキュメントを参照してください。
保存済みソース フィールド -
インデックスのタイプ。デフォルトのタイプは検索です。
値は
searchです。 -
データベース フィールド テキストを検索可能な単語に変換するために選択された特定の定義済みメソッド。この変換により、フィールドのテキストが最小のテキスト単位に縮小されます。これらの単位はタームまたはトークンと呼ばれます。トークン化と呼ばれるこのプロセスでは、フィールド内のテキストにさまざまな変更が加えられます。
- 単語の抽出
- 句読点の削除
- アクセントの削除
- 小文字への変更
- 一般的な単語の削除
- 単語を語幹形態まで縮小（ステミング）
- 単語を基本形に変更する（レンマ化）。MongoDB Cloud は、選択したプロセスを使用して Atlas Search インデックスを構築します。
値は
lucene.standard、lucene.simple、lucene.whitespace、lucene.keyword、lucene.arabic、lucene.armenian、lucene.basque、lucene.bengali、lucene.brazilian、lucene.bulgarian、lucene.catalan、lucene.chinese、lucene.cjk、lucene.czech、lucene.danish、lucene.dutch、lucene.english、lucene.finnish、lucene.french、lucene.galician、lucene.german、lucene.greek、lucene.hindi、lucene.hungarian、lucene.indonesian、lucene.irish、lucene.italian、lucene.japanese、lucene.korean、lucene.kuromoji、lucene.latvian、lucene.lithuanian、lucene.morfologik、lucene.nori、lucene.norwegian、lucene.persian、lucene.portuguese、lucene.romanian、lucene.russian、lucene.smartcn、lucene.sorani、lucene.spanish、lucene.swedish、lucene.thai、lucene.turkish、またはlucene.ukrainian。デフォルト値はlucene.standardです。Atlas Searchアナライザ -
データベース フィールドのテキストを検索可能な単語に変換するユーザー定義メソッドのリスト。
1 つの Atlas Searchカスタムアナライザを説明する設定。
カスタムの Atlas Search アナライザ アナライザの属性を非表示にする アナライザの属性を表示する オブジェクト
-
テキストを 1 文字ずつ検査し、フィルタリング操作を実行するフィルター。
次の 1 つ： HTML 構造を削除するフィルター。
ICU Normalizer で正規化されたテキストを処理するフィルター。これは、 Lucene の ICUNormazer2CharFilter に基づいています。
ICUNormazer2CharFilter 文字に指定した正規化マッピングを適用するフィルター。
ゼロ幅非結合のインスタンスを通常のスペースに置き換えるフィルター。これは Lucene の PersianCharFilter に基づいています。
PersianCharFilter -
カスタムアナライザを識別する、人間が判読できる名前。 名前はインデックス内で一意である必要があり、次のいずれかの文字列で始まらない必要があります。
lucene.builtin.mongodb.
-
次のような操作を実行するフィルター。
ステミング 。これにより、「toring」、「thaled」、「torages」などの関連単語を語幹単語の「torage」に減らします。
編集 : 公開ドキュメントから機密情報を排除します。
次のいずれか: asciFieltingオブジェクトdwitchMoあります xオブジェクト EdgeGramオブジェクトenglishPassiveオブジェクト flattenGraphオブジェクト icClusteringオブジェクト icuNormalizerオブジェクト kStemingオブジェクト 長さオブジェクト 小文字オブジェクト nGramオブジェクトportStemingオブジェクト 正規表現オブジェクト 逆オブジェクト単一オブジェクト refreshオブジェクトspanishPluralStemingオブジェクト ステミングオブジェクト ストップワードオブジェクト オブジェクトの削除 phraseDelimiterGraphオブジェクト基本ラテン Unicode ブロックに含まれていない文字、数字、および記号 Unicode 文字を ASCII に変換するフィルター（使用可能な場合）。
基本ラテン Unicode ブロック Darty-MongoDB Shellex 発音区別アルゴリズムに基づいて、同じように発音する単語のトークンを作成するフィルター。このフィルターは、入力ごとに複数のエンコーディングを生成できます。各エンコードされたトークンは 6 桁の数字です。
注意 : 次の場合は、daitchMotor保存オプションを使用しないでください。
-シノニム（同意語）またはオートコンプリート マッピング定義
- ファジーが有効になっている演算子。 Atlas Search は、 オートコンプリート 、ターム、および テキスト 演算子に対してのみ ファジー オプションをサポートしています。
デーモン] テキスト入力の左側、つまり「エッジ」からの入力を設定されたサイズの n グラムにトークン化するフィルター。このトークン フィルターは、シノニム（同意語）またはオートコンプリートのマッピング定義では使用できません。
属性を非表示 属性を表示
-
生成された n グラムの最大長を指定する値。この値は minGram 以上である必要があります。
-
生成された n グラムの最小長を指定する値。この値は maxGram 未満である必要があります。
-
minGram より短いトークンまたは maxGram より長いトークンのインデックスするかどうかを示す値。
値は
omitまたはincludeです。デフォルト値はomitです。 -
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
edgeGramです。
単語から所有語（後続の ）を削除するフィルター。
トークン フィルターグラフ（wordDelimiterGraph トークン フィルターが生成するトークン フィルターグラフなど）をインデックス作成に適した平面形式に変換するフィルター。
Unicode テクニカル レポート #30 からの文字フォールディングを適用するフィルター。
Unicode テクニカル レポート #30 標準の Unicode 正規化モードを使用してトークンを正規化するフィルター。
Unicode 正規化モード 言語のステミングと組み込み辞書を組み合わせたフィルターで、単語のステミングを行います。
小さすぎるまたは長すぎるトークンを削除するフィルター。
トークン テキストを小文字に正規化するフィルター。
入力を設定されたサイズの n グラムにトークン化するフィルター。このトークン フィルターは、シノニム（同意語）またはオートコンプリートのマッピング定義では使用できません。
属性を非表示 属性を表示
-
生成された n グラムの最大長を指定する値。この値は minGram 以上である必要があります。
-
生成された n グラムの最小長を指定する値。この値は maxGram 未満である必要があります。
-
minGram より短いトークンまたは maxGram より長いトークンのインデックスするかどうかを示す値。
値は
omitまたはincludeです。デフォルト値はomitです。 -
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
nGramです。
ポータル ステミングアルゴリズムを使用して、英語の単語から一般的な語形接尾辞、または語幹を読む フィルター 。これは小文字のテキストを要求し、大文字のテキストの場合は期待どおりに動作しません。
各トークンに正規式を適用し、指定された文字列に一致するフィルター。
一連のトークンからラップリング（トークン n グラム）を構築するフィルター。このトークン フィルターは、シノニム（同意語）またはオートコンプリートのマッピング定義では使用できません。
SNMP で生成されたステマーを使用してトークンをステミングするフィルター。
スキーレーターで生成されたステマー 属性を非表示 属性を表示
-
使用するスキーマが生成されたステマー。
値は
arabic、armenian、basque、catalan、danish、dutch、english、finnish、french、german、german2、hungarian、irish、italian、kp、lithuanian、lovins、norwegian、porter、portuguese、romanian、russian、spanish、swedish、またはturkish。 -
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
snowballStemmingです。
スペイン語の複数形の単語を語幹するフィルター。小文字のテキストが必要です。
Lucene のデフォルトのポーランド語ステマー テーブルを使用して、ポーランド言語の単語の語幹をサポートするフィルター。小文字のテキストが必要です。
デフォルトのポーランド語ステマー テーブル 指定されたストップワードに対応するトークンを削除するフィルター。このトークン フィルターは、指定されたストップワードは分析しません。
設定されたルールに基づいてトークンをサブトークンに分割するフィルター。
属性を非表示 属性を表示
-
単語をサブ単語に分割する方法を決定するルールを含むオブジェクト。
deleteOptions 属性を非表示 deleteOptions 属性を表示 オブジェクト
-
の実行を連結するかどうかを示すフラグ。
デフォルト値は
falseです。 -
サブ番号の実行を連結するかどうかを示すフラグ。
デフォルト値は
falseです。 -
サブワードの実行を連結するかどうかを示すフラグ。
デフォルト値は
falseです。 -
サブ番号に基づいてトークンを分割するかどうかを示すフラグ。 たとえば、
trueの場合、このオプションは100-2を100と2に分割します。デフォルト値は
trueです。 -
サブワードに基づいてトークンを分裂かどうかを示すフラグ。
デフォルト値は
trueです。 -
keyword属性がtrueに設定されているトークンをスキップするかどうかを示すフラグ。デフォルト値は
falseです。 -
元の単語のトークンを生成するかどうかを示すフラグ。
デフォルト値は
trueです。 -
大文字と小文字の移行に基づいてトークンを分裂かどうかを示すフラグ。
デフォルト値は
trueです。 -
文字数トランザクションに基づいてトークンを分裂かどうかを示すフラグ。
デフォルト値は
trueです。 -
各サブワードから後続の所有者を削除するかどうかを示すフラグ。
デフォルト値は
trueです。
-
-
保護された単語のオプションを含むオブジェクト。
-
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
wordDelimiterGraphです。
トークナイザ
オブジェクト 必須 トークンを作成するために使用する トークナイザ 。 トークンは、Atlas Search がインデックスを作成するためにテキストを個別のチャンクに分割する方法を決定します。
次の 1 つ： テキスト入力の左側、つまり「エッジ」から入力を指定されたサイズの n グラムに分割するトークナイザ。シノニム（同意語） または オートコンプリート のマッピング定義では、edgeGramトークナイザを使用できません。
入力全体を単一のトークンとして結合するトークナイザ。
入力を指定されたサイズのテキスト チャンク、つまり「n グラム」に分割するトークナイザ。シノニム（同意語） または オートコンプリート マッピング定義では nGramトークナイザは使用できません。
正規式パターンを使用してトークンを抽出する トークナイザ 。
正規表現ベースの区切り文字を使用してトークンを分割するトークナイザ。
Unicode テキスト分割アルゴリズムからの単語の分割ルールに基づいてトークンを分割するトークナイザ。
Unicode テキスト分割アルゴリズム URL とメールアドレスからトークンを作成するトークナイザ。このトークナイザはUnicode テキスト分割アルゴリズムの単語の分割ルールを使用しますが、インデックスされたフィールド値に URL とメールアドレスが含まれている場合にのみ使用することをお勧めします。 URL またはメールアドレスを含まないフィールドの場合は、標準のトークナイザを使用してワードブレークルールに基づいてトークンを作成します。
Unicode テキスト分割アルゴリズム
-
-
コレクションのフィールドのインデックス仕様。
マッピング属性の非表示 マッピング属性の表示 オブジェクト
-
インデックスが動的マッピングを使用するか、静的マッピングを使用するかを示すフラグ。 mappings.fields が省略されている場合は必須です。
デフォルト値は
falseです。動的マッピングまたは静的マッピング -
Atlas Searchインデックスの 1 つ以上のフィールド仕様。 mappings.dynum が省略されているか、 false に設定されている場合は必須です。
Atlas Search インデックス フィールド属性を非表示 フィールド属性を表示 オブジェクト
-
-
このインデックスを検索するときに単語を識別するために適用される方法。
値は
lucene.standard、lucene.simple、lucene.whitespace、lucene.keyword、lucene.arabic、lucene.armenian、lucene.basque、lucene.bengali、lucene.brazilian、lucene.bulgarian、lucene.catalan、lucene.chinese、lucene.cjk、lucene.czech、lucene.danish、lucene.dutch、lucene.english、lucene.finnish、lucene.french、lucene.galician、lucene.german、lucene.greek、lucene.hindi、lucene.hungarian、lucene.indonesian、lucene.irish、lucene.italian、lucene.japanese、lucene.korean、lucene.kuromoji、lucene.latvian、lucene.lithuanian、lucene.morfologik、lucene.nori、lucene.norwegian、lucene.persian、lucene.portuguese、lucene.romanian、lucene.russian、lucene.smartcn、lucene.sorani、lucene.spanish、lucene.swedish、lucene.thai、lucene.turkish、またはlucene.ukrainian。デフォルト値はlucene.standardです。 -
このインデックス内の単語を同義語にマッピングするルール セット。
この全文インデックスに使用されるシノニム（同意語）。
同義語マッピング シノニム属性を非表示にする シノニム（同意語）属性の表示 オブジェクト
-
検索するシノニム（同意語）に適用するために選択された特定の定義済みメソッド。
値は
lucene.standard、lucene.simple、lucene.whitespace、lucene.keyword、lucene.arabic、lucene.armenian、lucene.basque、lucene.bengali、lucene.brazilian、lucene.bulgarian、lucene.catalan、lucene.chinese、lucene.cjk、lucene.czech、lucene.danish、lucene.dutch、lucene.english、lucene.finnish、lucene.french、lucene.galician、lucene.german、lucene.greek、lucene.hindi、lucene.hungarian、lucene.indonesian、lucene.irish、lucene.italian、lucene.japanese、lucene.korean、lucene.kuromoji、lucene.latvian、lucene.lithuanian、lucene.morfologik、lucene.nori、lucene.norwegian、lucene.persian、lucene.portuguese、lucene.romanian、lucene.russian、lucene.smartcn、lucene.sorani、lucene.spanish、lucene.swedish、lucene.thai、lucene.turkish、またはlucene.ukrainian。 -
シノニム（同意語）の定義を識別するラベル。各 シノニム（同意語） は、同じインデックス定義内で一意である必要があります。
-
単語とそれに適用される同義語を保存するデータセット。
-
-
1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。
-
1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。
-
このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。
-
インデックスパーティションの数。許可されている値は［1、2、4］です。
デフォルト値は
1です。 -
Atlas Search にすべてのフィールド （true） を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません（false）。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか（include）、または保存しないフィールドのリストを含む（exclude）オブジェクトを指定することもできます。ベクトル検索インデックスではすべてのフィールド（true）の保存は許可されていないことに注意してください。詳しく学ぶには、ドキュメントを参照してください。
保存済みソース フィールド -
インデックスのタイプ。デフォルトのタイプは検索です。
値は
vectorSearchです。 -
オブジェクトごとに 1 つのフィールドを構成する設定。少なくとも 1 つの「ベクトル」タイプフィールドを定義する必要があります。オプションで、「フィルター」タイプのフィールドも定義できます。
ベクトル検索フィールド
応答
-
OK
次の 1 つ： 属性を非表示 属性を表示
-
1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。
-
1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。
-
このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。
-
インデックスパーティションの数。許可されている値は［1、2、4］です。
デフォルト値は
1です。 -
Atlas Search にすべてのフィールド （true） を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません（false）。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか（include）、または保存しないフィールドのリストを含む（exclude）オブジェクトを指定することもできます。ベクトル検索インデックスではすべてのフィールド（true）の保存は許可されていないことに注意してください。詳しく学ぶには、ドキュメントを参照してください。
保存済みソース フィールド -
インデックスのタイプ。デフォルトのタイプは検索です。
値は
searchです。 -
データベース フィールド テキストを検索可能な単語に変換するために選択された特定の定義済みメソッド。この変換により、フィールドのテキストが最小のテキスト単位に縮小されます。これらの単位はタームまたはトークンと呼ばれます。トークン化と呼ばれるこのプロセスでは、フィールド内のテキストにさまざまな変更が加えられます。
- 単語の抽出
- 句読点の削除
- アクセントの削除
- 小文字への変更
- 一般的な単語の削除
- 単語を語幹形態まで縮小（ステミング）
- 単語を基本形に変更する（レンマ化）。MongoDB Cloud は、選択したプロセスを使用して Atlas Search インデックスを構築します。
値は
lucene.standard、lucene.simple、lucene.whitespace、lucene.keyword、lucene.arabic、lucene.armenian、lucene.basque、lucene.bengali、lucene.brazilian、lucene.bulgarian、lucene.catalan、lucene.chinese、lucene.cjk、lucene.czech、lucene.danish、lucene.dutch、lucene.english、lucene.finnish、lucene.french、lucene.galician、lucene.german、lucene.greek、lucene.hindi、lucene.hungarian、lucene.indonesian、lucene.irish、lucene.italian、lucene.japanese、lucene.korean、lucene.kuromoji、lucene.latvian、lucene.lithuanian、lucene.morfologik、lucene.nori、lucene.norwegian、lucene.persian、lucene.portuguese、lucene.romanian、lucene.russian、lucene.smartcn、lucene.sorani、lucene.spanish、lucene.swedish、lucene.thai、lucene.turkish、またはlucene.ukrainian。デフォルト値はlucene.standardです。Atlas Searchアナライザ -
データベース フィールドのテキストを検索可能な単語に変換するユーザー定義メソッドのリスト。
1 つの Atlas Searchカスタムアナライザを説明する設定。
カスタムの Atlas Search アナライザ アナライザの属性を非表示にする アナライザの属性を表示する オブジェクト
-
テキストを 1 文字ずつ検査し、フィルタリング操作を実行するフィルター。
次の 1 つ： HTML 構造を削除するフィルター。
ICU Normalizer で正規化されたテキストを処理するフィルター。これは、 Lucene の ICUNormazer2CharFilter に基づいています。
ICUNormazer2CharFilter 文字に指定した正規化マッピングを適用するフィルター。
ゼロ幅非結合のインスタンスを通常のスペースに置き換えるフィルター。これは Lucene の PersianCharFilter に基づいています。
PersianCharFilter -
カスタムアナライザを識別する、人間が判読できる名前。 名前はインデックス内で一意である必要があり、次のいずれかの文字列で始まらない必要があります。
lucene.builtin.mongodb.
-
次のような操作を実行するフィルター。
ステミング 。これにより、「toring」、「thaled」、「torages」などの関連単語を語幹単語の「torage」に減らします。
編集 : 公開ドキュメントから機密情報を排除します。
次のいずれか: asciFieltingオブジェクトdwitchMoあります xオブジェクト EdgeGramオブジェクトenglishPassiveオブジェクト flattenGraphオブジェクト icClusteringオブジェクト icuNormalizerオブジェクト kStemingオブジェクト 長さオブジェクト 小文字オブジェクト nGramオブジェクトportStemingオブジェクト 正規表現オブジェクト 逆オブジェクト単一オブジェクト refreshオブジェクトspanishPluralStemingオブジェクト ステミングオブジェクト ストップワードオブジェクト オブジェクトの削除 phraseDelimiterGraphオブジェクト基本ラテン Unicode ブロックに含まれていない文字、数字、および記号 Unicode 文字を ASCII に変換するフィルター（使用可能な場合）。
基本ラテン Unicode ブロック Darty-MongoDB Shellex 発音区別アルゴリズムに基づいて、同じように発音する単語のトークンを作成するフィルター。このフィルターは、入力ごとに複数のエンコーディングを生成できます。各エンコードされたトークンは 6 桁の数字です。
注意 : 次の場合は、daitchMotor保存オプションを使用しないでください。
-シノニム（同意語）またはオートコンプリート マッピング定義
- ファジーが有効になっている演算子。 Atlas Search は、 オートコンプリート 、ターム、および テキスト 演算子に対してのみ ファジー オプションをサポートしています。
デーモン] テキスト入力の左側、つまり「エッジ」からの入力を設定されたサイズの n グラムにトークン化するフィルター。このトークン フィルターは、シノニム（同意語）またはオートコンプリートのマッピング定義では使用できません。
属性を非表示 属性を表示
-
生成された n グラムの最大長を指定する値。この値は minGram 以上である必要があります。
-
生成された n グラムの最小長を指定する値。この値は maxGram 未満である必要があります。
-
minGram より短いトークンまたは maxGram より長いトークンのインデックスするかどうかを示す値。
値は
omitまたはincludeです。デフォルト値はomitです。 -
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
edgeGramです。
単語から所有語（後続の ）を削除するフィルター。
トークン フィルターグラフ（wordDelimiterGraph トークン フィルターが生成するトークン フィルターグラフなど）をインデックス作成に適した平面形式に変換するフィルター。
Unicode テクニカル レポート #30 からの文字フォールディングを適用するフィルター。
Unicode テクニカル レポート #30 標準の Unicode 正規化モードを使用してトークンを正規化するフィルター。
Unicode 正規化モード 言語のステミングと組み込み辞書を組み合わせたフィルターで、単語のステミングを行います。
小さすぎるまたは長すぎるトークンを削除するフィルター。
トークン テキストを小文字に正規化するフィルター。
入力を設定されたサイズの n グラムにトークン化するフィルター。このトークン フィルターは、シノニム（同意語）またはオートコンプリートのマッピング定義では使用できません。
属性を非表示 属性を表示
-
生成された n グラムの最大長を指定する値。この値は minGram 以上である必要があります。
-
生成された n グラムの最小長を指定する値。この値は maxGram 未満である必要があります。
-
minGram より短いトークンまたは maxGram より長いトークンのインデックスするかどうかを示す値。
値は
omitまたはincludeです。デフォルト値はomitです。 -
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
nGramです。
ポータル ステミングアルゴリズムを使用して、英語の単語から一般的な語形接尾辞、または語幹を読む フィルター 。これは小文字のテキストを要求し、大文字のテキストの場合は期待どおりに動作しません。
各トークンに正規式を適用し、指定された文字列に一致するフィルター。
一連のトークンからラップリング（トークン n グラム）を構築するフィルター。このトークン フィルターは、シノニム（同意語）またはオートコンプリートのマッピング定義では使用できません。
SNMP で生成されたステマーを使用してトークンをステミングするフィルター。
スキーレーターで生成されたステマー 属性を非表示 属性を表示
-
使用するスキーマが生成されたステマー。
値は
arabic、armenian、basque、catalan、danish、dutch、english、finnish、french、german、german2、hungarian、irish、italian、kp、lithuanian、lovins、norwegian、porter、portuguese、romanian、russian、spanish、swedish、またはturkish。 -
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
snowballStemmingです。
スペイン語の複数形の単語を語幹するフィルター。小文字のテキストが必要です。
Lucene のデフォルトのポーランド語ステマー テーブルを使用して、ポーランド言語の単語の語幹をサポートするフィルター。小文字のテキストが必要です。
デフォルトのポーランド語ステマー テーブル 指定されたストップワードに対応するトークンを削除するフィルター。このトークン フィルターは、指定されたストップワードは分析しません。
設定されたルールに基づいてトークンをサブトークンに分割するフィルター。
属性を非表示 属性を表示
-
単語をサブ単語に分割する方法を決定するルールを含むオブジェクト。
deleteOptions 属性を非表示 deleteOptions 属性を表示 オブジェクト
-
の実行を連結するかどうかを示すフラグ。
デフォルト値は
falseです。 -
サブ番号の実行を連結するかどうかを示すフラグ。
デフォルト値は
falseです。 -
サブワードの実行を連結するかどうかを示すフラグ。
デフォルト値は
falseです。 -
サブ番号に基づいてトークンを分割するかどうかを示すフラグ。 たとえば、
trueの場合、このオプションは100-2を100と2に分割します。デフォルト値は
trueです。 -
サブワードに基づいてトークンを分裂かどうかを示すフラグ。
デフォルト値は
trueです。 -
keyword属性がtrueに設定されているトークンをスキップするかどうかを示すフラグ。デフォルト値は
falseです。 -
元の単語のトークンを生成するかどうかを示すフラグ。
デフォルト値は
trueです。 -
大文字と小文字の移行に基づいてトークンを分裂かどうかを示すフラグ。
デフォルト値は
trueです。 -
文字数トランザクションに基づいてトークンを分裂かどうかを示すフラグ。
デフォルト値は
trueです。 -
各サブワードから後続の所有者を削除するかどうかを示すフラグ。
デフォルト値は
trueです。
-
-
保護された単語のオプションを含むオブジェクト。
-
このトークン フィルター タイプを識別する、人間が判読できるラベル。
値は
wordDelimiterGraphです。
トークナイザ
オブジェクト 必須 トークンを作成するために使用する トークナイザ 。 トークンは、Atlas Search がインデックスを作成するためにテキストを個別のチャンクに分割する方法を決定します。
次の 1 つ： テキスト入力の左側、つまり「エッジ」から入力を指定されたサイズの n グラムに分割するトークナイザ。シノニム（同意語） または オートコンプリート のマッピング定義では、edgeGramトークナイザを使用できません。
入力全体を単一のトークンとして結合するトークナイザ。
入力を指定されたサイズのテキスト チャンク、つまり「n グラム」に分割するトークナイザ。シノニム（同意語） または オートコンプリート マッピング定義では nGramトークナイザは使用できません。
正規式パターンを使用してトークンを抽出する トークナイザ 。
正規表現ベースの区切り文字を使用してトークンを分割するトークナイザ。
Unicode テキスト分割アルゴリズムからの単語の分割ルールに基づいてトークンを分割するトークナイザ。
Unicode テキスト分割アルゴリズム URL とメールアドレスからトークンを作成するトークナイザ。このトークナイザはUnicode テキスト分割アルゴリズムの単語の分割ルールを使用しますが、インデックスされたフィールド値に URL とメールアドレスが含まれている場合にのみ使用することをお勧めします。 URL またはメールアドレスを含まないフィールドの場合は、標準のトークナイザを使用してワードブレークルールに基づいてトークンを作成します。
Unicode テキスト分割アルゴリズム
-
-
コレクションのフィールドのインデックス仕様。
マッピング属性の非表示 マッピング属性の表示 オブジェクト
-
インデックスが動的マッピングを使用するか、静的マッピングを使用するかを示すフラグ。 mappings.fields が省略されている場合は必須です。
デフォルト値は
falseです。動的マッピングまたは静的マッピング -
Atlas Searchインデックスの 1 つ以上のフィールド仕様。 mappings.dynum が省略されているか、 false に設定されている場合は必須です。
Atlas Search インデックス フィールド属性を非表示 フィールド属性を表示 オブジェクト
-
-
このインデックスを検索するときに単語を識別するために適用される方法。
値は
lucene.standard、lucene.simple、lucene.whitespace、lucene.keyword、lucene.arabic、lucene.armenian、lucene.basque、lucene.bengali、lucene.brazilian、lucene.bulgarian、lucene.catalan、lucene.chinese、lucene.cjk、lucene.czech、lucene.danish、lucene.dutch、lucene.english、lucene.finnish、lucene.french、lucene.galician、lucene.german、lucene.greek、lucene.hindi、lucene.hungarian、lucene.indonesian、lucene.irish、lucene.italian、lucene.japanese、lucene.korean、lucene.kuromoji、lucene.latvian、lucene.lithuanian、lucene.morfologik、lucene.nori、lucene.norwegian、lucene.persian、lucene.portuguese、lucene.romanian、lucene.russian、lucene.smartcn、lucene.sorani、lucene.spanish、lucene.swedish、lucene.thai、lucene.turkish、またはlucene.ukrainian。デフォルト値はlucene.standardです。 -
このインデックス内の単語を同義語にマッピングするルール セット。
この全文インデックスに使用されるシノニム（同意語）。
同義語マッピング シノニム属性を非表示にする シノニム（同意語）属性の表示 オブジェクト
-
検索するシノニム（同意語）に適用するために選択された特定の定義済みメソッド。
値は
lucene.standard、lucene.simple、lucene.whitespace、lucene.keyword、lucene.arabic、lucene.armenian、lucene.basque、lucene.bengali、lucene.brazilian、lucene.bulgarian、lucene.catalan、lucene.chinese、lucene.cjk、lucene.czech、lucene.danish、lucene.dutch、lucene.english、lucene.finnish、lucene.french、lucene.galician、lucene.german、lucene.greek、lucene.hindi、lucene.hungarian、lucene.indonesian、lucene.irish、lucene.italian、lucene.japanese、lucene.korean、lucene.kuromoji、lucene.latvian、lucene.lithuanian、lucene.morfologik、lucene.nori、lucene.norwegian、lucene.persian、lucene.portuguese、lucene.romanian、lucene.russian、lucene.smartcn、lucene.sorani、lucene.spanish、lucene.swedish、lucene.thai、lucene.turkish、またはlucene.ukrainian。 -
シノニム（同意語）の定義を識別するラベル。各 シノニム（同意語） は、同じインデックス定義内で一意である必要があります。
-
単語とそれに適用される同義語を保存するデータセット。
-
属性を非表示 属性を表示
-
1 つ以上の Atlas Search インデックスを含むコレクションを識別する、人間が判読できるラベル。
-
1 つ以上の Atlas Search インデックスを持つコレクションを含むデータベースを識別する、人間が判読できるラベル。
-
このインデックスを識別する、人間が判読できるラベル。各名前空間内では、名前空間内のすべてのインデックスの名前が一意である必要があります。
-
インデックスパーティションの数。許可されている値は［1、2、4］です。
デフォルト値は
1です。 -
Atlas Search にすべてのフィールド （true） を保存するかどうかを示すフラグ。デフォルトでは、Atlas は Atlas Search のフィールドを保存しません（false）。または、Atlas Search に保存するフィールドのリストのみを含むオブジェクトを指定するか（include）、または保存しないフィールドのリストを含む（exclude）オブジェクトを指定することもできます。ベクトル検索インデックスではすべてのフィールド（true）の保存は許可されていないことに注意してください。詳しく学ぶには、ドキュメントを参照してください。
保存済みソース フィールド -
インデックスのタイプ。デフォルトのタイプは検索です。
値は
vectorSearchです。 -
オブジェクトごとに 1 つのフィールドを構成する設定。少なくとも 1 つの「ベクトル」タイプフィールドを定義する必要があります。オプションで、「フィルター」タイプのフィールドも定義できます。
ベクトル検索フィールド
-
-
無効なリクエストです。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
許可されていません。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
Forbidden.
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
見つかりません。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
競合。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
内部サーバーエラー。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
atlas api atlasSearch createClusterFtsIndex --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupClusterFtsIndexApiParams{}
sdkResp, httpResp, err := client.AtlasSearchApi.
CreateGroupClusterFtsIndexWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \
-d '{ <Payload> }'{
"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"storedSource": {
"include | exclude": [
"field1",
"field2"
]
},
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [
{
"charFilters": [
{
"ignoredTags": [
"string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [
{
"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {
"maxGram": 42,
"minGram": 42,
"type": "edgeGram"
}
}
],
"mappings": {
"dynamic": false,
"fields": {
"additionalProperty1": {},
"additionalProperty2": {}
}
},
"searchAnalyzer": "lucene.standard",
"synonyms": [
{
"analyzer": "lucene.standard",
"name": "string",
"source": {
"collection": "string"
}
}
]
}{
"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"storedSource": {
"include | exclude": [
"field1",
"field2"
]
},
"type": "vectorSearch",
"fields": [
{
"additionalProperty1": {},
"additionalProperty2": {}
}
]
}{
"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"storedSource": {
"include | exclude": [
"field1",
"field2"
]
},
"type": "search",
"analyzer": "lucene.standard",
"analyzers": [
{
"charFilters": [
{
"ignoredTags": [
"string"
],
"type": "htmlStrip"
}
],
"name": "string",
"tokenFilters": [
{
"originalTokens": "omit",
"type": "asciiFolding"
}
],
"tokenizer": {
"maxGram": 42,
"minGram": 42,
"type": "edgeGram"
}
}
],
"mappings": {
"dynamic": false,
"fields": {
"additionalProperty1": {},
"additionalProperty2": {}
}
},
"searchAnalyzer": "lucene.standard",
"synonyms": [
{
"analyzer": "lucene.standard",
"name": "string",
"source": {
"collection": "string"
}
}
]
}{
"collectionName": "string",
"database": "string",
"name": "string",
"numPartitions": 1,
"storedSource": {
"include | exclude": [
"field1",
"field2"
]
},
"type": "vectorSearch",
"fields": [
{
"additionalProperty1": {},
"additionalProperty2": {}
}
]
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}