ChatHistoryMessage Sınıf
Sohbet geçmişindeki tek bir iletiyi temsil eder.
Bu model, tehdit koruma analizi ve uyumluluk izleme için kullanıcılar ve yapay zeka yardımcısı arasında tek tek ileti alışverişi yapmak için kullanılır.
Oluşturucu
pydantic model ChatHistoryMessage
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
id
|
Default value: None
|
|
role
Gerekli
|
|
|
content
Gerekli
|
|
|
timestamp
|
Default value: None
|
Örnekler
>>> message = ChatHistoryMessage(role="user", content="Hello, how can you help?")
>>> print(message.role)
'user'
>>> print(message.content)
'Hello, how can you help?'
Yöntemler
| __init__ |
Anahtar sözcük bağımsız değişkenlerinden giriş verilerini ayrıştırarak ve doğrulayarak yeni bir model oluşturun. [ValidationError][pydantic_core yükseltir. ValidationError] giriş verileri geçerli bir model oluşturacak şekilde doğrulanamıyorsa. self , alan adı olarak self'e izin vermek için açıkça yalnızca konumsaldır. |
| __new__ | |
| construct | |
| content_not_empty |
İçeriğin boş veya yalnızca boşluk olmadığını doğrulayın. |
| copy |
Modelin bir kopyasını döndürür. !!! uyarı "Kullanım dışı" Bu yöntem artık kullanım dışı bırakıldı; yerine model_copy kullanın. Dahil etmeniz veya dışlamanız gerekiyorsa şunu kullanın:
|
| dict | |
| from_orm | |
| json | |
| model_construct |
Doğrulanmış verilerle Model sınıfının yeni bir örneğini oluşturur. Güvenilen veya önceden doğrulanmış verilerden dikte ve pydantic_fields_set yeni bir model ayarı oluşturur. Varsayılan değerlere uyulur, ancak başka doğrulama yapılmaz. !!! not model_construct() genellikle sağlanan modeldeki model_config.extra ayarını dikkate alır. Başka bir ifadeyle , model_config.extra == 'allow' ise, tüm ek geçirilen değerler model örneğinin dikte ve pydantic_extra alanlarına eklenir. model_config.extra == 'yoksay' (varsayılan) ise, tüm ek geçirilen değerler yoksayılır. model_construct() çağrısıyla doğrulama yapılmadığından, model_config.extra == 'yasak' olması, ek değerler geçirilirse hataya neden olmaz, ancak yoksayılır. |
| model_copy |
!!! soyut "Kullanım Belgeleri" model_copy Modelin bir kopyasını döndürür. !!! not Temel alınan örneğin [dict][nesnesi.dict] özniteliği kopyalandı. Model alanlarının (örneğin[önbelleğe alınmış özellikler][functools.cached_property] değeri) üzerinde herhangi bir şey depolarsanız bu beklenmeyen yan etkilere neden olabilir. |
| model_dump |
!!! özet "Kullanım Belgeleri" model_dump İsteğe bağlı olarak hangi alanların dahilleneceğini veya hariç tutulacağını belirterek modelin sözlük gösterimini oluşturun. |
| model_dump_json |
!!! özet "Kullanım Belgeleri" model_dump_json Pydantic'in to_json yöntemini kullanarak modelin JSON gösterimini oluşturur. |
| model_json_schema |
Model sınıfı için bir JSON şeması oluşturur. |
| model_parametrized_name |
Genel sınıfların parametrizasyonları için sınıf adını hesaplama. Genel BaseModel'ler için özel bir adlandırma düzeni elde etmek için bu yöntem geçersiz kılınabilir. |
| model_post_init |
Başlatma vemodel_construct sonra ek başlatma gerçekleştirmek için bu yöntemi geçersiz kılın. Modelin tamamının başlatılmasını gerektiren bir doğrulama yapmak istiyorsanız bu yararlı olur. |
| model_rebuild |
Modelin pydantic-core şemasını yeniden oluşturmayı deneyin. Ek açıklamalardan biri, şemayı derlemeye yönelik ilk girişim sırasında çözümlenemeyen bir ForwardRef olduğunda ve otomatik yeniden derleme başarısız olduğunda bu gerekli olabilir. |
| model_validate |
Pydantik model örneğini doğrulayın. |
| model_validate_json |
!!! soyut "Kullanım Belgeleri" JSON Ayrıştırma Verilen JSON verilerini Pydantic modeline göre doğrulayın. |
| model_validate_strings |
Verilen nesneyi Pydantic modeline karşı dize verileriyle doğrulayın. |
| parse_file | |
| parse_obj | |
| parse_raw | |
| schema | |
| schema_json | |
| update_forward_refs | |
| validate |
__init__
Anahtar sözcük bağımsız değişkenlerinden giriş verilerini ayrıştırarak ve doğrulayarak yeni bir model oluşturun.
[ValidationError][pydantic_core yükseltir. ValidationError] giriş verileri geçerli bir model oluşturacak şekilde doğrulanamıyorsa.
self , alan adı olarak self'e izin vermek için açıkça yalnızca konumsaldır.
__init__(**data: Any) -> None
Parametreler
| Name | Description |
|---|---|
|
data
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
__new__
__new__(**kwargs)
construct
content_not_empty
copy
Modelin bir kopyasını döndürür.
!!! uyarı "Kullanım dışı" Bu yöntem artık kullanım dışı bırakıldı; yerine model_copy kullanın.
Dahil etmeniz veya dışlamanız gerekiyorsa şunu kullanın:
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
Parametreler
| Name | Description |
|---|---|
|
include
Gerekli
|
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None
Kopyalanan modele eklenecek alanları belirten isteğe bağlı küme veya eşleme. |
|
exclude
Gerekli
|
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None
Kopyalanan modelde hangi alanların hariç tutulacağını belirten isteğe bağlı küme veya eşleme. |
|
update
Gerekli
|
Kopyalanan modeldeki alan değerlerini geçersiz kılmak için isteğe bağlı alan-değer çiftleri sözlüğü. |
|
deep
Gerekli
|
True ise, Pydantic modelleri olan alanların değerleri ayrıntılı olarak kopyalanır. |
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
include
|
Default value: None
|
|
exclude
|
Default value: None
|
|
update
|
Default value: None
|
|
deep
|
Default value: False
|
Döndürülenler
| Tür | Description |
|---|---|
|
Modelin belirtilen şekilde dahil edilen, dışlanan ve güncelleştirilen alanları olan bir kopyası. |
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]
Parametreler
| Name | Description |
|---|---|
|
include
Gerekli
|
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
Gerekli
|
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
Gerekli
|
|
|
exclude_unset
Gerekli
|
|
|
exclude_defaults
Gerekli
|
|
|
exclude_none
Gerekli
|
|
Yalnızca Anahtar Sözcük Parametreleri
| 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
|
Döndürülenler
| Tür | 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
Parametreler
| Name | Description |
|---|---|
|
include
Gerekli
|
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
Gerekli
|
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
Gerekli
|
|
|
exclude_unset
Gerekli
|
|
|
exclude_defaults
Gerekli
|
|
|
exclude_none
Gerekli
|
|
|
encoder
Gerekli
|
|
|
models_as_dict
Gerekli
|
|
|
dumps_kwargs
Gerekli
|
|
Yalnızca Anahtar Sözcük Parametreleri
| 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
|
Döndürülenler
| Tür | Description |
|---|---|
model_construct
Doğrulanmış verilerle Model sınıfının yeni bir örneğini oluşturur.
Güvenilen veya önceden doğrulanmış verilerden dikte ve pydantic_fields_set yeni bir model ayarı oluşturur. Varsayılan değerlere uyulur, ancak başka doğrulama yapılmaz.
!!! not model_construct() genellikle sağlanan modeldeki model_config.extra ayarını dikkate alır. Başka bir ifadeyle , model_config.extra == 'allow' ise, tüm ek geçirilen değerler model örneğinin dikte ve pydantic_extra alanlarına eklenir. model_config.extra == 'yoksay' (varsayılan) ise, tüm ek geçirilen değerler yoksayılır. model_construct() çağrısıyla doğrulama yapılmadığından, model_config.extra == 'yasak' olması, ek değerler geçirilirse hataya neden olmaz, ancak yoksayılır.
model_construct(_fields_set: set[str] | None = None, **values: Any) -> Self
Parametreler
| Name | Description |
|---|---|
|
_fields_set
|
Başlangıçta örnek oluşturma sırasında açıkça ayarlanan alan adları kümesi. Sağlanırsa, bu doğrudan [model_fields_set][pydantic için kullanılır. BaseModel.model_fields_set] özniteliği. Aksi takdirde, değerler bağımsız değişkeninden alan adları kullanılır. Default value: None
|
|
values
Gerekli
|
Güvenilir veya önceden doğrulanmış veri sözlüğü. |
Döndürülenler
| Tür | Description |
|---|---|
|
Doğrulanmış verilerle Model sınıfının yeni bir örneği. |
model_copy
!!! soyut "Kullanım Belgeleri" model_copy
Modelin bir kopyasını döndürür.
!!! not Temel alınan örneğin [dict][nesnesi.dict] özniteliği kopyalandı. Model alanlarının (örneğin[önbelleğe alınmış özellikler][functools.cached_property] değeri) üzerinde herhangi bir şey depolarsanız bu beklenmeyen yan etkilere neden olabilir.
model_copy(*, update: Mapping[str, Any] | None = None, deep: bool = False) -> Self
Parametreler
| Name | Description |
|---|---|
|
update
Gerekli
|
Yeni modelde değiştirecek/eklenecek değerler. Not: Yeni model oluşturulmadan önce veriler doğrulanmaz. Bu verilere güvenmeniz gerekir. |
|
deep
Gerekli
|
Modelin derin bir kopyasını oluşturmak için True olarak ayarlayın. |
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
update
|
Default value: None
|
|
deep
|
Default value: False
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yeni model örneği. |
model_dump
!!! özet "Kullanım Belgeleri" model_dump
İsteğe bağlı olarak hangi alanların dahilleneceğini veya hariç tutulacağını belirterek modelin sözlük gösterimini oluşturun.
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]
Parametreler
| Name | Description |
|---|---|
|
mode
Gerekli
|
Literal['json', 'python'] | str
to_python çalıştırılması gereken mod. Mod 'json' ise, çıkış yalnızca JSON serileştirilebilir türleri içerir. Mod 'python' ise çıkış JSON tarafından serileştirilebilir olmayan Python nesneleri içerebilir. |
|
include
Gerekli
|
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
Çıktıya eklenecek bir alan kümesi. |
|
exclude
Gerekli
|
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
Çıktının dışında tutulacak bir alan kümesi. |
|
context
Gerekli
|
Seri hale getiriciye geçirmek için ek bağlam. |
|
by_alias
Gerekli
|
Tanımlanmışsa sözlük anahtarında alanın diğer adının kullanılıp kullanılmaymayacağı. |
|
exclude_unset
Gerekli
|
Açıkça ayarlanmamış alanların dışlanıp dışlanmaymayacağı. |
|
exclude_defaults
Gerekli
|
Varsayılan değerlerine ayarlanmış alanların dışlanıp dışlanmayacağı. |
|
exclude_none
Gerekli
|
Yok değerine sahip alanların dışlanıp dışlanmaymayacağı. |
|
exclude_computed_fields
Gerekli
|
Hesaplanan alanların dışlanıp dışlanmayacağınız. Bu, yuvarlama için yararlı olsa da, genellikle bunun yerine ayrılmış round_trip parametresinin kullanılması önerilir. |
|
round_trip
Gerekli
|
True ise, döküm değerleri Json[T] gibi bir kez etkili olmayan türler için giriş olarak geçerli olmalıdır. |
|
warnings
Gerekli
|
Serileştirme hatalarını işleme. False/"none" bunları yoksayar, True/"warn" hataları günlüğe kaydeder, "error" bir [PydanticSerializationError][pydantic_core oluşturur. PydanticSerializationError]. |
|
fallback
Gerekli
|
Bilinmeyen bir değerle karşılaşıldığında çağrılacak bir işlev. Sağlanmadıysa, [PydanticSerializationError][pydantic_core. PydanticSerializationError] hatası oluştu. |
|
serialize_as_any
Gerekli
|
Ördek yazma serileştirme davranışıyla alanların serileştirilip serileştirileceği. |
|
polymorphic_serialization
Gerekli
|
Bu çağrı için model ve veri sınıfı polimorfik serileştirmenin kullanılıp kullanılmaymayacağı. |
Yalnızca Anahtar Sözcük Parametreleri
| 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
|
Döndürülenler
| Tür | Description |
|---|---|
|
Modelin sözlük gösterimi. |
model_dump_json
!!! özet "Kullanım Belgeleri" model_dump_json
Pydantic'in to_json yöntemini kullanarak modelin JSON gösterimini oluşturur.
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
Parametreler
| Name | Description |
|---|---|
|
indent
Gerekli
|
JSON çıkışında kullanılacak girintileme. Hiçbiri geçirilirse çıkış sıkıştırılır. |
|
ensure_ascii
Gerekli
|
True ise, çıkışta tüm gelen ASCII olmayan karakterlerin kaçması garanti edilir. False (varsayılan) ise, bu karakterler as-isçıkış olacaktır. |
|
include
Gerekli
|
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 çıkışına eklenecek alan(lar). |
|
exclude
Gerekli
|
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 çıkışının dışında tutulacak alan veya alan. |
|
context
Gerekli
|
Seri hale getiriciye geçirmek için ek bağlam. |
|
by_alias
Gerekli
|
Alan diğer adları kullanılarak serileştirilip serileştirilip serileştirılmayacağı. |
|
exclude_unset
Gerekli
|
Açıkça ayarlanmamış alanların dışlanıp dışlanmaymayacağı. |
|
exclude_defaults
Gerekli
|
Varsayılan değerlerine ayarlanmış alanların dışlanıp dışlanmayacağı. |
|
exclude_none
Gerekli
|
Yok değerine sahip alanların dışlanıp dışlanmaymayacağı. |
|
exclude_computed_fields
Gerekli
|
Hesaplanan alanların dışlanıp dışlanmayacağınız. Bu, yuvarlama için yararlı olsa da, genellikle bunun yerine ayrılmış round_trip parametresinin kullanılması önerilir. |
|
round_trip
Gerekli
|
True ise, döküm değerleri Json[T] gibi bir kez etkili olmayan türler için giriş olarak geçerli olmalıdır. |
|
warnings
Gerekli
|
Serileştirme hatalarını işleme. False/"none" bunları yoksayar, True/"warn" hataları günlüğe kaydeder, "error" bir [PydanticSerializationError][pydantic_core oluşturur. PydanticSerializationError]. |
|
fallback
Gerekli
|
Bilinmeyen bir değerle karşılaşıldığında çağrılacak bir işlev. Sağlanmadıysa, [PydanticSerializationError][pydantic_core. PydanticSerializationError] hatası oluştu. |
|
serialize_as_any
Gerekli
|
Ördek yazma serileştirme davranışıyla alanların serileştirilip serileştirileceği. |
|
polymorphic_serialization
Gerekli
|
Bu çağrı için model ve veri sınıfı polimorfik serileştirmenin kullanılıp kullanılmaymayacağı. |
Yalnızca Anahtar Sözcük Parametreleri
| 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
|
Döndürülenler
| Tür | Description |
|---|---|
|
Modelin JSON dize gösterimi. |
model_json_schema
Model sınıfı için bir JSON şeması oluşturur.
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]
Parametreler
| Name | Description |
|---|---|
|
by_alias
|
Öznitelik diğer adlarının kullanılıp kullanılmaymayacağı. Default value: True
|
|
ref_template
|
Başvuru şablonu. Default value: DEFAULT_REF_TEMPLATE
|
|
union_format
Gerekli
|
Literal['any_of', 'primitive_type_array']
Birleşimlerden şemaları birleştirirken kullanılacak biçim. Şu türlerden biri olabilir:
anahtar sözcüğünü kullanarak şemaları birleştirin (varsayılan).
|
|
schema_generator
|
type[<xref:pydantic.json_schema.GenerateJsonSchema>]
JSON şemasını oluşturmak için kullanılan mantığı, generateJsonSchema'nın alt sınıfı olarak istediğiniz değişikliklerle geçersiz kılmak için Default value: GenerateJsonSchema
|
|
mode
|
Literal['validation', 'serialization']
Şemanın oluşturulacağı mod. Default value: 'validation'
|
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
union_format
|
Default value: 'any_of'
|
Döndürülenler
| Tür | Description |
|---|---|
|
Verilen model sınıfı için JSON şeması. |
model_parametrized_name
Genel sınıfların parametrizasyonları için sınıf adını hesaplama.
Genel BaseModel'ler için özel bir adlandırma düzeni elde etmek için bu yöntem geçersiz kılınabilir.
model_parametrized_name(params: tuple[type[Any], ...]) -> str
Parametreler
| Name | Description |
|---|---|
|
params
Gerekli
|
Sınıfın türleri tanımlama grubu. 2 tür değişkeni ve somut model Model[str, int] içeren genel bir sınıf Modeli verilmelidir, değer (str, int)parametrelere geçirilir. |
Döndürülenler
| Tür | Description |
|---|---|
|
Parametrelerin tür değişkenleri olarak cls'ye geçirildiği yeni sınıfı temsil eden dize. |
Özel durumlar
| Tür | Description |
|---|---|
|
Genel olmayan modeller için somut adlar oluşturmaya çalışırken oluşturulur. |
model_post_init
Başlatma vemodel_construct sonra ek başlatma gerçekleştirmek için bu yöntemi geçersiz kılın. Modelin tamamının başlatılmasını gerektiren bir doğrulama yapmak istiyorsanız bu yararlı olur.
model_post_init(context: Any, /) -> None
Yalnızca Konumsal Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
model_rebuild
Modelin pydantic-core şemasını yeniden oluşturmayı deneyin.
Ek açıklamalardan biri, şemayı derlemeye yönelik ilk girişim sırasında çözümlenemeyen bir ForwardRef olduğunda ve otomatik yeniden derleme başarısız olduğunda bu gerekli olabilir.
model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: MappingNamespace | None = None) -> bool | None
Parametreler
| Name | Description |
|---|---|
|
force
Gerekli
|
Model şemasının yeniden derlenmesine zorlanılıp zorlanmayacağı, varsayılan olarak False olarak ayarlanır. |
|
raise_errors
Gerekli
|
Hata oluşturup oluşturmayacağı, varsayılan olarak True olarak ayarlanır. |
|
_parent_namespace_depth
Gerekli
|
Üst ad alanının derinlik düzeyi varsayılan olarak 2'ye sahiptir. |
|
_types_namespace
Gerekli
|
<xref:MappingNamespace> | None
Ad alanı türleri varsayılan olarak Yok olarak belirlenir. |
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
force
|
Default value: False
|
|
raise_errors
|
Default value: True
|
|
_parent_namespace_depth
|
Default value: 2
|
|
_types_namespace
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Şema zaten "tamamlandı" ise ve yeniden oluşturma gerekli değilse Hiçbiri döndürür. Yeniden oluşturma gerekliyse , yeniden oluşturma başarılı olursa True , aksi takdirde False döndürür. |
model_validate
Pydantik model örneğini doğrulayın.
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
Parametreler
| Name | Description |
|---|---|
|
obj
Gerekli
|
Doğrulanması gereken nesne. |
|
strict
Gerekli
|
Türlerin kesin olarak zorlanıp zorlanmayacağı. |
|
extra
Gerekli
|
Literal['allow', 'ignore', 'forbid'] | None
Model doğrulama sırasında ek verilerin yoksayılıp yoksayılmayacağı, izin verilip verilmeyeceği. Bkz. [ek yapılandırma değeri][pydantic. Ayrıntılar için ConfigDict.extra] . |
|
from_attributes
Gerekli
|
Nesne özniteliklerinden veri ayıklanıp ayıklanmayacağı. |
|
context
Gerekli
|
Doğrulayıcıya geçirmek için ek bağlam. |
|
by_alias
Gerekli
|
Sağlanan giriş verileriyle doğrulanırken alanın diğer adının kullanılıp kullanılmaymayacağı. |
|
by_name
Gerekli
|
Sağlanan giriş verileriyle doğrulanırken alanın adının kullanılıp kullanılmaymayacağı. |
Yalnızca Anahtar Sözcük Parametreleri
| 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
|
Döndürülenler
| Tür | Description |
|---|---|
|
Doğrulanmış model örneği. |
Özel durumlar
| Tür | Description |
|---|---|
|
ValidationError
|
Nesne doğrulanamadıysa. |
model_validate_json
!!! soyut "Kullanım Belgeleri" JSON Ayrıştırma
Verilen JSON verilerini Pydantic modeline göre doğrulayın.
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
Parametreler
| Name | Description |
|---|---|
|
json_data
Gerekli
|
Doğrulanması gereken JSON verileri. |
|
strict
Gerekli
|
Türlerin kesin olarak zorlanıp zorlanmayacağı. |
|
extra
Gerekli
|
Literal['allow', 'ignore', 'forbid'] | None
Model doğrulama sırasında ek verilerin yoksayılıp yoksayılmayacağı, izin verilip verilmeyeceği. Bkz. [ek yapılandırma değeri][pydantic. Ayrıntılar için ConfigDict.extra] . |
|
context
Gerekli
|
Doğrulayıcıya geçirmek için ek değişkenler. |
|
by_alias
Gerekli
|
Sağlanan giriş verileriyle doğrulanırken alanın diğer adının kullanılıp kullanılmaymayacağı. |
|
by_name
Gerekli
|
Sağlanan giriş verileriyle doğrulanırken alanın adının kullanılıp kullanılmaymayacağı. |
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
strict
|
Default value: None
|
|
extra
|
Default value: None
|
|
context
|
Default value: None
|
|
by_alias
|
Default value: None
|
|
by_name
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Doğrulanmış Pydantik modeli. |
Özel durumlar
| Tür | Description |
|---|---|
|
ValidationError
|
json_data bir JSON dizesi değilse veya nesne doğrulanamadıysa. |
model_validate_strings
Verilen nesneyi Pydantic modeline karşı dize verileriyle doğrulayın.
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
Parametreler
| Name | Description |
|---|---|
|
obj
Gerekli
|
Doğrulanması gereken dize verilerini içeren nesne. |
|
strict
Gerekli
|
Türlerin kesin olarak zorlanıp zorlanmayacağı. |
|
extra
Gerekli
|
Literal['allow', 'ignore', 'forbid'] | None
Model doğrulama sırasında ek verilerin yoksayılıp yoksayılmayacağı, izin verilip verilmeyeceği. Bkz. [ek yapılandırma değeri][pydantic. Ayrıntılar için ConfigDict.extra] . |
|
context
Gerekli
|
Doğrulayıcıya geçirmek için ek değişkenler. |
|
by_alias
Gerekli
|
Sağlanan giriş verileriyle doğrulanırken alanın diğer adının kullanılıp kullanılmaymayacağı. |
|
by_name
Gerekli
|
Sağlanan giriş verileriyle doğrulanırken alanın adının kullanılıp kullanılmaymayacağı. |
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
strict
|
Default value: None
|
|
extra
|
Default value: None
|
|
context
|
Default value: None
|
|
by_alias
|
Default value: None
|
|
by_name
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Doğrulanmış Pydantik modeli. |
parse_file
parse_file(path: str | Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) -> Self
Parametreler
| Name | Description |
|---|---|
|
path
Gerekli
|
str | <xref:Path>
|
|
content_type
Gerekli
|
|
|
encoding
Gerekli
|
|
|
proto
Gerekli
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
Gerekli
|
|
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
content_type
|
Default value: None
|
|
encoding
|
Default value: 'utf8'
|
|
proto
|
Default value: None
|
|
allow_pickle
|
Default value: False
|
Döndürülenler
| Tür | 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
Parametreler
| Name | Description |
|---|---|
|
b
Gerekli
|
|
|
content_type
Gerekli
|
|
|
encoding
Gerekli
|
|
|
proto
Gerekli
|
<xref:DeprecatedParseProtocol> | None
|
|
allow_pickle
Gerekli
|
|
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
content_type
|
Default value: None
|
|
encoding
|
Default value: 'utf8'
|
|
proto
|
Default value: None
|
|
allow_pickle
|
Default value: False
|
Döndürülenler
| Tür | Description |
|---|---|
schema
schema_json
schema_json(*, by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, **dumps_kwargs: Any) -> str
Parametreler
| Name | Description |
|---|---|
|
by_alias
Gerekli
|
|
|
ref_template
Gerekli
|
|
|
dumps_kwargs
Gerekli
|
|
Yalnızca Anahtar Sözcük Parametreleri
| Name | Description |
|---|---|
|
by_alias
|
Default value: True
|
|
ref_template
|
Default value: DEFAULT_REF_TEMPLATE
|
Döndürülenler
| Tür | Description |
|---|---|
update_forward_refs
validate
Öznitelikler
model_extra
Doğrulama sırasında ayarlanan ek alanlar alın.
Döndürülenler
| Tür | Description |
|---|---|
|
Ek alan sözlüğü veya config.extra"izin ver" olarak ayarlanmadıysa Hiçbiri. |
model_fields_set
Bu model örneğinde açıkça ayarlanmış alan kümesini döndürür.
Döndürülenler
| Tür | Description |
|---|---|
|
Ayarlanmış alanları temsil eden bir dizi dize, örneğin varsayılan değerlerden doldurulmamıştır. |
id
İleti için isteğe bağlı benzersiz tanımlayıcı.
field id: str | None = None
role
İletiyi gönderenin rolü (kullanıcı, yardımcı veya sistem).
field role: Literal['user', 'assistant', 'system'] [Required]
content
İletinin metin içeriği.
field content: str [Required]
timestamp
İletinin oluşturulduğu isteğe bağlı zaman damgası.
field timestamp: datetime | None = None