Class: Falcon::KnowledgeBaseFiles
- Inherits:
-
Object
- Object
- Falcon::KnowledgeBaseFiles
- Defined in:
- lib/crimson-falcon/api/knowledge_base_files.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#entities_knowledge_base_files_create_v1(knowledge_base_id, file, opts = {}) ⇒ DomainReplyEntitiesKnowledgeBaseFilesResponse
Upload a file to a knowledge base.
-
#entities_knowledge_base_files_create_v1_with_http_info(knowledge_base_id, file, opts = {}) ⇒ Array<(DomainReplyEntitiesKnowledgeBaseFilesResponse, Integer, Hash)>
Upload a file to a knowledge base.
-
#entities_knowledge_base_files_delete_v1(knowledge_base_id, id, opts = {}) ⇒ MsaspecResponseFields
Delete document from knowledge base.
-
#entities_knowledge_base_files_delete_v1_with_http_info(knowledge_base_id, id, opts = {}) ⇒ Array<(MsaspecResponseFields, Integer, Hash)>
Delete document from knowledge base.
-
#entities_knowledge_base_files_download_v1(knowledge_base_id, id, opts = {}) ⇒ nil
Download knowledge base file entities for the provided id.
-
#entities_knowledge_base_files_download_v1_with_http_info(knowledge_base_id, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Download knowledge base file entities for the provided id.
-
#entities_knowledge_base_files_update_v1(id, file, opts = {}) ⇒ DomainReplyEntitiesKnowledgeBaseFilesResponse
Update an existing file in a knowledge base.
-
#entities_knowledge_base_files_update_v1_with_http_info(id, file, opts = {}) ⇒ Array<(DomainReplyEntitiesKnowledgeBaseFilesResponse, Integer, Hash)>
Update an existing file in a knowledge base.
-
#entities_knowledge_base_files_v1(knowledge_base_id, ids, opts = {}) ⇒ DomainReplyEntitiesKnowledgeBaseFilesResponse
Retrieve knowledge base file entities for the provided id.
-
#entities_knowledge_base_files_v1_with_http_info(knowledge_base_id, ids, opts = {}) ⇒ Array<(DomainReplyEntitiesKnowledgeBaseFilesResponse, Integer, Hash)>
Retrieve knowledge base file entities for the provided id.
-
#initialize(api_client = ApiClient.default) ⇒ KnowledgeBaseFiles
constructor
A new instance of KnowledgeBaseFiles.
-
#queries_knowledge_base_files_v1(knowledge_base_id, opts = {}) ⇒ DomainReplyQueryKnowledgeBaseFilesResponse
Query knowledge base files based on the provided filters.
-
#queries_knowledge_base_files_v1_with_http_info(knowledge_base_id, opts = {}) ⇒ Array<(DomainReplyQueryKnowledgeBaseFilesResponse, Integer, Hash)>
Query knowledge base files based on the provided filters.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ KnowledgeBaseFiles
Returns a new instance of KnowledgeBaseFiles.
35 36 37 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 35 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
33 34 35 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 33 def api_client @api_client end |
Instance Method Details
#entities_knowledge_base_files_create_v1(knowledge_base_id, file, opts = {}) ⇒ DomainReplyEntitiesKnowledgeBaseFilesResponse
Upload a file to a knowledge base.
44 45 46 47 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 44 def entities_knowledge_base_files_create_v1(knowledge_base_id, file, opts = {}) data, _status_code, _headers = entities_knowledge_base_files_create_v1_with_http_info(knowledge_base_id, file, opts) data end |
#entities_knowledge_base_files_create_v1_with_http_info(knowledge_base_id, file, opts = {}) ⇒ Array<(DomainReplyEntitiesKnowledgeBaseFilesResponse, Integer, Hash)>
Upload a file to a knowledge base.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 55 def entities_knowledge_base_files_create_v1_with_http_info(knowledge_base_id, file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: KnowledgeBaseFiles.entities_knowledge_base_files_create_v1 ...' end # verify the required parameter 'knowledge_base_id' is set if @api_client.config.client_side_validation && knowledge_base_id.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseFiles.entities_knowledge_base_files_create_v1" end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling KnowledgeBaseFiles.entities_knowledge_base_files_create_v1" end # resource path local_var_path = '/agentic-studio/entities/knowledge_base_files/v1' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['multipart/form-data']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['knowledge_base_id'] = knowledge_base_id form_params['file'] = file form_params['file_description'] = opts[:'file_description'] if !opts[:'file_description'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DomainReplyEntitiesKnowledgeBaseFilesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"KnowledgeBaseFiles.entities_knowledge_base_files_create_v1", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseFiles#entities_knowledge_base_files_create_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#entities_knowledge_base_files_delete_v1(knowledge_base_id, id, opts = {}) ⇒ MsaspecResponseFields
Delete document from knowledge base.
120 121 122 123 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 120 def entities_knowledge_base_files_delete_v1(knowledge_base_id, id, opts = {}) data, _status_code, _headers = entities_knowledge_base_files_delete_v1_with_http_info(knowledge_base_id, id, opts) data end |
#entities_knowledge_base_files_delete_v1_with_http_info(knowledge_base_id, id, opts = {}) ⇒ Array<(MsaspecResponseFields, Integer, Hash)>
Delete document from knowledge base.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 130 def entities_knowledge_base_files_delete_v1_with_http_info(knowledge_base_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: KnowledgeBaseFiles.entities_knowledge_base_files_delete_v1 ...' end # verify the required parameter 'knowledge_base_id' is set if @api_client.config.client_side_validation && knowledge_base_id.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseFiles.entities_knowledge_base_files_delete_v1" 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 KnowledgeBaseFiles.entities_knowledge_base_files_delete_v1" end # resource path local_var_path = '/agentic-studio/entities/knowledge_base_files/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'knowledge_base_id'] = knowledge_base_id 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'MsaspecResponseFields' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"KnowledgeBaseFiles.entities_knowledge_base_files_delete_v1", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseFiles#entities_knowledge_base_files_delete_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#entities_knowledge_base_files_download_v1(knowledge_base_id, id, opts = {}) ⇒ nil
Download knowledge base file entities for the provided id.
189 190 191 192 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 189 def entities_knowledge_base_files_download_v1(knowledge_base_id, id, opts = {}) entities_knowledge_base_files_download_v1_with_http_info(knowledge_base_id, id, opts) nil end |
#entities_knowledge_base_files_download_v1_with_http_info(knowledge_base_id, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Download knowledge base file entities for the provided id.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 199 def entities_knowledge_base_files_download_v1_with_http_info(knowledge_base_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: KnowledgeBaseFiles.entities_knowledge_base_files_download_v1 ...' end # verify the required parameter 'knowledge_base_id' is set if @api_client.config.client_side_validation && knowledge_base_id.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseFiles.entities_knowledge_base_files_download_v1" 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 KnowledgeBaseFiles.entities_knowledge_base_files_download_v1" end # resource path local_var_path = '/agentic-studio/entities/knowledge_base_files/download/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'knowledge_base_id'] = knowledge_base_id 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/octet-stream', 'application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"KnowledgeBaseFiles.entities_knowledge_base_files_download_v1", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseFiles#entities_knowledge_base_files_download_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#entities_knowledge_base_files_update_v1(id, file, opts = {}) ⇒ DomainReplyEntitiesKnowledgeBaseFilesResponse
Update an existing file in a knowledge base. Supports updating file content and optionally its description.
259 260 261 262 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 259 def entities_knowledge_base_files_update_v1(id, file, opts = {}) data, _status_code, _headers = entities_knowledge_base_files_update_v1_with_http_info(id, file, opts) data end |
#entities_knowledge_base_files_update_v1_with_http_info(id, file, opts = {}) ⇒ Array<(DomainReplyEntitiesKnowledgeBaseFilesResponse, Integer, Hash)>
Update an existing file in a knowledge base. Supports updating file content and optionally its description.
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 270 def entities_knowledge_base_files_update_v1_with_http_info(id, file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: KnowledgeBaseFiles.entities_knowledge_base_files_update_v1 ...' 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 KnowledgeBaseFiles.entities_knowledge_base_files_update_v1" end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling KnowledgeBaseFiles.entities_knowledge_base_files_update_v1" end # resource path local_var_path = '/agentic-studio/entities/knowledge_base_files/v1' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['multipart/form-data']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} form_params['id'] = id form_params['file'] = file form_params['file_description'] = opts[:'file_description'] if !opts[:'file_description'].nil? # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DomainReplyEntitiesKnowledgeBaseFilesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"KnowledgeBaseFiles.entities_knowledge_base_files_update_v1", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseFiles#entities_knowledge_base_files_update_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#entities_knowledge_base_files_v1(knowledge_base_id, ids, opts = {}) ⇒ DomainReplyEntitiesKnowledgeBaseFilesResponse
Retrieve knowledge base file entities for the provided id.
336 337 338 339 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 336 def entities_knowledge_base_files_v1(knowledge_base_id, ids, opts = {}) data, _status_code, _headers = entities_knowledge_base_files_v1_with_http_info(knowledge_base_id, ids, opts) data end |
#entities_knowledge_base_files_v1_with_http_info(knowledge_base_id, ids, opts = {}) ⇒ Array<(DomainReplyEntitiesKnowledgeBaseFilesResponse, Integer, Hash)>
Retrieve knowledge base file entities for the provided id.
347 348 349 350 351 352 353 354 355 356 357 358 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 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 347 def entities_knowledge_base_files_v1_with_http_info(knowledge_base_id, ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: KnowledgeBaseFiles.entities_knowledge_base_files_v1 ...' end # verify the required parameter 'knowledge_base_id' is set if @api_client.config.client_side_validation && knowledge_base_id.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseFiles.entities_knowledge_base_files_v1" end # verify the required parameter 'ids' is set if @api_client.config.client_side_validation && ids.nil? fail ArgumentError, "Missing the required parameter 'ids' when calling KnowledgeBaseFiles.entities_knowledge_base_files_v1" end # resource path local_var_path = '/agentic-studio/entities/knowledge_base_files/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'knowledge_base_id'] = knowledge_base_id query_params[:'ids'] = @api_client.build_collection_param(ids, :multi) query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DomainReplyEntitiesKnowledgeBaseFilesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"KnowledgeBaseFiles.entities_knowledge_base_files_v1", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseFiles#entities_knowledge_base_files_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#queries_knowledge_base_files_v1(knowledge_base_id, opts = {}) ⇒ DomainReplyQueryKnowledgeBaseFilesResponse
Query knowledge base files based on the provided filters.
410 411 412 413 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 410 def queries_knowledge_base_files_v1(knowledge_base_id, opts = {}) data, _status_code, _headers = queries_knowledge_base_files_v1_with_http_info(knowledge_base_id, opts) data end |
#queries_knowledge_base_files_v1_with_http_info(knowledge_base_id, opts = {}) ⇒ Array<(DomainReplyQueryKnowledgeBaseFilesResponse, Integer, Hash)>
Query knowledge base files based on the provided filters.
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 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'lib/crimson-falcon/api/knowledge_base_files.rb', line 423 def queries_knowledge_base_files_v1_with_http_info(knowledge_base_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: KnowledgeBaseFiles.queries_knowledge_base_files_v1 ...' end # verify the required parameter 'knowledge_base_id' is set if @api_client.config.client_side_validation && knowledge_base_id.nil? fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseFiles.queries_knowledge_base_files_v1" end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KnowledgeBaseFiles.queries_knowledge_base_files_v1, must be smaller than or equal to 500.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KnowledgeBaseFiles.queries_knowledge_base_files_v1, must be greater than or equal to 1.' end # resource path local_var_path = '/agentic-studio/queries/knowledge_base_files/v1' # query parameters query_params = opts[:query_params] || {} query_params[:'knowledge_base_id'] = knowledge_base_id query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DomainReplyQueryKnowledgeBaseFilesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"KnowledgeBaseFiles.queries_knowledge_base_files_v1", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: KnowledgeBaseFiles#queries_knowledge_base_files_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |