ChatMessageRequest Klasse

Fordern Sie Nutzlast zum Senden des Chatverlaufs an die MCP-Plattform an.

Dieses Modell stellt den vollständigen Anforderungstext dar, der an den Chatverlaufsendpunkt der MCP-Plattform zur Analyse des Bedrohungsschutzes gesendet wird. Sie enthält den aktuellen Unterhaltungskontext und historische Nachrichten.

Das Modell verwendet Feldaliasen, um nach Bedarf der MCP-Plattform-API in das CamelCase JSON-Format zu serialisieren.

Konstruktor

pydantic model ChatMessageRequest

Nur Schlüsselwortparameter

Name	Beschreibung
conversationId Erforderlich
messageId Erforderlich
userMessage Erforderlich
chatHistory Erforderlich

Beispiele


>>> 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'

Methoden

__init__	Erstellen Sie ein neues Modell, indem Sie Eingabedaten aus Schlüsselwortargumenten analysieren und validieren. Löst [ValidationError][pydantic_core. ValidationError] wenn die Eingabedaten nicht überprüft werden können, um ein gültiges Modell zu bilden. self ist explizit positional, um selbst als Feldnamen zuzulassen.
__new__
construct
copy	Gibt eine Kopie des Modells zurück. !!! Warnung "Veraltet" Diese Methode ist jetzt veraltet; verwenden Sie stattdessen model_copy . Wenn Sie Folgendes einschließen oder ausschließen müssen, verwenden Sie Folgendes: `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	Erstellt eine neue Instanz der Model-Klasse mit überprüften Daten. Erstellt ein neues Modelleinstellungsdict und pydantic_fields_set aus vertrauenswürdigen oder vorab überprüften Daten. Standardwerte werden beachtet, aber es wird keine andere Überprüfung durchgeführt. !!! Beachten Sie model_construct() im Allgemeinen die Einstellung model_config.extra für das bereitgestellte Modell berücksichtigt. Das heißt, wenn model_config.extra == 'allow', dann werden alle zusätzlichen übergebenen Werte dem Diktat und pydantic_extra Feldern der Modellinstanz hinzugefügt. Wenn model_config.extra == 'ignore' (Standard) ist, werden alle zusätzlichen übergebenen Werte ignoriert. Da keine Überprüfung mit einem Aufruf von model_construct()durchgeführt wird, führt model_config.extra == "forbid" nicht zu einem Fehler, wenn zusätzliche Werte übergeben werden, aber sie werden ignoriert.
model_copy	!!! abstrakte "Nutzungsdokumentation" model_copy Gibt eine Kopie des Modells zurück. !!! beachten Sie die [dict][-Objekt] der zugrunde liegenden Instanz.dict]-Attribut wird kopiert. Dies kann unerwartete Nebenwirkungen haben, wenn Sie etwas in ihr speichern, über den Modellfeldern (z. B. den Wert von [zwischengespeicherten Eigenschaften][functools.cached_property]).
model_dump	!!! abstrakte "Nutzungsdokumentation" model_dump Generieren Sie eine Wörterbuchdarstellung des Modells, optional angeben, welche Felder eingeschlossen oder ausgeschlossen werden sollen.
model_dump_json	!!! abstrakte "Verwendungsdokumentation" model_dump_json Generiert eine JSON-Darstellung des Modells mithilfe der to_json-Methode von Pydantic.
model_json_schema	Generiert ein JSON-Schema für eine Modellklasse.
model_parametrized_name	Berechnen Sie den Klassennamen für Parametrisierungen generischer Klassen. Diese Methode kann überschrieben werden, um ein benutzerdefiniertes Benennungsschema für generische BaseModels zu erreichen.
model_post_init	Überschreiben Sie diese Methode, um zusätzliche Initialisierung nach init und model_construct durchzuführen. Dies ist nützlich, wenn Sie eine Überprüfung durchführen möchten, für die das gesamte Modell initialisiert werden muss.
model_rebuild	Versuchen Sie, das pydantische Kernschema für das Modell neu zu erstellen. Dies kann erforderlich sein, wenn es sich bei einer der Anmerkungen um eine ForwardRef handelt, die beim ersten Versuch, das Schema zu erstellen, nicht aufgelöst werden konnte, und die automatische Neuerstellung fehlschlägt.
model_validate	Überprüfen einer pydantischen Modellinstanz.
model_validate_json	!!! abstrakte " Verwendungsdokumentation" JSON-Analyse Überprüfen Sie die angegebenen JSON-Daten anhand des Pydantischen Modells.
model_validate_strings	Überprüfen Sie das angegebene Objekt mit Zeichenfolgendaten für das Pydantische Modell.
not_empty	Überprüfen Sie, ob Zeichenfolgenfelder nicht leer oder nur Leerzeichen sind.
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

init

Erstellen Sie ein neues Modell, indem Sie Eingabedaten aus Schlüsselwortargumenten analysieren und validieren.

Löst [ValidationError][pydantic_core. ValidationError] wenn die Eingabedaten nicht überprüft werden können, um ein gültiges Modell zu bilden.

self ist explizit positional, um selbst als Feldnamen zuzulassen.

__init__(**data: Any) -> None

Parameter

Name	Beschreibung
data Erforderlich	Any

Gibt zurück

Typ	Beschreibung
None

new

__new__(**kwargs)

construct

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

Parameter

Name	Beschreibung
_fields_set	set[str] \| None Standardwert: None
values Erforderlich	Any

Gibt zurück

Typ	Beschreibung
Self

copy

Gibt eine Kopie des Modells zurück.

!!! Warnung "Veraltet" Diese Methode ist jetzt veraltet; verwenden Sie stattdessen model_copy .

Wenn Sie Folgendes einschließen oder ausschließen müssen, verwenden Sie Folgendes:

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

Parameter

Name	Beschreibung
include Erforderlich	<xref:AbstractSetIntStr> \| <xref:MappingIntStrAny> \| None Optionaler Satz oder eine Zuordnung, die angibt, welche Felder in das kopierte Modell eingeschlossen werden sollen.
exclude Erforderlich	<xref:AbstractSetIntStr> \| <xref:MappingIntStrAny> \| None Optionaler Satz oder eine Zuordnung, die angibt, welche Felder im kopierten Modell ausgeschlossen werden sollen.
update Erforderlich	Dict[str, Any] \| None Optionales Wörterbuch von Feldwertpaaren zum Überschreiben von Feldwerten im kopierten Modell.
deep Erforderlich	bool Wenn True, werden die Werte von Feldern, die Pydantische Modelle sind, tief kopiert.

Nur Schlüsselwortparameter

Name	Beschreibung
include	Standardwert: None
exclude	Standardwert: None
update	Standardwert: None
deep	Standardwert: False

Gibt zurück

Typ	Beschreibung
Self	Eine Kopie des Modells mit eingeschlossenen, ausgeschlossenen und aktualisierten Feldern wie angegeben.

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]

Parameter

Name	Beschreibung
include Erforderlich	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 Erforderlich	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 Erforderlich	bool
exclude_unset Erforderlich	bool
exclude_defaults Erforderlich	bool
exclude_none Erforderlich	bool

Nur Schlüsselwortparameter

Name	Beschreibung
include	Standardwert: None
exclude	Standardwert: None
by_alias	Standardwert: False
exclude_unset	Standardwert: False
exclude_defaults	Standardwert: False
exclude_none	Standardwert: False

Gibt zurück

Typ	Beschreibung
Dict[str, Any]

from_orm

from_orm(obj: Any) -> Self

Parameter

Name	Beschreibung
obj Erforderlich	Any

Gibt zurück

Typ	Beschreibung
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

Parameter

Name	Beschreibung
include Erforderlich	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 Erforderlich	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 Erforderlich	bool
exclude_unset Erforderlich	bool
exclude_defaults Erforderlich	bool
exclude_none Erforderlich	bool
encoder Erforderlich	Callable[[Any], Any] \| None
models_as_dict Erforderlich	bool
dumps_kwargs Erforderlich	Any

Nur Schlüsselwortparameter

Name	Beschreibung
include	Standardwert: None
exclude	Standardwert: None
by_alias	Standardwert: False
exclude_unset	Standardwert: False
exclude_defaults	Standardwert: False
exclude_none	Standardwert: False
encoder	Standardwert: PydanticUndefined
models_as_dict	Standardwert: PydanticUndefined

Gibt zurück

Typ	Beschreibung
str

model_construct

Erstellt eine neue Instanz der Model-Klasse mit überprüften Daten.

Erstellt ein neues Modelleinstellungsdict und pydantic_fields_set aus vertrauenswürdigen oder vorab überprüften Daten. Standardwerte werden beachtet, aber es wird keine andere Überprüfung durchgeführt.

!!! Beachten Sie model_construct() im Allgemeinen die Einstellung model_config.extra für das bereitgestellte Modell berücksichtigt. Das heißt, wenn model_config.extra == 'allow', dann werden alle zusätzlichen übergebenen Werte dem Diktat und pydantic_extra Feldern der Modellinstanz hinzugefügt. Wenn model_config.extra == 'ignore' (Standard) ist, werden alle zusätzlichen übergebenen Werte ignoriert. Da keine Überprüfung mit einem Aufruf von model_construct()durchgeführt wird, führt model_config.extra == "forbid" nicht zu einem Fehler, wenn zusätzliche Werte übergeben werden, aber sie werden ignoriert.

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

Parameter

Name	Beschreibung
_fields_set	set[str] \| None Eine Reihe von Feldnamen, die ursprünglich während der Instanziierung explizit festgelegt wurden. Falls angegeben, wird dies direkt für die [model_fields_set][pydantisch] verwendet. BaseModel.model_fields_set]-Attribut. Andernfalls werden die Feldnamen aus dem Argument "Werte " verwendet. Standardwert: None
values Erforderlich	Any Vertrauenswürdiges oder vorab überprüftes Datenwörterbuch.

Gibt zurück

Typ	Beschreibung
Self	Eine neue Instanz der Model-Klasse mit überprüften Daten.

model_copy

!!! abstrakte "Nutzungsdokumentation" model_copy

Gibt eine Kopie des Modells zurück.

!!! beachten Sie die [dict][-Objekt] der zugrunde liegenden Instanz.dict]-Attribut wird kopiert. Dies kann unerwartete Nebenwirkungen haben, wenn Sie etwas in ihr speichern, über den Modellfeldern (z. B. den Wert von [zwischengespeicherten Eigenschaften][functools.cached_property]).

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

Parameter

Name	Beschreibung
update Erforderlich	Mapping[str, Any] \| None Werte, die im neuen Modell geändert/hinzugefügt werden sollen. Hinweis: Die Daten werden vor dem Erstellen des neuen Modells nicht überprüft. Sie sollten diesen Daten vertrauen.
deep Erforderlich	bool Legen Sie den Wert auf "True" fest, um eine tiefe Kopie des Modells zu erstellen.

Nur Schlüsselwortparameter

Name	Beschreibung
update	Standardwert: None
deep	Standardwert: False

Gibt zurück

Typ	Beschreibung
Self	Neue Modellinstanz.

model_dump

!!! abstrakte "Nutzungsdokumentation" model_dump

Generieren Sie eine Wörterbuchdarstellung des Modells, optional angeben, welche Felder eingeschlossen oder ausgeschlossen werden sollen.

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]

Parameter

Name	Beschreibung
mode Erforderlich	Literal['json', 'python'] \| str Der Modus, in dem to_python ausgeführt werden soll. Wenn der Modus "json" lautet, enthält die Ausgabe nur serialisierbare JSON-Typen. Wenn der Modus "python" lautet, kann die Ausgabe nicht-JSON-serialisierbare Python-Objekte enthalten.
include Erforderlich	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 Eine Reihe von Feldern, die in die Ausgabe eingeschlossen werden sollen.
exclude Erforderlich	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 Eine Gruppe von Feldern, die von der Ausgabe ausgeschlossen werden sollen.
context Erforderlich	Any \| None Zusätzlicher Kontext, der an den Serialisierer übergeben werden soll.
by_alias Erforderlich	bool \| None Gibt an, ob der Alias des Felds im Wörterbuchschlüssel verwendet werden soll, falls definiert.
exclude_unset Erforderlich	bool Gibt an, ob Felder ausgeschlossen werden sollen, die nicht explizit festgelegt wurden.
exclude_defaults Erforderlich	bool Gibt an, ob Felder ausgeschlossen werden sollen, die auf ihren Standardwert festgelegt sind.
exclude_none Erforderlich	bool Gibt an, ob Felder mit dem Wert "None" ausgeschlossen werden sollen.
exclude_computed_fields Erforderlich	bool Gibt an, ob berechnete Felder ausgeschlossen werden sollen. Dies kann zwar für Roundtripping hilfreich sein, es wird jedoch in der Regel empfohlen, stattdessen den dedizierten round_trip Parameter zu verwenden.
round_trip Erforderlich	bool Wenn True, sollten dumpierte Werte als Eingabe für Nicht-idempotent-Typen wie Json[T] gültig sein.
warnings Erforderlich	bool \| Literal['none', 'warn', 'error'] Behandeln von Serialisierungsfehlern False/"none" ignoriert sie, True/"warn" protokolliert Fehler, "error" löst ein [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Erforderlich	Callable[[Any], Any] \| None Eine Funktion, die aufgerufen werden soll, wenn ein unbekannter Wert gefunden wird. Wenn nicht angegeben, ist ein [PydanticSerializationError][pydantic_core. PydanticSerializationError]-Fehler wird ausgelöst.
serialize_as_any Erforderlich	bool Gibt an, ob Felder mit dem Serialisierungsverhalten der Ententypisierung serialisiert werden sollen.
polymorphic_serialization Erforderlich	bool \| None Gibt an, ob modell- und dataclass polymorphe Serialisierung für diesen Aufruf verwendet werden soll.

Nur Schlüsselwortparameter

Name	Beschreibung
mode	Standardwert: 'python'
include	Standardwert: None
exclude	Standardwert: None
context	Standardwert: None
by_alias	Standardwert: None
exclude_unset	Standardwert: False
exclude_defaults	Standardwert: False
exclude_none	Standardwert: False
exclude_computed_fields	Standardwert: False
round_trip	Standardwert: False
warnings	Standardwert: True
fallback	Standardwert: None
serialize_as_any	Standardwert: False
polymorphic_serialization	Standardwert: None

Gibt zurück

Typ	Beschreibung
dict[str, Any]	Eine Wörterbuchdarstellung des Modells.

model_dump_json

!!! abstrakte "Verwendungsdokumentation" model_dump_json

Generiert eine JSON-Darstellung des Modells mithilfe der to_json-Methode von 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

Parameter

Name	Beschreibung
indent Erforderlich	int \| None Einzug, der in der JSON-Ausgabe verwendet werden soll. Wenn Keine übergeben wird, wird die Ausgabe kompakt.
ensure_ascii Erforderlich	bool Wenn True, wird die Ausgabe garantiert, dass alle eingehenden Nicht-ASCII-Zeichen escaped sind. Wenn False (Standardeinstellung) werden diese Zeichen as-isausgegeben.
include Erforderlich	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 Felder, die in die JSON-Ausgabe eingeschlossen werden sollen.
exclude Erforderlich	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 Felder, die von der JSON-Ausgabe ausgeschlossen werden sollen.
context Erforderlich	Any \| None Zusätzlicher Kontext, der an den Serialisierer übergeben werden soll.
by_alias Erforderlich	bool \| None Gibt an, ob die Serialisierung mithilfe von Feldaliasen erfolgt.
exclude_unset Erforderlich	bool Gibt an, ob Felder ausgeschlossen werden sollen, die nicht explizit festgelegt wurden.
exclude_defaults Erforderlich	bool Gibt an, ob Felder ausgeschlossen werden sollen, die auf ihren Standardwert festgelegt sind.
exclude_none Erforderlich	bool Gibt an, ob Felder mit dem Wert "None" ausgeschlossen werden sollen.
exclude_computed_fields Erforderlich	bool Gibt an, ob berechnete Felder ausgeschlossen werden sollen. Dies kann zwar für Roundtripping hilfreich sein, es wird jedoch in der Regel empfohlen, stattdessen den dedizierten round_trip Parameter zu verwenden.
round_trip Erforderlich	bool Wenn True, sollten dumpierte Werte als Eingabe für Nicht-idempotent-Typen wie Json[T] gültig sein.
warnings Erforderlich	bool \| Literal['none', 'warn', 'error'] Behandeln von Serialisierungsfehlern False/"none" ignoriert sie, True/"warn" protokolliert Fehler, "error" löst ein [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Erforderlich	Callable[[Any], Any] \| None Eine Funktion, die aufgerufen werden soll, wenn ein unbekannter Wert gefunden wird. Wenn nicht angegeben, ist ein [PydanticSerializationError][pydantic_core. PydanticSerializationError]-Fehler wird ausgelöst.
serialize_as_any Erforderlich	bool Gibt an, ob Felder mit dem Serialisierungsverhalten der Ententypisierung serialisiert werden sollen.
polymorphic_serialization Erforderlich	bool \| None Gibt an, ob modell- und dataclass polymorphe Serialisierung für diesen Aufruf verwendet werden soll.

Nur Schlüsselwortparameter

Name	Beschreibung
indent	Standardwert: None
ensure_ascii	Standardwert: False
include	Standardwert: None
exclude	Standardwert: None
context	Standardwert: None
by_alias	Standardwert: None
exclude_unset	Standardwert: False
exclude_defaults	Standardwert: False
exclude_none	Standardwert: False
exclude_computed_fields	Standardwert: False
round_trip	Standardwert: False
warnings	Standardwert: True
fallback	Standardwert: None
serialize_as_any	Standardwert: False
polymorphic_serialization	Standardwert: None

Gibt zurück

Typ	Beschreibung
str	Eine JSON-Zeichenfolgendarstellung des Modells.

model_json_schema

Generiert ein JSON-Schema für eine Modellklasse.

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]

Parameter

Name	Beschreibung
by_alias	bool Gibt an, ob Attributalias verwendet werden sollen. Standardwert: True
ref_template	str Die Referenzvorlage. Standardwert: DEFAULT_REF_TEMPLATE
union_format Erforderlich	Literal['any_of', 'primitive_type_array'] Das Format, das beim Kombinieren von Schemas aus Gewerkschaften verwendet werden soll. Kann eine der folgenden sein: 'any_of': Verwenden Sie anyOf Schlüsselwort zum Kombinieren von Schemas (Standard). 'primitive_type_array': Verwenden Sie das Typschlüsselwort als Array von Zeichenfolgen, die jeden Typ der Kombination enthalten. Wenn eines der Schemas kein Grundtyp (Zeichenfolge, boolescher Wert, null, ganze Zahl) oder Einschränkungen/Metadaten enthält, fällt auf any_of zurück.
schema_generator	type[<xref:pydantic.json_schema.GenerateJsonSchema>] So überschreiben Sie die Logik, die zum Generieren des JSON-Schemas verwendet wird, als Unterklasse von GenerateJsonSchema mit den gewünschten Änderungen Standardwert: GenerateJsonSchema
mode	Literal['validation', 'serialization'] Der Modus, in dem das Schema generiert werden soll. Standardwert: 'validation'

Nur Schlüsselwortparameter

Name	Beschreibung
union_format	Standardwert: 'any_of'

Gibt zurück

Typ	Beschreibung
dict[str, Any]	Das JSON-Schema für die angegebene Modellklasse.

model_parametrized_name

Berechnen Sie den Klassennamen für Parametrisierungen generischer Klassen.

Diese Methode kann überschrieben werden, um ein benutzerdefiniertes Benennungsschema für generische BaseModels zu erreichen.

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

Parameter

Name	Beschreibung
params Erforderlich	tuple[type[Any], ...] Tupel von Typen der Klasse. Angesichts eines generischen Klassenmodells mit 2 Typvariablen und einem konkreten Modellmodell[str, int], wird der Wert (str, int) an Params übergeben.

Gibt zurück

Typ	Beschreibung
str	Zeichenfolge, die die neue Klasse darstellt, in der Params als Typvariablen an Cls übergeben werden.

Ausnahmen

Typ	Beschreibung
TypeError	Wird ausgelöst, wenn versucht wird, konkrete Namen für nicht generische Modelle zu generieren.

model_post_init

Überschreiben Sie diese Methode, um zusätzliche Initialisierung nach init und model_construct durchzuführen. Dies ist nützlich, wenn Sie eine Überprüfung durchführen möchten, für die das gesamte Modell initialisiert werden muss.

model_post_init(context: Any, /) -> None

Nur Positionsparameter

Name	Beschreibung
context Erforderlich

Parameter

Name	Beschreibung
context Erforderlich	Any

Gibt zurück

Typ	Beschreibung
None

model_rebuild

Versuchen Sie, das pydantische Kernschema für das Modell neu zu erstellen.

Dies kann erforderlich sein, wenn es sich bei einer der Anmerkungen um eine ForwardRef handelt, die beim ersten Versuch, das Schema zu erstellen, nicht aufgelöst werden konnte, und die automatische Neuerstellung fehlschlägt.

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

Parameter

Name	Beschreibung
force Erforderlich	bool Gibt an, ob die Neuerstellung des Modellschemas erzwungen werden soll, standardmäßig auf "False".
raise_errors Erforderlich	bool Gibt an, ob Fehler angezeigt werden sollen, standardmäßig auf "True".
_parent_namespace_depth Erforderlich	int Die Tiefenebene des übergeordneten Namespaces ist standardmäßig 2.
_types_namespace Erforderlich	<xref:MappingNamespace> \| None Der Typennamespace ist standardmäßig "None".

Nur Schlüsselwortparameter

Name	Beschreibung
force	Standardwert: False
raise_errors	Standardwert: True
_parent_namespace_depth	Standardwert: 2
_types_namespace	Standardwert: None

Gibt zurück

Typ	Beschreibung
bool \| None	Gibt "None " zurück, wenn das Schema bereits "vollständig" ist und die Neuerstellung nicht erforderlich war. Wenn die Neuerstellung erforderlich war , gibt True zurück, wenn die Neuerstellung erfolgreich war, andernfalls False.

model_validate

Überprüfen einer pydantischen Modellinstanz.

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

Parameter

Name	Beschreibung
obj Erforderlich	Any Das zu überprüfende Objekt.
strict Erforderlich	bool \| None Gibt an, ob Typen streng erzwungen werden sollen.
extra Erforderlich	Literal['allow', 'ignore', 'forbid'] \| None Gibt an, ob zusätzliche Daten während der Modellüberprüfung ignoriert, zugelassen oder untersagt werden sollen. Siehe den [zusätzlichen Konfigurationswert][pydantisch. ConfigDict.extra] für Details.
from_attributes Erforderlich	bool \| None Gibt an, ob Daten aus Objektattributen extrahiert werden sollen.
context Erforderlich	Any \| None Zusätzlicher Kontext, der an den Validator übergeben werden soll.
by_alias Erforderlich	bool \| None Gibt an, ob der Alias des Felds beim Überprüfen anhand der bereitgestellten Eingabedaten verwendet werden soll.
by_name Erforderlich	bool \| None Gibt an, ob der Name des Felds beim Überprüfen anhand der bereitgestellten Eingabedaten verwendet werden soll.

Nur Schlüsselwortparameter

Name	Beschreibung
strict	Standardwert: None
extra	Standardwert: None
from_attributes	Standardwert: None
context	Standardwert: None
by_alias	Standardwert: None
by_name	Standardwert: None

Gibt zurück

Typ	Beschreibung
Self	Die überprüfte Modellinstanz.

Ausnahmen

Typ	Beschreibung
ValidationError	Wenn das Objekt nicht überprüft werden konnte.

model_validate_json

!!! abstrakte " Verwendungsdokumentation" JSON-Analyse

Überprüfen Sie die angegebenen JSON-Daten anhand des Pydantischen Modells.

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

Parameter

Name	Beschreibung
json_data Erforderlich	str \| bytes \| bytearray Die zu überprüfenden JSON-Daten.
strict Erforderlich	bool \| None Gibt an, ob Typen streng erzwungen werden sollen.
extra Erforderlich	Literal['allow', 'ignore', 'forbid'] \| None Gibt an, ob zusätzliche Daten während der Modellüberprüfung ignoriert, zugelassen oder untersagt werden sollen. Siehe den [zusätzlichen Konfigurationswert][pydantisch. ConfigDict.extra] für Details.
context Erforderlich	Any \| None Zusätzliche Variablen, die an den Validator übergeben werden sollen.
by_alias Erforderlich	bool \| None Gibt an, ob der Alias des Felds beim Überprüfen anhand der bereitgestellten Eingabedaten verwendet werden soll.
by_name Erforderlich	bool \| None Gibt an, ob der Name des Felds beim Überprüfen anhand der bereitgestellten Eingabedaten verwendet werden soll.

Nur Schlüsselwortparameter

Name	Beschreibung
strict	Standardwert: None
extra	Standardwert: None
context	Standardwert: None
by_alias	Standardwert: None
by_name	Standardwert: None

Gibt zurück

Typ	Beschreibung
Self	Das validierte Pydantische Modell.

Ausnahmen

Typ	Beschreibung
ValidationError	Wenn json_data keine JSON-Zeichenfolge ist oder das Objekt nicht überprüft werden konnte.

model_validate_strings

Überprüfen Sie das angegebene Objekt mit Zeichenfolgendaten für das Pydantische Modell.

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

Parameter

Name	Beschreibung
obj Erforderlich	Any Das Objekt, das zu überprüfende Zeichenfolgendaten enthält.
strict Erforderlich	bool \| None Gibt an, ob Typen streng erzwungen werden sollen.
extra Erforderlich	Literal['allow', 'ignore', 'forbid'] \| None Gibt an, ob zusätzliche Daten während der Modellüberprüfung ignoriert, zugelassen oder untersagt werden sollen. Siehe den [zusätzlichen Konfigurationswert][pydantisch. ConfigDict.extra] für Details.
context Erforderlich	Any \| None Zusätzliche Variablen, die an den Validator übergeben werden sollen.
by_alias Erforderlich	bool \| None Gibt an, ob der Alias des Felds beim Überprüfen anhand der bereitgestellten Eingabedaten verwendet werden soll.
by_name Erforderlich	bool \| None Gibt an, ob der Name des Felds beim Überprüfen anhand der bereitgestellten Eingabedaten verwendet werden soll.

Nur Schlüsselwortparameter

Name	Beschreibung
strict	Standardwert: None
extra	Standardwert: None
context	Standardwert: None
by_alias	Standardwert: None
by_name	Standardwert: None

Gibt zurück

Typ	Beschreibung
Self	Das validierte Pydantische Modell.

not_empty

Überprüfen Sie, ob Zeichenfolgenfelder nicht leer oder nur Leerzeichen sind.

validator not_empty  »  message_id, user_message, conversation_id

Parameter

Name	Beschreibung
v Erforderlich	str

Gibt zurück

Typ	Beschreibung
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

Parameter

Name	Beschreibung
path Erforderlich	str \| <xref:Path>
content_type Erforderlich	str \| None
encoding Erforderlich	str
proto Erforderlich	<xref:DeprecatedParseProtocol> \| None
allow_pickle Erforderlich	bool

Nur Schlüsselwortparameter

Name	Beschreibung
content_type	Standardwert: None
encoding	Standardwert: 'utf8'
proto	Standardwert: None
allow_pickle	Standardwert: False

Gibt zurück

Typ	Beschreibung
Self

parse_obj

parse_obj(obj: Any) -> Self

Parameter

Name	Beschreibung
obj Erforderlich	Any

Gibt zurück

Typ	Beschreibung
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

Parameter

Name	Beschreibung
b Erforderlich	str \| bytes
content_type Erforderlich	str \| None
encoding Erforderlich	str
proto Erforderlich	<xref:DeprecatedParseProtocol> \| None
allow_pickle Erforderlich	bool

Nur Schlüsselwortparameter

Name	Beschreibung
content_type	Standardwert: None
encoding	Standardwert: 'utf8'
proto	Standardwert: None
allow_pickle	Standardwert: False

Gibt zurück

Typ	Beschreibung
Self

schema

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

Parameter

Name	Beschreibung
by_alias	bool Standardwert: True
ref_template	str Standardwert: DEFAULT_REF_TEMPLATE

Gibt zurück

Typ	Beschreibung
Dict[str, Any]

schema_json

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

Parameter

Name	Beschreibung
by_alias Erforderlich	bool
ref_template Erforderlich	str
dumps_kwargs Erforderlich	Any

Nur Schlüsselwortparameter

Name	Beschreibung
by_alias	Standardwert: True
ref_template	Standardwert: DEFAULT_REF_TEMPLATE

Gibt zurück

Typ	Beschreibung
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

Parameter

Name	Beschreibung
localns Erforderlich	Any

Gibt zurück

Typ	Beschreibung
None

validate

validate(value: Any) -> Self

Parameter

Name	Beschreibung
value Erforderlich	Any

Gibt zurück

Typ	Beschreibung
Self

Attribute

model_extra

Erhalten Sie zusätzliche Felder, die während der Überprüfung festgelegt wurden.

Gibt zurück

Typ	Beschreibung
	Ein Wörterbuch mit zusätzlichen Feldern oder "None ", wenn "config.extra " nicht auf "zulassen" festgelegt ist.

model_fields_set

Gibt den Satz von Feldern zurück, die für diese Modellinstanz explizit festgelegt wurden.

Gibt zurück

Typ	Beschreibung
	Eine Reihe von Zeichenfolgen, die die festgelegten Felder darstellen, d. h., die nicht aus Standardwerten gefüllt wurden.

conversation_id

Eindeutige Kennung für die Konversation.

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

message_id

Eindeutiger Bezeichner für die aktuelle Nachricht.

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

user_message

Die aktuelle Benutzernachricht, die verarbeitet wird.

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

chat_history

Liste der vorherigen Nachrichten in der Unterhaltung.

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