ChatHistoryMessage מחלקה

מייצגת הודעה בודדת בהיסטוריית הצ'אט.

מודל זה משמש ללכידת הודעות בודדות שהועברו בין משתמשים למסייע הבינה המלאכותית לצורך ניתוח הגנה מפני איומים וניטור תאימות.

בנאי

pydantic model ChatHistoryMessage

פרמטרים של מילת מפתח בלבד

שם	תיאור
id	ערך ברירת מחדל: None
role נדרש
content נדרש
timestamp	ערך ברירת מחדל: None

דוגמאות

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

שיטות

__init__	צור מודל חדש על-ידי ניתוח ואימות של נתוני קלט מארגומנטים של מילות מפתח. מעלה את [ValidationError][pydantic_core. ValidationError] אם אין אפשרות לאמת את נתוני הקלט כדי ליצור מודל חוקי. self מוגדר באופן מפורש למיקום בלבד כדי לאפשר את עצמו כשם שדה.
__new__
construct
content_not_empty	ודא שתוכן זה אינו ריק או רווח לבן בלבד.
copy	מחזירה עותק של המודל. !!! אזהרה "יצא משימוש" פעולת שירות זו אינה נמצאת עוד בשימוש; השתמש model_copy במקום זאת. אם עליך לכלול או לאלכלול, השתמש ב: 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	יצירת מופע חדש של מחלקת המודל עם נתונים מאומתים. יצירת הגדרת מודל חדשה הכתבה pydantic_fields_setנתונים מהימנים או מאומתים מראש. ערכי ברירת המחדל מכובדים, אך לא מבוצע אימות אחר. !!! הערה model_construct() מכבדת בדרך model_config.extra במודל שסופק. זאת, אם model_config.extra == 'allow', כל הערכים שהועברו מיותרים יתווספו להכתבה של מופע המודל pydantic_extra השדות. אם model_config.extra == 'ignore' (ברירת המחדל), הפונקציה מתעלמת מכל הערכים שהועברו מיותרים. מאחר שלא מבוצע אימות עם קריאה ל- model_construct(),, הוספת model_config.extra == 'יחד עם' אינה התוצאה לשגיאה אם ערכים נוספים מועברים, אך המערכת תתעלם מהם.
model_copy	!!! תקציר "תיעוד שימוש" model_copy מחזירה עותק של המודל. !!! הערה [dict][object של המופע המשמשת כק"התכונה dict] מועתקת. מצב זה עשוי לכלול תופעות לוואי בלתי צפויות אם תאחסן בו משהו, מעל שדות המודל (לדוגמה, הערך של [מאפיינים המאוחסנים במטמון][functools.cached_property]).
model_dump	!!! תקציר "תיעוד שימוש" model_dump צור ייצוג מילון של המודל, המציין באופן אופציונלי אילו שדות לכלול או לא לכלול.
model_dump_json	!!! תקציר "תיעוד שימוש" model_dump_json יוצר ייצוג JSON של המודל באמצעות שיטת ההפצה של to_json פידאנטית.
model_json_schema	יצירת סכימת JSON עבור מחלקת מודל.
model_parametrized_name	חשב את שם הכיתה עבור מדידת שימוש של כיתות כלליות. ניתן לעקוף שיטה זו כדי להשיג סכימת מתן שמות מותאמת אישית עבור BaseModels כלליים.
model_post_init	עקוף שיטה זו כדי לבצע אתחול נוסף לאחר אתחול model_construct. פעולה זו שימושית אם ברצונך לבצע אימות שתרצה לאתחל את המודל כולו.
model_rebuild	נסה לבנות מחדש את סכימת הליבה הפידאנטית עבור המודל. ייתכן שיהיה צורך בכך כאשר אחד הביאורים הוא ForwardRef שלא היתה אפשרות לפענחו במהלך הניסיון הראשוני לבנות את הסכימה, ובנייה מחדש אוטומטית נכשלת.
model_validate	אמת מופע של מודל פידאנטי.
model_validate_json	!!! תקציר "תיעוד שימוש" ניתוח JSON אמת את נתוני JSON הנתונים מול המודל הפירדני.
model_validate_strings	אמת את האובייקט הנתון באמצעות נתוני מחרוזת מול המודל הפירדני.
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

__init__

צור מודל חדש על-ידי ניתוח ואימות של נתוני קלט מארגומנטים של מילות מפתח.

מעלה את [ValidationError][pydantic_core. ValidationError] אם אין אפשרות לאמת את נתוני הקלט כדי ליצור מודל חוקי.

self מוגדר באופן מפורש למיקום בלבד כדי לאפשר את עצמו כשם שדה.

__init__(**data: Any) -> None

פרמטרים

שם	תיאור
data נדרש	Any

החזרות

סוג נתונים	תיאור
None

__new__

__new__(**kwargs)

construct

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

פרמטרים

שם	תיאור
_fields_set	set[str] | None ערך ברירת מחדל: None
values נדרש	Any

החזרות

סוג נתונים	תיאור
Self

content_not_empty

ודא שתוכן זה אינו ריק או רווח לבן בלבד.

validator content_not_empty  »  content

פרמטרים

שם	תיאור
v נדרש	str

החזרות

סוג נתונים	תיאור
str

copy

מחזירה עותק של המודל.

!!! אזהרה "יצא משימוש" פעולת שירות זו אינה נמצאת עוד בשימוש; השתמש model_copy במקום זאת.

אם עליך לכלול או לאלכלול, השתמש ב:

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

פרמטרים

שם	תיאור
include נדרש	<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None ערכה או מיפוי אופציונליים המצידרים אילו שדות לכלול במודל המועתק.
exclude נדרש	<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None ערכה או מיפוי אופציונליים המצידרים אילו שדות לא לכלול במודל המועתק.
update נדרש	Dict[str, Any] | None מילון אופציונלי של זוגות ערכי שדה כדי לעקוף ערכי שדה במודל המועתק.
deep נדרש	bool אם הערך הוא True, הערכים של שדות שהם מודלים ורודנים יועתקו בעומק.

פרמטרים של מילת מפתח בלבד

שם	תיאור
include	ערך ברירת מחדל: None
exclude	ערך ברירת מחדל: None
update	ערך ברירת מחדל: None
deep	ערך ברירת מחדל: False

החזרות

סוג נתונים	תיאור
Self	עותק של המודל עם שדות כלולים, שדות לא נכללים ומעודכנים כפי שצוין.

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]

