/AWS1/CL_CPDCLASSIFYDOCRSP¶
ClassifyDocumentResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
it_classes TYPE /AWS1/CL_CPDDOCUMENTCLASS=>TT_LISTOFCLASSES TT_LISTOFCLASSES¶
The classes used by the document being analyzed. These are used for models trained in multi-class mode. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.
it_labels TYPE /AWS1/CL_CPDDOCUMENTLABEL=>TT_LISTOFLABELS TT_LISTOFLABELS¶
The labels used in the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.
io_documentmetadata TYPE REF TO /AWS1/CL_CPDDOCUMENTMETADATA /AWS1/CL_CPDDOCUMENTMETADATA¶
Extraction information about the document. This field is present in the response only if your request includes the
Byteparameter.
it_documenttype TYPE /AWS1/CL_CPDDOCTYPELISTITEM=>TT_LISTOFDOCUMENTTYPE TT_LISTOFDOCUMENTTYPE¶
The document type for each page in the input document. This field is present in the response only if your request includes the
Byteparameter.
it_errors TYPE /AWS1/CL_CPDERRORSLISTITEM=>TT_LISTOFERRORS TT_LISTOFERRORS¶
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
it_warnings TYPE /AWS1/CL_CPDWARNINGSLISTITEM=>TT_LISTOFWARNINGS TT_LISTOFWARNINGS¶
Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.
The field is empty if the system generated no warnings.
Queryable Attributes¶
Classes¶
The classes used by the document being analyzed. These are used for models trained in multi-class mode. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.
For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLASSES() |
Getter for CLASSES, with configurable default |
ASK_CLASSES() |
Getter for CLASSES w/ exceptions if field has no value |
HAS_CLASSES() |
Determine if CLASSES has a value |
Labels¶
The labels used in the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LABELS() |
Getter for LABELS, with configurable default |
ASK_LABELS() |
Getter for LABELS w/ exceptions if field has no value |
HAS_LABELS() |
Determine if LABELS has a value |
DocumentMetadata¶
Extraction information about the document. This field is present in the response only if your request includes the
Byteparameter.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTMETADATA() |
Getter for DOCUMENTMETADATA |
DocumentType¶
The document type for each page in the input document. This field is present in the response only if your request includes the
Byteparameter.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTTYPE() |
Getter for DOCUMENTTYPE, with configurable default |
ASK_DOCUMENTTYPE() |
Getter for DOCUMENTTYPE w/ exceptions if field has no value |
HAS_DOCUMENTTYPE() |
Determine if DOCUMENTTYPE has a value |
Errors¶
Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERRORS() |
Getter for ERRORS, with configurable default |
ASK_ERRORS() |
Getter for ERRORS w/ exceptions if field has no value |
HAS_ERRORS() |
Determine if ERRORS has a value |
Warnings¶
Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.
The field is empty if the system generated no warnings.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WARNINGS() |
Getter for WARNINGS, with configurable default |
ASK_WARNINGS() |
Getter for WARNINGS w/ exceptions if field has no value |
HAS_WARNINGS() |
Determine if WARNINGS has a value |