prebuilt.ai_insight.models¶

Models for General News Reporter System.

Classes¶

Article

Represents a news article.

ArticleSummary

Summary of an article.

NewsCategory

Category for organizing news.

NewsReport

Complete news report.

NewsSearchConfig

Configuration for news search.

ReportConfig

Configuration for report generation.

ReportMetadata

Metadata for the news report.

SummaryStyle

Configuration for summary generation.

Module Contents¶

class prebuilt.ai_insight.models.Article(/, **data)¶

Bases: pydantic.BaseModel

Represents a news article.

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.

Parameters:

data (Any)

property days_old: int | None¶

Days since publication.

Return type:

Optional[int]

class prebuilt.ai_insight.models.ArticleSummary(/, **data)¶

Bases: pydantic.BaseModel

Summary of an article.

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.

Parameters:

data (Any)

class prebuilt.ai_insight.models.NewsCategory(/, **data)¶

Bases: pydantic.BaseModel

Category for organizing news.

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.

Parameters:

data (Any)

property article_count: int¶

Number of articles in category.

Return type:

int

class prebuilt.ai_insight.models.NewsReport(/, **data)¶

Bases: pydantic.BaseModel

Complete news report.

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.

Parameters:

data (Any)

property report_date: str¶

Formatted report date.

Return type:

str

property total_articles: int¶

Total number of articles in report.

Return type:

int

class prebuilt.ai_insight.models.NewsSearchConfig(/, **data)¶

Bases: pydantic.BaseModel

Configuration for news search.

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.

Parameters:

data (Any)

class prebuilt.ai_insight.models.ReportConfig(/, **data)¶

Bases: pydantic.BaseModel

Configuration for report generation.

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.

Parameters:

data (Any)

class prebuilt.ai_insight.models.ReportMetadata(/, **data)¶

Bases: pydantic.BaseModel

Metadata for the news report.

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.

Parameters:

data (Any)

class prebuilt.ai_insight.models.SummaryStyle(/, **data)¶

Bases: pydantic.BaseModel

Configuration for summary generation.

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.

Parameters:

data (Any)