Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
response = client.tags.pattern.suggest_patterns(
    description="description",
)
print(response.regex)

{
  "regex": "<string>",
  "explanation": "<string>"
}

Tags

Suggest Patterns

Generate a regex pattern based on a natural language description using AI.

Request Body

Field	Type	Description
`description`	`str`	Natural language description of what to match (e.g., “phone numbers in format (XXX) XXX-XXXX”).
`examples`	`List[str]`	Optional. List of example strings that should match the pattern.

Response

200: Regex pattern generated successfully
- Returns: { "regex": str, "explanation": str }
400: Bad Request (e.g., invalid request data)
500: Internal Server Error

Example

{
  "description": "phone numbers in format (XXX) XXX-XXXX",
  "examples": [
    "(123) 456-7890",
    "(555) 123-4567"
  ]
}

Example Response

{
  "regex": "\(\d{3}\) \d{3}-\d{4}",
  "explanation": "Matches phone numbers in the format (XXX) XXX-XXXX where X is a digit"
}

POST

/

suggest_regex

Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
response = client.tags.pattern.suggest_patterns(
    description="description",
)
print(response.regex)

{
  "regex": "<string>",
  "explanation": "<string>"
}

Body

application/json

description

string

required

examples

string[] | null

Response

Successful Response

regex

string

required

explanation

string | null

⌘I