Module `llmflex.Schemas.documents`

Expand source code

from pydantic import BaseModel
from typing import Dict, Any, Optional

class Document(BaseModel):
    index: str
    metadata: Dict[str, Any] = dict()

class RankResult:
    """Result of rerankers.
    """
    def __init__(self, index: str, rank_score: float, metadata: Optional[Dict[str, Any]] = None, original_score: Optional[float] = None, id: Optional[int] = None) -> None:
        from ..utils import validate_type
        self.index = validate_type(index, str)
        self.rank_score = validate_type(rank_score, float)
        self.metadata = dict() if metadata is None else validate_type(metadata, dict)
        self.original_score = 0.0 if original_score is None else validate_type(original_score, float)
        self.id = -1 if id is None else validate_type(id, int)

    def to_dict(self) -> Dict[str, Any]:
        """Transform the result to a dictionary.

        Returns:
            Dict[str, Any]: Dictionary of the content of the result.
        """
        values = dict(
            index=self.index,
            rank_score=self.rank_score,
            metadata=self.metadata,
            original_score=self.original_score,
            id=self.id 
        )
        return values
    
    def __repr__(self) -> str:
        view = f'RankResult(index="{self.index}", rank_score={self.rank_score}, metadata={self.metadata}, original_score={self.original_score}, id={self.id})'
        return view

Classes

class Document (**data: Any)

Usage docs: https://docs.pydantic.dev/2.7/concepts/models/

A base class for creating Pydantic models.

Attributes

__class_vars__: The names of classvars defined on the model.
__private_attributes__: Metadata about the private attributes of the model.
__signature__: The signature for instantiating the model.
__pydantic_complete__: Whether model building is completed, or if there are still undefined fields.
__pydantic_core_schema__: The pydantic-core schema used to build the SchemaValidator and SchemaSerializer.
__pydantic_custom_init__: Whether the model has a custom __init__ function.
__pydantic_decorators__: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
__pydantic_generic_metadata__: Metadata for generic models; contains data used for a similar purpose to args, origin, parameters in typing-module generics. May eventually be replaced by these.
__pydantic_parent_namespace__: Parent namespace of the model, used for automatic rebuilding of models.
__pydantic_post_init__: The name of the post-init method for the model, if defined.
__pydantic_root_model__: Whether the model is a RootModel.
__pydantic_serializer__: The pydantic-core SchemaSerializer used to dump instances of the model.
__pydantic_validator__: The pydantic-core SchemaValidator used to validate instances of the model.
__pydantic_extra__: An instance attribute with the values of extra fields from validation when model_config['extra'] == 'allow'.
__pydantic_fields_set__: An instance attribute with the names of fields explicitly set.
__pydantic_private__: Instance attribute with the values of private attributes set on the model instance.

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.

Expand source code

class Document(BaseModel):
    index: str
    metadata: Dict[str, Any] = dict()

Ancestors

pydantic.main.BaseModel

Class variables

var index : str
var metadata : Dict[str, Any]
var model_computed_fields
var model_config
var model_fields

class RankResult (index: str, rank_score: float, metadata: Optional[Dict[str, Any]] = None, original_score: Optional[float] = None, id: Optional[int] = None)

Result of rerankers.

Expand source code

class RankResult:
    """Result of rerankers.
    """
    def __init__(self, index: str, rank_score: float, metadata: Optional[Dict[str, Any]] = None, original_score: Optional[float] = None, id: Optional[int] = None) -> None:
        from ..utils import validate_type
        self.index = validate_type(index, str)
        self.rank_score = validate_type(rank_score, float)
        self.metadata = dict() if metadata is None else validate_type(metadata, dict)
        self.original_score = 0.0 if original_score is None else validate_type(original_score, float)
        self.id = -1 if id is None else validate_type(id, int)

    def to_dict(self) -> Dict[str, Any]:
        """Transform the result to a dictionary.

        Returns:
            Dict[str, Any]: Dictionary of the content of the result.
        """
        values = dict(
            index=self.index,
            rank_score=self.rank_score,
            metadata=self.metadata,
            original_score=self.original_score,
            id=self.id 
        )
        return values
    
    def __repr__(self) -> str:
        view = f'RankResult(index="{self.index}", rank_score={self.rank_score}, metadata={self.metadata}, original_score={self.original_score}, id={self.id})'
        return view

Methods

def to_dict(self) ‑> Dict[str, Any]

Transform the result to a dictionary.

Returns

Dict[str, Any]: Dictionary of the content of the result.

Expand source code

def to_dict(self) -> Dict[str, Any]:
    """Transform the result to a dictionary.

    Returns:
        Dict[str, Any]: Dictionary of the content of the result.
    """
    values = dict(
        index=self.index,
        rank_score=self.rank_score,
        metadata=self.metadata,
        original_score=self.original_score,
        id=self.id 
    )
    return values