Class: Cerca::Resources::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/cerca/resources/context.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Context

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 Context.

Parameters:



152
153
154
 
# File 'lib/cerca/resources/context.rb', line 152

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(agent_id, key:, request_options: {}) ⇒ Cerca::Models::ContextDeleteResponse

Delete context entry

Parameters:

  • agent_id (String)
  • key (String) —

    Context entry key.

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

Returns:

See Also:



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cerca/resources/context.rb', line 77

def delete(agent_id, params)
  parsed, options = Cerca::ContextDeleteParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :delete,
    path: ["agents/%1$s/context/entry", agent_id],
    query: query,
    model: Cerca::Models::ContextDeleteResponse,
    options: options
  )
end

#list(agent_id, cursor: nil, limit: nil, prefix: nil, request_options: {}) ⇒ Cerca::Internal::EntriesCursorPage<Cerca::Models::EntrySummary>

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

List context entries

Parameters:

  • agent_id (String)
  • cursor (String) —

    Opaque pagination cursor returned by a previous request.

  • limit (String) —

    Maximum number of items to return. Defaults to 20 and preserves parseInt semanti

  • prefix (String) —

    Optional key prefix filter.

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

Returns:

See Also:



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cerca/resources/context.rb', line 51

def list(agent_id, params = {})
  parsed, options = Cerca::ContextListParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["agents/%1$s/context", agent_id],
    query: query,
    page: Cerca::Internal::EntriesCursorPage,
    model: Cerca::EntrySummary,
    options: options
  )
end

#retrieve(agent_id, key:, request_options: {}) ⇒ Cerca::Models::Entry

Retrieve context entry

Parameters:

  • agent_id (String)
  • key (String) —

    Context entry key.

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

Returns:

See Also:



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/cerca/resources/context.rb', line 19

def retrieve(agent_id, params)
  parsed, options = Cerca::ContextRetrieveParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["agents/%1$s/context/entry", agent_id],
    query: query,
    model: Cerca::Entry,
    options: options
  )
end

#search(agent_id, q:, cursor: nil, limit: nil, prefix: nil, request_options: {}) ⇒ Cerca::Internal::ResultsCursorPage<Cerca::Models::SearchResult>

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

Search context

Parameters:

  • agent_id (String)
  • q (String) —

    Search query.

  • cursor (String) —

    Opaque pagination cursor returned by a previous request.

  • limit (String) —

    Maximum number of items to return. Defaults to 20 and preserves parseInt semanti

  • prefix (String) —

    Optional key prefix filter.

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

Returns:

See Also:



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/cerca/resources/context.rb', line 111

def search(agent_id, params)
  parsed, options = Cerca::ContextSearchParams.dump_request(params)
  query = Cerca::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["agents/%1$s/context/search", agent_id],
    query: query,
    page: Cerca::Internal::ResultsCursorPage,
    model: Cerca::SearchResult,
    options: options
  )
end

#write(agent_id, content:, key:, expected_version: nil, mime_type: nil, request_options: {}) ⇒ Cerca::Models::Entry

Update context entry

Parameters:

  • agent_id (String)
  • content (String)
  • key (String)
  • expected_version (Float)
  • mime_type (String)
  • request_options (Cerca::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cerca/resources/context.rb', line 138

def write(agent_id, params)
  parsed, options = Cerca::ContextWriteParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["agents/%1$s/context/entry", agent_id],
    body: parsed,
    model: Cerca::Entry,
    options: options
  )
end