ChatMessageRequest Klass

Begär nyttolast för att skicka chatthistorik till MCP-plattformen.

Den här modellen representerar hela begärandetexten som skickas till MCP-plattformens slutpunkt för chatthistorik för analys av hotskydd. Den innehåller den aktuella konversationskontexten och historiska meddelanden.

Modellen använder fältalias för att serialisera till camelCase JSON-format som krävs av MCP-plattforms-API:et.

Konstruktor

pydantic model ChatMessageRequest

Keyword-Only parametrar

Name Description
conversationId
Obligatorisk
messageId
Obligatorisk
userMessage
Obligatorisk
chatHistory
Obligatorisk

Exempel


>>> from microsoft_agents_a365.tooling.models import ChatHistoryMessage
>>> request = ChatMessageRequest(
...     conversation_id="conv-123",
...     message_id="msg-456",
...     user_message="What is the weather today?",
...     chat_history=[
...         ChatHistoryMessage(role="user", content="Hello"),
...         ChatHistoryMessage(role="assistant", content="Hi there!"),
...     ]
... )
>>> # Serialize to camelCase JSON
>>> json_dict = request.model_dump(by_alias=True)
>>> print(json_dict["conversationId"])
'conv-123'

Metoder

__init__

Skapa en ny modell genom att parsa och verifiera indata från nyckelordsargument.

Höjer [ValidationError][pydantic_core. ValidationError] om indata inte kan verifieras för att bilda en giltig modell.

self är uttryckligen positionsbegränsad för att tillåta sig själv som ett fältnamn.

__new__
construct
copy

Returnerar en kopia av modellen.

!!! varning "Inaktuell" Den här metoden är nu inaktuell. använd model_copy i stället.

Om du behöver inkludera eller exkludera använder du:

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

Skapar en ny instans av modellklassen med verifierade data.

Skapar en ny modellinställning som dikterar och pydantic_fields_set från betrodda eller förgodkända data. Standardvärdena respekteras, men ingen annan verifiering utförs.

!!! observera model_construct() i allmänhet respekterar inställningen model_config.extra för den angivna modellen. Om model_config.extra == "allow" läggs alltså alla extra överförda värden till i modellinstansens dikta ochpydantic_extra fält. Om model_config.extra == "ignore" (standard) ignoreras alla extra överförda värden. Eftersom ingen validering utförs med ett anrop till model_construct(), resulterar inte model_config.extra == "forbid" i ett fel om extra värden skickas, men de ignoreras.

model_copy

!!! abstrakt "Användningsdokumentation" model_copy

Returnerar en kopia av modellen.

!!! Obs! Den underliggande instansens [dict][objekt.attributet dict] kopieras. Detta kan ha oväntade biverkningar om du lagrar något i det, ovanpå modellfälten (t.ex. värdet för [cachelagrade egenskaper][functools.cached_property]).

model_dump

!!! abstrakt "Användningsdokumentation" model_dump

Generera en ordlisterepresentation av modellen, om du vill ange vilka fält som ska inkluderas eller exkluderas.

model_dump_json

!!! abstrakt "Användningsdokumentation" model_dump_json

Genererar en JSON-representation av modellen med Pydantics to_json-metod .

model_json_schema

Genererar ett JSON-schema för en modellklass.

model_parametrized_name

Beräkna klassnamnet för parametriseringar av generiska klasser.

Den här metoden kan åsidosättas för att uppnå ett anpassat namngivningsschema för generiska BaseModels.

model_post_init

Åsidosätt den här metoden för att utföra ytterligare initiering efter init och model_construct. Det här är användbart om du vill utföra en verifiering som kräver att hela modellen initieras.

model_rebuild

Försök att återskapa pydantic-core-schemat för modellen.

Detta kan vara nödvändigt när en av anteckningarna är en ForwardRef som inte kunde lösas under det första försöket att skapa schemat, och automatisk återskapande misslyckas.

model_validate

Verifiera en pydantisk modellinstans.

model_validate_json

!!! abstrakt "Användningsdokumentation" JSON-parsning

Verifiera angivna JSON-data mot Pydantic-modellen.

model_validate_strings

Verifiera det angivna objektet med strängdata mot Pydantic-modellen.

not_empty

