AI Assistance

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 }
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}",
}

POST

suggest_regex

Python

import os
from unstructured import UnstructuredClient

client = UnstructuredClient(
    username=os.environ.get("UNSTRUCTURED_USERNAME"),  # This is the default and can be omitted
    password=os.environ.get("UNSTRUCTURED_PASSWORD"),  # This is the default and can be omitted
)
response = client.tags.pattern.suggest_patterns(
    pattern_description="pattern_description",
    tag_data={
        "name": "name"
    },
)
print(response.confidence_score)

import UnstructuredClient from 'unstructured-sdk';

const client = new UnstructuredClient({
  authMethod: 'My Auth Method',
  username: process.env['UNSTRUCTURED_USERNAME'], // This is the default and can be omitted
  password: process.env['UNSTRUCTURED_PASSWORD'], // This is the default and can be omitted
});

const response = await client.tags.pattern.suggestPatterns({
  pattern_description: 'pattern_description',
  tag_data: { name: 'name' },
});

console.log(response.confidence_score);

{
  "regex": "<string>",
  "explanation": "<string>",
  "validation_results": {},
  "confidence_score": 123,
  "suggested_improvements": [
    "<string>"
  ],
  "context_items": [
    "<string>"
  ],
  "inferred_intent": "<string>",
  "required_context_matches": 123
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

tag_data

Tag · object

required

Show child attributes

pattern_description

string

required

examples

string[] | null

negative_examples

string[] | null

edge_case_context

string | null

positive_test_cases

TestCase · object[] | null

Show child attributes

negative_test_cases

TestCase · object[] | null

Show child attributes

validate_before_return

boolean

default:true

document_context

string | null

current_wrong_result

string | null

previous_attempts

Previous Attempts · object[] | null

context_type

string | null

context_payload

Context Payload · object | null

evidence_examples

EvidenceExample · object[] | null

Show child attributes

Response

Successful Response

regex

string

required

explanation

string | null

validation_results

Validation Results · object | null

confidence_score

number | null

suggested_improvements

string[] | null

context_items

string[] | null

inferred_intent

string | null

required_context_matches

integer | null

⌘I

Python

import os
from unstructured import UnstructuredClient

client = UnstructuredClient(
    username=os.environ.get("UNSTRUCTURED_USERNAME"),  # This is the default and can be omitted
    password=os.environ.get("UNSTRUCTURED_PASSWORD"),  # This is the default and can be omitted
)
response = client.tags.pattern.suggest_patterns(
    pattern_description="pattern_description",
    tag_data={
        "name": "name"
    },
)
print(response.confidence_score)

import UnstructuredClient from 'unstructured-sdk';

const client = new UnstructuredClient({
  authMethod: 'My Auth Method',
  username: process.env['UNSTRUCTURED_USERNAME'], // This is the default and can be omitted
  password: process.env['UNSTRUCTURED_PASSWORD'], // This is the default and can be omitted
});

const response = await client.tags.pattern.suggestPatterns({
  pattern_description: 'pattern_description',
  tag_data: { name: 'name' },
});

console.log(response.confidence_score);

{
  "regex": "<string>",
  "explanation": "<string>",
  "validation_results": {},
  "confidence_score": 123,
  "suggested_improvements": [
    "<string>"
  ],
  "context_items": [
    "<string>"
  ],
  "inferred_intent": "<string>",
  "required_context_matches": 123
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Overview

Data Connectors

Tags

Taxonomies

Metadata

Data Slices

Destinations

Projects

Workflows

Task Tracking

Suggest Patterns

Request Body

Response

Example

Example Response

Authorizations

Body

Response