Skip to content

iter_list_memories

iter_list_memories(
    space_id: SpaceId,
    *,
    config_overrides: Optional[OpenSearchMemoryClientConfig] = None,
    memory_strategies: Optional[StrategySelectorList] = None,
    actor_ids: Optional[ActorIdList] = None,
    session_ids: Optional[SessionIdList] = None,
    sort_by: Optional[MemorySortField] = None,
    sort_order: Optional[SortOrder] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> Iterator[MemoryListSummary]
Source code in docs_src/capo_opensearchmemory/_services/open_search_memory.py
def iter_list_memories(
    self,
    space_id: "capo_opensearchmemory.types.space_id.SpaceId",
    *,
    config_overrides: Optional[OpenSearchMemoryClientConfig] = None,
    memory_strategies: Optional[
        "capo_opensearchmemory.types.strategy_selector_list.StrategySelectorList"
    ] = None,
    actor_ids: Optional[
        "capo_opensearchmemory.types.actor_id_list.ActorIdList"
    ] = None,
    session_ids: Optional[
        "capo_opensearchmemory.types.session_id_list.SessionIdList"
    ] = None,
    sort_by: Optional[
        "capo_opensearchmemory.types.memory_sort_field.MemorySortField"
    ] = None,
    sort_order: Optional["capo_opensearchmemory.types.sort_order.SortOrder"] = None,
    max_results: Optional[
        "capo_opensearchmemory.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_opensearchmemory.types.pagination_token.PaginationToken"
    ] = None,
) -> "Iterator[capo_opensearchmemory.types.memory_list_summary.MemoryListSummary]":
    _token = next_token
    while True:
        _response = self.list_memories(
            space_id,
            config_overrides=config_overrides,
            memory_strategies=memory_strategies,
            actor_ids=actor_ids,
            session_ids=session_ids,
            sort_by=sort_by,
            sort_order=sort_order,
            max_results=max_results,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("memories",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break