oci-aivision 2.20.0 → 2.24.0

package/lib/model/output-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/page.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 Page {
     /**
-     * Document page number. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The document page number. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "pageNumber": number;
     "dimensions"?: model.Dimensions;
@@ -29,19 +29,19 @@ export interface Page {
      */
     "detectedLanguages"?: Array<model.DetectedLanguage>;
     /**
-     * Words detected on the page.
+     * The words detected on the page.
      */
     "words"?: Array<model.Word>;
     /**
-     * Text lines detected on the page.
+     * The lines of text detected on the page.
      */
     "lines"?: Array<model.Line>;
     /**
-     * Tables detected on the page.
+     * The tables detected on the page.
      */
     "tables"?: Array<model.Table>;
     /**
-     * Form fields detected on the page.
+     * The form fields detected on the page.
      */
     "documentFields"?: Array<model.DocumentField>;
 }

package/lib/model/page.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/processing-error.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.
  */
 /**
- * Error in document processing.
+ * The error in document processing.
  */
 export interface ProcessingError {
     /**
-     * Error code.
+     * The error code.
      */
     "code": string;
     /**
-     * Error message.
+     * The error message.
      */
     "message": string;
 }

package/lib/model/processing-error.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/project-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,7 +12,7 @@
  */
 import * as model from "../model";
 /**
- * Results of a project search.
+ * The results of a project search.
  */
 export interface ProjectCollection {
     /**

package/lib/model/project-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/project-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
  *
  *
@@ -11,19 +11,19 @@
  * 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.
  */
 /**
- * Metadata about the project.
+ * the metadata about the project.
  */
 export interface ProjectSummary {
     /**
-     * Unique identifier that is immutable after creation.
+     * A unique identifier that is immutable after creation.
      */
     "id": string;
     /**
-     * Human-friendly name for the project, which can be changed.
+     * A human-friendly name for the project, that can be changed.
      */
     "displayName"?: string;
     /**
-     * Compartment identifier.
+     * The compartment identifier.
      */
     "compartmentId": string;
     /**
@@ -39,12 +39,12 @@ export interface ProjectSummary {
      */
     "lifecycleState": string;
     /**
-     * A message describing the current state in more detail which can provide actionable information if creation failed.
+     * A message describing the current state in more detail, that can provide actionable information if creation failed.
      */
     "lifecycleDetails"?: string;
     /**
-     * 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"?: {
@@ -52,7 +52,7 @@ export interface ProjectSummary {
     };
     /**
      * 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"?: {
@@ -62,7 +62,7 @@ export interface ProjectSummary {
     };
     /**
      * 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/project-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
  *
  *

package/lib/model/project.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,23 +11,23 @@
  * 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 Vision Project which contains models.
+ * A Vision Project containing models.
  */
 export interface Project {
     /**
-     * Unique identifier that is immutable after creation.
+     * A unique identifier that is immutable after creation.
      */
     "id": string;
     /**
-     * Human-friendly name for the project, which can be changed.
+     * A human-friendly name for the project, which can be changed.
      */
     "displayName"?: string;
     /**
-     * Optional description of the project.
+     * An optional description of the project.
      */
     "description"?: string;
     /**
-     * Compartment identifier.
+     * A compartment identifier.
      */
     "compartmentId": string;
     /**
@@ -43,12 +43,12 @@ export interface Project {
      */
     "lifecycleState": Project.LifecycleState;
     /**
-     * A message describing the current state in more detail which can provide actionable information if creation failed.
+     * A message describing the current state in more detail, that can provide actionable information if creation failed.
      */
     "lifecycleDetails"?: string;
     /**
-     * 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"?: {
@@ -56,7 +56,7 @@ export interface Project {
     };
     /**
      * 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"?: {
@@ -66,7 +66,7 @@ export interface Project {
     };
     /**
      * 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/project.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/sort-order.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/sort-order.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/table-row.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 TableRow {
     /**
-     * Cells in the row.
+     * The cells in the row.
      */
     "cells": Array<model.Cell>;
 }

package/lib/model/table-row.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/table.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,31 +12,31 @@
  */
 import * as model from "../model";
 /**
- * Table extracted from a document.
+ * The table extracted from a document.
  */
 export interface Table {
     /**
-     * Number of rows. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The number of rows. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "rowCount": number;
     /**
-     * Number of columns. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The number of columns. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "columnCount": number;
     /**
-     * Header rows.
+     * The header rows.
      */
     "headerRows": Array<model.TableRow>;
     /**
-     * Body rows.
+     * The body rows.
      */
     "bodyRows": Array<model.TableRow>;
     /**
-     * Footer rows.
+     * the footer rows.
      */
     "footerRows": Array<model.TableRow>;
     /**
-     * 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/table.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/update-model-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,20 +11,20 @@
  * 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.
  */
 /**
- * Metadata which can be edited after model creation.
+ * The metadata which can be edited after model creation.
  */
 export interface UpdateModelDetails {
     /**
-     * Human-friendly name of the model, which can be changed.
+     * A human-friendly name of the model, which can be changed.
      */
     "displayName"?: string;
     /**
-     * Optional description of the model.
+     * An optional description of the model.
      */
     "description"?: string;
     /**
-     * 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"?: {
@@ -32,7 +32,7 @@ export interface UpdateModelDetails {
     };
     /**
      * 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"?: {

package/lib/model/update-model-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/update-project-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,20 +11,20 @@
  * 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.
  */
 /**
- * Metadata which can be edited after project creation.
+ * The metadata that can be edited after project creation.
  */
 export interface UpdateProjectDetails {
     /**
-     * Human-friendly name for the project, which can be changed.
+     * A human-friendly name for the project, that can be changed.
      */
     "displayName"?: string;
     /**
-     * Optional description of the project.
+     * An optional description of the project.
      */
     "description"?: string;
     /**
-     * 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"?: {
@@ -32,7 +32,7 @@ export interface UpdateProjectDetails {
     };
     /**
      * 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"?: {

package/lib/model/update-project-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/value-array.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";
 /**
- * Array of field values.
+ * The array of field values.
  */
 export interface ValueArray extends model.FieldValue {
     "items": Array<model.DocumentField>;

package/lib/model/value-array.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/value-date.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";
 /**
- * Date field value.
+ * The date field value.
  */
 export interface ValueDate extends model.FieldValue {
     /**
-     * Date field value as yyyy-mm-dd.
+     * The date field value as yyyy-mm-dd.
      */
     "value": Date;
     "valueType": string;

package/lib/model/value-date.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/value-integer.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";
 /**
- * Integer field value.
+ * The integer field value.
  */
 export interface ValueInteger extends model.FieldValue {
     /**
-     * Integer value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The integer value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "value": number;
     "valueType": string;

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