oci 2.17.0 → 2.18.0

data/lib/oci/ai_vision/ai_service_vision_client.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # A description of the VisionService API.
+  # Using Vision, you can upload images to detect and classify objects in them. If you have lots of images, you can process them in batch using asynchronous API endpoints. Vision's features are thematically split between Document AI for document-centric images, and Image Analysis for object and scene-based images. Pretrained models and custom models are supported.
   class AiVision::AIServiceVisionClient
     # Client used to make HTTP requests.
     # @return [OCI::ApiClient]
@@ -100,7 +100,7 @@ module OCI
 
     # Perform different types of image analysis.
     #
-    # @param [OCI::AiVision::Models::AnalyzeDocumentDetails] analyze_document_details Details about how to analyze a document.
+    # @param [OCI::AiVision::Models::AnalyzeDocumentDetails] analyze_document_details The details of how to analyze a document.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -206,7 +206,7 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Cancel a batch document job.
+    # Cancel a document batch job.
     #
     # @param [String] document_job_id Document job id.
     # @param [Hash] opts the optional parameters
@@ -267,7 +267,7 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Cancel a batch image job.
+    # Cancel an image batch job.
     #
     # @param [String] image_job_id Image job id.
     # @param [Hash] opts the optional parameters
@@ -328,7 +328,7 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Cancel work request with the given ID.
+    # Cancel the work request with the given ID.
     # @param [String] work_request_id The ID of the asynchronous request.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
@@ -388,9 +388,9 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Moves a model from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
-    # @param [String] model_id unique model identifier.
-    # @param [OCI::AiVision::Models::ChangeModelCompartmentDetails] change_model_compartment_details The deatils of the move.
+    # Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
+    # @param [String] model_id A unique model identifier.
+    # @param [OCI::AiVision::Models::ChangeModelCompartmentDetails] change_model_compartment_details The details of the move.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -450,8 +450,8 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Moves a project from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
-    # @param [String] project_id unique project identifier.
+    # Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
+    # @param [String] project_id A unique project identifier.
     # @param [OCI::AiVision::Models::ChangeProjectCompartmentDetails] change_project_compartment_details The deatils of the move.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
@@ -512,14 +512,14 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Create a batch document analysis job
+    # Create a document analysis batch job.
     #
-    # @param [OCI::AiVision::Models::CreateDocumentJobDetails] create_document_job_details Details about the batch document analysis.
+    # @param [OCI::AiVision::Models::CreateDocumentJobDetails] create_document_job_details The details of the batch document analysis.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
-    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   server error without the risk of executing that same action again. Retry tokens expire after 24
     #   hours, but can be invalidated before then due to conflicting operations. For example, if a resource
     #   has been deleted and purged from the system, then a retry of the original creation request
     #   might be rejected.
@@ -574,14 +574,14 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Create a batch image analysis job.
+    # Create an image analysis batch job.
     #
-    # @param [OCI::AiVision::Models::CreateImageJobDetails] create_image_job_details Details about the batch image analysis.
+    # @param [OCI::AiVision::Models::CreateImageJobDetails] create_image_job_details The details of the batch image analysis.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
-    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   server error without the risk of executing that same action again. Retry tokens expire after 24
     #   hours, but can be invalidated before then due to conflicting operations. For example, if a resource
     #   has been deleted and purged from the system, then a retry of the original creation request
     #   might be rejected.
@@ -636,14 +636,14 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Creates a new model.
+    # Create a new model.
     #
-    # @param [OCI::AiVision::Models::CreateModelDetails] create_model_details Metadata about the new model.
+    # @param [OCI::AiVision::Models::CreateModelDetails] create_model_details The metadata about the new model.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
-    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   server error without the risk of executing that same action again. Retry tokens expire after 24
     #   hours, but can be invalidated before then due to conflicting operations. For example, if a resource
     #   has been deleted and purged from the system, then a retry of the original creation request
     #   might be rejected.
@@ -698,14 +698,14 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Creates a new project.
+    # Create a new project.
     #
-    # @param [OCI::AiVision::Models::CreateProjectDetails] create_project_details Details for the new Project.
+    # @param [OCI::AiVision::Models::CreateProjectDetails] create_project_details The new Project's details.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
-    #   server error without risk of executing that same action again. Retry tokens expire after 24
+    #   server error without the risk of executing that same action again. Retry tokens expire after 24
     #   hours, but can be invalidated before then due to conflicting operations. For example, if a resource
     #   has been deleted and purged from the system, then a retry of the original creation request
     #   might be rejected.
