oci-aivision 2.19.0 → 2.22.0

package/lib/model/image-job.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
  *
  *
@@ -12,11 +12,11 @@
  */
 import * as model from "../model";
 /**
- * Job details for a batch image analysis.
+ * The job details for a batch image analysis.
  */
 export interface ImageJob {
     /**
-     * Job id
+     * The job id
      */
     "id": string;
     /**
@@ -24,28 +24,28 @@ export interface ImageJob {
      */
     "compartmentId": string;
     /**
-     * Image job display name.
+     * The image job display name.
      */
     "displayName"?: string;
     /**
-     * List of document analysis types requested.
+     * The list of requested document analysis types.
      */
     "features": Array<model.ImageFeature>;
     "inputLocation"?: model.ObjectListInlineInputLocation;
     /**
-     * Job accepted time.
+     * The job acceptance time.
      */
     "timeAccepted": Date;
     /**
-     * Job started time.
+     * The job start time.
      */
     "timeStarted"?: Date;
     /**
-     * Job finished time.
+     * The job finish time.
      */
     "timeFinished"?: Date;
     /**
-     * How much progress the operation has made, vs the total amount of work that must be performed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * How much progress the operation has made, compared to the total amount of work to be performed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "percentComplete"?: number;
     "outputLocation": model.OutputLocation;
@@ -54,11 +54,11 @@ export interface ImageJob {
      */
     "lifecycleState": ImageJob.LifecycleState;
     /**
-     * Detailed status of FAILED state.
+     * The detailed status of FAILED state.
      */
     "lifecycleDetails"?: ImageJob.LifecycleDetails;
     /**
-     * Whether to generate a Zip file containing the results.
+     * Whether or not to generate a ZIP file containing the results.
      */
     "isZipOutputEnabled"?: boolean;
 }

package/lib/model/image-job.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/model/image-object-detection-feature.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
  *
  *
