SearchIndex interface

パッケージ:

@azure/search-documents

インデックスのフィールドと検索動作を記述する検索インデックス定義を表します。

プロパティ

analyzers	インデックスのアナライザー。
charFilters	インデックスの文字フィルター。
corsOptions	インデックスのクロスオリジン リソース共有 (CORS) を制御するオプション。
defaultScoringProfile	クエリで何も指定されていない場合に使用するスコアリング プロファイルの名前。 このプロパティが設定されておらず、クエリでスコアリング プロファイルが指定されていない場合は、既定のスコアリング (tf-idf) が使用されます。
encryptionKey	Azure Key Vaultで作成する暗号化キーの説明。 このキーは、Microsoft だけでなく、誰もAzure Cognitive Searchでデータの暗号化を解除できないという完全な保証が必要な場合に、データの保存時の暗号化レベルを追加するために使用されます。 データを暗号化すると、常に暗号化されたままになります。 Azure Cognitive Searchは、このプロパティを null に設定する試行を無視します。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データは影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
etag	インデックスの ETag。
fields	インデックスのフィールド。
name	インデックスの名前です。
scoringProfiles	インデックスのスコアリング プロファイル。
semanticSearch	セマンティック機能に影響を与える検索インデックスのパラメーターを定義します。
similarity	検索クエリに一致するドキュメントのスコア付けとランク付けの際に使用する類似性アルゴリズムの種類。 類似性アルゴリズムは、インデックス作成時にのみ定義でき、既存のインデックスでは変更できません。 null の場合は、ClassicSimilarity アルゴリズムが使用されます。
suggesters	インデックスの suggesters。
tokenFilters	インデックスのトークン フィルター。
tokenizers	インデックスのトークナイザー。
vectorSearch	ベクター検索に関連する構成オプションが含まれています。

プロパティの詳細

analyzers

インデックスのアナライザー。

analyzers?: LexicalAnalyzer[]

プロパティ値

LexicalAnalyzer[]

charFilters

インデックスの文字フィルター。

charFilters?: CharFilter[]

プロパティ値

CharFilter[]

corsOptions

インデックスのクロスオリジン リソース共有 (CORS) を制御するオプション。

corsOptions?: CorsOptions

プロパティ値

CorsOptions

defaultScoringProfile

クエリで何も指定されていない場合に使用するスコアリング プロファイルの名前。 このプロパティが設定されておらず、クエリでスコアリング プロファイルが指定されていない場合は、既定のスコアリング (tf-idf) が使用されます。

defaultScoringProfile?: string

プロパティ値

string

encryptionKey

Azure Key Vaultで作成する暗号化キーの説明。 このキーは、Microsoft だけでなく、誰もAzure Cognitive Searchでデータの暗号化を解除できないという完全な保証が必要な場合に、データの保存時の暗号化レベルを追加するために使用されます。 データを暗号化すると、常に暗号化されたままになります。 Azure Cognitive Searchは、このプロパティを null に設定する試行を無視します。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。データは影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

encryptionKey?: SearchResourceEncryptionKey

プロパティ値

SearchResourceEncryptionKey

etag

インデックスの ETag。

etag?: string

プロパティ値

string

fields

インデックスのフィールド。

fields: SearchField[]

プロパティ値

SearchField[]

name

インデックスの名前です。

name: string

プロパティ値

string

scoringProfiles

インデックスのスコアリング プロファイル。

scoringProfiles?: ScoringProfile[]

プロパティ値

ScoringProfile[]

semanticSearch

セマンティック機能に影響を与える検索インデックスのパラメーターを定義します。

semanticSearch?: SemanticSearch

プロパティ値

SemanticSearch

similarity

検索クエリに一致するドキュメントのスコア付けとランク付けの際に使用する類似性アルゴリズムの種類。 類似性アルゴリズムは、インデックス作成時にのみ定義でき、既存のインデックスでは変更できません。 null の場合は、ClassicSimilarity アルゴリズムが使用されます。

similarity?: SimilarityAlgorithm

プロパティ値

SimilarityAlgorithm

suggesters

インデックスの suggesters。

suggesters?: SearchSuggester[]

プロパティ値

SearchSuggester[]

tokenFilters

インデックスのトークン フィルター。

tokenFilters?: TokenFilter[]

プロパティ値

TokenFilter[]

tokenizers

インデックスのトークナイザー。

tokenizers?: LexicalTokenizer[]

プロパティ値

LexicalTokenizer[]

vectorSearch

ベクター検索に関連する構成オプションが含まれています。

vectorSearch?: VectorSearch

プロパティ値

VectorSearch