Class: Anthropic::Models::Beta::MemoryStores::MemoryListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/memory_stores/memory_list_params.rb,
sig/anthropic/models/beta/memory_stores/memory_list_params.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::MemoryStores::Memories#list

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(memory_store_id:, depth: nil, limit: nil, page: nil, path_prefix: nil, view: nil, betas: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Anthropic::Models::Beta::MemoryStores::MemoryListParams for more details.

Parameters:

  • memory_store_id (String)
  • depth (Integer) (defaults to: nil) —

    0 (or omitted) returns all descendants below path_prefix (recursive). 1 re

  • limit (Integer) (defaults to: nil) —

    Maximum number of items to return per page. Must be between 1 and 100. Defaults

  • page (String) (defaults to: nil) —

    Opaque pagination cursor (a page_... value). Pass the next_page value from a

  • path_prefix (String) (defaults to: nil) —

    Optional path prefix filter. Must end with / (segment-aligned), e.g., `/notes/

  • view (Symbol, Anthropic::Models::Beta::MemoryStores::BetaManagedAgentsMemoryView) (defaults to: nil) —

    Which projection of each memory to return. Defaults to basic (content omitte

  • betas (Array<String, Symbol, Anthropic::Models::AnthropicBeta>) (defaults to: nil) —

    Optional header to specify the beta version(s) you want to use.

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 62

Instance Attribute Details

#betas ⇒ Array<String, Symbol, Anthropic::Models::AnthropicBeta>?

Optional header to specify the beta version(s) you want to use.

Returns:



60
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 60

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#depth ⇒ Integer?

0 (or omitted) returns all descendants below path_prefix (recursive). 1 returns immediate children only; deeper entries roll up as memory_prefix items. depth=1 behaves like ls; omitting depth behaves like find.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


23
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 23

optional :depth, Integer

#limit ⇒ Integer?

Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 when omitted. Capped at 20 when view=full. Both memory and memory_prefix items count toward the limit.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


31
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 31

optional :limit, Integer

#memory_store_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 15

required :memory_store_id, String

#page ⇒ String?

Opaque pagination cursor (a page_... value). Pass the next_page value from a previous response to fetch the next page; omit for the first page.

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 38

optional :page, String

#path_prefix ⇒ String?

Optional path prefix filter. Must end with / (segment-aligned), e.g., /notes/. This value appears in request URLs. Do not include secrets or personally identifiable information.

Parameters:

  • (String)

Returns:

  • (String, nil) 


46
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 46

optional :path_prefix, String

#view ⇒ Symbol, ...

Which projection of each memory to return. Defaults to basic (content omitted). full populates content on each item and caps limit at 20; use this as the bulk-read path for export and sync.

Returns:



54
 
# File 'lib/anthropic/models/beta/memory_stores/memory_list_params.rb', line 54

optional :view, enum: -> { Anthropic::Beta::MemoryStores::BetaManagedAgentsMemoryView }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


62
 
# File 'sig/anthropic/models/beta/memory_stores/memory_list_params.rbs', line 62

def to_hash: -> {