haive.agents.rag.common.document_graders.models
===============================================

.. py:module:: haive.agents.rag.common.document_graders.models

.. autoapi-nested-parse::

   RAG Structured Output Models.

   Pydantic models for structured outputs from RAG evaluation agents.



Classes
-------

.. autoapisummary::

   haive.agents.rag.common.document_graders.models.DocumentBinaryGrading
   haive.agents.rag.common.document_graders.models.DocumentBinaryResponse
   haive.agents.rag.common.document_graders.models.DocumentGrade
   haive.agents.rag.common.document_graders.models.DocumentGradingResponse
   haive.agents.rag.common.document_graders.models.DocumentRelevanceScore


Module Contents
---------------

.. py:class:: DocumentBinaryGrading(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Binary pass/fail document grading.

   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:: DocumentBinaryResponse(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Response for binary document grading.

   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:: DocumentGrade(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Simple document grade for use in corrective RAG.

   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:: DocumentGradingResponse(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Comprehensive document grading 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:: DocumentRelevanceScore(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Individual document relevance assessment.

   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.