models パッケージ

リファレンス

クラス

AnalyzeResult	テキストでアナライザーをテストした結果。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
AnalyzeTextOptions	そのテキストをトークンに分割するために使用されるテキストコンポーネントと分析コンポーネントを指定します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
AnalyzedTokenInfo	アナライザーによって返されるトークンに関する情報。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
AsciiFoldingTokenFilter	最初の 127 文字の ASCII 文字 ("Basic Latin" Unicode ブロック) にないアルファベット文字、数値文字、およびシンボリック Unicode 文字を、ASCII に相当する文字 (存在する場合) に変換します。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
BM25SimilarityAlgorithm
CharFilter	文字フィルターの基本型。このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。既知のサブクラス: MappingCharFilter、PatternReplaceCharFilter Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CjkBigramTokenFilter	標準トークナイザーから生成される CJK 用語のビッグラムを形成します。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ClassicSimilarityAlgorithm
ClassicTokenizer	ほとんどのヨーロッパ言語ドキュメントの処理に適した文法ベースのトークナイザー。このトークナイザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CognitiveServicesAccount	スキルセットにアタッチされている Azure AI サービスリソースを記述するための基本型。このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。既知のサブクラス: CognitiveServicesAccountKey、DefaultCognitiveServicesAccount Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CognitiveServicesAccountKey	スキルセットにアタッチされたキーを使用してプロビジョニングされた Azure AI サービスリソース。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CommonGramTokenFilter	インデックス付けの間に、頻繁に発生する用語に対してバイグラムが作成されます。 1 つの用語も、バイグラムがオーバーレイされてインデックス付けされます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ConditionalSkill	ブール演算を必要とするシナリオで、出力に割り当てるデータを決定できるようにするスキル。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CorsOptions	インデックスのクロスオリジンリソース共有 (CORS) を制御するオプションを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CustomAnalyzer	テキストをインデックス可能/検索可能なトークンに変換するプロセスを制御できます。これは、1 つの定義済みのトークナイザーと 1 つ以上のフィルターで構成されるユーザー定義の構成です。トークナイザーは、テキストをトークンに分割し、トークナイザーによって出力されるトークンを変更するためのフィルターを担当します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CustomEntity	検出された一致に関する情報と、関連するメタデータを含むオブジェクト。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CustomEntityAlias	ルートエンティティ名の代替スペルまたはシノニムを指定するために使用できる複合オブジェクト。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
CustomEntityLookupSkill	スキルは、ユーザー定義の単語と語句のリストからテキストを検索します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DataChangeDetectionPolicy	データ変更検出ポリシーの基本型。このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。既知のサブクラス: HighWaterMarkChangeDetectionPolicy、SqlIntegratedChangeTrackingPolicy Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DataDeletionDetectionPolicy	データ削除検出ポリシーの基本型。このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。既知のサブクラス: SoftDeleteColumnDeletionDetectionPolicy Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DefaultCognitiveServicesAccount	スキルセットの既定の Azure AI サービスリソースを表す空のオブジェクト。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DictionaryDecompounderTokenFilter	多くのゲルマン言語に出現する複合語を分解します。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DistanceScoringFunction	地理的な場所からの距離に基づいてスコアをブーストする関数を定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DistanceScoringParameters	距離スコアリング関数にパラメーター値を提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
DocumentExtractionSkill	エンリッチメントパイプライン内のファイルからコンテンツを抽出するスキル。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
EdgeNGramTokenFilter	入力トークンの前面または背面から始まる、指定されたサイズの n-gram を生成します。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
EdgeNGramTokenizer	エッジからの入力を特定のサイズの n グラムにトークン化します。このトークナイザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ElisionTokenFilter	省略記号が削除されます。たとえば、"l'avion" (平面) は "avion" (平面) に変換されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
EntityLinkingSkill	Text Analytics API を使用して、リンクされたエンティティをテキストから抽出します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
EntityRecognitionSkill	Text Analytics API を使用して、テキストからさまざまな型のエンティティを抽出します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ExhaustiveKnnAlgorithmConfiguration	クエリ中に使用される完全な KNN アルゴリズムに固有の構成オプションが含まれています。これにより、ベクターインデックス全体でブルートフォース検索が実行されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ExhaustiveKnnParameters	完全な KNN アルゴリズムに固有のパラメーターが含まれています。
FieldMapping	データソース内のフィールドとインデックス内のターゲットフィールドの間のマッピングを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
FieldMappingFunction	インデックスを作成する前にデータソースから値を変換する関数を表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
FreshnessScoringFunction	日時フィールドの値に基づいてスコアをブーストする関数を定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
FreshnessScoringParameters	鮮度スコアリング関数にパラメーター値を提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
GetIndexStatisticsResult	特定のインデックスの統計。統計は定期的に収集され、常に最新であるとは限りません。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
HighWaterMarkChangeDetectionPolicy	高いウォーターマーク列の値に基づいて変更をキャプチャするデータ変更検出ポリシーを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
HnswAlgorithmConfiguration	インデックス作成とクエリ中に使用される HNSW 近似最近隣アルゴリズムに固有の構成オプションが含まれます。 HNSW アルゴリズムは、検索速度と精度の間で調整可能なトレードオフを提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
HnswParameters	HNSW アルゴリズムに固有のパラメーターを格納します。
ImageAnalysisSkill	画像ファイルを分析するスキル。画像コンテンツに基づいて豊富なビジュアル機能のセットを抽出します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
IndexerExecutionResult	個々のインデクサー実行の結果を表します。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
IndexingParameters	インデクサー実行のパラメーターを表します。
IndexingParametersConfiguration	インデクサー固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
IndexingSchedule	インデクサー実行のスケジュールを表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
InputFieldMappingEntry	スキルの入力フィールドマッピング。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
KeepTokenFilter	指定した単語の一覧に含まれるテキストを持つトークンのみを保持するトークンフィルター。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
KeyPhraseExtractionSkill	キーフレーズ抽出にテキスト分析を使用するスキル。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
KeywordMarkerTokenFilter	用語がキーワードとしてマークされます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
KeywordTokenizer
LanguageDetectionSkill	入力テキストの言語を検出し、要求で送信されたすべてのドキュメントに対して 1 つの言語コードを報告するスキル。言語コードは、分析の信頼度を示すスコアとペアになっています。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
LengthTokenFilter	長すぎる単語または短すぎる単語が削除されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
LexicalAnalyzer	アナライザーの基本型。このクラスを直接使用せず、サブクラスを使用する必要がある場合があります。既知のサブクラスは次のとおりです。CustomAnalyzer、PatternAnalyzer、LuceneStandardAnalyzer、StopAnalyzer Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
LexicalTokenizer	トークナイザーの基本型。このクラスを直接使用せず、サブクラスを使用する必要がある場合があります。既知のサブクラス: ClassicTokenizer、EdgeNGramTokenizer、KeywordTokenizer、KeywordTokenizerV2、MicrosoftLanguageStemmingTokenizer、MicrosoftLanguageTokenizer、NGramTokenizer、PathHierarchyTokenizerV2、PatternTokenizer、LuceneStandardTokenizerV2、LuceneStandardTokenizerV2、UaxUrlEmailTokenizer Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
LimitTokenFilter	インデックス付けの間に、トークンの数が制限されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
LuceneStandardAnalyzer	Standard Apache Lucene アナライザー。標準のトークナイザー、小文字のフィルター、および停止フィルターで構成されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
LuceneStandardTokenizer	Unicode テキストセグメント化ルールに従ってテキストを分割します。このトークナイザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
MagnitudeScoringFunction	数値フィールドの大きさに基づいてスコアをブーストする関数を定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
MagnitudeScoringParameters	マグニチュードスコアリング関数にパラメーター値を提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
MappingCharFilter	マッピングオプションで定義されたマッピングを適用する文字フィルター。一致は最長一致です (特定ポイントでの最長パターンマッチングを優先)。空の文字列での置換が許可されます。この文字フィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
MergeSkill	2 つ以上の文字列を 1 つの統合文字列にマージするスキル。オプションのユーザー定義区切り記号で各コンポーネントパーツを区切ります。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
MicrosoftLanguageStemmingTokenizer	言語固有のルールを使用してテキストが分割され、基本フォームに単語が減らされます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
MicrosoftLanguageTokenizer	言語固有のルールを使用してテキストが分割されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
NGramTokenFilter	指定サイズの n グラムが生成されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
NGramTokenizer	入力が指定サイズの n グラムにトークン化されます。このトークナイザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
OcrSkill	イメージファイルからテキストを抽出するスキル。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
OutputFieldMappingEntry	スキルの出力フィールドマッピング。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PIIDetectionSkill	Text Analytics API を使用して、入力テキストから個人情報を抽出し、それをマスクするオプションを提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PathHierarchyTokenizer
PatternAnalyzer	正規表現を使用してテキストを用語に柔軟に分離します。このアナライザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PatternCaptureTokenFilter	Java 正規表現を使用して、1 つ以上のパターンでキャプチャグループごとに 1 つずつ、複数のトークンを出力します。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PatternReplaceCharFilter	入力文字列内の文字を置き換える文字フィルター。正規表現を使用して維持する文字のシーケンスが識別され、置換パターンを使用して置換する文字が識別されます。たとえば、入力テキスト "aa bb aa bb"、pattern "(aa)s+(bb)"、置換後の "$1#$2" を指定すると、結果は "aa#bb aa#bb" になります。この文字フィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PatternReplaceTokenFilter	入力文字列内の文字を置き換える文字フィルター。正規表現を使用して維持する文字のシーケンスが識別され、置換パターンを使用して置換する文字が識別されます。たとえば、入力テキスト "aa bb aa bb"、パターン "(aa)s+(bb)"、置換後の "$1#$2" を指定すると、結果は "aa#bb aa#bb" になります。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PatternTokenizer	正規表現パターンマッチングを使用して個別のトークンを構築するトークナイザー。このトークナイザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
PhoneticTokenFilter	音声一致用のトークンが作成されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ScoringFunction	ランク付け中にドキュメントスコアを変更できる関数の基本型。このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。既知のサブクラス: DistanceScoringFunction、FreshnessScoringFunction、MagnitudeScoringFunction、TagScoringFunction Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ScoringProfile	検索クエリのスコアリングに影響を与える検索インデックスのパラメーターを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchField	フィールドの名前、データ型、および検索動作を記述する、インデックス定義内のフィールドを表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndex	インデックスのフィールドと検索動作を記述する検索インデックス定義を表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexer	インデクサーを表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerDataContainer	インデックスが作成されるエンティティ (Azure SQL テーブルや CosmosDB コレクションなど) に関する情報を表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerDataSourceConnection	インデクサーの構成に使用できるデータソース接続定義を表します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerError	アイテムレベルまたはドキュメントレベルのインデックス作成エラーを表します。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerKnowledgeStore	エンリッチされたデータの Azure BLOB、テーブル、またはファイルへの追加のプロジェクションの定義。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerKnowledgeStoreBlobProjectionSelector	具象セレクター間でプロパティを共有する抽象クラス。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerKnowledgeStoreFileProjectionSelector	Azure Filesに格納するデータのプロジェクション定義。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerKnowledgeStoreObjectProjectionSelector	Azure BLOB に格納するデータのプロジェクション定義。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerKnowledgeStoreProjection	さまざまなプロジェクションセレクターのコンテナーオブジェクト。
SearchIndexerKnowledgeStoreProjectionSelector	具象セレクター間でプロパティを共有する抽象クラス。
SearchIndexerKnowledgeStoreTableProjectionSelector	Azure テーブルに格納するデータの説明。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerLimits	SearchIndexerLimits。変数はサーバーによってのみ設定され、要求の送信時には無視されます。
SearchIndexerSkill	スキルの基本型。このクラスを直接使用するのではなく、サブクラスを使用する必要がある可能性があります。既知のサブクラスは次のとおりです。WebApiSkill、 CustomEntityLookupSkill、EntityRecognitionSkill、KeyPhraseExtractionSkill、LanguageDetectionSkill、MergeSkill、PIIDetectionSkill、SentimentSkill、SplitSkill、TextTranslationSkill、EntityLinkingSkill、EntityRecognitionSkillV3、SentimentSkillV3、ConditionalSkill、DocumentExtractionSkill、ShaperSkill、ImageAnalysisSkill、OcrSkill Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerSkillset	スキルの一覧。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerStatus	インデクサーの現在の状態と実行の履歴を表します。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchIndexerWarning	項目レベルの警告を表します。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchResourceEncryptionKey	Azure Key Vaultのカスタマーマネージド暗号化キー。作成して管理するキーを使用すると、インデックスやシノニムマップなど、Azure Cognitive Searchの保存データを暗号化または暗号化解除できます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SearchSuggester
SemanticConfiguration	セマンティック機能のコンテキストで使用する特定の構成を定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SemanticField	セマンティック構成の一部として使用されるフィールド。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SemanticPrioritizedFields	セマンティックランク付け、キャプション、強調表示、回答に使用するタイトル、コンテンツ、キーワードのフィールドについて説明します。
SemanticSearch	セマンティック機能に影響を与える検索インデックスのパラメーターを定義します。
SentimentSkill	V1: テキスト分析の肯定的-否定的な感情分析。0 から 1 の範囲の浮動小数点値としてスコア付けされます。 V3: Text Analytics API を使用して、非構造化テキストを評価し、各レコードに対して、文とドキュメントレベルでサービスによって見つかった最高の信頼度スコアに基づいてセンチメントラベル ("negative"、"neutral"、"positive" など) を提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ShaperSkill	出力を再作成するためのスキル。複合フィールド (マルチパートフィールドとも呼ばれます) をサポートする複合型を作成します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
ShingleTokenFilter	トークンの組み合わせが 1 つのトークンとして作成されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SimilarityAlgorithm
SnowballTokenFilter	Snowball で生成されたステマーを使用して単語をステミングするフィルター。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SoftDeleteColumnDeletionDetectionPolicy	論理的な削除戦略を実装するデータ削除検出ポリシーを定義します。指定された "論理的な削除" 列の値に基づいて、アイテムを削除するかどうかを決定します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SplitSkill	文字列をテキストのチャンクに分割するスキル。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SqlIntegratedChangeTrackingPolicy	Azure SQL Database の統合Change Tracking機能を使用して変更をキャプチャするデータ変更検出ポリシーを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
StemmerOverrideTokenFilter	ユーザー辞書ベースのステミングを使用して、他のステミングフィルターをオーバーライドする機能を提供します。辞書で語幹を付けた用語はキーワードとしてマークされるため、チェーンの下のステマーで語幹を付けなくなります。すべてのステミングフィルターの前に配置する必要があります。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
StemmerTokenFilter	言語固有のステミングフィルター。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
StopAnalyzer	テキストを文字以外で分割します。小文字とストップワードのトークンフィルターを適用します。このアナライザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
StopwordsTokenFilter	トークンストリームからストップワードが削除されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SuggestOptions	パラメーターグループ。
SynonymMap	シノニムマップ定義を表します。変数はサーバーによってのみ設定され、要求の送信時には無視されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
SynonymTokenFilter	トークンストリーム内の単一または複数単語のシノニムと一致します。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TagScoringFunction	特定のタグのリストに一致する文字列値を持つドキュメントのスコアを向上させる関数を定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TagScoringParameters	タグスコアリング関数にパラメーター値を提供します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TextTranslationSkill	ある言語から別の言語にテキストを翻訳するスキル。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TextWeights	検索クエリで一致がスコアリングを向上させるインデックスフィールドの重みを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TokenFilter	トークンフィルターの基本型。このクラスを直接使用せず、サブクラスを使用する必要がある場合があります。既知のサブクラスは次のとおりです。AsciiFoldingTokenFilter、CjkBigramTokenFilter、CommonGramTokenFilter、DictionaryDecompounderTokenFilter、 EdgeNGramTokenFilter、EdgeNGramTokenFilterV2、ElisionTokenFilter、KeepTokenFilter、KeywordMarkerTokenFilter、LengthTokenFilter、LimitTokenFilter、NGramTokenFilter、NGramTokenFilterV2、PatternCaptureTokenFilter、PatternReplaceTokenFilter、PhoneticTokenFilter、ShingleTokenFilter、SnowballTokenFilter、StemmerOverrideTokenFilter、、StemmerTokenFilter、StopwordsTokenFilter、SynonymTokenFilter、TruncateTokenFilter、UniqueTokenFilter、WordDelimiterTokenFilter Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
TruncateTokenFilter	用語を特定の長さに切り捨てます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
UaxUrlEmailTokenizer	URL と電子メールが 1 つのトークンとしてトークン化されます。このトークナイザーは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
UniqueTokenFilter	前のトークンと同じテキストのトークンが除外されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
VectorSearch	ベクター検索に関連する構成オプションが含まれています。
VectorSearchAlgorithmConfiguration	インデックス作成またはクエリ中に使用されるアルゴリズムに固有の構成オプションが含まれます。このクラスを直接使用せず、サブクラスを使用する必要がある場合があります。既知のサブクラスは次のとおりです。ExhaustiveKnnAlgorithmConfiguration、HnswAlgorithmConfiguration Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
VectorSearchProfile	ベクター検索で使用する構成の組み合わせを定義します。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
WebApiSkill	Web API エンドポイントを呼び出すことができるスキル。カスタムコードを呼び出すことでスキルセットを拡張できます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
WordDelimiterTokenFilter	単語がサブ単語に分割され、部分語のグループに対してオプションの変換が実行されます。このトークンフィルターは、Apache Lucene を使用して実装されます。 Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。

