oci-aivision 2.21.0 → 2.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/index.d.ts +2 -2
  2. package/index.js +2 -2
  3. package/lib/aiservicevision-waiter.d.ts +2 -2
  4. package/lib/aiservicevision-waiter.js +2 -2
  5. package/lib/client.d.ts +46 -45
  6. package/lib/client.js +51 -46
  7. package/lib/client.js.map +1 -1
  8. package/lib/model/action-type.d.ts +2 -2
  9. package/lib/model/action-type.js +2 -2
  10. package/lib/model/analyze-document-details.d.ts +6 -6
  11. package/lib/model/analyze-document-details.js +2 -2
  12. package/lib/model/analyze-document-result.d.ts +11 -11
  13. package/lib/model/analyze-document-result.js +2 -2
  14. package/lib/model/analyze-image-details.d.ts +5 -5
  15. package/lib/model/analyze-image-details.js +2 -2
  16. package/lib/model/analyze-image-result.d.ts +10 -10
  17. package/lib/model/analyze-image-result.js +2 -2
  18. package/lib/model/bounding-polygon.d.ts +4 -4
  19. package/lib/model/bounding-polygon.js +2 -2
  20. package/lib/model/cell.d.ts +7 -7
  21. package/lib/model/cell.js +2 -2
  22. package/lib/model/change-model-compartment-details.d.ts +3 -3
  23. package/lib/model/change-model-compartment-details.js +2 -2
  24. package/lib/model/change-project-compartment-details.d.ts +2 -2
  25. package/lib/model/change-project-compartment-details.js +2 -2
  26. package/lib/model/create-document-job-details.d.ts +8 -8
  27. package/lib/model/create-document-job-details.js +2 -2
  28. package/lib/model/create-image-job-details.d.ts +7 -7
  29. package/lib/model/create-image-job-details.js +2 -2
  30. package/lib/model/create-model-details.d.ts +14 -14
  31. package/lib/model/create-model-details.js +2 -2
  32. package/lib/model/create-project-details.d.ts +9 -9
  33. package/lib/model/create-project-details.js +2 -2
  34. package/lib/model/data-science-labeling-dataset.d.ts +3 -3
  35. package/lib/model/data-science-labeling-dataset.js +2 -2
  36. package/lib/model/dataset.d.ts +2 -2
  37. package/lib/model/dataset.js +2 -2
  38. package/lib/model/detected-document-type.d.ts +5 -5
  39. package/lib/model/detected-document-type.js +2 -2
  40. package/lib/model/detected-language.d.ts +5 -5
  41. package/lib/model/detected-language.js +2 -2
  42. package/lib/model/dimensions.d.ts +6 -6
  43. package/lib/model/dimensions.js +2 -2
  44. package/lib/model/document-classification-feature.d.ts +4 -4
  45. package/lib/model/document-classification-feature.js +2 -2
  46. package/lib/model/document-details.d.ts +3 -3
  47. package/lib/model/document-details.js +2 -2
  48. package/lib/model/document-feature.d.ts +3 -3
  49. package/lib/model/document-feature.js +2 -2
  50. package/lib/model/document-field.d.ts +3 -3
  51. package/lib/model/document-field.js +2 -2
  52. package/lib/model/document-job.d.ts +14 -14
  53. package/lib/model/document-job.js +2 -2
  54. package/lib/model/document-key-value-detection-feature.d.ts +2 -2
  55. package/lib/model/document-key-value-detection-feature.js +2 -2
  56. package/lib/model/document-language-classification-feature.d.ts +2 -2
  57. package/lib/model/document-language-classification-feature.js +2 -2
  58. package/lib/model/document-language.d.ts +3 -3
  59. package/lib/model/document-language.js +3 -3
  60. package/lib/model/document-metadata.d.ts +5 -5
  61. package/lib/model/document-metadata.js +2 -2
  62. package/lib/model/document-table-detection-feature.d.ts +2 -2
  63. package/lib/model/document-table-detection-feature.js +2 -2
  64. package/lib/model/document-text-detection-feature.d.ts +3 -3
  65. package/lib/model/document-text-detection-feature.js +2 -2
  66. package/lib/model/document-type.d.ts +3 -3
  67. package/lib/model/document-type.js +3 -3
  68. package/lib/model/field-label.d.ts +5 -5
  69. package/lib/model/field-label.js +2 -2
  70. package/lib/model/field-name.d.ts +6 -6
  71. package/lib/model/field-name.js +2 -2
  72. package/lib/model/field-value.d.ts +6 -6
  73. package/lib/model/field-value.js +2 -2
  74. package/lib/model/image-classification-feature.d.ts +4 -4
  75. package/lib/model/image-classification-feature.js +2 -2
  76. package/lib/model/image-details.d.ts +3 -3
  77. package/lib/model/image-details.js +2 -2
  78. package/lib/model/image-feature.d.ts +3 -3
  79. package/lib/model/image-feature.js +2 -2
  80. package/lib/model/image-job.d.ts +12 -12
  81. package/lib/model/image-job.js +2 -2
  82. package/lib/model/image-object-detection-feature.d.ts +4 -4
  83. package/lib/model/image-object-detection-feature.js +2 -2
  84. package/lib/model/image-object.d.ts +5 -5
  85. package/lib/model/image-object.js +2 -2
  86. package/lib/model/image-text-detection-feature.d.ts +4 -4
  87. package/lib/model/image-text-detection-feature.js +2 -2
  88. package/lib/model/image-text.d.ts +5 -5
  89. package/lib/model/image-text.js +2 -2
  90. package/lib/model/index.d.ts +2 -2
  91. package/lib/model/index.js +2 -2
  92. package/lib/model/inline-document-details.d.ts +4 -4
  93. package/lib/model/inline-document-details.js +2 -2
  94. package/lib/model/inline-image-details.d.ts +4 -4
  95. package/lib/model/inline-image-details.js +2 -2
  96. package/lib/model/input-location.d.ts +3 -3
  97. package/lib/model/input-location.js +2 -2
  98. package/lib/model/label.d.ts +5 -5
  99. package/lib/model/label.js +2 -2
  100. package/lib/model/line.d.ts +6 -6
  101. package/lib/model/line.js +2 -2
  102. package/lib/model/model-collection.d.ts +4 -4
  103. package/lib/model/model-collection.js +2 -2
  104. package/lib/model/model-summary.d.ts +14 -14
  105. package/lib/model/model-summary.js +2 -2
  106. package/lib/model/model.d.ts +22 -22
  107. package/lib/model/model.js +2 -2
  108. package/lib/model/normalized-vertex.d.ts +4 -4
  109. package/lib/model/normalized-vertex.js +2 -2
  110. package/lib/model/object-list-inline-input-location.d.ts +3 -3
  111. package/lib/model/object-list-inline-input-location.js +2 -2
  112. package/lib/model/object-location.d.ts +5 -5
  113. package/lib/model/object-location.js +2 -2
  114. package/lib/model/object-storage-dataset.d.ts +3 -3
  115. package/lib/model/object-storage-dataset.js +2 -2
  116. package/lib/model/object-storage-document-details.d.ts +5 -5
  117. package/lib/model/object-storage-document-details.js +2 -2
  118. package/lib/model/object-storage-image-details.d.ts +6 -6
  119. package/lib/model/object-storage-image-details.js +2 -2
  120. package/lib/model/ontology-class.d.ts +5 -5
  121. package/lib/model/ontology-class.js +2 -2
  122. package/lib/model/operation-status.d.ts +3 -3
  123. package/lib/model/operation-status.js +3 -3
  124. package/lib/model/operation-type.d.ts +2 -2
  125. package/lib/model/operation-type.js +2 -2
  126. package/lib/model/output-location.d.ts +6 -6
  127. package/lib/model/output-location.js +2 -2
  128. package/lib/model/page.d.ts +7 -7
  129. package/lib/model/page.js +2 -2
  130. package/lib/model/processing-error.d.ts +5 -5
  131. package/lib/model/processing-error.js +2 -2
  132. package/lib/model/project-collection.d.ts +3 -3
  133. package/lib/model/project-collection.js +2 -2
  134. package/lib/model/project-summary.d.ts +11 -11
  135. package/lib/model/project-summary.js +2 -2
  136. package/lib/model/project.d.ts +12 -12
  137. package/lib/model/project.js +2 -2
  138. package/lib/model/sort-order.d.ts +2 -2
  139. package/lib/model/sort-order.js +2 -2
  140. package/lib/model/table-row.d.ts +3 -3
  141. package/lib/model/table-row.js +2 -2
  142. package/lib/model/table.d.ts +9 -9
  143. package/lib/model/table.js +2 -2
  144. package/lib/model/update-model-details.d.ts +8 -8
  145. package/lib/model/update-model-details.js +2 -2
  146. package/lib/model/update-project-details.d.ts +8 -8
  147. package/lib/model/update-project-details.js +2 -2
  148. package/lib/model/value-array.d.ts +3 -3
  149. package/lib/model/value-array.js +2 -2
  150. package/lib/model/value-date.d.ts +4 -4
  151. package/lib/model/value-date.js +2 -2
  152. package/lib/model/value-integer.d.ts +4 -4
  153. package/lib/model/value-integer.js +2 -2
  154. package/lib/model/value-number.d.ts +4 -4
  155. package/lib/model/value-number.js +2 -2
  156. package/lib/model/value-phone-number.d.ts +4 -4
  157. package/lib/model/value-phone-number.js +2 -2
  158. package/lib/model/value-string.d.ts +4 -4
  159. package/lib/model/value-string.js +2 -2
  160. package/lib/model/value-time.d.ts +4 -4
  161. package/lib/model/value-time.js +2 -2
  162. package/lib/model/word.d.ts +4 -4
  163. package/lib/model/word.js +2 -2
  164. package/lib/model/work-request-error-collection.d.ts +4 -4
  165. package/lib/model/work-request-error-collection.js +2 -2
  166. package/lib/model/work-request-error.d.ts +3 -3
  167. package/lib/model/work-request-error.js +2 -2
  168. package/lib/model/work-request-log-entry-collection.d.ts +4 -4
  169. package/lib/model/work-request-log-entry-collection.js +2 -2
  170. package/lib/model/work-request-log-entry.d.ts +3 -3
  171. package/lib/model/work-request-log-entry.js +2 -2
  172. package/lib/model/work-request-resource.d.ts +6 -6
  173. package/lib/model/work-request-resource.js +2 -2
  174. package/lib/model/work-request-summary-collection.d.ts +4 -4
  175. package/lib/model/work-request-summary-collection.js +2 -2
  176. package/lib/model/work-request-summary.d.ts +9 -9
  177. package/lib/model/work-request-summary.js +2 -2
  178. package/lib/model/work-request.d.ts +7 -7
  179. package/lib/model/work-request.js +2 -2
  180. package/lib/request/analyze-document-request.d.ts +2 -2
  181. package/lib/request/analyze-image-request.d.ts +1 -1
  182. package/lib/request/cancel-document-job-request.d.ts +1 -1
  183. package/lib/request/cancel-image-job-request.d.ts +1 -1
  184. package/lib/request/cancel-work-request-request.d.ts +1 -1
  185. package/lib/request/change-model-compartment-request.d.ts +3 -3
  186. package/lib/request/change-project-compartment-request.d.ts +2 -2
  187. package/lib/request/create-document-job-request.d.ts +3 -3
  188. package/lib/request/create-image-job-request.d.ts +3 -3
  189. package/lib/request/create-model-request.d.ts +3 -3
  190. package/lib/request/create-project-request.d.ts +3 -3
  191. package/lib/request/delete-model-request.d.ts +2 -2
  192. package/lib/request/delete-project-request.d.ts +2 -2
  193. package/lib/request/get-document-job-request.d.ts +1 -1
  194. package/lib/request/get-image-job-request.d.ts +1 -1
  195. package/lib/request/get-model-request.d.ts +2 -2
  196. package/lib/request/get-project-request.d.ts +2 -2
  197. package/lib/request/get-work-request-request.d.ts +1 -1
  198. package/lib/request/index.d.ts +2 -2
  199. package/lib/request/index.js +2 -2
  200. package/lib/request/list-models-request.d.ts +4 -4
  201. package/lib/request/list-projects-request.d.ts +4 -4
  202. package/lib/request/list-work-request-errors-request.d.ts +2 -2
  203. package/lib/request/list-work-request-logs-request.d.ts +2 -2
  204. package/lib/request/list-work-requests-request.d.ts +3 -3
  205. package/lib/request/update-model-request.d.ts +3 -3
  206. package/lib/request/update-project-request.d.ts +3 -3
  207. package/lib/response/analyze-document-response.d.ts +1 -1
  208. package/lib/response/analyze-image-response.d.ts +1 -1
  209. package/lib/response/cancel-document-job-response.d.ts +1 -1
  210. package/lib/response/cancel-image-job-response.d.ts +1 -1
  211. package/lib/response/cancel-work-request-response.d.ts +1 -1
  212. package/lib/response/change-model-compartment-response.d.ts +1 -1
  213. package/lib/response/change-project-compartment-response.d.ts +1 -1
  214. package/lib/response/create-document-job-response.d.ts +1 -1
  215. package/lib/response/create-image-job-response.d.ts +1 -1
  216. package/lib/response/create-model-response.d.ts +2 -2
  217. package/lib/response/create-project-response.d.ts +2 -2
  218. package/lib/response/delete-model-response.d.ts +2 -2
  219. package/lib/response/delete-project-response.d.ts +2 -2
  220. package/lib/response/get-document-job-response.d.ts +1 -1
  221. package/lib/response/get-image-job-response.d.ts +1 -1
  222. package/lib/response/get-model-response.d.ts +1 -1
  223. package/lib/response/get-project-response.d.ts +1 -1
  224. package/lib/response/get-work-request-response.d.ts +1 -1
  225. package/lib/response/index.d.ts +2 -2
  226. package/lib/response/index.js +2 -2
  227. package/lib/response/list-models-response.d.ts +1 -1
  228. package/lib/response/list-projects-response.d.ts +1 -1
  229. package/lib/response/list-work-request-errors-response.d.ts +1 -1
  230. package/lib/response/list-work-request-logs-response.d.ts +1 -1
  231. package/lib/response/list-work-requests-response.d.ts +1 -1
  232. package/lib/response/update-model-response.d.ts +2 -2
  233. package/lib/response/update-project-response.d.ts +2 -2
  234. package/package.json +3 -3
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Floating point number field value.
15
+ * The floating point number field value.
16
16
  */
