ChatHistoryMessage Třída
Představuje jednu zprávu v historii chatu.
Tento model slouží k zachycení jednotlivých zpráv vyměňovaných mezi uživateli a asistentem AI pro analýzu ochrany před hrozbami a monitorování dodržování předpisů.
Konstruktor
pydantic model ChatHistoryMessage
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
id
|
Default value: None
|
|
role
Vyžadováno
|
|
|
content
Vyžadováno
|
|
|
timestamp
|
Default value: None
|
Příklady
>>> message = ChatHistoryMessage(role="user", content="Hello, how can you help?")
>>> print(message.role)
'user'
>>> print(message.content)
'Hello, how can you help?'
Metody
| __init__ |
Vytvořte nový model parsováním a ověřením vstupních dat z argumentů klíčových slov. Vyvolá [ValidationError][pydantic_core. ValidationError] Pokud vstupní data nelze ověřit pro vytvoření platného modelu. Self je explicitně poziční pouze pro povolení sebe jako názvu pole. |
| __new__ | |
| construct | |
| content_not_empty |
Ověřte, že obsah není prázdný nebo prázdný. |
| copy |
Vrátí kopii modelu. !!! upozornění "Zastaralé" Tato metoda je nyní zastaralá; místo toho použijte model_copy . Pokud potřebujete zahrnout nebo vyloučit, použijte:
|
| dict | |
| from_orm | |
| json | |
| model_construct |
Vytvoří novou instanci třídy Modelu s ověřenými daty. Vytvoří nový dikt nastavení modelu a pydantic_fields_set z důvěryhodných nebo předem ověřených dat. Výchozí hodnoty se respektují, ale neprovádí se žádné jiné ověření. !!! poznámka model_construct() obecně respektuje nastavení model_config.extra pro zadaný model. To znamená, že pokud model_config.extra == 'allow', všechny předané hodnoty navíc se přidají do diktování instance modelu a pydantic_extra polí. Pokud model_config.extra == 'ignore' (výchozí), všechny předané hodnoty navíc se ignorují. Vzhledem k tomu, že se při volání model_construct()neprovádí žádné ověření, nemá model_config.extra == "zakázáno" , pokud jsou předány nadbytečné hodnoty, ale budou ignorovány. |
| model_copy |
!!! abstraktní model_copy "Dokumentace k využití" Vrátí kopii modelu. !!! Poznámka: Objekt [dict][základní instance.atribut dict] se zkopíruje. To může mít neočekávané vedlejší účinky, pokud do něj uložíte cokoli, nad poli modelu (např. hodnota [vlastnosti uložené v mezipaměti][functools.cached_property]). |
| model_dump |
!!! abstraktní model_dump dokumentace k používání Vygenerujte slovníkovou reprezentaci modelu a volitelně určete, která pole se mají zahrnout nebo vyloučit. |
| model_dump_json |
!!! abstraktní model_dump_json "Dokumentace k využití" Vygeneruje reprezentaci MODELU ve formátu JSON pomocí metody to_json Pydantic. |
| model_json_schema |
Vygeneruje schéma JSON pro třídu modelu. |
| model_parametrized_name |
Vypočítá název třídy pro parametrizace obecných tříd. Tuto metodu lze přepsat, aby se dosáhlo vlastního schématu pojmenování pro obecné baseModels. |
| model_post_init |
Přepsat tuto metodu provést další inicializace po inicializaci a model_construct. To je užitečné, pokud chcete provést ověření, které vyžaduje inicializaci celého modelu. |
| model_rebuild |
Pokuste se znovu sestavit schéma pydantic-core pro model. To může být nutné v případě, že jedna z poznámek je ForwardRef, která se nepodařilo vyřešit během počátečního pokusu o sestavení schématu a automatické opětovné sestavení selže. |
| model_validate |
Ověřte instanci pydantického modelu. |
| model_validate_json |
!!! Abstraktní analýza JSON v dokumentaci k využití Ověřte daná data JSON v modelu Pydantic. |
| model_validate_strings |
Ověřte daný objekt s řetězcovými daty v modelu Pydantic. |
| parse_file | |
| parse_obj | |
| parse_raw | |
| schema | |
| schema_json | |
| update_forward_refs | |
| validate |
__init__
Vytvořte nový model parsováním a ověřením vstupních dat z argumentů klíčových slov.
Vyvolá [ValidationError][pydantic_core. ValidationError] Pokud vstupní data nelze ověřit pro vytvoření platného modelu.
Self je explicitně poziční pouze pro povolení sebe jako názvu pole.
__init__(**data: Any) -> None
Parametry
| Name | Description |
|---|---|
|
data
Vyžadováno
|
|
Návraty
| Typ | Description |
|---|---|
__new__
__new__(**kwargs)
construct
content_not_empty
copy
Vrátí kopii modelu.
!!! upozornění "Zastaralé" Tato metoda je nyní zastaralá; místo toho použijte model_copy .
Pokud potřebujete zahrnout nebo vyloučit, použijte:
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
Parametry
| Name | Description |
|---|---|
|
include
Vyžadováno
|
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None
Volitelná sada nebo mapování určující pole, která mají být zahrnuta do zkopírovaného modelu. |
|
exclude
Vyžadováno
|
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None
Volitelná sada nebo mapování určující pole, která mají být vyloučena ve zkopírovaném modelu. |
|
update
Vyžadováno
|
Volitelný slovník párů hodnot pole pro přepsání hodnot polí ve zkopírovaném modelu. |
|
deep
Vyžadováno
|
Pokud je pravda, hodnoty polí, která jsou Pydantickým modelem, se zkopírují do hloubky. |
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
include
|
Default value: None
|
|
exclude
|
Default value: None
|
|
update
|
Default value: None
|
|
deep
|
Default value: False
|
Návraty
| Typ | Description |
|---|---|
|
Kopie modelu se zahrnutými, vyloučenými a aktualizovanými poli, jak je uvedeno. |
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]
Parametry
| Name | Description |
|---|---|
|
include
Vyžadováno
|
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
Vyžadováno
|
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
Vyžadováno
|
|
|
exclude_unset
Vyžadováno
|
|
|
exclude_defaults
Vyžadováno
|
|
|
exclude_none
Vyžadováno
|
|
Výhradně parametry klíčových slov
| 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
|
Návraty
| Typ | Description |
|---|---|
from_orm
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
Parametry
| Name | Description |
|---|---|
|
include
Vyžadováno
|
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
Vyžadováno
|
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
Vyžadováno
|
|
|
exclude_unset
Vyžadováno
|
|
|
exclude_defaults
Vyžadováno
|
|
|
exclude_none
Vyžadováno
|
|
|
encoder
Vyžadováno
|
|
|
models_as_dict
Vyžadováno
|
|
|
dumps_kwargs
Vyžadováno
|
|
Výhradně parametry klíčových slov
| 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
|
Návraty
| Typ | Description |
|---|---|
model_construct
Vytvoří novou instanci třídy Modelu s ověřenými daty.
Vytvoří nový dikt nastavení modelu a pydantic_fields_set z důvěryhodných nebo předem ověřených dat. Výchozí hodnoty se respektují, ale neprovádí se žádné jiné ověření.
!!! poznámka model_construct() obecně respektuje nastavení model_config.extra pro zadaný model. To znamená, že pokud model_config.extra == 'allow', všechny předané hodnoty navíc se přidají do diktování instance modelu a pydantic_extra polí. Pokud model_config.extra == 'ignore' (výchozí), všechny předané hodnoty navíc se ignorují. Vzhledem k tomu, že se při volání model_construct()neprovádí žádné ověření, nemá model_config.extra == "zakázáno" , pokud jsou předány nadbytečné hodnoty, ale budou ignorovány.
model_construct(_fields_set: set[str] | None = None, **values: Any) -> Self
Parametry
| Name | Description |
|---|---|
|
_fields_set
|
Sada názvů polí, které byly původně explicitně nastaveny během vytváření instancí. V případě potřeby se používá přímo pro [model_fields_set][pydantic. atribut BaseModel.model_fields_set] V opačném případě se použijí názvy polí z argumentu hodnot . Default value: None
|
|
values
Vyžadováno
|
Důvěryhodný nebo předem ověřený datový slovník |
Návraty
| Typ | Description |
|---|---|
|
Nová instance třídy Model s ověřenými daty. |
model_copy
!!! abstraktní model_copy "Dokumentace k využití"
Vrátí kopii modelu.
!!! Poznámka: Objekt [dict][základní instance.atribut dict] se zkopíruje. To může mít neočekávané vedlejší účinky, pokud do něj uložíte cokoli, nad poli modelu (např. hodnota [vlastnosti uložené v mezipaměti][functools.cached_property]).
model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) -> Self
Parametry
| Name | Description |
|---|---|
|
update
Vyžadováno
|
Hodnoty, které chcete změnit nebo přidat do nového modelu. Poznámka: Data se před vytvořením nového modelu neověřují. Tato data byste měli považovat za důvěryhodná. |
|
deep
Vyžadováno
|
Pokud chcete vytvořit hlubokou kopii modelu, nastavte hodnotu True . |
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
update
|
Default value: None
|
|
deep
|
Default value: False
|
Návraty
| Typ | Description |
|---|---|
|
Nová instance modelu |
model_dump
!!! abstraktní model_dump dokumentace k používání
Vygenerujte slovníkovou reprezentaci modelu a volitelně určete, která pole se mají zahrnout nebo vyloučit.
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]
Parametry
| Name | Description |
|---|---|
|
mode
Vyžadováno
|
Literal['json', 'python'] | str
Režim, ve kterém se má spustit to_python . Pokud je režim json, výstup bude obsahovat pouze serializovatelné typy JSON. Pokud je režim pythonu, výstup může obsahovat objekty Pythonu, které nejsou serializovatelné jako JSON. |
|
include
Vyžadováno
|
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
Sada polí, která se mají zahrnout do výstupu. |
|
exclude
Vyžadováno
|
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
Sada polí, která se mají z výstupu vyloučit. |
|
context
Vyžadováno
|
Další kontext pro předání serializátoru. |
|
by_alias
Vyžadováno
|
Určuje, jestli se má použít alias pole v klíči slovníku, pokud je definován. |
|
exclude_unset
Vyžadováno
|
Zda chcete vyloučit pole, která nebyla explicitně nastavena. |
|
exclude_defaults
Vyžadováno
|
Určuje, jestli chcete vyloučit pole, která jsou nastavená na výchozí hodnotu. |
|
exclude_none
Vyžadováno
|
Zda chcete vyloučit pole, která mají hodnotu None. |
|
exclude_computed_fields
Vyžadováno
|
Určuje, jestli se mají vyloučit počítaná pole. I když to může být užitečné pro odezvu, obvykle se doporučuje místo toho použít vyhrazený parametr round_trip . |
|
round_trip
Vyžadováno
|
Pokud je hodnota True, hodnoty s výpisem paměti by měly být platné jako vstup pro jiné než idempotentní typy, jako je json[T]. |
|
warnings
Vyžadováno
|
Zpracování chyb serializace False/"none" je ignoruje, True/"warn" protokoly chyby, "error" vyvolá [PydanticSerializationError][pydantic_core. PydanticSerializationError]. |
|
fallback
Vyžadováno
|
Funkce, která se má volat, když je zjištěna neznámá hodnota. Pokud není k dispozici, [PydanticSerializationError][pydantic_core. Došlo k chybě PydanticSerializationError]. |
|
serialize_as_any
Vyžadováno
|
Zda serializovat pole s duck-typing chování serializace. |
|
polymorphic_serialization
Vyžadováno
|
Zda použít model a polymorfní serializace datové třídy pro toto volání. |
Výhradně parametry klíčových slov
| 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
|
Návraty
| Typ | Description |
|---|---|
|
Slovníková reprezentace modelu. |
model_dump_json
!!! abstraktní model_dump_json "Dokumentace k využití"
Vygeneruje reprezentaci MODELU ve formátu JSON pomocí metody to_json Pydantic.
model_dump_json(*, indent: int | None = None, ensure_ascii: bool = False, include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, fallback: Callable[[Any], Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> str
Parametry
| Name | Description |
|---|---|
|
indent
Vyžadováno
|
Odsazení pro použití ve výstupu JSON Pokud se předá žádný, výstup bude komprimovat. |
|
ensure_ascii
Vyžadováno
|
Pokud je pravda, je zaručeno, že výstup bude obsahovat všechny příchozí znaky, které nejsou ASCII řídicími znaky. Pokud je false (výchozí), budou tyto znaky výstupem as-is. |
|
include
Vyžadováno
|
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
Pole, která se mají zahrnout do výstupu JSON. |
|
exclude
Vyžadováno
|
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
Pole, která chcete vyloučit z výstupu JSON. |
|
context
Vyžadováno
|
Další kontext pro předání serializátoru. |
|
by_alias
Vyžadováno
|
Určuje, zda se má serializovat pomocí aliasů polí. |
|
exclude_unset
Vyžadováno
|
Zda chcete vyloučit pole, která nebyla explicitně nastavena. |
|
exclude_defaults
Vyžadováno
|
Určuje, jestli chcete vyloučit pole, která jsou nastavená na výchozí hodnotu. |
|
exclude_none
Vyžadováno
|
Zda chcete vyloučit pole, která mají hodnotu None. |
|
exclude_computed_fields
Vyžadováno
|
Určuje, jestli se mají vyloučit počítaná pole. I když to může být užitečné pro odezvu, obvykle se doporučuje místo toho použít vyhrazený parametr round_trip . |
|
round_trip
Vyžadováno
|
Pokud je hodnota True, hodnoty s výpisem paměti by měly být platné jako vstup pro jiné než idempotentní typy, jako je json[T]. |
|
warnings
Vyžadováno
|
Zpracování chyb serializace False/"none" je ignoruje, True/"warn" protokoly chyby, "error" vyvolá [PydanticSerializationError][pydantic_core. PydanticSerializationError]. |
|
fallback
Vyžadováno
|
Funkce, která se má volat, když je zjištěna neznámá hodnota. Pokud není k dispozici, [PydanticSerializationError][pydantic_core. Došlo k chybě PydanticSerializationError]. |
|
serialize_as_any
Vyžadováno
|
Zda serializovat pole s duck-typing chování serializace. |
|
polymorphic_serialization
Vyžadováno
|
Zda použít model a polymorfní serializace datové třídy pro toto volání. |
Výhradně parametry klíčových slov
| 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
|
Návraty
| Typ | Description |
|---|---|
|
Řetězcová reprezentace modelu JSON. |
model_json_schema
Vygeneruje schéma JSON pro třídu modelu.
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]
Parametry
| Name | Description |
|---|---|
|
by_alias
|
Bez ohledu na to, jestli se mají používat aliasy atributů, nebo ne. Default value: True
|
|
ref_template
|
Referenční šablona. Default value: DEFAULT_REF_TEMPLATE
|
|
union_format
Vyžadováno
|
Literal['any_of', 'primitive_type_array']
Formát, který se má použít při kombinování schémat ze sjednocení. Může to být jedna z těchto možností:
ke kombinování schémat (výchozí).
|
|
schema_generator
|
type[<xref:pydantic.json_schema.GenerateJsonSchema>]
Přepsání logiky použité k vygenerování schématu JSON jako podtřídy GenerateJsonSchema s požadovanými úpravami Default value: GenerateJsonSchema
|
|
mode
|
Literal['validation', 'serialization']
Režim, ve kterém se má schéma generovat. Default value: 'validation'
|
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
union_format
|
Default value: 'any_of'
|
Návraty
| Typ | Description |
|---|---|
|
Schéma JSON pro danou třídu modelu. |
model_parametrized_name
Vypočítá název třídy pro parametrizace obecných tříd.
Tuto metodu lze přepsat, aby se dosáhlo vlastního schématu pojmenování pro obecné baseModels.
model_parametrized_name(params: tuple[type[Any], ...]) -> str
Parametry
| Name | Description |
|---|---|
|
params
Vyžadováno
|
Řazená kolekce členů typů třídy. Vzhledem k obecné třídě Model se 2 proměnnými typů a konkrétním modelem[str, int], hodnota (str, int) by byla předána do parametrů. |
Návraty
| Typ | Description |
|---|---|
|
Řetězec představující novou třídu, kde se parametry předávají cls jako proměnné typu. |
Výjimky
| Typ | Description |
|---|---|
|
Vyvolá se při pokusu o vygenerování konkrétních názvů pro ne generické modely. |
model_post_init
Přepsat tuto metodu provést další inicializace po inicializaci a model_construct. To je užitečné, pokud chcete provést ověření, které vyžaduje inicializaci celého modelu.
model_post_init(context: Any, /) -> None
Výhradně poziční parametry
| Name | Description |
|---|---|
|
context
Vyžadováno
|
|
Parametry
| Name | Description |
|---|---|
|
context
Vyžadováno
|
|
Návraty
| Typ | Description |
|---|---|
model_rebuild
Pokuste se znovu sestavit schéma pydantic-core pro model.
To může být nutné v případě, že jedna z poznámek je ForwardRef, která se nepodařilo vyřešit během počátečního pokusu o sestavení schématu a automatické opětovné sestavení selže.
model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: MappingNamespace | None = None) -> bool | None
Parametry
| Name | Description |
|---|---|
|
force
Vyžadováno
|
Určuje, jestli chcete vynutit opětovné sestavení schématu modelu, výchozí hodnota je False. |
|
raise_errors
Vyžadováno
|
Určuje, zda se mají vyvolat chyby, výchozí hodnota je True. |
|
_parent_namespace_depth
Vyžadováno
|
Úroveň hloubky nadřazeného oboru názvů je výchozí hodnota 2. |
|
_types_namespace
Vyžadováno
|
<xref:MappingNamespace> | None
Typ oboru názvů, výchozí hodnota None. |
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
force
|
Default value: False
|
|
raise_errors
|
Default value: True
|
|
_parent_namespace_depth
|
Default value: 2
|
|
_types_namespace
|
Default value: None
|
Návraty
| Typ | Description |
|---|---|
|
Vrátí hodnotu None , pokud schéma je již dokončeno a opětovné sestavení nebylo vyžadováno. Pokud bylo opětovné sestavení požadováno , vrátí hodnotu True , pokud bylo opětovné sestavení úspěšné, jinak false. |
model_validate
Ověřte instanci pydantického modelu.
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
Parametry
| Name | Description |
|---|---|
|
obj
Vyžadováno
|
Objekt, který chcete ověřit. |
|
strict
Vyžadováno
|
Zda se mají typy vynucovat striktně. |
|
extra
Vyžadováno
|
Literal['allow', 'ignore', 'forbid'] | None
Ať už chcete během ověřování modelu ignorovat, povolit nebo zakázat nadbytečná data. Viz [extra konfigurační hodnota][pydantic. Podrobnosti najdete v souboru ConfigDict.extra. |
|
from_attributes
Vyžadováno
|
Určuje, zda se mají extrahovat data z atributů objektů. |
|
context
Vyžadováno
|
Další kontext, který se má předat validátoru |
|
by_alias
Vyžadováno
|
Zda se má použít alias pole při ověřování proti zadaným vstupním datům. |
|
by_name
Vyžadováno
|
Určuje, jestli se má při ověřování proti zadaným vstupním datům použít název pole. |
Výhradně parametry klíčových slov
| 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
|
Návraty
| Typ | Description |
|---|---|
|
Ověřená instance modelu. |
Výjimky
| Typ | Description |
|---|---|
|
ValidationError
|
Pokud objekt nelze ověřit. |
model_validate_json
!!! Abstraktní analýza JSON v dokumentaci k využití
Ověřte daná data JSON v modelu Pydantic.
model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, extra: Literal['allow', 'ignore', 'forbid'] | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> Self
Parametry
| Name | Description |
|---|---|
|
json_data
Vyžadováno
|
Data JSON, která se mají ověřit. |
|
strict
Vyžadováno
|
Zda se mají typy vynucovat striktně. |
|
extra
Vyžadováno
|
Literal['allow', 'ignore', 'forbid'] | None
Ať už chcete během ověřování modelu ignorovat, povolit nebo zakázat nadbytečná data. Viz [extra konfigurační hodnota][pydantic. Podrobnosti najdete v souboru ConfigDict.extra. |
|
context
Vyžadováno
|
Další proměnné, které se předávají validátoru. |
|
by_alias
Vyžadováno
|
Zda se má použít alias pole při ověřování proti zadaným vstupním datům. |
|
by_name
Vyžadováno
|
Určuje, jestli se má při ověřování proti zadaným vstupním datům použít název pole. |
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
strict
|
Default value: None
|
|
extra
|
Default value: None
|
|
context
|
Default value: None
|
|
by_alias
|
Default value: None
|
|
by_name
|
Default value: None
|
Návraty
| Typ | Description |
|---|---|
|
Ověřený Pydantický model. |
Výjimky
| Typ | Description |
|---|---|
|
ValidationError
|
Pokud json_data není řetězec JSON nebo objekt nelze ověřit. |
model_validate_strings
Ověřte daný objekt s řetězcovými daty v modelu Pydantic.
model_validate_strings(obj: Any, *, strict: bool | None = None, extra: Literal['allow', 'ignore', 'forbid'] | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> Self
Parametry
| Name | Description |
|---|---|
|
obj
Vyžadováno
|
Objekt obsahující řetězcová data k ověření. |
|
strict
Vyžadováno
|
Zda se mají typy vynucovat striktně. |
|
extra
Vyžadováno
|
Literal['allow', 'ignore', 'forbid'] | None
Ať už chcete během ověřování modelu ignorovat, povolit nebo zakázat nadbytečná data. Viz [extra konfigurační hodnota][pydantic. Podrobnosti najdete v souboru ConfigDict.extra. |
|
context
Vyžadováno
|
Další proměnné, které se předávají validátoru. |
|
by_alias
Vyžadováno
|
Zda se má použít alias pole při ověřování proti zadaným vstupním datům. |
|
by_name
Vyžadováno
|
Určuje, jestli se má při ověřování proti zadaným vstupním datům použít název pole. |
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
strict
|
Default value: None
|
|
extra
|
Default value: None
|
|
context
|
Default value: None
|
|
by_alias
|
Default value: None
|
|
by_name
|
Default value: None
|
Návraty
| Typ | Description |
|---|---|
|
Ověřený Pydantický model. |
parse_file
parse_file(path: str | Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) -> Self
Parametry
| Name | Description |
|---|---|
|
path
Vyžadováno
|
str | <xref:Path>
|
|
content_type
Vyžadováno
|
|
|
encoding
Vyžadováno
|
|
|
proto
Vyžadováno
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
Vyžadováno
|
|
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
content_type
|
Default value: None
|
|
encoding
|
Default value: 'utf8'
|
|
proto
|
Default value: None
|
|
allow_pickle
|
Default value: False
|
Návraty
| Typ | Description |
|---|---|
parse_obj
parse_raw
parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) -> Self
Parametry
| Name | Description |
|---|---|
|
b
Vyžadováno
|
|
|
content_type
Vyžadováno
|
|
|
encoding
Vyžadováno
|
|
|
proto
Vyžadováno
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
Vyžadováno
|
|
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
content_type
|
Default value: None
|
|
encoding
|
Default value: 'utf8'
|
|
proto
|
Default value: None
|
|
allow_pickle
|
Default value: False
|
Návraty
| Typ | Description |
|---|---|
schema
schema_json
schema_json(*, by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, **dumps_kwargs: Any) -> str
Parametry
| Name | Description |
|---|---|
|
by_alias
Vyžadováno
|
|
|
ref_template
Vyžadováno
|
|
|
dumps_kwargs
Vyžadováno
|
|
Výhradně parametry klíčových slov
| Name | Description |
|---|---|
|
by_alias
|
Default value: True
|
|
ref_template
|
Default value: DEFAULT_REF_TEMPLATE
|
Návraty
| Typ | Description |
|---|---|
update_forward_refs
validate
Atributy
model_extra
Získejte další pole nastavená během ověřování.
Návraty
| Typ | Description |
|---|---|
|
Slovník dodatečných polí nebo Žádný , pokud parametr config.extra není nastavený na "povolit". |
model_fields_set
Vrátí sadu polí, která byla explicitně nastavena pro tuto instanci modelu.
Návraty
| Typ | Description |
|---|---|
|
Sada řetězců představujících pole, která byla nastavena, tj. která nebyla vyplněna z výchozích hodnot. |
id
Volitelný jedinečný identifikátor zprávy.
field id: str | None = None
role
Role odesílatele zprávy (uživatel, asistent nebo systém).
field role: Literal['user', 'assistant', 'system'] [Required]
content
Textový obsah zprávy.
field content: str [Required]
timestamp
Volitelné časové razítko při vytvoření zprávy
field timestamp: datetime | None = None