列挙型

BlobIndexerDataToExtract	Azure BLOB ストレージから抽出するデータを指定し、"imageAction" が "none" 以外の値に設定されている場合に、画像コンテンツから抽出するデータをインデクサーに指示します。これは、.PDF またはその他のアプリケーションの埋め込みイメージコンテンツ、または Azure BLOB の .jpg や .png などのイメージファイルに適用されます。
BlobIndexerImageAction	Azure BLOB ストレージ内の埋め込みイメージとイメージファイルを処理する方法を決定します。 "imageAction" 構成を "none" 以外の値に設定するには、スキルセットもそのインデクサーにアタッチする必要があります。
BlobIndexerParsingMode	Azure BLOB データソースからのインデックス作成の解析モードを表します。
CharFilterName	検索エンジンでサポートされているすべての文字フィルターの名前を定義します。
CustomEntityLookupSkillLanguage	CustomEntityLookupSkill で入力テキストに対してサポートされている言語コード。
EdgeNGramTokenFilterSide	n-gram を生成する入力の側を指定します。
EntityCategory	返すエンティティカテゴリを示す文字列。
EntityRecognitionSkillLanguage	EntityRecognitionSkill による入力テキストでサポートされる言語コード。
EntityRecognitionSkillVersion	使用するエンティティ認識スキルのバージョンを指定します。
ImageAnalysisSkillLanguage	ImageAnalysisSkill による入力でサポートされる言語コード。
ImageDetail	返すドメイン固有の詳細を示す文字列。
IndexerExecutionStatus	個々のインデクサー実行の状態を表します。
IndexerStatus	全体的インデクサーの状態を表します。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill によって入力テキストに対してサポートされている言語コード。
LexicalAnalyzerName	検索エンジンでサポートされているすべてのテキストアナライザーの名前を定義します。
LexicalTokenizerName	検索エンジンでサポートされているすべてのトークナイザーの名前を定義します。
MicrosoftStemmingTokenizerLanguage	Microsoft 言語ステミングトークナイザーでサポートされている言語を一覧表示します。
MicrosoftTokenizerLanguage	Microsoft 言語トークナイザーでサポートされている言語を一覧表示します。
OcrSkillLanguage	OcrSkill による入力でサポートされる言語コード。
PIIDetectionSkillMaskingMode	入力テキストで検出された個人情報をマスクするために使用する maskingMode を示す文字列。
PhoneticEncoder	PhoneticTokenFilter で使用するふりがなエンコーダーの種類を識別します。
RegexFlags	パターンアナライザーとパターントークナイザーで正規表現を使用する方法を制御するために組み合わせることができるフラグを定義します。
ScoringFunctionAggregation	スコアリングプロファイル内のすべてのスコアリング関数の結果を結合するために使用される集計関数を定義します。
ScoringFunctionInterpolation	さまざまなドキュメントでスコアブーストを補間するために使用される関数を定義します。
SearchIndexerDataSourceType	データソースの型を定義します。
SentimentSkillLanguage	SentimentSkill による入力テキストでサポートされる言語コード。
SentimentSkillVersion	使用するセンチメントスキルのバージョンを指定します。
SnowballTokenFilterLanguage	Snowball トークンフィルターに使用する言語。
SplitSkillLanguage	SplitSkill で入力テキストに対してサポートされている言語コード。
StemmerTokenFilterLanguage	ステマートークンフィルターに使用する言語。
StopwordsList	言語固有のストップワードの定義済みリストを識別します。
TextSplitMode	実行する分割モードを示す値。
TextTranslationSkillLanguage	TextTranslationSkill で入力テキストに対してサポートされている言語コード。
TokenCharacterKind	トークンフィルターが動作できる文字のクラスを表します。
TokenFilterName	検索エンジンでサポートされているすべてのトークンフィルターの名前を定義します。
VectorSearchAlgorithmKind	インデックス作成とクエリに使用されるアルゴリズム。
VectorSearchAlgorithmMetric	ベクター比較に使用する類似性メトリック。
VisualFeature	返すビジュアル機能の種類を示す文字列。

