ChatMessageRequest Klas

Nettolading aanvragen voor het verzenden van de chatgeschiedenis naar het MCP-platform.

Dit model vertegenwoordigt de volledige aanvraagbody die is verzonden naar het eindpunt van de chatgeschiedenis van het MCP-platform voor analyse van bedreigingsbeveiliging. Het bevat de huidige gesprekscontext en historische berichten.

Het model maakt gebruik van veldaliassen om te serialiseren naar camelCase JSON-indeling zoals vereist door de MCP-platform-API.

Constructor

pydantic model ChatMessageRequest

Keyword-Only Parameters

Name Description
conversationId
Vereist
messageId
Vereist
userMessage
Vereist
chatHistory
Vereist

Voorbeelden


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

Maak een nieuw model door invoergegevens van trefwoordargumenten te parseren en valideren.

Genereert [ValidationError][pydantic_core. ValidationError] als de invoergegevens niet kunnen worden gevalideerd om een geldig model te vormen.

zelf is expliciet positioneel om zichzelf als veldnaam toe te staan.
__new__
construct
copy

Retourneert een kopie van het model.

!!! waarschuwing 'Afgeschaft' Deze methode is nu afgeschaft; gebruik in plaats daarvan model_copy .

Als u opnemen of uitsluiten nodig hebt, gebruikt u:

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

Hiermee maakt u een nieuw exemplaar van de modelklasse met gevalideerde gegevens.

Hiermee maakt u een nieuwe modelinstellingsdicteerfunctie en pydantic_fields_set op basis van vertrouwde of vooraf gevalideerde gegevens. Standaardwaarden worden gerespecteerd, maar er wordt geen andere validatie uitgevoerd.

!!! let op model_construct() over het algemeen de instelling model_config.extra respecteert voor het opgegeven model. Als model_config.extra == toestaan, worden alle extra doorgegeven waarden toegevoegd aan de dict en pydantic_extra velden van het modelexemplaren. Als model_config.extra == 'negeren' (de standaardinstelling), worden alle extra doorgegeven waarden genegeerd. Omdat er geen validatie wordt uitgevoerd met een aanroep naar model_construct(), resulteert het hebben van model_config.extra == 'verbieden' niet in een fout als er extra waarden worden doorgegeven, maar worden ze genegeerd.
model_copy

!!! abstracte gebruiksdocumentatie model_copy

Retourneert een kopie van het model.

!!! Noteer het [dict][object van het onderliggende exemplaar.het kenmerk dict] wordt gekopieerd. Dit kan onverwachte bijwerkingen hebben als u er iets in opslaat, boven op de modelvelden (bijvoorbeeld de waarde van [eigenschappen in cache][functools.cached_property]).
model_dump

!!! abstracte gebruiksdocumentatie model_dump

Genereer een woordenlijstweergave van het model, eventueel opgeven welke velden moeten worden opgenomen of uitgesloten.
model_dump_json

!!! abstracte gebruiksdocumentatie model_dump_json

Genereert een JSON-weergave van het model met behulp van de to_json methode van Pydantic.
model_json_schema

Hiermee genereert u een JSON-schema voor een modelklasse.
model_parametrized_name

Bereken de klassenaam voor parametrisaties van algemene klassen.

Deze methode kan worden overschreven om een aangepast naamgevingsschema voor algemene BaseModels te bereiken.
model_post_init

Overschrijf deze methode om extra initialisatie uit te voeren na init en model_construct. Dit is handig als u een validatie wilt uitvoeren waarvoor het hele model moet worden geïnitialiseerd.
model_rebuild

Probeer het pydantic-core-schema voor het model opnieuw op te bouwen.

Dit kan nodig zijn wanneer een van de aantekeningen een ForwardRef is die niet kan worden opgelost tijdens de eerste poging om het schema te bouwen en het automatisch opnieuw opbouwen mislukt.
model_validate

Valideer een pydantisch modelexemplaren.
model_validate_json

!!! abstracte JSON-parsering voor gebruiksdocumentatie

Valideer de opgegeven JSON-gegevens op basis van het Pydantic-model.
model_validate_strings

Valideer het opgegeven object met tekenreeksgegevens op basis van het Pydantic-model.
not_empty

