ChatMessageRequest Classe

Solicite carga útil para enviar o histórico de chat para a plataforma MCP.

Este modelo representa o corpo completo do pedido enviado para o endpoint do histórico de chat da plataforma MCP para análise de proteção contra ameaças. Inclui o contexto atual da conversa e mensagens históricas.

O modelo utiliza aliases de campo para serializar para o formato camelCase JSON, conforme exigido pela API da plataforma MCP.

Construtor

pydantic model ChatMessageRequest

Parâmetros Só de Palavra-Chave

Name	Description
conversationId Necessário
messageId Necessário
userMessage Necessário
chatHistory Necessário

Exemplos


>>> 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'

Métodos

__init__	Crie um novo modelo analisando e validando dados de entrada a partir de argumentos de palavras-chave. Aumenta [ValidationError][pydantic_core. ValidationError] se os dados de entrada não puderem ser validados para formar um modelo válido. self é explicitamente apenas posicional para permitir self como nome de campo.
__new__
construct
copy	Devolve uma cópia do modelo. !!! aviso "Descontinuado" Este método está agora obsoleto; Use model_copy em vez disso. Se precisar de incluir ou excluir, utilize: `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	Cria uma nova instância da classe Model com dados validados. Cria um novo modelo definido e pydantic_fields_set a partir de dados confiáveis ou pré-validados. Os valores padrão são respeitados, mas não é realizada outra validação. !!! nota model_construct() geralmente respeita a definição de model_config.extra no modelo fornecido. Ou seja, se model_config.extra == 'permitir', então todos os valores extra passados são adicionados ao dict e aos campos de pydantic_extra da instância do modelo. Se model_config.extra == 'ignorar' (o padrão), então todos os valores extra passados são ignorados. Como nenhuma validação é realizada com uma chamada para model_construct(), ter model_config.extra == 'proibir' não resulta em erro se forem passados valores extra, mas estes serão ignorados.
model_copy	!!! resumo "Documentação de Utilização" model_copy Devolve uma cópia do modelo. !!! nota: A instância subjacente [dict][objeto.O atributo Dict] é copiado. Isto pode ter efeitos secundários inesperados se guardar algo nele, para além dos campos do modelo (por exemplo, o valor de [propriedades em cache][functools.cached_property]).
model_dump	!!! resumo "Documentação de Utilização" model_dump Gerar uma representação no dicionário do modelo, especificando opcionalmente quais os campos a incluir ou excluir.
model_dump_json	!!! resumo "Documentação de Utilização" model_dump_json Gera uma representação JSON do modelo usando o método to_json do Pydantic.
model_json_schema	Gera um esquema JSON para uma classe modelo.
model_parametrized_name	Calcule o nome da classe para parametrizações de classes genéricas. Este método pode ser sobreposto para obter um esquema de nomenclatura personalizado para BaseModels genéricos.
model_post_init	Substitua este método para realizar inicializações adicionais após o init e o model_construct. Isto é útil se quiseres fazer alguma validação que exija a inicialização de todo o modelo.
model_rebuild	Tenta reconstruir o esquema pydantic-core para o modelo. Isto pode ser necessário quando uma das anotações é um ForwardRef que não pôde ser resolvido durante a tentativa inicial de construir o esquema, e a reconstrução automática falha.
model_validate	Valide uma instância de modelo pydântico.
model_validate_json	!!! resumo "Documentação de Uso" JSON Parsing Valide os dados JSON apresentados contra o modelo Pydantic.
model_validate_strings	Valide o objeto dado com dados em cadeia contra o modelo Pydantic.
not_empty	Valide que os campos de strings não são vazios ou apenas espaços em branco.
parse_file
parse_obj
parse_raw
schema
schema_json
update_forward_refs
validate

init

Crie um novo modelo analisando e validando dados de entrada a partir de argumentos de palavras-chave.

Aumenta [ValidationError][pydantic_core. ValidationError] se os dados de entrada não puderem ser validados para formar um modelo válido.

self é explicitamente apenas posicional para permitir self como nome de campo.

__init__(**data: Any) -> None

Parâmetros

Name	Description
data Necessário	Any

Devoluções

Tipo	Description
None

new

__new__(**kwargs)

construct

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

Parâmetros

Name	Description
_fields_set	set[str] \| None Default value: None
values Necessário	Any

Devoluções

Tipo	Description
Self

copy

Devolve uma cópia do modelo.

!!! aviso "Descontinuado" Este método está agora obsoleto; Use model_copy em vez disso.

Se precisar de incluir ou excluir, utilize:

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

Parâmetros

Name	Description
include Necessário	<xref:AbstractSetIntStr> \| <xref:MappingIntStrAny> \| None Conjunto opcional ou mapeamento que especifica quais os campos a incluir no modelo copiado.
exclude Necessário	<xref:AbstractSetIntStr> \| <xref:MappingIntStrAny> \| None Conjunto opcional ou mapeamento que especifica quais os campos a excluir no modelo copiado.
update Necessário	Dict[str, Any] \| None Dicionário opcional de pares campo-valor para sobrescrever os valores dos campos no modelo copiado.
deep Necessário	bool Se Verdadeiro, os valores dos campos que são modelos Pidânticos serão copiados em profundidade.

Parâmetros Só de Palavra-Chave

Name	Description
include	Default value: None
exclude	Default value: None
update	Default value: None
deep	Default value: False

Devoluções

Tipo	Description
Self	Uma cópia do modelo com campos incluídos, excluídos e atualizados conforme especificado.

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]

Parâmetros

Name	Description
include Necessário	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 Necessário	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 Necessário	bool
exclude_unset Necessário	bool
exclude_defaults Necessário	bool
exclude_none Necessário	bool

Parâmetros Só de Palavra-Chave

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

Devoluções

Tipo	Description
Dict[str, Any]

from_orm

from_orm(obj: Any) -> Self

Parâmetros

Name	Description
obj Necessário	Any

Devoluções

Tipo	Description
Self

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

Parâmetros

Name	Description
include Necessário	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 Necessário	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 Necessário	bool
exclude_unset Necessário	bool
exclude_defaults Necessário	bool
exclude_none Necessário	bool
encoder Necessário	Callable[[Any], Any] \| None
models_as_dict Necessário	bool
dumps_kwargs Necessário	Any

Parâmetros Só de Palavra-Chave

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

Devoluções

Tipo	Description
str

model_construct

Cria uma nova instância da classe Model com dados validados.

Cria um novo modelo definido e pydantic_fields_set a partir de dados confiáveis ou pré-validados. Os valores padrão são respeitados, mas não é realizada outra validação.

!!! nota model_construct() geralmente respeita a definição de model_config.extra no modelo fornecido. Ou seja, se model_config.extra == 'permitir', então todos os valores extra passados são adicionados ao dict e aos campos de pydantic_extra da instância do modelo. Se model_config.extra == 'ignorar' (o padrão), então todos os valores extra passados são ignorados. Como nenhuma validação é realizada com uma chamada para model_construct(), ter model_config.extra == 'proibir' não resulta em erro se forem passados valores extra, mas estes serão ignorados.

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

Parâmetros

Name	Description
_fields_set	set[str] \| None Um conjunto de nomes de campos que foram originalmente explicitamente definidos durante a instância. Se fornecida, esta é usada diretamente para o [model_fields_set][pydântico. atributo BaseModel.model_fields_set]. Caso contrário, serão usados os nomes dos campos do argumento dos valores . Default value: None
values Necessário	Any Dicionário de dados confiável ou pré-validado.

Devoluções

Tipo	Description
Self	Uma nova instância da classe Model com dados validados.

model_copy

!!! resumo "Documentação de Utilização" model_copy

Devolve uma cópia do modelo.

!!! nota: A instância subjacente [dict][objeto.O atributo Dict] é copiado. Isto pode ter efeitos secundários inesperados se guardar algo nele, para além dos campos do modelo (por exemplo, o valor de [propriedades em cache][functools.cached_property]).

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

Parâmetros

Name	Description
update Necessário	Mapping[str, Any] \| None Valores a alterar/adicionar no novo modelo. Nota: os dados não são validados antes de criar o novo modelo. Deves confiar nestes dados.
deep Necessário	bool Defina para Verdadeiro para criar uma cópia profunda do modelo.

Parâmetros Só de Palavra-Chave

Name	Description
update	Default value: None
deep	Default value: False

Devoluções

Tipo	Description
Self	Instância de novo modelo.

model_dump

!!! resumo "Documentação de Utilização" model_dump

Gerar uma representação no dicionário do modelo, especificando opcionalmente quais os campos a incluir ou excluir.

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]

Parâmetros

Name	Description
mode Necessário	Literal['json', 'python'] \| str O modo em que to_python deve correr. Se o modo for 'json', a saída só conterá tipos JSON serializáveis. Se o modo for 'python', a saída pode conter objetos Python não serializáveis em JSON.
include Necessário	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 Um conjunto de campos a incluir na saída.
exclude Necessário	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 Um conjunto de campos a excluir da saída.
context Necessário	Any \| None Contexto adicional para passar ao serializador.
by_alias Necessário	bool \| None Se deve usar o alias do campo na chave do dicionário, caso esteja definido.
exclude_unset Necessário	bool Se deve excluir campos que não foram explicitamente definidos.
exclude_defaults Necessário	bool Se deve excluir campos definidos para o seu valor padrão.
exclude_none Necessário	bool Se deve excluir campos que tenham valor de Nenhum.
exclude_computed_fields Necessário	bool Se deve excluir campos calculados. Embora isto possa ser útil para ida e volta, normalmente recomenda-se usar o parâmetro dedicado round_trip em vez disso.
round_trip Necessário	bool Se Verdadeiro, os valores descarregados devem ser válidos como entrada para tipos não idempotentes como Json[T].
warnings Necessário	bool \| Literal['none', 'warn', 'error'] Como lidar com erros de serialização. False/"nenhum" ignora-os, True/"warn" regista erros, "error" gera um [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Necessário	Callable[[Any], Any] \| None Uma função a chamar quando se encontra um valor desconhecido. Se não for fornecido, um [PydanticSerializationError][pydantic_core. É apresentado o erro PydanticSerializationError].
serialize_as_any Necessário	bool Se deve serializar campos com comportamento de serialização por tipagem duck.
polymorphic_serialization Necessário	bool \| None Se deve usar serialização polimórfica de modelo e dataclass para esta chamada.

Parâmetros Só de Palavra-Chave

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

Devoluções

Tipo	Description
dict[str, Any]	Uma representação no dicionário do modelo.

model_dump_json

!!! resumo "Documentação de Utilização" model_dump_json

Gera uma representação JSON do modelo usando o método to_json do 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

Parâmetros

Name	Description
indent Necessário	int \| None Indentação para usar na saída JSON. Se Nenhum for aprovado, a saída será compacta.
ensure_ascii Necessário	bool Se for Verdadeiro, a saída garante que todos os caracteres não-ASCII de entrada escapam. Se for False (o predefinido), estes caracteres serão produzidos as-is.
include Necessário	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 Campo(s) a incluir na saída JSON.
exclude Necessário	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 Campo(s) a excluir da saída JSON.
context Necessário	Any \| None Contexto adicional para passar ao serializador.
by_alias Necessário	bool \| None Se deve serializar usando aliases de campo.
exclude_unset Necessário	bool Se deve excluir campos que não foram explicitamente definidos.
exclude_defaults Necessário	bool Se deve excluir campos definidos para o seu valor padrão.
exclude_none Necessário	bool Se deve excluir campos que tenham valor de Nenhum.
exclude_computed_fields Necessário	bool Se deve excluir campos calculados. Embora isto possa ser útil para ida e volta, normalmente recomenda-se usar o parâmetro dedicado round_trip em vez disso.
round_trip Necessário	bool Se Verdadeiro, os valores descarregados devem ser válidos como entrada para tipos não idempotentes como Json[T].
warnings Necessário	bool \| Literal['none', 'warn', 'error'] Como lidar com erros de serialização. False/"nenhum" ignora-os, True/"warn" regista erros, "error" gera um [PydanticSerializationError][pydantic_core. PydanticSerializationError].
fallback Necessário	Callable[[Any], Any] \| None Uma função a chamar quando se encontra um valor desconhecido. Se não for fornecido, um [PydanticSerializationError][pydantic_core. É apresentado o erro PydanticSerializationError].
serialize_as_any Necessário	bool Se deve serializar campos com comportamento de serialização por tipagem duck.
polymorphic_serialization Necessário	bool \| None Se deve usar serialização polimórfica de modelo e dataclass para esta chamada.

Parâmetros Só de Palavra-Chave

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

Devoluções

Tipo	Description
str	Uma representação em string JSON do modelo.

model_json_schema

Gera um esquema JSON para uma classe modelo.

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]

Parâmetros

Name	Description
by_alias	bool Se deve usar ou não os pseudónimos de atributos. Default value: True
ref_template	str O modelo de referência. Default value: DEFAULT_REF_TEMPLATE
union_format Necessário	Literal['any_of', 'primitive_type_array'] O formato a usar ao combinar esquemas de uniões. Pode ser um dos seguintes: 'any_of': Usa o anyOf palavra-chave para combinar esquemas (o padrão). 'primitive_type_array': Use a palavra-chave type como um array de cadeias, contendo cada tipo da combinação. Se algum dos esquemas não for do tipo primitivo (string, booleano, nulo, inteiro ou número) ou contiver restrições/metadados, recai para any_of.
schema_generator	type[<xref:pydantic.json_schema.GenerateJsonSchema>] Para sobrepor a lógica usada para gerar o esquema JSON, como uma subclasse do GenerateJsonSchema com as modificações desejadas Default value: GenerateJsonSchema
mode	Literal['validation', 'serialization'] O modo em que gerar o esquema. Default value: 'validation'

Parâmetros Só de Palavra-Chave

Name	Description
union_format	Default value: 'any_of'

Devoluções

Tipo	Description
dict[str, Any]	O esquema JSON para a dada classe modelo.

model_parametrized_name

Calcule o nome da classe para parametrizações de classes genéricas.

Este método pode ser sobreposto para obter um esquema de nomenclatura personalizado para BaseModels genéricos.

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

Parâmetros

Name	Description
params Necessário	tuple[type[Any], ...] Tupla de tipos da classe. Dado um Modelo de classes genérico com 2 variáveis de tipo e um modelo concreto Model[str, int], o valor (str, int) seria passado para params.

Devoluções

Tipo	Description
str	String que representa a nova classe onde os parâmetros são passados para cls como variáveis de tipo.

Exceções

Tipo	Description
TypeError	Elevado ao tentar gerar nomes concretos para modelos não genéricos.

model_post_init

Substitua este método para realizar inicializações adicionais após o init e o model_construct. Isto é útil se quiseres fazer alguma validação que exija a inicialização de todo o modelo.

model_post_init(context: Any, /) -> None

Parâmetros Só Posicionais

Name	Description
context Necessário

Parâmetros

Name	Description
context Necessário	Any

Devoluções

Tipo	Description
None

model_rebuild

Tenta reconstruir o esquema pydantic-core para o modelo.

Isto pode ser necessário quando uma das anotações é um ForwardRef que não pôde ser resolvido durante a tentativa inicial de construir o esquema, e a reconstrução automática falha.

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

Parâmetros

Name	Description
force Necessário	bool Se forçar a reconstrução do esquema do modelo, por defeito é Falso.
raise_errors Necessário	bool Se deve levantar erros, por defeito é Verdadeiro.
_parent_namespace_depth Necessário	int O nível de profundidade do namespace pai é por defeito 2.
_types_namespace Necessário	<xref:MappingNamespace> \| None O espaço de nomes dos tipos é por defeito Nenhum.

Parâmetros Só de Palavra-Chave

Name	Description
force	Default value: False
raise_errors	Default value: True
_parent_namespace_depth	Default value: 2
_types_namespace	Default value: None

Devoluções

Tipo	Description
bool \| None	Retorna Nenhum se o esquema já estiver "completo" e não fosse necessário reconstruir. Se for necessária a reconstrução, retorna Verdadeiro se a reconstrução foi bem-sucedida, caso contrário Falso.

model_validate

Valide uma instância de modelo pydântico.

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

Parâmetros

Name	Description
obj Necessário	Any O objetivo a validar.
strict Necessário	bool \| None Se deve aplicar os tipos de forma rigorosa.
extra Necessário	Literal['allow', 'ignore', 'forbid'] \| None Se deve ignorar, permitir ou proibir dados adicionais durante a validação do modelo. Veja o [valor de configuração extra ] [pydântico. ConfigDict.extra] para mais detalhes.
from_attributes Necessário	bool \| None Se deve extrair dados dos atributos do objeto.
context Necessário	Any \| None Contexto adicional para passar ao validador.
by_alias Necessário	bool \| None Se deve usar o alias do campo ao validar contra os dados de entrada fornecidos.
by_name Necessário	bool \| None Se deve usar o nome do campo ao validar contra os dados de entrada fornecidos.

Parâmetros Só de Palavra-Chave

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

Devoluções

Tipo	Description
Self	A instância validada do modelo.

Exceções

Tipo	Description
ValidationError	Se o objeto não pudesse ser validado.

model_validate_json

!!! resumo "Documentação de Uso" JSON Parsing

Valide os dados JSON apresentados contra o modelo 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

Parâmetros

Name	Description
json_data Necessário	str \| bytes \| bytearray Os dados JSON para validar.
strict Necessário	bool \| None Se deve aplicar os tipos de forma rigorosa.
extra Necessário	Literal['allow', 'ignore', 'forbid'] \| None Se deve ignorar, permitir ou proibir dados adicionais durante a validação do modelo. Veja o [valor de configuração extra ] [pydântico. ConfigDict.extra] para mais detalhes.
context Necessário	Any \| None Variáveis extra para passar ao validador.
by_alias Necessário	bool \| None Se deve usar o alias do campo ao validar contra os dados de entrada fornecidos.
by_name Necessário	bool \| None Se deve usar o nome do campo ao validar contra os dados de entrada fornecidos.

Parâmetros Só de Palavra-Chave

Name	Description
strict	Default value: None
extra	Default value: None
context	Default value: None
by_alias	Default value: None
by_name	Default value: None

Devoluções

Tipo	Description
Self	O modelo Pydantic validado.

Exceções

Tipo	Description
ValidationError	Se json_data não for uma string JSON ou se o objeto não pudesse ser validado.

model_validate_strings

Valide o objeto dado com dados em cadeia contra o modelo 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

Parâmetros

Name	Description
obj Necessário	Any O objeto que contém dados de cadeia para validar.
strict Necessário	bool \| None Se deve aplicar os tipos de forma rigorosa.
extra Necessário	Literal['allow', 'ignore', 'forbid'] \| None Se deve ignorar, permitir ou proibir dados adicionais durante a validação do modelo. Veja o [valor de configuração extra ] [pydântico. ConfigDict.extra] para mais detalhes.
context Necessário	Any \| None Variáveis extra para passar ao validador.
by_alias Necessário	bool \| None Se deve usar o alias do campo ao validar contra os dados de entrada fornecidos.
by_name Necessário	bool \| None Se deve usar o nome do campo ao validar contra os dados de entrada fornecidos.

Parâmetros Só de Palavra-Chave

Name	Description
strict	Default value: None
extra	Default value: None
context	Default value: None
by_alias	Default value: None
by_name	Default value: None

Devoluções

Tipo	Description
Self	O modelo Pydantic validado.

not_empty

Valide que os campos de strings não são vazios ou apenas espaços em branco.

validator not_empty  »  message_id, conversation_id, user_message

Parâmetros

Name	Description
v Necessário	str

Devoluções

Tipo	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

Parâmetros

Name	Description
path Necessário	str \| <xref:Path>
content_type Necessário	str \| None
encoding Necessário	str
proto Necessário	<xref:DeprecatedParseProtocol> \| None
allow_pickle Necessário	bool

Parâmetros Só de Palavra-Chave

Name	Description
content_type	Default value: None
encoding	Default value: 'utf8'
proto	Default value: None
allow_pickle	Default value: False

Devoluções

Tipo	Description
Self

parse_obj

parse_obj(obj: Any) -> Self

Parâmetros

Name	Description
obj Necessário	Any

Devoluções

Tipo	Description
Self

parse_raw

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

Parâmetros

Name	Description
b Necessário	str \| bytes
content_type Necessário	str \| None
encoding Necessário	str
proto Necessário	<xref:DeprecatedParseProtocol> \| None
allow_pickle Necessário	bool

Parâmetros Só de Palavra-Chave

Name	Description
content_type	Default value: None
encoding	Default value: 'utf8'
proto	Default value: None
allow_pickle	Default value: False

Devoluções

Tipo	Description
Self

schema

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

Parâmetros

Name	Description
by_alias	bool Default value: True
ref_template	str Default value: DEFAULT_REF_TEMPLATE

Devoluções

Tipo	Description
Dict[str, Any]

schema_json

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

Parâmetros

Name	Description
by_alias Necessário	bool
ref_template Necessário	str
dumps_kwargs Necessário	Any

Parâmetros Só de Palavra-Chave

Name	Description
by_alias	Default value: True
ref_template	Default value: DEFAULT_REF_TEMPLATE

Devoluções

Tipo	Description
str

update_forward_refs

update_forward_refs(**localns: Any) -> None

Parâmetros

Name	Description
localns Necessário	Any

Devoluções

Tipo	Description
None

validate

validate(value: Any) -> Self

Parâmetros

Name	Description
value Necessário	Any

Devoluções

Tipo	Description
Self

Atributos

model_extra

Configura campos extra durante a validação.

Devoluções

Tipo	Description
	Um dicionário de campos extra, ou Nenhum se o config.extra não estiver definido como "permitir".

model_fields_set

Devolve o conjunto de campos que foram explicitamente definidos nesta instância do modelo.

Devoluções

Tipo	Description
	Um conjunto de cadeias que representam os campos que foram definidos, ou seja, que não foram preenchidos a partir dos defaults.

conversation_id

Identificador exclusivo da conversa.

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

message_id

Identificador único para a mensagem atual.

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

user_message

A mensagem do utilizador atual a ser processada.

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

chat_history

Lista de mensagens anteriores na conversa.

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