# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elasticsearch Request & Response Specification Text Structure API
  version: 1.0.0
extends: openapi/elk-stack-text-structure-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/_text_structure/find_field_structure'].get
  update:
    x-apievangelist-phrasing:
      intent: Detect the structure of an indexed text field
      effect: read
      questions:
      - Can Elasticsearch work out the format of log lines already in an index?
      - What Grok pattern fits a text field I've ingested?
      instructions:
      - text: Find the structure of field {field} in index {index}.
        slots:
          field: query.field
          index: query.index
      - text: Analyze {field} in {index} sampling {documents} documents.
        slots:
          field: query.field
          index: query.index
          documents: query.documents_to_sample
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_text_structure/find_message_structure'].get
  update:
    x-apievangelist-phrasing:
      intent: Detect the structure of text messages via GET
      effect: read
      questions:
      - Can I infer the format of a list of log messages before ingesting them?
      - Is there a GET form of message structure detection?
      instructions:
      - text: Find the structure of messages {messages} using GET.
        slots:
          messages: requestBody.messages
      - text: Detect the timestamp format in messages {messages} with a GET request.
        slots:
          messages: requestBody.messages
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_text_structure/find_message_structure'].post
  update:
    x-apievangelist-phrasing:
      intent: Detect the structure of text messages via POST
      effect: read
      questions:
      - What ingest pipeline would suit a batch of sample messages?
      - Can I POST sample messages and get a suggested mapping back?
      instructions:
      - text: POST messages {messages} to find their structure.
        slots:
          messages: requestBody.messages
      - text: Suggest mappings for messages {messages} in format {format} via POST.
        slots:
          messages: requestBody.messages
          format: query.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_text_structure/find_structure'].post
  update:
    x-apievangelist-phrasing:
      intent: Detect the structure of a text file
      effect: read
      questions:
      - Can Elasticsearch figure out the format of a CSV or log file for me?
      - Does structure detection handle files with a header row?
      instructions:
      - text: Find the structure of this text file.
      - text: Analyze the file as {format} sampling {lines} lines.
        slots:
          format: query.format
          lines: query.lines_to_sample
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_text_structure/test_grok_pattern'].get
  update:
    x-apievangelist-phrasing:
      intent: Test a Grok pattern via GET
      effect: read
      questions:
      - Does my Grok pattern match these log lines?
      - Is there a GET version of the Grok pattern tester?
      instructions:
      - text: Test Grok pattern {grok_pattern} against {text} with GET.
        slots:
          grok_pattern: requestBody.grok_pattern
          text: requestBody.text
      - text: Use the GET tester to check {grok_pattern} on lines {text}.
        slots:
          grok_pattern: requestBody.grok_pattern
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_text_structure/test_grok_pattern'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a Grok pattern via POST
      effect: read
      questions:
      - Can I POST a Grok pattern and see match offsets for each line?
      - Which substrings did my Grok pattern capture?
      instructions:
      - text: POST Grok pattern {grok_pattern} to test against {text}.
        slots:
          grok_pattern: requestBody.grok_pattern
          text: requestBody.text
      - text: Show match offsets for {grok_pattern} on {text} via POST.
        slots:
          grok_pattern: requestBody.grok_pattern
          text: requestBody.text
      method: generated
      generated: '2026-09-26'