@@ -760,8 +760,8 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Deletes a model by identifier.
-    # @param [String] model_id unique model identifier.
+    # Delete a model by identifier.
+    # @param [String] model_id A unique model identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -820,8 +820,8 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Deletes a project by identifier.
-    # @param [String] project_id unique project identifier.
+    # Delete a project by identifier.
+    # @param [String] project_id A unique project identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -880,7 +880,7 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Get details of a batch document job.
+    # Get details of a document batch job.
     #
     # @param [String] document_job_id Document job id.
     # @param [Hash] opts the optional parameters
@@ -935,7 +935,7 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Get details of a batch image job.
+    # Get details of an image batch job.
     #
     # @param [String] image_job_id Image job id.
     # @param [Hash] opts the optional parameters
@@ -990,8 +990,8 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Gets a model by identifier.
-    # @param [String] model_id unique model identifier.
+    # Get a model by identifier.
+    # @param [String] model_id A unique model identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -1044,8 +1044,8 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Gets a project by identifier.
-    # @param [String] project_id unique project identifier.
+    # Get a project by identifier.
+    # @param [String] project_id A unique project identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -1159,13 +1159,13 @@ module OCI
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :compartment_id The ID of the compartment in which to list resources.
     # @option opts [String] :project_id The ID of the project for which to list the objects.
-    # @option opts [String] :lifecycle_state Filter to match models with the given lifecycleState.
+    # @option opts [String] :lifecycle_state The filter to match models with the given lifecycleState.
     # @option opts [String] :display_name A filter to return only resources that match the entire display name given.
-    # @option opts [String] :id Filter to find the model with the given identifier.
+    # @option opts [String] :id The filter to find the model with the given identifier.
     # @option opts [Integer] :limit The maximum number of items to return. (default to 10)
     # @option opts [String] :page The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
     # @option opts [String] :sort_order The sort order to use, either 'ASC' or 'DESC'.
-    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
+    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending.
     #    (default to timeCreated)
     #   Allowed values are: timeCreated, displayName
     # @option opts [String] :opc_request_id The client request ID for tracing.
@@ -1242,13 +1242,13 @@ module OCI
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :compartment_id The ID of the compartment in which to list resources.
-    # @option opts [String] :lifecycle_state Filter to match projects with the given lifecycleState.
+    # @option opts [String] :lifecycle_state The filter to match projects with the given lifecycleState.
     # @option opts [String] :display_name A filter to return only resources that match the entire display name given.
-    # @option opts [String] :id Filter to find the project with the given identifier.
+    # @option opts [String] :id The filter to find the project with the given identifier.
     # @option opts [Integer] :limit The maximum number of items to return. (default to 10)
     # @option opts [String] :page The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
     # @option opts [String] :sort_order The sort order to use, either 'ASC' or 'DESC'.
-    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
+    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending.
     #    (default to timeCreated)
     #   Allowed values are: timeCreated, displayName
     # @option opts [String] :opc_request_id The client request ID for tracing.
@@ -1318,7 +1318,7 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Return a (paginated) list of errors for a given work request.
+    # Returns a (paginated) list of errors for a given work request.
     #
     # @param [String] work_request_id The ID of the asynchronous request.
     # @param [Hash] opts the optional parameters
@@ -1327,7 +1327,7 @@ module OCI
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @option opts [String] :page The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
     # @option opts [Integer] :limit The maximum number of items to return. (default to 10)
-    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
+    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.
     #    (default to timeAccepted)
     #   Allowed values are: timeAccepted
     # @option opts [String] :sort_order The sort order to use, either 'ASC' or 'DESC'.
@@ -1400,7 +1400,7 @@ module OCI
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @option opts [String] :page The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
     # @option opts [Integer] :limit The maximum number of items to return. (default to 10)
-    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
+    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.
     #    (default to timeAccepted)
     #   Allowed values are: timeAccepted
     # @option opts [String] :sort_order The sort order to use, either 'ASC' or 'DESC'.
@@ -1471,13 +1471,13 @@ module OCI
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
     # @option opts [String] :compartment_id The ID of the compartment in which to list resources.
     # @option opts [String] :work_request_id The ID of the asynchronous work request.
