ChatHistoryMessage Luokka

Edustaa yhtä viestiä keskusteluhistoriassa.

Tätä mallia käytetään sieppaamaan yksittäisiä viestejä, jotka vaihdetaan käyttäjien ja tekoälyavustajan välillä uhkien suojaamisen analysoinnissa ja vaatimustenmukaisuuden seurannassa.

Konstruktori

pydantic model ChatHistoryMessage

Keyword-Only-parametrit

Nimi	Description
id	Default value: None
role Pakollinen
content Pakollinen
timestamp	Default value: None

Esimerkit

>>> message = ChatHistoryMessage(role="user", content="Hello, how can you help?")
>>> print(message.role)
'user'
>>> print(message.content)
'Hello, how can you help?'

Menetelmät

__init__	Luo uusi malli jäsentämällä ja vahvistamalla avainsanaargumenttien syötetietoja. Korotukset [ValidationError][pydantic_core. ValidationError], jos syötetietoja ei voida vahvistaa kelvollisen mallin muodostamiseksi. se on eksplisiittisesti vain sijainti , jotta hän voi sallia itsensä kentän nimenä.
__new__
construct
content_not_empty	Varmista, että sisältö ei ole tyhjää tai vain välilyöntiä.
copy	Palauttaa kopion mallista. !!! varoitus "Vanhentunut" Tämä menetelmä on nyt vanhentunut; käyttää model_copy sen sijaan. Jos haluat sisällyttää tai jättää pois, käytä seuraavaa: 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	Luo malliluokan uuden esiintymän vahvistettujen tietojen avulla. Luo uuden malliasetuksen sanelun ja pydantic_fields_set luotettavista tai ennalta vahvistetuista tiedoista. Oletusarvoja noudatetaan, mutta muuta vahvistusta ei suoriteta. !!! huomautus : model_construct() noudattaa yleisesti model_config.extra-asetusta annetussa mallissa. Jos model_config.extra == 'allow', kaikki ylimääräiset välitetty arvot lisätään malliesiintymän sanelun ja pydantic_extra kenttiin. Jos model_config.extra == 'ignore' (oletus), kaikki ylimääräiset välitetyt arvot ohitetaan. Koska model_construct()-kutsulla ei suoriteta vahvistusta, model_config.extra == 'mahdollisuuksien mukaan' ei aiheuta virhettä, jos ylimääräiset arvot välitetään, mutta ne ohitetaan.
model_copy	!!! abstract "Usage Documentation" model_copy Palauttaa kopion mallista. !!! note (huomautus) Pohjana olevan esiintymän [dict][object.dict]-määrite kopioidaan. Tällä voi olla odottamattomia sivuvaikutuksia, jos siihen tallennetaan jotain mallikenttien lisäksi (esim. [välimuistiin tallennettujen ominaisuuksien] arvo[functools.cached_property]).
model_dump	!!! abstract "Usage Documentation" model_dump Luo mallista hakemistoesitys, joka voi valinnaisesti määrittää, mitkä kentät sisällytetään tai jätetään pois.
model_dump_json	!!! abstract "Usage Documentation" model_dump_json Luo mallista JSON-esityksen Pydanticin to_json -menetelmällä.
model_json_schema	Luo JSON-rakenteen malliluokalle.
model_parametrized_name	Laske luokan nimi yleisten luokkien parametrisaatioille. Tämä menetelmä voidaan ohittaa, jotta yleisille BaseModels-muodoille saadaan mukautettu nimeämismalli.
model_post_init	Ohita tämä menetelmä, jos haluat tehdä lisä alustuksen alustuksen jälkeen ja model_construct. Tästä on hyötyä, jos haluat tehdä vahvistusta, joka edellyttää koko mallin alustamista.
model_rebuild	Yritä muodostaa uudelleen pydanttiydinrakenne mallille. Tämä saattaa olla tarpeen, kun yksi huomautuksista on ForwardRef, jota ei voitu ratkaista ensimmäisen rakenteen muodostamisyrityksen aikana, ja automaattinen uudelleenrakentaminen epäonnistuu.
model_validate	Vahvista pydanttisen mallin esiintymä.
model_validate_json	!!! abstract "Usage Documentation" JSON -jäsennys Vahvista annetut JSON-tiedot pydanttiseen malliin nähden.
model_validate_strings	Vahvista annettu objekti merkkijonotiedolla pydanttista mallia vasten.
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

