tfg.Agents package
Submodules
tfg.Agents.BaseAgent module
- class tfg.Agents.BaseAgent.BaseAgent(tools, name, system_instructions='', model_name='gemini-2.0-flash', model_kwargs=None)[source]
Bases:
objectBaseAgent is responsible for creating a specialized agent that can use a specific set of tools and execute reasoning and actions through LangGraph-compatible interfaces.
This base class leverages create_react_agent to enable compatibility with the langgraph-supervisor model routing logic.
- Parameters:
tools (
List[Tool]) – A list of LangChain-compatible tools the agent can use.name (
str) – A unique name for the agent (used by the supervisor).system_instructions (
str) – Prompt instructions to guide the agent’s behavior.model_name (
str) – Name of the VertexAI chat model to use.model_kwargs (
Dict) – Optional model configuration overrides.
- class AIMessage(content, **kwargs)
Bases:
BaseMessageMessage from an AI.
AIMessage is returned from a chat model as a response to a prompt.
This message represents the output of the model and consists of both the raw output as returned by the model together standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.
- __add__(other)
Concatenate this message with another message.
- Parameters:
other (
Any) – Another message to concatenate with this one.- Return type:
ChatPromptTemplate- Returns:
A ChatPromptTemplate containing both messages.
- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(content, **kwargs)
Initialize
AIMessage.- Parameters:
content (
Union[str,list[Union[str,dict]]]) – The content of the message.kwargs (
Any) – Additional arguments to pass to the parent class.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- classmethod _backwards_compat_tool_calls(values)
- Return type:
Any
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- additional_kwargs: dict
Reserved for additional payload data associated with the message.
For example, for a message from an AI, this could include tool calls as encoded by the model provider.
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- content: str | list[str | dict]
The string contents of the message.
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- example: bool
Use to denote that a message is part of an example conversation.
At the moment, this is ignored by most models. Usage is discouraged.
- classmethod from_orm(obj)
- Return type:
Self
- classmethod get_lc_namespace()
Get the namespace of the langchain object.
- Return type:
list[str]- Returns:
["langchain", "schema", "messages"]
- id: str | None
An optional unique identifier for the message.
This should ideally be provided by the provider/model which created the message.
- invalid_tool_calls: list[InvalidToolCall]
If provided, tool calls with parsing errors associated with the message.
- classmethod is_lc_serializable()
BaseMessageis serializable.- Return type:
bool- Returns:
True
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- property lc_attributes: dict
Attrs to be serialized even if they are derived from other init args.
- classmethod lc_id()
Return a unique identifier for this class for serialization purposes.
The unique identifier is a list of strings that describes the path to the object. For example, for the class langchain.llms.openai.OpenAI, the id is [“langchain”, “llms”, “openai”, “OpenAI”].
- Return type:
list[str]
- property lc_secrets: dict[str, str]
A map of constructor argument names to secret ids.
- For example,
{“openai_api_key”: “OPENAI_API_KEY”}
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'allow'}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.deep (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'additional_kwargs': FieldInfo(annotation=dict, required=False, default_factory=dict), 'content': FieldInfo(annotation=Union[str, list[Union[str, dict]]], required=True), 'example': FieldInfo(annotation=bool, required=False, default=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, metadata=[_PydanticGeneralMetadata(coerce_numbers_to_str=True)]), 'invalid_tool_calls': FieldInfo(annotation=list[InvalidToolCall], required=False, default=[]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'response_metadata': FieldInfo(annotation=dict, required=False, default_factory=dict), 'tool_calls': FieldInfo(annotation=list[ToolCall], required=False, default=[]), 'type': FieldInfo(annotation=Literal['ai'], required=False, default='ai'), 'usage_metadata': FieldInfo(annotation=Union[UsageMetadata, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- name: str | None
An optional name for the message.
This can be used to provide a human-readable name for the message.
Usage of this field is optional, and whether it’s used or not is up to the model implementation.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- pretty_print()
Print a pretty representation of the message.
- Return type:
None
- pretty_repr(html=False)
Return a pretty representation of the message.
- Parameters:
html (
bool) – Whether to return an HTML-formatted string. Defaults to False.- Return type:
str- Returns:
A pretty representation of the message.
- response_metadata: dict
response headers, logprobs, token counts, model name.
- Type:
Examples
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- text()
Get the text
contentof the message.- Return type:
str- Returns:
The text content of the message.
- to_json()
Serialize the object to JSON.
- Raises:
ValueError – If the class has deprecated attributes.
- Return type:
Union[SerializedConstructor,SerializedNotImplemented]- Returns:
A json serializable object or a SerializedNotImplemented object.
- to_json_not_implemented()
Serialize a “not implemented” object.
- Return type:
SerializedNotImplemented- Returns:
SerializedNotImplemented.
- tool_calls: list[ToolCall]
If provided, tool calls associated with the message.
- type: Literal['ai']
The type of the message (used for deserialization). Defaults to
'ai'.
- classmethod update_forward_refs(**localns)
- Return type:
None
- usage_metadata: UsageMetadata | None
If provided, usage metadata for a message, such as token counts.
This is a standard representation of token usage that is consistent across models.
- classmethod validate(value)
- Return type:
Self
- __init__(tools, name, system_instructions='', model_name='gemini-2.0-flash', model_kwargs=None)[source]
tfg.Agents.CalcAgent module
- class tfg.Agents.CalcAgent.CalculatorAgent[source]
Bases:
BaseAgentAgent for performing simple mathematical operations like mean, sum, min, and max on lists of numbers.
- class AIMessage(content, **kwargs)
Bases:
BaseMessageMessage from an AI.
AIMessage is returned from a chat model as a response to a prompt.
This message represents the output of the model and consists of both the raw output as returned by the model together standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.
- __add__(other)
Concatenate this message with another message.
- Parameters:
other (
Any) – Another message to concatenate with this one.- Return type:
ChatPromptTemplate- Returns:
A ChatPromptTemplate containing both messages.
- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(content, **kwargs)
Initialize
AIMessage.- Parameters:
content (
Union[str,list[Union[str,dict]]]) – The content of the message.kwargs (
Any) – Additional arguments to pass to the parent class.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- classmethod _backwards_compat_tool_calls(values)
- Return type:
Any
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- additional_kwargs: dict
Reserved for additional payload data associated with the message.
For example, for a message from an AI, this could include tool calls as encoded by the model provider.
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- content: str | list[str | dict]
The string contents of the message.
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- example: bool
Use to denote that a message is part of an example conversation.
At the moment, this is ignored by most models. Usage is discouraged.
- classmethod from_orm(obj)
- Return type:
Self
- classmethod get_lc_namespace()
Get the namespace of the langchain object.
- Return type:
list[str]- Returns:
["langchain", "schema", "messages"]
- id: str | None
An optional unique identifier for the message.
This should ideally be provided by the provider/model which created the message.
- invalid_tool_calls: list[InvalidToolCall]
If provided, tool calls with parsing errors associated with the message.
- classmethod is_lc_serializable()
BaseMessageis serializable.- Return type:
bool- Returns:
True
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- property lc_attributes: dict
Attrs to be serialized even if they are derived from other init args.
- classmethod lc_id()
Return a unique identifier for this class for serialization purposes.
The unique identifier is a list of strings that describes the path to the object. For example, for the class langchain.llms.openai.OpenAI, the id is [“langchain”, “llms”, “openai”, “OpenAI”].
- Return type:
list[str]
- property lc_secrets: dict[str, str]
A map of constructor argument names to secret ids.
- For example,
{“openai_api_key”: “OPENAI_API_KEY”}
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'allow'}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.deep (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'additional_kwargs': FieldInfo(annotation=dict, required=False, default_factory=dict), 'content': FieldInfo(annotation=Union[str, list[Union[str, dict]]], required=True), 'example': FieldInfo(annotation=bool, required=False, default=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, metadata=[_PydanticGeneralMetadata(coerce_numbers_to_str=True)]), 'invalid_tool_calls': FieldInfo(annotation=list[InvalidToolCall], required=False, default=[]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'response_metadata': FieldInfo(annotation=dict, required=False, default_factory=dict), 'tool_calls': FieldInfo(annotation=list[ToolCall], required=False, default=[]), 'type': FieldInfo(annotation=Literal['ai'], required=False, default='ai'), 'usage_metadata': FieldInfo(annotation=Union[UsageMetadata, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- name: str | None
An optional name for the message.
This can be used to provide a human-readable name for the message.
Usage of this field is optional, and whether it’s used or not is up to the model implementation.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- pretty_print()
Print a pretty representation of the message.
- Return type:
None
- pretty_repr(html=False)
Return a pretty representation of the message.
- Parameters:
html (
bool) – Whether to return an HTML-formatted string. Defaults to False.- Return type:
str- Returns:
A pretty representation of the message.
- response_metadata: dict
response headers, logprobs, token counts, model name.
- Type:
Examples
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- text()
Get the text
contentof the message.- Return type:
str- Returns:
The text content of the message.
- to_json()
Serialize the object to JSON.
- Raises:
ValueError – If the class has deprecated attributes.
- Return type:
Union[SerializedConstructor,SerializedNotImplemented]- Returns:
A json serializable object or a SerializedNotImplemented object.
- to_json_not_implemented()
Serialize a “not implemented” object.
- Return type:
SerializedNotImplemented- Returns:
SerializedNotImplemented.
- tool_calls: list[ToolCall]
If provided, tool calls associated with the message.
- type: Literal['ai']
The type of the message (used for deserialization). Defaults to
'ai'.
- classmethod update_forward_refs(**localns)
- Return type:
None
- usage_metadata: UsageMetadata | None
If provided, usage metadata for a message, such as token counts.
This is a standard representation of token usage that is consistent across models.
- classmethod validate(value)
- Return type:
Self
- invoke(input_data)
Entry point for langgraph-supervisor to call this agent.
- Parameters:
input_data (
dict) – State passed by the supervisor (e.g., {“messages”: […]})- Returns:
Agent’s structured response.
- Return type:
dict
- run(query)
Convenience method for standalone testing/debugging.
- Parameters:
query (
str) – User input to run directly through the agent.- Returns:
The agent textual response.
- Return type:
str
tfg.Agents.CrossrefAgent module
- class tfg.Agents.CrossrefAgent.CrossrefAgent[source]
Bases:
BaseAgentAgent for searching scientific articles using the Crossref tool.
- class AIMessage(content, **kwargs)
Bases:
BaseMessageMessage from an AI.
AIMessage is returned from a chat model as a response to a prompt.
This message represents the output of the model and consists of both the raw output as returned by the model together standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.
- __add__(other)
Concatenate this message with another message.
- Parameters:
other (
Any) – Another message to concatenate with this one.- Return type:
ChatPromptTemplate- Returns:
A ChatPromptTemplate containing both messages.
- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(content, **kwargs)
Initialize
AIMessage.- Parameters:
content (
Union[str,list[Union[str,dict]]]) – The content of the message.kwargs (
Any) – Additional arguments to pass to the parent class.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- classmethod _backwards_compat_tool_calls(values)
- Return type:
Any
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- additional_kwargs: dict
Reserved for additional payload data associated with the message.
For example, for a message from an AI, this could include tool calls as encoded by the model provider.
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- content: str | list[str | dict]
The string contents of the message.
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- example: bool
Use to denote that a message is part of an example conversation.
At the moment, this is ignored by most models. Usage is discouraged.
- classmethod from_orm(obj)
- Return type:
Self
- classmethod get_lc_namespace()
Get the namespace of the langchain object.
- Return type:
list[str]- Returns:
["langchain", "schema", "messages"]
- id: str | None
An optional unique identifier for the message.
This should ideally be provided by the provider/model which created the message.
- invalid_tool_calls: list[InvalidToolCall]
If provided, tool calls with parsing errors associated with the message.
- classmethod is_lc_serializable()
BaseMessageis serializable.- Return type:
bool- Returns:
True
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- property lc_attributes: dict
Attrs to be serialized even if they are derived from other init args.
- classmethod lc_id()
Return a unique identifier for this class for serialization purposes.
The unique identifier is a list of strings that describes the path to the object. For example, for the class langchain.llms.openai.OpenAI, the id is [“langchain”, “llms”, “openai”, “OpenAI”].
- Return type:
list[str]
- property lc_secrets: dict[str, str]
A map of constructor argument names to secret ids.
- For example,
{“openai_api_key”: “OPENAI_API_KEY”}
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'allow'}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.deep (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'additional_kwargs': FieldInfo(annotation=dict, required=False, default_factory=dict), 'content': FieldInfo(annotation=Union[str, list[Union[str, dict]]], required=True), 'example': FieldInfo(annotation=bool, required=False, default=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, metadata=[_PydanticGeneralMetadata(coerce_numbers_to_str=True)]), 'invalid_tool_calls': FieldInfo(annotation=list[InvalidToolCall], required=False, default=[]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'response_metadata': FieldInfo(annotation=dict, required=False, default_factory=dict), 'tool_calls': FieldInfo(annotation=list[ToolCall], required=False, default=[]), 'type': FieldInfo(annotation=Literal['ai'], required=False, default='ai'), 'usage_metadata': FieldInfo(annotation=Union[UsageMetadata, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- name: str | None
An optional name for the message.
This can be used to provide a human-readable name for the message.
Usage of this field is optional, and whether it’s used or not is up to the model implementation.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- pretty_print()
Print a pretty representation of the message.
- Return type:
None
- pretty_repr(html=False)
Return a pretty representation of the message.
- Parameters:
html (
bool) – Whether to return an HTML-formatted string. Defaults to False.- Return type:
str- Returns:
A pretty representation of the message.
- response_metadata: dict
response headers, logprobs, token counts, model name.
- Type:
Examples
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- text()
Get the text
contentof the message.- Return type:
str- Returns:
The text content of the message.
- to_json()
Serialize the object to JSON.
- Raises:
ValueError – If the class has deprecated attributes.
- Return type:
Union[SerializedConstructor,SerializedNotImplemented]- Returns:
A json serializable object or a SerializedNotImplemented object.
- to_json_not_implemented()
Serialize a “not implemented” object.
- Return type:
SerializedNotImplemented- Returns:
SerializedNotImplemented.
- tool_calls: list[ToolCall]
If provided, tool calls associated with the message.
- type: Literal['ai']
The type of the message (used for deserialization). Defaults to
'ai'.
- classmethod update_forward_refs(**localns)
- Return type:
None
- usage_metadata: UsageMetadata | None
If provided, usage metadata for a message, such as token counts.
This is a standard representation of token usage that is consistent across models.
- classmethod validate(value)
- Return type:
Self
- invoke(input_data)
Entry point for langgraph-supervisor to call this agent.
- Parameters:
input_data (
dict) – State passed by the supervisor (e.g., {“messages”: […]})- Returns:
Agent’s structured response.
- Return type:
dict
- run(query)
Convenience method for standalone testing/debugging.
- Parameters:
query (
str) – User input to run directly through the agent.- Returns:
The agent textual response.
- Return type:
str
tfg.Agents.DBAgent module
tfg.Agents.ElsevierAgent module
- class tfg.Agents.ElsevierAgent.ElsevierAgent[source]
Bases:
BaseAgentAgent for retrieving article content using the Elsevier API tool.
- class AIMessage(content, **kwargs)
Bases:
BaseMessageMessage from an AI.
AIMessage is returned from a chat model as a response to a prompt.
This message represents the output of the model and consists of both the raw output as returned by the model together standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.
- __add__(other)
Concatenate this message with another message.
- Parameters:
other (
Any) – Another message to concatenate with this one.- Return type:
ChatPromptTemplate- Returns:
A ChatPromptTemplate containing both messages.
- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(content, **kwargs)
Initialize
AIMessage.- Parameters:
content (
Union[str,list[Union[str,dict]]]) – The content of the message.kwargs (
Any) – Additional arguments to pass to the parent class.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- classmethod _backwards_compat_tool_calls(values)
- Return type:
Any
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- additional_kwargs: dict
Reserved for additional payload data associated with the message.
For example, for a message from an AI, this could include tool calls as encoded by the model provider.
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- content: str | list[str | dict]
The string contents of the message.
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- example: bool
Use to denote that a message is part of an example conversation.
At the moment, this is ignored by most models. Usage is discouraged.
- classmethod from_orm(obj)
- Return type:
Self
- classmethod get_lc_namespace()
Get the namespace of the langchain object.
- Return type:
list[str]- Returns:
["langchain", "schema", "messages"]
- id: str | None
An optional unique identifier for the message.
This should ideally be provided by the provider/model which created the message.
- invalid_tool_calls: list[InvalidToolCall]
If provided, tool calls with parsing errors associated with the message.
- classmethod is_lc_serializable()
BaseMessageis serializable.- Return type:
bool- Returns:
True
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- property lc_attributes: dict
Attrs to be serialized even if they are derived from other init args.
- classmethod lc_id()
Return a unique identifier for this class for serialization purposes.
The unique identifier is a list of strings that describes the path to the object. For example, for the class langchain.llms.openai.OpenAI, the id is [“langchain”, “llms”, “openai”, “OpenAI”].
- Return type:
list[str]
- property lc_secrets: dict[str, str]
A map of constructor argument names to secret ids.
- For example,
{“openai_api_key”: “OPENAI_API_KEY”}
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'allow'}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.deep (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'additional_kwargs': FieldInfo(annotation=dict, required=False, default_factory=dict), 'content': FieldInfo(annotation=Union[str, list[Union[str, dict]]], required=True), 'example': FieldInfo(annotation=bool, required=False, default=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, metadata=[_PydanticGeneralMetadata(coerce_numbers_to_str=True)]), 'invalid_tool_calls': FieldInfo(annotation=list[InvalidToolCall], required=False, default=[]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'response_metadata': FieldInfo(annotation=dict, required=False, default_factory=dict), 'tool_calls': FieldInfo(annotation=list[ToolCall], required=False, default=[]), 'type': FieldInfo(annotation=Literal['ai'], required=False, default='ai'), 'usage_metadata': FieldInfo(annotation=Union[UsageMetadata, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- name: str | None
An optional name for the message.
This can be used to provide a human-readable name for the message.
Usage of this field is optional, and whether it’s used or not is up to the model implementation.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- pretty_print()
Print a pretty representation of the message.
- Return type:
None
- pretty_repr(html=False)
Return a pretty representation of the message.
- Parameters:
html (
bool) – Whether to return an HTML-formatted string. Defaults to False.- Return type:
str- Returns:
A pretty representation of the message.
- response_metadata: dict
response headers, logprobs, token counts, model name.
- Type:
Examples
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- text()
Get the text
contentof the message.- Return type:
str- Returns:
The text content of the message.
- to_json()
Serialize the object to JSON.
- Raises:
ValueError – If the class has deprecated attributes.
- Return type:
Union[SerializedConstructor,SerializedNotImplemented]- Returns:
A json serializable object or a SerializedNotImplemented object.
- to_json_not_implemented()
Serialize a “not implemented” object.
- Return type:
SerializedNotImplemented- Returns:
SerializedNotImplemented.
- tool_calls: list[ToolCall]
If provided, tool calls associated with the message.
- type: Literal['ai']
The type of the message (used for deserialization). Defaults to
'ai'.
- classmethod update_forward_refs(**localns)
- Return type:
None
- usage_metadata: UsageMetadata | None
If provided, usage metadata for a message, such as token counts.
This is a standard representation of token usage that is consistent across models.
- classmethod validate(value)
- Return type:
Self
- invoke(input_data)
Entry point for langgraph-supervisor to call this agent.
- Parameters:
input_data (
dict) – State passed by the supervisor (e.g., {“messages”: […]})- Returns:
Agent’s structured response.
- Return type:
dict
- run(query)
Convenience method for standalone testing/debugging.
- Parameters:
query (
str) – User input to run directly through the agent.- Returns:
The agent textual response.
- Return type:
str
tfg.Agents.WeatherAgent module
- class tfg.Agents.WeatherAgent.WeatherAgent[source]
Bases:
BaseAgentAgent for retrieving weather information using the OpenWeatherMap tool.
- class AIMessage(content, **kwargs)
Bases:
BaseMessageMessage from an AI.
AIMessage is returned from a chat model as a response to a prompt.
This message represents the output of the model and consists of both the raw output as returned by the model together standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.
- __add__(other)
Concatenate this message with another message.
- Parameters:
other (
Any) – Another message to concatenate with this one.- Return type:
ChatPromptTemplate- Returns:
A ChatPromptTemplate containing both messages.
- __copy__()
Returns a shallow copy of the model.
- Return type:
Self
- __deepcopy__(memo=None)
Returns a deep copy of the model.
- Return type:
Self
- classmethod __get_pydantic_core_schema__(source, handler, /)
Hook into generating the model’s CoreSchema.
- Parameters:
source (
type[BaseModel]) – The class we are generating a schema for. This will generally be the same as the cls argument if this is a classmethod.handler (
GetCoreSchemaHandler) – A callable that calls into Pydantic’s internal CoreSchema generation logic.
- Return type:
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]- Returns:
A pydantic-core CoreSchema.
- classmethod __get_pydantic_json_schema__(core_schema, handler, /)
Hook into generating the model’s JSON schema.
- Parameters:
core_schema (
Union[AnySchema,NoneSchema,BoolSchema,IntSchema,FloatSchema,DecimalSchema,StringSchema,BytesSchema,DateSchema,TimeSchema,DatetimeSchema,TimedeltaSchema,LiteralSchema,EnumSchema,IsInstanceSchema,IsSubclassSchema,CallableSchema,ListSchema,TupleSchema,SetSchema,FrozenSetSchema,GeneratorSchema,DictSchema,AfterValidatorFunctionSchema,BeforeValidatorFunctionSchema,WrapValidatorFunctionSchema,PlainValidatorFunctionSchema,WithDefaultSchema,NullableSchema,UnionSchema,TaggedUnionSchema,ChainSchema,LaxOrStrictSchema,JsonOrPythonSchema,TypedDictSchema,ModelFieldsSchema,ModelSchema,DataclassArgsSchema,DataclassSchema,ArgumentsSchema,CallSchema,CustomErrorSchema,JsonSchema,UrlSchema,MultiHostUrlSchema,DefinitionsSchema,DefinitionReferenceSchema,UuidSchema,ComplexSchema]) – A pydantic-core CoreSchema. You can ignore this argument and call the handler with a new CoreSchema, wrap this CoreSchema ({‘type’: ‘nullable’, ‘schema’: current_schema}), or just call the handler with the original schema.handler (
GetJsonSchemaHandler) – Call into Pydantic’s internal JSON schema generation. This will raise a pydantic.errors.PydanticInvalidForJsonSchema if JSON schema generation fails. Since this gets called by BaseModel.model_json_schema you can override the schema_generator argument to that function to change JSON schema generation globally for a type.
- Return type:
Dict[str,Any]- Returns:
A JSON schema, as a Python object.
- __init__(content, **kwargs)
Initialize
AIMessage.- Parameters:
content (
Union[str,list[Union[str,dict]]]) – The content of the message.kwargs (
Any) – Additional arguments to pass to the parent class.
- __iter__()
So dict(model) works.
- Return type:
Generator[Tuple[str,Any],None,None]
- __pretty__(fmt, **kwargs)
Used by devtools (https://python-devtools.helpmanual.io/) to pretty print objects.
- Return type:
Generator[Any,None,None]
- classmethod __pydantic_init_subclass__(**kwargs)
This is intended to behave just like __init_subclass__, but is called by ModelMetaclass only after the class is actually fully initialized. In particular, attributes like model_fields will be present when this is called.
This is necessary because __init_subclass__ will always be called by type.__new__, and it would require a prohibitively large refactor to the ModelMetaclass to ensure that type.__new__ was called in such a manner that the class would already be sufficiently initialized.
This will receive the same kwargs that would be passed to the standard __init_subclass__, namely, any kwargs passed to the class definition that aren’t used internally by pydantic.
- Parameters:
**kwargs (
Any) – Any keyword arguments passed to the class definition that aren’t used internally by pydantic.- Return type:
None
- __repr_name__()
Name of the instance’s class, used in __repr__.
- Return type:
str
- __rich_repr__()
Used by Rich (https://rich.readthedocs.io/en/stable/pretty.html) to pretty print objects.
- Return type:
Iterable[Any|tuple[Any] |tuple[str,Any] |tuple[str,Any,Any]]
- _abc_impl = <_abc._abc_data object>
- classmethod _backwards_compat_tool_calls(values)
- Return type:
Any
- _calculate_keys(*args, **kwargs)
- Return type:
Any
- _check_frozen(name, value)
- Return type:
None
- _copy_and_set_values(*args, **kwargs)
- Return type:
Any
- classmethod _get_value(*args, **kwargs)
- Return type:
Any
- _iter(*args, **kwargs)
- Return type:
Any
- additional_kwargs: dict
Reserved for additional payload data associated with the message.
For example, for a message from an AI, this could include tool calls as encoded by the model provider.
- classmethod construct(_fields_set=None, **values)
- Return type:
Self
- content: str | list[str | dict]
The string contents of the message.
- copy(*, include=None, exclude=None, update=None, deep=False)
Returns a copy of the model.
- !!! warning “Deprecated”
This method is now deprecated; use model_copy instead.
If you need include or exclude, use:
`py data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `- Parameters:
include – Optional set or mapping specifying which fields to include in the copied model.
exclude – Optional set or mapping specifying which fields to exclude in the copied model.
update – Optional dictionary of field-value pairs to override field values in the copied model.
deep – If True, the values of fields that are Pydantic models will be deep-copied.
- Returns:
A copy of the model with included, excluded and updated fields as specified.
- dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)
- Return type:
Dict[str,Any]
- example: bool
Use to denote that a message is part of an example conversation.
At the moment, this is ignored by most models. Usage is discouraged.
- classmethod from_orm(obj)
- Return type:
Self
- classmethod get_lc_namespace()
Get the namespace of the langchain object.
- Return type:
list[str]- Returns:
["langchain", "schema", "messages"]
- id: str | None
An optional unique identifier for the message.
This should ideally be provided by the provider/model which created the message.
- invalid_tool_calls: list[InvalidToolCall]
If provided, tool calls with parsing errors associated with the message.
- classmethod is_lc_serializable()
BaseMessageis serializable.- Return type:
bool- Returns:
True
- json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)
- Return type:
str
- property lc_attributes: dict
Attrs to be serialized even if they are derived from other init args.
- classmethod lc_id()
Return a unique identifier for this class for serialization purposes.
The unique identifier is a list of strings that describes the path to the object. For example, for the class langchain.llms.openai.OpenAI, the id is [“langchain”, “llms”, “openai”, “OpenAI”].
- Return type:
list[str]
- property lc_secrets: dict[str, str]
A map of constructor argument names to secret ids.
- For example,
{“openai_api_key”: “OPENAI_API_KEY”}
- model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'allow'}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- classmethod model_construct(_fields_set=None, **values)
Creates a new instance of the Model class with validated data.
Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.
- !!! note
model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.
- Parameters:
_fields_set (
set[str] |None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.values (
Any) – Trusted or pre-validated data dictionary.
- Return type:
Self- Returns:
A new instance of the Model class with validated data.
- model_copy(*, update=None, deep=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#model_copy
Returns a copy of the model.
- Parameters:
update (
dict[str,Any] |None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.deep (
bool) – Set to True to make a deep copy of the model.
- Return type:
Self- Returns:
New model instance.
- model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters:
mode (
Union[Literal['json','python'],str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to include in the output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – A set of fields to exclude from the output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to use the field’s alias in the dictionary key if defined.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
dict[str,Any]- Returns:
A dictionary representation of the model.
- model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, serialize_as_any=False)
Usage docs: https://docs.pydantic.dev/2.9/concepts/serialization/#modelmodel_dump_json
Generates a JSON representation of the model using Pydantic’s to_json method.
- Parameters:
indent (
int|None) – Indentation to use in the JSON output. If None is passed, the output will be compact.include (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to include in the JSON output.exclude (
Union[Set[int],Set[str],Mapping[int,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],Mapping[str,Union[Set[int],Set[str],Mapping[int,Union[IncEx,Literal[True]]],Mapping[str,Union[IncEx,Literal[True]]],Literal[True]]],None]) – Field(s) to exclude from the JSON output.context (
Any|None) – Additional context to pass to the serializer.by_alias (
bool) – Whether to serialize using field aliases.exclude_unset (
bool) – Whether to exclude fields that have not been explicitly set.exclude_defaults (
bool) – Whether to exclude fields that are set to their default value.exclude_none (
bool) – Whether to exclude fields that have a value of None.round_trip (
bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].warnings (
Union[bool,Literal['none','warn','error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].serialize_as_any (
bool) – Whether to serialize fields with duck-typing serialization behavior.
- Return type:
str- Returns:
A JSON string representation of the model.
- property model_extra: dict[str, Any] | None
Get extra fields set during validation.
- Returns:
A dictionary of extra fields, or None if config.extra is not set to “allow”.
- model_fields: ClassVar[Dict[str, FieldInfo]] = {'additional_kwargs': FieldInfo(annotation=dict, required=False, default_factory=dict), 'content': FieldInfo(annotation=Union[str, list[Union[str, dict]]], required=True), 'example': FieldInfo(annotation=bool, required=False, default=False), 'id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, metadata=[_PydanticGeneralMetadata(coerce_numbers_to_str=True)]), 'invalid_tool_calls': FieldInfo(annotation=list[InvalidToolCall], required=False, default=[]), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None), 'response_metadata': FieldInfo(annotation=dict, required=False, default_factory=dict), 'tool_calls': FieldInfo(annotation=list[ToolCall], required=False, default=[]), 'type': FieldInfo(annotation=Literal['ai'], required=False, default='ai'), 'usage_metadata': FieldInfo(annotation=Union[UsageMetadata, NoneType], required=False, default=None)}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.
This replaces Model.__fields__ from Pydantic V1.
- property model_fields_set: set[str]
Returns the set of fields that have been explicitly set on this model instance.
- Returns:
- A set of strings representing the fields that have been set,
i.e. that were not filled from defaults.
- classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')
Generates a JSON schema for a model class.
- Parameters:
by_alias (
bool) – Whether to use attribute aliases or not.ref_template (
str) – The reference template.schema_generator (
type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modificationsmode (
Literal['validation','serialization']) – The mode in which to generate the schema.
- Return type:
dict[str,Any]- Returns:
The JSON schema for the given model class.
- classmethod model_parametrized_name(params)
Compute the class name for parametrizations of generic classes.
This method can be overridden to achieve a custom naming scheme for generic BaseModels.
- Parameters:
params (
tuple[type[Any],...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.- Return type:
str- Returns:
String representing the new class where params are passed to cls as type variables.
- Raises:
TypeError – Raised when trying to generate concrete names for non-generic models.
- model_post_init(_BaseModel__context)
Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.
- Return type:
None
- classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)
Try to rebuild the pydantic-core schema for the model.
This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.
- Parameters:
force (
bool) – Whether to force the rebuilding of the model schema, defaults to False.raise_errors (
bool) – Whether to raise errors, defaults to True._parent_namespace_depth (
int) – The depth level of the parent namespace, defaults to 2._types_namespace (
dict[str,Any] |None) – The types namespace, defaults to None.
- Return type:
bool|None- Returns:
Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.
- classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None)
Validate a pydantic model instance.
- Parameters:
obj (
Any) – The object to validate.strict (
bool|None) – Whether to enforce types strictly.from_attributes (
bool|None) – Whether to extract data from object attributes.context (
Any|None) – Additional context to pass to the validator.
- Raises:
ValidationError – If the object could not be validated.
- Return type:
Self- Returns:
The validated model instance.
- classmethod model_validate_json(json_data, *, strict=None, context=None)
Usage docs: https://docs.pydantic.dev/2.9/concepts/json/#json-parsing
Validate the given JSON data against the Pydantic model.
- Parameters:
json_data (
str|bytes|bytearray) – The JSON data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- Raises:
ValidationError – If json_data is not a JSON string or the object could not be validated.
- classmethod model_validate_strings(obj, *, strict=None, context=None)
Validate the given object with string data against the Pydantic model.
- Parameters:
obj (
Any) – The object containing string data to validate.strict (
bool|None) – Whether to enforce types strictly.context (
Any|None) – Extra variables to pass to the validator.
- Return type:
Self- Returns:
The validated Pydantic model.
- name: str | None
An optional name for the message.
This can be used to provide a human-readable name for the message.
Usage of this field is optional, and whether it’s used or not is up to the model implementation.
- classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- classmethod parse_obj(obj)
- Return type:
Self
- classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)
- Return type:
Self
- pretty_print()
Print a pretty representation of the message.
- Return type:
None
- pretty_repr(html=False)
Return a pretty representation of the message.
- Parameters:
html (
bool) – Whether to return an HTML-formatted string. Defaults to False.- Return type:
str- Returns:
A pretty representation of the message.
- response_metadata: dict
response headers, logprobs, token counts, model name.
- Type:
Examples
- classmethod schema(by_alias=True, ref_template='#/$defs/{model}')
- Return type:
Dict[str,Any]
- classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)
- Return type:
str
- text()
Get the text
contentof the message.- Return type:
str- Returns:
The text content of the message.
- to_json()
Serialize the object to JSON.
- Raises:
ValueError – If the class has deprecated attributes.
- Return type:
Union[SerializedConstructor,SerializedNotImplemented]- Returns:
A json serializable object or a SerializedNotImplemented object.
- to_json_not_implemented()
Serialize a “not implemented” object.
- Return type:
SerializedNotImplemented- Returns:
SerializedNotImplemented.
- tool_calls: list[ToolCall]
If provided, tool calls associated with the message.
- type: Literal['ai']
The type of the message (used for deserialization). Defaults to
'ai'.
- classmethod update_forward_refs(**localns)
- Return type:
None
- usage_metadata: UsageMetadata | None
If provided, usage metadata for a message, such as token counts.
This is a standard representation of token usage that is consistent across models.
- classmethod validate(value)
- Return type:
Self
- invoke(input_data)
Entry point for langgraph-supervisor to call this agent.
- Parameters:
input_data (
dict) – State passed by the supervisor (e.g., {“messages”: […]})- Returns:
Agent’s structured response.
- Return type:
dict
- run(query)
Convenience method for standalone testing/debugging.
- Parameters:
query (
str) – User input to run directly through the agent.- Returns:
The agent textual response.
- Return type:
str