ChatMessageRequest Klasse

Be om nyttelast for å sende chatteloggen til MCP-plattformen.

Denne modellen representerer hele forespørselsteksten som sendes til MCP-plattformens chatloggendepunkt for trusselbeskyttelsesanalyse. Den inneholder gjeldende samtalekontekst og historiske meldinger.

Modellen bruker feltaliaser til å serialisere til camelCase JSON-format som kreves av MCP-plattform-API-en.

Konstruktør

pydantic model ChatMessageRequest

Parametere med kun nøkkelord

Navn Beskrivelse
conversationId
Obligatorisk
messageId
Obligatorisk
userMessage
Obligatorisk
chatHistory
Obligatorisk

Eksempler


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

Metoder

__init__

Opprett en ny modell ved å analysere og validere inndata fra nøkkelordargumenter.

Hever [ValidationError][pydantic_core. ValidationError] hvis inndata ikke kan valideres for å danne en gyldig modell.

selv er eksplisitt posisjonsbasert for å tillate seg selv som et feltnavn.

__new__
construct
copy

Returnerer en kopi av modellen.

!!! advarsel «Avskrevet» Denne metoden er nå avskrevet. bruk model_copy i stedet.

Hvis du trenger å inkludere eller ekskludere, kan du bruke:

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

Oppretter en ny forekomst av modellklassen med validerte data.

Oppretter en ny modellinnstillingsindeks og pydantic_fields_set fra klarerte eller forhåndsvaliderte data. Standardverdier respekteres, men ingen annen validering utføres.

!!! obs! model_construct() respekterer generelt model_config.extra-innstillingen på den angitte modellen. Hvis model_config.extra == «tillat», legges alle ekstra overførte verdier til modellforekomstens diktering og pydantic_extra felt. Hvis model_config.extra == "ignorer" (standard), ignoreres alle ekstra overførte verdier. Fordi ingen validering utføres med et kall til model_construct(), vil det å ha model_config.extra == "forbid" ikke resultere i en feil hvis ekstra verdier sendes, men de vil bli ignorert.

model_copy

!!! abstrakt «Bruksdokumentasjon» -model_copy

Returnerer en kopi av modellen.

!!! obs! Den underliggende forekomstens [dikt][objekt.dict]-attributtet kopieres. Dette kan ha uventede bivirkninger hvis du lagrer noe i det, øverst i modellfeltene (f.eks. verdien av [bufrede egenskaper][functools.cached_property]).

model_dump

!!! abstrakt «Bruksdokumentasjon» -model_dump

Generer en ordlistepresentasjon av modellen, og angi eventuelt hvilke felt som skal inkluderes eller utelates.

model_dump_json

!!! abstrakt «Bruksdokumentasjon» -model_dump_json

Genererer en JSON-representasjon av modellen ved hjelp av Pydantics to_json metode.

model_json_schema

Genererer et JSON-skjema for en modellklasse.

model_parametrized_name

Beregne klassenavnet for parametriseringer av generiske klasser.

Denne metoden kan overstyres for å oppnå et egendefinert navnevalg for generiske BaseModels.

model_post_init

Overstyr denne metoden for å utføre ytterligere initialisering etter init og model_construct. Dette er nyttig hvis du vil utføre en validering som krever at hele modellen initialiseres.

model_rebuild

Prøv å gjenoppbygge det pydantiske kjerneskjemaet for modellen.

Dette kan være nødvendig når en av merknadene er en ForwardRef som ikke kunne løses under det første forsøket på å bygge skjemaet, og automatisk ombygging mislykkes.

model_validate

Valider en pydantisk modellforekomst.

model_validate_json

!!! abstrakt « Bruksdokumentasjon» JSON-analyse

Valider de angitte JSON-dataene mot Pydantic-modellen.

model_validate_strings

Valider det angitte objektet med strengdata mot Pydantic-modellen.

not_empty

Valider at strengfelt ikke er tomme eller bare mellomrom.

parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

__init__