Kontrollera att strängfälten inte är tomma eller endast tomt utrymme.

parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

__init__

Skapa en ny modell genom att parsa och verifiera indata från nyckelordsargument.

Höjer [ValidationError][pydantic_core. ValidationError] om indata inte kan verifieras för att bilda en giltig modell.

self är uttryckligen positionsbegränsad för att tillåta sig själv som ett fältnamn.

__init__(**data: Any) -> None

Parametrar

Name Description
data
Obligatorisk
Any

Returer

Typ Description

__new__

__new__(**kwargs)

construct

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

Parametrar

Name Description
_fields_set
set[str] | None
Standardvärde: None
values
Obligatorisk
Any

Returer

Typ Description

copy

Returnerar en kopia av modellen.

!!! varning "Inaktuell" Den här metoden är nu inaktuell. använd model_copy i stället.

Om du behöver inkludera eller exkludera använder du:

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

Parametrar

Name Description
include
Obligatorisk
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

Valfri uppsättning eller mappning som anger vilka fält som ska inkluderas i den kopierade modellen.

exclude
Obligatorisk
<xref:AbstractSetIntStr> | <xref:MappingIntStrAny> | None

Valfri uppsättning eller mappning som anger vilka fält som ska undantas i den kopierade modellen.

update
Obligatorisk

Valfri ordlista med fält/värde-par för att åsidosätta fältvärden i den kopierade modellen.

deep
Obligatorisk

Om värdet är Sant kopieras värdena för fält som är pydantiska modeller.

Keyword-Only parametrar

Name Description
include
Standardvärde: None
exclude
Standardvärde: None
update
Standardvärde: None
deep
Standardvärde: False

Returer

Typ Description

En kopia av modellen med inkluderade, exkluderade och uppdaterade fält som angetts.

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]

Parametrar

Name Description
include
Obligatorisk
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
Obligatorisk
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
Obligatorisk
exclude_unset
Obligatorisk
exclude_defaults
Obligatorisk
exclude_none
Obligatorisk

Keyword-Only parametrar

Name Description
include
Standardvärde: None
exclude
Standardvärde: None
by_alias
Standardvärde: False
exclude_unset
Standardvärde: False
exclude_defaults
Standardvärde: False
exclude_none
Standardvärde: False

Returer

Typ Description

from_orm

from_orm(obj: Any) -> Self

Parametrar

Name Description
obj
Obligatorisk
Any

Returer

Typ Description

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

Parametrar

Name Description
include
Obligatorisk
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
Obligatorisk
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
Obligatorisk
exclude_unset
Obligatorisk
exclude_defaults
Obligatorisk
exclude_none
Obligatorisk
encoder
Obligatorisk
models_as_dict
Obligatorisk
dumps_kwargs
Obligatorisk
Any

Keyword-Only parametrar

Name Description
include
Standardvärde: None
exclude
Standardvärde: None
by_alias
Standardvärde: False
exclude_unset
Standardvärde: False
exclude_defaults
Standardvärde: False
exclude_none
Standardvärde: False
encoder
Standardvärde: PydanticUndefined
models_as_dict
Standardvärde: PydanticUndefined

Returer

Typ Description
str

model_construct

Skapar en ny instans av modellklassen med verifierade data.

Skapar en ny modellinställning som dikterar och pydantic_fields_set från betrodda eller förgodkända data. Standardvärdena respekteras, men ingen annan verifiering utförs.

!!! observera model_construct() i allmänhet respekterar inställningen model_config.extra för den angivna modellen. Om model_config.extra == "allow" läggs alltså alla extra överförda värden till i modellinstansens dikta ochpydantic_extra fält. Om model_config.extra == "ignore" (standard) ignoreras alla extra överförda värden. Eftersom ingen validering utförs med ett anrop till model_construct(), resulterar inte model_config.extra == "forbid" i ett fel om extra värden skickas, men de ignoreras.

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

Parametrar

Name Description
_fields_set
set[str] | None

En uppsättning fältnamn som ursprungligen uttryckligen angavs under instansieringen. Om detta anges används detta direkt för [model_fields_set][pydantic. BaseModel.model_fields_set]-attribut. Annars används fältnamnen från argumentet values .

Standardvärde: None
values
Obligatorisk
Any

