Skip to content

update_agent_collaborator

Operation

update_agent_collaborator

update_agent_collaborator(request: UpdateAgentCollaboratorInput | UpdateAgentCollaboratorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentCollaboratorInputDict]) -> UpdateAgentCollaboratorOutput

Updates an agent's collaborator.

Parameters:

Name Type Description Default
request UpdateAgentCollaboratorInput | UpdateAgentCollaboratorInputDict | 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[UpdateAgentCollaboratorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateAgentCollaboratorOutput

An instance of UpdateAgentCollaboratorOutput.

update_agent_collaborator async

update_agent_collaborator(request: UpdateAgentCollaboratorInput | UpdateAgentCollaboratorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentCollaboratorInputDict]) -> UpdateAgentCollaboratorOutput

Updates an agent's collaborator.

Parameters:

Name Type Description Default
request UpdateAgentCollaboratorInput | UpdateAgentCollaboratorInputDict | 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[UpdateAgentCollaboratorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateAgentCollaboratorOutput

An instance of UpdateAgentCollaboratorOutput.

Input

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

UpdateAgentCollaboratorInputDict

Bases: TypedDict

Dictionary form of UpdateAgentCollaboratorInput.

Attributes

agent_descriptor instance-attribute

An agent descriptor for the agent collaborator.

agent_id instance-attribute
agent_id: Required[str]

The agent's ID.

agent_version instance-attribute
agent_version: Required[str]

The agent's version.

collaboration_instruction instance-attribute
collaboration_instruction: Required[str]

Instruction for the collaborator.

collaborator_id instance-attribute
collaborator_id: Required[str]

The collaborator's ID.

collaborator_name instance-attribute
collaborator_name: Required[str]

The collaborator's name.

relay_conversation_history instance-attribute
relay_conversation_history: str | None

A relay conversation history for the collaborator.

UpdateAgentCollaboratorInput dataclass

Bases: _SerdeShape

Dataclass for UpdateAgentCollaboratorInput structure.

Attributes

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

An agent descriptor for the agent collaborator.

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.

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

Instruction for the collaborator.

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

The collaborator's ID.

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

The collaborator's name.

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

A relay conversation history for the collaborator.

Output

UpdateAgentCollaboratorOutput dataclass

Bases: _SerdeShape

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