Opprett en ny modell ved å analysere og validere inndata fra nøkkelordargumenter.

Hever [ValidationError][pydantic_core. ValidationError] hvis inndata ikke kan valideres for å danne en gyldig modell.

selv er eksplisitt posisjonsbasert for å tillate seg selv som et feltnavn.

__init__(**data: Any) -> None

Parametere

Navn Beskrivelse
data
Obligatorisk
Any

Returnerer

Type Beskrivelse

__new__

__new__(**kwargs)

construct

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

Parametere

Navn Beskrivelse
_fields_set
set[str] | None
Default value: None
values
Obligatorisk
Any

Returnerer

Type Beskrivelse

copy

Returnerer en kopi av modellen.

!!! advarsel «Avskrevet» Denne metoden er nå avskrevet. bruk model_copy i stedet.

Hvis du trenger å inkludere eller ekskludere, kan du bruke:

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

Parametere

Navn Beskrivelse
include
Obligatorisk
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

Valgfritt sett eller tilordning som angir hvilke felt som skal inkluderes i den kopierte modellen.

exclude
Obligatorisk
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

Valgfritt sett eller tilordning som angir hvilke felt som skal utelates i den kopierte modellen.

update
Obligatorisk

Valgfri ordliste med feltverdipar for å overstyre feltverdier i den kopierte modellen.

deep
Obligatorisk

Hvis Sann, kopieres verdiene for felt som er Pydantic-modeller.

Parametere med kun nøkkelord

Navn Beskrivelse
include
Default value: None
exclude
Default value: None
update
Default value: None
deep
Default value: False

Returnerer

Type Beskrivelse

En kopi av modellen med inkluderte, utelatte og oppdaterte felt som angitt.

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]

Parametere

Navn Beskrivelse
include
Obligatorisk
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
Obligatorisk
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
Obligatorisk
exclude_unset
Obligatorisk
exclude_defaults
Obligatorisk
exclude_none
Obligatorisk

Parametere med kun nøkkelord

Navn Beskrivelse
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

Returnerer

Type Beskrivelse

from_orm

from_orm(obj: Any) -> Self

Parametere

Navn Beskrivelse
obj
Obligatorisk
Any

Returnerer

Type Beskrivelse

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

Parametere

Navn Beskrivelse
include
Obligatorisk
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
Obligatorisk
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
Obligatorisk
exclude_unset
Obligatorisk
exclude_defaults
Obligatorisk
exclude_none
Obligatorisk
encoder
Obligatorisk
models_as_dict
Obligatorisk
dumps_kwargs
Obligatorisk
Any

Parametere med kun nøkkelord

Navn Beskrivelse
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

Returnerer

Type Beskrivelse
str

model_construct

Oppretter en ny forekomst av modellklassen med validerte data.

Oppretter en ny modellinnstillingsindeks og pydantic_fields_set fra klarerte eller forhåndsvaliderte data. Standardverdier respekteres, men ingen annen validering utføres.

!!! obs! model_construct() respekterer generelt model_config.extra-innstillingen på den angitte modellen. Hvis model_config.extra == «tillat», legges alle ekstra overførte verdier til modellforekomstens diktering og pydantic_extra felt. Hvis model_config.extra == "ignorer" (standard), ignoreres alle ekstra overførte verdier. Fordi ingen validering utføres med et kall til model_construct(), vil det å ha model_config.extra == "forbid" ikke resultere i en feil hvis ekstra verdier sendes, men de vil bli ignorert.

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

Parametere

Navn Beskrivelse
_fields_set
set[str] | None

Et sett med feltnavn som opprinnelig ble eksplisitt angitt under integulering. Hvis angitt, brukes dette direkte for [model_fields_set][pydantic. BaseModel.model_fields_set]-attributtet. Ellers brukes feltnavnene fra verdiargumentet .

Default value: None
values
Obligatorisk
Any

Klarert eller forhånds validert dataordliste.

Returnerer

Type Beskrivelse

En ny forekomst av modellklassen med validerte data.

model_copy

