prebuilt.search_and_summarize.models¶

Models for Search & Summarize Agent System.

Classes¶

ContentSummary

Summary of a piece of content.

ResearchReport

Complete research report combining all summaries.

SearchQuery

Search query with optional site filtering.

SearchResult

Individual search result.

SearchResults

Collection of search results.

SummaryConfig

Configuration for summarization.

Module Contents¶

class prebuilt.search_and_summarize.models.ContentSummary(/, **data)¶

Bases: pydantic.BaseModel

Summary of a piece of content.

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.search_and_summarize.models.ResearchReport(/, **data)¶

Bases: pydantic.BaseModel

Complete research report combining all summaries.

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 average_relevance: float¶

Average relevance score across all summaries.

Return type:

float

property source_count: int¶

Number of sources summarized.

Return type:

int

class prebuilt.search_and_summarize.models.SearchQuery(/, **data)¶

Bases: pydantic.BaseModel

Search query with optional site filtering.

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.search_and_summarize.models.SearchResult(/, **data)¶

Bases: pydantic.BaseModel

Individual search result.

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.search_and_summarize.models.SearchResults(/, **data)¶

Bases: pydantic.BaseModel

Collection of search results.

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 has_results: bool¶

Check if search returned any results.

Return type:

bool

class prebuilt.search_and_summarize.models.SummaryConfig(/, **data)¶

Bases: pydantic.BaseModel

Configuration for summarization.

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)