Class: IndexeaClient::QueriesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/indexea_client/api/queries_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QueriesApi

Returns a new instance of QueriesApi.



16
17
18
 
# File 'lib/indexea_client/api/queries_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/indexea_client/api/queries_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#query_analyze(body, app, opts = {}) ⇒ Array<AnalyzeToken>

分词测试

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :index (BigDecimal) —

    索引编号，如果指定索引编号则使用索引的分词器 (default to 0)

Returns:



25
26
27
28
 
# File 'lib/indexea_client/api/queries_api.rb', line 25

def query_analyze(body, app, opts = {})
  data, _status_code, _headers = query_analyze_with_http_info(body, app, opts)
  data
end

#query_analyze_with_http_info(body, app, opts = {}) ⇒ Array<(Array<AnalyzeToken>, Integer, Hash)>

分词测试

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :index (BigDecimal) —

    索引编号，如果指定索引编号则使用索引的分词器

Returns:

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

    Array<AnalyzeToken> data, response status code and response headers



36
37
38
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
 
# File 'lib/indexea_client/api/queries_api.rb', line 36

def query_analyze_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_analyze ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_analyze"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_analyze"
  end
  # resource path
  local_var_path = '/queries/{app}/analyze'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Array<AnalyzeToken>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_analyze\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_copy(app, query, opts = {}) ⇒ QueryBean

复制指定查询并创建新查询

Parameters:

  • app —

    应用标识

  • query —

    源查询编号

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/indexea_client/api/queries_api.rb', line 89

def query_copy(app, query, opts = {})
  data, _status_code, _headers = query_copy_with_http_info(app, query, opts)
  data
end

#query_copy_to_query(app, query, to, opts = {}) ⇒ BOOLEAN

复制查询到已有查询

Parameters:

  • app —

    应用标识

  • query —

    源查询编号

  • to —

    目标查询编号

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

    the optional parameters

Returns:

  • (BOOLEAN) 


151
152
153
154
 
# File 'lib/indexea_client/api/queries_api.rb', line 151

def query_copy_to_query(app, query, to, opts = {})
  data, _status_code, _headers = query_copy_to_query_with_http_info(app, query, to, opts)
  data
end

#query_copy_to_query_with_http_info(app, query, to, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

复制查询到已有查询

Parameters:

  • app —

    应用标识

  • query —

    源查询编号

  • to —

    目标查询编号

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/indexea_client/api/queries_api.rb', line 162

