---
orphan: true
---

# {py:mod}`agents.components.memory`

```{py:module} agents.components.memory
```

```{autodoc2-docstring} agents.components.memory
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Memory <agents.components.memory.Memory>`
  - ```{autodoc2-docstring} agents.components.memory.Memory
    :summary:
    ```
````

### API

`````{py:class} Memory(*, layers: typing.List[agents.ros.MemLayer], position: agents.ros.Topic, model_client: typing.Optional[agents.clients.model_base.ModelClient] = None, embedding_client: typing.Optional[agents.clients.model_base.ModelClient] = None, config: typing.Optional[agents.config.MemoryConfig] = None, trigger: typing.Union[agents.ros.Topic, typing.List[agents.ros.Topic], float, agents.ros.Event] = 10.0, component_name: str, **kwargs)
:canonical: agents.components.memory.Memory

Bases: {py:obj}`agents.components.component_base.Component`

```{autodoc2-docstring} agents.components.memory.Memory
```

````{py:method} custom_on_configure()
:canonical: agents.components.memory.Memory.custom_on_configure

```{autodoc2-docstring} agents.components.memory.Memory.custom_on_configure
```

````

````{py:method} custom_on_deactivate()
:canonical: agents.components.memory.Memory.custom_on_deactivate

```{autodoc2-docstring} agents.components.memory.Memory.custom_on_deactivate
```

````

````{py:method} inspect_component() -> str
:canonical: agents.components.memory.Memory.inspect_component

```{autodoc2-docstring} agents.components.memory.Memory.inspect_component
```

````

````{py:method} store() -> None
:canonical: agents.components.memory.Memory.store

```{autodoc2-docstring} agents.components.memory.Memory.store
```

````

````{py:method} store_specific_memory(content: str, layer_name: str = 'agent_notes', x: typing.Optional[float] = None, y: typing.Optional[float] = None, z: typing.Optional[float] = None) -> bool
:canonical: agents.components.memory.Memory.store_specific_memory

```{autodoc2-docstring} agents.components.memory.Memory.store_specific_memory
```

````

````{py:method} start_episode(name: str) -> str
:canonical: agents.components.memory.Memory.start_episode

```{autodoc2-docstring} agents.components.memory.Memory.start_episode
```

````

````{py:method} end_episode() -> str
:canonical: agents.components.memory.Memory.end_episode

```{autodoc2-docstring} agents.components.memory.Memory.end_episode
```

````

````{py:method} semantic_search(**kwargs) -> str
:canonical: agents.components.memory.Memory.semantic_search

```{autodoc2-docstring} agents.components.memory.Memory.semantic_search
```

````

````{py:method} spatial_query(**kwargs) -> str
:canonical: agents.components.memory.Memory.spatial_query

```{autodoc2-docstring} agents.components.memory.Memory.spatial_query
```

````

````{py:method} temporal_query(**kwargs) -> str
:canonical: agents.components.memory.Memory.temporal_query

```{autodoc2-docstring} agents.components.memory.Memory.temporal_query
```

````

````{py:method} episode_summary(**kwargs) -> str
:canonical: agents.components.memory.Memory.episode_summary

```{autodoc2-docstring} agents.components.memory.Memory.episode_summary
```

````

````{py:method} get_current_context(**kwargs) -> str
:canonical: agents.components.memory.Memory.get_current_context

```{autodoc2-docstring} agents.components.memory.Memory.get_current_context
```

````

````{py:method} search_gists(**kwargs) -> str
:canonical: agents.components.memory.Memory.search_gists

```{autodoc2-docstring} agents.components.memory.Memory.search_gists
```

````

````{py:method} entity_query(**kwargs) -> str
:canonical: agents.components.memory.Memory.entity_query

```{autodoc2-docstring} agents.components.memory.Memory.entity_query
```

````

````{py:method} locate(**kwargs) -> str
:canonical: agents.components.memory.Memory.locate

```{autodoc2-docstring} agents.components.memory.Memory.locate
```

````

````{py:method} recall(**kwargs) -> str
:canonical: agents.components.memory.Memory.recall

```{autodoc2-docstring} agents.components.memory.Memory.recall
```

````

````{py:method} body_status(**kwargs) -> str
:canonical: agents.components.memory.Memory.body_status

```{autodoc2-docstring} agents.components.memory.Memory.body_status
```

````

````{py:method} register_tools_on(llm, tools: typing.Optional[typing.List[str]] = None, send_tool_response_to_model: bool = True) -> None
:canonical: agents.components.memory.Memory.register_tools_on

```{autodoc2-docstring} agents.components.memory.Memory.register_tools_on
```

````

`````