ChatHistoryMessage クラス

チャット履歴内の 1 つのメッセージを表します。

このモデルは、脅威保護分析とコンプライアンス監視のためにユーザーと AI アシスタントの間で交換される個々のメッセージをキャプチャするために使用されます。

コンストラクター

pydantic model ChatHistoryMessage

キーワードのみのパラメーター

名前 説明
id
規定値: None
role
必須
content
必須
timestamp
規定値: None


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

メソッド

__init__

キーワード引数からの入力データを解析して検証することで、新しいモデルを作成します。

[ValidationError][pydantic_core を発生させます。ValidationError] (入力データを検証して有効なモデルを形成できない場合)。

self は、フィールド名として self を許可するために明示的に位置指定専用です。

__new__
construct
content_not_empty

コンテンツが空または空白のみではないことを検証します。

copy

モデルのコピーを返します。

!!! 警告 "非推奨" このメソッドは非推奨になりました。 代わりにmodel_copy を使用してください。

インクルードまたは除外が必要な場合は、次の値を使用します。

python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data)

dict
from_orm
json
model_construct

検証済みデータを使用して Model クラスの新しいインスタンスを作成します。

信頼済みデータまたは事前検証済みデータから新しいモデル設定 のディクトpydantic_fields_set を作成します。 既定値は考慮されますが、他の検証は実行されません。

!!! model_construct() は、通常、指定されたモデルの model_config.extra 設定を考慮します。 つまり、 model_config.extra == 'allow' の場合、渡されたすべての余分な値がモデル インスタンスの dict フィールドと pydantic_extra フィールドに 追加されます。 model_config.extra == 'ignore' (既定値) の場合、渡された余分な値はすべて無視されます。 model_construct()の呼び出しで検証が実行されないため、model_config.extra == 'forbid' を指定しても、余分な値が渡されてもエラーは発生しませんが、無視されます。

model_copy

!!! abstract "Usage Documentation" model_copy

モデルのコピーを返します。

!!! 注: 基になるインスタンスの [dict][object] を指定します。dict] 属性がコピーされます。 モデル フィールド ([キャッシュされたプロパティ][functools.cached_property] の値など) の上に何かを格納すると、予期しない副作用が発生する可能性があります。

model_dump

!!! abstract "Usage Documentation" model_dump

モデルのディクショナリ表現を生成し、必要に応じて、含めるフィールドまたは除外するフィールドを指定します。

model_dump_json

!!! abstract "Usage Documentation" model_dump_json

Pydantic の to_json メソッドを使用して、モデルの JSON 表現 生成します。

model_json_schema

モデル クラスの JSON スキーマを生成します。

model_parametrized_name

ジェネリック クラスのパラメーター化のクラス名を計算します。

このメソッドをオーバーライドして、汎用 BaseModel のカスタム名前付けスキームを実現できます。

model_post_init

initmodel_construct の後に追加の初期化を実行するには、このメソッドをオーバーライドします。 これは、モデル全体を初期化する必要がある検証を行う場合に便利です。

model_rebuild

モデルの pydantic-core スキーマを再構築してみてください。

これは、注釈の 1 つが ForwardRef であり、スキーマの最初のビルド中に解決できなかった場合に、自動再構築が失敗した場合に必要になる場合があります。

model_validate

pydantic モデル インスタンスを検証します。

model_validate_json

!!! 抽象 "Usage Documentation" JSON Parsing

Pydantic モデルに対して指定された JSON データを検証します。

model_validate_strings

Pydantic モデルに対して文字列データを使用して、指定されたオブジェクトを検証します。

parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

__init__

キーワード引数からの入力データを解析して検証することで、新しいモデルを作成します。

[ValidationError][pydantic_core を発生させます。ValidationError] (入力データを検証して有効なモデルを形成できない場合)。

self は、フィールド名として self を許可するために明示的に位置指定専用です。

__init__(**data: Any) -> None

パラメーター

名前 説明
data
必須
Any

返品

説明

__new__

__new__(**kwargs)

construct

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

パラメーター

名前 説明
_fields_set
set[str] | None
規定値: None
values
必須
Any

返品

説明

content_not_empty

コンテンツが空または空白のみではないことを検証します。

validator content_not_empty  »  content

