oci-aivision 2.20.0 → 2.24.0

package/lib/model/analyze-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/analyze-document-result.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,12 +12,12 @@
  */
 import * as model from "../model";
 /**
- * Document analysis results.
+ * The document analysis results.
  */
 export interface AnalyzeDocumentResult {
     "documentMetadata": model.DocumentMetadata;
     /**
-     * Array of Page.
+     * The array of a Page.
      */
     "pages": Array<model.Page>;
     /**
@@ -29,31 +29,31 @@ export interface AnalyzeDocumentResult {
      */
     "detectedLanguages"?: Array<model.DetectedLanguage>;
     /**
-     * Document classification model version.
+     * The document classification model version.
      */
     "documentClassificationModelVersion"?: string;
     /**
-     * Document language classification model version.
+     * The document language classification model version.
      */
     "languageClassificationModelVersion"?: string;
     /**
-     * Document text detection model version.
+     * The document text detection model version.
      */
     "textDetectionModelVersion"?: string;
     /**
-     * Document keyValue detection model version.
+     * The document keyValue detection model version.
      */
     "keyValueDetectionModelVersion"?: string;
     /**
-     * Document table detection model version.
+     * The document table detection model version.
      */
     "tableDetectionModelVersion"?: string;
     /**
-     * Errors encountered during document analysis.
+     * The errors encountered during document analysis.
      */
     "errors"?: Array<model.ProcessingError>;
     /**
-     * Generated searchable PDF file.
+     * The searchable PDF file that was generated.
      */
     "searchablePdf"?: string;
 }

package/lib/model/analyze-document-result.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/analyze-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,16 +12,16 @@
  */
 import * as model from "../model";
 /**
- * Details about how to analyze an image.
+ * The details of how to analyze an image.
  */
 export interface AnalyzeImageDetails {
     /**
-     * Types of image analysis.
+     * The types of image analysis.
      */
     "features": Array<model.ImageFeature>;
     "image": model.ObjectStorageImageDetails | model.InlineImageDetails;
     /**
-     * The ocid of the compartment that calls the API.
+     * The OCID of the compartment that calls the API.
      */
     "compartmentId"?: string;
 }

package/lib/model/analyze-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/analyze-image-result.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,36 +12,36 @@
  */
 import * as model from "../model";
 /**
- * Image analysis results.
+ * The image analysis results.
  */
 export interface AnalyzeImageResult {
     /**
-     * Detected objects.
+     * The detected objects.
      */
     "imageObjects"?: Array<model.ImageObject>;
     /**
-     * Image classification labels.
+     * The image classification labels.
      */
     "labels"?: Array<model.Label>;
     /**
-     * ontologyClasses of image labels.
+     * The ontologyClasses of image labels.
      */
     "ontologyClasses"?: Array<model.OntologyClass>;
     "imageText"?: model.ImageText;
     /**
-     * Image classification model version.
+     * The image classification model version.
      */
     "imageClassificationModelVersion"?: string;
     /**
-     * Object detection model version.
+     * The object detection model version.
      */
     "objectDetectionModelVersion"?: string;
     /**
-     * Text detection model version.
+     * The text detection model version.
      */
     "textDetectionModelVersion"?: string;
     /**
-     * Errors encountered during image analysis.
+     * The errors encountered during image analysis.
      */
     "errors"?: Array<model.ProcessingError>;
 }