!!! abstrakt «Bruksdokumentasjon» -model_copy

Returnerer en kopi av modellen.

!!! obs! Den underliggende forekomstens [dikt][objekt.dict]-attributtet kopieres. Dette kan ha uventede bivirkninger hvis du lagrer noe i det, øverst i modellfeltene (f.eks. verdien av [bufrede egenskaper][functools.cached_property]).

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

Parametere

Navn Beskrivelse
update
Obligatorisk

Verdier som skal endres/legges til i den nye modellen. Obs! Dataene valideres ikke før du oppretter den nye modellen. Du bør klarere disse dataene.

deep
Obligatorisk

Sett til Sann for å lage en dyp kopi av modellen.

Parametere med kun nøkkelord

Navn Beskrivelse
update
Default value: None
deep
Default value: False

Returnerer

Type Beskrivelse

Ny modellforekomst.

model_dump

!!! abstrakt «Bruksdokumentasjon» -model_dump

Generer en ordlistepresentasjon av modellen, og angi eventuelt hvilke felt som skal inkluderes eller utelates.

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]

Parametere

Navn Beskrivelse
mode
Obligatorisk
Literal['json', 'python'] | str

Modusen der to_python skal kjøres. Hvis modus er json, vil utdataene bare inneholde JSON-serialiserbare typer. Hvis modus er python, kan utdataene inneholde python-objekter som ikke er JSON-serialiserbare.

include
Obligatorisk
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

Et sett med felt som skal inkluderes i utdataene.

exclude
Obligatorisk
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

Et sett med felt som skal utelates fra utdataene.

context
Obligatorisk
Any | None

Ekstra kontekst som skal sendes til serialisereren.

by_alias
Obligatorisk

Om du vil bruke feltets alias i ordlistenøkkelen hvis definert.

exclude_unset
Obligatorisk

Om du vil utelate felt som ikke er eksplisitt angitt.

exclude_defaults
Obligatorisk

Om du vil utelate felt som er satt til standardverdien.

exclude_none
Obligatorisk

Om du vil utelate felt som har en verdi av Ingen.

exclude_computed_fields
Obligatorisk

Om beregnede felt skal utelates. Selv om dette kan være nyttig for rund-tripping, anbefales det vanligvis å bruke den dedikerte round_trip parameteren i stedet.

round_trip
Obligatorisk

Hvis Sann, må dumpede verdier være gyldige som inndata for ikke-idempotente typer, for eksempel Json[T].

warnings
Obligatorisk
bool | Literal['none', 'warn', 'error']

Slik håndterer du serialiseringsfeil. False/"none" ignorerer dem, True/"warn" logger feil, "error" hever en [PydanticSerializationError][pydantic_core. PydanticSerializationError].

fallback
Obligatorisk

En funksjon som skal ringes opp når det oppstår en ukjent verdi. Hvis ikke angitt, en [PydanticSerializationError][pydantic_core. PydanticSerializationError]-feilen utløses.

serialize_as_any
Obligatorisk

Om du vil serialisere felt med virkemåte for duck-typing serialisering.

polymorphic_serialization
Obligatorisk

Om du vil bruke polymorf serialisering for modell og dataklasse for dette kallet.

Parametere med kun nøkkelord

Navn Beskrivelse
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

Returnerer

Type Beskrivelse

En ordlistepresentasjon av modellen.

model_dump_json

!!! abstrakt «Bruksdokumentasjon» -model_dump_json

Genererer en JSON-representasjon av modellen ved hjelp av Pydantics to_json metode.

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

Parametere

Navn Beskrivelse
indent
Obligatorisk
int | None

Innrykk som skal brukes i JSON-utdataene. Hvis Ingen sendes, vil utdataene være kompakte.

ensure_ascii
Obligatorisk

Hvis Sann, er utdataene garantert at alle innkommende ikke-ASCII-tegn er rømt. Hvis Usann (standard), vil disse tegnene bli utdata as-is.

include
Obligatorisk
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

