Grokパターンのテスト（Test Grok pattern）

テストGrokパターンAPI

テキストの行に対してGrokパターンをテストします。詳細はGrokking grokを参照してください。

リクエスト

GET _text_structure/test_grok_pattern

POST _text_structure/test_grok_pattern

説明

テストGrokパターンAPIは、1つ以上のテキスト行に対してGrokパターンを実行することを可能にします。行がパターンに一致するかどうか、そして一致した部分文字列のオフセットと長さを返します。

クエリパラメータ

• ecs_compatibility
• （オプション、文字列）ECS準拠のGrokパターンとの互換性モード。構造ファインダーがGrokパターンを作成する際に、レガシーの代わりにECS Grokパターンを使用するかどうかを指定するためにこのパラメータを使用します。有効な値はdisabledとv1です。デフォルト値はdisabledです。

リクエストボディ

• grok_pattern
• （必須、文字列）テキストの行に対して実行するGrokパターン。
• text
• （必須、文字列の配列）Grokパターンを実行するテキストの行。

例

Python

resp = client.text_structure.test_grok_pattern(
   grok_pattern="Hello %{WORD:first_name} %{WORD:last_name}",
   text=[
   "Hello John Doe",
   "this does not match"
   ],
)
print(resp)

Ruby

response = client.text_structure.test_grok_pattern(
  body: {
   grok_pattern: 'Hello %{WORD:first_name} %{WORD:last_name}',
   text: [
   'Hello John Doe',
   'this does not match'
   ]
  }
)
puts response

Js

const response = await client.textStructure.testGrokPattern({
  grok_pattern: "Hello %{WORD:first_name} %{WORD:last_name}",
  text: ["Hello John Doe", "this does not match"],
});
console.log(response);

コンソール

GET _text_structure/test_grok_pattern
{
  "grok_pattern": "Hello %{WORD:first_name} %{WORD:last_name}",
  "text": [
   "Hello John Doe",
   "this does not match"
  ]
}

APIは以下のレスポンスを返します：

コンソール-結果

{
  "matches": [
   {
   "matched": true,
   "fields": {
   "first_name": [
   {
   "match": "John",
   "offset": 6,
   "length": 4
   }
   ],
   "last_name": [
   {
   "match": "Doe",
   "offset": 11,
   "length": 3
   }
   ]
   }
   },
   {
   "matched": false
   }
  ]
}