機能

ComplexField

Azure Search インデックスの複合コレクションフィールドまたは複合コレクションフィールドを構成する

ComplexField(**kw: Any) -> SearchField

Keyword-Only パラメータ

名前	説明
name	str 必須。フィールドの名前。インデックスまたは親フィールドの fields コレクション内で一意である必要があります。
collection	bool この複合フィールドがコレクションかどうか (既定値は False)
fields	list[<xref:search_service_client.models.Field>] サブフィールドの一覧

SearchableField

Azure Search インデックスの検索可能なテキストフィールドを構成する

SearchableField(**kw: Any) -> SearchField

Keyword-Only パラメータ

名前	説明
name	str 必須。フィールドの名前。インデックスまたは親フィールドの fields コレクション内で一意である必要があります。
collection	bool この検索フィールドがコレクションかどうか (既定値は False)
key	bool フィールドがインデックス内のドキュメントを一意に識別するかどうかを示す値。各インデックスの最上位フィールドをキーフィールドとして 1 つだけ選択する必要があり、SearchFieldDataType.String 型である必要があります。キーフィールドを使用すると、ドキュメントを直接検索したり、特定のドキュメントを更新または削除したりできます。既定値は False です
hidden	bool 検索結果でフィールドを返すことができるかどうかを示す値。フィルター、並べ替え、またはスコアリングのメカニズムとしてフィールド (余白など) を使用するが、エンドユーザーにフィールドを表示したくない場合は、このオプションを有効にすることができます。キーフィールドの場合、このプロパティは False である必要があります。このプロパティは、既存のフィールドで変更できます。このプロパティを有効にしても、インデックスストレージの要件は増加しません。既定値は False です。
searchable	bool フィールドがフルテキスト検索可能かどうかを示す値。これは、インデックス処理中に単語の区切りなどの分析が行われることを意味します。検索可能フィールドを "sunny day" などの値に設定した場合、その値は内部的に個別のトークン "sunny" と "day" に分割されます。これにより、これらの語句をフルテキスト検索できます。注: 検索可能なフィールドでは、フルテキスト検索用のフィールド値のトークン化された追加バージョンがAzure Cognitive Searchに格納されるため、インデックスに余分な領域が消費されます。インデックスの領域を節約し、検索にフィールドを含める必要がない場合は、searchable を false に設定します。既定値は True です。
filterable	bool $filterクエリでフィールドを参照できるかどうかを示す値。 filterable は、文字列の処理方法で検索可能とは異なります。フィルター可能なフィールドは単語区切りを行わないので、比較は完全一致のみを対象とします。たとえば、このようなフィールド f を "晴れた日" に設定した場合、$filter=f eq 'sunny' は一致しませんが、$filter=f eq 'sunny day' は見つかります。既定値は False です。
sortable	bool $orderby式でフィールドを参照できるかどうかを示す値。既定ではAzure Cognitive Search結果はスコア順に並べ替えられますが、多くのエクスペリエンスでは、ユーザーはドキュメント内のフィールドで並べ替える必要があります。既定値は False です。
facetable	bool ファセットクエリでフィールドを参照できるかどうかを示す値。通常、カテゴリ別のヒット数を含む検索結果のプレゼンテーションで使用されます (たとえば、デジタルカメラを検索し、ブランド別、メガピクセル別、価格別などのヒット数を確認します)。既定値は False です。
analyzer_name	str または <xref:azure.search.documents.indexes.models.AnalyzerName> フィールドに使用するアナライザーの名前。このオプションを searchAnalyzer または indexAnalyzer と共に設定することはできません。フィールドのアナライザーを選択した後は変更できません。指定できる値は、'ar.microsoft'、'ar.lucene'、'hy.lucene'、 'bn.microsoft'、'eu.lucene'、'bg.microsoft'、'bg.lucene'、'ca.microsoft'、'ca.lucene'、'zh- Hans.microsoft'、'zh-Hans.lucene'、'zh-Hant.microsoft'、'zh-Hant.lucene'、'hr.microsoft'、'cs.microsoft'、'cs.lucene'、 'da.microsoft'、'da.lucene'、'nl.microsoft'、'nl.lucene'、'en.microsoft'、'en.lucene'、'et.microsoft'、'fi.microsoft'、'fi.lucene'、'fr.microsoft'、'fr.lucene'、'gl.lucene'、'de.microsoft'、'de.lucene'、'el.microsoft'、'el.lucene'、'gu.microsoft'、'he.microsoft'、'hi.microsoft'、'hi.lucene'、'hu.microsoft'、'hu.lucene'、'is.microsoft'、'id.microsoft'、'id.lucene'、'ga.lucene'、'it.microsoft'、'it.lucene'、'ja.microsoft'、'ja.lucene'、'kn.microsoft'、'kn.microsoft'、 'ko.microsoft'、'ko.lucene'、'lv.microsoft'、'lv.lucene'、'lt.microsoft'、'ml.microsoft'、'ms.microsoft'、'mr.microsoft'、'nb.microsoft'、'no.lucene'、'fa.lucene'、'pl.microsoft'、'pl.lucene'、'pt-BR.lucene'、'pt-BR.lucene'、'pt-PT.microsoft'、'pt-PT.lucene'、'pa.microsoft'、'ro.microsoft'、'ro.lucene'、'ru.microsoft'、'ru.lucene'、'sr-cyrillic.microsoft'、'sr-latin.microsoft'、'sk.microsoft'、'sl.microsoft'、 'es.microsoft'、'es.lucene'、'sv.microsoft'、'sv.lucene'、'ta.microsoft'、'te.microsoft'、'th.microsoft'、'th.lucene'、'tr.microsoft'、'tr.lucene'、'uk.microsoft'、'your.microsoft'、'vi.microsoft'、'standard.lucene'、'standardasciifolding.lucene'、'キーワード (keyword)'、'pattern'、'simple'、'stop'、'whitespace'。
search_analyzer_name	str または <xref:azure.search.documents.indexes.models.AnalyzerName> フィールドの検索時に使用されるアナライザーの名前。 indexAnalyzer と共に設定する必要があり、アナライザーオプションと一緒に設定することはできません。このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりにアナライザープロパティを使用してください。このアナライザーは、既存のフィールドで更新できます。指定できる値は、'ar.microsoft'、'ar.lucene'、'hy.lucene'、 'bn.microsoft'、'eu.lucene'、'bg.microsoft'、'bg.lucene'、'ca.microsoft'、'ca.lucene'、'zh-Hans.microsoft'、'zh-Hans.lucene'、'zh- Hant.microsoft'、'zh-Hant.lucene'、'hr.microsoft'、'cs.microsoft'、'cs.lucene'、、 'da.microsoft'、'da.lucene'、'nl.microsoft'、'nl.lucene'、'en.microsoft'、'en.lucene'、'et.microsoft'、'fi.microsoft'、'fi.lucene'、'fr.microsoft'、'fr.lucene'、'gl.lucene'、'de.microsoft'、'de.lucene'、'el.microsoft'、'el.lucene'、'gu.microsoft'、'he.microsoft'、'hi.microsoft'、'hi.lucene'、'hu.microsoft'、'is.microsoft'、'id.microsoft'、'id.lucene'、'ga.lucene'、'it.microsoft'、'it.lucene'、'ja.microsoft'、'ja.lucene'、'ja.lucene'、、 'kn.microsoft'、'ko.microsoft'、'ko.lucene'、'lv.microsoft'、'lv.lucene'、'lt.microsoft'、'ml.microsoft'、'ms.microsoft'、'mr.microsoft'、'nb.microsoft'、'no.lucene'、'fa.lucene'、'pl.microsoft'、'pl.lucene'、'pt-BR.microsoft'、'pt-BR.lucene'、'pt-PT.microsoft'、'pt-PT.lucene'、'pa.microsoft'、'ro.microsoft'、'ro.lucene'、'ru.microsoft'、'ru.lucene'、'sr- cyrillic.microsoft'、'sr-latin.microsoft'、'sk.microsoft'、'sl.microsoft'、 'es.microsoft'、'es.lucene'、'sv.microsoft'、'sv.lucene'、'ta.microsoft'、'te.microsoft'、'th.lucene'、'tr.microsoft'、'tr.lucene'、'uk.microsoft'、'your.microsoft'、'vi.microsoft'、'standard.lucene'、'standardasciifolding.lucene'、'キーワード (keyword)'、'pattern'、'simple'、'stop'、'whitespace'。
index_analyzer_name	str または <xref:azure.search.documents.indexes.models.AnalyzerName> フィールドのインデックス作成時に使用されるアナライザーの名前。 searchAnalyzer と共に設定する必要があり、アナライザーオプションと一緒に設定することはできません。このプロパティを言語アナライザーの名前に設定することはできません。言語アナライザーが必要な場合は、代わりにアナライザープロパティを使用してください。フィールドのアナライザーを選択した後は変更できません。指定できる値は、'ar.microsoft'、'ar.lucene'、'hy.lucene'、 'bn.microsoft'、'eu.lucene'、'bg.microsoft'、'bg.lucene'、'ca.microsoft'、'ca.lucene'、'zh-Hans.microsoft'、'zh- Hans.lucene'、'zh-Hant.microsoft'、'zh-Hant.lucene'、'hr.microsoft'、'cs.microsoft'、'cs.lucene'、、 'da.microsoft'、'da.lucene'、'nl.microsoft'、'nl.lucene'、'en.microsoft'、'en.lucene'、'et.microsoft'、'fi.microsoft'、'fi.lucene'、'fr.microsoft'、'fr.lucene'、'gl.lucene'、'de.microsoft'、'de.lucene'、'el.microsoft'、'el.lucene'、'gu.microsoft'、'he.microsoft'、'hi.microsoft'、'hi.lucene'、'hu.microsoft'、'is.microsoft'、'id.microsoft'、'id.lucene'、'ga.lucene'、'it.microsoft'、'it.lucene'、'ja.microsoft'、'ja.lucene'、'ja.lucene'、、 'kn.microsoft'、'ko.microsoft'、'ko.lucene'、'lv.microsoft'、'lv.lucene'、'lt.microsoft'、'ml.microsoft'、'ms.microsoft'、'mr.microsoft'、'nb.microsoft'、'no.lucene'、'fa.lucene'、'pl.microsoft'、'pl.lucene'、'pt-BR.microsoft'、'pt-BR.lucene'、'pt-PT.microsoft'、'pt-PT.lucene'、'pa.microsoft'、'ro.microsoft'、'ro.lucene'、'ru.microsoft'、'ru.lucene'、'sr- cyrillic.microsoft'、'sr-latin.microsoft'、'sk.microsoft'、'sl.microsoft'、 'es.microsoft'、'es.lucene'、'sv.microsoft'、'sv.lucene'、'ta.microsoft'、'te.microsoft'、'th.lucene'、'tr.microsoft'、'tr.lucene'、'uk.microsoft'、'your.microsoft'、'vi.microsoft'、'standard.lucene'、'standardasciifolding.lucene'、'キーワード (keyword)'、'pattern'、'simple'、'stop'、'whitespace'。
synonym_map_names	list[str] このフィールドに関連付けるシノニムマップの名前のリスト。現在、サポートされているシノニムマップはフィールドごとに 1 つだけです。フィールドにシノニムマップを割り当てると、シノニムマップのルールを使用して、そのフィールドを対象とするクエリ用語がクエリ時に展開されるようになります。この属性は、既存のフィールドで変更できます。