Felt som skal inkluderes i JSON-utdataene.

exclude
Obligatorisk
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

Felt som skal utelates fra JSON-utdataene.

context
Obligatorisk
Any | None

Ekstra kontekst som skal sendes til serialisereren.

by_alias
Obligatorisk

Om du vil serialisere ved hjelp av feltaliaser.

exclude_unset
Obligatorisk

Om du vil utelate felt som ikke er eksplisitt angitt.

exclude_defaults
Obligatorisk

Om du vil utelate felt som er satt til standardverdien.

exclude_none
Obligatorisk

Om du vil utelate felt som har en verdi av Ingen.

exclude_computed_fields
Obligatorisk

Om beregnede felt skal utelates. Selv om dette kan være nyttig for rund-tripping, anbefales det vanligvis å bruke den dedikerte round_trip parameteren i stedet.

round_trip
Obligatorisk

Hvis Sann, må dumpede verdier være gyldige som inndata for ikke-idempotente typer, for eksempel Json[T].

warnings
Obligatorisk
bool | Literal['none', 'warn', 'error']

Slik håndterer du serialiseringsfeil. False/"none" ignorerer dem, True/"warn" logger feil, "error" hever en [PydanticSerializationError][pydantic_core. PydanticSerializationError].

fallback
Obligatorisk

En funksjon som skal ringes opp når det oppstår en ukjent verdi. Hvis ikke angitt, en [PydanticSerializationError][pydantic_core. PydanticSerializationError]-feilen utløses.

serialize_as_any
Obligatorisk

Om du vil serialisere felt med virkemåte for duck-typing serialisering.

polymorphic_serialization
Obligatorisk

Om du vil bruke polymorf serialisering for modell og dataklasse for dette kallet.

Parametere med kun nøkkelord

Navn Beskrivelse
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

Returnerer

Type Beskrivelse
str

En JSON-strengpresentasjon av modellen.

model_json_schema

Genererer et JSON-skjema for en 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]

Parametere

Navn Beskrivelse
by_alias

Om du vil bruke attributtaliaser eller ikke.

Default value: True
ref_template
str

Referansemalen.

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

Formatet som skal brukes når du kombinerer skjemaer fra fagforeninger sammen. Kan være én av:

nøkkelord for å kombinere skjemaer (standard).

  • 'primitive_type_array': Bruk typenøkkelordet som en matrise med strenger, som inneholder hver type kombinasjon. Hvis noen av skjemaene ikke er en primitiv type (streng, boolsk, null, heltall eller tall) eller inneholder begrensninger/metadata, faller tilbake til any_of.
schema_generator
type[<xref:pydantic.json_schema.GenerateJsonSchema>]

Hvis du vil overstyre logikken som brukes til å generere JSON-skjemaet, som en underklasse av GenerateJsonSchema med ønskede endringer

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

Modusen som skjemaet skal genereres i.

Default value: 'validation'

Parametere med kun nøkkelord

Navn Beskrivelse
union_format
Default value: 'any_of'

Returnerer

Type Beskrivelse

JSON-skjemaet for den angitte modellklassen.

model_parametrized_name

Beregne klassenavnet for parametriseringer av generiske klasser.

Denne metoden kan overstyres for å oppnå et egendefinert navnevalg for generiske BaseModels.

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

Parametere

Navn Beskrivelse
params
Obligatorisk
tuple[type[Any], ...]

Tuppel av typer av klassen. Gitt en generisk klassemodell med 2 typevariabler og en betongmodellmodell[str, int], sendes verdien (str, int) til params.

Returnerer

Type Beskrivelse
str

Streng som representerer den nye klassen der params sendes til cls som typevariabler.

Unntak

Type Beskrivelse

Opphøyd når du prøver å generere konkrete navn for ikke-generiske modeller.

model_post_init

Overstyr denne metoden for å utføre ytterligere initialisering etter init og model_construct. Dette er nyttig hvis du vil utføre en validering som krever at hele modellen initialiseres.

model_post_init(context: Any, /) -> None