Controleer of tekenreeksvelden niet leeg of alleen witruimte zijn.
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

__init__

Maak een nieuw model door invoergegevens van trefwoordargumenten te parseren en valideren.

Genereert [ValidationError][pydantic_core. ValidationError] als de invoergegevens niet kunnen worden gevalideerd om een geldig model te vormen.

zelf is expliciet positioneel om zichzelf als veldnaam toe te staan.

__init__(**data: Any) -> None

Parameters

Name Description
data
Vereist
Any

Retouren

Type Description
None

__new__ 

__new__(**kwargs)

construct 

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

Parameters

Name Description
_fields_set
set[str] | None
Default value: None
values
Vereist
Any

Retouren

Type Description
Self

copy

Retourneert een kopie van het model.

!!! waarschuwing 'Afgeschaft' Deze methode is nu afgeschaft; gebruik in plaats daarvan model_copy .

Als u opnemen of uitsluiten nodig hebt, gebruikt u:

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

Parameters

Name Description
include
Vereist
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

Optionele set of toewijzing die aangeeft welke velden moeten worden opgenomen in het gekopieerde model.
exclude
Vereist
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

Optionele set of toewijzing die aangeeft welke velden moeten worden uitgesloten in het gekopieerde model.
update
Vereist
Dict[str, Any] | None

Optionele woordenlijst van veld-waardeparen om veldwaarden in het gekopieerde model te overschrijven.
deep
Vereist
bool

Indien waar, worden de waarden van velden die Pydantic-modellen zijn, diep gekopieerd.

Keyword-Only Parameters

Name Description
include
Default value: None
exclude
Default value: None
update
Default value: None
deep
Default value: False

Retouren

Type Description
Self

Een kopie van het model met opgenomen, uitgesloten en bijgewerkte velden zoals opgegeven.

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]

Parameters

Name Description
include
Vereist
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
Vereist
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
Vereist
bool
exclude_unset
Vereist
bool
exclude_defaults
Vereist
bool
exclude_none
Vereist
bool

Keyword-Only Parameters

Name Description
include
Default value: None
exclude
Default value: None
by_alias
Default value: False
exclude_unset
Default value: False
exclude_defaults
Default value: False
exclude_none
Default value: False

Retouren

Type Description
Dict[str, Any]

from_orm 

from_orm(obj: Any) -> Self

Parameters

Name Description
obj
Vereist
Any

Retouren

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

Parameters

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

Keyword-Only Parameters

Name Description
include
Default value: None
exclude
Default value: None
by_alias
Default value: False
exclude_unset
Default value: False
exclude_defaults
Default value: False
exclude_none
Default value: False
encoder
Default value: PydanticUndefined
models_as_dict
Default value: PydanticUndefined

Retouren

Type Description
str

model_construct

Hiermee maakt u een nieuw exemplaar van de modelklasse met gevalideerde gegevens.

Hiermee maakt u een nieuwe modelinstellingsdicteerfunctie en pydantic_fields_set op basis van vertrouwde of vooraf gevalideerde gegevens. Standaardwaarden worden gerespecteerd, maar er wordt geen andere validatie uitgevoerd.

!!! let op model_construct() over het algemeen de instelling model_config.extra respecteert voor het opgegeven model. Als model_config.extra == toestaan, worden alle extra doorgegeven waarden toegevoegd aan de dict en pydantic_extra velden van het modelexemplaren. Als model_config.extra == 'negeren' (de standaardinstelling), worden alle extra doorgegeven waarden genegeerd. Omdat er geen validatie wordt uitgevoerd met een aanroep naar model_construct(), resulteert het hebben van model_config.extra == 'verbieden' niet in een fout als er extra waarden worden doorgegeven, maar worden ze genegeerd.

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

Parameters

Name Description
_fields_set
set[str] | None

Een set veldnamen die oorspronkelijk expliciet zijn ingesteld tijdens de instantiëring. Indien opgegeven, wordt dit rechtstreeks gebruikt voor de [model_fields_set][pydantic. BaseModel.model_fields_set] kenmerk. Anders worden de veldnamen uit het argument waarden gebruikt.

Default value: None
values
Vereist
Any

Vertrouwde of vooraf gevalideerde gegevenswoordenlijst.