SimpleField

Azure Search インデックスの単純なフィールドを構成する

SimpleField(**kw: Any) -> SearchField

Keyword-Only パラメータ

名前	説明
name	str 必須。フィールドの名前。インデックスまたは親フィールドの fields コレクション内で一意である必要があります。
type	必須。フィールドのデータ型。指定できる値は、 Azure.search.documents.SearchFieldDataType から SearchFieldDataType.String、SearchFieldDataType.Int32、SearchFieldDataType.Int64、SearchFieldDataType.Double、SearchFieldDataType.Boolean、SearchFieldDataType.DateTimeOffset、SearchFieldDataType.GeographyPoint、SearchFieldDataType.ComplexType です。 :p aramtype 型: str
key	bool フィールドがインデックス内のドキュメントを一意に識別するかどうかを示す値。キーフィールドとして各インデックスの最上位フィールドを 1 つだけ選択し、SearchFieldDataType.String 型にする必要があります。キーフィールドを使用すると、ドキュメントを直接検索したり、特定のドキュメントを更新または削除したりできます。既定値は False です
hidden	bool フィールドを検索結果で返すことができるかどうかを示す値。フィルター、並べ替え、スコアリングのメカニズムとしてフィールド (余白など) を使用するが、エンドユーザーにフィールドを表示したくない場合は、このオプションを有効にすることができます。キーフィールドの場合、このプロパティは False である必要があります。このプロパティは、既存のフィールドで変更できます。このプロパティを有効にしても、インデックスストレージの要件が増加することはありません。既定値は False です。
filterable	bool $filterクエリでフィールドを参照できるかどうかを示す値。 filterable は、文字列の処理方法で検索可能とは異なります。フィルター可能な SearchFieldDataType.String 型または Collection(SearchFieldDataType.String) 型のフィールドは単語区切りを行わないので、比較は完全一致のみを対象とします。たとえば、このようなフィールド f を "晴れた日" に設定した場合、$filter=f eq 'sunny' は一致しませんが、$filter=f eq 'sunny day' は発生します。複合フィールドの場合、このプロパティは null である必要があります。既定値は False です
sortable	bool $orderby式でフィールドを参照できるかどうかを示す値。既定では、Azure Cognitive Searchスコアで結果が並べ替えられますが、多くのエクスペリエンスでは、ユーザーはドキュメント内のフィールドで並べ替える必要があります。単純なフィールドは、単一値の場合にのみ並べ替えることができます (親ドキュメントのスコープに 1 つの値があります)。単純なコレクションフィールドは複数値であるため、並べ替えできません。複雑なコレクションの単純なサブフィールドも複数値であるため、並べ替えできません。これは、親フィールドが直接であるか、先祖フィールドであるかに関係なく、複雑なコレクションである場合に当てはまります。既定値は False です。
facetable	bool ファセットクエリでフィールドを参照できるかどうかを示す値。通常、カテゴリ別のヒット数を含む検索結果のプレゼンテーションで使用されます (たとえば、デジタルカメラを検索し、ブランド別、メガピクセル別、価格別などのヒット数を確認します)。 SearchFieldDataType.GeographyPoint 型または Collection(SearchFieldDataType.GeographyPoint) 型のフィールドをファセット可能にすることはできません。既定値は False です。

次の方法で共有

models パッケージ

クラス

列挙型

機能

ComplexField

Keyword-Only パラメータ

SearchableField

Keyword-Only パラメータ

SimpleField

Keyword-Only パラメータ

その他のリソース