roboto.ai.summary#
Module Contents#
- class roboto.ai.summary.AISummary(/, **data)#
Bases:
pydantic.BaseModel
A wire-transmissible representation of an AI summary
- Parameters:
data (Any)
- created: datetime.datetime#
The time at which the summary was created.
- status: AISummaryStatus#
The status of the summary.
- summary_id: str#
The ID of the summary.
- text: str#
The text of the summary.
- class roboto.ai.summary.AISummaryStatus#
Bases:
str
,enum.Enum
Status of an AI summary.
- Complete = 'complete'#
The summary has been generated.
- Failed = 'failed'#
The summary failed to generate.
- Pending = 'pending'#
The summary is being generated. Its text may be the empty string, or may be a partial result. If you continually poll for the summary while it is in the pending state, you will eventually get the complete summary.