Skip to content

delete_agent_memory

Operation

delete_agent_memory

delete_agent_memory(request: DeleteAgentMemoryInput | DeleteAgentMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentMemoryInputDict]) -> DeleteAgentMemoryOutput

Deletes memory from the specified memory identifier.

Parameters:

Name Type Description Default
request DeleteAgentMemoryInput | DeleteAgentMemoryInputDict | 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[DeleteAgentMemoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteAgentMemoryOutput

An instance of DeleteAgentMemoryOutput.

delete_agent_memory async

delete_agent_memory(request: DeleteAgentMemoryInput | DeleteAgentMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentMemoryInputDict]) -> DeleteAgentMemoryOutput

Deletes memory from the specified memory identifier.

Parameters:

Name Type Description Default
request DeleteAgentMemoryInput | DeleteAgentMemoryInputDict | 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[DeleteAgentMemoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteAgentMemoryOutput

An instance of DeleteAgentMemoryOutput.

Input

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

DeleteAgentMemoryInputDict

Bases: TypedDict

Dictionary form of DeleteAgentMemoryInput.

Attributes

agent_alias_id instance-attribute
agent_alias_id: Required[str]

The unique identifier of an alias of an agent.

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent to which the alias belongs.

memory_id instance-attribute
memory_id: str | None

The unique identifier of the memory.

session_id instance-attribute
session_id: str | None

The unique session identifier of the memory.

DeleteAgentMemoryInput dataclass

Bases: _SerdeShape

Dataclass for DeleteAgentMemoryInput structure.

Attributes

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

The unique identifier of an alias of an agent.

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

The unique identifier of the agent to which the alias belongs.

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

The unique identifier of the memory.

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

The unique session identifier of the memory.

Output

DeleteAgentMemoryOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteAgentMemoryOutput structure.

Attributes

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.