ChatMessageRequest Classe

Demande de charge utile pour l’envoi de l’historique des conversations à la plateforme MCP.

Ce modèle représente le corps de la demande complet envoyé au point de terminaison de l’historique des conversations de la plateforme MCP pour l’analyse de la protection contre les menaces. Il inclut le contexte de conversation actuel et les messages historiques.

Le modèle utilise des alias de champ pour sérialiser au format JSON camelCase, comme requis par l’API de plateforme MCP.

Constructeur

pydantic model ChatMessageRequest

Paramètres de mot clé uniquement

Nom	Description
conversationId Obligatoire
messageId Obligatoire
userMessage Obligatoire
chatHistory Obligatoire

Exemples


>>> from microsoft_agents_a365.tooling.models import ChatHistoryMessage
>>> request = ChatMessageRequest(
...     conversation_id="conv-123",
...     message_id="msg-456",
...     user_message="What is the weather today?",
...     chat_history=[
...         ChatHistoryMessage(role="user", content="Hello"),
...         ChatHistoryMessage(role="assistant", content="Hi there!"),
...     ]
... )
>>> # Serialize to camelCase JSON
>>> json_dict = request.model_dump(by_alias=True)
>>> print(json_dict["conversationId"])
'conv-123'

Méthodes

__init__	Créez un modèle en analysant et en validant les données d’entrée à partir d’arguments de mot clé. Déclenche [ValidationError][pydantic_core. ValidationError] si les données d’entrée ne peuvent pas être validées pour former un modèle valide. auto est explicitement positionnel pour autoriser l’auto en tant que nom de champ.
__new__
construct
copy	Retourne une copie du modèle. !!! avertissement « Déconseillé » Cette méthode est désormais déconseillée ; utilisez model_copy à la place. Si vous avez besoin d’inclure ou d’exclure, utilisez : `python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {data, (update or {})} copied = self.model_validate(data)`
dict
from_orm
json
model_construct	Crée une instance de la classe Model avec des données validées. Crée un paramètre de modèle dicté et pydantic_fields_set à partir de données approuvées ou pré-validées. Les valeurs par défaut sont respectées, mais aucune autre validation n’est effectuée. !!! notez model_construct() respecte généralement le paramètre model_config.extra sur le modèle fourni. Autrement dit, si model_config.extra == 'allow', toutes les valeurs supplémentaires passées sont ajoutées aux champs dict et pydantic_extra de l’instance de modèle. Si model_config.extra == 'ignore' (valeur par défaut), toutes les valeurs transmises supplémentaires sont ignorées. Étant donné qu’aucune validation n’est effectuée avec un appel à model_construct(),le fait d’avoir model_config.extra == 'interdit' n’entraîne pas d’erreur si des valeurs supplémentaires sont passées, mais elles seront ignorées.
model_copy	!!! abstraite « Documentation sur l’utilisation » model_copy Retourne une copie du modèle. !!! notez que l’instance sous-jacente [dict][object.l’attribut dict] est copié. Cela peut avoir des effets secondaires inattendus si vous stockez quelque chose dans celui-ci, au-dessus des champs du modèle (par exemple, la valeur de [propriétés mises en cache][functools.cached_property]).
model_dump	!!! abstraite « Documentation sur l’utilisation » model_dump Générez une représentation de dictionnaire du modèle, en spécifiant éventuellement les champs à inclure ou exclure.
model_dump_json	!!! abstraite « Documentation sur l’utilisation » model_dump_json Génère une représentation JSON du modèle à l’aide de la méthode to_json pydantic .
model_json_schema	Génère un schéma JSON pour une classe de modèle.
model_parametrized_name	Calculez le nom de classe pour les paramétrations des classes génériques. Cette méthode peut être remplacée pour obtenir un schéma d’affectation de noms personnalisé pour les BasesModels génériques.
model_post_init	Remplacez cette méthode pour effectuer une initialisation supplémentaire après init et model_construct. Cela est utile si vous souhaitez effectuer une validation qui nécessite l’initialisation de l’ensemble du modèle.
model_rebuild	Essayez de reconstruire le schéma pydantic-core pour le modèle. Cela peut être nécessaire lorsque l’une des annotations est un ForwardRef qui n’a pas pu être résolu lors de la tentative initiale de génération du schéma et l’échec de la reconstruction automatique.
model_validate	Validez une instance de modèle pydantic.
model_validate_json	!!! analyse JSON abstraite de la « documentation d’utilisation » Validez les données JSON données données par rapport au modèle Pydantic.
model_validate_strings	Validez l’objet donné avec des données de chaîne sur le modèle Pydantic.
not_empty	Vérifiez que les champs de chaîne ne sont pas vides ou espaces blancs uniquement.
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

