Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

Type: prompter Subtype: see Settings

​
Settings

​
subtype
string
required
Enrichment algorithm and provider. Set at the WorkflowNode level, outside of settings. Allowed values:
  • anthropic_ner
  • openai_ner
The preceding list applies only to Unstructured Let’s Go and Pay-As-You-Go accounts.For Unstructured Business accounts, to get your current list of available values, contact your Unstructured account administrator or Unstructured sales representative, or email Unstructured Support at support@unstructured.io.
​
provider_type
string
required
Provider that matches the prefix of subtype. Allowed values: anthropic, openai.
​
model
string
required
Model to use for NER. For a full list of the models available in Unstructured, see Available models.
​
prompt_interface_overrides.prompt.user
string
Alternative prompt to pass to the NER model. Default: none (uses Unstructured’s internal default prompt).If specified, you must provide the complete prompt in the following format. For best results, limit changes to the entity types, relationship types, or clarifying instructions only — changing other parts of the prompt may produce unexpected results.
Extract named entities and their relationships from the following text.

Provide the entities, their corresponding types and relationships as a structured JSON response.

Entity types:
- PERSON
- ORGANIZATION
- LOCATION
- DATE
- TIME
- EVENT
- MONEY
- PERCENT
- FACILITY
- PRODUCT
- ROLE
- DOCUMENT
- DATASET

Relationship types:
- PERSON - ORGANIZATION: works_for, affiliated_with, founded
- PERSON - LOCATION: born_in, lives_in, traveled_to
- ORGANIZATION - LOCATION: based_in, has_office_in
- Entity - DATE: occurred_on, founded_on, died_on, published_in
- PERSON - PERSON: married_to, parent_of, colleague_of
- PRODUCT - ORGANIZATION: developed_by, owned_by
- EVENT - LOCATION: held_in, occurred_in
- Entity - ROLE: has_title, acts_as, has_role
- DATASET - PERSON: mentions
- DATASET - DOCUMENT: located_in
- PERSON - DATASET: published
- DOCUMENT - DOCUMENT: referenced_in, contains
- DOCUMENT - DATE: dated
- PERSON - DOCUMENT: published

[START OF TEXT]
{{text}}
[END OF TEXT]


Response format json schema: {
    "items": [
        { "entity": "Entity name", "type": "Entity type" },
        { "entity": "Entity name", "type": "Entity type" }
    ],
    "relationships": [
        {"from": "Entity name", "relationship": "Relationship type", "to": "Entity name"},
        {"from": "Entity name", "relationship": "Relationship type", "to": "Entity name"}
    ]
}

ner_enrichment_workflow_node = WorkflowNode(
    name="Enrichment",
    subtype="<subtype>",
    type="prompter",
    settings={
        "provider_type": "<provider-type>",
        "model": "<model>",
        "prompt_interface_overrides": {
            "prompt": {
                "user": "<user-prompt-override>"
            }
        }
    }
)