Indexes - Analyze
アナライザーがテキストをトークンに分割する方法を示します。
POST {endpoint}/indexes('{indexName}')/search.analyze?api-version=2024-07-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
検索サービスのエンドポイント URL。 |
|
index
|
path | True |
string |
アナライザーをテストするインデックスの名前。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
デバッグに役立つ要求と共に送信される追跡 ID。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| text | True |
string |
トークンに分割するテキスト。 |
| analyzer |
指定されたテキストを中断するために使用するアナライザーの名前。 このパラメーターを指定しない場合は、代わりにトークナイザーを指定する必要があります。 トークナイザーパラメーターとアナライザー パラメーターは相互に排他的です。 |
||
| charFilters |
指定したテキストを分割するときに使用する文字フィルターの省略可能なリスト。 このパラメーターは、トークナイザー パラメーターを使用する場合にのみ設定できます。 |
||
| tokenFilters |
指定されたテキストを中断するときに使用するトークン フィルターの省略可能なリスト。 このパラメーターは、トークナイザー パラメーターを使用する場合にのみ設定できます。 |
||
| tokenizer |
指定されたテキストを区切るために使用するトークナイザーの名前。 このパラメーターを指定しない場合は、代わりにアナライザーを指定する必要があります。 トークナイザーパラメーターとアナライザー パラメーターは相互に排他的です。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK | ||
| Other Status Codes |
エラー応答。 |
例
SearchServiceIndexAnalyze
要求のサンプル
POST https://myservice.search.windows.net/indexes('hotels')/search.analyze?api-version=2024-07-01
{
"text": "Text to analyze",
"analyzer": "standard.lucene"
}
応答のサンプル
{
"tokens": [
{
"token": "text",
"startOffset": 0,
"endOffset": 4,
"position": 0
},
{
"token": "to",
"startOffset": 5,
"endOffset": 7,
"position": 1
},
{
"token": "analyze",
"startOffset": 8,
"endOffset": 15,
"position": 2
}
]
}定義
| 名前 | 説明 |
|---|---|
|
Analyzed |
アナライザーによって返されるトークンに関する情報。 |
|
Analyze |
そのテキストをトークンに分割するために使用されるテキストおよび分析コンポーネントをいくつか指定します。 |
|
Analyze |
テキストでアナライザーをテストした結果。 |
|
Char |
検索エンジンでサポートされているすべての文字フィルターの名前を定義します。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Lexical |
検索エンジンでサポートされているすべてのテキスト アナライザーの名前を定義します。 |
|
Lexical |
検索エンジンでサポートされているすべてのトークナイザーの名前を定義します。 |
|
Token |
検索エンジンでサポートされているすべてのトークン フィルターの名前を定義します。 |
AnalyzedTokenInfo
アナライザーによって返されるトークンに関する情報。
| 名前 | 型 | 説明 |
|---|---|---|
| endOffset |
integer (int32) |
入力テキスト内のトークンの最後の文字のインデックス。 |
| position |
integer (int32) |
他のトークンに対する入力テキスト内のトークンの位置。 入力テキストの最初のトークンの位置は 0、次のトークンの位置は 1 です。 使用されるアナライザーによっては、一部のトークンが同じ位置にある場合があります (たとえば、トークンが互いのシノニムである場合)。 |
| startOffset |
integer (int32) |
入力テキスト内のトークンの最初の文字のインデックス。 |
| token |
string |
アナライザーによって返されるトークン。 |
AnalyzeRequest
そのテキストをトークンに分割するために使用されるテキストおよび分析コンポーネントをいくつか指定します。
| 名前 | 型 | 説明 |
|---|---|---|
| analyzer |
指定されたテキストを中断するために使用するアナライザーの名前。 このパラメーターを指定しない場合は、代わりにトークナイザーを指定する必要があります。 トークナイザーパラメーターとアナライザー パラメーターは相互に排他的です。 |
|
| charFilters |
指定したテキストを分割するときに使用する文字フィルターの省略可能なリスト。 このパラメーターは、トークナイザー パラメーターを使用する場合にのみ設定できます。 |
|
| text |
string |
トークンに分割するテキスト。 |
| tokenFilters |
指定されたテキストを中断するときに使用するトークン フィルターの省略可能なリスト。 このパラメーターは、トークナイザー パラメーターを使用する場合にのみ設定できます。 |
|
| tokenizer |
指定されたテキストを区切るために使用するトークナイザーの名前。 このパラメーターを指定しない場合は、代わりにアナライザーを指定する必要があります。 トークナイザーパラメーターとアナライザー パラメーターは相互に排他的です。 |
AnalyzeResult
テキストでアナライザーをテストした結果。
| 名前 | 型 | 説明 |
|---|---|---|
| tokens |
要求で指定されたアナライザーによって返されるトークンの一覧。 |
CharFilterName
検索エンジンでサポートされているすべての文字フィルターの名前を定義します。
| 値 | 説明 |
|---|---|
| html_strip |
HTML コンストラクトを取り除こうとする文字フィルター。 https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html を参照してください |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
LexicalAnalyzerName
検索エンジンでサポートされているすべてのテキスト アナライザーの名前を定義します。
| 値 | 説明 |
|---|---|
| ar.lucene |
アラビア語用 Lucene アナライザー。 |
| ar.microsoft |
アラビア語用 Microsoft アナライザー。 |
| bg.lucene |
ブルガリア語用ルセンアナライザー。 |
| bg.microsoft |
ブルガリア語用 Microsoft アナライザー。 |
| bn.microsoft |
Bangla 用 Microsoft アナライザー。 |
| ca.lucene |
カタロニア語用 Lucene アナライザー。 |
| ca.microsoft |
カタロニア語用 Microsoft アナライザー。 |
| cs.lucene |
チェコ語用 Lucene アナライザー。 |
| cs.microsoft |
チェコ語用 Microsoft アナライザー。 |
| da.lucene |
デンマーク語用 Lucene アナライザー。 |
| da.microsoft |
デンマーク語用 Microsoft アナライザー。 |
| de.lucene |
ドイツ語用 Lucene アナライザー。 |
| de.microsoft |
ドイツ語用 Microsoft アナライザー。 |
| el.lucene |
ギリシャ語用 Lucene アナライザー。 |
| el.microsoft |
ギリシャ語用 Microsoft アナライザー。 |
| en.lucene |
英語用 Lucene アナライザー。 |
| en.microsoft |
英語用 Microsoft アナライザー。 |
| es.lucene |
スペイン語用 Lucene アナライザー。 |
| es.microsoft |
スペイン語用 Microsoft アナライザー。 |
| et.microsoft |
エストニア語用 Microsoft アナライザー。 |
| eu.lucene |
バスク用 Lucene アナライザー。 |
| fa.lucene |
ペルシア語用 Lucene アナライザー。 |
| fi.lucene |
フィンランド語用 Lucene アナライザー。 |
| fi.microsoft |
フィンランド語用 Microsoft アナライザー。 |
| fr.lucene |
フランス語用 Lucene アナライザー。 |
| fr.microsoft |
フランス語用 Microsoft アナライザー。 |
| ga.lucene |
アイルランド語用 Lucene アナライザー。 |
| gl.lucene |
ガリシア語用 Lucene アナライザー。 |
| gu.microsoft |
Gujarati 用 Microsoft アナライザー。 |
| he.microsoft |
ヘブライ語用 Microsoft アナライザー。 |
| hi.lucene |
ヒンディー語用 Lucene アナライザー。 |
| hi.microsoft |
ヒンディー語用 Microsoft アナライザー。 |
| hr.microsoft |
クロアチア語用 Microsoft アナライザー。 |
| hu.lucene |
ハンガリー語用 Lucene アナライザー。 |
| hu.microsoft |
ハンガリー語用 Microsoft アナライザー。 |
| hy.lucene |
アルメニア語用 Lucene アナライザー。 |
| id.lucene |
インドネシア語用 Lucene アナライザー。 |
| id.microsoft |
インドネシア語 (Bahasa) 用 Microsoft アナライザー。 |
| is.microsoft |
アイスランドの Microsoft アナライザー。 |
| it.lucene |
イタリア語用 Lucene アナライザー。 |
| it.microsoft |
イタリア語用 Microsoft アナライザー。 |
| ja.lucene |
日本語用 Lucene アナライザー。 |
| ja.microsoft |
日本語用 Microsoft アナライザー。 |
| keyword |
フィールドの内容全体を 1 つのトークンとして扱います。 これは、郵便番号、ID、一部の製品名などのデータに役立ちます。 http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html を参照してください |
| kn.microsoft |
カンナダ用 Microsoft アナライザー。 |
| ko.lucene |
韓国語用 Lucene アナライザー。 |
| ko.microsoft |
韓国語用 Microsoft アナライザー。 |
| lt.microsoft |
リトアニア語用 Microsoft アナライザー。 |
| lv.lucene |
ラトビア語用 Lucene アナライザー。 |
| lv.microsoft |
ラトビア語用 Microsoft アナライザー。 |
| ml.microsoft |
マラヤーラム用 Microsoft アナライザー。 |
| mr.microsoft |
Marathi 用 Microsoft アナライザー。 |
| ms.microsoft |
マレー語 (ラテン) 用 Microsoft アナライザー。 |
| nb.microsoft |
ノルウェー語 (Bokmål) 用 Microsoft アナライザー。 |
| nl.lucene |
オランダ語用 Lucene アナライザー。 |
| nl.microsoft |
オランダ語用 Microsoft アナライザー。 |
| no.lucene |
ノルウェー語用 Lucene アナライザー。 |
| pa.microsoft |
Punjabi 用 Microsoft アナライザー。 |
| pattern |
正規表現パターンを使用して、テキストを用語に柔軟に分割します。 http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html を参照してください |
| pl.lucene |
ポーランド語用 Lucene アナライザー。 |
| pl.microsoft |
ポーランド語用 Microsoft アナライザー。 |
| pt-BR.lucene |
ポルトガル語 (ブラジル) 用 Lucene アナライザー。 |
| pt-BR.microsoft |
ポルトガル語 (ブラジル) 用 Microsoft アナライザー。 |
| pt-PT.lucene |
ポルトガル語 (ポルトガル) 用 Lucene アナライザー。 |
| pt-PT.microsoft |
ポルトガル語 (ポルトガル) 用 Microsoft アナライザー。 |
| ro.lucene |
ルーマニア語用 Lucene アナライザー。 |
| ro.microsoft |
ルーマニア語用 Microsoft アナライザー。 |
| ru.lucene |
ロシア語用 Lucene アナライザー。 |
| ru.microsoft |
ロシア語用 Microsoft アナライザー。 |
| simple |
テキストを文字以外で分割し、小文字に変換します。 http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html を参照してください |
| sk.microsoft |
スロバキア語用 Microsoft アナライザー。 |
| sl.microsoft |
スロベニア語用 Microsoft アナライザー。 |
| sr-cyrillic.microsoft |
セルビア語 (キリル) 用 Microsoft アナライザー。 |
| sr-latin.microsoft |
セルビア語 (ラテン) 用 Microsoft アナライザー。 |
| standard.lucene |
標準 Lucene アナライザー。 |
| standardasciifolding.lucene |
標準 ASCII フォールディング Lucene アナライザー。 https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers を参照してください |
| stop |
テキストを文字以外で除算します。小文字とストップワードのトークン フィルターを適用します。 http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html を参照してください |
| sv.lucene |
スウェーデン語用 Lucene アナライザー。 |
| sv.microsoft |
スウェーデン語用 Microsoft アナライザー。 |
| ta.microsoft |
Tamil 用 Microsoft アナライザー。 |
| te.microsoft |
Telugu 用 Microsoft アナライザー。 |
| th.lucene |
タイ語用 Lucene アナライザー。 |
| th.microsoft |
タイ語用 Microsoft アナライザー。 |
| tr.lucene |
トルコ語用 Lucene アナライザー。 |
| tr.microsoft |
トルコ語用 Microsoft アナライザー。 |
| uk.microsoft |
ウクライナ語用 Microsoft アナライザー。 |
| ur.microsoft |
Urdu 用 Microsoft アナライザー。 |
| vi.microsoft |
ベトナム語用 Microsoft アナライザー。 |
| whitespace |
空白トークナイザーを使用するアナライザー。 http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html を参照してください |
| zh-Hans.lucene |
中国語 (簡体字) 用 Lucene アナライザー。 |
| zh-Hans.microsoft |
Microsoft Analyzer for Chinese (簡体字)。 |
| zh-Hant.lucene |
中国語 (繁体字) 用 Lucene アナライザー。 |
| zh-Hant.microsoft |
Microsoft analyzer for Chinese (繁体字)。 |
LexicalTokenizerName
検索エンジンでサポートされているすべてのトークナイザーの名前を定義します。
TokenFilterName
検索エンジンでサポートされているすべてのトークン フィルターの名前を定義します。