init

Créez un modèle en analysant et en validant les données d’entrée à partir d’arguments de mot clé.

Déclenche [ValidationError][pydantic_core. ValidationError] si les données d’entrée ne peuvent pas être validées pour former un modèle valide.

auto est explicitement positionnel pour autoriser l’auto en tant que nom de champ.

__init__(**data: Any) -> None

Paramètres

Nom	Description
data Obligatoire	Any

Retours

Type	Description
None

new

__new__(**kwargs)

construct

construct(_fields_set: set[str] | None = None, **values: Any) -> Self

Paramètres

Nom	Description
_fields_set	set[str] \| None Valeur par défaut: None
values Obligatoire	Any

Retours

Type	Description
Self

copy

Retourne une copie du modèle.

!!! avertissement « Déconseillé » Cette méthode est désormais déconseillée ; utilisez model_copy à la place.

Si vous avez besoin d’inclure ou d’exclure, utilisez :

python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data)

copy(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, update: Dict[str, Any] | None = None, deep: bool = False) -> Self

Paramètres

Nom	Description
include Obligatoire	<xref:AbstractSetIntStr> \| <xref:MappingIntStrAny> \| None Ensemble ou mappage facultatif spécifiant les champs à inclure dans le modèle copié.
exclude Obligatoire	<xref:AbstractSetIntStr> \| <xref:MappingIntStrAny> \| None Ensemble ou mappage facultatif spécifiant les champs à exclure dans le modèle copié.
update Obligatoire	Dict[str, Any] \| None Dictionnaire facultatif de paires champ-valeur pour remplacer les valeurs de champ dans le modèle copié.
deep Obligatoire	bool Si la valeur est True, les valeurs des champs qui sont des modèles Pydantic sont copiées en profondeur.

Paramètres de mot clé uniquement

Nom	Description
include	Valeur par défaut: None
exclude	Valeur par défaut: None
update	Valeur par défaut: None
deep	Valeur par défaut: False

Retours

Type	Description
Self	Copie du modèle avec des champs inclus, exclus et mis à jour comme spécifié.

dict

dict(*, include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) -> Dict[str, Any]

Paramètres

Nom	Description
include Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None
exclude Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None
by_alias Obligatoire	bool
exclude_unset Obligatoire	bool
exclude_defaults Obligatoire	bool
exclude_none Obligatoire	bool

Paramètres de mot clé uniquement

Nom	Description
include	Valeur par défaut: None
exclude	Valeur par défaut: None
by_alias	Valeur par défaut: False
exclude_unset	Valeur par défaut: False
exclude_defaults	Valeur par défaut: False
exclude_none	Valeur par défaut: False

Retours

Type	Description
Dict[str, Any]

from_orm

from_orm(obj: Any) -> Self

Paramètres

Nom	Description
obj Obligatoire	Any

Retours

Type	Description
Self

json

json(*, include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Callable[[Any], Any] | None = PydanticUndefined, models_as_dict: bool = PydanticUndefined, **dumps_kwargs: Any) -> str

Paramètres

Nom	Description
include Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None
exclude Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None
by_alias Obligatoire	bool
exclude_unset Obligatoire	bool
exclude_defaults Obligatoire	bool
exclude_none Obligatoire	bool
encoder Obligatoire	Callable[[Any], Any] \| None
models_as_dict Obligatoire	bool
dumps_kwargs Obligatoire	Any

Paramètres de mot clé uniquement

Nom	Description
include	Valeur par défaut: None
exclude	Valeur par défaut: None
by_alias	Valeur par défaut: False
exclude_unset	Valeur par défaut: False
exclude_defaults	Valeur par défaut: False
exclude_none	Valeur par défaut: False
encoder	Valeur par défaut: PydanticUndefined
models_as_dict	Valeur par défaut: PydanticUndefined

