Class: Rafflesia::Biosearch

Inherits:
Object
  • Object
show all
Defined in:
lib/rafflesia/biosearch.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Biosearch

Returns a new instance of Biosearch.



9
10
11
 
# File 'lib/rafflesia/biosearch.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#queryProfilesAudit(engine: nil, limit: nil, timeout_ms: nil, request_options: {}) ⇒ Rafflesia::EnvelopeBiosearchQueryProfileAuditData

POST /v1/biosearch/query-profiles/audit

Parameters:

  • engine (String, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: nil)
  • timeout_ms (Integer, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rafflesia/biosearch.rb', line 19

def queryProfilesAudit(
  engine: nil,
  limit: nil,
  timeout_ms: nil,
  request_options: {}
)
  body = {
    'engine' => engine,
    'limit' => limit,
    'timeout_ms' => timeout_ms
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/biosearch/query-profiles/audit',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeBiosearchQueryProfileAuditData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#queryProfilesAuditRun(path:, write_markdown:, allow_duplicate: nil, engine: nil, expected_row_count: nil, ingest_mode: nil, insert_chunk_bytes: nil, limit: nil, max_bytes_per_query: nil, max_bytes_per_query_increase: nil, max_final_recall_regression: nil, max_latency_ms: nil, max_latency_ms_increase: nil, max_object_reads_increase: nil, max_object_reads_per_query: nil, max_result_set_ids: nil, min_candidate_pool_recall: nil, min_final_recall_at_k: nil, output_dir: nil, previous_audit_path: nil, timeout_ms: nil, request_options: {}) ⇒ Rafflesia::EnvelopeBiosearchQueryProfileAuditRunData

POST /v1/biosearch/query-profiles/audit-run

Parameters:

  • allow_duplicate (Boolean, nil) (defaults to: nil)
  • engine (Rafflesia::Types::BiosearchQueryProfileAuditRunRequestEngine, nil) (defaults to: nil)
  • expected_row_count (Integer, nil) (defaults to: nil)
  • ingest_mode (Rafflesia::Types::BiosearchQueryProfileAuditRunRequestIngestMode, nil) (defaults to: nil)
  • insert_chunk_bytes (Integer, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: nil)
  • max_bytes_per_query (Float, nil) (defaults to: nil)
  • max_bytes_per_query_increase (Float, nil) (defaults to: nil)
  • max_final_recall_regression (Float, nil) (defaults to: nil)
  • max_latency_ms (Float, nil) (defaults to: nil)
  • max_latency_ms_increase (Float, nil) (defaults to: nil)
  • max_object_reads_increase (Float, nil) (defaults to: nil)
  • max_object_reads_per_query (Float, nil) (defaults to: nil)
  • max_result_set_ids (Integer, nil) (defaults to: nil)
  • min_candidate_pool_recall (Float, nil) (defaults to: nil)
  • min_final_recall_at_k (Float, nil) (defaults to: nil)
  • output_dir (String, nil) (defaults to: nil)
  • path (String)
  • previous_audit_path (String, nil) (defaults to: nil)
  • timeout_ms (Integer, nil) (defaults to: nil)
  • write_markdown (Boolean)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/rafflesia/biosearch.rb', line 66

def queryProfilesAuditRun(
  path:,
  write_markdown:,
  allow_duplicate: nil,
  engine: nil,
  expected_row_count: nil,
  ingest_mode: nil,
  insert_chunk_bytes: nil,
  limit: nil,
  max_bytes_per_query: nil,
  max_bytes_per_query_increase: nil,
  max_final_recall_regression: nil,
  max_latency_ms: nil,
  max_latency_ms_increase: nil,
  max_object_reads_increase: nil,
  max_object_reads_per_query: nil,
  max_result_set_ids: nil,
  min_candidate_pool_recall: nil,
  min_final_recall_at_k: nil,
  output_dir: nil,
  previous_audit_path: nil,
  timeout_ms: nil,
  request_options: {}
)
  body = {
    'allow_duplicate' => allow_duplicate,
    'engine' => engine,
    'expected_row_count' => expected_row_count,
    'ingest_mode' => ingest_mode,
    'insert_chunk_bytes' => insert_chunk_bytes,
    'limit' => limit,
    'max_bytes_per_query' => max_bytes_per_query,
    'max_bytes_per_query_increase' => max_bytes_per_query_increase,
    'max_final_recall_regression' => max_final_recall_regression,
    'max_latency_ms' => max_latency_ms,
    'max_latency_ms_increase' => max_latency_ms_increase,
    'max_object_reads_increase' => max_object_reads_increase,
    'max_object_reads_per_query' => max_object_reads_per_query,
    'max_result_set_ids' => max_result_set_ids,
    'min_candidate_pool_recall' => min_candidate_pool_recall,
    'min_final_recall_at_k' => min_final_recall_at_k,
    'output_dir' => output_dir,
    'path' => path,
    'previous_audit_path' => previous_audit_path,
    'timeout_ms' => timeout_ms,
    'write_markdown' => write_markdown
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/biosearch/query-profiles/audit-run',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeBiosearchQueryProfileAuditRunData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#queryProfilesIngest(path:, allow_duplicate: nil, dry_run: nil, expected_row_count: nil, ingest_mode: nil, insert_chunk_bytes: nil, request_options: {}) ⇒ Rafflesia::EnvelopeBiosearchQueryProfileIngestData

POST /v1/biosearch/query-profiles/ingest

Parameters:

  • allow_duplicate (Boolean, nil) (defaults to: nil)
  • dry_run (Boolean, nil) (defaults to: nil)
  • expected_row_count (Integer, nil) (defaults to: nil)
  • ingest_mode (Rafflesia::Types::BiosearchQueryProfileIngestRequestIngestMode, nil) (defaults to: nil)
  • insert_chunk_bytes (Integer, nil) (defaults to: nil)
  • path (String)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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
 
# File 'lib/rafflesia/biosearch.rb', line 134

def queryProfilesIngest(
  path:,
  allow_duplicate: nil,
  dry_run: nil,
  expected_row_count: nil,
  ingest_mode: nil,
  insert_chunk_bytes: nil,
  request_options: {}
)
  body = {
    'allow_duplicate' => allow_duplicate,
    'dry_run' => dry_run,
    'expected_row_count' => expected_row_count,
    'ingest_mode' => ingest_mode,
    'insert_chunk_bytes' => insert_chunk_bytes,
    'path' => path
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/biosearch/query-profiles/ingest',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeBiosearchQueryProfileIngestData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end