Class: Cadenya::Resources::MemoryLayers

Inherits:
Object
  • Object
show all
Defined in:
lib/cadenya/resources/memory_layers.rb,
lib/cadenya/resources/memory_layers/entries.rb,
sig/cadenya/resources/memory_layers.rbs,
sig/cadenya/resources/memory_layers/entries.rbs

Overview

Manage memory layers and their entries. Layers are named containers that can be composed into an objective's memory cascade; entries are the keyed values within a layer. System-managed layers (e.g., episodic layers created by the runtime) cannot be mutated through this API.

Defined Under Namespace

Classes: Entries

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ MemoryLayers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of MemoryLayers.

Parameters:



201
202
203
204
 
# File 'lib/cadenya/resources/memory_layers.rb', line 201

def initialize(client:)
  @client = client
  @entries = Cadenya::Resources::MemoryLayers::Entries.new(client: client)
end

Instance Attribute Details

#entries ⇒ Cadenya::Resources::MemoryLayers::Entries (readonly)

Manage memory layers and their entries. Layers are named containers that can be composed into an objective's memory cascade; entries are the keyed values within a layer. System-managed layers (e.g., episodic layers created by the runtime) cannot be mutated through this API.

Returns:



15
16
17
 
# File 'lib/cadenya/resources/memory_layers.rb', line 15

def entries
  @entries
end

Instance Method Details

#create(metadata:, spec:, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::MemoryLayer

Some parameter documentations has been truncated, see Models::MemoryLayerCreateParams for more details.

Creates a new memory layer in the workspace

Parameters:

Returns:

See Also:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/cadenya/resources/memory_layers.rb', line 35

def create(params)
  parsed, options = Cadenya::MemoryLayerCreateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :post,
    path: ["v1/workspaces/%1$s/memory_layers", workspace_id],
    body: parsed,
    model: Cadenya::MemoryLayer,
    options: options
  )
end

#delete(id, workspace_id: nil, request_options: {}) ⇒ nil

Deletes a memory layer from the workspace

Parameters:

  • id (String) —

    Memory layer ID. Accepts canonical memlyr_… form or external_id: form.

  • workspace_id (String)
  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/cadenya/resources/memory_layers.rb', line 184

def delete(id, params = {})
  parsed, options = Cadenya::MemoryLayerDeleteParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :delete,
    path: ["v1/workspaces/%1$s/memory_layers/%2$s", workspace_id, id],
    model: NilClass,
    options: options
  )
end

#list(workspace_id: nil, agent_id: nil, cursor: nil, episodic_key_prefix: nil, include_info: nil, labels: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, type: nil, request_options: {}) ⇒ Cadenya::Internal::CursorPagination<Cadenya::Models::MemoryLayer>

Some parameter documentations has been truncated, see Models::MemoryLayerListParams for more details.

Lists all memory layers in the workspace

Parameters:

  • workspace_id (String) —

    Path param

  • agent_id (String) —

    Query param: Filter to episodic layers belonging to this agent.

  • cursor (String) —

    Query param: Pagination cursor from previous response

  • episodic_key_prefix (String) —

    Query param: Filter to episodic layers whose episodic key starts with this prefi

  • include_info (Boolean) —

    Query param: When set to true you may use more of your alloted API rate-limit

  • labels (String) —

    Query param: Filters by metadata labels. Comma-separated key=value pairs,

  • limit (Integer) —

    Query param: Maximum number of results to return

  • prefix (String) —

    Query param: Filter expression (query param: prefix)

  • query (String) —

    Query param: Free-form search query

  • sort_order (String) —

    Query param: Sort order for results (asc or desc by creation time)

  • type (Symbol, Cadenya::Models::MemoryLayerListParams::Type) —

    Query param: Filter by layer type

  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/cadenya/resources/memory_layers.rb', line 149

def list(params = {})
  parsed, options = Cadenya::MemoryLayerListParams.dump_request(params)
  query = Cadenya::Internal::Util.encode_query_params(parsed)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/memory_layers", workspace_id],
    query: query.transform_keys(
      agent_id: "agentId",
      episodic_key_prefix: "episodicKeyPrefix",
      include_info: "includeInfo",
      sort_order: "sortOrder"
    ),
    page: Cadenya::Internal::CursorPagination,
    model: Cadenya::MemoryLayer,
    options: options
  )
end

#retrieve(id, workspace_id: nil, request_options: {}) ⇒ Cadenya::Models::MemoryLayer

Retrieves a memory layer by ID from the workspace

Parameters:

  • id (String) —

    Memory layer ID. Accepts canonical memlyr_… form or external_id: form.

  • workspace_id (String)
  • request_options (Cadenya::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/cadenya/resources/memory_layers.rb', line 63

def retrieve(id, params = {})
  parsed, options = Cadenya::MemoryLayerRetrieveParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :get,
    path: ["v1/workspaces/%1$s/memory_layers/%2$s", workspace_id, id],
    model: Cadenya::MemoryLayer,
    options: options
  )
end

#update(id, workspace_id: nil, metadata: nil, spec: nil, update_mask: nil, request_options: {}) ⇒ Cadenya::Models::MemoryLayer

Some parameter documentations has been truncated, see Models::MemoryLayerUpdateParams for more details.

Updates a memory layer in the workspace

external_id:<val

Parameters:

Returns:

See Also:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/cadenya/resources/memory_layers.rb', line 100

def update(id, params = {})
  parsed, options = Cadenya::MemoryLayerUpdateParams.dump_request(params)
  workspace_id =
    parsed.delete(:workspace_id) do
      @client.workspace_id
    end
  @client.request(
    method: :patch,
    path: ["v1/workspaces/%1$s/memory_layers/%2$s", workspace_id, id],
    body: parsed,
    model: Cadenya::MemoryLayer,
    options: options
  )
end