oci-aivision 2.19.0 → 2.22.0

package/index.d.ts

@@ -1,6 +1,6 @@
 /**
- * VisionService API
- * A description of the VisionService API.
+ * Vision 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.
  * OpenAPI spec version: 20220125
  *
  *

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
- * VisionService API
- * A description of the VisionService API.
+ * Vision 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.
  * OpenAPI spec version: 20220125
  *
  *

package/lib/aiservicevision-waiter.d.ts

@@ -1,6 +1,6 @@
 /**
- * VisionService API
- * A description of the VisionService API.
+ * Vision 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.
  * OpenAPI spec version: 20220125
  *
  *

package/lib/aiservicevision-waiter.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
- * VisionService API
- * A description of the VisionService API.
+ * Vision 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.
  * OpenAPI spec version: 20220125
  *
  *

package/lib/client.d.ts

@@ -1,6 +1,6 @@
 /**
- * VisionService API
- * A description of the VisionService API.
+ * Vision 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.
  * OpenAPI spec version: 20220125
  *
  *
@@ -74,7 +74,7 @@ export declare class AIServiceVisionClient {
      * @param AnalyzeDocumentRequest
      * @return AnalyzeDocumentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/AnalyzeDocument.ts.html |here} to see how to use AnalyzeDocument API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/AnalyzeDocument.ts.html |here} to see how to use AnalyzeDocument API.
      */
     analyzeDocument(analyzeDocumentRequest: requests.AnalyzeDocumentRequest): Promise<responses.AnalyzeDocumentResponse>;
     /**
@@ -84,150 +84,150 @@ export declare class AIServiceVisionClient {
      * @param AnalyzeImageRequest
      * @return AnalyzeImageResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/AnalyzeImage.ts.html |here} to see how to use AnalyzeImage API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/AnalyzeImage.ts.html |here} to see how to use AnalyzeImage API.
      */
     analyzeImage(analyzeImageRequest: requests.AnalyzeImageRequest): Promise<responses.AnalyzeImageResponse>;
     /**
-     * Cancel a batch document job.
+     * Cancel a document batch job.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CancelDocumentJobRequest
      * @return CancelDocumentJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CancelDocumentJob.ts.html |here} to see how to use CancelDocumentJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CancelDocumentJob.ts.html |here} to see how to use CancelDocumentJob API.
      */
     cancelDocumentJob(cancelDocumentJobRequest: requests.CancelDocumentJobRequest): Promise<responses.CancelDocumentJobResponse>;
     /**
-     * Cancel a batch image job.
+     * Cancel an image batch job.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CancelImageJobRequest
      * @return CancelImageJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CancelImageJob.ts.html |here} to see how to use CancelImageJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CancelImageJob.ts.html |here} to see how to use CancelImageJob API.
      */
     cancelImageJob(cancelImageJobRequest: requests.CancelImageJobRequest): Promise<responses.CancelImageJobResponse>;
     /**
-     * Cancel work request with the given ID.
+     * Cancel the work request with the given ID.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CancelWorkRequestRequest
      * @return CancelWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
      */
     cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
     /**
-     * Moves a model from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
+     * Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeModelCompartmentRequest
      * @return ChangeModelCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartment API.
      */
     changeModelCompartment(changeModelCompartmentRequest: requests.ChangeModelCompartmentRequest): Promise<responses.ChangeModelCompartmentResponse>;
     /**
-     * Moves a project from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
+     * Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeProjectCompartmentRequest
      * @return ChangeProjectCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartment API.
      */
     changeProjectCompartment(changeProjectCompartmentRequest: requests.ChangeProjectCompartmentRequest): Promise<responses.ChangeProjectCompartmentResponse>;
     /**
-     * Create a batch document analysis job
+     * Create a document analysis batch job.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateDocumentJobRequest
      * @return CreateDocumentJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CreateDocumentJob.ts.html |here} to see how to use CreateDocumentJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CreateDocumentJob.ts.html |here} to see how to use CreateDocumentJob API.
      */
     createDocumentJob(createDocumentJobRequest: requests.CreateDocumentJobRequest): Promise<responses.CreateDocumentJobResponse>;
     /**
-     * Create a batch image analysis job.
+     * Create an image analysis batch job.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateImageJobRequest
      * @return CreateImageJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CreateImageJob.ts.html |here} to see how to use CreateImageJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CreateImageJob.ts.html |here} to see how to use CreateImageJob API.
      */
     createImageJob(createImageJobRequest: requests.CreateImageJobRequest): Promise<responses.CreateImageJobResponse>;
     /**
-     * Creates a new model.
+     * Create a new model.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateModelRequest
      * @return CreateModelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CreateModel.ts.html |here} to see how to use CreateModel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CreateModel.ts.html |here} to see how to use CreateModel API.
      */
     createModel(createModelRequest: requests.CreateModelRequest): Promise<responses.CreateModelResponse>;
     /**
-     * Creates a new project.
+     * Create a new project.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateProjectRequest
      * @return CreateProjectResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/CreateProject.ts.html |here} to see how to use CreateProject API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/CreateProject.ts.html |here} to see how to use CreateProject API.
      */
     createProject(createProjectRequest: requests.CreateProjectRequest): Promise<responses.CreateProjectResponse>;
     /**
-     * Deletes a model by identifier.
+     * Delete a model by identifier.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteModelRequest
      * @return DeleteModelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/DeleteModel.ts.html |here} to see how to use DeleteModel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/DeleteModel.ts.html |here} to see how to use DeleteModel API.
      */
     deleteModel(deleteModelRequest: requests.DeleteModelRequest): Promise<responses.DeleteModelResponse>;
     /**
-     * Deletes a project by identifier.
+     * Delete a project by identifier.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteProjectRequest
      * @return DeleteProjectResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/DeleteProject.ts.html |here} to see how to use DeleteProject API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/DeleteProject.ts.html |here} to see how to use DeleteProject API.
      */
     deleteProject(deleteProjectRequest: requests.DeleteProjectRequest): Promise<responses.DeleteProjectResponse>;
     /**
-     * Get details of a batch document job.
+     * Get details of a document batch job.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetDocumentJobRequest
      * @return GetDocumentJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/GetDocumentJob.ts.html |here} to see how to use GetDocumentJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/GetDocumentJob.ts.html |here} to see how to use GetDocumentJob API.
      */
     getDocumentJob(getDocumentJobRequest: requests.GetDocumentJobRequest): Promise<responses.GetDocumentJobResponse>;
     /**
-     * Get details of a batch image job.
+     * Get details of an image batch job.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetImageJobRequest
      * @return GetImageJobResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/GetImageJob.ts.html |here} to see how to use GetImageJob API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/GetImageJob.ts.html |here} to see how to use GetImageJob API.
      */
     getImageJob(getImageJobRequest: requests.GetImageJobRequest): Promise<responses.GetImageJobResponse>;
     /**
-     * Gets a model by identifier.
+     * Get a model by identifier.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetModelRequest
      * @return GetModelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/GetModel.ts.html |here} to see how to use GetModel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/GetModel.ts.html |here} to see how to use GetModel API.
      */
     getModel(getModelRequest: requests.GetModelRequest): Promise<responses.GetModelResponse>;
     /**
-     * Gets a project by identifier.
+     * Get a project by identifier.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetProjectRequest
      * @return GetProjectResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/GetProject.ts.html |here} to see how to use GetProject API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/GetProject.ts.html |here} to see how to use GetProject API.
      */
     getProject(getProjectRequest: requests.GetProjectRequest): Promise<responses.GetProjectResponse>;
     /**
@@ -236,7 +236,7 @@ export declare class AIServiceVisionClient {
      * @param GetWorkRequestRequest
      * @return GetWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
@@ -246,7 +246,7 @@ export declare class AIServiceVisionClient {
      * @param ListModelsRequest
      * @return ListModelsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ListModels.ts.html |here} to see how to use ListModels API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ListModels.ts.html |here} to see how to use ListModels API.
      */
     listModels(listModelsRequest: requests.ListModelsRequest): Promise<responses.ListModelsResponse>;
     /**
@@ -256,17 +256,17 @@ export declare class AIServiceVisionClient {
      * @param ListProjectsRequest
      * @return ListProjectsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ListProjects.ts.html |here} to see how to use ListProjects API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ListProjects.ts.html |here} to see how to use ListProjects API.
      */
     listProjects(listProjectsRequest: requests.ListProjectsRequest): Promise<responses.ListProjectsResponse>;
     /**
-     * Return a (paginated) list of errors for a given work request.
+     * Returns a (paginated) list of errors for a given work request.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestErrorsRequest
      * @return ListWorkRequestErrorsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
      */
     listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
     /**
@@ -276,7 +276,7 @@ export declare class AIServiceVisionClient {
      * @param ListWorkRequestLogsRequest
      * @return ListWorkRequestLogsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
      */
     listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
     /**
@@ -286,25 +286,25 @@ export declare class AIServiceVisionClient {
      * @param ListWorkRequestsRequest
      * @return ListWorkRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
-     * Updates model metadata.
+     * Updates the model metadata.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateModelRequest
      * @return UpdateModelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/UpdateModel.ts.html |here} to see how to use UpdateModel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/UpdateModel.ts.html |here} to see how to use UpdateModel API.
      */
     updateModel(updateModelRequest: requests.UpdateModelRequest): Promise<responses.UpdateModelResponse>;
     /**
-     * Updates project metadata.
+     * Update the project metadata.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateProjectRequest
      * @return UpdateProjectResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.19.0/aivision/UpdateProject.ts.html |here} to see how to use UpdateProject API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.22.0/aivision/UpdateProject.ts.html |here} to see how to use UpdateProject API.
      */
     updateProject(updateProjectRequest: requests.UpdateProjectRequest): Promise<responses.UpdateProjectResponse>;
 }