Parametere med kun posisjonelle

Navn Beskrivelse
context
Obligatorisk

Parametere

Navn Beskrivelse
context
Obligatorisk
Any

Returnerer

Type Beskrivelse

model_rebuild

Prøv å gjenoppbygge det pydantiske kjerneskjemaet for modellen.

Dette kan være nødvendig når en av merknadene er en ForwardRef som ikke kunne løses under det første forsøket på å bygge skjemaet, og automatisk ombygging mislykkes.

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

Parametere

Navn Beskrivelse
force
Obligatorisk

Hvis du vil tvinge gjenoppbyggingen av modellskjemaet, brukes usann som standard.

raise_errors
Obligatorisk

Om det skal oppstå feil, er sann som standard.

_parent_namespace_depth
Obligatorisk
int

Dybdenivået for det overordnede navneområdet, som standard til 2.

_types_namespace
Obligatorisk
<xref:MappingNamespace> | None

Typenavneområdet, som standard, er ingen.

Parametere med kun nøkkelord

Navn Beskrivelse
force
Default value: False
raise_errors
Default value: True
_parent_namespace_depth
Default value: 2
_types_namespace
Default value: None

Returnerer

Type Beskrivelse

Returnerer Ingen hvis skjemaet allerede er «fullført» og ombygging ikke var nødvendig. Hvis ombygging var nødvendig, returnerer Sann hvis gjenoppbyggingen var vellykket, ellers usann.

model_validate

Valider en pydantisk modellforekomst.

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

Parametere

Navn Beskrivelse
obj
Obligatorisk
Any

Objektet som skal valideres.

strict
Obligatorisk

Om du vil håndheve typer strengt.

extra
Obligatorisk
Literal['allow', 'ignore', 'forbid'] | None

Om du vil ignorere, tillate eller forby ekstra data under modellvalidering. Se [ekstra konfigurasjonsverdi][pydantisk. ConfigDict.extra] for mer informasjon.

from_attributes
Obligatorisk

Om du vil trekke ut data fra objektattributter.

context
Obligatorisk
Any | None

Ekstra kontekst som skal sendes til validatoren.

by_alias
Obligatorisk

Om du vil bruke feltets alias når du validerer mot de angitte inndata.

by_name
Obligatorisk

Om du vil bruke feltets navn når du validerer mot de angitte inndata.

Parametere med kun nøkkelord

Navn Beskrivelse
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

Returnerer

Type Beskrivelse

Den validerte modellforekomsten.

Unntak

Type Beskrivelse
ValidationError

Hvis objektet ikke kunne valideres.

model_validate_json

!!! abstrakt « Bruksdokumentasjon» JSON-analyse

Valider de angitte JSON-dataene mot Pydantic-modellen.

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

Parametere

Navn Beskrivelse
json_data
Obligatorisk

JSON-dataene som skal valideres.

strict
Obligatorisk

Om du vil håndheve typer strengt.

extra
Obligatorisk
Literal['allow', 'ignore', 'forbid'] | None

Om du vil ignorere, tillate eller forby ekstra data under modellvalidering. Se [ekstra konfigurasjonsverdi][pydantisk. ConfigDict.extra] for mer informasjon.

context
Obligatorisk
Any | None

Ekstra variabler som skal sendes til validatoren.

by_alias
Obligatorisk

Om du vil bruke feltets alias når du validerer mot de angitte inndata.

by_name
Obligatorisk

Om du vil bruke feltets navn når du validerer mot de angitte inndata.

Parametere med kun nøkkelord

Navn Beskrivelse
strict
Default value: None
extra
Default value: None
context
Default value: None
by_alias
Default value: None
by_name
Default value: None

Returnerer

Type Beskrivelse

Den validerte Pydantic-modellen.

Unntak

Type Beskrivelse
ValidationError

Hvis json_data ikke er en JSON-streng eller objektet ikke kan valideres.

model_validate_strings

Valider det angitte objektet med strengdata mot Pydantic-modellen.

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

Parametere