-    # @option opts [String] :status A filter to return only resources their lifecycleState matches the given OperationStatus.
+    # @option opts [String] :status A filter to return only resources whose lifecycleState matches the given OperationStatus.
     # @option opts [String] :resource_id The ID of the resource affected by the work request.
     # @option opts [String] :opc_request_id The client request ID for tracing.
     # @option opts [String] :page The position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
     # @option opts [Integer] :limit The maximum number of items to return. (default to 10)
     # @option opts [String] :sort_order The sort order to use, either 'ASC' or 'DESC'.
-    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.
+    # @option opts [String] :sort_by The field to sort by. Only one sort order may be provided. The default order for timeAccepted is descending.
     #    (default to timeAccepted)
     #   Allowed values are: timeAccepted
     # @return [Response] A Response object with data of type {OCI::AiVision::Models::WorkRequestSummaryCollection WorkRequestSummaryCollection}
@@ -1546,9 +1546,9 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Updates model metadata.
-    # @param [String] model_id unique model identifier.
-    # @param [OCI::AiVision::Models::UpdateModelDetails] update_model_details Model metadata to be updated.
+    # Updates the model metadata.
+    # @param [String] model_id A unique model identifier.
+    # @param [OCI::AiVision::Models::UpdateModelDetails] update_model_details The model metadata to be updated.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@@ -1608,9 +1608,9 @@ module OCI
     # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
 
 
-    # Updates project metadata.
-    # @param [String] project_id unique project identifier.
-    # @param [OCI::AiVision::Models::UpdateProjectDetails] update_project_details Project metadata to be updated.
+    # Update the project metadata.
+    # @param [String] project_id A unique project identifier.
+    # @param [OCI::AiVision::Models::UpdateProjectDetails] update_project_details The project metadata to be updated.
     # @param [Hash] opts the optional parameters
     # @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
     #   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

data/lib/oci/ai_vision/ai_service_vision_client_composite_operations.rb

@@ -28,7 +28,7 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#create_document_job} and then waits for the {OCI::AiVision::Models::DocumentJob} acted upon
     # to enter the given state(s).
     #
-    # @param [OCI::AiVision::Models::CreateDocumentJobDetails] create_document_job_details Details about the batch document analysis.
+    # @param [OCI::AiVision::Models::CreateDocumentJobDetails] create_document_job_details The details of the batch document analysis.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::DocumentJob#lifecycle_state}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#create_document_job}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -67,7 +67,7 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#create_image_job} and then waits for the {OCI::AiVision::Models::ImageJob} acted upon
     # to enter the given state(s).
     #
-    # @param [OCI::AiVision::Models::CreateImageJobDetails] create_image_job_details Details about the batch image analysis.
+    # @param [OCI::AiVision::Models::CreateImageJobDetails] create_image_job_details The details of the batch image analysis.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::ImageJob#lifecycle_state}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#create_image_job}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -106,7 +106,7 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#create_model} and then waits for the {OCI::AiVision::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [OCI::AiVision::Models::CreateModelDetails] create_model_details Metadata about the new model.
+    # @param [OCI::AiVision::Models::CreateModelDetails] create_model_details The metadata about the new model.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#create_model}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -155,7 +155,7 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#create_project} and then waits for the {OCI::AiVision::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [OCI::AiVision::Models::CreateProjectDetails] create_project_details Details for the new Project.
+    # @param [OCI::AiVision::Models::CreateProjectDetails] create_project_details The new Project's details.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#create_project}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -204,7 +204,7 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#delete_model} and then waits for the {OCI::AiVision::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] model_id unique model identifier.
+    # @param [String] model_id A unique model identifier.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#delete_model}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -253,7 +253,7 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#delete_project} and then waits for the {OCI::AiVision::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] project_id unique project identifier.
+    # @param [String] project_id A unique project identifier.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#delete_project}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -302,8 +302,8 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#update_model} and then waits for the {OCI::AiVision::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] model_id unique model identifier.
-    # @param [OCI::AiVision::Models::UpdateModelDetails] update_model_details Model metadata to be updated.
+    # @param [String] model_id A unique model identifier.
+    # @param [OCI::AiVision::Models::UpdateModelDetails] update_model_details The model metadata to be updated.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#update_model}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
@@ -352,8 +352,8 @@ module OCI
     # Calls {OCI::AiVision::AIServiceVisionClient#update_project} and then waits for the {OCI::AiVision::Models::WorkRequest}
     # to enter the given state(s).
     #
-    # @param [String] project_id unique project identifier.
-    # @param [OCI::AiVision::Models::UpdateProjectDetails] update_project_details Project metadata to be updated.
+    # @param [String] project_id A unique project identifier.
+    # @param [OCI::AiVision::Models::UpdateProjectDetails] update_project_details The project metadata to be updated.
     # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::AiVision::Models::WorkRequest#status}
     # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::AiVision::AIServiceVisionClient#update_project}
     # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:

data/lib/oci/ai_vision/models/analyze_document_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Details about how to analyze a document.
+  # The details of how to analyze a document.
   class AiVision::Models::AnalyzeDocumentDetails
     LANGUAGE_ENUM = [
       LANGUAGE_ENG = 'ENG'.freeze,
@@ -48,7 +48,7 @@ module OCI
       DOCUMENT_TYPE_OTHERS = 'OTHERS'.freeze
     ].freeze
 
-    # **[Required]** Types of document analysis requested.
+    # **[Required]** The types of document analysis requested.
     # @return [Array<OCI::AiVision::Models::DocumentFeature>]
     attr_accessor :features
 
@@ -63,11 +63,11 @@ module OCI
     # @return [OCI::AiVision::Models::OutputLocation]
     attr_accessor :output_location
 
-    # Language of the document, abbreviated according to ISO 639-2.
+    # The document language, abbreviated according to ISO 639-2.
     # @return [String]
     attr_reader :language
 
-    # The type of document.
+    # The document type.
     # @return [String]
     attr_reader :document_type
 

data/lib/oci/ai_vision/models/analyze_document_result.rb

@@ -5,13 +5,13 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Document analysis results.
+  # The document analysis results.
   class AiVision::Models::AnalyzeDocumentResult
     # This attribute is required.
     # @return [OCI::AiVision::Models::DocumentMetadata]
     attr_accessor :document_metadata
 
-    # **[Required]** Array of Page.
+    # **[Required]** The array of a Page.
     # @return [Array<OCI::AiVision::Models::Page>]
     attr_accessor :pages
 
@@ -23,31 +23,31 @@ module OCI
     # @return [Array<OCI::AiVision::Models::DetectedLanguage>]
     attr_accessor :detected_languages
 
-    # Document classification model version.
+    # The document classification model version.
     # @return [String]
     attr_accessor :document_classification_model_version
 
-    # Document language classification model version.
+    # The document language classification model version.
     # @return [String]
     attr_accessor :language_classification_model_version
 
-    # Document text detection model version.
+    # The document text detection model version.
     # @return [String]
     attr_accessor :text_detection_model_version
 
-    # Document keyValue detection model version.
+    # The document keyValue detection model version.
     # @return [String]
     attr_accessor :key_value_detection_model_version
 
-    # Document table detection model version.
+    # The document table detection model version.
     # @return [String]
     attr_accessor :table_detection_model_version
 
-    # Errors encountered during document analysis.
+    # The errors encountered during document analysis.
     # @return [Array<OCI::AiVision::Models::ProcessingError>]
     attr_accessor :errors
 
-    # Generated searchable PDF file.
+    # The searchable PDF file that was generated.
     # @return [String]
     attr_accessor :searchable_pdf
 

data/lib/oci/ai_vision/models/analyze_image_details.rb

@@ -5,9 +5,9 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Details about how to analyze an image.
+  # The details of how to analyze an image.
   class AiVision::Models::AnalyzeImageDetails
-    # **[Required]** Types of image analysis.
+    # **[Required]** The types of image analysis.
     # @return [Array<OCI::AiVision::Models::ImageFeature>]
     attr_accessor :features
 
@@ -15,7 +15,7 @@ module OCI
     # @return [OCI::AiVision::Models::ImageDetails]
     attr_accessor :image
 
-    # The ocid of the compartment that calls the API.
+    # The OCID of the compartment that calls the API.
     # @return [String]
     attr_accessor :compartment_id
 

data/lib/oci/ai_vision/models/analyze_image_result.rb

@@ -5,36 +5,36 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Image analysis results.
+  # The image analysis results.
   class AiVision::Models::AnalyzeImageResult
-    # Detected objects.
+    # The detected objects.
     # @return [Array<OCI::AiVision::Models::ImageObject>]
     attr_accessor :image_objects
 
-    # Image classification labels.
+    # The image classification labels.
     # @return [Array<OCI::AiVision::Models::Label>]
     attr_accessor :labels
 
-    # ontologyClasses of image labels.
+    # The ontologyClasses of image labels.
     # @return [Array<OCI::AiVision::Models::OntologyClass>]
     attr_accessor :ontology_classes
 
     # @return [OCI::AiVision::Models::ImageText]
     attr_accessor :image_text
 