__init__

Luo uusi malli jäsentämällä ja vahvistamalla avainsanaargumenttien syötetietoja.

Korotukset [ValidationError][pydantic_core. ValidationError], jos syötetietoja ei voida vahvistaa kelvollisen mallin muodostamiseksi.

se on eksplisiittisesti vain sijainti , jotta hän voi sallia itsensä kentän nimenä.

__init__(**data: Any) -> None

Parametrit

Nimi	Description
data Pakollinen	Any

Palautukset

Tyyppi	Description
None

__new__

__new__(**kwargs)

construct

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

Parametrit

Nimi	Description
_fields_set	set[str] | None Default value: None
values Pakollinen	Any

Palautukset

Tyyppi	Description
Self

content_not_empty

Varmista, että sisältö ei ole tyhjää tai vain välilyöntiä.

validator content_not_empty  »  content

Parametrit

Nimi	Description
v Pakollinen	str

Palautukset

Tyyppi	Description
str

copy

Palauttaa kopion mallista.

!!! varoitus "Vanhentunut" Tämä menetelmä on nyt vanhentunut; käyttää model_copy sen sijaan.

Jos haluat sisällyttää tai jättää pois, käytä seuraavaa:

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

Parametrit

Nimi	Description
include Pakollinen	<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None Valinnainen joukko tai yhdistämismääritys, joka määrittää, mitkä kentät sisällytetään kopioituun malliin.
exclude Pakollinen	<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None Valinnainen joukko tai yhdistämismääritys, joka määrittää, mitkä kentät jätetään pois kopioidussa mallissa.
update Pakollinen	Dict[str, Any] | None Valinnainen field-value-parien sanasto, joka ohittaa kopioidun mallin kenttien arvot.
deep Pakollinen	bool Jos arvo on TRUE, pydanttisia malleja olevien kenttien arvot kopioidaan syvälle.

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
Self	Kopio mallista, joka sisältää määritetyn mukaisesti sisällytetyt, pois jätetyt ja päivitetyt kentät.

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]

Parametrit

Nimi	Description
include Pakollinen	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 Pakollinen	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 Pakollinen	bool
exclude_unset Pakollinen	bool
exclude_defaults Pakollinen	bool
exclude_none Pakollinen	bool

Keyword-Only-parametrit

Nimi	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

Palautukset

Tyyppi	Description
Dict[str, Any]

from_orm

from_orm(obj: Any) -> Self

Parametrit

Nimi	Description
obj Pakollinen	Any

Palautukset

Tyyppi	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

Parametrit

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

Keyword-Only-parametrit

Nimi	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

Palautukset

Tyyppi	Description
str

model_construct

Luo malliluokan uuden esiintymän vahvistettujen tietojen avulla.

Luo uuden malliasetuksen sanelun ja pydantic_fields_set luotettavista tai ennalta vahvistetuista tiedoista. Oletusarvoja noudatetaan, mutta muuta vahvistusta ei suoriteta.

!!! huomautus : model_construct() noudattaa yleisesti model_config.extra-asetusta annetussa mallissa. Jos model_config.extra == 'allow', kaikki ylimääräiset välitetty arvot lisätään malliesiintymän sanelun ja pydantic_extra kenttiin. Jos model_config.extra == 'ignore' (oletus), kaikki ylimääräiset välitetyt arvot ohitetaan. Koska model_construct()-kutsulla ei suoriteta vahvistusta, model_config.extra == 'mahdollisuuksien mukaan' ei aiheuta virhettä, jos ylimääräiset arvot välitetään, mutta ne ohitetaan.

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

Parametrit

Nimi	Description
_fields_set	set[str] | None Joukko kenttien nimiä, jotka oli alun perin nimenomaisesti määritetty esiintymän aikana. Jos tämä on annettu, sitä käytetään suoraan [model_fields_set][pydantic]. BaseModel.model_fields_set]-määrite. Muussa tapauksessa käytetään arvoargumentin kenttien nimiä. Default value: None
values Pakollinen	Any Luotettu tai esivahvistettu tietohakemisto.

Palautukset

Tyyppi	Description
Self	Malliluokan uusi esiintymä, jossa on vahvistettuja tietoja.

model_copy

!!! abstract "Usage Documentation" model_copy

Palauttaa kopion mallista.

!!! note (huomautus) Pohjana olevan esiintymän [dict][object.dict]-määrite kopioidaan. Tällä voi olla odottamattomia sivuvaikutuksia, jos siihen tallennetaan jotain mallikenttien lisäksi (esim. [välimuistiin tallennettujen ominaisuuksien] arvo[functools.cached_property]).

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

Parametrit

Nimi	Description
update Pakollinen	Mapping[str, Any] | None Arvot, joita muutetaan tai lisätään uudessa mallissa. Huomautus: tietoja ei varmenneta ennen uuden mallin luomista. Sinun kannattaa luottaa näihin tietoihin.
deep Pakollinen	bool Määritä arvoksi Tosi , jos haluat tehdä mallista syväkopion.

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
Self	Uusi malliesiintymä.

model_dump

!!! abstract "Usage Documentation" model_dump

Luo mallista hakemistoesitys, joka voi valinnaisesti määrittää, mitkä kentät sisällytetään tai jätetään pois.

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]

Parametrit