17
17
  export interface ValueNumber extends model.FieldValue {
18
18
  /**
19
- * Number value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
19
+ * The number value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
20
20
  */
21
21
  "value": number;
22
22
  "valueType": string;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Phone number field value.
15
+ * The phone number field value.
16
16
  */
17
17
  export interface ValuePhoneNumber extends model.FieldValue {
18
18
  /**
19
- * Phone number field value.
19
+ * The phone number field value.
20
20
  */
21
21
  "value": string;
22
22
  "valueType": string;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * String field value.
15
+ * The string field value.
16
16
  */
17
17
  export interface ValueString extends model.FieldValue {
18
18
  /**
19
- * String text.
19
+ * The string text.
20
20
  */
21
21
  "value": string;
22
22
  "valueType": string;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Time field value
15
+ * The time field value.
16
16
  */
17
17
  export interface ValueTime extends model.FieldValue {
18
18
  /**
19
- * Time field value as yyyy-mm-dd hh-mm-ss.
19
+ * The time field value as yyyy-mm-dd hh-mm-ss.
20
20
  */
21
21
  "value": Date;
22
22
  "valueType": string;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -16,11 +16,11 @@ import * as model from "../model";
16
16
  */
17
17
  export interface Word {
18
18
  /**
19
- * String of text characters in the word.
19
+ * The string of text characters in the word.
20
20
  */
21
21
  "text": string;
22
22
  /**
23
- * Confidence score between 0 to 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
23
+ * the confidence score between 0 and 1. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
24
24
  */
25
25
  "confidence": number;
26
26
  "boundingPolygon": model.BoundingPolygon;
package/lib/model/word.js CHANGED
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Results of a workRequestError search.
15
+ * The results of a workRequestError search.
16
16
  */
17
17
  export interface WorkRequestErrorCollection {
18
18
  /**
19
- * List of workRequestError objects.
19
+ * the list of workRequestError objects.
20
20
  */
21
21
  "items": Array<model.WorkRequestError>;
22
22
  }
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -21,7 +21,7 @@ export interface WorkRequestError {
21
21
  */
22
22
  "code": string;
23
23
  /**
24
- * A human readable description of the issue encountered.
24
+ * A human-readable description of the issue encountered.
25
25
  */
26
26
  "message": string;
27
27
  /**
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Results of a workRequestLog search.
15
+ * The results of a workRequestLog search.
16
16
  */
17
17
  export interface WorkRequestLogEntryCollection {
18
18
  /**
19
- * List of workRequestLogEntries.
19
+ * The list of workRequestLogEntries.
20
20
  */
21
21
  "items": Array<model.WorkRequestLogEntry>;
22
22
  }
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -15,7 +15,7 @@
15
15
  */
16
16
  export interface WorkRequestLogEntry {
17
17
  /**
18
- * Human-readable log message.
18
+ * A human-readable log message.
19
19
  */
20
20
  "message": string;
21
21
  /**
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * A resource created or operated on by a work request.
15
+ * A resource created, or operated on, by a work request.
16
16
  */
17
17
  export interface WorkRequestResource {
18
18
  /**
@@ -21,9 +21,9 @@ export interface WorkRequestResource {
21
21
  "entityType": string;
22
22
  /**
23
23
  * The way in which this resource is affected by the work tracked in the work request.
24
- * A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
25
- * work is complete for that resource at which point it will transition to CREATED, UPDATED,
26
- * or DELETED, respectively.
24
+ * A resource being created, updated, or deleted remains in the IN_PROGRESS state until
25
+ * the work is complete for. At that point, it transitions to CREATED, UPDATED,
26
+ * or DELETED, as appropriate.
27
27
  *
28
28
  */
29
29
  "actionType": model.ActionType;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,11 +12,11 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Results of a workRequest search.
15
+ * The results of a workRequest search.
16
16
  */
17
17
  export interface WorkRequestSummaryCollection {
18
18
  /**
19
- * List of workRequestSummary objects.
19
+ * The list of workRequestSummary objects.
20
20
  */
21
21
  "items": Array<model.WorkRequestSummary>;
22
22
  }
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,26 +12,26 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * Summary of the status of a work request.
15
+ * A summary of the status of a work request.
16
16
  */
17
17
  export interface WorkRequestSummary {
18
18
  /**
19
- * Type of the work request.
19
+ * The type of the work request.
20
20
  */
21
21
  "operationType": model.OperationType;
22
22
  /**
23
- * Status of current work request.
23
+ * The status of the current work request.
24
24
  */
25
25
  "status": model.OperationStatus;
26
26
  /**
27
- * The id of the work request.
27
+ * The ID of the work request.
28
28
  */
29
29
  "id": string;
30
30
  /**
31
- * The ocid of the compartment that contains the work request. Work requests should be scoped to
31
+ * The OCID of the compartment that contains the work request. Work requests should be scoped to
32
32
  * the same compartment as the resource the work request affects. If the work request affects multiple resources,
33
33
  * and those resources are not in the same compartment, it is up to the service team to pick the primary
34
- * resource whose compartment should be used.
34
+ * resource whose compartment is used.
35
35
  *
36
36
  */
37
37
  "compartmentId": string;
@@ -40,7 +40,7 @@ export interface WorkRequestSummary {
40
40
  */
41
41
  "resources": Array<model.WorkRequestResource>;
42
42
  /**
43
- * Percentage of the request completed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
43
+ * The percentage of the request completed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
44
44
  */
45
45
  "percentComplete": number;
46
46
  /**
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * VisionService API
3
- * A description of the VisionService API.
2
+ * Vision API
3
+ * 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.
4
4
  * OpenAPI spec version: 20220125
5
5
  *
6
6
  *
@@ -12,19 +12,19 @@
12
12
  */
13
13
  import * as model from "../model";
14
14
  /**
15
- * A description of workrequest status.
15
+ * The workrequest status details.
16
16
  */
17
17
  export interface WorkRequest {
18
18
  /**
19
- * Type of the work request.
19
+ * The type of work request.
20
20
  */
21
21
  "operationType": model.OperationType;
22
22
  /**
23
- * Status of current work request.
23
+ * The status of the current work request.
24
24
  */
25
25
  "status": model.OperationStatus;
26
26
  /**
27
- * The id of the work request.
27
+ * The ID of the work request.
28
28
  */
29
29
  "id": string;
30
30
  /**
@@ -38,7 +38,7 @@ export interface WorkRequest {
38
38
  */
39
39
  "resources": Array<model.WorkRequestResource>;
40
40
  /**
41
- * Percentage of the request completed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
41
+ * The percentage of the request completed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
42
42
  */
43
43
  "percentComplete": number;
44
44
  /**
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
- * VisionService API
4
- * A description of the VisionService API.
3
+ * Vision API
4
+ * 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.
5
5
  * OpenAPI spec version: 20220125
6
6
  *
7
7
  *
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/AnalyzeDocument.ts.html |here} to see how to use AnalyzeDocumentRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/AnalyzeDocument.ts.html |here} to see how to use AnalyzeDocumentRequest.
17
17
  */
18
18
  export interface AnalyzeDocumentRequest extends common.BaseRequest {
19
19
  /**
20
- * Details about how to analyze a document.
20
+ * The details of how to analyze a document.
21
21
  */
22
22
  "analyzeDocumentDetails": model.AnalyzeDocumentDetails;
23
23
  /**
@@ -13,7 +13,7 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/AnalyzeImage.ts.html |here} to see how to use AnalyzeImageRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/AnalyzeImage.ts.html |here} to see how to use AnalyzeImageRequest.
17
17
  */
18
18
  export interface AnalyzeImageRequest extends common.BaseRequest {
19
19
  /**
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/CancelDocumentJob.ts.html |here} to see how to use CancelDocumentJobRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/CancelDocumentJob.ts.html |here} to see how to use CancelDocumentJobRequest.
16
16
  */
17
17
  export interface CancelDocumentJobRequest extends common.BaseRequest {
18
18
  /**
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/CancelImageJob.ts.html |here} to see how to use CancelImageJobRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/CancelImageJob.ts.html |here} to see how to use CancelImageJobRequest.
16
16
  */
17
17
  export interface CancelImageJobRequest extends common.BaseRequest {
18
18
  /**
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequestRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequestRequest.
16
16
  */
17
17
  export interface CancelWorkRequestRequest extends common.BaseRequest {
18
18
  /**
@@ -13,15 +13,15 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartmentRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/ChangeModelCompartment.ts.html |here} to see how to use ChangeModelCompartmentRequest.
17
17
  */
18
18
  export interface ChangeModelCompartmentRequest extends common.BaseRequest {
19
19
  /**
20
- * unique model identifier.
20
+ * A unique model identifier.
21
21
  */
22
22
  "modelId": string;
23
23
  /**
24
- * The deatils of the move.
24
+ * The details of the move.
25
25
  */
26
26
  "changeModelCompartmentDetails": model.ChangeModelCompartmentDetails;
27
27
  /**
@@ -13,11 +13,11 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartmentRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/ChangeProjectCompartment.ts.html |here} to see how to use ChangeProjectCompartmentRequest.
17
17
  */
18
18
  export interface ChangeProjectCompartmentRequest extends common.BaseRequest {
19
19
  /**
20
- * unique project identifier.
20
+ * A unique project identifier.
21
21
  */
22
22
  "projectId": string;
23
23
  /**
@@ -13,16 +13,16 @@
13
13
  import * as model from "../model";
14
14
  import common = require("oci-common");
15
15
  /**
16
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.21.0/aivision/CreateDocumentJob.ts.html |here} to see how to use CreateDocumentJobRequest.
16
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.25.0/aivision/CreateDocumentJob.ts.html |here} to see how to use CreateDocumentJobRequest.
17
17
  */
18
18
  export interface CreateDocumentJobRequest extends common.BaseRequest {
19
19
  /**
20
- * Details about the batch document analysis.
20
+ * The details of the batch document analysis.
21
21
  */
22
22
  "createDocumentJobDetails": model.CreateDocumentJobDetails;
23
23
  /**
24
24
  * A token that uniquely identifies a request so it can be retried in case of a timeout or
25
- * server error without risk of executing that same action again. Retry tokens expire after 24
25
+ * server error without the risk of executing that same action again. Retry tokens expire after 24
26
26
  * hours, but can be invalidated before then due to conflicting operations. For example, if a resource
27
27
  * has been deleted and purged from the system, then a retry of the original creation request
28
28
  * might be rejected.