Betrodd eller förvald dataordlista.

Returer

Typ Description

En ny instans av modellklassen med verifierade data.

model_copy

!!! abstrakt "Användningsdokumentation" model_copy

Returnerar en kopia av modellen.

!!! Obs! Den underliggande instansens [dict][objekt.attributet dict] kopieras. Detta kan ha oväntade biverkningar om du lagrar något i det, ovanpå modellfälten (t.ex. värdet för [cachelagrade egenskaper][functools.cached_property]).

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

Parametrar

Name Description
update
Obligatorisk

Värden som ska ändras/läggas till i den nya modellen. Obs! Data verifieras inte innan den nya modellen skapas. Du bör lita på dessa data.

deep
Obligatorisk

Ställ in på True för att göra en djup kopia av modellen.

Keyword-Only parametrar

Name Description
update
Standardvärde: None
deep
Standardvärde: False

Returer

Typ Description

Ny modellinstans.

model_dump

!!! abstrakt "Användningsdokumentation" model_dump

Generera en ordlisterepresentation av modellen, om du vill ange vilka fält som ska inkluderas eller exkluderas.

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]

Parametrar

Name Description
mode
Obligatorisk
Literal['json', 'python'] | str

Läget där to_python ska köras. Om läget är "json" innehåller utdata endast JSON-serialiserbara typer. Om läget är "python" kan utdata innehålla Python-objekt som inte är JSON-serialiserbara.

include
Obligatorisk
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

En uppsättning fält som ska inkluderas i utdata.

exclude
Obligatorisk
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

En uppsättning fält som ska undantas från utdata.

context
Obligatorisk
Any | None

Ytterligare kontext som ska skickas till serialiseraren.

by_alias
Obligatorisk

Om fältets alias ska användas i ordlistenyckeln om det definieras.

exclude_unset
Obligatorisk

Om fält som inte uttryckligen har angetts ska undantas.

exclude_defaults
Obligatorisk

Om fält som är inställda på deras standardvärde ska undantas.

exclude_none
Obligatorisk

Om du vill exkludera fält som har värdet Ingen.

exclude_computed_fields
Obligatorisk

Om du vill exkludera beräknade fält. Även om detta kan vara användbart för avrundning rekommenderar vi vanligtvis att du använder den dedikerade round_trip parametern i stället.

round_trip
Obligatorisk

Om sant ska dumpade värden vara giltiga som indata för icke-idempotenttyper som Json[T].

warnings
Obligatorisk
bool | Literal['none', 'warn', 'error']

Hantera serialiseringsfel. False/"none" ignorerar dem, True/"warn" loggar fel, "error" genererar en [PydanticSerializationError][pydantic_core. PydanticSerializationError].

fallback
Obligatorisk

En funktion att anropa när ett okänt värde påträffas. Om det inte anges, en [PydanticSerializationError][pydantic_core. PydanticSerializationError]-fel utlöses.

serialize_as_any
Obligatorisk

Om du vill serialisera fält med serialiseringsbeteende för ankskrivning.

polymorphic_serialization
Obligatorisk

Om du vill använda polymorf serialisering för modell och dataklass för det här anropet.

Keyword-Only parametrar

Name Description
mode
Standardvärde: 'python'
include
Standardvärde: None
exclude
Standardvärde: None
context
Standardvärde: None
by_alias
Standardvärde: None
exclude_unset
Standardvärde: False
exclude_defaults
Standardvärde: False
exclude_none
Standardvärde: False
exclude_computed_fields
Standardvärde: False
round_trip
Standardvärde: False
warnings
Standardvärde: True
fallback
Standardvärde: None
serialize_as_any
Standardvärde: False
polymorphic_serialization
Standardvärde: None

Returer

Typ Description

En ordlisterepresentation av modellen.

model_dump_json

!!! abstrakt "Användningsdokumentation" model_dump_json

Genererar en JSON-representation av modellen med Pydantics to_json-metod .

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

Parametrar

Name Description
indent
Obligatorisk
int | None

Indrag som ska användas i JSON-utdata. Om Ingen skickas kommer utdata att vara kompakta.

ensure_ascii
Obligatorisk