-    # Image classification model version.
+    # The image classification model version.
     # @return [String]
     attr_accessor :image_classification_model_version
 
-    # Object detection model version.
+    # The object detection model version.
     # @return [String]
     attr_accessor :object_detection_model_version
 
-    # Text detection model version.
+    # The text detection model version.
     # @return [String]
     attr_accessor :text_detection_model_version
 
-    # Errors encountered during image analysis.
+    # The errors encountered during image analysis.
     # @return [Array<OCI::AiVision::Models::ProcessingError>]
     attr_accessor :errors
 

data/lib/oci/ai_vision/models/bounding_polygon.rb

@@ -5,10 +5,10 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Object bounding polygon box.
+  # The object-bounding polygon box.
   class AiVision::Models::BoundingPolygon
     # **[Required]** An array of normalized points defining the polygon's perimeter, with an implicit segment between subsequent points and between the first and last point.
-    # Rectangles are defined with four points, e.g. `[{\"x\": 0, \"y\": 0}, {\"x\": 1, \"y\": 0}, {\"x\": 1, \"y\": 0.5}, {\"x\": 0, \"y\": 0.5}]` represents the top half of an image.
+    # Rectangles are defined with four points. For example, `[{\"x\": 0, \"y\": 0}, {\"x\": 1, \"y\": 0}, {\"x\": 1, \"y\": 0.5}, {\"x\": 0, \"y\": 0.5}]` represents the top half of an image.
     #
     # @return [Array<OCI::AiVision::Models::NormalizedVertex>]
     attr_accessor :normalized_vertices

data/lib/oci/ai_vision/models/cell.rb

@@ -7,19 +7,19 @@ require 'date'
 module OCI
   # A single cell in a table.
   class AiVision::Models::Cell
-    # **[Required]** Text recognized in the cell.
+    # **[Required]** The text recognized in the cell.
     # @return [String]
     attr_accessor :text
 
-    # **[Required]** Index of the cell inside the row.
+    # **[Required]** The index of the cell inside the row.
     # @return [Integer]
     attr_accessor :row_index
 
-    # **[Required]** Index of the cell inside the column.
+    # **[Required]** The index of the cell inside the column.
     # @return [Integer]
     attr_accessor :column_index
 
-    # **[Required]** Confidence score between 0 to 1.
+    # **[Required]** The confidence score between 0 and 1.
     # @return [Float]
     attr_accessor :confidence
 
@@ -27,7 +27,7 @@ module OCI
     # @return [OCI::AiVision::Models::BoundingPolygon]
     attr_accessor :bounding_polygon
 
-    # **[Required]** Words detected in the cell.
+    # **[Required]** The words detected in the cell.
     # @return [Array<Integer>]
     attr_accessor :word_indexes
 

data/lib/oci/ai_vision/models/change_model_compartment_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Which compartment the model should be moved to.
+  # The compartment the model should be moved to.
   class AiVision::Models::ChangeModelCompartmentDetails
     # **[Required]** The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
     # into which the model should be moved.

data/lib/oci/ai_vision/models/create_document_job_details.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Details about the batch document analysis.
+  # The batch document analysis details.
   class AiVision::Models::CreateDocumentJobDetails
     LANGUAGE_ENUM = [
       LANGUAGE_ENG = 'ENG'.freeze,
@@ -52,7 +52,7 @@ module OCI
     # @return [OCI::AiVision::Models::InputLocation]
     attr_accessor :input_location
 
-    # **[Required]** List of document analysis types requested.
+    # **[Required]** The list of requested document analysis types.
     # @return [Array<OCI::AiVision::Models::DocumentFeature>]
     attr_accessor :features
 
@@ -60,15 +60,15 @@ module OCI
     # @return [OCI::AiVision::Models::OutputLocation]
     attr_accessor :output_location
 
-    # Compartment identifier from the requester.
+    # The compartment identifier from the requester.
     # @return [String]
     attr_accessor :compartment_id
 
-    # Document job display name.
+    # The document job display name.
     # @return [String]
     attr_accessor :display_name
 
-    # Language of the document, abbreviated according to ISO 639-2.
+    # The language of the document, abbreviated according to ISO 639-2.
     # @return [String]
     attr_reader :language
 
@@ -76,7 +76,7 @@ module OCI
     # @return [String]
     attr_reader :document_type
 
-    # Whether to generate a Zip file containing the results.
+    # Whether or not to generate a ZIP file containing the results.
     # @return [BOOLEAN]
     attr_accessor :is_zip_output_enabled