oci-aivision 2.21.0 → 2.22.0

package/lib/model/document-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/document-field.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
  *
  *
@@ -16,7 +16,7 @@ import * as model from "../model";
  */
 export interface DocumentField {
     /**
-     * Field type.
+     * The field type.
      */
     "fieldType": DocumentField.FieldType;
     "fieldLabel"?: model.FieldLabel;

package/lib/model/document-field.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/document-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 document analysis.
+ * The job details for a batch document analysis.
  */
 export interface DocumentJob {
     /**
-     * Job id.
+     * The job id.
      */
     "id": string;
     /**
@@ -24,36 +24,36 @@ export interface DocumentJob {
      */
     "compartmentId": string;
     /**
-     * Document job display name.
+     * The document job display name.
      */
     "displayName"?: string;
     /**
-     * List of document analysis types requested.
+     * The list of requested document analysis types.
      */
     "features": Array<model.DocumentFeature>;
     /**
-     * Language of the document, abbreviated according to ISO 639-2.
+     * The document language, abbreviated according to ISO 639-2.
      */
     "language"?: model.DocumentLanguage;
     /**
-     * The type of documents.
+     * The type of document.
      */
     "documentType"?: model.DocumentType;
     "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;
@@ -62,11 +62,11 @@ export interface DocumentJob {
      */
     "lifecycleState": DocumentJob.LifecycleState;
     /**
-     * Whether to generate a Zip file containing the results.
+     * Whether or not to generate a ZIP file containing the results.
      */
     "isZipOutputEnabled"?: boolean;
     /**
-     * Detailed status of FAILED state.
+     * The detailed status of FAILED state.
      */
     "lifecycleDetails"?: DocumentJob.LifecycleDetails;
 }

package/lib/model/document-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/document-key-value-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
  *
  *

package/lib/model/document-key-value-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/document-language-classification-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
  *
  *

package/lib/model/document-language-classification-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/document-language.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.
  */
 /**
- * Language of the document, abbreviated according to ISO 639-2.
+ * The language of the document, abbreviated according to ISO 639-2.
  **/
 export declare enum DocumentLanguage {
     Eng = "ENG",

package/lib/model/document-language.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
  *
  *
@@ -14,7 +14,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentLanguage = void 0;
 /**
- * Language of the document, abbreviated according to ISO 639-2.
+ * The language of the document, abbreviated according to ISO 639-2.
  **/
 var DocumentLanguage;
 (function (DocumentLanguage) {

package/lib/model/document-metadata.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.
  */
 /**
- * Document information.
+ * The document information.
  */
 export interface DocumentMetadata {
     /**
-     * Number of pages in the document. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * Teh number of pages in the document. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "pageCount": number;
     /**
-     * Result data format.
+     * The result data format.
      */
     "mimeType": string;
 }

package/lib/model/document-metadata.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/document-table-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
  *
  *

package/lib/model/document-table-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/document-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
  *
  *
@@ -16,7 +16,7 @@ import * as model from "../model";
  */
 export interface DocumentTextDetectionFeature extends model.DocumentFeature {
     /**
-     * Whether to generate a searchable PDF file.
+     * Whether or not to generate a searchable PDF file.
      */
     "generateSearchablePdf"?: boolean;
     "featureType": string;

package/lib/model/document-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/document-type.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.
  */
 /**
- * Type of the document.
+ * The type of document.
  **/
 export declare enum DocumentType {
     Invoice = "INVOICE",

package/lib/model/document-type.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
  *
  *
@@ -14,7 +14,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentType = void 0;
 /**
- * Type of the document.
+ * The type of document.
  **/
 var DocumentType;
 (function (DocumentType) {

package/lib/model/field-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.
  */
 /**
- * Label in a field.
+ * The label in a field.
  */
 export interface FieldLabel {
     /**
-     * Name of the field label.
+     * The name of the field label.
      */
     "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/field-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/field-name.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";
 /**
- * Name of a form field.
+ * The name of a form field.
  */
 export interface FieldName {
     /**
-     * Name of the field.
+     * The name of the field.
      */
     "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;
     /**
-     * Indexes of the words in the field name.
+     * The indexes of the words in the field name.
      */
     "wordIndexes"?: Array<number>;
 }

package/lib/model/field-name.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/field-value.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";
 /**
- * Value of a form field.
+ * The value of a form field.
  */
 export interface FieldValue {
     /**
-     * Detected text of a field.
+     * The detected text of a field.
      */
     "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;
     /**
-     * Indexes of the words in the field value.
+     * The indexes of the words in the field value.
      */
     "wordIndexes": Array<number>;
     "valueType": string;

package/lib/model/field-value.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-classification-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";
 /**
- * Image classification parameters.
+ * The image classification parameters.
  */
 export interface ImageClassificationFeature extends model.ImageFeature {
     /**
@@ -20,7 +20,7 @@ export interface ImageClassificationFeature extends model.ImageFeature {
      */
     "maxResults"?: number;
     /**
-     * Custom model id.
+     * The custom model ID.
      */
     "modelId"?: string;
     "featureType": string;

package/lib/model/image-classification-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-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
  *
  *
@@ -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.
  */
 /**
- * Details about an image to analyze.
+ * The details of an image to analyze.
  */
 export interface ImageDetails {
     "source": string;

package/lib/model/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/image-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
  *
  *
@@ -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.
  */
 /**
- * Type of image analysis.
+ * The type of image analysis.
  */
 export interface ImageFeature {
     "featureType": string;

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