Om Sant kommer utdata garanterat att ha alla inkommande icke-ASCII-tecken undantagna. Om false (standardvärdet) matas dessa tecken ut as-is.

include
Obligatorisk
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

Fält som ska inkluderas i JSON-utdata.

exclude
Obligatorisk
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

Fält som ska undantas från JSON-utdata.

context
Obligatorisk
Any | None

Ytterligare kontext som ska skickas till serialiseraren.

by_alias
Obligatorisk

Om du vill serialisera med hjälp av fältalias.

exclude_unset
Obligatorisk

Om fält som inte uttryckligen har angetts ska undantas.

exclude_defaults
Obligatorisk

Om fält som är inställda på deras standardvärde ska undantas.

exclude_none
Obligatorisk

Om du vill exkludera fält som har värdet Ingen.

exclude_computed_fields
Obligatorisk

Om du vill exkludera beräknade fält. Även om detta kan vara användbart för avrundning rekommenderar vi vanligtvis att du använder den dedikerade round_trip parametern i stället.

round_trip
Obligatorisk

Om sant ska dumpade värden vara giltiga som indata för icke-idempotenttyper som Json[T].

warnings
Obligatorisk
bool | Literal['none', 'warn', 'error']

Hantera serialiseringsfel. False/"none" ignorerar dem, True/"warn" loggar fel, "error" genererar en [PydanticSerializationError][pydantic_core. PydanticSerializationError].

fallback
Obligatorisk

En funktion att anropa när ett okänt värde påträffas. Om det inte anges, en [PydanticSerializationError][pydantic_core. PydanticSerializationError]-fel utlöses.

serialize_as_any
Obligatorisk

Om du vill serialisera fält med serialiseringsbeteende för ankskrivning.

polymorphic_serialization
Obligatorisk

Om du vill använda polymorf serialisering för modell och dataklass för det här anropet.

Keyword-Only parametrar

Name Description
indent
Standardvärde: None
ensure_ascii
Standardvärde: False
include
Standardvärde: None
exclude
Standardvärde: None
context
Standardvärde: None
by_alias
Standardvärde: None
exclude_unset
Standardvärde: False
exclude_defaults
Standardvärde: False
exclude_none
Standardvärde: False
exclude_computed_fields
Standardvärde: False
round_trip
Standardvärde: False
warnings
Standardvärde: True
fallback
Standardvärde: None
serialize_as_any
Standardvärde: False
polymorphic_serialization
Standardvärde: None

Returer

Typ Description
str

En JSON-strängrepresentation av modellen.

model_json_schema

Genererar ett JSON-schema för en modellklass.

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]

Parametrar

Name Description
by_alias

Om du vill använda attributalias eller inte.

Standardvärde: True
ref_template
str

Referensmallen.

Standardvärde: DEFAULT_REF_TEMPLATE
union_format
Obligatorisk
Literal['any_of', 'primitive_type_array']

Det format som ska användas när du kombinerar scheman från fackföreningar. Kan vara något av:

  • "any_of": Använd anyOf

nyckelord för att kombinera scheman (standard).

  • "primitive_type_array": Använd typnyckelordet som en matris med strängar som innehåller varje typ av kombination. Om något av schemana inte är en primitiv typ (sträng, boolesk, null, heltal eller tal) eller innehåller begränsningar/metadata, återgår till any_of.
schema_generator
type[<xref:pydantic.json_schema.GenerateJsonSchema>]

Om du vill åsidosätta logiken som används för att generera JSON-schemat, som en underklass av GenerateJsonSchema med önskade ändringar

Standardvärde: GenerateJsonSchema
mode
Literal['validation', 'serialization']

Det läge där schemat ska genereras.

Standardvärde: 'validation'

Keyword-Only parametrar

Name Description
union_format
Standardvärde: 'any_of'

Returer

Typ Description

JSON-schemat för den angivna modellklassen.

model_parametrized_name

Beräkna klassnamnet för parametriseringar av generiska klasser.

Den här metoden kan åsidosättas för att uppnå ett anpassat namngivningsschema för generiska BaseModels.

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

Parametrar

Name Description
params
Obligatorisk
tuple[type[Any], ...]

Tuppeln av typer av klassen. Givet en generisk klassmodell med variabler av två typer och en konkret modellmodell[str, int], skickas värdet (str, int) till params.