@@ -12,7 +12,7 @@
  */
 import * as model from "../model";
 /**
- * Object detection parameters.
+ * The object detection parameters.
  */
 export interface ImageObjectDetectionFeature extends model.ImageFeature {
     /**
@@ -20,7 +20,7 @@ export interface ImageObjectDetectionFeature extends model.ImageFeature {
      */
     "maxResults"?: number;
     /**
-     * Custom model id.
+     * The custom model ID.
      */
     "modelId"?: string;
     "featureType": string;

package/lib/model/image-object-detection-feature.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/model/image-object.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
  *
  *
@@ -12,15 +12,15 @@
  */
 import * as model from "../model";
 /**
- * Detected object in image.
+ * The object detected in an image.
  */
 export interface ImageObject {
     /**
-     * Object category name. Every value returned by the pre-deployed model will be in English.
+     * The object category name. Every value returned by the pre-deployed model is in English.
      */
     "name": string;
     /**
-     * Confidence score between 0 to 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The confidence score, between 0 and 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "confidence": number;
     "boundingPolygon": model.BoundingPolygon;

package/lib/model/image-object.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/model/image-text-detection-feature.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
  *
  *
@@ -12,11 +12,11 @@
  */
 import * as model from "../model";
 /**
- * Text detection parameters.
+ * The text detection parameters.
  */
 export interface ImageTextDetectionFeature extends model.ImageFeature {
     /**
-     * Language of the document image, abbreviated according to ISO 639-2.
+     * The language of the document image, abbreviated according to ISO 639-2.
      */
     "language"?: model.DocumentLanguage;
     "featureType": string;

package/lib/model/image-text-detection-feature.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/model/image-text.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
  *
  *
@@ -12,15 +12,15 @@
  */
 import * as model from "../model";
 /**
- * Detected text.
+ * The detected text.
  */
 export interface ImageText {
     /**
-     * Words recognized in the image.
+     * The words recognized in an image.
      */
     "words": Array<model.Word>;
     /**
-     * Lines of text recognized in the image.
+     * The lines of text recognized in an image.
      */
     "lines": Array<model.Line>;
 }

package/lib/model/image-text.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/model/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/lib/model/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/model/inline-document-details.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
  *
  *
@@ -12,11 +12,11 @@
  */
 import * as model from "../model";
 /**
- * Document incorporated in the request payload.
+ * The document incorporated in the request payload.
  */
 export interface InlineDocumentDetails extends model.DocumentDetails {
     /**
-     * Document raw data.
+     * Raw document data.
      */
     "data": string;
     "source": string;

package/lib/model/inline-document-details.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/model/inline-image-details.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
  *
  *
@@ -12,11 +12,11 @@
  */
 import * as model from "../model";
 /**
- * Image incorporated in the request payload.
+ * The image incorporated in the request payload.
  */
 export interface InlineImageDetails extends model.ImageDetails {
     /**
-     * Image raw data.
+     * Raw image data.
      */
     "data": string;
     "source": string;

package/lib/model/inline-image-details.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/model/input-location.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
  *
  *
@@ -11,7 +11,7 @@
  * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
  */
 /**
- * The location of the input(s).
+ * The location of the inputs.
  */
 export interface InputLocation {
     "sourceType": string;

package/lib/model/input-location.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/model/label.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
  *
  *
@@ -11,15 +11,15 @@
  * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
  */
 /**
- * A label describing an image. Every label returned by the pre-deployed model will be in English.
+ * A label describing an image. Every label returned by the pre-deployed model is in English.
  */
 export interface Label {
     /**
-     * Classification catagory label name.
+     * The classification catagory label name.
      */
     "name": string;
     /**
-     * Confidence score between 0 to 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The confidence score between 0 and 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "confidence": number;
 }

package/lib/model/label.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/model/line.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
  *
  *
@@ -12,20 +12,20 @@
  */
 import * as model from "../model";
 /**
- * Line of text.
+ * The line of text.
  */
 export interface Line {
     /**
-     * Text recognized.
+     * The text recognized.
      */
     "text": string;
     /**
-     * Confidence score between 0 to 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The confidence score between 0 and 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "confidence": number;
     "boundingPolygon": model.BoundingPolygon;
     /**
-     * Array of words.
+     * The array of words.
      */
     "wordIndexes": Array<number>;
 }

package/lib/model/line.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/model/model-collection.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
  *
  *
@@ -12,11 +12,11 @@
  */
 import * as model from "../model";
 /**
- * Results of a model search.
+ * The results of a model search.
  */
 export interface ModelCollection {
     /**
-     * List of models.
+     * A list of models.
      */
     "items": Array<model.ModelSummary>;
 }

package/lib/model/model-collection.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/model/model-summary.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
  *
  *
@@ -12,23 +12,23 @@
  */
 import * as model from "../model";
 /**
- * Metadata about the model.
+ * The metadata about the model.
  */
 export interface ModelSummary {
     /**
-     * Unique identifier that is immutable after creation.
+     * A unique identifier that is immutable after creation.
      */
     "id": string;
     /**
-     * Human-friendly name for the model, which can be changed.
+     * A human-friendly name for the model, which can be changed.
      */
     "displayName"?: string;
     /**
-     * Optional description of the model.
+     * An optional description of the model.
      */
     "description"?: string;
     /**
-     * Compartment identifier.
+     * The compartment identifier.
      */
     "compartmentId": string;
     /**
@@ -40,7 +40,7 @@ export interface ModelSummary {
      */
     "modelVersion": string;
     /**
-     * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project which contains the model.
+     * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project that contains the model.
      */
     "projectId": string;
     /**
@@ -56,19 +56,19 @@ export interface ModelSummary {
      */
     "lifecycleState": string;
     /**
-     * A message describing the current state in more detail which can provide actionable information if training failed.
+     * A message describing the current state in more detail, that can provide actionable information if training failed.
      */
     "lifecycleDetails"?: string;
     /**
-     * Precision of the trained model. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The precision of the trained model. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "precision"?: number;
     "trainingDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
     "testingDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
     "validationDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
     /**
-     * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
-     * Example: `{\"bar-key\": \"value\"}`
+     * A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
+     * For example: `{\"bar-key\": \"value\"}`
      *
      */
     "freeformTags"?: {
@@ -76,7 +76,7 @@ export interface ModelSummary {
     };
     /**
      * Defined tags for this resource. Each key is predefined and scoped to a namespace.
-     * Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
+     * For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
      *
      */
     "definedTags"?: {
@@ -86,7 +86,7 @@ export interface ModelSummary {
     };
     /**
      * Usage of system tag keys. These predefined keys are scoped to namespaces.
-     * Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
+     * For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
      *
      */
     "systemTags"?: {

package/lib/model/model-summary.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
  *
  *