Skip to content

get_agent_collaborator

Operation

get_agent_collaborator

get_agent_collaborator(request: GetAgentCollaboratorInput | GetAgentCollaboratorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentCollaboratorInputDict]) -> GetAgentCollaboratorOutput

Retrieves information about an agent's collaborator.

Parameters:

Name Type Description Default
request GetAgentCollaboratorInput | GetAgentCollaboratorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAgentCollaboratorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentCollaboratorOutput

An instance of GetAgentCollaboratorOutput.

get_agent_collaborator async

get_agent_collaborator(request: GetAgentCollaboratorInput | GetAgentCollaboratorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentCollaboratorInputDict]) -> GetAgentCollaboratorOutput

Retrieves information about an agent's collaborator.

Parameters:

Name Type Description Default
request GetAgentCollaboratorInput | GetAgentCollaboratorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetAgentCollaboratorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentCollaboratorOutput

An instance of GetAgentCollaboratorOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetAgentCollaboratorInputDict

Bases: TypedDict

Dictionary form of GetAgentCollaboratorInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The agent's ID.

agent_version instance-attribute
agent_version: Required[str]

The agent's version.

collaborator_id instance-attribute
collaborator_id: Required[str]

The collaborator's ID.

GetAgentCollaboratorInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentCollaboratorInput structure.

Attributes

agent_id class-attribute instance-attribute
agent_id: str | None = ...

The agent's ID.

agent_version class-attribute instance-attribute
agent_version: str | None = ...

The agent's version.

collaborator_id class-attribute instance-attribute
collaborator_id: str | None = ...

The collaborator's ID.

Output

GetAgentCollaboratorOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentCollaboratorOutput structure.

Attributes

agent_collaborator instance-attribute
agent_collaborator: AgentCollaborator

Details about the collaborator.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.