Retouren

Type Description
Self

Een nieuw exemplaar van de modelklasse met gevalideerde gegevens.

model_copy

!!! abstracte gebruiksdocumentatie model_copy

Retourneert een kopie van het model.

!!! Noteer het [dict][object van het onderliggende exemplaar.het kenmerk dict] wordt gekopieerd. Dit kan onverwachte bijwerkingen hebben als u er iets in opslaat, boven op de modelvelden (bijvoorbeeld de waarde van [eigenschappen in cache][functools.cached_property]).

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

Parameters

Name Description
update
Vereist
Mapping[str, Any] | None

Waarden om het nieuwe model te wijzigen/toe te voegen. Opmerking: de gegevens worden niet gevalideerd voordat het nieuwe model wordt gemaakt. U moet deze gegevens vertrouwen.
deep
Vereist
bool

Stel in op True om een diepe kopie van het model te maken.

Keyword-Only Parameters

Name Description
update
Default value: None
deep
Default value: False

Retouren

Type Description
Self

Nieuw modelexemplaren.

model_dump

!!! abstracte gebruiksdocumentatie model_dump

Genereer een woordenlijstweergave van het model, eventueel opgeven welke velden moeten worden opgenomen of uitgesloten.

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]

Parameters

Name Description
mode
Vereist
Literal['json', 'python'] | str

De modus waarin to_python moet worden uitgevoerd. Als de modus 'json' is, bevat de uitvoer alleen serialiseerbare typen JSON. Als de modus python is, kan de uitvoer niet-JSON-serialiseerbare Python-objecten bevatten.
include
Vereist
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

Een set velden die moeten worden opgenomen in de uitvoer.
exclude
Vereist
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

Een set velden die moeten worden uitgesloten van de uitvoer.
context
Vereist
Any | None

Aanvullende context die moet worden doorgegeven aan de serializer.
by_alias
Vereist
bool | None

Of u de alias van het veld wilt gebruiken in de woordenlijstsleutel, indien gedefinieerd.
exclude_unset
Vereist
bool

Of u velden wilt uitsluiten die niet expliciet zijn ingesteld.
exclude_defaults
Vereist
bool

Of u velden wilt uitsluiten die zijn ingesteld op de standaardwaarde.
exclude_none
Vereist
bool

Of u velden wilt uitsluiten met de waarde Geen.
exclude_computed_fields
Vereist
bool

Of berekende velden moeten worden uitgesloten. Hoewel dit handig kan zijn voor roundtripping, wordt het meestal aanbevolen om in plaats daarvan de toegewezen round_trip parameter te gebruiken.
round_trip
Vereist
bool

Indien Waar, moeten gedumpte waarden geldig zijn als invoer voor niet-idempotente typen, zoals Json[T].
warnings
Vereist
bool | Literal['none', 'warn', 'error']