パラメーター

名前 説明
v
必須
str

返品

説明
str

copy

モデルのコピーを返します。

!!! 警告 "非推奨" このメソッドは非推奨になりました。 代わりにmodel_copy を使用してください。

インクルードまたは除外が必要な場合は、次の値を使用します。

python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data)

copy(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, update: Dict[str, Any] | None = None, deep: bool = False) -> Self

パラメーター

名前 説明
include
必須
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

コピーしたモデルに含めるフィールドを指定するオプションのセットまたはマッピング。

exclude
必須
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

コピーしたモデルで除外するフィールドを指定するオプションのセットまたはマッピング。

update
必須

コピーしたモデル内のフィールド値をオーバーライドするためのフィールドと値のペアの省略可能なディクショナリ。

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

返品

説明

from_orm

from_orm(obj: Any) -> Self

パラメーター

名前 説明
obj
必須
Any

返品

説明

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
必須
Any

キーワードのみのパラメーター

名前 説明
include
規定値: None
exclude
規定値: None
by_alias
規定値: False
exclude_unset
規定値: False
exclude_defaults
規定値: False
exclude_none
規定値: False
encoder
規定値: PydanticUndefined
models_as_dict
規定値: PydanticUndefined

返品

説明
str

model_construct

検証済みデータを使用して Model クラスの新しいインスタンスを作成します。

信頼済みデータまたは事前検証済みデータから新しいモデル設定 のディクトpydantic_fields_set を作成します。 既定値は考慮されますが、他の検証は実行されません。

!!! model_construct() は、通常、指定されたモデルの model_config.extra 設定を考慮します。 つまり、 model_config.extra == 'allow' の場合、渡されたすべての余分な値がモデル インスタンスの dict フィールドと pydantic_extra フィールドに 追加されます。 model_config.extra == 'ignore' (既定値) の場合、渡された余分な値はすべて無視されます。 model_construct()の呼び出しで検証が実行されないため、model_config.extra == 'forbid' を指定しても、余分な値が渡されてもエラーは発生しませんが、無視されます。

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

パラメーター

名前 説明
_fields_set
set[str] | None

インスタンス化中に最初に明示的に設定されたフィールド名のセット。 指定した場合、これは [model_fields_set][pydantic] に直接使用されます。BaseModel.model_fields_set] 属性。 それ以外の場合は、 values 引数のフィールド名が使用されます。

規定値: None
values
必須
Any

信頼済みまたは事前検証済みのデータ ディクショナリ。

返品

説明

検証済みデータを含む Model クラスの新しいインスタンス。

model_copy

!!! abstract "Usage Documentation" model_copy

モデルのコピーを返します。

!!! 注: 基になるインスタンスの [dict][object] を指定します。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

!!! abstract "Usage Documentation" 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' の場合、出力に JSON シリアル化不可能な Python オブジェクトが含まれている可能性があります。

include
必須
set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, <xref:IncEx> | bool] | Mapping[str, <xref:IncEx> | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, <xref:IncEx> | bool] | Mapping[str, <xref:IncEx> | bool] | bool] | None

出力に含めるフィールドのセット。

exclude
必須
set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, <xref:IncEx> | bool] | Mapping[str, <xref:IncEx> | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, <xref:IncEx> | bool] | Mapping[str, <xref:IncEx> | bool] | bool] | None

出力から除外するフィールドのセット。

context
必須
Any | None

シリアライザーに渡す追加のコンテキスト。

by_alias
必須

定義されている場合、ディクショナリ キーでフィールドのエイリアスを使用するかどうかを指定します。

exclude_unset
必須

明示的に設定されていないフィールドを除外するかどうかを指定します。

exclude_defaults
必須

既定値に設定されているフィールドを除外するかどうかを指定します。

exclude_none
必須

値が None のフィールドを除外するかどうかを 指定します

exclude_computed_fields
必須

計算フィールドを除外するかどうか。 これはラウンドトリップに役立ちますが、通常は専用 のround_trip パラメーターを代わりに使用することをお勧めします。

round_trip
必須

True の場合、ダンプされた値は Json[T] などのべき等以外の型の入力として有効である必要があります。

warnings
必須
bool | Literal['none', 'warn', 'error']

