Skip to content

associate_agent_collaborator

Operation

associate_agent_collaborator

associate_agent_collaborator(request: AssociateAgentCollaboratorInput | AssociateAgentCollaboratorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateAgentCollaboratorInputDict]) -> AssociateAgentCollaboratorOutput

Makes an agent a collaborator for another agent.

Parameters:

Name Type Description Default
request AssociateAgentCollaboratorInput | AssociateAgentCollaboratorInputDict | 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[AssociateAgentCollaboratorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssociateAgentCollaboratorOutput

An instance of AssociateAgentCollaboratorOutput.

associate_agent_collaborator async

associate_agent_collaborator(request: AssociateAgentCollaboratorInput | AssociateAgentCollaboratorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AssociateAgentCollaboratorInputDict]) -> AssociateAgentCollaboratorOutput

Makes an agent a collaborator for another agent.

Parameters:

Name Type Description Default
request AssociateAgentCollaboratorInput | AssociateAgentCollaboratorInputDict | 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[AssociateAgentCollaboratorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
AssociateAgentCollaboratorOutput

An instance of AssociateAgentCollaboratorOutput.

Input

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

AssociateAgentCollaboratorInputDict

Bases: TypedDict

Dictionary form of AssociateAgentCollaboratorInput.

Attributes

agent_descriptor instance-attribute

The alias of the collaborator agent.

agent_id instance-attribute
agent_id: Required[str]

The agent's ID.

agent_version instance-attribute
agent_version: Required[str]

An agent version.

client_token instance-attribute
client_token: str | None

A client token.

This field is autopopulated if not provided.

collaboration_instruction instance-attribute
collaboration_instruction: Required[str]

Instruction for the collaborator.

collaborator_name instance-attribute
collaborator_name: Required[str]

A name for the collaborator.

relay_conversation_history instance-attribute
relay_conversation_history: str | None

A relay conversation history for the collaborator.

AssociateAgentCollaboratorInput dataclass

Bases: _SerdeShape

Dataclass for AssociateAgentCollaboratorInput structure.

Attributes

agent_descriptor class-attribute instance-attribute
agent_descriptor: AgentDescriptor | None = ...

The alias of the collaborator agent.

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

The agent's ID.

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

An agent version.

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

A client token.

This field is autopopulated if not provided.

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

Instruction for the collaborator.

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

A name for the collaborator.

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

A relay conversation history for the collaborator.

Output

AssociateAgentCollaboratorOutput dataclass

Bases: _SerdeShape

Dataclass for AssociateAgentCollaboratorOutput 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.