Class: TrieveRubyClient::AnalyticsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/api/analytics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnalyticsApi

Returns a new instance of AnalyticsApi.



19
20
21
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_cluster_analytics(tr_dataset, cluster_analytics, opts = {}) ⇒ ClusterAnalyticsResponse

Get Cluster Analytics This route allows you to view the cluster analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • cluster_analytics (ClusterAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 28

def get_cluster_analytics(tr_dataset, cluster_analytics, opts = {})
  data, _status_code, _headers = get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics, opts)
  data
end

#get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics, opts = {}) ⇒ Array<(ClusterAnalyticsResponse, Integer, Hash)>

Get Cluster Analytics This route allows you to view the cluster analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • cluster_analytics (ClusterAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ClusterAnalyticsResponse, Integer, Hash)>) —

    ClusterAnalyticsResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 39

def get_cluster_analytics_with_http_info(tr_dataset, cluster_analytics, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_cluster_analytics ...'
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling AnalyticsApi.get_cluster_analytics"
  end
  # verify the required parameter 'cluster_analytics' is set
  if @api_client.config.client_side_validation && cluster_analytics.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_analytics' when calling AnalyticsApi.get_cluster_analytics"
  end
  # resource path
  local_var_path = '/api/analytics/search/cluster'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cluster_analytics)

  # return_type
  return_type = opts[:debug_return_type] || 'ClusterAnalyticsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_cluster_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_cluster_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rag_analytics(tr_dataset, rag_analytics, opts = {}) ⇒ RAGAnalyticsResponse

Get RAG Analytics This route allows you to view the RAG analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • rag_analytics (RAGAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



103
104
105
106
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 103

def get_rag_analytics(tr_dataset, rag_analytics, opts = {})
  data, _status_code, _headers = get_rag_analytics_with_http_info(tr_dataset, rag_analytics, opts)
  data
end

#get_rag_analytics_with_http_info(tr_dataset, rag_analytics, opts = {}) ⇒ Array<(RAGAnalyticsResponse, Integer, Hash)>

Get RAG Analytics This route allows you to view the RAG analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • rag_analytics (RAGAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RAGAnalyticsResponse, Integer, Hash)>) —

    RAGAnalyticsResponse data, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 114

def get_rag_analytics_with_http_info(tr_dataset, rag_analytics, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_rag_analytics ...'
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling AnalyticsApi.get_rag_analytics"
  end
  # verify the required parameter 'rag_analytics' is set
  if @api_client.config.client_side_validation && rag_analytics.nil?
    fail ArgumentError, "Missing the required parameter 'rag_analytics' when calling AnalyticsApi.get_rag_analytics"
  end
  # resource path
  local_var_path = '/api/analytics/rag'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(rag_analytics)

  # return_type
  return_type = opts[:debug_return_type] || 'RAGAnalyticsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_rag_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_rag_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_recommendation_analytics(tr_dataset, recommendation_analytics, opts = {}) ⇒ RecommendationAnalyticsResponse

Get Recommendation Analytics This route allows you to view the recommendation analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • recommendation_analytics (RecommendationAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



178
179
180
181
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 178

def get_recommendation_analytics(tr_dataset, recommendation_analytics, opts = {})
  data, _status_code, _headers = get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics, opts)
  data
end

#get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics, opts = {}) ⇒ Array<(RecommendationAnalyticsResponse, Integer, Hash)>

Get Recommendation Analytics This route allows you to view the recommendation analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • recommendation_analytics (RecommendationAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 189

def get_recommendation_analytics_with_http_info(tr_dataset, recommendation_analytics, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_recommendation_analytics ...'
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling AnalyticsApi.get_recommendation_analytics"
  end
  # verify the required parameter 'recommendation_analytics' is set
  if @api_client.config.client_side_validation && recommendation_analytics.nil?
    fail ArgumentError, "Missing the required parameter 'recommendation_analytics' when calling AnalyticsApi.get_recommendation_analytics"
  end
  # resource path
  local_var_path = '/api/analytics/recommendation'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(recommendation_analytics)

  # return_type
  return_type = opts[:debug_return_type] || 'RecommendationAnalyticsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_recommendation_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_recommendation_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_search_analytics(tr_dataset, search_analytics, opts = {}) ⇒ SearchAnalyticsResponse

Get Search Analytics This route allows you to view the search analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • search_analytics (SearchAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



253
254
255
256
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 253

def get_search_analytics(tr_dataset, search_analytics, opts = {})
  data, _status_code, _headers = get_search_analytics_with_http_info(tr_dataset, search_analytics, opts)
  data
end

#get_search_analytics_with_http_info(tr_dataset, search_analytics, opts = {}) ⇒ Array<(SearchAnalyticsResponse, Integer, Hash)>

Get Search Analytics This route allows you to view the search analytics for a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • search_analytics (SearchAnalytics) —

    JSON request payload to filter the graph

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SearchAnalyticsResponse, Integer, Hash)>) —

    SearchAnalyticsResponse data, response status code and response headers



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/trieve_ruby_client/api/analytics_api.rb', line 264

def get_search_analytics_with_http_info(tr_dataset, search_analytics, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_search_analytics ...'
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling AnalyticsApi.get_search_analytics"
  end
  # verify the required parameter 'search_analytics' is set
  if @api_client.config.client_side_validation && search_analytics.nil?
    fail ArgumentError, "Missing the required parameter 'search_analytics' when calling AnalyticsApi.get_search_analytics"
  end
  # resource path
  local_var_path = '/api/analytics/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(search_analytics)

  # return_type
  return_type = opts[:debug_return_type] || 'SearchAnalyticsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_search_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_search_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end