# PatternMatcher

**Type**: `object`

## Properties

- name: attributeTokenization (optional)
  type: enum: `KEYS_ONLY`, `KEYS_AND_VALUES`
  description: Use attribute shape only, or shape and whole-value similarity tokens.

- name: delimiters (required)
  type: array of string
  description: Characters to use for splitting tokens.

- name: emitNewPatternSignals (optional)
  type: boolean
  description: Whether this operation may emit LogPatternSignal events to the agent-service when new patterns are detected or replayed. Must be enabled before an agent can subscribe to this pipeline.

- name: enabledMasks (required)
  type: array of string
  description: Masks that are enabled for tokenizing messages.

- name: excludedAttributePrefixes (optional)
  type: array of array of string
  description: Excluded attribute prefixes as arrays of literal key segments. Does not affect partition-by values or output attributes.

- name: includedAttributePrefixes (optional)
  type: array of array of string
  description: Included attribute prefixes as arrays of literal key segments. Empty selects all. Array elements are traversed without indices.

- name: masks (required)
  type: array of array of string
  description: Set of masks that can be applied to messages before tokenizing them. These masks are specified as pairs of (name, regex).

- name: name (required)
  type: string

- name: partitionByAttributePaths (optional)
  type: array of array of string
  description: Attribute paths as arrays of keys. Use for unambiguous nested vs flat attributes. Example: [["user", "id"]] for nested user.id, [["user.id"]] for flat attribute named 'user.id'

- name: partitionByAttributes (optional)
  type: array of string

- name: partitionByTags (optional)
  type: array of string

- name: similarityThreshold (optional)
  type: number
  description: Controls how close a set of tokens are to a pattern before it is considered a match. Calculated as the percent of matching tokens between a pattern and a message.

- name: tokenizationInput (optional)
  type: enum: `MESSAGE_ONLY`, `ATTRIBUTES_ONLY`, `MESSAGE_AND_ATTRIBUTES`, `AUTO`
  description: Selects message text, attributes, both, or message text with an attributes fallback.

- name: type (required)
  type: enum: `pattern-matcher`
  description: Matches log patterns using an iterative feedback loop. Events with known patterns skip the global reducer for improved efficiency.