Nimi	Description
mode Pakollinen	Literal['json', 'python'] | str Tila, jossa to_python tulisi suorittaa. Jos tila on 'json', tuloste sisältää vain JSON-sarjoitettavissa olevia tyyppejä. Jos tila on "python", tuloste voi sisältää ei-JSON-sarjoitettavissa olevia Python-objekteja.
include Pakollinen	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 Tulosteeseen sisällytettävä kenttäjoukko.
exclude Pakollinen	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 Tulosteeseen jätettävä kenttäjoukko.
context Pakollinen	Any | None Lisäkonteksti välitykseen sarjoittajaan.
by_alias Pakollinen	bool | None Onko käytettävä kentän aliasta hakemistoavaimessa, jos se on määritetty.
exclude_unset Pakollinen	bool Jätetäänkö pois kentät, joita ei ole eksplisiittisesti määritetty.
exclude_defaults Pakollinen	bool Jätetäänkö pois kentät, joiden oletusarvoksi on määritetty .
exclude_none Pakollinen	bool Jätetäänkö pois kentät, joiden arvo on Ei mitään.
exclude_computed_fields Pakollinen	bool Onko laskettuja kenttiä jättää pois. Vaikka tämä voi olla hyödyllistä pyöristykseen, on yleensä suositeltavaa käyttää erillistä round_trip.parametria.
round_trip Pakollinen	bool Jos arvo on Tosi, heittoarvojen tulee olla kelvollisia syötteinä muille kuin idempotenttityypeille, kuten Json[T].
warnings Pakollinen	bool | Literal['none', 'warn', 'error'] Sarjoitusvirheiden käsitteleminen. False/"none" ohittaa ne, True/"warn" kirjaa virheet, "virhe" aiheuttaa [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Pakollinen	Callable[[Any], Any] | None Funktio, jota kutsutaan, kun tuntematon arvo tulee vastaan. Jos sitä ei ole annettu, [PydanticSerializationError][pydantic_core. Esiin tulee PydanticSerializationError-virhe.
serialize_as_any Pakollinen	bool Sarjoitetaanko kenttiä ankkaa kirjoittavalla sarjoitustoiminnalla.
polymorphic_serialization Pakollinen	bool | None Tämän kutsun malli- ja tietoluokan polymorfisen sarjoituksen käyttäminen.

Keyword-Only-parametrit

Nimi	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

Palautukset

Tyyppi	Description
dict[str, Any]	Mallin sanastoesitys.

model_dump_json

!!! abstract "Usage Documentation" model_dump_json

Luo mallista JSON-esityksen Pydanticin to_json -menetelmällä.

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

Parametrit

Nimi	Description
indent Pakollinen	int | None Sisennys käytettäväksi JSON-tulosteessa. Jos Ei mitään välitetään, tulos on kompakti.
ensure_ascii Pakollinen	bool Jos arvo on TOSI, tuloste sisältää varmasti kaikki saapuvat ei-ASCII-merkit. Jos arvo on epätosi (oletus), nämä merkit tulostetaan as-is.
include Pakollinen	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 JSON-tulokseen sisällytettävät kentät.
exclude Pakollinen	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 Kentät, jotka jätetään pois JSON-tulosteeseen.
context Pakollinen	Any | None Lisäkonteksti välitykseen sarjoittajaan.
by_alias Pakollinen	bool | None Sarjoitetaanko käyttäen kentän aliaksia.
exclude_unset Pakollinen	bool Jätetäänkö pois kentät, joita ei ole eksplisiittisesti määritetty.
exclude_defaults Pakollinen	bool Jätetäänkö pois kentät, joiden oletusarvoksi on määritetty .
exclude_none Pakollinen	bool Jätetäänkö pois kentät, joiden arvo on Ei mitään.
exclude_computed_fields Pakollinen	bool Onko laskettuja kenttiä jättää pois. Vaikka tämä voi olla hyödyllistä pyöristykseen, on yleensä suositeltavaa käyttää erillistä round_trip.parametria.
round_trip Pakollinen	bool Jos arvo on Tosi, heittoarvojen tulee olla kelvollisia syötteinä muille kuin idempotenttityypeille, kuten Json[T].
warnings Pakollinen	bool | Literal['none', 'warn', 'error'] Sarjoitusvirheiden käsitteleminen. False/"none" ohittaa ne, True/"warn" kirjaa virheet, "virhe" aiheuttaa [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Pakollinen	Callable[[Any], Any] | None Funktio, jota kutsutaan, kun tuntematon arvo tulee vastaan. Jos sitä ei ole annettu, [PydanticSerializationError][pydantic_core. Esiin tulee PydanticSerializationError-virhe.
serialize_as_any Pakollinen	bool Sarjoitetaanko kenttiä ankkaa kirjoittavalla sarjoitustoiminnalla.
polymorphic_serialization Pakollinen	bool | None Tämän kutsun malli- ja tietoluokan polymorfisen sarjoituksen käyttäminen.

Keyword-Only-parametrit

Nimi	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

Palautukset

Tyyppi	Description
str	Mallin JSON-merkkijonoesitys.

model_json_schema

Luo JSON-rakenteen malliluokalle.

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]

Parametrit

Nimi	Description
by_alias	bool Määrittää, käytetäänkö määritealiaksia vai ei. Default value: True
ref_template	str Viitemalli. Default value: DEFAULT_REF_TEMPLATE
union_format Pakollinen	Literal['any_of', 'primitive_type_array'] Muoto, jota käytetään yhdistettäessä liitosten rakenteet yhteen. Voi olla jokin seuraavista: 'any_of': Käytä mitä tahansa avainsana rakenteet yhdistämiseen (oletus). 'primitive_type_array': Käytä tyypin avainsanaa merkkijonomatriisina, joka sisältää kunkin tyyppisen yhdistelmän. Jos jokin rakenteet eivät ole primitiivisiä tyyppejä (merkkijono, totuusarvo, tyhjäarvo, kokonaisluku tai luku) tai sisältävät rajoituksia/metatietoja, palataan any_of.
schema_generator	type[<xref:pydantic.json_schema.GenerateJsonSchema>] Jos haluat ohittaa JSON-rakenteen luonnissa käytetyn logiikan GenerateJsonScheman aliluokkana, jossa on haluamasi muutokset Default value: GenerateJsonSchema
mode	Literal['validation', 'serialization'] Tila, jossa rakenne luodaan. Default value: 'validation'

Keyword-Only-parametrit

Nimi	Description
union_format	Default value: 'any_of'

Palautukset

Tyyppi	Description
dict[str, Any]	Annetun malliluokan JSON-rakenne.

model_parametrized_name

Laske luokan nimi yleisten luokkien parametrisaatioille.

Tämä menetelmä voidaan ohittaa, jotta yleisille BaseModels-muodoille saadaan mukautettu nimeämismalli.

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

Parametrit

Nimi	Description
params Pakollinen	tuple[type[Any], ...] Luokan monikko. Kun annetaan yleinen luokkamalli , jossa on 2-tyyppistä muuttujaa ja konkreettinen malli Model[str, int], arvo (str, int) välitetään parameihin.

Palautukset

Tyyppi	Description
str	Merkkijono, joka edustaa uutta luokkaa, jossa parametrit välitetään cls-arvoihin tyyppimuuttujina.

Poikkeukset

Tyyppi	Description
TypeError	Korotettu, kun yritetään luoda betoninimiä ei-yleisille malleille.

model_post_init

Ohita tämä menetelmä, jos haluat tehdä lisä alustuksen alustuksen jälkeen ja model_construct. Tästä on hyötyä, jos haluat tehdä vahvistusta, joka edellyttää koko mallin alustamista.

model_post_init(context: Any, /) -> None

Positional-Only-parametrit

Nimi	Description
context Pakollinen

Parametrit

Nimi	Description
context Pakollinen	Any

Palautukset

Tyyppi	Description
None

model_rebuild

Yritä muodostaa uudelleen pydanttiydinrakenne mallille.

Tämä saattaa olla tarpeen, kun yksi huomautuksista on ForwardRef, jota ei voitu ratkaista ensimmäisen rakenteen muodostamisyrityksen aikana, ja automaattinen uudelleenrakentaminen epäonnistuu.

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

Parametrit

Nimi	Description
force Pakollinen	bool Määrittää, pakotetaanko mallin rakenne uudelleenrakentamalla, oletusarvo on False.
raise_errors Pakollinen	bool Onko virheilmoituksia, oletusarvo on True.
_parent_namespace_depth Pakollinen	int Ylätason nimitilan syvyystaso on oletusarvoisesti 2.
_types_namespace Pakollinen	<xref:MappingNamespace> | None Tyyppien nimitila -asetuksen oletusarvo on Ei mitään.

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
bool | None	Palauttaa arvon Ei mitään , jos rakenne on jo "valmis" eikä uudelleenrakentamista tarvittu. Jos uudelleenrakentaminen oli tarpeen, palauttaa arvon True , jos uudelleenrakentaminen onnistui, muussa tapauksessa arvon False.

model_validate

Vahvista pydanttisen mallin esiintymä.

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

Parametrit

Nimi	Description
obj Pakollinen	Any Vahvistettava objekti.
strict Pakollinen	bool | None Valvotko tyyppejä tiukasti.
extra Pakollinen	Literal['allow', 'ignore', 'forbid'] | None Ohitettava, sallittava tai kiellettävä ylimääräisiä tietoja mallin vahvistuksen aikana. Katso [ylimääräinen määritysarvo][pydantic]. ConfigDict.extra] lisätietoja.
from_attributes Pakollinen	bool | None Poimitaanko tiedot objektimääritteistä?
context Pakollinen	Any | None Lisää kontekstia välitettavaksi vahvistajalle.
by_alias Pakollinen	bool | None Käytetäänkö kentän aliasta, kun vahvistetaan annettuja syötetietoja käyttämällä.
by_name Pakollinen	bool | None Käytetäänkö kentän nimeä vahvistettaessa annettuja syötetietoja.

Keyword-Only-parametrit

Nimi	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

Palautukset

Tyyppi	Description
Self	Vahvistettu malliesiintymä.

Poikkeukset

Tyyppi	Description
ValidationError	Objektin vahvistus ei onnistu.

model_validate_json

!!! abstract "Usage Documentation" JSON -jäsennys

Vahvista annetut JSON-tiedot pydanttiseen malliin nähden.

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

Parametrit

Nimi	Description
json_data Pakollinen	str | bytes | bytearray Vahvistettavat JSON-tiedot.
strict Pakollinen	bool | None Valvotko tyyppejä tiukasti.
extra Pakollinen	Literal['allow', 'ignore', 'forbid'] | None Ohitettava, sallittava tai kiellettävä ylimääräisiä tietoja mallin vahvistuksen aikana. Katso [ylimääräinen määritysarvo][pydantic]. ConfigDict.extra] lisätietoja.
context Pakollinen	Any | None Ylimääräisiä muuttujia välitettavaksi vahvistajalle.
by_alias Pakollinen	bool | None Käytetäänkö kentän aliasta, kun vahvistetaan annettuja syötetietoja käyttämällä.
by_name Pakollinen	bool | None Käytetäänkö kentän nimeä vahvistettaessa annettuja syötetietoja.

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
Self	Vahvistettu pydanttinen malli.

Poikkeukset

Tyyppi	Description
ValidationError	Jos json_data ei ole JSON-merkkijono tai objektia ei voitu vahvistaa.

model_validate_strings

Vahvista annettu objekti merkkijonotiedolla pydanttista mallia vasten.

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

Parametrit

Nimi	Description
obj Pakollinen	Any Vahvistettava merkkijonotietoja sisältävä objekti.
strict Pakollinen	bool | None Valvotko tyyppejä tiukasti.
extra Pakollinen	Literal['allow', 'ignore', 'forbid'] | None Ohitettava, sallittava tai kiellettävä ylimääräisiä tietoja mallin vahvistuksen aikana. Katso [ylimääräinen määritysarvo][pydantic]. ConfigDict.extra] lisätietoja.
context Pakollinen	Any | None Ylimääräisiä muuttujia välitettavaksi vahvistajalle.
by_alias Pakollinen	bool | None Käytetäänkö kentän aliasta, kun vahvistetaan annettuja syötetietoja käyttämällä.
by_name Pakollinen	bool | None Käytetäänkö kentän nimeä vahvistettaessa annettuja syötetietoja.

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
Self	Vahvistettu pydanttinen malli.