Serialisatiefouten afhandelen. False/"none" negeert deze, waar/'waarschuwen' registreert fouten, 'fout' genereert een [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback
Vereist
Callable[[Any], Any] | None

Een functie die moet worden aangeroepen wanneer een onbekende waarde wordt aangetroffen. Indien niet opgegeven, een [PydanticSerializationError][pydantic_core. De fout PydanticSerializationError] wordt gegenereerd.
serialize_as_any
Vereist
bool

Of u velden wilt serialiseren met serialisatiegedrag van eenden.
polymorphic_serialization
Vereist
bool | None

Of u voor deze aanroep polymorfe serialisatie van modellen en gegevensklassen wilt gebruiken.

Keyword-Only Parameters

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

Retouren

Type Description
dict[str, Any]

Een woordenlijstweergave van het model.

model_dump_json

!!! abstracte gebruiksdocumentatie model_dump_json

Genereert een JSON-weergave van het model met behulp van de to_json methode van 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

Parameters

Name Description
indent
Vereist
int | None

Inspringing die moet worden gebruikt in de JSON-uitvoer. Als Geen wordt doorgegeven, wordt de uitvoer gecomprimeerd.
ensure_ascii
Vereist
bool

Als waar is, is de uitvoer gegarandeerd dat alle binnenkomende niet-ASCII-tekens zijn ontsnapt. Als Onwaar (de standaardinstelling) worden deze tekens uitgevoerd as-is.
include
Vereist
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

Velden die moeten worden opgenomen in de JSON-uitvoer.
exclude
Vereist
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

Velden die moeten worden uitgesloten van de JSON-uitvoer.
context
Vereist
Any | None

Aanvullende context die moet worden doorgegeven aan de serializer.
by_alias
Vereist
bool | None

Of u wilt serialiseren met veldaliassen.
exclude_unset
Vereist
bool

Of u velden wilt uitsluiten die niet expliciet zijn ingesteld.
exclude_defaults
Vereist
bool

Of u velden wilt uitsluiten die zijn ingesteld op de standaardwaarde.
exclude_none
Vereist
bool

Of u velden wilt uitsluiten met de waarde Geen.
exclude_computed_fields
Vereist
bool

Of berekende velden moeten worden uitgesloten. Hoewel dit handig kan zijn voor roundtripping, wordt het meestal aanbevolen om in plaats daarvan de toegewezen round_trip parameter te gebruiken.
round_trip
Vereist
bool

Indien Waar, moeten gedumpte waarden geldig zijn als invoer voor niet-idempotente typen, zoals Json[T].
warnings
Vereist
bool | Literal['none', 'warn', 'error']

Serialisatiefouten afhandelen. False/"none" negeert deze, waar/'waarschuwen' registreert fouten, 'fout' genereert een [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback
Vereist
Callable[[Any], Any] | None

Een functie die moet worden aangeroepen wanneer een onbekende waarde wordt aangetroffen. Indien niet opgegeven, een [PydanticSerializationError][pydantic_core. De fout PydanticSerializationError] wordt gegenereerd.
serialize_as_any
Vereist
bool

Of u velden wilt serialiseren met serialisatiegedrag van eenden.
polymorphic_serialization
Vereist
bool | None

Of u voor deze aanroep polymorfe serialisatie van modellen en gegevensklassen wilt gebruiken.

Keyword-Only Parameters

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

Retouren

Type Description
str

Een JSON-tekenreeksweergave van het model.

model_json_schema

Hiermee genereert u een JSON-schema voor een modelklasse.

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]

Parameters

Name Description
by_alias
bool

Of u nu kenmerkaliassen wilt gebruiken of niet.

Default value: True
ref_template
str

De referentiesjabloon.

Default value: DEFAULT_REF_TEMPLATE
union_format
Vereist
Literal['any_of', 'primitive_type_array']

De indeling die moet worden gebruikt bij het combineren van schema's van samenvoegingen. Dit kan een van de volgende zijn:

  • 'any_of': gebruik de anyOf

trefwoord voor het combineren van schema's (de standaardinstelling).

  • 'primitive_type_array': gebruik het trefwoord van het type als een matrix met tekenreeksen, met elk type combinatie. Als een van de schema's geen primitief type is (tekenreeks, booleaanse waarde, null, geheel getal of getal) of beperkingen/metagegevens bevat, valt u terug op any_of.
schema_generator
type[<xref:pydantic.json_schema.GenerateJsonSchema>]

De logica overschrijven die wordt gebruikt om het JSON-schema te genereren, als subklasse van GenerateJsonSchema met de gewenste wijzigingen

Default value: GenerateJsonSchema
mode
Literal['validation', 'serialization']

De modus waarin het schema moet worden gegenereerd.

Default value: 'validation'

Keyword-Only Parameters

Name Description
union_format
Default value: 'any_of'

Retouren

Type Description
dict[str, Any]

Het JSON-schema voor de opgegeven modelklasse.

model_parametrized_name

Bereken de klassenaam voor parametrisaties van algemene klassen.

Deze methode kan worden overschreven om een aangepast naamgevingsschema voor algemene BaseModels te bereiken.

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

Parameters

Name Description
params
Vereist
tuple[type[Any], ...]

Tuple van typen van de klasse. Gezien een algemeen klassemodel met twee typevariabelen en een betonmodelmodel[str, int], wordt de waarde (str, int) doorgegeven aan parameters.

Retouren

Type Description
str

Tekenreeks die de nieuwe klasse aangeeft waarin parameters als typevariabelen worden doorgegeven aan cls .

Uitzonderingen

Type Description
TypeError

Verhoogd bij het genereren van concrete namen voor niet-generieke modellen.

model_post_init

Overschrijf deze methode om extra initialisatie uit te voeren na init en model_construct. Dit is handig als u een validatie wilt uitvoeren waarvoor het hele model moet worden geïnitialiseerd.

model_post_init(context: Any, /) -> None

Positional-Only Parameters

Name Description
context
Vereist

Parameters

Name Description
context
Vereist
Any

Retouren

Type Description
None

model_rebuild

Probeer het pydantic-core-schema voor het model opnieuw op te bouwen.

Dit kan nodig zijn wanneer een van de aantekeningen een ForwardRef is die niet kan worden opgelost tijdens de eerste poging om het schema te bouwen en het automatisch opnieuw opbouwen mislukt.

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

Parameters

Name Description
force
Vereist
bool

Of het opnieuw samenstellen van het modelschema moet worden afgedwongen, wordt standaard ingesteld op False.
raise_errors
Vereist
bool

Of u fouten wilt genereren, wordt standaard ingesteld op Waar.
_parent_namespace_depth
Vereist
int

Het diepteniveau van de bovenliggende naamruimte is standaard ingesteld op 2.
_types_namespace
Vereist
<xref:MappingNamespace> | None

De typen naamruimte, wordt standaard ingesteld op Geen.

Keyword-Only Parameters

Name Description
force
Default value: False
raise_errors
Default value: True
_parent_namespace_depth
Default value: 2
_types_namespace
Default value: None

Retouren

Type Description
bool | None

Retourneert Geen als het schema al 'voltooid' is en herbouwen niet is vereist. Als herbouwen is vereist, retourneert u Waar als het opnieuw opbouwen is geslaagd, anders Onwaar.

model_validate

Valideer een pydantisch modelexemplaren.

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

Parameters

Name Description
obj
Vereist
Any

Het object dat moet worden gevalideerd.
strict
Vereist
bool | None

Of typen strikt moeten worden afgedwongen.
extra
Vereist
Literal['allow', 'ignore', 'forbid'] | None

Of u extra gegevens tijdens modelvalidatie wilt negeren, toestaan of verbieden. Zie de [extra configuratiewaarde][pydantic. ConfigDict.extra] voor meer informatie.
from_attributes
Vereist
bool | None

Of gegevens moeten worden geëxtraheerd uit objectkenmerken.
context
Vereist
Any | None

Aanvullende context die moet worden doorgegeven aan de validator.
by_alias
Vereist
bool | None

Of u de alias van het veld wilt gebruiken bij het valideren van de opgegeven invoergegevens.
by_name
Vereist
bool | None

Of u de naam van het veld wilt gebruiken bij het valideren van de opgegeven invoergegevens.

Keyword-Only Parameters

Name Description
strict
Default value: None
extra
Default value: None
from_attributes
Default value: None
context
Default value: None
by_alias
Default value: None
by_name
Default value: None

Retouren

Type Description
Self

Het gevalideerde modelexemplaren.

Uitzonderingen

Type Description
ValidationError

Als het object niet kan worden gevalideerd.

model_validate_json

!!! abstracte JSON-parsering voor gebruiksdocumentatie

Valideer de opgegeven JSON-gegevens op basis van het Pydantic-model.

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

Parameters

Name Description
json_data
Vereist
str | bytes | bytearray

De JSON-gegevens die moeten worden gevalideerd.
strict
Vereist
bool | None

Of typen strikt moeten worden afgedwongen.
extra
Vereist
Literal['allow', 'ignore', 'forbid'] | None

Of u extra gegevens tijdens modelvalidatie wilt negeren, toestaan of verbieden. Zie de [extra configuratiewaarde][pydantic. ConfigDict.extra] voor meer informatie.
context
Vereist
Any | None

Extra variabelen die aan de validator moeten worden doorgegeven.
by_alias
Vereist
bool | None

Of u de alias van het veld wilt gebruiken bij het valideren van de opgegeven invoergegevens.
by_name
Vereist
bool | None

Of u de naam van het veld wilt gebruiken bij het valideren van de opgegeven invoergegevens.

Keyword-Only Parameters

Name Description
strict
Default value: None
extra
Default value: None
context
Default value: None
by_alias
Default value: None
by_name
Default value: None

Retouren

Type Description
Self

Het gevalideerde Pydantic-model.

Uitzonderingen

Type Description
ValidationError

Als json_data geen JSON-tekenreeks is of het object niet kan worden gevalideerd.

model_validate_strings

Valideer het opgegeven object met tekenreeksgegevens op basis van het Pydantic-model.

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

Parameters

Name Description
obj
Vereist
Any

Het object met tekenreeksgegevens die moeten worden gevalideerd.
strict
Vereist
bool | None

Of typen strikt moeten worden afgedwongen.
extra
Vereist
Literal['allow', 'ignore', 'forbid'] | None

Of u extra gegevens tijdens modelvalidatie wilt negeren, toestaan of verbieden. Zie de [extra configuratiewaarde][pydantic. ConfigDict.extra] voor meer informatie.
context
Vereist
Any | None

Extra variabelen die aan de validator moeten worden doorgegeven.
by_alias
Vereist
bool | None

Of u de alias van het veld wilt gebruiken bij het valideren van de opgegeven invoergegevens.
by_name
Vereist
bool | None

Of u de naam van het veld wilt gebruiken bij het valideren van de opgegeven invoergegevens.

Keyword-Only Parameters

Name Description
strict
Default value: None
extra
Default value: None
context
Default value: None
by_alias
Default value: None
by_name
Default value: None

Retouren

Type Description
Self

Het gevalideerde Pydantic-model.

not_empty

Controleer of tekenreeksvelden niet leeg of alleen witruimte zijn.

validator not_empty  »  message_id, conversation_id, user_message

Parameters

Name Description
v
Vereist
str

Retouren

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

Parameters

Name Description
path
Vereist
str | <xref:Path>
content_type
Vereist
str | None
encoding
Vereist
str
proto
Vereist
<xref:DeprecatedParseProtocol> | None
allow_pickle
Vereist
bool

Keyword-Only Parameters

Name Description
content_type
Default value: None
encoding
Default value: 'utf8'
proto
Default value: None
allow_pickle
Default value: False

Retouren

Type Description
Self

parse_obj 

parse_obj(obj: Any) -> Self

Parameters

Name Description
obj
Vereist
Any

Retouren

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

Parameters

Name Description
b
Vereist
str | bytes
content_type
Vereist
str | None
encoding
Vereist
str
proto
Vereist
<xref:DeprecatedParseProtocol> | None
allow_pickle
Vereist
bool

Keyword-Only Parameters

Name Description
content_type
Default value: None
encoding
Default value: 'utf8'
proto
Default value: None
allow_pickle
Default value: False

Retouren

Type Description
Self

schema 

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

Parameters

Name Description
by_alias
bool
Default value: True
ref_template
str
Default value: DEFAULT_REF_TEMPLATE

Retouren

Type Description
Dict[str, Any]

schema_json 

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

Parameters

Name Description
by_alias
Vereist
bool
ref_template
Vereist
str
dumps_kwargs
Vereist
Any

Keyword-Only Parameters

Name Description
by_alias
Default value: True
ref_template
Default value: DEFAULT_REF_TEMPLATE

Retouren

Type Description
str

update_forward_refs 

update_forward_refs(**localns: Any) -> None

Parameters

Name Description
localns
Vereist
Any

Retouren

Type Description
None

validate 

validate(value: Any) -> Self

Parameters

Name Description
value
Vereist
Any

Retouren

Type Description
Self

Kenmerken

model_extra

Extra velden instellen tijdens de validatie.

Retouren

Type Description

Een woordenlijst met extra velden of Geen als config.extra niet is ingesteld op Toestaan.

model_fields_set

Retourneert de set velden die expliciet zijn ingesteld op dit modelexemplaren.

Retouren

Type Description

Een reeks tekenreeksen die de velden vertegenwoordigen die zijn ingesteld, d.w. die niet zijn ingevuld vanuit de standaardinstellingen.

conversation_id

Unieke ID voor het gesprek.

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

message_id

Unieke id voor het huidige bericht.

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

user_message

Het huidige gebruikersbericht dat wordt verwerkt.

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

chat_history

Lijst met eerdere berichten in het gesprek.

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