シリアル化エラーを処理する方法。 False/"none" はそれらを無視し、True/"warn" はエラーをログに記録し、"error" は [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

!!! abstract "Usage Documentation" model_dump_json

Pydantic の to_json メソッドを使用して、モデルの JSON 表現 生成します。

model_dump_json(*, indent: int | None = None, ensure_ascii: bool = False, include: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, exclude: set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None = None, context: Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | Literal['none', 'warn', 'error'] = True, fallback: Callable[[Any], Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> str

パラメーター

名前 説明
indent
必須
int | None

JSON 出力で使用するインデント。 None が渡された場合、出力はコンパクトになります。

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
必須
Any | None

シリアライザーに渡す追加のコンテキスト。

by_alias
必須

フィールド エイリアスを使用してシリアル化するかどうかを指定します。

exclude_unset
必須

明示的に設定されていないフィールドを除外するかどうかを指定します。

exclude_defaults
必須

既定値に設定されているフィールドを除外するかどうかを指定します。

exclude_none
必須

値が None のフィールドを除外するかどうかを 指定します

exclude_computed_fields
必須

計算フィールドを除外するかどうか。 これはラウンドトリップに役立ちますが、通常は専用 のround_trip パラメーターを代わりに使用することをお勧めします。

round_trip
必須

True の場合、ダンプされた値は Json[T] などのべき等以外の型の入力として有効である必要があります。

warnings
必須
bool | Literal['none', 'warn', 'error']

シリアル化エラーを処理する方法。 False/"none" はそれらを無視し、True/"warn" はエラーをログに記録し、"error" は [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

返品

説明
str

モデルの JSON 文字列表現。

model_json_schema

モデル クラスの JSON スキーマを生成します。

model_json_schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, schema_generator: type[GenerateJsonSchema] = GenerateJsonSchema, mode: Literal['validation', 'serialization'] = 'validation', *, union_format: Literal['any_of', 'primitive_type_array'] = 'any_of') -> dict[str, Any]

パラメーター

名前 説明
by_alias

属性エイリアスを使用するかどうか。

規定値: True
ref_template
str

参照テンプレート。

規定値: DEFAULT_REF_TEMPLATE
union_format
必須
Literal['any_of', 'primitive_type_array']

共用体のスキーマを結合するときに使用する形式。 次のいずれかになります。

キーワードを使用してスキーマを結合します (既定値)。

  • 'primitive_type_array': 組み合わせの各 を含む文字列の配列として type キーワードを使用します。 いずれかのスキーマがプリミティブ型 (文字列ブール値、 null整数 、または 数値) ではない場合、または制約/メタデータが含まれている場合は、 any_ofにフォールバックします。
schema_generator
type[<xref:pydantic.json_schema.GenerateJsonSchema>]

JSON スキーマの生成に使用されるロジックをオーバーライドするには、 GenerateJsonSchema のサブクラスとして必要な変更を加えます。

規定値: GenerateJsonSchema
mode
Literal['validation', 'serialization']

スキーマを生成するモード。

規定値: 'validation'

キーワードのみのパラメーター

名前 説明
union_format
規定値: 'any_of'

返品

説明

指定されたモデル クラスの JSON スキーマ。

model_parametrized_name

ジェネリック クラスのパラメーター化のクラス名を計算します。

このメソッドをオーバーライドして、汎用 BaseModel のカスタム名前付けスキームを実現できます。

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

パラメーター

名前 説明
params
必須
tuple[type[Any], ...]

クラスの型のタプル。 2 つの型変数を持つジェネリック クラス Model と具象モデル Model[str, int]を指定すると 、値 (str, int)パラメーターに渡されます。

返品

説明
str

パラメーターが型変数として cls に渡される新しいクラスを表す文字列。

例外

説明

非ジェネリック モデルの具象名を生成しようとしたときに発生します。

model_post_init

initmodel_construct の後に追加の初期化を実行するには、このメソッドをオーバーライドします。 これは、モデル全体を初期化する必要がある検証を行う場合に便利です。

model_post_init(context: Any, /) -> None

位置指定のみのパラメーター

名前 説明
context
必須

パラメーター

名前 説明
context
必須
Any

返品

説明

model_rebuild

モデルの pydantic-core スキーマを再構築してみてください。

これは、注釈の 1 つが 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
必須
int

親名前空間の深さレベルは、既定では 2 です。

_types_namespace
必須
<xref:MappingNamespace> | None

型の名前空間は既定で None です。

キーワードのみのパラメーター

名前 説明
force
規定値: False
raise_errors
規定値: True
_parent_namespace_depth
規定値: 2
_types_namespace
規定値: None

返品

説明

スキーマが既に "完了" であり、再構築が必要なかった場合は 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
必須
Any

検証するオブジェクト。

strict
必須

型を厳密に適用するかどうか。

extra
必須
Literal['allow', 'ignore', 'forbid'] | None

モデルの検証中に追加のデータを無視、許可、または禁止するかどうかを指定します。 [追加 の構成値][pydantic] を参照してください。詳細については、ConfigDict.extra] を参照してください。

from_attributes
必須

オブジェクト属性からデータを抽出するかどうか。

context
必須
Any | None

検証コントロールに渡す追加のコンテキスト。

by_alias
必須

指定された入力データに対して検証するときにフィールドのエイリアスを使用するかどうか。

by_name
必須

指定された入力データに対して検証するときにフィールドの名前を使用するかどうか。

キーワードのみのパラメーター

名前 説明
strict
規定値: None
extra
規定値: None
from_attributes
規定値: None
context
規定値: None
by_alias
規定値: None
by_name
規定値: None

返品

説明

検証済みのモデル インスタンス。

例外

説明
ValidationError

オブジェクトを検証できなかった場合。

model_validate_json

!!! 抽象 "Usage Documentation" JSON Parsing

Pydantic モデルに対して指定された JSON データを検証します。

model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, extra: Literal['allow', 'ignore', 'forbid'] | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> Self

パラメーター

名前 説明
json_data
必須

検証する JSON データ。

strict
必須

型を厳密に適用するかどうか。

extra
必須
Literal['allow', 'ignore', 'forbid'] | None

モデルの検証中に追加のデータを無視、許可、または禁止するかどうかを指定します。 [追加 の構成値][pydantic] を参照してください。詳細については、ConfigDict.extra] を参照してください。

context
必須
Any | None

バリデーターに渡す追加の変数。

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
必須
Any

検証する文字列データを含むオブジェクト。

strict
必須

型を厳密に適用するかどうか。

extra
必須
Literal['allow', 'ignore', 'forbid'] | None

モデルの検証中に追加のデータを無視、許可、または禁止するかどうかを指定します。 [追加 の構成値][pydantic] を参照してください。詳細については、ConfigDict.extra] を参照してください。