Retours

Type	Description
str

model_construct

Crée une instance de la classe Model avec des données validées.

Crée un paramètre de modèle dicté et pydantic_fields_set à partir de données approuvées ou pré-validées. Les valeurs par défaut sont respectées, mais aucune autre validation n’est effectuée.

!!! notez model_construct() respecte généralement le paramètre model_config.extra sur le modèle fourni. Autrement dit, si model_config.extra == 'allow', toutes les valeurs supplémentaires passées sont ajoutées aux champs dict et pydantic_extra de l’instance de modèle. Si model_config.extra == 'ignore' (valeur par défaut), toutes les valeurs transmises supplémentaires sont ignorées. Étant donné qu’aucune validation n’est effectuée avec un appel à model_construct(),le fait d’avoir model_config.extra == 'interdit' n’entraîne pas d’erreur si des valeurs supplémentaires sont passées, mais elles seront ignorées.

model_construct(_fields_set: set[str] | None = None, **values: Any) -> Self

Paramètres

Nom	Description
_fields_set	set[str] \| None Ensemble de noms de champs qui ont été définis explicitement à l’origine lors de l’instanciation. S’il est fourni, il est directement utilisé pour le [model_fields_set][pydantique. attribut BaseModel.model_fields_set]. Dans le cas contraire, les noms de champs de l’argument valeurs seront utilisés. Valeur par défaut: None
values Obligatoire	Any Dictionnaire de données approuvé ou pré-validé.

Retours

Type	Description
Self	Nouvelle instance de la classe Model avec des données validées.

model_copy

!!! abstraite « Documentation sur l’utilisation » model_copy

Retourne une copie du modèle.

!!! notez que l’instance sous-jacente [dict][object.l’attribut dict] est copié. Cela peut avoir des effets secondaires inattendus si vous stockez quelque chose dans celui-ci, au-dessus des champs du modèle (par exemple, la valeur de [propriétés mises en cache][functools.cached_property]).

model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) -> Self

Paramètres

Nom	Description
update Obligatoire	Mapping[str, Any] \| None Valeurs à modifier/ajouter dans le nouveau modèle. Remarque : les données ne sont pas validées avant de créer le nouveau modèle. Vous devez approuver ces données.
deep Obligatoire	bool Définissez la valeur True pour effectuer une copie approfondie du modèle.

Paramètres de mot clé uniquement

Nom	Description
update	Valeur par défaut: None
deep	Valeur par défaut: False

Retours

Type	Description
Self	Nouvelle instance de modèle.

model_dump

!!! abstraite « Documentation sur l’utilisation » model_dump

Générez une représentation de dictionnaire du modèle, en spécifiant éventuellement les champs à inclure ou exclure.

