ChatHistoryMessage Κλάση
Αντιπροσωπεύει ένα μεμονωμένο μήνυμα στο ιστορικό συνομιλίας.
Αυτό το μοντέλο χρησιμοποιείται για την καταγραφή μεμονωμένων μηνυμάτων που ανταλλάσσουν μεταξύ των χρηστών και του βοηθού AI για ανάλυση προηγμένης προστασίας και παρακολούθηση συμμόρφωσης.
Κατασκευή
pydantic model ChatHistoryMessage
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
id
|
Default value: None
|
|
role
Απαιτείται
|
|
|
content
Απαιτείται
|
|
|
timestamp
|
Default value: 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] αντιγράφεται. Αυτό μπορεί να έχει μη αναμενόμενες παρενέργειες εάν αποθηκεύετε οτιδήποτε σε αυτό, με βάση τα πεδία μοντέλου (π.χ. την τιμή [ιδιότητες στο cache][functools.cached_property]). |
| model_dump |
!!! αφηρημένη "Τεκμηρίωση χρήσης" model_dump Δημιουργήστε μια αναπαράσταση λεξικού του μοντέλου, καθορίζοντας προαιρετικά ποια πεδία θα συμπεριληφθούν ή εξαιρεθούν. |
| model_dump_json |
!!! αφηρημένη "Τεκμηρίωση χρήσης" model_dump_json Δημιουργεί μια αναπαράσταση JSON του μοντέλου χρησιμοποιώντας τη μέθοδο to_json του Pydantic. |
| model_json_schema |
Δημιουργεί ένα σχήμα JSON για μια κλάση μοντέλου. |
| model_parametrized_name |
Υπολογίστε το όνομα κλάσης για παραμετροποιήσεις γενικών κλάσεων. Αυτή η μέθοδος μπορεί να παρακαμπθεί για να επιτευχθεί ένας συνδυασμός προσαρμοσμένης ονοματοθεσίας για γενικά BaseModels. |
| model_post_init |
Αντικαταστήστε αυτήν τη μέθοδο για να εκτελέσετε πρόσθετη προετοιμασία μετά την εισαγωγή και model_construct. Αυτό είναι χρήσιμο εάν θέλετε να κάνετε κάποια επικύρωση που απαιτεί την προετοιμασία ολόκληρου του μοντέλου. |
| model_rebuild |
Προσπαθήστε να δημιουργήσετε ξανά το σχήμα πυδανικού πυρήνα για το μοντέλο. Αυτό μπορεί να είναι απαραίτητο όταν ένα από τα σχόλια είναι ένα 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
|
Default value: None
|
|
exclude
|
Default value: None
|
|
update
|
Default value: None
|
|
deep
|
Default value: 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
|
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
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
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
Παράμετροι
| Όνομα | Περιγραφή |
|---|---|
|
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
|
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
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
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]. Διαφορετικά, θα χρησιμοποιηθούν τα ονόματα πεδίων από το όρισμα τιμών . Default value: None
|
|
values
Απαιτείται
|
Λεξικό αξιόπιστων ή προ-επικυρωμένων δεδομένων. |
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Μια νέα παρουσία της κλάσης μοντέλου με επικυρωμένα δεδομένα. |
model_copy
!!! αφηρημένη "Τεκμηρίωση χρήσης" model_copy
Επιστρέφει ένα αντίγραφο του μοντέλου.
!!! σημείωση Το [dict][αντικείμενο της υποκείμενη παρουσίας.το χαρακτηριστικό dict] αντιγράφεται. Αυτό μπορεί να έχει μη αναμενόμενες παρενέργειες εάν αποθηκεύετε οτιδήποτε σε αυτό, με βάση τα πεδία μοντέλου (π.χ. την τιμή [ιδιότητες στο cache][functools.cached_property]).
model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) -> Self
Παράμετροι
| Όνομα | Περιγραφή |
|---|---|
|
update
Απαιτείται
|
Τιμές για αλλαγή/προσθήκη στο νέο μοντέλο. Σημείωση: τα δεδομένα δεν επικυρώνονται πριν από τη δημιουργία του νέου μοντέλου. Θα πρέπει να εμπιστεύεστε αυτά τα δεδομένα. |
|
deep
Απαιτείται
|
Ορίστε την σε True για να δημιουργήσετε ένα αντίγραφο του μοντέλου σε βάθος. |
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
update
|
Default value: None
|
|
deep
|
Default value: 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
Απαιτείται
|
Εάν θα εξαιρέσετε πεδία που έχουν τιμή None. |
|
exclude_computed_fields
Απαιτείται
|
Εάν θα εξαιρεθούν τα υπολογισμμένα πεδία. Παρόλο που αυτό μπορεί να είναι χρήσιμο για τη διαδρομή μετ 'επιστροφής, συνήθως συνιστάται η χρήση της αποκλειστικής παραμέτρου round_trip . |
|
round_trip
Απαιτείται
|
Εάν είναι True, οι τιμές που αποτελούν αντικείμενο ντάμπινγκ θα πρέπει να είναι έγκυρες ως δεδομένα εισόδου για μη ταυτοδύναμους τύπους, όπως το Json[T]. |
|
warnings
Απαιτείται
|
Τρόπος χειρισμού σφαλμάτων σειριοποίησης. Τα στοιχεία false/"none" τα παραβλέπουν, σφάλματα αρχείων καταγραφής True/"warn", το "error" προκαλεί [PydanticSerializationError][pydantic_core. PydanticSerializationError]. |
|
fallback
Απαιτείται
|
Μια συνάρτηση που θα καλέσει όταν παρουσιαστεί μια άγνωστη τιμή. Εάν δεν παρέχεται, μια [PydanticSerializationError][pydantic_core. Το σφάλμα PydanticSerializationError] προκαλείται. |
|
serialize_as_any
Απαιτείται
|
Ορίζει εάν θα γίνει σειριοποίηση πεδίων με συμπεριφορά σειριοποίησης πληκτρολόγησης πάπιας. |
|
polymorphic_serialization
Απαιτείται
|
Εάν θα χρησιμοποιήσετε το μοντέλο και την πολυμορφική σειριοποίηση κλάσης δεδομένων για αυτή την κλήση. |
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
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
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Μια αναπαράσταση λεξικού του μοντέλου. |
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. Εάν δεν διαβιβαστεί καμία, η έξοδος θα είναι συμπαγής. |
|
ensure_ascii
Απαιτείται
|
Εάν είναι True, η έξοδος εγγυάται ότι θα διαφύγουν όλοι οι εισερχόμενοι χαρακτήρες μη 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
Απαιτείται
|
Εάν θα εξαιρέσετε πεδία που έχουν τιμή None. |
|
exclude_computed_fields
Απαιτείται
|
Εάν θα εξαιρεθούν τα υπολογισμμένα πεδία. Παρόλο που αυτό μπορεί να είναι χρήσιμο για τη διαδρομή μετ 'επιστροφής, συνήθως συνιστάται η χρήση της αποκλειστικής παραμέτρου round_trip . |
|
round_trip
Απαιτείται
|
Εάν είναι True, οι τιμές που αποτελούν αντικείμενο ντάμπινγκ θα πρέπει να είναι έγκυρες ως δεδομένα εισόδου για μη ταυτοδύναμους τύπους, όπως το Json[T]. |
|
warnings
Απαιτείται
|
Τρόπος χειρισμού σφαλμάτων σειριοποίησης. Τα στοιχεία false/"none" τα παραβλέπουν, σφάλματα αρχείων καταγραφής True/"warn", το "error" προκαλεί [PydanticSerializationError][pydantic_core. PydanticSerializationError]. |
|
fallback
Απαιτείται
|
Μια συνάρτηση που θα καλέσει όταν παρουσιαστεί μια άγνωστη τιμή. Εάν δεν παρέχεται, μια [PydanticSerializationError][pydantic_core. Το σφάλμα PydanticSerializationError] προκαλείται. |
|
serialize_as_any
Απαιτείται
|
Ορίζει εάν θα γίνει σειριοποίηση πεδίων με συμπεριφορά σειριοποίησης πληκτρολόγησης πάπιας. |
|
polymorphic_serialization
Απαιτείται
|
Εάν θα χρησιμοποιήσετε το μοντέλο και την πολυμορφική σειριοποίηση κλάσης δεδομένων για αυτή την κλήση. |
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
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
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Μια αναπαράσταση συμβολοσειράς 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
|
Εάν θα χρησιμοποιείτε ψευδώνυμα χαρακτηριστικών ή όχι. Default value: True
|
|
ref_template
|
Το πρότυπο αναφοράς. Default value: DEFAULT_REF_TEMPLATE
|
|
union_format
Απαιτείται
|
Literal['any_of', 'primitive_type_array']
Η μορφή που θα χρησιμοποιηθεί κατά τον συνδυασμό σχημάτων από ενώσεις μαζί. Μπορεί να είναι ένα από τα εξής:
λέξη-κλειδί για τον συνδυασμό σχημάτων (η προεπιλογή).
|
|
schema_generator
|
type[<xref:pydantic.json_schema.GenerateJsonSchema>]
Για να παρακάμψετε τη λογική που χρησιμοποιείται για τη δημιουργία του σχήματος JSON, ως δευτερεύουσα κλάση του GenerateJsonSchema με τις επιθυμητές τροποποιήσεις Default value: GenerateJsonSchema
|
|
mode
|
Literal['validation', 'serialization']
Η λειτουργία στην οποία θα δημιουργηθεί το σχήμα. Default value: 'validation'
|
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
union_format
|
Default value: 'any_of'
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Το σχήμα JSON για τη δεδομένη κλάση μοντέλου. |
model_parametrized_name
Υπολογίστε το όνομα κλάσης για παραμετροποιήσεις γενικών κλάσεων.
Αυτή η μέθοδος μπορεί να παρακαμπθεί για να επιτευχθεί ένας συνδυασμός προσαρμοσμένης ονοματοθεσίας για γενικά BaseModels.
model_parametrized_name(params: tuple[type[Any], ...]) -> str
Παράμετροι
| Όνομα | Περιγραφή |
|---|---|
|
params
Απαιτείται
|
Πλειάδα τύπων της κλάσης. Δεδομένου ενός γενικού μοντέλου κλάσης με μεταβλητές τύπου 2 και ενός μοντέλου από σκυρόδεμα Model[str, int], η τιμή (str, int) θα μεταβιβαστεί σε παραμέτρους. |
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Συμβολοσειρά που αντιπροσωπεύει τη νέα κλάση όπου οι παράμετροι μεταβιβάζονται σε cls ως μεταβλητές τύπου. |
Εξαιρέσεις
| Τύπος | Περιγραφή |
|---|---|
|
Ενεργοποιείται όταν προσπαθείτε να δημιουργήσετε συγκεκριμένα ονόματα για μη γενικά μοντέλα. |
model_post_init
Αντικαταστήστε αυτήν τη μέθοδο για να εκτελέσετε πρόσθετη προετοιμασία μετά την εισαγωγή και model_construct. Αυτό είναι χρήσιμο εάν θέλετε να κάνετε κάποια επικύρωση που απαιτεί την προετοιμασία ολόκληρου του μοντέλου.
model_post_init(context: Any, /) -> None
Παράμετροι μόνο θέσεις
| Όνομα | Περιγραφή |
|---|---|
|
context
Απαιτείται
|
|
Παράμετροι
| Όνομα | Περιγραφή |
|---|---|
|
context
Απαιτείται
|
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
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
Απαιτείται
|
Εάν θέλετε να επι εξαναγκάήσετε την αναδόμηση του σχήματος μοντέλου, η προεπιλογή είναι False. |
|
raise_errors
Απαιτείται
|
Εάν πρόκειται να προκαλέσει σφάλματα, η προεπιλογή είναι True. |
|
_parent_namespace_depth
Απαιτείται
|
Το επίπεδο βάθους του γονικού χώρου ονομάτων, από προεπιλογή, είναι 2. |
|
_types_namespace
Απαιτείται
|
<xref:MappingNamespace> | None
Ο χώρος ονομάτων τύπων, από προεπιλογή, None. |
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
force
|
Default value: False
|
|
raise_errors
|
Default value: True
|
|
_parent_namespace_depth
|
Default value: 2
|
|
_types_namespace
|
Default value: 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
|
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
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Η επικυρωμένη παρουσία μοντέλου. |
Εξαιρέσεις
| Τύπος | Περιγραφή |
|---|---|
|
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
|
Default value: None
|
|
extra
|
Default value: None
|
|
context
|
Default value: None
|
|
by_alias
|
Default value: None
|
|
by_name
|
Default value: 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
|
Default value: None
|
|
extra
|
Default value: None
|
|
context
|
Default value: None
|
|
by_alias
|
Default value: None
|
|
by_name
|
Default value: 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
|
Default value: None
|
|
encoding
|
Default value: 'utf8'
|
|
proto
|
Default value: None
|
|
allow_pickle
|
Default value: False
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
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
Παράμετροι
| Όνομα | Περιγραφή |
|---|---|
|
b
Απαιτείται
|
|
|
content_type
Απαιτείται
|
|
|
encoding
Απαιτείται
|
|
|
proto
Απαιτείται
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
Απαιτείται
|
|
Παράμετροι μόνο λέξεων-κλειδιών
| Όνομα | Περιγραφή |
|---|---|
|
content_type
|
Default value: None
|
|
encoding
|
Default value: 'utf8'
|
|
proto
|
Default value: None
|
|
allow_pickle
|
Default value: 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
|
Default value: True
|
|
ref_template
|
Default value: DEFAULT_REF_TEMPLATE
|
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
update_forward_refs
validate
Χαρακτηριστικά
model_extra
Λάβετε επιπλέον πεδία που έχουν οριστεί κατά την επικύρωση.
Επιστροφές
| Τύπος | Περιγραφή |
|---|---|
|
Ένα λεξικό με επιπλέον πεδία ή Κανένα εάν το config.extra δεν έχει οριστεί σε "allow". |
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