package/lib/model/analyze-image-result.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/bounding-polygon.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,12 +12,12 @@
  */
 import * as model from "../model";
 /**
- * Object bounding polygon box.
+ * The object-bounding polygon box.
  */
 export interface BoundingPolygon {
     /**
      * An array of normalized points defining the polygon's perimeter, with an implicit segment between subsequent points and between the first and last point.
-     * Rectangles are defined with four points, e.g. `[{\"x\": 0, \"y\": 0}, {\"x\": 1, \"y\": 0}, {\"x\": 1, \"y\": 0.5}, {\"x\": 0, \"y\": 0.5}]` represents the top half of an image.
+     * Rectangles are defined with four points. For example, `[{\"x\": 0, \"y\": 0}, {\"x\": 1, \"y\": 0}, {\"x\": 1, \"y\": 0.5}, {\"x\": 0, \"y\": 0.5}]` represents the top half of an image.
      *
      */
     "normalizedVertices": Array<model.NormalizedVertex>;

package/lib/model/bounding-polygon.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/cell.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,24 +16,24 @@ import * as model from "../model";
  */
 export interface Cell {
     /**
-     * Text recognized in the cell.
+     * The text recognized in the cell.
      */
     "text": string;
     /**
-     * Index of the cell inside the row. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The index of the cell inside the row. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "rowIndex": number;
     /**
-     * Index of the cell inside the column. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The index of the cell inside the column. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "columnIndex": number;
     /**
-     * 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;
     /**
-     * Words detected in the cell.
+     * The words detected in the cell.
      */
     "wordIndexes": Array<number>;
 }

package/lib/model/cell.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/change-model-compartment-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.
  */
 /**
- * Which compartment the model should be moved to.
+ * The compartment the model should be moved to.
  */
 export interface ChangeModelCompartmentDetails {
     /**

package/lib/model/change-model-compartment-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/change-project-compartment-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
  *
  *

package/lib/model/change-project-compartment-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/create-document-job-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,25 +12,25 @@
  */
 import * as model from "../model";
 /**
- * Details about the batch document analysis.
+ * The batch document analysis details.
  */
 export interface CreateDocumentJobDetails {
     "inputLocation": model.ObjectListInlineInputLocation;
     /**
-     * List of document analysis types requested.
+     * The list of requested document analysis types.
      */
     "features": Array<model.DocumentFeature>;
     "outputLocation": model.OutputLocation;
     /**
-     * Compartment identifier from the requester.
+     * The compartment identifier from the requester.
      */
     "compartmentId"?: string;
     /**
-     * Document job display name.
+     * The document job display name.
      */
     "displayName"?: string;
     /**
-     * Language of the document, abbreviated according to ISO 639-2.
+     * The language of the document, abbreviated according to ISO 639-2.
      */
     "language"?: model.DocumentLanguage;
     /**
@@ -38,7 +38,7 @@ export interface CreateDocumentJobDetails {
      */
     "documentType"?: model.DocumentType;
     /**
-     * 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/create-document-job-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/create-image-job-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,25 +12,25 @@
  */
 import * as model from "../model";
 /**
- * Details about the batch image analysis.
+ * The details of the batch image analysis.
  */
 export interface CreateImageJobDetails {
     "inputLocation": model.ObjectListInlineInputLocation;
     /**
-     * List of image analysis types requested.
+     * The list of requested image analysis types.
      */
     "features": Array<model.ImageFeature>;
     "outputLocation": model.OutputLocation;
     /**
-     * Compartment identifier from the requester.
+     * The compartment identifier from the requester.
      */
     "compartmentId"?: string;
     /**
-     * Image job display name.
+     * The image job display name.
      */
     "displayName"?: string;
     /**
-     * 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/create-image-job-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/create-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
  *
  *
@@ -12,47 +12,47 @@
  */
 import * as model from "../model";
 /**
- * Information needed to create a new model.
+ * The information needed to create a new model.
  */
 export interface CreateModelDetails {
     /**
-     * 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;
     /**
-     * Model version
+     * The model version
      */
     "modelVersion"?: string;
     /**
-     * What type of Vision model this is.
+     * Which type of Vision model this is.
      */
     "modelType": string;
     /**
-     * Compartment identifier.
+     * The compartment identifier.
      */
     "compartmentId": string;
     /**
-     * Set to true when experimenting with a new model type or dataset so model training is quick, with a predefined low number of passes through the training data.
+     * Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data.
      */
     "isQuickMode"?: boolean;
     /**
-     * Maximum model training duration in hours, expressed as a decimal fraction. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
+     * The maximum model training duration in hours, expressed as a decimal fraction. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
      */
     "maxTrainingDurationInHours"?: number;
     "trainingDataset": model.DataScienceLabelingDataset | model.ObjectStorageDataset;
     "testingDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
     "validationDataset"?: model.DataScienceLabelingDataset | model.ObjectStorageDataset;
     /**
-     * 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;
     /**
-     * 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"?: {
@@ -60,7 +60,7 @@ export interface CreateModelDetails {
     };
     /**
      * 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/create-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/create-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,24 +11,24 @@
  * 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.
  */
 /**
- * Information needed to create a new project.
+ * The information needed to create a new project.
  */
 export interface CreateProjectDetails {
     /**
-     * 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;
     /**
-     * Compartment identifier.
+     * The compartment identifier.
      */
     "compartmentId": 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"?: {
@@ -36,7 +36,7 @@ export interface CreateProjectDetails {
     };
     /**
      * 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/create-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/data-science-labeling-dataset.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";
 /**
- * Dataset created by the Data Labeling Service.
+ * The dataset created by the Data Labeling Service.
  */
 export interface DataScienceLabelingDataset extends model.Dataset {
     /**

package/lib/model/data-science-labeling-dataset.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/dataset.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
  *
  *