model_dump(*, mode: Literal['json', 'python'] | str = 'python', include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, fallback: Callable[[Any], Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> dict[str, Any]

Paramètres

Nom	Description
mode Obligatoire	Literal['json', 'python'] \| str Mode dans lequel to_python devez s’exécuter . Si le mode est « json », la sortie contient uniquement des types sérialisables JSON. Si le mode est « python », la sortie peut contenir des objets Python non-JSON sérialisables.
include Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None Ensemble de champs à inclure dans la sortie.
exclude Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None Ensemble de champs à exclure de la sortie.
context Obligatoire	Any \| None Contexte supplémentaire à passer au sérialiseur.
by_alias Obligatoire	bool \| None Indique s’il faut utiliser l’alias du champ dans la clé de dictionnaire si elle est définie.
exclude_unset Obligatoire	bool Indique s’il faut exclure des champs qui n’ont pas été définis explicitement.
exclude_defaults Obligatoire	bool Indique s’il faut exclure les champs définis sur leur valeur par défaut.
exclude_none Obligatoire	bool Indique s’il faut exclure des champs qui ont la valeur None.
exclude_computed_fields Obligatoire	bool Indique s’il faut exclure les champs calculés. Bien que cela puisse être utile pour l’aller-retour, il est généralement recommandé d’utiliser le paramètre de round_trip dédié à la place.
round_trip Obligatoire	bool Si la valeur est True, les valeurs vidées doivent être valides comme entrée pour les types non idempotents tels que Json[T].
warnings Obligatoire	bool \| Literal['none', 'warn', 'error'] Comment gérer les erreurs de sérialisation. False/"none » ignore ces erreurs, True/"warn » journalise les erreurs, « error » déclenche une [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Obligatoire	Callable[[Any], Any] \| None Fonction à appeler lorsqu’une valeur inconnue est rencontrée. S’il n’est pas fourni, a [PydanticSerializationError][pydantic_core. L’erreur PydanticSerializationError] est générée.
serialize_as_any Obligatoire	bool Indique s’il faut sérialiser des champs avec un comportement de sérialisation de type canard.
polymorphic_serialization Obligatoire	bool \| None Indique s’il faut utiliser la sérialisation polymorphe de modèle et de classe de données pour cet appel.

Paramètres de mot clé uniquement

Nom	Description
mode	Valeur par défaut: 'python'
include	Valeur par défaut: None
exclude	Valeur par défaut: None
context	Valeur par défaut: None
by_alias	Valeur par défaut: None
exclude_unset	Valeur par défaut: False
exclude_defaults	Valeur par défaut: False
exclude_none	Valeur par défaut: False
exclude_computed_fields	Valeur par défaut: False
round_trip	Valeur par défaut: False
warnings	Valeur par défaut: True
fallback	Valeur par défaut: None
serialize_as_any	Valeur par défaut: False
polymorphic_serialization	Valeur par défaut: None

Retours

Type	Description
dict[str, Any]	Représentation du dictionnaire du modèle.

model_dump_json

!!! abstraite « Documentation sur l’utilisation » model_dump_json

Génère une représentation JSON du modèle à l’aide de la méthode to_json pydantic .

model_dump_json(*, indent: int | None = None, ensure_ascii: bool = False, include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, fallback: Callable[[Any], Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> str

Paramètres

Nom	Description
indent Obligatoire	int \| None Retrait à utiliser dans la sortie JSON. Si aucun n’est passé, la sortie sera compacte.
ensure_ascii Obligatoire	bool Si la valeur est True, la sortie est garantie que tous les caractères non ASCII entrants sont placés en échappement. Si la valeur est False (valeur par défaut), ces caractères sont générés as-is.
include Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None Champs à inclure dans la sortie JSON.
exclude Obligatoire	set[int] \| set[str] \| Mapping[int, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| Mapping[str, set[int] \| set[str] \| Mapping[int, <xref:IncEx> \| bool] \| Mapping[str, <xref:IncEx> \| bool] \| bool] \| None Champs à exclure de la sortie JSON.
context Obligatoire	Any \| None Contexte supplémentaire à passer au sérialiseur.
by_alias Obligatoire	bool \| None Indique s’il faut sérialiser à l’aide d’alias de champ.
exclude_unset Obligatoire	bool Indique s’il faut exclure des champs qui n’ont pas été définis explicitement.
exclude_defaults Obligatoire	bool Indique s’il faut exclure les champs définis sur leur valeur par défaut.
exclude_none Obligatoire	bool Indique s’il faut exclure des champs qui ont la valeur None.
exclude_computed_fields Obligatoire	bool Indique s’il faut exclure les champs calculés. Bien que cela puisse être utile pour l’aller-retour, il est généralement recommandé d’utiliser le paramètre de round_trip dédié à la place.
round_trip Obligatoire	bool Si la valeur est True, les valeurs vidées doivent être valides comme entrée pour les types non idempotents tels que Json[T].
warnings Obligatoire	bool \| Literal['none', 'warn', 'error'] Comment gérer les erreurs de sérialisation. False/"none » ignore ces erreurs, True/"warn » journalise les erreurs, « error » déclenche une [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Obligatoire	Callable[[Any], Any] \| None Fonction à appeler lorsqu’une valeur inconnue est rencontrée. S’il n’est pas fourni, a [PydanticSerializationError][pydantic_core. L’erreur PydanticSerializationError] est générée.
serialize_as_any Obligatoire	bool Indique s’il faut sérialiser des champs avec un comportement de sérialisation de type canard.
polymorphic_serialization Obligatoire	bool \| None Indique s’il faut utiliser la sérialisation polymorphe de modèle et de classe de données pour cet appel.

Paramètres de mot clé uniquement

Nom	Description
indent	Valeur par défaut: None
ensure_ascii	Valeur par défaut: False
include	Valeur par défaut: None
exclude	Valeur par défaut: None
context	Valeur par défaut: None
by_alias	Valeur par défaut: None
exclude_unset	Valeur par défaut: False
exclude_defaults	Valeur par défaut: False
exclude_none	Valeur par défaut: False
exclude_computed_fields	Valeur par défaut: False
round_trip	Valeur par défaut: False
warnings	Valeur par défaut: True
fallback	Valeur par défaut: None
serialize_as_any	Valeur par défaut: False
polymorphic_serialization	Valeur par défaut: None

Retours

Type	Description
str	Représentation sous forme de chaîne JSON du modèle.

model_json_schema

Génère un schéma JSON pour une classe de modèle.

model_json_schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, schema_generator: type[GenerateJsonSchema] = GenerateJsonSchema, mode: Literal['validation', 'serialization'] = 'validation', *, union_format: Literal['any_of', 'primitive_type_array'] = 'any_of') -> dict[str, Any]

Paramètres

Nom	Description
by_alias	bool Indique s’il faut utiliser des alias d’attribut ou non. Valeur par défaut: True
ref_template	str Modèle de référence. Valeur par défaut: DEFAULT_REF_TEMPLATE
union_format Obligatoire	Literal['any_of', 'primitive_type_array'] Format à utiliser lors de la combinaison de schémas à partir d’unions. Peut prendre les valeurs suivantes : 'any_of' : Utiliser l’anyOf mot clé pour combiner des schémas (valeur par défaut). 'primitive_type_array' : utilisez le mot clé de type comme tableau de chaînes contenant chaque type de la combinaison. Si l’un des schémas n’est pas un type primitif (chaîne, booléen, null, entier ou nombre) ou contient des contraintes/métadonnées, revient à any_of.
schema_generator	type[<xref:pydantic.json_schema.GenerateJsonSchema>] Pour remplacer la logique utilisée pour générer le schéma JSON, sous-classe de GenerateJsonSchema avec vos modifications souhaitées Valeur par défaut: GenerateJsonSchema
mode	Literal['validation', 'serialization'] Mode dans lequel générer le schéma. Valeur par défaut: 'validation'

Paramètres de mot clé uniquement

Nom	Description
union_format	Valeur par défaut: 'any_of'

Retours

Type	Description
dict[str, Any]	Schéma JSON pour la classe de modèle donnée.

model_parametrized_name

Calculez le nom de classe pour les paramétrations des classes génériques.

Cette méthode peut être remplacée pour obtenir un schéma d’affectation de noms personnalisé pour les BasesModels génériques.

model_parametrized_name(params: tuple[type[Any], ...]) -> str

Paramètres

Nom	Description
params Obligatoire	tuple[type[Any], ...] Tuple de types de la classe. Étant donné un modèle de classe générique avec 2 variables de type et un modèle concret Model[str, int], la valeur (str, int) est passée à des params.

Retours

Type	Description
str	Chaîne représentant la nouvelle classe où les paramètres sont passés à cls en tant que variables de type.

Exceptions

Type	Description
TypeError	Déclenché lors de la tentative de génération de noms concrets pour les modèles non génériques.

model_post_init

Remplacez cette méthode pour effectuer une initialisation supplémentaire après init et model_construct. Cela est utile si vous souhaitez effectuer une validation qui nécessite l’initialisation de l’ensemble du modèle.

model_post_init(context: Any, /) -> None

Paramètres positionnels uniquement

Nom	Description
context Obligatoire

Paramètres

Nom	Description
context Obligatoire	Any

Retours

Type	Description
None

model_rebuild

Essayez de reconstruire le schéma pydantic-core pour le modèle.

Cela peut être nécessaire lorsque l’une des annotations est un ForwardRef qui n’a pas pu être résolu lors de la tentative initiale de génération du schéma et l’échec de la reconstruction automatique.

model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: MappingNamespace | None = None) -> bool | None

Paramètres

Nom	Description
force Obligatoire	bool Indique s’il faut forcer la reconstruction du schéma du modèle, la valeur par défaut est False.
raise_errors Obligatoire	bool Indique s’il faut déclencher des erreurs par défaut sur True.
_parent_namespace_depth Obligatoire	int Le niveau de profondeur de l’espace de noms parent est défini par défaut sur 2.
_types_namespace Obligatoire	<xref:MappingNamespace> \| None L’espace de noms types est défini par défaut sur None.

Paramètres de mot clé uniquement

Nom	Description
force	Valeur par défaut: False
raise_errors	Valeur par défaut: True
_parent_namespace_depth	Valeur par défaut: 2
_types_namespace	Valeur par défaut: None

Retours

Type	Description
bool \| None	Retourne Aucun si le schéma est déjà « terminé » et que la reconstruction n’a pas été requise. Si la reconstruction a été requise, retourne True si la reconstruction a réussi, sinon False.

model_validate

Validez une instance de modèle pydantic.

model_validate(obj: Any, *, strict: bool | None = None, extra: Literal['allow', 'ignore', 'forbid'] | None = None, from_attributes: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> Self

Paramètres

Nom	Description
obj Obligatoire	Any Objet à valider.
strict Obligatoire	bool \| None Indique s’il faut appliquer strictement des types.
extra Obligatoire	Literal['allow', 'ignore', 'forbid'] \| None Indique s’il faut ignorer, autoriser ou interdire des données supplémentaires pendant la validation du modèle. Consultez la [valeur de configuration supplémentaire ][pydantic. ConfigDict.extra] pour plus d’informations.
from_attributes Obligatoire	bool \| None Indique s’il faut extraire des données à partir d’attributs d’objet.
context Obligatoire	Any \| None Contexte supplémentaire à passer au validateur.
by_alias Obligatoire	bool \| None Indique s’il faut utiliser l’alias du champ lors de la validation sur les données d’entrée fournies.
by_name Obligatoire	bool \| None Indique s’il faut utiliser le nom du champ lors de la validation par rapport aux données d’entrée fournies.

Paramètres de mot clé uniquement

Nom	Description
strict	Valeur par défaut: None
extra	Valeur par défaut: None
from_attributes	Valeur par défaut: None
context	Valeur par défaut: None
by_alias	Valeur par défaut: None
by_name	Valeur par défaut: None

Retours

Type	Description
Self	Instance de modèle validée.

Exceptions

Type	Description
ValidationError	Si l’objet n’a pas pu être validé.

model_validate_json

!!! analyse JSON abstraite de la « documentation d’utilisation »

Validez les données JSON données données par rapport au modèle Pydantic.

model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, extra: Literal['allow', 'ignore', 'forbid'] | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> Self

Paramètres

Nom	Description
json_data Obligatoire	str \| bytes \| bytearray Données JSON à valider.
strict Obligatoire	bool \| None Indique s’il faut appliquer strictement des types.
extra Obligatoire	Literal['allow', 'ignore', 'forbid'] \| None Indique s’il faut ignorer, autoriser ou interdire des données supplémentaires pendant la validation du modèle. Consultez la [valeur de configuration supplémentaire ][pydantic. ConfigDict.extra] pour plus d’informations.
context Obligatoire	Any \| None Variables supplémentaires à passer au validateur.
by_alias Obligatoire	bool \| None Indique s’il faut utiliser l’alias du champ lors de la validation sur les données d’entrée fournies.
by_name Obligatoire	bool \| None Indique s’il faut utiliser le nom du champ lors de la validation par rapport aux données d’entrée fournies.

Paramètres de mot clé uniquement

Nom	Description
strict	Valeur par défaut: None
extra	Valeur par défaut: None
context	Valeur par défaut: None
by_alias	Valeur par défaut: None
by_name	Valeur par défaut: None

Retours

Type	Description
Self	Modèle Pydantic validé.

Exceptions

Type	Description
ValidationError	Si json_data n’est pas une chaîne JSON ou si l’objet n’a pas pu être validé.

model_validate_strings

Validez l’objet donné avec des données de chaîne sur le modèle Pydantic.

model_validate_strings(obj: Any, *, strict: bool | None = None, extra: Literal['allow', 'ignore', 'forbid'] | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> Self

Paramètres

Nom	Description
obj Obligatoire	Any Objet contenant des données de chaîne à valider.
strict Obligatoire	bool \| None Indique s’il faut appliquer strictement des types.
extra Obligatoire	Literal['allow', 'ignore', 'forbid'] \| None Indique s’il faut ignorer, autoriser ou interdire des données supplémentaires pendant la validation du modèle. Consultez la [valeur de configuration supplémentaire ][pydantic. ConfigDict.extra] pour plus d’informations.
context Obligatoire	Any \| None Variables supplémentaires à passer au validateur.
by_alias Obligatoire	bool \| None Indique s’il faut utiliser l’alias du champ lors de la validation sur les données d’entrée fournies.
by_name Obligatoire	bool \| None Indique s’il faut utiliser le nom du champ lors de la validation par rapport aux données d’entrée fournies.

Paramètres de mot clé uniquement

Nom	Description
strict	Valeur par défaut: None
extra	Valeur par défaut: None
context	Valeur par défaut: None
by_alias	Valeur par défaut: None
by_name	Valeur par défaut: None

Retours

Type	Description
Self	Modèle Pydantic validé.

not_empty

Vérifiez que les champs de chaîne ne sont pas vides ou espaces blancs uniquement.

validator not_empty  »  message_id, user_message, conversation_id

Paramètres

Nom	Description
v Obligatoire	str

Retours

Type	Description
str

parse_file

parse_file(path: str | Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) -> Self

Paramètres

Nom	Description
path Obligatoire	str \| <xref:Path>
content_type Obligatoire	str \| None
encoding Obligatoire	str
proto Obligatoire	<xref:DeprecatedParseProtocol> \| None
allow_pickle Obligatoire	bool

Paramètres de mot clé uniquement

Nom	Description
content_type	Valeur par défaut: None
encoding	Valeur par défaut: 'utf8'
proto	Valeur par défaut: None
allow_pickle	Valeur par défaut: False

Retours

Type	Description
Self

parse_obj

parse_obj(obj: Any) -> Self

Paramètres

Nom	Description
obj Obligatoire	Any

Retours

Type	Description
Self

parse_raw

parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) -> Self

Paramètres

Nom	Description
b Obligatoire	str \| bytes
content_type Obligatoire	str \| None
encoding Obligatoire	str
proto Obligatoire	<xref:DeprecatedParseProtocol> \| None
allow_pickle Obligatoire	bool

Paramètres de mot clé uniquement

Nom	Description
content_type	Valeur par défaut: None
encoding	Valeur par défaut: 'utf8'
proto	Valeur par défaut: None
allow_pickle	Valeur par défaut: False

Retours

Type	Description
Self

schema

schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE) -> Dict[str, Any]

Paramètres

Nom	Description
by_alias	bool Valeur par défaut: True
ref_template	str Valeur par défaut: DEFAULT_REF_TEMPLATE

Retours

Type	Description
Dict[str, Any]

schema_json

schema_json(*, by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, **dumps_kwargs: Any) -> str

Paramètres

Nom	Description
by_alias Obligatoire	bool
ref_template Obligatoire	str
dumps_kwargs Obligatoire	Any

Paramètres de mot clé uniquement

Nom	Description
by_alias	Valeur par défaut: True
ref_template	Valeur par défaut: DEFAULT_REF_TEMPLATE

Retours

Type	Description
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

Paramètres

Nom	Description
localns Obligatoire	Any

Retours

Type	Description
None

validate

validate(value: Any) -> Self

Paramètres

Nom	Description
value Obligatoire	Any

Retours

Type	Description
Self

Attributs

model_extra

Obtenir des champs supplémentaires définis pendant la validation.

Retours

Type	Description
	Dictionnaire de champs supplémentaires ou Aucun si config.extra n’est pas défini sur « allow ».

model_fields_set

Retourne l’ensemble de champs qui ont été explicitement définis sur cette instance de modèle.

Retours

Type	Description
	Ensemble de chaînes représentant les champs qui ont été définis, c’est-à-dire qui n’ont pas été remplis à partir des valeurs par défaut.

conversation_id

Identifiant unique de la conversation.

field conversation_id: str [Required] (alias 'conversationId')

message_id

Identificateur unique du message actuel.

field message_id: str [Required] (alias 'messageId')

user_message

Message utilisateur actuel en cours de traitement.

field user_message: str [Required] (alias 'userMessage')

chat_history

Liste des messages précédents dans la conversation.

field chat_history: List[ChatHistoryMessage] [Required] (alias 'chatHistory')