Returer

Typ Description
str

Sträng som representerar den nya klassen där paramsskickas till cls som typvariabler.

Undantag

Typ Description

Upphöjt vid försök att generera konkreta namn för icke-generiska modeller.

model_post_init

Åsidosätt den här metoden för att utföra ytterligare initiering efter init och model_construct. Det här är användbart om du vill utföra en verifiering som kräver att hela modellen initieras.

model_post_init(context: Any, /) -> None

Positional-Only parametrar

Name Description
context
Obligatorisk

Parametrar

Name Description
context
Obligatorisk
Any

Returer

Typ Description

model_rebuild

Försök att återskapa pydantic-core-schemat för modellen.

Detta kan vara nödvändigt när en av anteckningarna är en ForwardRef som inte kunde lösas under det första försöket att skapa schemat, och automatisk återskapande misslyckas.

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

Parametrar

Name Description
force
Obligatorisk

Om du vill framtvinga återskapande av modellschemat, är standardvärdet Falskt.

raise_errors
Obligatorisk

Om fel ska genereras, är standardvärdet Sant.

_parent_namespace_depth
Obligatorisk
int

Djupnivån för det överordnade namnområdet är som standard 2.

_types_namespace
Obligatorisk
<xref:MappingNamespace> | None

Typernas namnområde, standardvärdet Ingen.

Keyword-Only parametrar

Name Description
force
Standardvärde: False
raise_errors
Standardvärde: True
_parent_namespace_depth
Standardvärde: 2
_types_namespace
Standardvärde: None

Returer

Typ Description

Returnerar Ingen om schemat redan är "slutfört" och återskapande inte krävdes. Om återskapande krävdes returnerar Sant om återskapande lyckades, annars Falskt.

model_validate

Verifiera en pydantisk modellinstans.

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

Parametrar

Name Description
obj
Obligatorisk
Any

Objektet som ska verifieras.

strict
Obligatorisk

Om du vill tillämpa typer strikt.

extra
Obligatorisk
Literal['allow', 'ignore', 'forbid'] | None

Om du vill ignorera, tillåta eller förbjuda extra data under modellverifieringen. Se [extra konfigurationsvärde][pydantic. ConfigDict.extra] för mer information.

from_attributes
Obligatorisk

Om du vill extrahera data från objektattribut.

context
Obligatorisk
Any | None

Ytterligare kontext som ska skickas till validatorn.

by_alias
Obligatorisk

Om du vill använda fältets alias när du verifierar mot angivna indata.

by_name
Obligatorisk

Om du vill använda fältets namn när du verifierar mot angivna indata.

Keyword-Only parametrar

Name Description
strict
Standardvärde: None
extra
Standardvärde: None
from_attributes
Standardvärde: None
context
Standardvärde: None
by_alias
Standardvärde: None
by_name
Standardvärde: None

Returer

Typ Description

Den verifierade modellinstansen.

Undantag

Typ Description
ValidationError

Om objektet inte kunde verifieras.

model_validate_json

!!! abstrakt "Användningsdokumentation" JSON-parsning

Verifiera angivna JSON-data mot Pydantic-modellen.

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

Parametrar

Name Description
json_data
Obligatorisk

JSON-data som ska verifieras.

strict
Obligatorisk

Om du vill tillämpa typer strikt.

extra
Obligatorisk
Literal['allow', 'ignore', 'forbid'] | None

Om du vill ignorera, tillåta eller förbjuda extra data under modellverifieringen. Se [extra konfigurationsvärde][pydantic. ConfigDict.extra] för mer information.

context
Obligatorisk
Any | None

Extra variabler som ska skickas till validatorn.

by_alias
Obligatorisk

Om du vill använda fältets alias när du verifierar mot angivna indata.

by_name
Obligatorisk

Om du vill använda fältets namn när du verifierar mot angivna indata.

Keyword-Only parametrar

Name Description
strict
Standardvärde: None
extra
Standardvärde: None
context
Standardvärde: None
by_alias
Standardvärde: None
by_name
Standardvärde: None

Returer

Typ Description

Den verifierade pydantiska modellen.

Undantag

Typ Description
ValidationError

Om json_data inte är en JSON-sträng eller om objektet inte kunde verifieras.

