Class: MemoriClient::Backend::V2::Analysis

Inherits:
Resource show all
Defined in:
lib/memori_client/backend/v2/analysis.rb

Overview

Generated on 2025-01-27 16:56:15 +0000

Class Method Summary collapse

Methods inherited from Resource

build_url

Methods inherited from Resource

build_arguments, build_url, exec_http_request, validate_payload!

Class Method Details

.analyze_user_query(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/Analysis/AnalyzeUserQuery/strToken/strMemoriID`

Starts an Analysis process for User/query match on Deep Thought known facts.

‘analyze_user_query(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

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

    request payload. optional

  • payload.query (String) —

    . optional

  • payload.threshold (Number) —

    . optional



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/memori_client/backend/v2/analysis.rb', line 19

def self.analyze_user_query(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'query',
    'threshold',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID}', **args)
end

.list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil) ⇒ Object

‘GET /api/v2/Analysis/UserQueryMatches/strToken/strAnalysisID/from/howMany/threshold`

Lists Deep Thought User/query Match objects of the specified Analysis object, with pagination.

‘list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)`

Parameters:

  • strToken (string) —

    The login token. required

  • strAnalysisID (string) —

    The Analysis process ID. required

  • from (integer) —

    The 0-based index of the first Match object to list. required

  • howMany (integer) —

    The number of the Match objects to list. required

  • threshold (number) (defaults to: nil) —

    Optional threshold between 0.0 and 1.0: Match objects below the threshold are excluded from the list. optional



47
48
49
50
51
 
# File 'lib/memori_client/backend/v2/analysis.rb', line 47

def self.list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)
  args = build_arguments(binding)

  exec_http_request('get', '/api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold}', **args)
end