haive.agents.structured_output.models ===================================== .. py:module:: haive.agents.structured_output.models .. autoapi-nested-parse:: Common structured output models for various agent patterns. Classes ------- .. autoapisummary:: haive.agents.structured_output.models.Analysis haive.agents.structured_output.models.Critique haive.agents.structured_output.models.Decision haive.agents.structured_output.models.ExtractedData haive.agents.structured_output.models.Improvement haive.agents.structured_output.models.Intent haive.agents.structured_output.models.QualityCheck haive.agents.structured_output.models.ReflectionResult haive.agents.structured_output.models.Response haive.agents.structured_output.models.SearchQuery haive.agents.structured_output.models.SearchResult haive.agents.structured_output.models.Summary haive.agents.structured_output.models.TaskResult haive.agents.structured_output.models.ValidationResult Module Contents --------------- .. py:class:: Analysis(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured analysis 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. .. py:class:: Critique(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured critique of an output. 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. .. py:class:: Decision(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured decision output. 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. .. py:class:: ExtractedData(/, **data) Bases: :py:obj:`pydantic.BaseModel` Extracted structured data. 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. .. py:class:: Improvement(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured improvement suggestions. 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. .. py:class:: Intent(/, **data) Bases: :py:obj:`pydantic.BaseModel` User intent classification. 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. .. py:class:: QualityCheck(/, **data) Bases: :py:obj:`pydantic.BaseModel` Quality assessment 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. .. py:class:: ReflectionResult(/, **data) Bases: :py:obj:`pydantic.BaseModel` Complete reflection analysis. 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. .. py:class:: Response(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured response. 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. .. py:class:: SearchQuery(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured search query. 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. .. py:class:: SearchResult(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured 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. .. py:class:: Summary(/, **data) Bases: :py:obj:`pydantic.BaseModel` Structured summary. 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. .. py:class:: TaskResult(/, **data) Bases: :py:obj:`pydantic.BaseModel` Result of task execution. 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. .. py:class:: ValidationResult(/, **data) Bases: :py:obj:`pydantic.BaseModel` Result of validation check. 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.