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] إذا تعذر التحقق من صحة بيانات الإدخال لتشكيل نموذج صالح. تكون الذات موضعية بشكل صريح فقط للسماح بالنفس كاسم حقل. |
| __new__ | |
| construct | |
| content_not_empty |
تحقق من أن المحتوى غير فارغ أو مسافة بيضاء فقط. |
| copy |
إرجاع نسخة من النموذج. !!! تحذير "مهمل" هذا الأسلوب مهمل الآن؛ استخدم model_copy بدلا من ذلك. إذا كنت بحاجة إلى تضمين أو استبعاد، فاستخدم:
|
| 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][الكائن.يتم نسخ السمة dict]. قد يكون لهذا آثار جانبية غير متوقعة إذا قمت بتخزين أي شيء فيه، أعلى حقول النموذج (على سبيل المثال، قيمة [الخصائص المخزنة مؤقتا][functools.cached_property]). |
| model_dump |
!!! model_dump "وثائق الاستخدام" المجردة إنشاء تمثيل قاموس للنموذج، مع تحديد الحقول التي يجب تضمينها أو استبعادها اختياريا. |
| model_dump_json |
!!! model_dump_json "وثائق الاستخدام" المجردة إنشاء تمثيل JSON للنموذج باستخدام أسلوب to_json Pydantic. |
| model_json_schema |
إنشاء مخطط JSON لفئة نموذج. |
| model_parametrized_name |
حساب اسم الفئة ل parametrizations للفئات العامة. يمكن تجاوز هذا الأسلوب لتحقيق نظام تسمية مخصص ل BaseModels العامة. |
| model_post_init |
تجاوز هذا الأسلوب لإجراء تهيئة إضافية بعد initو model_construct. وهذا مفيد إذا كنت تريد إجراء بعض التحقق من الصحة الذي يتطلب تهيئة النموذج بأكمله. |
| model_rebuild |
حاول إعادة إنشاء مخطط pydantic-core للنموذج. قد يكون هذا ضروريا عندما يكون أحد التعليقات التوضيحية هو ForwardRef الذي تعذر حله أثناء المحاولة الأولية لإنشاء المخطط، وفشل إعادة البناء التلقائي. |
| model_validate |
التحقق من صحة مثيل نموذج pydantic. |
| model_validate_json |
!!! تحليل JSON ل "وثائق الاستخدام" المجردة تحقق من صحة بيانات JSON المحددة مقابل نموذج Pydantic. |
| model_validate_strings |
تحقق من صحة الكائن المحدد باستخدام بيانات السلسلة مقابل نموذج Pydantic. |
| parse_file | |
| parse_obj | |
| parse_raw | |
| schema | |
| schema_json | |
| update_forward_refs | |
| validate |
__init__
إنشاء نموذج جديد عن طريق تحليل بيانات الإدخال والتحقق من صحتها من وسيطات الكلمة الأساسية.
يرفع [ValidationError][pydantic_core. ValidationError] إذا تعذر التحقق من صحة بيانات الإدخال لتشكيل نموذج صالح.
تكون الذات موضعية بشكل صريح فقط للسماح بالنفس كاسم حقل.
__init__(**data: Any) -> None
المعلمات
| الاسم | الوصف |
|---|---|
|
data
مطلوب
|
|
المرتجعات
| النوع | الوصف |
|---|---|
__new__
__new__(**kwargs)
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)
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
مطلوب
|
قاموس اختياري لأزواج قيم الحقول لتجاوز قيم الحقول في النموذج المنسخ. |
|
deep
مطلوب
|
إذا كانت True، فسيتم نسخ قيم الحقول التي هي نماذج Pydantic نسخا عميقا. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
include
|
القيمة الافتراضية: None
|
|
exclude
|
القيمة الافتراضية: None
|
|
update
|
القيمة الافتراضية: None
|
|
deep
|
القيمة الافتراضية: False
|
المرتجعات
| النوع | الوصف |
|---|---|
|
نسخة من النموذج مع حقول مضمنة ومستبعدة ومحدثة كما هو محدد. |
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
مطلوب
|
|
|
exclude_unset
مطلوب
|
|
|
exclude_defaults
مطلوب
|
|
|
exclude_none
مطلوب
|
|
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
include
|
القيمة الافتراضية: None
|
|
exclude
|
القيمة الافتراضية: None
|
|
by_alias
|
القيمة الافتراضية: False
|
|
exclude_unset
|
القيمة الافتراضية: False
|
|
exclude_defaults
|
القيمة الافتراضية: False
|
|
exclude_none
|
القيمة الافتراضية: False
|
المرتجعات
| النوع | الوصف |
|---|---|
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
مطلوب
|
|
|
exclude_unset
مطلوب
|
|
|
exclude_defaults
مطلوب
|
|
|
exclude_none
مطلوب
|
|
|
encoder
مطلوب
|
|
|
models_as_dict
مطلوب
|
|
|
dumps_kwargs
مطلوب
|
|
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
include
|
القيمة الافتراضية: None
|
|
exclude
|
القيمة الافتراضية: None
|
|
by_alias
|
القيمة الافتراضية: False
|
|
exclude_unset
|
القيمة الافتراضية: False
|
|
exclude_defaults
|
القيمة الافتراضية: False
|
|
exclude_none
|
القيمة الافتراضية: False
|
|
encoder
|
القيمة الافتراضية: PydanticUndefined
|
|
models_as_dict
|
القيمة الافتراضية: PydanticUndefined
|
المرتجعات
| النوع | الوصف |
|---|---|
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
|
مجموعة من أسماء الحقول التي تم تعيينها بشكل صريح في الأصل أثناء إنشاء مثيل. إذا تم توفيره، يتم استخدام هذا مباشرة ل [model_fields_set][pydantic. سمة BaseModel.model_fields_set]. وإلا، سيتم استخدام أسماء الحقول من وسيطة القيم . القيمة الافتراضية: None
|
|
values
مطلوب
|
قاموس بيانات موثوق به أو تم التحقق من صحته مسبقا. |
المرتجعات
| النوع | الوصف |
|---|---|
|
مثيل جديد لفئة النموذج مع بيانات تم التحقق من صحتها. |
model_copy
!!! model_copy "وثائق الاستخدام" المجردة
إرجاع نسخة من النموذج.
!!! ملاحظة المثيل الأساسي [dict][الكائن.يتم نسخ السمة dict]. قد يكون لهذا آثار جانبية غير متوقعة إذا قمت بتخزين أي شيء فيه، أعلى حقول النموذج (على سبيل المثال، قيمة [الخصائص المخزنة مؤقتا][functools.cached_property]).
model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) -> Self
المعلمات
| الاسم | الوصف |
|---|---|
|
update
مطلوب
|
القيم المراد تغييرها/إضافتها في النموذج الجديد. ملاحظة: لم يتم التحقق من صحة البيانات قبل إنشاء النموذج الجديد. يجب أن تثق بهذه البيانات. |
|
deep
مطلوب
|
اضبط على True لإنشاء نسخة عميقة من النموذج. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
update
|
القيمة الافتراضية: None
|
|
deep
|
القيمة الافتراضية: False
|
المرتجعات
| النوع | الوصف |
|---|---|
|
مثيل نموذج جديد. |
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 فيه. إذا كان الوضع هو "json"، فسيحتوي الإخراج على أنواع JSON القابلة للتسلسل فقط. إذا كان الوضع هو "python"، فقد يحتوي الإخراج على كائنات Python غير قابلة للتسلسل JSON. |
|
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
مطلوب
|
سياق إضافي لتمريره إلى التسلسل. |
|
by_alias
مطلوب
|
ما إذا كان يجب استخدام الاسم المستعار للحقل في مفتاح القاموس إذا تم تعريفه. |
|
exclude_unset
مطلوب
|
ما إذا كان سيتم استبعاد الحقول التي لم يتم تعيينها بشكل صريح. |
|
exclude_defaults
مطلوب
|
ما إذا كان سيتم استبعاد الحقول التي تم تعيينها إلى قيمتها الافتراضية. |
|
exclude_none
مطلوب
|
ما إذا كان سيتم استبعاد الحقول التي تحتوي على قيمة بلا. |
|
exclude_computed_fields
مطلوب
|
ما إذا كان سيتم استبعاد الحقول المحسوبة. في حين أن هذا يمكن أن يكون مفيدا للتنقل ذهابا وإيابا، يوصى عادة باستخدام المعلمة round_trip المخصصة بدلا من ذلك. |
|
round_trip
مطلوب
|
إذا كانت True، يجب أن تكون القيم المفرغة صالحة كإدخال لأنواع غير متكررة مثل Json[T]. |
|
warnings
مطلوب
|
كيفية معالجة أخطاء التسلسل. يتجاهل False/"none" أخطاء سجلات True/"warn"، ويثير "خطأ" [PydanticSerializationError][pydantic_core. PydanticSerializationError]. |
|
fallback
مطلوب
|
دالة لاستدعاء عند مواجهة قيمة غير معروفة. إذا لم يتم توفيره، [PydanticSerializationError][pydantic_core. يتم رفع خطأ PydanticSerializationError]. |
|
serialize_as_any
مطلوب
|
ما إذا كان يجب تسلسل الحقول باستخدام سلوك تسلسل الكتابة البطية. |
|
polymorphic_serialization
مطلوب
|
ما إذا كان يجب استخدام التسلسل متعدد الأشكال للنموذج وفئة البيانات لهذا الاستدعاء. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
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
|
المرتجعات
| النوع | الوصف |
|---|---|
|
تمثيل قاموس للنموذج. |
model_dump_json
!!! model_dump_json "وثائق الاستخدام" المجردة
إنشاء تمثيل JSON للنموذج باستخدام أسلوب 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
المعلمات
| الاسم | الوصف |
|---|---|
|
indent
مطلوب
|
المسافة البادئة لاستخدامها في إخراج JSON. إذا تم تمرير None، فسيكون الإخراج مضغوطا. |
|
ensure_ascii
مطلوب
|
إذا كان صحيحا، يضمن الإخراج إلغاء كافة الأحرف الواردة غير 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
مطلوب
|
سياق إضافي لتمريره إلى التسلسل. |
|
by_alias
مطلوب
|
ما إذا كان يجب إجراء تسلسل باستخدام الأسماء المستعارة للحقل. |
|
exclude_unset
مطلوب
|
ما إذا كان سيتم استبعاد الحقول التي لم يتم تعيينها بشكل صريح. |
|
exclude_defaults
مطلوب
|
ما إذا كان سيتم استبعاد الحقول التي تم تعيينها إلى قيمتها الافتراضية. |
|
exclude_none
مطلوب
|
ما إذا كان سيتم استبعاد الحقول التي تحتوي على قيمة بلا. |
|
exclude_computed_fields
مطلوب
|
ما إذا كان سيتم استبعاد الحقول المحسوبة. في حين أن هذا يمكن أن يكون مفيدا للتنقل ذهابا وإيابا، يوصى عادة باستخدام المعلمة round_trip المخصصة بدلا من ذلك. |
|
round_trip
مطلوب
|
إذا كانت True، يجب أن تكون القيم المفرغة صالحة كإدخال لأنواع غير متكررة مثل Json[T]. |
|
warnings
مطلوب
|
كيفية معالجة أخطاء التسلسل. يتجاهل False/"none" أخطاء سجلات True/"warn"، ويثير "خطأ" [PydanticSerializationError][pydantic_core. PydanticSerializationError]. |
|
fallback
مطلوب
|
دالة لاستدعاء عند مواجهة قيمة غير معروفة. إذا لم يتم توفيره، [PydanticSerializationError][pydantic_core. يتم رفع خطأ PydanticSerializationError]. |
|
serialize_as_any
مطلوب
|
ما إذا كان يجب تسلسل الحقول باستخدام سلوك تسلسل الكتابة البطية. |
|
polymorphic_serialization
مطلوب
|
ما إذا كان يجب استخدام التسلسل متعدد الأشكال للنموذج وفئة البيانات لهذا الاستدعاء. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
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
|
المرتجعات
| النوع | الوصف |
|---|---|
|
تمثيل سلسلة 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
|
ما إذا كنت تريد استخدام الأسماء المستعارة للسمة أم لا. القيمة الافتراضية: True
|
|
ref_template
|
القالب المرجعي. القيمة الافتراضية: DEFAULT_REF_TEMPLATE
|
|
union_format
مطلوب
|
Literal['any_of', 'primitive_type_array']
التنسيق الذي يجب استخدامه عند دمج المخططات من الاتحادات معا. يمكن أن يكون أحد:
الكلمة الأساسية لدمج المخططات (الافتراضي).
|
|
schema_generator
|
type[<xref:pydantic.json_schema.GenerateJsonSchema>]
لتجاوز المنطق المستخدم لإنشاء مخطط JSON، كفئة فرعية من GenerateJsonSchema مع التعديلات المطلوبة القيمة الافتراضية: GenerateJsonSchema
|
|
mode
|
Literal['validation', 'serialization']
الوضع الذي يتم فيه إنشاء المخطط. القيمة الافتراضية: 'validation'
|
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
union_format
|
القيمة الافتراضية: 'any_of'
|
المرتجعات
| النوع | الوصف |
|---|---|
|
مخطط JSON لفئة النموذج المحددة. |
model_parametrized_name
حساب اسم الفئة ل parametrizations للفئات العامة.
يمكن تجاوز هذا الأسلوب لتحقيق نظام تسمية مخصص ل BaseModels العامة.
model_parametrized_name(params: tuple[type[Any], ...]) -> str
المعلمات
| الاسم | الوصف |
|---|---|
|
params
مطلوب
|
مجموعة من أنواع الفئة. بالنظر إلى نموذج فئة عام مع متغيرات نوع 2 ونموذج ملموس Model[str، int]، سيتم تمرير القيمة (str، int) إلى params. |
المرتجعات
| النوع | الوصف |
|---|---|
|
سلسلة تمثل الفئة الجديدة حيث يتم تمرير المعلمات إلى cls كمتغيرات النوع. |
استثناءات
| النوع | الوصف |
|---|---|
|
يرفع عند محاولة إنشاء أسماء ملموسة للنماذج غير العامة. |
model_post_init
model_rebuild
حاول إعادة إنشاء مخطط pydantic-core للنموذج.
قد يكون هذا ضروريا عندما يكون أحد التعليقات التوضيحية هو ForwardRef الذي تعذر حله أثناء المحاولة الأولية لإنشاء المخطط، وفشل إعادة البناء التلقائي.
model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: MappingNamespace | None = None) -> bool | None
المعلمات
| الاسم | الوصف |
|---|---|
|
force
مطلوب
|
ما إذا كان يجب فرض إعادة إنشاء مخطط النموذج، يتم تعيين الإعدادات الافتراضية إلى False. |
|
raise_errors
مطلوب
|
ما إذا كنت تريد رفع الأخطاء، يتم تعيين الإعدادات الافتراضية إلى True. |
|
_parent_namespace_depth
مطلوب
|
مستوى عمق مساحة الاسم الأصل، افتراضيا إلى 2. |
|
_types_namespace
مطلوب
|
<xref:MappingNamespace> | None
مساحة اسم الأنواع، افتراضيا إلى بلا. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
force
|
القيمة الافتراضية: False
|
|
raise_errors
|
القيمة الافتراضية: True
|
|
_parent_namespace_depth
|
القيمة الافتراضية: 2
|
|
_types_namespace
|
القيمة الافتراضية: None
|
المرتجعات
| النوع | الوصف |
|---|---|
|
إرجاع بلا إذا كان المخطط "مكتملا" بالفعل ولم تكن إعادة البناء مطلوبة. إذا كانت إعادة البناء مطلوبة، فترجعTrue إذا كانت إعادة البناء ناجحة، وإلا تكون False. |
model_validate
التحقق من صحة مثيل نموذج pydantic.
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
مطلوب
|
الكائن المراد التحقق من صحته. |
|
strict
مطلوب
|
ما إذا كان يجب فرض الأنواع بدقة. |
|
extra
مطلوب
|
Literal['allow', 'ignore', 'forbid'] | None
ما إذا كان سيتم تجاهل البيانات الإضافية أو السماح بها أو منعها أثناء التحقق من صحة النموذج. راجع [قيمة التكوين الإضافية ][pydantic. ConfigDict.extra] للحصول على التفاصيل. |
|
from_attributes
مطلوب
|
ما إذا كان يجب استخراج البيانات من سمات الكائن. |
|
context
مطلوب
|
سياق إضافي لتمريره إلى المدقق. |
|
by_alias
مطلوب
|
ما إذا كنت تريد استخدام الاسم المستعار للحقل عند التحقق من صحة بيانات الإدخال المتوفرة. |
|
by_name
مطلوب
|
ما إذا كنت تريد استخدام اسم الحقل عند التحقق من صحة بيانات الإدخال المتوفرة. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
strict
|
القيمة الافتراضية: None
|
|
extra
|
القيمة الافتراضية: None
|
|
from_attributes
|
القيمة الافتراضية: None
|
|
context
|
القيمة الافتراضية: None
|
|
by_alias
|
القيمة الافتراضية: None
|
|
by_name
|
القيمة الافتراضية: None
|
المرتجعات
| النوع | الوصف |
|---|---|
|
مثيل النموذج الذي تم التحقق من صحته. |
استثناءات
| النوع | الوصف |
|---|---|
|
ValidationError
|
إذا تعذر التحقق من صحة الكائن. |
model_validate_json
!!! تحليل JSON ل "وثائق الاستخدام" المجردة
تحقق من صحة بيانات JSON المحددة مقابل نموذج 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
المعلمات
| الاسم | الوصف |
|---|---|
|
json_data
مطلوب
|
بيانات JSON للتحقق من صحتها. |
|
strict
مطلوب
|
ما إذا كان يجب فرض الأنواع بدقة. |
|
extra
مطلوب
|
Literal['allow', 'ignore', 'forbid'] | None
ما إذا كان سيتم تجاهل البيانات الإضافية أو السماح بها أو منعها أثناء التحقق من صحة النموذج. راجع [قيمة التكوين الإضافية ][pydantic. ConfigDict.extra] للحصول على التفاصيل. |
|
context
مطلوب
|
متغيرات إضافية لتمريرها إلى المدقق. |
|
by_alias
مطلوب
|
ما إذا كنت تريد استخدام الاسم المستعار للحقل عند التحقق من صحة بيانات الإدخال المتوفرة. |
|
by_name
مطلوب
|
ما إذا كنت تريد استخدام اسم الحقل عند التحقق من صحة بيانات الإدخال المتوفرة. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
strict
|
القيمة الافتراضية: None
|
|
extra
|
القيمة الافتراضية: None
|
|
context
|
القيمة الافتراضية: None
|
|
by_alias
|
القيمة الافتراضية: None
|
|
by_name
|
القيمة الافتراضية: None
|
المرتجعات
| النوع | الوصف |
|---|---|
|
نموذج Pydantic الذي تم التحقق من صحته. |
استثناءات
| النوع | الوصف |
|---|---|
|
ValidationError
|
إذا لم تكن json_data سلسلة JSON أو تعذر التحقق من صحة الكائن. |
model_validate_strings
تحقق من صحة الكائن المحدد باستخدام بيانات السلسلة مقابل نموذج 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
المعلمات
| الاسم | الوصف |
|---|---|
|
obj
مطلوب
|
الكائن الذي يحتوي على بيانات سلسلة للتحقق من صحته. |
|
strict
مطلوب
|
ما إذا كان يجب فرض الأنواع بدقة. |
|
extra
مطلوب
|
Literal['allow', 'ignore', 'forbid'] | None
ما إذا كان سيتم تجاهل البيانات الإضافية أو السماح بها أو منعها أثناء التحقق من صحة النموذج. راجع [قيمة التكوين الإضافية ][pydantic. ConfigDict.extra] للحصول على التفاصيل. |
|
context
مطلوب
|
متغيرات إضافية لتمريرها إلى المدقق. |
|
by_alias
مطلوب
|
ما إذا كنت تريد استخدام الاسم المستعار للحقل عند التحقق من صحة بيانات الإدخال المتوفرة. |
|
by_name
مطلوب
|
ما إذا كنت تريد استخدام اسم الحقل عند التحقق من صحة بيانات الإدخال المتوفرة. |
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
strict
|
القيمة الافتراضية: None
|
|
extra
|
القيمة الافتراضية: None
|
|
context
|
القيمة الافتراضية: None
|
|
by_alias
|
القيمة الافتراضية: None
|
|
by_name
|
القيمة الافتراضية: None
|
المرتجعات
| النوع | الوصف |
|---|---|
|
نموذج Pydantic الذي تم التحقق من صحته. |
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
مطلوب
|
|
|
encoding
مطلوب
|
|
|
proto
مطلوب
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
مطلوب
|
|
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
content_type
|
القيمة الافتراضية: None
|
|
encoding
|
القيمة الافتراضية: 'utf8'
|
|
proto
|
القيمة الافتراضية: None
|
|
allow_pickle
|
القيمة الافتراضية: False
|
المرتجعات
| النوع | الوصف |
|---|---|
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
مطلوب
|
|
|
content_type
مطلوب
|
|
|
encoding
مطلوب
|
|
|
proto
مطلوب
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
مطلوب
|
|
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
content_type
|
القيمة الافتراضية: None
|
|
encoding
|
القيمة الافتراضية: 'utf8'
|
|
proto
|
القيمة الافتراضية: None
|
|
allow_pickle
|
القيمة الافتراضية: False
|
المرتجعات
| النوع | الوصف |
|---|---|
schema
schema_json
schema_json(*, by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, **dumps_kwargs: Any) -> str
المعلمات
| الاسم | الوصف |
|---|---|
|
by_alias
مطلوب
|
|
|
ref_template
مطلوب
|
|
|
dumps_kwargs
مطلوب
|
|
معلمات الكلمة الأساسية فقط
| الاسم | الوصف |
|---|---|
|
by_alias
|
القيمة الافتراضية: True
|
|
ref_template
|
القيمة الافتراضية: DEFAULT_REF_TEMPLATE
|
المرتجعات
| النوع | الوصف |
|---|---|
update_forward_refs
validate
السمات
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