Named Entity Recognition Task¶

openaivec.task.nlp.named_entity_recognition ¶

Named entity recognition task definition.

Classes¶

NamedEntity ¶

Bases: BaseModel

Single named-entity span.

NamedEntityRecognition ¶

Bases: BaseModel

Named entity recognition output.

Functions¶

named_entity_recognition ¶

named_entity_recognition() -> PreparedTask[
    NamedEntityRecognition
]

Create a named entity recognition task.

Source code in src/openaivec/task/nlp/named_entity_recognition.py

def named_entity_recognition() -> PreparedTask[NamedEntityRecognition]:
    """Create a named entity recognition task."""
    return PreparedTask(
        instructions=_build_instructions(),
        response_format=NamedEntityRecognition,
    )