context
必須
Any | None

バリデーターに渡す追加の変数。

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
必須
str | None
encoding
必須
str
proto
必須
<xref:DeprecatedParseProtocol> | None
allow_pickle
必須

キーワードのみのパラメーター

名前 説明
content_type
規定値: None
encoding
規定値: 'utf8'
proto
規定値: None
allow_pickle
規定値: False

返品

説明

parse_obj

parse_obj(obj: Any) -> Self

パラメーター

名前 説明
obj
必須
Any

返品

説明

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
必須
str | None
encoding
必須
str
proto
必須
<xref:DeprecatedParseProtocol> | None
allow_pickle
必須

キーワードのみのパラメーター

名前 説明
content_type
規定値: None
encoding
規定値: 'utf8'
proto
規定値: None
allow_pickle
規定値: False

返品

説明

schema

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

パラメーター

名前 説明
by_alias
規定値: True
ref_template
str
規定値: DEFAULT_REF_TEMPLATE

返品

説明

schema_json

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

パラメーター

名前 説明
by_alias
必須
ref_template
必須
str
dumps_kwargs
必須
Any

キーワードのみのパラメーター

名前 説明
by_alias
規定値: True
ref_template
規定値: DEFAULT_REF_TEMPLATE

返品

説明
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

パラメーター

名前 説明
localns
必須
Any

返品

説明

validate

validate(value: Any) -> Self

パラメーター

名前 説明
value
必須
Any

返品

説明

属性

model_extra

検証中に設定された追加のフィールドを取得します。

返品

説明

追加フィールドのディクショナリ。config.extra"allow" に設定されていない場合は None

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