Navn Beskrivelse
obj
Obligatorisk
Any

Objektet som inneholder strengdata som skal valideres.

strict
Obligatorisk

Om du vil håndheve typer strengt.

extra
Obligatorisk
Literal['allow', 'ignore', 'forbid'] | None

Om du vil ignorere, tillate eller forby ekstra data under modellvalidering. Se [ekstra konfigurasjonsverdi][pydantisk. ConfigDict.extra] for mer informasjon.

context
Obligatorisk
Any | None

Ekstra variabler som skal sendes til validatoren.

by_alias
Obligatorisk

Om du vil bruke feltets alias når du validerer mot de angitte inndata.

by_name
Obligatorisk

Om du vil bruke feltets navn når du validerer mot de angitte inndata.

Parametere med kun nøkkelord

Navn Beskrivelse
strict
Default value: None
extra
Default value: None
context
Default value: None
by_alias
Default value: None
by_name
Default value: None

Returnerer

Type Beskrivelse

Den validerte Pydantic-modellen.

not_empty

Valider at strengfelt ikke er tomme eller bare mellomrom.

validator not_empty  »  message_id, conversation_id, user_message

Parametere

Navn Beskrivelse
v
Obligatorisk
str

Returnerer

Type Beskrivelse
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

Parametere

Navn Beskrivelse
path
Obligatorisk
str | <xref:Path>
content_type
Obligatorisk
str | None
encoding
Obligatorisk
str
proto
Obligatorisk
<xref:DeprecatedParseProtocol> | None
allow_pickle
Obligatorisk

Parametere med kun nøkkelord

Navn Beskrivelse
content_type
Default value: None
encoding
Default value: 'utf8'
proto
Default value: None
allow_pickle
Default value: False

Returnerer

Type Beskrivelse

parse_obj

parse_obj(obj: Any) -> Self

Parametere

Navn Beskrivelse
obj
Obligatorisk
Any

Returnerer

Type Beskrivelse

parse_raw

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

Parametere

Navn Beskrivelse
b
Obligatorisk
content_type
Obligatorisk
str | None
encoding
Obligatorisk
str
proto
Obligatorisk
<xref:DeprecatedParseProtocol> | None
allow_pickle
Obligatorisk

Parametere med kun nøkkelord

Navn Beskrivelse
content_type
Default value: None
encoding
Default value: 'utf8'
proto
Default value: None
allow_pickle
Default value: False

Returnerer

Type Beskrivelse

schema

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

Parametere

Navn Beskrivelse
by_alias
Default value: True
ref_template
str
Default value: DEFAULT_REF_TEMPLATE

Returnerer

Type Beskrivelse

schema_json

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

Parametere

Navn Beskrivelse
by_alias
Obligatorisk
ref_template
Obligatorisk
str
dumps_kwargs
Obligatorisk
Any

Parametere med kun nøkkelord

Navn Beskrivelse
by_alias
Default value: True
ref_template
Default value: DEFAULT_REF_TEMPLATE

Returnerer

Type Beskrivelse
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

Parametere

Navn Beskrivelse
localns
Obligatorisk
Any

Returnerer

Type Beskrivelse

validate

validate(value: Any) -> Self

Parametere

Navn Beskrivelse
value
Obligatorisk
Any

Returnerer

Type Beskrivelse

Attributter

model_extra

Få ekstra felt angitt under validering.

Returnerer

Type Beskrivelse

En ordliste med ekstra felt, eller Ingen hvis config.extra ikke er satt til «tillat».

model_fields_set

Returnerer settet med felt som er eksplisitt angitt for denne modellforekomsten.

Returnerer

Type Beskrivelse

Et sett med strenger som representerer feltene som er angitt, dvs. som ikke ble fylt ut fra standarder.

conversation_id

Unik identifikator for samtalen.

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

message_id

Unik identifikator for gjeldende melding.

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

user_message

Den gjeldende brukermeldingen behandles.

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

chat_history

Liste over tidligere meldinger i samtalen.

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