AiProjectAgentRef

pydantic model openapi_client.models.ai_project_agent_ref.AiProjectAgentRef

An agent linked to the project.

Fields:

• agent_alias_id (str | None)

• agent_id (str | None)

• agent_name (str | None)

• agent_status (str | None)

• agent_type (str | None)

• description (str | None)

• display_name (str | None)

• last_modified_time (str | None)

• model_id (str | None)

• reference_id (str | None)

field agent_id: Optional[StrictStr] = None (alias 'AgentId')

Agent identifier.

field agent_name: Optional[StrictStr] = None (alias 'AgentName')

Agent name.

field display_name: Optional[StrictStr] = None (alias 'DisplayName')

Display name; falls back to AgentName when unset.

field description: Optional[StrictStr] = None (alias 'Description')

Agent description.

field reference_id: Optional[StrictStr] = None (alias 'ReferenceId')

Underlying provider reference id, captured when the link was made.

field agent_alias_id: Optional[StrictStr] = None (alias 'AgentAliasId')

Provider alias id, captured when the link was made.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

UTC timestamp of the agent’s last change; empty when unknown. Feeds LastContextRefreshedTime.

field agent_status: Optional[StrictStr] = None (alias 'AgentStatus')

Agent status; “UNKNOWN” when the agent does not report one.

field agent_type: Optional[StrictStr] = None (alias 'AgentType')

Agent type. Reported as “CUSTOM” when the agent record does not set one. SYSTEM agents are platform-provided and skip per-user access checks.

field model_id: Optional[StrictStr] = None (alias 'ModelId')

Model the agent runs on; empty when not applicable.

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 AiProjectAgentRef 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 AiProjectAgentRef from a dict

Return type:

Optional[Self]