model_validate_strings

Verifiera det angivna objektet med strängdata mot Pydantic-modellen.

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

Parametrar

Name Description
obj
Obligatorisk
Any

Objektet som innehåller strängdata som ska verifieras.

strict
Obligatorisk

Om du vill tillämpa typer strikt.

extra
Obligatorisk
Literal['allow', 'ignore', 'forbid'] | None

Om du vill ignorera, tillåta eller förbjuda extra data under modellverifieringen. Se [extra konfigurationsvärde][pydantic. ConfigDict.extra] för mer information.

context
Obligatorisk
Any | None

Extra variabler som ska skickas till validatorn.

by_alias
Obligatorisk

Om du vill använda fältets alias när du verifierar mot angivna indata.

by_name
Obligatorisk

Om du vill använda fältets namn när du verifierar mot angivna indata.

Keyword-Only parametrar

Name Description
strict
Standardvärde: None
extra
Standardvärde: None
context
Standardvärde: None
by_alias
Standardvärde: None
by_name
Standardvärde: None

Returer

Typ Description

Den verifierade pydantiska modellen.

not_empty

Kontrollera att strängfälten inte är tomma eller endast tomt utrymme.

validator not_empty  »  message_id, conversation_id, user_message

Parametrar

Name Description
v
Obligatorisk
str

Returer

Typ Description
str

parse_file

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

Parametrar

Name Description
path
Obligatorisk
str | <xref:Path>
content_type
Obligatorisk
str | None
encoding
Obligatorisk
str
proto
Obligatorisk
<xref:DeprecatedParseProtocol> | None
allow_pickle
Obligatorisk

Keyword-Only parametrar

Name Description
content_type
Standardvärde: None
encoding
Standardvärde: 'utf8'
proto
Standardvärde: None
allow_pickle
Standardvärde: False

Returer

Typ Description

parse_obj

parse_obj(obj: Any) -> Self

Parametrar

Name Description
obj
Obligatorisk
Any

Returer

Typ Description

parse_raw

parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: DeprecatedParseProtocol | None = None, allow_pickle: bool = False) -> Self

Parametrar

Name Description
b
Obligatorisk
content_type
Obligatorisk
str | None
encoding
Obligatorisk
str
proto
Obligatorisk
<xref:DeprecatedParseProtocol> | None
allow_pickle
Obligatorisk

Keyword-Only parametrar

Name Description
content_type
Standardvärde: None
encoding
Standardvärde: 'utf8'
proto
Standardvärde: None
allow_pickle
Standardvärde: False

Returer

Typ Description

schema

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

Parametrar

Name Description
by_alias
Standardvärde: True
ref_template
str
Standardvärde: DEFAULT_REF_TEMPLATE

Returer

Typ Description

schema_json

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

Parametrar

Name Description
by_alias
Obligatorisk
ref_template
Obligatorisk
str
dumps_kwargs
Obligatorisk
Any

Keyword-Only parametrar

Name Description
by_alias
Standardvärde: True
ref_template
Standardvärde: DEFAULT_REF_TEMPLATE

Returer

Typ Description
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

Parametrar

Name Description
localns
Obligatorisk
Any

Returer

Typ Description

validate

validate(value: Any) -> Self

Parametrar

Name Description
value
Obligatorisk
Any

Returer

Typ Description

Attribut

model_extra

Hämta extra fält som angetts under valideringen.

Returer

Typ Description

En ordlista med extra fält eller Ingen om config.extra inte har angetts till "allow".

model_fields_set

Returnerar den uppsättning fält som uttryckligen har angetts för den här modellinstansen.

Returer

Typ Description

En uppsättning strängar som representerar de fält som har angetts, dvs. som inte fyllts i från standardvärden.

conversation_id

Unik identifierare för konversationen.

field conversation_id: str [Required] (alias 'conversationId')

message_id

Unik identifierare för det aktuella meddelandet.

field message_id: str [Required] (alias 'messageId')

user_message

Det aktuella användarmeddelandet som bearbetas.

field user_message: str [Required] (alias 'userMessage')

chat_history

Lista över tidigare meddelanden i konversationen.

field chat_history: List[ChatHistoryMessage] [Required] (alias 'chatHistory')