פרמטרים

שם	תיאור
include נדרש	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 נדרש	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 נדרש	bool
exclude_unset נדרש	bool
exclude_defaults נדרש	bool
exclude_none נדרש	bool

פרמטרים של מילת מפתח בלבד

שם	תיאור
include	ערך ברירת מחדל: None
exclude	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: False
exclude_unset	ערך ברירת מחדל: False
exclude_defaults	ערך ברירת מחדל: False
exclude_none	ערך ברירת מחדל: False

החזרות

סוג נתונים	תיאור
Dict[str, Any]

from_orm

from_orm(obj: Any) -> Self

פרמטרים

שם	תיאור
obj נדרש	Any

החזרות

סוג נתונים	תיאור
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

פרמטרים

שם	תיאור
include נדרש	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 נדרש	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 נדרש	bool
exclude_unset נדרש	bool
exclude_defaults נדרש	bool
exclude_none נדרש	bool
encoder נדרש	Callable[[Any], Any] | None
models_as_dict נדרש	bool
dumps_kwargs נדרש	Any

פרמטרים של מילת מפתח בלבד

שם	תיאור
include	ערך ברירת מחדל: None
exclude	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: False
exclude_unset	ערך ברירת מחדל: False
exclude_defaults	ערך ברירת מחדל: False
exclude_none	ערך ברירת מחדל: False
encoder	ערך ברירת מחדל: PydanticUndefined
models_as_dict	ערך ברירת מחדל: PydanticUndefined

החזרות

סוג נתונים	תיאור
str

model_construct

יצירת מופע חדש של מחלקת המודל עם נתונים מאומתים.

