Class: OCI::AiDocument::AIServiceDocumentClient
- Inherits:
-
Object
- Object
- OCI::AiDocument::AIServiceDocumentClient
- Defined in:
- lib/oci/ai_document/ai_service_document_client.rb
Overview
Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#analyze_document(analyze_document_details, opts = {}) ⇒ Response
Perform different types of document analysis.
-
#cancel_processor_job(processor_job_id, opts = {}) ⇒ Response
Cancel a processor job.
-
#cancel_work_request(work_request_id, opts = {}) ⇒ Response
Cancel the work request with the given ID.
-
#change_model_compartment(model_id, change_model_compartment_details, opts = {}) ⇒ Response
Moves a model from one compartment to another.
-
#change_project_compartment(project_id, change_project_compartment_details, opts = {}) ⇒ Response
Move a project from one compartment to another.
-
#create_model(create_model_details, opts = {}) ⇒ Response
Create a new model.
-
#create_processor_job(create_processor_job_details, opts = {}) ⇒ Response
Create a processor job for document analysis.
-
#create_project(create_project_details, opts = {}) ⇒ Response
Create a new project.
-
#delete_model(model_id, opts = {}) ⇒ Response
Delete a model by identifier.
-
#delete_project(project_id, opts = {}) ⇒ Response
Delete a project by identifier.
-
#get_model(model_id, opts = {}) ⇒ Response
Get a model by identifier.
-
#get_processor_job(processor_job_id, opts = {}) ⇒ Response
Get the details of a processor job.
-
#get_project(project_id, opts = {}) ⇒ Response
Get a project by identifier.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Gets the status of the work request with the given ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AIServiceDocumentClient
constructor
Creates a new AIServiceDocumentClient.
-
#list_models(opts = {}) ⇒ Response
Returns a list of models in a compartment.
-
#list_projects(opts = {}) ⇒ Response
Returns a list of projects.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Returns a (paginated) list of errors for a given work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Return a (paginated) list of logs for a given work request.
-
#list_work_requests(opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#patch_model(model_id, patch_model_details, opts = {}) ⇒ Response
Updates the model metadata only selected path parameter.
-
#update_model(model_id, update_model_details, opts = {}) ⇒ Response
Updates the model metadata.
-
#update_project(project_id, update_project_details, opts = {}) ⇒ Response
Update the project metadata.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AIServiceDocumentClient
Creates a new AIServiceDocumentClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 55 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20221109' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "AIServiceDocumentClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 29 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
25 26 27 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#analyze_document(analyze_document_details, opts = {}) ⇒ Response
Click here to see an example of how to use analyze_document API.
Perform different types of document analysis.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 118 def analyze_document(analyze_document_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#analyze_document.' if logger raise "Missing the required parameter 'analyze_document_details' when calling analyze_document." if analyze_document_details.nil? path = '/actions/analyzeDocument' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(analyze_document_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#analyze_document') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::AnalyzeDocumentResult' ) end # rubocop:enable Metrics/BlockLength end |
#cancel_processor_job(processor_job_id, opts = {}) ⇒ Response
Click here to see an example of how to use cancel_processor_job API.
Cancel a processor job.
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 213 214 215 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 179 def cancel_processor_job(processor_job_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#cancel_processor_job.' if logger raise "Missing the required parameter 'processor_job_id' when calling cancel_processor_job." if processor_job_id.nil? raise "Parameter value for 'processor_job_id' must not be blank" if OCI::Internal::Util.blank_string?(processor_job_id) path = '/processorJobs/{processorJobId}/actions/cancel'.sub('{processorJobId}', processor_job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#cancel_processor_job') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#cancel_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use cancel_work_request API.
Cancel the work request with the given ID.
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 275 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 239 def cancel_work_request(work_request_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#cancel_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling cancel_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#cancel_work_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_model_compartment(model_id, change_model_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_model_compartment API.
Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 300 def change_model_compartment(model_id, change_model_compartment_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#change_model_compartment.' if logger raise "Missing the required parameter 'model_id' when calling change_model_compartment." if model_id.nil? raise "Missing the required parameter 'change_model_compartment_details' when calling change_model_compartment." if change_model_compartment_details.nil? raise "Parameter value for 'model_id' must not be blank" if OCI::Internal::Util.blank_string?(model_id) path = '/models/{modelId}/actions/changeCompartment'.sub('{modelId}', model_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_model_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#change_model_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_project_compartment(project_id, change_project_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_project_compartment API.
Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 362 def change_project_compartment(project_id, change_project_compartment_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#change_project_compartment.' if logger raise "Missing the required parameter 'project_id' when calling change_project_compartment." if project_id.nil? raise "Missing the required parameter 'change_project_compartment_details' when calling change_project_compartment." if change_project_compartment_details.nil? raise "Parameter value for 'project_id' must not be blank" if OCI::Internal::Util.blank_string?(project_id) path = '/projects/{projectId}/actions/changeCompartment'.sub('{projectId}', project_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_project_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#change_project_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_model(create_model_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_model API.
Create a new model.
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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 424 def create_model(create_model_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#create_model.' if logger raise "Missing the required parameter 'create_model_details' when calling create_model." if create_model_details.nil? path = '/models' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_model_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#create_model') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::Model' ) end # rubocop:enable Metrics/BlockLength end |
#create_processor_job(create_processor_job_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_processor_job API.
Create a processor job for document analysis.
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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 486 def create_processor_job(create_processor_job_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#create_processor_job.' if logger raise "Missing the required parameter 'create_processor_job_details' when calling create_processor_job." if create_processor_job_details.nil? path = '/processorJobs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_processor_job_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#create_processor_job') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::ProcessorJob' ) end # rubocop:enable Metrics/BlockLength end |
#create_project(create_project_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_project API.
Create a new project.
548 549 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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 548 def create_project(create_project_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#create_project.' if logger raise "Missing the required parameter 'create_project_details' when calling create_project." if create_project_details.nil? path = '/projects' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_project_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#create_project') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::Project' ) end # rubocop:enable Metrics/BlockLength end |
#delete_model(model_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_model API.
Delete a model by identifier.
609 610 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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 609 def delete_model(model_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#delete_model.' if logger raise "Missing the required parameter 'model_id' when calling delete_model." if model_id.nil? raise "Parameter value for 'model_id' must not be blank" if OCI::Internal::Util.blank_string?(model_id) path = '/models/{modelId}'.sub('{modelId}', model_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#delete_model') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_project(project_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_project API.
Delete a project by identifier.
669 670 671 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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 669 def delete_project(project_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#delete_project.' if logger raise "Missing the required parameter 'project_id' when calling delete_project." if project_id.nil? raise "Parameter value for 'project_id' must not be blank" if OCI::Internal::Util.blank_string?(project_id) path = '/projects/{projectId}'.sub('{projectId}', project_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#delete_project') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_model(model_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_model API.
Get a model by identifier.
723 724 725 726 727 728 729 730 731 732 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 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 723 def get_model(model_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#get_model.' if logger raise "Missing the required parameter 'model_id' when calling get_model." if model_id.nil? raise "Parameter value for 'model_id' must not be blank" if OCI::Internal::Util.blank_string?(model_id) path = '/models/{modelId}'.sub('{modelId}', model_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#get_model') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::Model' ) end # rubocop:enable Metrics/BlockLength end |
#get_processor_job(processor_job_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_processor_job API.
Get the details of a processor job.
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 778 def get_processor_job(processor_job_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#get_processor_job.' if logger raise "Missing the required parameter 'processor_job_id' when calling get_processor_job." if processor_job_id.nil? raise "Parameter value for 'processor_job_id' must not be blank" if OCI::Internal::Util.blank_string?(processor_job_id) path = '/processorJobs/{processorJobId}'.sub('{processorJobId}', processor_job_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#get_processor_job') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::ProcessorJob' ) end # rubocop:enable Metrics/BlockLength end |
#get_project(project_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_project API.
Get a project by identifier.
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 832 def get_project(project_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#get_project.' if logger raise "Missing the required parameter 'project_id' when calling get_project." if project_id.nil? raise "Parameter value for 'project_id' must not be blank" if OCI::Internal::Util.blank_string?(project_id) path = '/projects/{projectId}'.sub('{projectId}', project_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#get_project') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::Project' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Gets the status of the work request with the given ID.
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 886 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#get_work_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_models(opts = {}) ⇒ Response
Click here to see an example of how to use list_models API.
Returns a list of models in a compartment.
Allowed values are: timeCreated, displayName
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 951 def list_models(opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#list_models.' if logger if opts[:lifecycle_state] && !OCI::AiDocument::Models::Model::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::AiDocument::Models::Model::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::AiDocument::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::AiDocument::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/models' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:projectId] = opts[:project_id] if opts[:project_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:id] = opts[:id] if opts[:id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#list_models') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::ModelCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_projects(opts = {}) ⇒ Response
Click here to see an example of how to use list_projects API.
Returns a list of projects.
Allowed values are: timeCreated, displayName
1034 1035 1036 1037 1038 1039 1040 1041 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/oci/ai_document/ai_service_document_client.rb', line 1034 def list_projects(opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#list_projects.' if logger if opts[:lifecycle_state] && !OCI::AiDocument::Models::Project::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::AiDocument::Models::Project::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::AiDocument::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::AiDocument::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/projects' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:id] = opts[:id] if opts[:id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#list_projects') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::ProjectCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Returns a (paginated) list of errors for a given work request.
Allowed values are: timeAccepted
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 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 1113 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end if opts[:sort_order] && !OCI::AiDocument::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::AiDocument::Models::SORT_ORDER_ENUM.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#list_work_request_errors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::WorkRequestErrorCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Return a (paginated) list of logs for a given work request.
Allowed values are: timeAccepted
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 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 1186 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end if opts[:sort_order] && !OCI::AiDocument::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::AiDocument::Models::SORT_ORDER_ENUM.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#list_work_request_logs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::WorkRequestLogEntryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists the work requests in a compartment.
Allowed values are: timeAccepted
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 1262 def list_work_requests(opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#list_work_requests.' if logger if opts[:status] && !OCI::AiDocument::Models::OPERATION_STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::AiDocument::Models::OPERATION_STATUS_ENUM.' end if opts[:sort_order] && !OCI::AiDocument::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::AiDocument::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeAccepted.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id] query_params[:status] = opts[:status] if opts[:status] query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#list_work_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::WorkRequestSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 94 def logger @api_client.config.logger end |
#patch_model(model_id, patch_model_details, opts = {}) ⇒ Response
Click here to see an example of how to use patch_model API.
Updates the model metadata only selected path parameter.
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 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 1341 def patch_model(model_id, patch_model_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#patch_model.' if logger raise "Missing the required parameter 'model_id' when calling patch_model." if model_id.nil? raise "Missing the required parameter 'patch_model_details' when calling patch_model." if patch_model_details.nil? raise "Parameter value for 'model_id' must not be blank" if OCI::Internal::Util.blank_string?(model_id) path = '/models/{modelId}'.sub('{modelId}', model_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(patch_model_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#patch_model') do @api_client.call_api( :PATCH, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::AiDocument::Models::PatchResponseMessage' ) end # rubocop:enable Metrics/BlockLength end |
#update_model(model_id, update_model_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_model API.
Updates the model metadata.
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 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 1404 def update_model(model_id, update_model_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#update_model.' if logger raise "Missing the required parameter 'model_id' when calling update_model." if model_id.nil? raise "Missing the required parameter 'update_model_details' when calling update_model." if update_model_details.nil? raise "Parameter value for 'model_id' must not be blank" if OCI::Internal::Util.blank_string?(model_id) path = '/models/{modelId}'.sub('{modelId}', model_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_model_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#update_model') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_project(project_id, update_project_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_project API.
Update the project metadata.
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 1497 1498 1499 1500 1501 1502 1503 |
# File 'lib/oci/ai_document/ai_service_document_client.rb', line 1466 def update_project(project_id, update_project_details, opts = {}) logger.debug 'Calling operation AIServiceDocumentClient#update_project.' if logger raise "Missing the required parameter 'project_id' when calling update_project." if project_id.nil? raise "Missing the required parameter 'update_project_details' when calling update_project." if update_project_details.nil? raise "Parameter value for 'project_id' must not be blank" if OCI::Internal::Util.blank_string?(project_id) path = '/projects/{projectId}'.sub('{projectId}', project_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_project_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'AIServiceDocumentClient#update_project') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |