AnnotationContent Class

Annotation content.

Note: This class is marked as 'experimental' and may change in the future.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

AnnotationContent(*, inner_content: Any | None = None, ai_model_id: str | None = None, metadata: dict[str, Any] = None, content_type: Literal[ContentTypes.ANNOTATION_CONTENT] = 'annotation', file_id: str | None = None, quote: str | None = None, start_index: int | None = None, end_index: int | None = None)

Keyword-Only Parameters

Name	Description
inner_content Required
ai_model_id Required
metadata Required
content_type	Default value: annotation
file_id Required
quote Required
start_index Required
end_index Required

Methods

from_element	Create an instance from an Element.
to_dict	Convert the instance to a dictionary.
to_element	Convert the annotation content to an Element.

from_element

Create an instance from an Element.

from_element(element: Element) -> _T

Parameters

Name	Description
element Required

to_dict

Convert the instance to a dictionary.

to_dict() -> dict[str, Any]

to_element

Convert the annotation content to an Element.

to_element() -> Element

Attributes

ai_model_id

ai_model_id: str | None

content_type

content_type: Literal[ContentTypes.ANNOTATION_CONTENT]

end_index

end_index: int | None

file_id

file_id: str | None

inner_content

inner_content: Annotated[Any | None, Field(exclude=True)]

is_experimental

is_experimental = True

metadata

metadata: dict[str, Any]

quote

quote: str | None

stage_status

stage_status = 'experimental'

start_index

start_index: int | None

tag

tag: ClassVar[str] = 'annotation'

Share via