יצירת הגדרת מודל חדשה הכתבה pydantic_fields_setנתונים מהימנים או מאומתים מראש. ערכי ברירת המחדל מכובדים, אך לא מבוצע אימות אחר.

!!! הערה model_construct() מכבדת בדרך model_config.extra במודל שסופק. זאת, אם model_config.extra == 'allow', כל הערכים שהועברו מיותרים יתווספו להכתבה של מופע המודל pydantic_extra השדות. אם model_config.extra == 'ignore' (ברירת המחדל), הפונקציה מתעלמת מכל הערכים שהועברו מיותרים. מאחר שלא מבוצע אימות עם קריאה ל- model_construct(),, הוספת model_config.extra == 'יחד עם' אינה התוצאה לשגיאה אם ערכים נוספים מועברים, אך המערכת תתעלם מהם.

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

פרמטרים

שם	תיאור
_fields_set	set[str] | None קבוצה של שמות שדות המוגדרים באופן מפורש במהלך יצירת מופעים. אם צוין, אפשרות זו משמשת ישירות עבור [model_fields_set][pydantic. BaseModel.model_fields_set] . אחרת, ייעשה שימוש בשמות השדות מהארגומנט values. ערך ברירת מחדל: None
values נדרש	Any מילון נתונים מהימן או מאומת מראש.

החזרות

סוג נתונים	תיאור
Self	מופע חדש של מחלקת המודל עם נתונים מאומתים.

model_copy

!!! תקציר "תיעוד שימוש" model_copy

מחזירה עותק של המודל.

!!! הערה [dict][object של המופע המשמשת כק"התכונה dict] מועתקת. מצב זה עשוי לכלול תופעות לוואי בלתי צפויות אם תאחסן בו משהו, מעל שדות המודל (לדוגמה, הערך של [מאפיינים המאוחסנים במטמון][functools.cached_property]).

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

פרמטרים

שם	תיאור
update נדרש	Mapping[str, Any] | None ערכים לשינוי/הוספה במודל החדש. הערה: הנתונים אינם מאומתים לפני יצירת המודל החדש. עליך לתת אמון בנתונים אלה.
deep נדרש	bool הגדר כ - True כדי ליצור עותק עמוק של המודל.

פרמטרים של מילת מפתח בלבד

שם	תיאור
update	ערך ברירת מחדל: None
deep	ערך ברירת מחדל: False

החזרות

סוג נתונים	תיאור
Self	מופע מודל חדש.

model_dump

!!! תקציר "תיעוד שימוש" model_dump

צור ייצוג מילון של המודל, המציין באופן אופציונלי אילו שדות לכלול או לא לכלול.

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]

פרמטרים