def query_copy_to_query_with_http_info(app, query, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_copy_to_query ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_copy_to_query"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_copy_to_query"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling QueriesApi.query_copy_to_query"
  end
  # resource path
  local_var_path = '/queries/{app}/copy'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_copy_to_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_copy_with_http_info(app, query, opts = {}) ⇒ Array<(QueryBean, Integer, Hash)>

复制指定查询并创建新查询

Parameters:

  • app —

    应用标识

  • query —

    源查询编号

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

    the optional parameters

Returns:

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

    QueryBean data, response status code and response headers



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/indexea_client/api/queries_api.rb', line 99

def query_copy_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_copy ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_copy"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_copy"
  end
  # resource path
  local_var_path = '/queries/{app}/copy'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'QueryBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_create(body, app, opts = {}) ⇒ QueryBean

创建搜索

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Returns:



218
219
220
221
 
# File 'lib/indexea_client/api/queries_api.rb', line 218

def query_create(body, app, opts = {})
  data, _status_code, _headers = query_create_with_http_info(body, app, opts)
  data
end

#query_create_keyword_bindings(body, query, app, opts = {}) ⇒ KeywordBindingBean

创建新的关键词文档绑定

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/indexea_client/api/queries_api.rb', line 281

def query_create_keyword_bindings(body, query, app, opts = {})
  data, _status_code, _headers = query_create_keyword_bindings_with_http_info(body, query, app, opts)
  data
end

#query_create_keyword_bindings_with_http_info(body, query, app, opts = {}) ⇒ Array<(KeywordBindingBean, Integer, Hash)>

创建新的关键词文档绑定

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    KeywordBindingBean data, response status code and response headers



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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/indexea_client/api/queries_api.rb', line 292

def query_create_keyword_bindings_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_create_keyword_bindings ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_create_keyword_bindings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_create_keyword_bindings"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_create_keyword_bindings"
  end
  # resource path
  local_var_path = '/queries/{app}/keyword-bindings'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'KeywordBindingBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_create_keyword_bindings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_create_variable(body, app, opts = {}) ⇒ QueryVariableBean

创建新的预定义查询变量

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Returns:



349
350
351
352
 
# File 'lib/indexea_client/api/queries_api.rb', line 349

def query_create_variable(body, app, opts = {})
  data, _status_code, _headers = query_create_variable_with_http_info(body, app, opts)
  data
end

#query_create_variable_with_http_info(body, app, opts = {}) ⇒ Array<(QueryVariableBean, Integer, Hash)>

创建新的预定义查询变量

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Returns:

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

    QueryVariableBean data, response status code and response headers



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/indexea_client/api/queries_api.rb', line 359

def query_create_variable_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_create_variable ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_create_variable"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_create_variable"
  end
  # resource path
  local_var_path = '/queries/{app}/variables'.sub('{' + 'app' + '}', app.to_s)

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'QueryVariableBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_create_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_create_with_http_info(body, app, opts = {}) ⇒ Array<(QueryBean, Integer, Hash)>

创建搜索

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Returns:

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

    QueryBean data, response status code and response headers



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/indexea_client/api/queries_api.rb', line 228

def query_create_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_create"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_create"
  end
  # resource path
  local_var_path = '/queries/{app}'.sub('{' + 'app' + '}', app.to_s)

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'QueryBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_delete(app, query, opts = {}) ⇒ BOOLEAN

删除搜索

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

  • (BOOLEAN) 


411
412
413
414
 
# File 'lib/indexea_client/api/queries_api.rb', line 411

def query_delete(app, query, opts = {})
  data, _status_code, _headers = query_delete_with_http_info(app, query, opts)
  data
end

#query_delete_keyword_bindings(app, query, id, opts = {}) ⇒ BOOLEAN

删除关键词文档绑定

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • id —

    关键词编号

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

    the optional parameters

Returns:

  • (BOOLEAN) 


473
474
475
476
 
# File 'lib/indexea_client/api/queries_api.rb', line 473

def query_delete_keyword_bindings(app, query, id, opts = {})
  data, _status_code, _headers = query_delete_keyword_bindings_with_http_info(app, query, id, opts)
  data
end

#query_delete_keyword_bindings_with_http_info(app, query, id, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除关键词文档绑定

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • id —

    关键词编号

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/indexea_client/api/queries_api.rb', line 484

def query_delete_keyword_bindings_with_http_info(app, query, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_delete_keyword_bindings ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_delete_keyword_bindings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_delete_keyword_bindings"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling QueriesApi.query_delete_keyword_bindings"
  end
  # resource path
  local_var_path = '/queries/{app}/keyword-bindings'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_delete_keyword_bindings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_delete_node_positions(app, query, opts = {}) ⇒ BOOLEAN

清除查询条件的节点位置信息

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

  • (BOOLEAN) 


540
541
542
543
 
# File 'lib/indexea_client/api/queries_api.rb', line 540

def query_delete_node_positions(app, query, opts = {})
  data, _status_code, _headers = query_delete_node_positions_with_http_info(app, query, opts)
  data
end

#query_delete_node_positions_with_http_info(app, query, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

清除查询条件的节点位置信息

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/indexea_client/api/queries_api.rb', line 550

def query_delete_node_positions_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_delete_node_positions ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_delete_node_positions"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_delete_node_positions"
  end
  # resource path
  local_var_path = '/queries/{app}/node-positions'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_delete_node_positions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_delete_variable(app, id, opts = {}) ⇒ BOOLEAN

删除预定义查询变量

Parameters:

  • app —

    应用标识

  • id —

    自定义查询变量编号

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

    the optional parameters

Returns:

  • (BOOLEAN) 


601
602
603
604
 
# File 'lib/indexea_client/api/queries_api.rb', line 601

def query_delete_variable(app, id, opts = {})
  data, _status_code, _headers = query_delete_variable_with_http_info(app, id, opts)
  data
end

#query_delete_variable_with_http_info(app, id, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除预定义查询变量

Parameters:

  • app —

    应用标识

  • id —

    自定义查询变量编号

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/indexea_client/api/queries_api.rb', line 611

def query_delete_variable_with_http_info(app, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_delete_variable ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_delete_variable"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling QueriesApi.query_delete_variable"
  end
  # resource path
  local_var_path = '/queries/{app}/variables'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_delete_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_delete_with_http_info(app, query, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

删除搜索

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/indexea_client/api/queries_api.rb', line 421

def query_delete_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_delete ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_delete"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_delete"
  end
  # resource path
  local_var_path = '/queries/{app}'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_fields(app, query, opts = {}) ⇒ Array<IndexFieldBean>

获取查询关联的所有索引的字段信息

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:



662
663
664
665
 
# File 'lib/indexea_client/api/queries_api.rb', line 662

def query_fields(app, query, opts = {})
  data, _status_code, _headers = query_fields_with_http_info(app, query, opts)
  data
end

#query_fields_with_http_info(app, query, opts = {}) ⇒ Array<(Array<IndexFieldBean>, Integer, Hash)>

获取查询关联的所有索引的字段信息

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    Array<IndexFieldBean> data, response status code and response headers



672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/indexea_client/api/queries_api.rb', line 672

def query_fields_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_fields ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_fields"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_fields"
  end
  # resource path
  local_var_path = '/queries/{app}/fields'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<IndexFieldBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_get(app, query, opts = {}) ⇒ QueryBean

获取查询的详情

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:



723
724
725
726
 
# File 'lib/indexea_client/api/queries_api.rb', line 723

def query_get(app, query, opts = {})
  data, _status_code, _headers = query_get_with_http_info(app, query, opts)
  data
end

#query_get_node_positions(app, query, opts = {}) ⇒ Object

获取查询条件的节点位置信息

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

  • (Object) 


783
784
785
786
 
# File 'lib/indexea_client/api/queries_api.rb', line 783

def query_get_node_positions(app, query, opts = {})
  data, _status_code, _headers = query_get_node_positions_with_http_info(app, query, opts)
  data
end

#query_get_node_positions_with_http_info(app, query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

获取查询条件的节点位置信息

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/indexea_client/api/queries_api.rb', line 793

def query_get_node_positions_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_get_node_positions ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_get_node_positions"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_get_node_positions"
  end
  # resource path
  local_var_path = '/queries/{app}/node-positions'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_get_node_positions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_get_record(app, query, _id, opts = {}) ⇒ Object

获取记录的详情

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • _id —

    记录 _id 值

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

    the optional parameters

Returns:

  • (Object) 


845
846
847
848
 
# File 'lib/indexea_client/api/queries_api.rb', line 845

def query_get_record(app, query, _id, opts = {})
  data, _status_code, _headers = query_get_record_with_http_info(app, query, _id, opts)
  data
end

#query_get_record_with_http_info(app, query, _id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

获取记录的详情

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • _id —

    记录 _id 值

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/indexea_client/api/queries_api.rb', line 856

def query_get_record_with_http_info(app, query, _id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_get_record ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_get_record"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_get_record"
  end
  # verify the required parameter '_id' is set
  if @api_client.config.client_side_validation && _id.nil?
    fail ArgumentError, "Missing the required parameter '_id' when calling QueriesApi.query_get_record"
  end
  # resource path
  local_var_path = '/queries/{app}/record'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_get_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_get_with_http_info(app, query, opts = {}) ⇒ Array<(QueryBean, Integer, Hash)>

获取查询的详情

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    QueryBean data, response status code and response headers



733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/indexea_client/api/queries_api.rb', line 733

def query_get_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_get ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_get"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_get"
  end
  # resource path
  local_var_path = '/queries/{app}/{query}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'query' + '}', query.to_s)

  # 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'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'QueryBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_keyword_bindings(app, query, opts = {}) ⇒ Array<KeywordBindingBean>

获取查询的关键词文档绑定列表

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:



912
913
914
915
 
# File 'lib/indexea_client/api/queries_api.rb', line 912

def query_keyword_bindings(app, query, opts = {})
  data, _status_code, _headers = query_keyword_bindings_with_http_info(app, query, opts)
  data
end

#query_keyword_bindings_with_http_info(app, query, opts = {}) ⇒ Array<(Array<KeywordBindingBean>, Integer, Hash)>

获取查询的关键词文档绑定列表

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    Array<KeywordBindingBean> data, response status code and response headers



922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
 
# File 'lib/indexea_client/api/queries_api.rb', line 922

def query_keyword_bindings_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_keyword_bindings ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_keyword_bindings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_keyword_bindings"
  end
  # resource path
  local_var_path = '/queries/{app}/keyword-bindings'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<KeywordBindingBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_keyword_bindings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_list(app, opts = {}) ⇒ Array<QueryBean>

获取应用下所有索引下的查询列表（按索引进行分组）

Parameters:

  • app —

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :index (Integer) —

    索引编号

Returns:



973
974
975
976
 
# File 'lib/indexea_client/api/queries_api.rb', line 973

def query_list(app, opts = {})
  data, _status_code, _headers = query_list_with_http_info(app, opts)
  data
end

#query_list_with_http_info(app, opts = {}) ⇒ Array<(Array<QueryBean>, Integer, Hash)>

获取应用下所有索引下的查询列表（按索引进行分组）

Parameters:

  • app —

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :index (Integer) —

    索引编号

Returns:

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

    Array<QueryBean> data, response status code and response headers



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'lib/indexea_client/api/queries_api.rb', line 983

def query_list_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_list ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_list"
  end
  # resource path
  local_var_path = '/queries/{app}'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<QueryBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_profile(app, query, opts = {}) ⇒ Object

获取搜索诊断信息

Parameters:

  • app —

    应用标识

  • query —

    记录编号

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    诊断关键字

Returns:

  • (Object) 


1031
1032
1033
1034
 
# File 'lib/indexea_client/api/queries_api.rb', line 1031

def query_profile(app, query, opts = {})
  data, _status_code, _headers = query_profile_with_http_info(app, query, opts)
  data
end

#query_profile_with_http_info(app, query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

获取搜索诊断信息

Parameters:

  • app —

    应用标识

  • query —

    记录编号

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    诊断关键字

Returns:

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

    Object data, response status code and response headers



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/indexea_client/api/queries_api.rb', line 1042

def query_profile_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_profile ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_profile"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_profile"
  end
  # resource path
  local_var_path = '/queries/{app}/profiler'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_records_of_keyword_binding(app, id, opts = {}) ⇒ Array<Object>

获取关键词绑定对应的记录列表

Parameters:

  • app —

    应用标识

  • id —

    关键词绑定编号

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

    the optional parameters

Returns:

  • (Array<Object>) 


1094
1095
1096
1097
 
# File 'lib/indexea_client/api/queries_api.rb', line 1094

def query_records_of_keyword_binding(app, id, opts = {})
  data, _status_code, _headers = query_records_of_keyword_binding_with_http_info(app, id, opts)
  data
end

#query_records_of_keyword_binding_with_http_info(app, id, opts = {}) ⇒ Array<(Array<Object>, Integer, Hash)>

获取关键词绑定对应的记录列表

Parameters:

  • app —

    应用标识

  • id —

    关键词绑定编号

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

    the optional parameters

Returns:

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

    Array<Object> data, response status code and response headers



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/indexea_client/api/queries_api.rb', line 1104

def query_records_of_keyword_binding_with_http_info(app, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_records_of_keyword_binding ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_records_of_keyword_binding"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling QueriesApi.query_records_of_keyword_binding"
  end
  # resource path
  local_var_path = '/queries/{app}/keyword-bindings-records'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<Object>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_records_of_keyword_binding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_save_intelligent_mappings(app, query, opts = {}) ⇒ BOOLEAN

设置索引智能匹配字段

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    字段列表

Returns:

  • (BOOLEAN) 


1156
1157
1158
1159
 
# File 'lib/indexea_client/api/queries_api.rb', line 1156

def query_save_intelligent_mappings(app, query, opts = {})
  data, _status_code, _headers = query_save_intelligent_mappings_with_http_info(app, query, opts)
  data
end

#query_save_intelligent_mappings_with_http_info(app, query, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

设置索引智能匹配字段

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    字段列表

Returns:

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

    BOOLEAN data, response status code and response headers



1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/indexea_client/api/queries_api.rb', line 1167

def query_save_intelligent_mappings_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_save_intelligent_mappings ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_save_intelligent_mappings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_save_intelligent_mappings"
  end
  # resource path
  local_var_path = '/queries/{app}/intelligent-mappings'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_save_intelligent_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_save_node_positions(body, query, app, opts = {}) ⇒ Object

保存查询条件的节点位置信息

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

  • (Object) 


1220
1221
1222
1223
 
# File 'lib/indexea_client/api/queries_api.rb', line 1220

def query_save_node_positions(body, query, app, opts = {})
  data, _status_code, _headers = query_save_node_positions_with_http_info(body, query, app, opts)
  data
end

#query_save_node_positions_with_http_info(body, query, app, opts = {}) ⇒ Array<(Object, Integer, Hash)>

保存查询条件的节点位置信息

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
 
# File 'lib/indexea_client/api/queries_api.rb', line 1231

def query_save_node_positions_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_save_node_positions ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_save_node_positions"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_save_node_positions"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_save_node_positions"
  end
  # resource path
  local_var_path = '/queries/{app}/node-positions'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_save_node_positions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_search(app, query, from, size, opts = {}) ⇒ Object

搜索测试 该接口主要用于定制查询的测试，必须授权才能访问

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • from —

    起始记录

  • size —

    每页记录数量

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    查询关键字

  • :params (Hash<String, String>) —

    聚合参数

Returns:

  • (Object) 


1293
1294
1295
1296
 
# File 'lib/indexea_client/api/queries_api.rb', line 1293

def query_search(app, query, from, size, opts = {})
  data, _status_code, _headers = query_search_with_http_info(app, query, from, size, opts)
  data
end

#query_search_with_http_info(app, query, from, size, opts = {}) ⇒ Array<(Object, Integer, Hash)>

搜索测试 该接口主要用于定制查询的测试，必须授权才能访问

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • from —

    起始记录

  • size —

    每页记录数量

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    查询关键字

  • :params (Hash<String, String>) —

    聚合参数

Returns:

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

    Object data, response status code and response headers



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'lib/indexea_client/api/queries_api.rb', line 1308

def query_search_with_http_info(app, query, from, size, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_search ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_search"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_search"
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling QueriesApi.query_search"
  end
  # verify the required parameter 'size' is set
  if @api_client.config.client_side_validation && size.nil?
    fail ArgumentError, "Missing the required parameter 'size' when calling QueriesApi.query_search"
  end
  # resource path
  local_var_path = '/queries/{app}/search'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'from'] = from
  query_params[:'size'] = size
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'params'] = @api_client.build_collection_param(opts[:'params'], :multi) if !opts[:'params'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_source(app, query, opts = {}) ⇒ Object

获取最终查询的源码(JSON)

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    搜索关键字

Returns:

  • (Object) 


1372
1373
1374
1375
 
# File 'lib/indexea_client/api/queries_api.rb', line 1372

def query_source(app, query, opts = {})
  data, _status_code, _headers = query_source_with_http_info(app, query, opts)
  data
end

#query_source_with_http_info(app, query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

获取最终查询的源码(JSON)

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    搜索关键字

Returns:

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

    Object data, response status code and response headers



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/indexea_client/api/queries_api.rb', line 1383

def query_source_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_source ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_source"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_source"
  end
  # resource path
  local_var_path = '/queries/{app}/{query}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'query' + '}', query.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_suggest(app, query, q, opts = {}) ⇒ Array<Object>

获取搜索建议列表

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • q —

    搜索关键字

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

    the optional parameters

Returns:

  • (Array<Object>) 


1435
1436
1437
1438
 
# File 'lib/indexea_client/api/queries_api.rb', line 1435

def query_suggest(app, query, q, opts = {})
  data, _status_code, _headers = query_suggest_with_http_info(app, query, q, opts)
  data
end

#query_suggest_with_http_info(app, query, q, opts = {}) ⇒ Array<(Array<Object>, Integer, Hash)>

获取搜索建议列表

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • q —

    搜索关键字

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

    the optional parameters

Returns:

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

    Array<Object> data, response status code and response headers



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/indexea_client/api/queries_api.rb', line 1446

def query_suggest_with_http_info(app, query, q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_suggest ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_suggest"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_suggest"
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling QueriesApi.query_suggest"
  end
  # resource path
  local_var_path = '/queries/{app}/suggest'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<Object>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_suggest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_test_intelligent_mappings(app, query, q, opts = {}) ⇒ Array<IntelligentMapping>

测试索引智能匹配字段

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • q —

    搜索内容

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    字段列表

Returns:



1504
1505
1506
1507
 
# File 'lib/indexea_client/api/queries_api.rb', line 1504

def query_test_intelligent_mappings(app, query, q, opts = {})
  data, _status_code, _headers = query_test_intelligent_mappings_with_http_info(app, query, q, opts)
  data
end

#query_test_intelligent_mappings_with_http_info(app, query, q, opts = {}) ⇒ Array<(Array<IntelligentMapping>, Integer, Hash)>

测试索引智能匹配字段

Parameters:

  • app —

    应用标识

  • query —

    查询编号

  • q —

    搜索内容

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    字段列表

Returns:

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

    Array<IntelligentMapping> data, response status code and response headers



1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/indexea_client/api/queries_api.rb', line 1516

def query_test_intelligent_mappings_with_http_info(app, query, q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_test_intelligent_mappings ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_test_intelligent_mappings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_test_intelligent_mappings"
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling QueriesApi.query_test_intelligent_mappings"
  end
  # resource path
  local_var_path = '/queries/{app}/intelligent-mappings'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'q'] = q
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<IntelligentMapping>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_test_intelligent_mappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_update(body, query, app, opts = {}) ⇒ QueryBean

修改查询

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:



1574
1575
1576
1577
 
# File 'lib/indexea_client/api/queries_api.rb', line 1574

def query_update(body, query, app, opts = {})
  data, _status_code, _headers = query_update_with_http_info(body, query, app, opts)
  data
end

#query_update_keyword_bindings(body, query, app, opts = {}) ⇒ KeywordBindingBean

修改关键词文档绑定

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:



1643
1644
1645
1646
 
# File 'lib/indexea_client/api/queries_api.rb', line 1643

def query_update_keyword_bindings(body, query, app, opts = {})
  data, _status_code, _headers = query_update_keyword_bindings_with_http_info(body, query, app, opts)
  data
end

#query_update_keyword_bindings_with_http_info(body, query, app, opts = {}) ⇒ Array<(KeywordBindingBean, Integer, Hash)>

修改关键词文档绑定

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    KeywordBindingBean data, response status code and response headers



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'lib/indexea_client/api/queries_api.rb', line 1654

def query_update_keyword_bindings_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_update_keyword_bindings ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_update_keyword_bindings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_update_keyword_bindings"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_update_keyword_bindings"
  end
  # resource path
  local_var_path = '/queries/{app}/keyword-bindings'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'KeywordBindingBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_update_keyword_bindings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_update_settings(app, query, name, value, type, opts = {}) ⇒ BOOLEAN

更改查询的设置项

Parameters:

  • app —

    应用标识

  • query —

    记录编号

  • name —

    设置项名称

  • value —

    设置值

  • type —

    设置项类型

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

    the optional parameters

Returns:

  • (BOOLEAN) 


1714
1715
1716
1717
 
# File 'lib/indexea_client/api/queries_api.rb', line 1714

def query_update_settings(app, query, name, value, type, opts = {})
  data, _status_code, _headers = query_update_settings_with_http_info(app, query, name, value, type, opts)
  data
end

#query_update_settings_with_http_info(app, query, name, value, type, opts = {}) ⇒ Array<(BOOLEAN, Integer, Hash)>

更改查询的设置项

Parameters:

  • app —

    应用标识

  • query —

    记录编号

  • name —

    设置项名称

  • value —

    设置值

  • type —

    设置项类型

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

    the optional parameters

Returns:

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

    BOOLEAN data, response status code and response headers



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/indexea_client/api/queries_api.rb', line 1727

def query_update_settings_with_http_info(app, query, name, value, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_update_settings ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_update_settings"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_update_settings"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling QueriesApi.query_update_settings"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling QueriesApi.query_update_settings"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling QueriesApi.query_update_settings"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['number', 'bool', 'string'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of number, bool, string"
  end
  # resource path
  local_var_path = '/queries/{app}/settings'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'query' + '}', query.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name
  query_params[:'value'] = value
  query_params[:'type'] = type

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'BOOLEAN' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_update_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_update_variable(body, id, app, opts = {}) ⇒ QueryVariableBean

修改预定义查询变量

Parameters:

  • body
  • id —

    自定义查询变量编号

  • app —

    应用标识

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

    the optional parameters

Returns:



1797
1798
1799
1800
 
# File 'lib/indexea_client/api/queries_api.rb', line 1797

def query_update_variable(body, id, app, opts = {})
  data, _status_code, _headers = query_update_variable_with_http_info(body, id, app, opts)
  data
end

#query_update_variable_with_http_info(body, id, app, opts = {}) ⇒ Array<(QueryVariableBean, Integer, Hash)>

修改预定义查询变量

Parameters:

  • body
  • id —

    自定义查询变量编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    QueryVariableBean data, response status code and response headers



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/indexea_client/api/queries_api.rb', line 1808

def query_update_variable_with_http_info(body, id, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_update_variable ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_update_variable"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling QueriesApi.query_update_variable"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_update_variable"
  end
  # resource path
  local_var_path = '/queries/{app}/variables'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'QueryVariableBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_update_variable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_update_with_http_info(body, query, app, opts = {}) ⇒ Array<(QueryBean, Integer, Hash)>

修改查询

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    QueryBean data, response status code and response headers



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/indexea_client/api/queries_api.rb', line 1585

def query_update_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_update"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_update"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_update"
  end
  # resource path
  local_var_path = '/queries/{app}'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'QueryBean' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_validate(app, query, opts = {}) ⇒ Object

获取搜索验证结果

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

  • (Object) 


1865
1866
1867
1868
 
# File 'lib/indexea_client/api/queries_api.rb', line 1865

def query_validate(app, query, opts = {})
  data, _status_code, _headers = query_validate_with_http_info(app, query, opts)
  data
end

#query_validate_aggregation(body, query, app, opts = {}) ⇒ Object

验证聚合定义是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

  • (Object) 


1927
1928
1929
1930
 
# File 'lib/indexea_client/api/queries_api.rb', line 1927

def query_validate_aggregation(body, query, app, opts = {})
  data, _status_code, _headers = query_validate_aggregation_with_http_info(body, query, app, opts)
  data
end

#query_validate_aggregation_with_http_info(body, query, app, opts = {}) ⇒ Array<(Object, Integer, Hash)>

验证聚合定义是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
 
# File 'lib/indexea_client/api/queries_api.rb', line 1938

def query_validate_aggregation_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_validate_aggregation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_validate_aggregation"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_validate_aggregation"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_validate_aggregation"
  end
  # resource path
  local_var_path = '/queries/{app}/validate-aggregation'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_validate_aggregation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_validate_query(body, query, app, opts = {}) ⇒ Object

验证聚合定义是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

  • (Object) 


1996
1997
1998
1999
 
# File 'lib/indexea_client/api/queries_api.rb', line 1996

def query_validate_query(body, query, app, opts = {})
  data, _status_code, _headers = query_validate_query_with_http_info(body, query, app, opts)
  data
end

#query_validate_query_with_http_info(body, query, app, opts = {}) ⇒ Array<(Object, Integer, Hash)>

验证聚合定义是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'lib/indexea_client/api/queries_api.rb', line 2007

def query_validate_query_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_validate_query ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_validate_query"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_validate_query"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_validate_query"
  end
  # resource path
  local_var_path = '/queries/{app}/validate-query'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_validate_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_validate_script_field(body, app, opts = {}) ⇒ Object

验证脚本字段是否正确

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :query (Integer) —

    查询编号, query 和 index 两个参数传一个即可

  • :index (Integer) —

    索引编号, query 和 index 两个参数传一个即可

Returns:

  • (Object) 


2066
2067
2068
2069
 
# File 'lib/indexea_client/api/queries_api.rb', line 2066

def query_validate_script_field(body, app, opts = {})
  data, _status_code, _headers = query_validate_script_field_with_http_info(body, app, opts)
  data
end

#query_validate_script_field_with_http_info(body, app, opts = {}) ⇒ Array<(Object, Integer, Hash)>

验证脚本字段是否正确

Parameters:

  • body
  • app —

    应用标识

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

    the optional parameters

Options Hash (opts):

  • :query (Integer) —

    查询编号, query 和 index 两个参数传一个即可

  • :index (Integer) —

    索引编号, query 和 index 两个参数传一个即可

Returns:

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

    Object data, response status code and response headers



2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
 
# File 'lib/indexea_client/api/queries_api.rb', line 2078

def query_validate_script_field_with_http_info(body, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_validate_script_field ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_validate_script_field"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_validate_script_field"
  end
  # resource path
  local_var_path = '/queries/{app}/validate-script-field'.sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_validate_script_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_validate_script_score(body, query, app, opts = {}) ⇒ Object

验证脚本字段是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

  • (Object) 


2133
2134
2135
2136
 
# File 'lib/indexea_client/api/queries_api.rb', line 2133

def query_validate_script_score(body, query, app, opts = {})
  data, _status_code, _headers = query_validate_script_score_with_http_info(body, query, app, opts)
  data
end

#query_validate_script_score_with_http_info(body, query, app, opts = {}) ⇒ Array<(Object, Integer, Hash)>

验证脚本字段是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
 
# File 'lib/indexea_client/api/queries_api.rb', line 2144

def query_validate_script_score_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_validate_script_score ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_validate_script_score"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_validate_script_score"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_validate_script_score"
  end
  # resource path
  local_var_path = '/queries/{app}/validate-script-score'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_validate_script_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_validate_suggestion(body, query, app, opts = {}) ⇒ Object

验证建议是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

  • (Object) 


2202
2203
2204
2205
 
# File 'lib/indexea_client/api/queries_api.rb', line 2202

def query_validate_suggestion(body, query, app, opts = {})
  data, _status_code, _headers = query_validate_suggestion_with_http_info(body, query, app, opts)
  data
end

#query_validate_suggestion_with_http_info(body, query, app, opts = {}) ⇒ Array<(Object, Integer, Hash)>

验证建议是否正确

Parameters:

  • body
  • query —

    查询编号

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
 
# File 'lib/indexea_client/api/queries_api.rb', line 2213

def query_validate_suggestion_with_http_info(body, query, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_validate_suggestion ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling QueriesApi.query_validate_suggestion"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_validate_suggestion"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_validate_suggestion"
  end
  # resource path
  local_var_path = '/queries/{app}/validate-suggest'.sub('{' + 'app' + '}', app.to_s)

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

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_validate_suggestion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_validate_with_http_info(app, query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

获取搜索验证结果

Parameters:

  • app —

    应用标识

  • query —

    查询编号

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
 
# File 'lib/indexea_client/api/queries_api.rb', line 1875

def query_validate_with_http_info(app, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_validate ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_validate"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling QueriesApi.query_validate"
  end
  # resource path
  local_var_path = '/queries/{app}/validate'.sub('{' + 'app' + '}', app.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_validate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#query_variables(app, opts = {}) ⇒ Array<QueryVariableBean>

获取应用的预定义查询变量列表

Parameters:

  • app —

    应用标识

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

    the optional parameters

Returns:



2269
2270
2271
2272
 
# File 'lib/indexea_client/api/queries_api.rb', line 2269

def query_variables(app, opts = {})
  data, _status_code, _headers = query_variables_with_http_info(app, opts)
  data
end

#query_variables_with_http_info(app, opts = {}) ⇒ Array<(Array<QueryVariableBean>, Integer, Hash)>

获取应用的预定义查询变量列表

Parameters:

  • app —

    应用标识

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

    the optional parameters

Returns:

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

    Array<QueryVariableBean> data, response status code and response headers



2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
 
# File 'lib/indexea_client/api/queries_api.rb', line 2278

def query_variables_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QueriesApi.query_variables ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling QueriesApi.query_variables"
  end
  # resource path
  local_var_path = '/queries/{app}/variables'.sub('{' + 'app' + '}', app.to_s)

  # 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'])

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

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Array<QueryVariableBean>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QueriesApi#query_variables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end