AgentDetails

class openapi_client.models.agent_details.AgentDetails(**data)

Bases: BaseModel

Details for a single AI agent.

agent_id: Optional[Annotated[str, Field(strict=True)]]

agent_name: Optional[Annotated[str, Field(strict=True)]]

agent_status: Optional[Annotated[str, Field(strict=True)]]

description: Optional[Annotated[str, Field(strict=True)]]

agent_type: Optional[Annotated[str, Field(strict=True)]]

agent_version: Optional[Annotated[str, Field(strict=True)]]

model_id: Optional[Annotated[str, Field(strict=True)]]

reference_id: Optional[Annotated[str, Field(strict=True)]]

agent_alias_id: Optional[Annotated[str, Field(strict=True)]]

message: Optional[Annotated[str, Field(strict=True)]]

access_type: Optional[Annotated[str, Field(strict=True)]]

created_by: Optional[Annotated[str, Field(strict=True)]]

creation_time: Optional[Annotated[str, Field(strict=True)]]

last_modified_by: Optional[Annotated[str, Field(strict=True)]]

last_modified_time: Optional[Annotated[str, Field(strict=True)]]

is_enabled: Optional[StrictBool]

agent_response_type: Optional[Annotated[str, Field(strict=True)]]

action_group_id: Optional[Annotated[str, Field(strict=True)]]

tools: Optional[Annotated[List[AgentToolObject], Field(max_length=10)]]

classmethod agent_id_validate_regular_expression(value)

Validates the regular expression

classmethod agent_name_validate_regular_expression(value)

Validates the regular expression

classmethod agent_status_validate_regular_expression(value)

Validates the regular expression

classmethod description_validate_regular_expression(value)

Validates the regular expression

classmethod agent_type_validate_regular_expression(value)

Validates the regular expression

classmethod agent_version_validate_regular_expression(value)

Validates the regular expression

classmethod model_id_validate_regular_expression(value)

Validates the regular expression

classmethod reference_id_validate_regular_expression(value)

Validates the regular expression

classmethod agent_alias_id_validate_regular_expression(value)

Validates the regular expression

classmethod message_validate_regular_expression(value)

Validates the regular expression

classmethod access_type_validate_regular_expression(value)

Validates the regular expression

classmethod created_by_validate_regular_expression(value)

Validates the regular expression

classmethod creation_time_validate_regular_expression(value)

Validates the regular expression

classmethod last_modified_by_validate_regular_expression(value)

Validates the regular expression

classmethod last_modified_time_validate_regular_expression(value)

Validates the regular expression

classmethod agent_response_type_validate_regular_expression(value)

Validates the regular expression

classmethod action_group_id_validate_regular_expression(value)

Validates the regular expression

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of AgentDetails from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of AgentDetails from a dict

Return type:

Optional[Self]

model_fields: ClassVar[dict[str, FieldInfo]] = {'access_type': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AccessType', alias_priority=2, description="Access type of the agent (e.g., 'owner', 'shared')."), 'action_group_id': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='ActionGroupId', alias_priority=2, description='Action group ID associated with the agent.'), 'agent_alias_id': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentAliasId', alias_priority=2, description='Alias ID for the agent.'), 'agent_id': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentId', alias_priority=2, description='Unique identifier of the agent.'), 'agent_name': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentName', alias_priority=2, description='Name of the agent.'), 'agent_response_type': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentResponseType', alias_priority=2, description='Type of response format used by the agent.'), 'agent_status': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentStatus', alias_priority=2, description='Current status of the agent.'), 'agent_type': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentType', alias_priority=2, description="Type of the agent (e.g., 'standard', 'custom')."), 'agent_version': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='AgentVersion', alias_priority=2, description='Version of the agent.'), 'created_by': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='CreatedBy', alias_priority=2, description='ID of the user who created the agent.'), 'creation_time': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='CreationTime', alias_priority=2, description='Timestamp when the agent was created.'), 'description': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='Description', alias_priority=2, description='Description of the agent.'), 'is_enabled': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, alias='IsEnabled', alias_priority=2, description='Indicates whether the agent is enabled.'), 'last_modified_by': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='LastModifiedBy', alias_priority=2, description='ID of the user who last modified the agent.'), 'last_modified_time': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='LastModifiedTime', alias_priority=2, description='Timestamp when the agent was last modified.'), 'message': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='Message', alias_priority=2, description='Additional message or information about the agent.'), 'model_id': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='ModelId', alias_priority=2, description='ID of the AI model used by the agent.'), 'reference_id': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='ReferenceId', alias_priority=2, description='Reference ID associated with the agent.'), 'tools': FieldInfo(annotation=Union[Annotated[List[AgentToolObject], FieldInfo(annotation=NoneType, required=True, metadata=[MaxLen(max_length=10)])], NoneType], required=False, alias='Tools', alias_priority=2, description='List of tools available to the agent.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

model_post_init(__context)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• __context (Any) – The context.

Return type:

None