AI Document Common Types
DBMS_CLOUD_OCI_AI_DOCUMENT_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_FEATURE_T Type
The type of document analysis.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_feature_t FORCE AUTHID CURRENT_USER IS OBJECT (
feature_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_feature_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_feature_t (
feature_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The type of document analysis requested. The allowed values are: - `LANGUAGE_CLASSIFICATION`: Detect the language. - `TEXT_EXTRACTION`: Recognize text. - `TABLE_EXTRACTION`: Detect and extract data in tables. - `KEY_VALUE_EXTRACTION`: Extract form fields. - `DOCUMENT_CLASSIFICATION`: Identify the type of document. Allowed values are: 'LANGUAGE_CLASSIFICATION', 'TEXT_EXTRACTION', 'TABLE_EXTRACTION', 'KEY_VALUE_EXTRACTION', 'DOCUMENT_CLASSIFICATION' |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_DETAILS_T Type
The details of a document to analyze.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
source varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_details_t (
source varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The location of the document data. The allowed values are: - `INLINE`: The data is included directly in the request payload. - `OBJECT_STORAGE`: The document is in OCI Object Storage. Allowed values are: 'INLINE', 'OBJECT_STORAGE' |
DBMS_CLOUD_OCI_AI_DOCUMENT_OUTPUT_LOCATION_T Type
The object storage location where to store analysis results.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_output_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
namespace_name varchar2(32767),
bucket_name varchar2(32767),
prefix varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_output_location_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_output_location_t (
namespace_name varchar2,
bucket_name varchar2,
prefix varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The Object Storage namespace. |
|
(required) The Object Storage bucket name. |
|
(required) The Object Storage folder name. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_METADATA_T Type
The document information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_metadata_t FORCE AUTHID CURRENT_USER IS OBJECT (
page_count number,
mime_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_metadata_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_metadata_t (
page_count number,
mime_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) Teh number of pages in the document. |
|
(required) The result data format. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DIMENSIONS_T Type
The width and height of a page.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_dimensions_t FORCE AUTHID CURRENT_USER IS OBJECT (
width number,
height number,
unit varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_dimensions_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_dimensions_t (
width number,
height number,
unit varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) the width of a page. |
|
(required) The height of a page. |
|
(required) The unit of length. Allowed values are: 'PIXEL', 'INCH' |
DBMS_CLOUD_OCI_AI_DOCUMENT_DETECTED_DOCUMENT_TYPE_T Type
The detected document type.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_detected_document_type_t FORCE AUTHID CURRENT_USER IS OBJECT (
document_type varchar2(32767),
document_id varchar2(32767),
confidence number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_detected_document_type_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_detected_document_type_t (
document_type varchar2,
document_id varchar2,
confidence number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The document type. |
|
(optional) The OCID of the Key-Value Extraction model that was used to extract the key-value pairs. |
|
(required) The confidence score between 0 and 1. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DETECTED_LANGUAGE_T Type
The language detected in a document.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_detected_language_t FORCE AUTHID CURRENT_USER IS OBJECT (
language varchar2(32767),
confidence number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_detected_language_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_detected_language_t (
language varchar2,
confidence number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The document language, abbreviated according to the BCP 47 syntax. |
|
(required) The confidence score between 0 and 1. |
DBMS_CLOUD_OCI_AI_DOCUMENT_NORMALIZED_VERTEX_T Type
An (x, y) coordinate in the image with dimensions normalized from zero to one. The origin is at top left, with the positive x-axis pointing right and the positive y-axis pointing down. The bottom right corner is at (1, 1).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_normalized_vertex_t FORCE AUTHID CURRENT_USER IS OBJECT (
x number,
y number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_normalized_vertex_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_normalized_vertex_t (
x number,
y number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The X-axis normalized coordinate. |
|
(required) The Y-axis normalized coordinate. |
DBMS_CLOUD_OCI_AI_DOCUMENT_NORMALIZED_VERTEX_TBL Type
Nested table type of dbms_cloud_oci_ai_document_normalized_vertex_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_normalized_vertex_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_normalized_vertex_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_BOUNDING_POLYGON_T Type
The object-bounding polygon box.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_bounding_polygon_t FORCE AUTHID CURRENT_USER IS OBJECT (
normalized_vertices dbms_cloud_oci_ai_document_normalized_vertex_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_bounding_polygon_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_bounding_polygon_t (
normalized_vertices dbms_cloud_oci_ai_document_normalized_vertex_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) 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. 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. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORD_T Type
A single word.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_word_t FORCE AUTHID CURRENT_USER IS OBJECT (
text varchar2(32767),
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_word_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_word_t (
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The string of text characters in the word. |
|
(required) the confidence score between 0 and 1. |
|
(required) |
DBMS_CLOUD_OCI_AI_DOCUMENT_NUMBER_TBL Type
Nested table type of number.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_number_tbl FORCE IS TABLE OF (number) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_LINE_T Type
The line of text.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_line_t FORCE AUTHID CURRENT_USER IS OBJECT (
text varchar2(32767),
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_line_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_line_t (
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The text recognized. |
|
(required) The confidence score between 0 and 1. |
|
(required) |
|
(required) The array of words. |
DBMS_CLOUD_OCI_AI_DOCUMENT_CELL_T Type
A single cell in a table.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_cell_t FORCE AUTHID CURRENT_USER IS OBJECT (
text varchar2(32767),
row_index number,
column_index number,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_cell_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_cell_t (
text varchar2,
row_index number,
column_index number,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The text recognized in the cell. |
|
(required) The index of the cell inside the row. |
|
(required) The index of the cell inside the column. |
|
(required) The confidence score between 0 and 1. |
|
(required) |
|
(required) The words detected in the cell. |
DBMS_CLOUD_OCI_AI_DOCUMENT_CELL_TBL Type
Nested table type of dbms_cloud_oci_ai_document_cell_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_cell_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_cell_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_TABLE_ROW_T Type
A single row in a table.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_table_row_t FORCE AUTHID CURRENT_USER IS OBJECT (
cells dbms_cloud_oci_ai_document_cell_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_table_row_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_table_row_t (
cells dbms_cloud_oci_ai_document_cell_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The cells in the row. |
DBMS_CLOUD_OCI_AI_DOCUMENT_TABLE_ROW_TBL Type
Nested table type of dbms_cloud_oci_ai_document_table_row_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_table_row_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_table_row_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_TABLE_T Type
The table extracted from a document.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_table_t FORCE AUTHID CURRENT_USER IS OBJECT (
row_count number,
column_count number,
header_rows dbms_cloud_oci_ai_document_table_row_tbl,
body_rows dbms_cloud_oci_ai_document_table_row_tbl,
footer_rows dbms_cloud_oci_ai_document_table_row_tbl,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_table_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_table_t (
row_count number,
column_count number,
header_rows dbms_cloud_oci_ai_document_table_row_tbl,
body_rows dbms_cloud_oci_ai_document_table_row_tbl,
footer_rows dbms_cloud_oci_ai_document_table_row_tbl,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The number of rows. |
|
(required) The number of columns. |
|
(required) The header rows. |
|
(required) The body rows. |
|
(required) the footer rows. |
|
(required) The confidence score between 0 and 1. |
|
(required) |
DBMS_CLOUD_OCI_AI_DOCUMENT_FIELD_LABEL_T Type
The label in a field.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_field_label_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
confidence number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_field_label_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_field_label_t (
name varchar2,
confidence number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The name of the field label. |
|
(optional) The confidence score between 0 and 1. |
DBMS_CLOUD_OCI_AI_DOCUMENT_FIELD_NAME_T Type
The name of a form field.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_field_name_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_field_name_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_field_name_t (
name varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The name of the field. |
|
(optional) The confidence score between 0 and 1. |
|
(optional) |
|
(optional) The indexes of the words in the field name. |
DBMS_CLOUD_OCI_AI_DOCUMENT_FIELD_VALUE_T Type
The value of a form field.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_field_value_t FORCE AUTHID CURRENT_USER IS OBJECT (
value_type varchar2(32767),
text varchar2(32767),
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_field_value_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_field_value_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The type of data detected. Allowed values are: 'STRING', 'DATE', 'TIME', 'PHONE_NUMBER', 'NUMBER', 'INTEGER', 'ARRAY' |
|
(optional) The detected text of a field. |
|
(required) The confidence score between 0 and 1. |
|
(required) |
|
(required) The indexes of the words in the field value. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_FIELD_T Type
Form field.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_field_t FORCE AUTHID CURRENT_USER IS OBJECT (
field_type varchar2(32767),
field_label dbms_cloud_oci_ai_document_field_label_t,
field_name dbms_cloud_oci_ai_document_field_name_t,
field_value dbms_cloud_oci_ai_document_field_value_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_field_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_field_t (
field_type varchar2,
field_label dbms_cloud_oci_ai_document_field_label_t,
field_name dbms_cloud_oci_ai_document_field_name_t,
field_value dbms_cloud_oci_ai_document_field_value_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The field type. Allowed values are: 'LINE_ITEM_GROUP', 'LINE_ITEM', 'LINE_ITEM_FIELD', 'KEY_VALUE' |
|
(optional) |
|
(optional) |
|
(required) |
DBMS_CLOUD_OCI_AI_DOCUMENT_DETECTED_DOCUMENT_TYPE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_detected_document_type_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_detected_document_type_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_detected_document_type_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_DETECTED_LANGUAGE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_detected_language_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_detected_language_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_detected_language_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_WORD_TBL Type
Nested table type of dbms_cloud_oci_ai_document_word_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_word_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_word_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_LINE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_line_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_line_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_line_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_TABLE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_table_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_table_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_table_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_FIELD_TBL Type
Nested table type of dbms_cloud_oci_ai_document_document_field_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_field_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_document_field_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_PAGE_T Type
One page document analysis result.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_page_t FORCE AUTHID CURRENT_USER IS OBJECT (
page_number number,
dimensions dbms_cloud_oci_ai_document_dimensions_t,
detected_document_types dbms_cloud_oci_ai_document_detected_document_type_tbl,
detected_languages dbms_cloud_oci_ai_document_detected_language_tbl,
words dbms_cloud_oci_ai_document_word_tbl,
lines dbms_cloud_oci_ai_document_line_tbl,
tables dbms_cloud_oci_ai_document_table_tbl,
document_fields dbms_cloud_oci_ai_document_document_field_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_page_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_page_t (
page_number number,
dimensions dbms_cloud_oci_ai_document_dimensions_t,
detected_document_types dbms_cloud_oci_ai_document_detected_document_type_tbl,
detected_languages dbms_cloud_oci_ai_document_detected_language_tbl,
words dbms_cloud_oci_ai_document_word_tbl,
lines dbms_cloud_oci_ai_document_line_tbl,
tables dbms_cloud_oci_ai_document_table_tbl,
document_fields dbms_cloud_oci_ai_document_document_field_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The document page number. |
|
(optional) |
|
(optional) An array of detected document types. |
|
(optional) An array of detected languages. |
|
(optional) The words detected on the page. |
|
(optional) The lines of text detected on the page. |
|
(optional) The tables detected on the page. |
|
(optional) The form fields detected on the page. |
DBMS_CLOUD_OCI_AI_DOCUMENT_PROCESSING_ERROR_T Type
The error in document processing.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_processing_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_processing_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_processing_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The error code. |
|
(required) The error message. |
DBMS_CLOUD_OCI_AI_DOCUMENT_PAGE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_page_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_page_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_page_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_PROCESSING_ERROR_TBL Type
Nested table type of dbms_cloud_oci_ai_document_processing_error_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_processing_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_processing_error_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_ANALYZE_DOCUMENT_RESULT_T Type
The document analysis results.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_analyze_document_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
document_metadata dbms_cloud_oci_ai_document_document_metadata_t,
pages dbms_cloud_oci_ai_document_page_tbl,
detected_document_types dbms_cloud_oci_ai_document_detected_document_type_tbl,
detected_languages dbms_cloud_oci_ai_document_detected_language_tbl,
document_classification_model_version varchar2(32767),
language_classification_model_version varchar2(32767),
text_extraction_model_version varchar2(32767),
key_value_extraction_model_version varchar2(32767),
table_extraction_model_version varchar2(32767),
errors dbms_cloud_oci_ai_document_processing_error_tbl,
searchable_pdf clob,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_analyze_document_result_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_analyze_document_result_t (
document_metadata dbms_cloud_oci_ai_document_document_metadata_t,
pages dbms_cloud_oci_ai_document_page_tbl,
detected_document_types dbms_cloud_oci_ai_document_detected_document_type_tbl,
detected_languages dbms_cloud_oci_ai_document_detected_language_tbl,
document_classification_model_version varchar2,
language_classification_model_version varchar2,
text_extraction_model_version varchar2,
key_value_extraction_model_version varchar2,
table_extraction_model_version varchar2,
errors dbms_cloud_oci_ai_document_processing_error_tbl,
searchable_pdf clob
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) |
|
(required) The array of a Page. |
|
(optional) An array of detected document types. |
|
(optional) An array of detected languages. |
|
(optional) The document classification model version. |
|
(optional) The document language classification model version. |
|
(optional) The document text extraction model version. |
|
(optional) The document keyValue extraction model version. |
|
(optional) The document table extraction model version. |
|
(optional) The errors encountered during document analysis. |
|
(optional) The searchable PDF file that was generated. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_FEATURE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_document_feature_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_feature_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_document_feature_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_ANALYZE_DOCUMENT_DETAILS_T Type
The details of how to analyze a document.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_analyze_document_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
features dbms_cloud_oci_ai_document_document_feature_tbl,
document dbms_cloud_oci_ai_document_document_details_t,
compartment_id varchar2(32767),
output_location dbms_cloud_oci_ai_document_output_location_t,
language varchar2(32767),
document_type varchar2(32767),
ocr_data dbms_cloud_oci_ai_document_analyze_document_result_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_analyze_document_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_analyze_document_details_t (
features dbms_cloud_oci_ai_document_document_feature_tbl,
document dbms_cloud_oci_ai_document_document_details_t,
compartment_id varchar2,
output_location dbms_cloud_oci_ai_document_output_location_t,
language varchar2,
document_type varchar2,
ocr_data dbms_cloud_oci_ai_document_analyze_document_result_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The types of document analysis requested. |
|
(required) |
|
(optional) The compartment identifier. |
|
(optional) |
|
(optional) The document language, abbreviated according to the BCP 47 syntax. |
|
(optional) The document type. Allowed values are: 'INVOICE', 'RECEIPT', 'RESUME', 'TAX_FORM', 'DRIVER_LICENSE', 'PASSPORT', 'BANK_STATEMENT', 'CHECK', 'PAYSLIP', 'OTHERS' |
|
(optional) |
DBMS_CLOUD_OCI_AI_DOCUMENT_CHANGE_MODEL_COMPARTMENT_DETAILS_T Type
The compartment the model should be moved to.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_change_model_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_change_model_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_change_model_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The compartment identifier. |
DBMS_CLOUD_OCI_AI_DOCUMENT_CHANGE_PROJECT_COMPARTMENT_DETAILS_T Type
Which compartment the project should be moved to.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_change_project_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_change_project_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_change_project_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The compartment identifier. |
DBMS_CLOUD_OCI_AI_DOCUMENT_COMPONENT_MODEL_T Type
The custom model selected for Composition.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_component_model_t FORCE AUTHID CURRENT_USER IS OBJECT (
model_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_component_model_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_component_model_t (
model_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) The OCID of active custom Key Value model that need to be composed. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DATASET_T Type
The base entity which is the input for creating and training a model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_dataset_t FORCE AUTHID CURRENT_USER IS OBJECT (
dataset_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_dataset_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_dataset_t (
dataset_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The dataset type, based on where it is stored. Allowed values are: 'DATA_SCIENCE_LABELING', 'OBJECT_STORAGE' |
DBMS_CLOUD_OCI_AI_DOCUMENT_COMPONENT_MODEL_TBL Type
Nested table type of dbms_cloud_oci_ai_document_component_model_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_component_model_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_component_model_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_CREATE_MODEL_DETAILS_T Type
The information needed to create a new model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_create_model_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
model_version varchar2(32767),
model_type varchar2(32767),
compartment_id varchar2(32767),
is_quick_mode number,
max_training_time_in_hours number,
training_dataset dbms_cloud_oci_ai_document_dataset_t,
testing_dataset dbms_cloud_oci_ai_document_dataset_t,
validation_dataset dbms_cloud_oci_ai_document_dataset_t,
component_models dbms_cloud_oci_ai_document_component_model_tbl,
alias_name varchar2(32767),
project_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_create_model_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_create_model_details_t (
display_name varchar2,
description varchar2,
model_version varchar2,
model_type varchar2,
compartment_id varchar2,
is_quick_mode number,
max_training_time_in_hours number,
training_dataset dbms_cloud_oci_ai_document_dataset_t,
testing_dataset dbms_cloud_oci_ai_document_dataset_t,
validation_dataset dbms_cloud_oci_ai_document_dataset_t,
component_models dbms_cloud_oci_ai_document_component_model_tbl,
alias_name varchar2,
project_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) A human-friendly name for the model, which can be changed. |
|
(optional) An optional description of the model. |
|
(optional) The model version |
|
(required) The type of the Document model. |
|
(required) The compartment identifier. |
|
(optional) 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. |
|
(optional) The maximum model training time in hours, expressed as a decimal fraction. |
|
(optional) |
|
(optional) |
|
(optional) |
|
(optional) The OCID list of active custom Key Value models that need to be composed. |
|
(optional) the alias name of the model. |
|
(required) The OCID of the project that contains the model. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_INPUT_LOCATION_T Type
The location of the inputs.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_input_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
source_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_input_location_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_input_location_t (
source_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The type of input location. The allowed values are: - `OBJECT_STORAGE_LOCATIONS`: A list of object locations in Object Storage. - `INLINE_DOCUMENT_CONTENT`: The content of an inline document. Allowed values are: 'OBJECT_STORAGE_LOCATIONS', 'INLINE_DOCUMENT_CONTENT' |
DBMS_CLOUD_OCI_AI_DOCUMENT_PROCESSOR_CONFIG_T Type
The configuration of a processor.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_processor_config_t FORCE AUTHID CURRENT_USER IS OBJECT (
processor_type varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_processor_config_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_processor_config_t (
processor_type varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The type of the processor. Allowed values are: 'GENERAL' |
DBMS_CLOUD_OCI_AI_DOCUMENT_CREATE_PROCESSOR_JOB_DETAILS_T Type
The details used to create a processor job.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_create_processor_job_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
input_location dbms_cloud_oci_ai_document_input_location_t,
output_location dbms_cloud_oci_ai_document_output_location_t,
compartment_id varchar2(32767),
display_name varchar2(32767),
processor_config dbms_cloud_oci_ai_document_processor_config_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_create_processor_job_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_create_processor_job_details_t (
input_location dbms_cloud_oci_ai_document_input_location_t,
output_location dbms_cloud_oci_ai_document_output_location_t,
compartment_id varchar2,
display_name varchar2,
processor_config dbms_cloud_oci_ai_document_processor_config_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) |
|
(required) |
|
(required) The compartment identifier. |
|
(optional) The display name of the processor job. |
|
(required) |
DBMS_CLOUD_OCI_AI_DOCUMENT_CREATE_PROJECT_DETAILS_T Type
The information needed to create a new project.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_create_project_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_create_project_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_create_project_details_t (
display_name varchar2,
description varchar2,
compartment_id varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) A human-friendly name for the project, that can be changed. |
|
(optional) An optional description of the project. |
|
(required) The compartment identifier. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_DATA_SCIENCE_LABELING_DATASET_T Type
The dataset created by the Data Labeling Service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_data_science_labeling_dataset_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_dataset_t (
dataset_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_data_science_labeling_dataset_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_data_science_labeling_dataset_t (
dataset_type varchar2,
dataset_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_data_science_labeling_dataset_t
is a subtype of the dbms_cloud_oci_ai_document_dataset_t
type.
Fields
Field | Description |
---|---|
|
(required) OCID of the Data Labeling dataset. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DATASET_SUMMARY_T Type
Summary of count of samples used during model training.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_dataset_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
training_sample_count number,
validation_sample_count number,
test_sample_count number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_dataset_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_dataset_summary_t (
training_sample_count number,
validation_sample_count number,
test_sample_count number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) Number of samples used for training the model. |
|
(optional) Number of samples used for validating the model. |
|
(optional) Number of samples used for testing the model. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_CONFIDENCE_ENTRY_T Type
Confidence Entry.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_confidence_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
threshold number,
precision number,
recall number,
f1_score number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_confidence_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_confidence_entry_t (
threshold number,
precision number,
recall number,
f1_score number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) Threshold used to calculate precision and recall. |
|
(required) Precision under the threshold |
|
(required) Recall under the threshold |
|
(required) f1Score under the threshold |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_FEATURE_T Type
Identifying the document type.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_feature_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_feature_t (
max_results number,
model_id varchar2(32767),
tenancy_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_feature_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_feature_t (
feature_type varchar2,
max_results number,
model_id varchar2,
tenancy_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_document_classification_feature_t
is a subtype of the dbms_cloud_oci_ai_document_document_feature_t
type.
Fields
Field | Description |
---|---|
|
(optional) The maximum number of results to return. |
|
(optional) The custom model ID. |
|
(optional) The custom model tenancy ID when modelId represents aliasName. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_CONFIDENCE_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_ai_document_document_classification_confidence_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_confidence_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_document_classification_confidence_entry_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_LABEL_METRICS_REPORT_T Type
Label Metrics report for Document Classification Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_label_metrics_report_t FORCE AUTHID CURRENT_USER IS OBJECT (
label varchar2(32767),
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_document_classification_confidence_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_label_metrics_report_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_label_metrics_report_t (
label varchar2,
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_document_classification_confidence_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) Label name |
|
(required) Mean average precision under different thresholds |
|
(required) List of document classification confidence report. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_OVERALL_METRICS_REPORT_T Type
Overall Metrics report for Document Classification Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_overall_metrics_report_t FORCE AUTHID CURRENT_USER IS OBJECT (
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_document_classification_confidence_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_overall_metrics_report_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_overall_metrics_report_t (
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_document_classification_confidence_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) Mean average precision under different thresholds |
|
(required) List of document classification confidence report. |
DBMS_CLOUD_OCI_AI_DOCUMENT_MODEL_METRICS_T Type
Trained Model Metrics.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_model_metrics_t FORCE AUTHID CURRENT_USER IS OBJECT (
model_type varchar2(32767),
dataset_summary dbms_cloud_oci_ai_document_dataset_summary_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_metrics_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_metrics_t (
model_type varchar2,
dataset_summary dbms_cloud_oci_ai_document_dataset_summary_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;
Fields
Field | Description |
---|---|
|
(required) The type of custom model trained. Allowed values are: 'KEY_VALUE_EXTRACTION', 'DOCUMENT_CLASSIFICATION' |
|
(optional) |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_LABEL_METRICS_REPORT_TBL Type
Nested table type of dbms_cloud_oci_ai_document_document_classification_label_metrics_report_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_label_metrics_report_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_document_classification_label_metrics_report_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_CLASSIFICATION_MODEL_METRICS_T Type
Metrics for Document Classification Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_classification_model_metrics_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_model_metrics_t (
label_metrics_report dbms_cloud_oci_ai_document_document_classification_label_metrics_report_tbl,
overall_metrics_report dbms_cloud_oci_ai_document_document_classification_overall_metrics_report_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_model_metrics_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_classification_model_metrics_t (
model_type varchar2,
dataset_summary dbms_cloud_oci_ai_document_dataset_summary_t,
label_metrics_report dbms_cloud_oci_ai_document_document_classification_label_metrics_report_tbl,
overall_metrics_report dbms_cloud_oci_ai_document_document_classification_overall_metrics_report_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_document_classification_model_metrics_t
is a subtype of the dbms_cloud_oci_ai_document_model_metrics_t
type.
Fields
Field | Description |
---|---|
|
(required) List of metrics entries per label. |
|
(required) |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_KEY_VALUE_EXTRACTION_FEATURE_T Type
Extracting form fields.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_key_value_extraction_feature_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_feature_t (
model_id varchar2(32767),
tenancy_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_key_value_extraction_feature_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_key_value_extraction_feature_t (
feature_type varchar2,
model_id varchar2,
tenancy_id varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_document_key_value_extraction_feature_t
is a subtype of the dbms_cloud_oci_ai_document_document_feature_t
type.
Fields
Field | Description |
---|---|
|
(optional) The custom model ID. |
|
(optional) The custom model tenancy ID when modelId represents aliasName. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_LANGUAGE_CLASSIFICATION_FEATURE_T Type
Detecting the language of the document.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_language_classification_feature_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_feature_t (
max_results number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_language_classification_feature_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_language_classification_feature_t (
feature_type varchar2,
max_results number
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_document_language_classification_feature_t
is a subtype of the dbms_cloud_oci_ai_document_document_feature_t
type.
Fields
Field | Description |
---|---|
|
(optional) The maximum number of results to return. |
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_TABLE_EXTRACTION_FEATURE_T Type
Detecting and extracting data in tables.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_table_extraction_feature_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_feature_t (
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_table_extraction_feature_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_table_extraction_feature_t (
feature_type varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_document_table_extraction_feature_t
is a subtype of the dbms_cloud_oci_ai_document_document_feature_t
type.
DBMS_CLOUD_OCI_AI_DOCUMENT_DOCUMENT_TEXT_EXTRACTION_FEATURE_T Type
Text recognition
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_document_text_extraction_feature_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_feature_t (
generate_searchable_pdf number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_text_extraction_feature_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_document_text_extraction_feature_t (
feature_type varchar2,
generate_searchable_pdf number
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_document_text_extraction_feature_t
is a subtype of the dbms_cloud_oci_ai_document_document_feature_t
type.
Fields
Field | Description |
---|---|
|
(optional) Whether or not to generate a searchable PDF file. |
DBMS_CLOUD_OCI_AI_DOCUMENT_ERROR_T Type
Error Information.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A short error code for programmatic parsing. |
|
(required) A human-readable error message. |
DBMS_CLOUD_OCI_AI_DOCUMENT_GENERAL_PROCESSOR_CONFIG_T Type
The configuration of a general processor.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_general_processor_config_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_processor_config_t (
document_type varchar2(32767),
features dbms_cloud_oci_ai_document_document_feature_tbl,
is_zip_output_enabled number,
language varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_general_processor_config_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_general_processor_config_t (
processor_type varchar2,
document_type varchar2,
features dbms_cloud_oci_ai_document_document_feature_tbl,
is_zip_output_enabled number,
language varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_general_processor_config_t
is a subtype of the dbms_cloud_oci_ai_document_processor_config_t
type.
Fields
Field | Description |
---|---|
|
(optional) The document type. Allowed values are: 'INVOICE', 'RECEIPT', 'RESUME', 'TAX_FORM', 'DRIVER_LICENSE', 'PASSPORT', 'BANK_STATEMENT', 'CHECK', 'PAYSLIP', 'OTHERS' |
|
(required) The types of document analysis requested. |
|
(optional) Whether or not to generate a ZIP file containing the results. |
|
(optional) The document language, abbreviated according to the BCP 47 Language-Tag syntax. |
DBMS_CLOUD_OCI_AI_DOCUMENT_INLINE_DOCUMENT_CONTENT_T Type
The content of an inline document.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_inline_document_content_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_input_location_t (
data clob,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_inline_document_content_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_inline_document_content_t (
source_type varchar2,
data clob
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_inline_document_content_t
is a subtype of the dbms_cloud_oci_ai_document_input_location_t
type.
Fields
Field | Description |
---|---|
|
(required) Raw document data with Base64 encoding. |
DBMS_CLOUD_OCI_AI_DOCUMENT_INLINE_DOCUMENT_DETAILS_T Type
The document incorporated in the request payload.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_inline_document_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_details_t (
data clob,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_inline_document_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_inline_document_details_t (
source varchar2,
data clob
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_inline_document_details_t
is a subtype of the dbms_cloud_oci_ai_document_document_details_t
type.
Fields
Field | Description |
---|---|
|
(required) Raw document data with Base64 encoding. |
DBMS_CLOUD_OCI_AI_DOCUMENT_KEY_VALUE_DETECTION_CONFIDENCE_ENTRY_T Type
Key Value Detection Confidence Entry.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
threshold number,
precision number,
recall number,
f1_score number,
accuracy number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_t (
threshold number,
precision number,
recall number,
f1_score number,
accuracy number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) Threshold used to calculate precision and recall. |
|
(required) Precision under the threshold |
|
(required) Recall under the threshold |
|
(required) f1Score under the threshold |
|
(required) accuracy under the threshold |
DBMS_CLOUD_OCI_AI_DOCUMENT_KEY_VALUE_DETECTION_CONFIDENCE_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_KEY_VALUE_DETECTION_LABEL_METRICS_REPORT_T Type
Label Metrics report for Key Value Detection Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_t FORCE AUTHID CURRENT_USER IS OBJECT (
label varchar2(32767),
document_count number,
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_t (
label varchar2,
document_count number,
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) Label name |
|
(optional) Total test documents in the label. |
|
(required) Mean average precision under different thresholds |
|
(required) List of key value detection confidence report. |
DBMS_CLOUD_OCI_AI_DOCUMENT_KEY_VALUE_DETECTION_OVERALL_METRICS_REPORT_T Type
Overall Metrics report for Key Value Detection Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_key_value_detection_overall_metrics_report_t FORCE AUTHID CURRENT_USER IS OBJECT (
document_count number,
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_overall_metrics_report_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_overall_metrics_report_t (
document_count number,
mean_average_precision number,
confidence_entries dbms_cloud_oci_ai_document_key_value_detection_confidence_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) Total test documents in the label. |
|
(required) Mean average precision under different thresholds |
|
(required) List of key value detection confidence report. |
DBMS_CLOUD_OCI_AI_DOCUMENT_KEY_VALUE_DETECTION_LABEL_METRICS_REPORT_TBL Type
Nested table type of dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_KEY_VALUE_DETECTION_MODEL_METRICS_T Type
Metrics for Document Key Value Detection Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_key_value_detection_model_metrics_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_model_metrics_t (
label_metrics_report dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_tbl,
overall_metrics_report dbms_cloud_oci_ai_document_key_value_detection_overall_metrics_report_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_model_metrics_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_key_value_detection_model_metrics_t (
model_type varchar2,
dataset_summary dbms_cloud_oci_ai_document_dataset_summary_t,
label_metrics_report dbms_cloud_oci_ai_document_key_value_detection_label_metrics_report_tbl,
overall_metrics_report dbms_cloud_oci_ai_document_key_value_detection_overall_metrics_report_t
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_key_value_detection_model_metrics_t
is a subtype of the dbms_cloud_oci_ai_document_model_metrics_t
type.
Fields
Field | Description |
---|---|
|
(required) List of metrics entries per label. |
|
(required) |
DBMS_CLOUD_OCI_AI_DOCUMENT_MODEL_T Type
Machine-learned Model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_model_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
model_type varchar2(32767),
tenancy_id varchar2(32767),
alias_name varchar2(32767),
labels dbms_cloud_oci_ai_document_varchar2_tbl,
is_quick_mode number,
max_training_time_in_hours number,
trained_time_in_hours number,
training_dataset dbms_cloud_oci_ai_document_dataset_t,
testing_dataset dbms_cloud_oci_ai_document_dataset_t,
validation_dataset dbms_cloud_oci_ai_document_dataset_t,
component_models dbms_cloud_oci_ai_document_component_model_tbl,
is_composed_model number,
model_version varchar2(32767),
project_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
metrics dbms_cloud_oci_ai_document_model_metrics_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
model_type varchar2,
tenancy_id varchar2,
alias_name varchar2,
labels dbms_cloud_oci_ai_document_varchar2_tbl,
is_quick_mode number,
max_training_time_in_hours number,
trained_time_in_hours number,
training_dataset dbms_cloud_oci_ai_document_dataset_t,
testing_dataset dbms_cloud_oci_ai_document_dataset_t,
validation_dataset dbms_cloud_oci_ai_document_dataset_t,
component_models dbms_cloud_oci_ai_document_component_model_tbl,
is_composed_model number,
model_version varchar2,
project_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
metrics dbms_cloud_oci_ai_document_model_metrics_t,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A unique identifier that is immutable after creation. |
|
(optional) A human-friendly name for the model, which can be changed. |
|
(optional) An optional description of the model. |
|
(required) The compartment identifier. |
|
(required) The type of the Document model. Allowed values are: 'KEY_VALUE_EXTRACTION', 'DOCUMENT_CLASSIFICATION' |
|
(optional) The tenancy id of the model. |
|
(optional) the alias name of the model. |
|
(optional) The collection of labels used to train the custom model. |
|
(optional) 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. |
|
(optional) The maximum model training time in hours, expressed as a decimal fraction. |
|
(optional) The total hours actually used for model training. |
|
(optional) |
|
(optional) |
|
(optional) |
|
(optional) The OCID collection of active custom Key Value models that need to be composed. |
|
(optional) Set to true when the model is created by using multiple key value extraction models. |
|
(required) The version of the model. |
|
(required) The OCID of the project that contains the model. |
|
(required) When the model was created, as an RFC3339 datetime string. |
|
(optional) When the model was updated, as an RFC3339 datetime string. |
|
(required) The current state of the model. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) A message describing the current state in more detail, that can provide actionable information if training failed. |
|
(optional) |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_MODEL_SUMMARY_T Type
The metadata about the model.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_model_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
model_type varchar2(32767),
model_version varchar2(32767),
project_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
precision number,
tenancy_id varchar2(32767),
alias_name varchar2(32767),
training_dataset dbms_cloud_oci_ai_document_dataset_t,
testing_dataset dbms_cloud_oci_ai_document_dataset_t,
validation_dataset dbms_cloud_oci_ai_document_dataset_t,
component_models dbms_cloud_oci_ai_document_component_model_tbl,
is_composed_model number,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_summary_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
model_type varchar2,
model_version varchar2,
project_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
precision number,
tenancy_id varchar2,
alias_name varchar2,
training_dataset dbms_cloud_oci_ai_document_dataset_t,
testing_dataset dbms_cloud_oci_ai_document_dataset_t,
validation_dataset dbms_cloud_oci_ai_document_dataset_t,
component_models dbms_cloud_oci_ai_document_component_model_tbl,
is_composed_model number,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A unique identifier that is immutable after creation. |
|
(optional) A human-friendly name for the model, which can be changed. |
|
(optional) An optional description of the model. |
|
(required) The compartment identifier. |
|
(required) The type of the Document model. |
|
(required) The version of the model. |
|
(required) The OCID of the project that contains the model. |
|
(required) When the model was created, as an RFC3339 datetime string. |
|
(optional) When the model was modified, as an RFC3339 datetime string. |
|
(required) The current state of the model. |
|
(optional) A message describing the current state in more detail, that can provide actionable information if training failed. |
|
(optional) The precision of the trained model. |
|
(optional) The tenancy id of the model. |
|
(optional) the alias name of the model. |
|
(optional) |
|
(optional) |
|
(optional) |
|
(optional) The OCID list of active custom Key Value models that need to be composed. |
|
(optional) Set to true when the model is created by using multiple key value extraction models. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_MODEL_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_ai_document_model_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_model_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_model_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_MODEL_COLLECTION_T Type
The results of a model search.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_model_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_ai_document_model_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_model_collection_t (
items dbms_cloud_oci_ai_document_model_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A list of models. |
DBMS_CLOUD_OCI_AI_DOCUMENT_OBJECT_LOCATION_T Type
A location in Object Storage that is uniquely identified by namespace name, bucket name and object name.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_object_location_t FORCE AUTHID CURRENT_USER IS OBJECT (
namespace_name varchar2(32767),
bucket_name varchar2(32767),
object_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_location_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_location_t (
namespace_name varchar2,
bucket_name varchar2,
object_name varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The Object Storage namespace name. |
|
(required) The Object Storage bucket name. |
|
(required) The Object Storage object name. |
DBMS_CLOUD_OCI_AI_DOCUMENT_OBJECT_STORAGE_DATASET_T Type
The dataset that resides in Object Storage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_object_storage_dataset_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_dataset_t (
namespace_name varchar2(32767),
bucket_name varchar2(32767),
object_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_storage_dataset_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_storage_dataset_t (
dataset_type varchar2,
namespace_name varchar2,
bucket_name varchar2,
object_name varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_object_storage_dataset_t
is a subtype of the dbms_cloud_oci_ai_document_dataset_t
type.
Fields
Field | Description |
---|---|
|
(required) The namespace name of the Object Storage bucket that contains the input data file. |
|
(required) The name of the Object Storage bucket that contains the input data file. |
|
(required) The object name of the input data file. |
DBMS_CLOUD_OCI_AI_DOCUMENT_OBJECT_STORAGE_DOCUMENT_DETAILS_T Type
A document in OCI Object Storage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_object_storage_document_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_document_details_t (
namespace_name varchar2(32767),
bucket_name varchar2(32767),
object_name varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_storage_document_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_storage_document_details_t (
source varchar2,
namespace_name varchar2,
bucket_name varchar2,
object_name varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_object_storage_document_details_t
is a subtype of the dbms_cloud_oci_ai_document_document_details_t
type.
Fields
Field | Description |
---|---|
|
(required) The Object Storage namespace. |
|
(required) The Object Storage bucket name. |
|
(required) The Object Storage object name. |
DBMS_CLOUD_OCI_AI_DOCUMENT_OBJECT_LOCATION_TBL Type
Nested table type of dbms_cloud_oci_ai_document_object_location_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_object_location_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_object_location_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_OBJECT_STORAGE_LOCATIONS_T Type
A list of object locations in Object Storage.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_object_storage_locations_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_input_location_t (
object_locations dbms_cloud_oci_ai_document_object_location_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_storage_locations_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_object_storage_locations_t (
source_type varchar2,
object_locations dbms_cloud_oci_ai_document_object_location_tbl
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_object_storage_locations_t
is a subtype of the dbms_cloud_oci_ai_document_input_location_t
type.
Fields
Field | Description |
---|---|
|
(required) The list of ObjectLocations. |
DBMS_CLOUD_OCI_AI_DOCUMENT_PATCH_MODEL_OPERATION_T Type
The metadata which can be edited after model creation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_patch_model_operation_t FORCE AUTHID CURRENT_USER IS OBJECT (
path varchar2(32767),
value varchar2(32767),
operation varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_patch_model_operation_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_patch_model_operation_t (
path varchar2,
value varchar2,
operation varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) The parameter of the resource to be changed. |
|
(optional) The value of the parameter to be updated. |
|
(optional) The value of the parameter to be updated. Allowed values are: 'DELETE', 'ADD', 'REPLACE' |
DBMS_CLOUD_OCI_AI_DOCUMENT_PATCH_MODEL_OPERATION_TBL Type
Nested table type of dbms_cloud_oci_ai_document_patch_model_operation_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_patch_model_operation_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_patch_model_operation_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_PATCH_MODEL_DETAILS_T Type
The model parameters to be updated using patch operation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_patch_model_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
operations dbms_cloud_oci_ai_document_patch_model_operation_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_patch_model_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_patch_model_details_t (
operations dbms_cloud_oci_ai_document_patch_model_operation_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) A list of patch operations for model. |
DBMS_CLOUD_OCI_AI_DOCUMENT_PATCH_RESPONSE_MESSAGE_T Type
The response containing the details of the patch operation status.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_patch_response_message_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
model_id varchar2(32767),
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_patch_response_message_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_patch_response_message_t (
message varchar2,
model_id varchar2,
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The response message containing details of operation. |
|
(optional) Model ID representing the conflicting patch operation. |
|
(optional) Compartment ID representing the conflicting Model Compartment. |
DBMS_CLOUD_OCI_AI_DOCUMENT_PROCESSOR_JOB_T Type
Details of a processor job.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_processor_job_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
compartment_id varchar2(32767),
display_name varchar2(32767),
processor_config dbms_cloud_oci_ai_document_processor_config_t,
input_location dbms_cloud_oci_ai_document_input_location_t,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
percent_complete number,
output_location dbms_cloud_oci_ai_document_output_location_t,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_processor_job_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_processor_job_t (
id varchar2,
compartment_id varchar2,
display_name varchar2,
processor_config dbms_cloud_oci_ai_document_processor_config_t,
input_location dbms_cloud_oci_ai_document_input_location_t,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
percent_complete number,
output_location dbms_cloud_oci_ai_document_output_location_t,
lifecycle_state varchar2,
lifecycle_details varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The id of the processor job. |
|
(required) The compartment identifier. |
|
(optional) The display name of the processor job. |
|
(required) |
|
(optional) |
|
(required) The job acceptance time. |
|
(optional) The job start time. |
|
(optional) The job finish time. |
|
(optional) How much progress the operation has made, compared to the total amount of work to be performed. |
|
(required) |
|
(required) The current state of the processor job. Allowed values are: 'SUCCEEDED', 'FAILED', 'ACCEPTED', 'CANCELED', 'IN_PROGRESS', 'CANCELING' |
|
(optional) The detailed status of FAILED state. Allowed values are: 'PARTIALLY_SUCCEEDED', 'COMPLETELY_FAILED' |
DBMS_CLOUD_OCI_AI_DOCUMENT_PROJECT_T Type
A Document Project containing models.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_project_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_project_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_project_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A unique identifier that is immutable after creation. |
|
(optional) A human-friendly name for the project, which can be changed. |
|
(optional) An optional description of the project. |
|
(required) The compartment identifier. |
|
(required) When the project was created, as an RFC3339 datetime string. |
|
(optional) When the project was updated, as an RFC3339 datetime string. |
|
(required) The current state of the project. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED' |
|
(optional) A message describing the current state in more detail, that can provide actionable information if creation failed. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_PROJECT_SUMMARY_T Type
the metadata about the project.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_project_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
description varchar2(32767),
compartment_id varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2(32767),
lifecycle_details varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_project_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_project_summary_t (
id varchar2,
display_name varchar2,
description varchar2,
compartment_id varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone,
lifecycle_state varchar2,
lifecycle_details varchar2,
freeform_tags json_element_t,
defined_tags json_element_t,
system_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A unique identifier that is immutable after creation. |
|
(optional) A human-friendly name for the project, that can be changed. |
|
(optional) An optional description of the project. |
|
(required) The compartment identifier. |
|
(required) When the project was created, as an RFC3339 datetime string. |
|
(optional) When the project was created, as an RFC3339 datetime string. |
|
(required) The current state of the project. |
|
(optional) A message describing the current state in more detail, that can provide actionable information if creation failed. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
|
(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_PROJECT_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_ai_document_project_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_project_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_project_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_PROJECT_COLLECTION_T Type
The results of a project search.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_project_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_ai_document_project_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_project_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_project_collection_t (
items dbms_cloud_oci_ai_document_project_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) List of projects. |
DBMS_CLOUD_OCI_AI_DOCUMENT_UPDATE_MODEL_DETAILS_T Type
The metadata which can be edited after model creation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_update_model_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_update_model_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_update_model_details_t (
display_name varchar2,
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) A human-friendly name of the model, which can be changed. |
|
(optional) An optional description of the model. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_UPDATE_PROJECT_DETAILS_T Type
The metadata that can be edited after project creation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_update_project_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
description varchar2(32767),
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_update_project_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_update_project_details_t (
display_name varchar2,
description varchar2,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(optional) A human-friendly name for the project, that can be changed. |
|
(optional) An optional description of the project. |
|
(optional) 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\"}` |
|
(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_ARRAY_T Type
The array of field values.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_array_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
items dbms_cloud_oci_ai_document_document_field_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_array_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_array_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
items dbms_cloud_oci_ai_document_document_field_tbl
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_array_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The array of values. |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_DATE_T Type
The date field value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_date_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
value timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_date_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_date_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
value timestamp with time zone
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_date_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The date field value as yyyy-mm-dd. |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_INTEGER_T Type
The integer field value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_integer_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
value number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_integer_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_integer_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
value number
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_integer_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The integer value. |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_NUMBER_T Type
The floating point number field value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_number_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
value number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_number_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_number_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
value number
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_number_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The number value. |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_PHONE_NUMBER_T Type
The phone number field value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_phone_number_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_phone_number_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_phone_number_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
value varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_phone_number_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The phone number field value. |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_STRING_T Type
The string field value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_string_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
value varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_string_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_string_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
value varchar2
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_string_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The string text. |
DBMS_CLOUD_OCI_AI_DOCUMENT_VALUE_TIME_T Type
The time field value.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_value_time_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_ai_document_field_value_t (
value timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_time_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_value_time_t (
value_type varchar2,
text varchar2,
confidence number,
bounding_polygon dbms_cloud_oci_ai_document_bounding_polygon_t,
word_indexes dbms_cloud_oci_ai_document_number_tbl,
value timestamp with time zone
) RETURN SELF AS RESULT
);
dbms_cloud_oci_ai_document_value_time_t
is a subtype of the dbms_cloud_oci_ai_document_field_value_t
type.
Fields
Field | Description |
---|---|
|
(required) The time field value as yyyy-mm-dd hh-mm-ss. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_RESOURCE_T Type
A resource created, or operated on, by a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
entity_type varchar2(32767),
action_type varchar2(32767),
identifier varchar2(32767),
entity_uri varchar2(32767),
metadata json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_resource_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_resource_t (
entity_type varchar2,
action_type varchar2,
identifier varchar2,
entity_uri varchar2,
metadata json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The resource type the work request affects. |
|
(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until the work is complete for. At that point, it transitions to CREATED, UPDATED, or DELETED, as appropriate. Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED', 'FAILED' |
|
(required) The identifier of the resource the work request affects. |
|
(optional) The URI path that the user can do a GET on to access the resource metadata. |
|
(optional) Additional information that helps to explain the resource. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_RESOURCE_TBL Type
Nested table type of dbms_cloud_oci_ai_document_work_request_resource_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_work_request_resource_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_T Type
The workrequest status details.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_ai_document_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_ai_document_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The type of work request. Allowed values are: 'CREATE_PROJECT', 'UPDATE_PROJECT', 'DELETE_PROJECT', 'MOVE_PROJECT', 'CREATE_MODEL', 'UPDATE_MODEL', 'DELETE_MODEL', 'MOVE_MODEL', 'COMPOSE_MODEL' |
|
(required) The status of the current work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
(required) The ID of the work request. |
|
(required) The compartment identifier. |
|
(required) The resources affected by this work request. |
|
(required) The percentage of the request completed. |
|
(required) The date and time the request was created, as described in RFC 3339, section 14.29. |
|
(optional) The date and time the request was started, as described in RFC 3339, section 14.29. |
|
(optional) The date and time the object was finished, as described in RFC 3339. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_ERROR_T Type
An error encountered while executing a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_error_t (
code varchar2,
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). |
|
(required) A human-readable description of the issue encountered. |
|
(required) When the error occured, as an RFC3339 formatted datetime. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_ERROR_TBL Type
Nested table type of dbms_cloud_oci_ai_document_work_request_error_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_work_request_error_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_ERROR_COLLECTION_T Type
The results of a workRequestError search.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_ai_document_work_request_error_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_error_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_error_collection_t (
items dbms_cloud_oci_ai_document_work_request_error_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) the list of workRequestError objects. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_LOG_ENTRY_T Type
A log message from the execution of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_log_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_log_entry_t (
message varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) A human-readable log message. |
|
(required) When the log message was written, as an RFC3339 formatted datetime. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_LOG_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_ai_document_work_request_log_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_work_request_log_entry_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type
The results of a workRequestLog search.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_ai_document_work_request_log_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_log_entry_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_log_entry_collection_t (
items dbms_cloud_oci_ai_document_work_request_log_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The list of workRequestLogEntries. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_SUMMARY_T Type
A summary of the status of a work request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
operation_type varchar2(32767),
status varchar2(32767),
id varchar2(32767),
compartment_id varchar2(32767),
resources dbms_cloud_oci_ai_document_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_summary_t (
operation_type varchar2,
status varchar2,
id varchar2,
compartment_id varchar2,
resources dbms_cloud_oci_ai_document_work_request_resource_tbl,
percent_complete number,
time_accepted timestamp with time zone,
time_started timestamp with time zone,
time_finished timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The type of the work request. Allowed values are: 'CREATE_PROJECT', 'UPDATE_PROJECT', 'DELETE_PROJECT', 'MOVE_PROJECT', 'CREATE_MODEL', 'UPDATE_MODEL', 'DELETE_MODEL', 'MOVE_MODEL', 'COMPOSE_MODEL' |
|
(required) The status of the current work request. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED' |
|
(required) The ID of the work request. |
|
(required) The compartment identifier. |
|
(required) The resources affected by this work request. |
|
(required) The percentage of the request completed. |
|
(required) The date and time the request was created, as described in RFC 3339, section 14.29. |
|
(optional) The date and time the request was started, as described in RFC 3339, section 14.29. |
|
(optional) The date and time the object was finished, as described in RFC 3339. |
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_SUMMARY_TBL Type
Nested table type of dbms_cloud_oci_ai_document_work_request_summary_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_ai_document_work_request_summary_t) NOT PERSISTABLE;
DBMS_CLOUD_OCI_AI_DOCUMENT_WORK_REQUEST_SUMMARY_COLLECTION_T Type
The results of a workRequest search.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_ai_document_work_request_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
items dbms_cloud_oci_ai_document_work_request_summary_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_summary_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_ai_document_work_request_summary_collection_t (
items dbms_cloud_oci_ai_document_work_request_summary_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;
Fields
Field | Description |
---|---|
|
(required) The list of workRequestSummary objects. |