שם	תיאור
mode נדרש	Literal['json', 'python'] | str המצב שבו to_python לפעול . אם mode הוא 'json', הפלט יכיל רק סוגים הניתנים לעריכה בסידרה של JSON. אם mode הוא 'python', הפלט עשוי להכיל אובייקטים שאינם ניתנים לעריכה ב- JSON ב- Python.
include נדרש	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 נדרש	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 קבוצת שדות שלא ייכללו בפלט.
context נדרש	Any | None הקשר נוסף להעביר לסידרה.
by_alias נדרש	bool | None אם יש להשתמש בכינוי השדה במקש המילון, אם הוא מוגדר.
exclude_unset נדרש	bool אם לא לכלול שדות שלא הוגדר במפורש.
exclude_defaults נדרש	bool אם לא לכלול שדות המוגדרים לערך ברירת המחדל שלהם.
exclude_none נדרש	bool אם לא לכלול שדות בעלי ערך 'ללא '.
exclude_computed_fields נדרש	bool אם לא לכלול שדות מחושבים. למרות שפעולות אלה יכולות להיות שימושיות עבור הלוך ושוב, בדרך כלל מומלץ להשתמש בפרמטר round_trip ייעודי במקום זאת.
round_trip נדרש	bool אם הערך הוא True, הערכים שהושלכו צריכים להיות חוקיים כקלט עבור סוגים שאינם מסוג idempotent כגון Json[T].
warnings נדרש	bool | Literal['none', 'warn', 'error'] כיצד לטפל בשגיאות עריכה בסידרה. False/"none" מתעלם מהם, True/"אזהרה" רושם שגיאות, "שגיאה" מעלה [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback נדרש	Callable[[Any], Any] | None פונקציה להתקשרות כאשר המערכת נתקלה בערך לא ידוע. אם לא צוין, [PydanticSerializationError][pydantic_core. שגיאת PydanticSerializationError] מוצגת.
serialize_as_any נדרש	bool אם לערוך בסידרה שדות עם אופן פעולה של עריכה בסידרה של הקלדת ברווזים.
polymorphic_serialization נדרש	bool | None אם להשתמש במודל וב- dataclass בסידרה פולימורפולית עבור שיחה זו.

פרמטרים של מילת מפתח בלבד

שם	תיאור
mode	ערך ברירת מחדל: 'python'
include	ערך ברירת מחדל: None
exclude	ערך ברירת מחדל: None
context	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: None
exclude_unset	ערך ברירת מחדל: False
exclude_defaults	ערך ברירת מחדל: False
exclude_none	ערך ברירת מחדל: False
exclude_computed_fields	ערך ברירת מחדל: False
round_trip	ערך ברירת מחדל: False
warnings	ערך ברירת מחדל: True
fallback	ערך ברירת מחדל: None
serialize_as_any	ערך ברירת מחדל: False
polymorphic_serialization	ערך ברירת מחדל: None

החזרות

סוג נתונים	תיאור
dict[str, Any]	ייצוג מילון של המודל.

model_dump_json

!!! תקציר "תיעוד שימוש" model_dump_json

יוצר ייצוג JSON של המודל באמצעות שיטת ההפצה של to_json פידאנטית.

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

פרמטרים

שם	תיאור
indent נדרש	int | None כניסה לשימוש בפלט JSON. אם האפשרות ללא מועברת, הפלט יהיה דחוס.
ensure_ascii נדרש	bool אם הערך נכון, כל התווים הנכנסים שאינם ASCII יתווקו באופן מובטח. אם False (ברירת המחדל), תווים אלה יפלטו as-is.
include נדרש	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.
exclude נדרש	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.
context נדרש	Any | None הקשר נוסף להעביר לסידרה.
by_alias נדרש	bool | None אם לערוך בסידרה באמצעות כינויי שדה.
exclude_unset נדרש	bool אם לא לכלול שדות שלא הוגדר במפורש.
exclude_defaults נדרש	bool אם לא לכלול שדות המוגדרים לערך ברירת המחדל שלהם.
exclude_none נדרש	bool אם לא לכלול שדות בעלי ערך 'ללא '.
exclude_computed_fields נדרש	bool אם לא לכלול שדות מחושבים. למרות שפעולות אלה יכולות להיות שימושיות עבור הלוך ושוב, בדרך כלל מומלץ להשתמש בפרמטר round_trip ייעודי במקום זאת.
round_trip נדרש	bool אם הערך הוא True, הערכים שהושלכו צריכים להיות חוקיים כקלט עבור סוגים שאינם מסוג idempotent כגון Json[T].
warnings נדרש	bool | Literal['none', 'warn', 'error'] כיצד לטפל בשגיאות עריכה בסידרה. False/"none" מתעלם מהם, True/"אזהרה" רושם שגיאות, "שגיאה" מעלה [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback נדרש	Callable[[Any], Any] | None פונקציה להתקשרות כאשר המערכת נתקלה בערך לא ידוע. אם לא צוין, [PydanticSerializationError][pydantic_core. שגיאת PydanticSerializationError] מוצגת.
serialize_as_any נדרש	bool אם לערוך בסידרה שדות עם אופן פעולה של עריכה בסידרה של הקלדת ברווזים.
polymorphic_serialization נדרש	bool | None אם להשתמש במודל וב- dataclass בסידרה פולימורפולית עבור שיחה זו.

פרמטרים של מילת מפתח בלבד

שם	תיאור
indent	ערך ברירת מחדל: None
ensure_ascii	ערך ברירת מחדל: False
include	ערך ברירת מחדל: None
exclude	ערך ברירת מחדל: None
context	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: None
exclude_unset	ערך ברירת מחדל: False
exclude_defaults	ערך ברירת מחדל: False
exclude_none	ערך ברירת מחדל: False
exclude_computed_fields	ערך ברירת מחדל: False
round_trip	ערך ברירת מחדל: False
warnings	ערך ברירת מחדל: True
fallback	ערך ברירת מחדל: None
serialize_as_any	ערך ברירת מחדל: False
polymorphic_serialization	ערך ברירת מחדל: None

החזרות

סוג נתונים	תיאור
str	ייצוג מחרוזת JSON של המודל.

model_json_schema

יצירת סכימת JSON עבור מחלקת מודל.

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]

פרמטרים

שם	תיאור
by_alias	bool אם להשתמש בכינויי תכונה או לא. ערך ברירת מחדל: True
ref_template	str תבנית ההפניה. ערך ברירת מחדל: DEFAULT_REF_TEMPLATE
union_format נדרש	Literal['any_of', 'primitive_type_array'] התבנית לשימוש בעת שילוב סכימות מאיחודים יחד. יכול להיות אחד מ: 'any_of': השתמש ב - anyOf מילת מפתח לשילוב סכימות (ברירת המחדל). 'primitive_type_array': השתמש במילת המפתח של הסוג כמערך של מחרוזות, המכיל כל סוג של השילוב. אם אחת מהסכימות אינה מסוג פרימיטיבי (מחרוזת, ערך בוליאני,Null, מספר שלם או מספר) או שהיא מכילה אילוצים/מטה-נתונים, חוזרת למצב any_of.
schema_generator	type[<xref:pydantic.json_schema.GenerateJsonSchema>] כדי לעקוף את הלוגיקה המשמשת ליצירת סכימת JSON, כסוג משנה של GenerateJsonSchema עם השינויים הרצויים ערך ברירת מחדל: GenerateJsonSchema
mode	Literal['validation', 'serialization'] המצב שבו יש ליצור את הסכימה. ערך ברירת מחדל: 'validation'

פרמטרים של מילת מפתח בלבד

שם	תיאור
union_format	ערך ברירת מחדל: 'any_of'

החזרות

סוג נתונים	תיאור
dict[str, Any]	סכימת JSON עבור מחלקת המודל הנתונה.

model_parametrized_name

חשב את שם הכיתה עבור מדידת שימוש של כיתות כלליות.

ניתן לעקוף שיטה זו כדי להשיג סכימת מתן שמות מותאמת אישית עבור BaseModels כלליים.

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

פרמטרים

שם	תיאור
params נדרש	tuple[type[Any], ...] קבוצת סוגים של הכיתה. בהינתן מודל מחלקה כללי עם 2 משתני סוג ומודל בטון[str, int], הערך (str, int) יועבר לפיסקה.

החזרות

סוג נתונים	תיאור
str	מחרוזת המייצגת את המחלקה החדשה שבה פרמטרים מועברים ל- cls כמשתנה סוג.

חריגות

סוג נתונים	תיאור
TypeError	מועלה בעת ניסיון ליצור שמות בטון עבור מודלים שאינם כלליים.

model_post_init

עקוף שיטה זו כדי לבצע אתחול נוסף לאחר אתחול model_construct. פעולה זו שימושית אם ברצונך לבצע אימות שתרצה לאתחל את המודל כולו.

model_post_init(context: Any, /) -> None

פרמטרים למיקום בלבד

שם	תיאור
context נדרש

פרמטרים

שם	תיאור
context נדרש	Any

החזרות

סוג נתונים	תיאור
None

model_rebuild

נסה לבנות מחדש את סכימת הליבה הפידאנטית עבור המודל.

ייתכן שיהיה צורך בכך כאשר אחד הביאורים הוא ForwardRef שלא היתה אפשרות לפענחו במהלך הניסיון הראשוני לבנות את הסכימה, ובנייה מחדש אוטומטית נכשלת.

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

פרמטרים

שם	תיאור
force נדרש	bool אם לכפות על בנייה מחדש של סכימת המודל, ברירת המחדל היא False.
raise_errors נדרש	bool אם להעלות שגיאות, ברירת המחדל היא True.
_parent_namespace_depth נדרש	int רמת העומק של מרחב שמות האב, המוגדרת כברירת מחדל ל- 2.
_types_namespace נדרש	<xref:MappingNamespace> | None מרחב השמות של הסוגים, המוגדר כברירת מחדל ל'ללא'.

פרמטרים של מילת מפתח בלבד

שם	תיאור
force	ערך ברירת מחדל: False
raise_errors	ערך ברירת מחדל: True
_parent_namespace_depth	ערך ברירת מחדל: 2
_types_namespace	ערך ברירת מחדל: None

החזרות

סוג נתונים	תיאור
bool | None	החזרת 'ללא ' אם הסכימה כבר "הושלמה" ולא נדרשה בנייה מחדש. אם נדרשה בנייה מחדש , מחזיר True אם בנייה מחדש הצליחה, אחרת False.

model_validate

אמת מופע של מודל פידאנטי.

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

פרמטרים

שם	תיאור
obj נדרש	Any האובייקט לאימות.
strict נדרש	bool | None האם לאכוף סוגים באופן בלעדי.
extra נדרש	Literal['allow', 'ignore', 'forbid'] | None אם להתעלם, לאפשר או לאסור על נתונים נוספים במהלך אימות מודל. ראה [ערך תצורה נוסף][פידאנטי. ConfigDict.extra] לקבלת פרטים.
from_attributes נדרש	bool | None אם לחלץ נתונים מתכונות אובייקט.
context נדרש	Any | None הקשר נוסף לתוקף.
by_alias נדרש	bool | None אם להשתמש בכינוי השדה בעת אימות מול נתוני הקלט שסופקו.
by_name נדרש	bool | None אם להשתמש בשם השדה בעת אימות מול נתוני הקלט שסופקו.

פרמטרים של מילת מפתח בלבד

שם	תיאור
strict	ערך ברירת מחדל: None
extra	ערך ברירת מחדל: None
from_attributes	ערך ברירת מחדל: None
context	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: None
by_name	ערך ברירת מחדל: None

החזרות

סוג נתונים	תיאור
Self	מופע המודל המאומת.

חריגות

סוג נתונים	תיאור
ValidationError	אם לא היתה אפשרות לאמת את האובייקט.

model_validate_json

!!! תקציר "תיעוד שימוש" ניתוח JSON

אמת את נתוני JSON הנתונים מול המודל הפירדני.

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

פרמטרים

שם	תיאור
json_data נדרש	str | bytes | bytearray נתוני JSON לאימות.
strict נדרש	bool | None האם לאכוף סוגים באופן בלעדי.
extra נדרש	Literal['allow', 'ignore', 'forbid'] | None אם להתעלם, לאפשר או לאסור על נתונים נוספים במהלך אימות מודל. ראה [ערך תצורה נוסף][פידאנטי. ConfigDict.extra] לקבלת פרטים.
context נדרש	Any | None משתנים מיותרים להעביר למוקף.
by_alias נדרש	bool | None אם להשתמש בכינוי השדה בעת אימות מול נתוני הקלט שסופקו.
by_name נדרש	bool | None אם להשתמש בשם השדה בעת אימות מול נתוני הקלט שסופקו.

פרמטרים של מילת מפתח בלבד

שם	תיאור
strict	ערך ברירת מחדל: None
extra	ערך ברירת מחדל: None
context	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: None
by_name	ערך ברירת מחדל: None

החזרות

סוג נתונים	תיאור
Self	המודל הפירדני שאומת.

חריגות

סוג נתונים	תיאור
ValidationError	אם json_data אינה מחרוזת JSON או אם לא היתה אפשרות לאמת את האובייקט.

model_validate_strings

אמת את האובייקט הנתון באמצעות נתוני מחרוזת מול המודל הפירדני.

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

פרמטרים

שם	תיאור
obj נדרש	Any האובייקט המכיל נתוני מחרוזת לאימות.
strict נדרש	bool | None האם לאכוף סוגים באופן בלעדי.
extra נדרש	Literal['allow', 'ignore', 'forbid'] | None אם להתעלם, לאפשר או לאסור על נתונים נוספים במהלך אימות מודל. ראה [ערך תצורה נוסף][פידאנטי. ConfigDict.extra] לקבלת פרטים.
context נדרש	Any | None משתנים מיותרים להעביר למוקף.
by_alias נדרש	bool | None אם להשתמש בכינוי השדה בעת אימות מול נתוני הקלט שסופקו.
by_name נדרש	bool | None אם להשתמש בשם השדה בעת אימות מול נתוני הקלט שסופקו.

פרמטרים של מילת מפתח בלבד

שם	תיאור
strict	ערך ברירת מחדל: None
extra	ערך ברירת מחדל: None
context	ערך ברירת מחדל: None
by_alias	ערך ברירת מחדל: None
by_name	ערך ברירת מחדל: None

החזרות

סוג נתונים	תיאור
Self	המודל הפירדני שאומת.

parse_file

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

פרמטרים

שם	תיאור
path נדרש	str | <xref:Path>
content_type נדרש	str | None
encoding נדרש	str
proto נדרש	<xref:DeprecatedParseProtocol> | None
allow_pickle נדרש	bool

פרמטרים של מילת מפתח בלבד

שם	תיאור
content_type	ערך ברירת מחדל: None
encoding	ערך ברירת מחדל: 'utf8'
proto	ערך ברירת מחדל: None
allow_pickle	ערך ברירת מחדל: False

החזרות

סוג נתונים	תיאור
Self

parse_obj

parse_obj(obj: Any) -> Self

פרמטרים

שם	תיאור
obj נדרש	Any

החזרות

סוג נתונים	תיאור
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

פרמטרים

שם	תיאור
b נדרש	str | bytes
content_type נדרש	str | None
encoding נדרש	str
proto נדרש	<xref:DeprecatedParseProtocol> | None
allow_pickle נדרש	bool

פרמטרים של מילת מפתח בלבד

שם	תיאור
content_type	ערך ברירת מחדל: None
encoding	ערך ברירת מחדל: 'utf8'
proto	ערך ברירת מחדל: None
allow_pickle	ערך ברירת מחדל: False

החזרות

סוג נתונים	תיאור
Self

schema

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

פרמטרים

שם	תיאור
by_alias	bool ערך ברירת מחדל: True
ref_template	str ערך ברירת מחדל: DEFAULT_REF_TEMPLATE

החזרות

סוג נתונים	תיאור
Dict[str, Any]

schema_json

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

פרמטרים

שם	תיאור
by_alias נדרש	bool
ref_template נדרש	str
dumps_kwargs נדרש	Any

פרמטרים של מילת מפתח בלבד

שם	תיאור
by_alias	ערך ברירת מחדל: True
ref_template	ערך ברירת מחדל: DEFAULT_REF_TEMPLATE

החזרות

סוג נתונים	תיאור
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

פרמטרים

שם	תיאור
localns נדרש	Any

החזרות

סוג נתונים	תיאור
None

validate

validate(value: Any) -> Self

פרמטרים

שם	תיאור
value נדרש	Any

החזרות

סוג נתונים	תיאור
Self

תכונות

model_extra

הגדר שדות נוספים במהלך האימות.

החזרות

סוג נתונים	תיאור
	מילון של שדות מיותרים, או ' ללא' אם config.extra אינו מוגדר ל'אפשר'.

model_fields_set

הפונקציה מחזירה את קבוצת השדות המוגדרים באופן מפורש במופע מודל זה.

החזרות

סוג נתונים	תיאור
	ערכה של מחרוזות המייצגות את השדות הוגדרו, כלומר לא מולאו מתוך ברירות המחדל.

id

מזהה ייחודי אופציונלי עבור ההודעה.

field id: str | None = None

role

התפקיד של שולח ההודעה (משתמש, מסייע או מערכת).

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

content

תוכן הטקסט של ההודעה.

field content: str [Required]

timestamp

חותמת זמן אופציונלית בעת יצירת ההודעה.

field timestamp: datetime | None = None