parse_file

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

Parametrit

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

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
Self

parse_obj

parse_obj(obj: Any) -> Self

Parametrit

Nimi	Description
obj Pakollinen	Any

Palautukset

Tyyppi	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

Parametrit

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

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
Self

schema

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

Parametrit

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

Palautukset

Tyyppi	Description
Dict[str, Any]

schema_json

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

Parametrit

Nimi	Description
by_alias Pakollinen	bool
ref_template Pakollinen	str
dumps_kwargs Pakollinen	Any

Keyword-Only-parametrit

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

Palautukset

Tyyppi	Description
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

Parametrit

Nimi	Description
localns Pakollinen	Any

Palautukset

Tyyppi	Description
None

validate

validate(value: Any) -> Self

Parametrit

Nimi	Description
value Pakollinen	Any

Palautukset

Tyyppi	Description
Self

Määritteet

model_extra

Määritä ylimääräiset kentät vahvistuksen aikana.

Palautukset

Tyyppi	Description
	Ylimääräisten kenttien sanasto tai Ei mitään , jos config.extra ei ole määritetty sallivaksi.

model_fields_set

Palauttaa kenttien joukon, joka on eksplisiittisesti määritetty tälle malliesiintymälle.

Palautukset

Tyyppi	Description
	Joukko merkkijonoja, jotka edustavat määritettyjä kenttiä eli kenttiä, joita ei ole täytetty oletusarvoista.

id

Valinnainen yksilöivä tunnus sanomalle.

field id: str | None = None

role

Viestin lähettäjän (käyttäjä, avustaja tai järjestelmä) rooli.

field role: Literal['user', 'assistant', 'system'] [Required]

content

Viestin tekstisisältö.

field content: str [Required]

timestamp

Valinnainen aikaleima viestin luonnin yhteydessä.

field timestamp: datetime | None = None