+ "! An object describing an error that occurred during
+ "! processing of an asynchronous operation. + begin of T_STATUS_ERROR, + "! The text of the error message. + MESSAGE type STRING, + end of T_STATUS_ERROR. types: "! No documentation available. T_DIALOG_NODE_OUTPUT_GENERIC type JSONOBJECT. @@ -151,9 +159,12 @@ public section. types: "! No documentation available. begin of T_DIALOG_NODE, - "! The dialog node ID. This string must conform to the following restrictions:+ "! An object containing properties that indicate how many
+ "! intents, entities, and dialog nodes are defined in the workspace. This property + "! is included only in responses from the **Export workspace asynchronously** + "! method, and only when the **verbose** query parameter is set to `true`. + begin of T_WORKSPACE_COUNTS, + "! The number of intents defined in the workspace. + INTENT type INTEGER, + "! The number of entities defined in the workspace. + ENTITY type INTEGER, + "! The number of nodes defined in the workspace. + NODE type INTEGER, + end of T_WORKSPACE_COUNTS. types: "!"! A webhook that can be used by dialog nodes to make
@@ -306,6 +336,22 @@ public section. "! An array of user input examples for the intent. EXAMPLES type STANDARD TABLE OF T_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, end of T_INTENT. + types: + "!+ "! Workspace settings related to the version of the training
+ "! algorithms currently used by the skill. + begin of T_WS_SYSTEM_SETTINGS_NLP, + "! The policy the skill follows for selecting the algorithm version to use. For + "! more information, see the + "! [documentation](/docs/watson-assistant?topic=watson-assistant-algorithm-version + "! )."! Workspace settings related to the Watson Assistant user
@@ -324,7 +370,7 @@ public section. "! Workspace settings related to the disambiguation feature. DISAMBIGUATION type T_WS_SYSTM_STTNGS_DSMBGTN, "! For internal use only. - HUMAN_AGENT_ASSIST type MAP, + HUMAN_AGENT_ASSIST type JSONOBJECT, "! Whether spelling correction is enabled for the workspace. SPELLING_SUGGESTIONS type BOOLEAN, "! Whether autocorrection is enabled for the workspace. If spelling correction is @@ -338,6 +384,9 @@ public section. SYSTEM_ENTITIES type T_WS_SYSTM_STTNGS_SYSTM_ENTTS, "! Workspace settings related to detection of irrelevant input. OFF_TOPIC type T_WS_SYSTEM_SETTINGS_OFF_TOPIC, + "! Workspace settings related to the version of the training algorithms currently + "! used by the skill. + NLP type T_WS_SYSTEM_SETTINGS_NLP, end of T_WORKSPACE_SYSTEM_SETTINGS. types: "! No documentation available. @@ -367,7 +416,7 @@ public section. "! newline, or tab characters. DESCRIPTION type STRING, "! Any metadata related to the entity. - METADATA type MAP, + METADATA type JSONOBJECT, "! Whether to use fuzzy matching for the entity. FUZZY_MATCH type BOOLEAN, "! The timestamp for creation of the object. @@ -400,22 +449,68 @@ public section. "! The timestamp for the most recent update to the object. UPDATED type DATETIME, "! Any metadata related to the workspace. - METADATA type MAP, + METADATA type JSONOBJECT, "! Whether training data from the workspace (including artifacts such as intents "! and entities) can be used by IBM for general service improvements. `true` "! indicates that workspace training data is not to be used. LEARNING_OPT_OUT type BOOLEAN, "! Global settings for the workspace. SYSTEM_SETTINGS type T_WORKSPACE_SYSTEM_SETTINGS, - "! The current status of the workspace. + "! The current status of the workspace:- "! The pagination data for the returned objects.
+ "! The pagination data for the returned objects. For more + "! information about using pagination, see [Pagination](#pagination). begin of T_PAGINATION, "! The URL that will return the same page of results. REFRESH_URL type STRING, @@ -452,7 +548,8 @@ public section. begin of T_SYNONYM_COLLECTION, "! An array of synonyms. SYNONYMS type STANDARD TABLE OF T_SYNONYM WITH NON-UNIQUE DEFAULT KEY, - "! The pagination data for the returned objects. + "! The pagination data for the returned objects. For more information about using + "! pagination, see [Pagination](#pagination). PAGINATION type T_PAGINATION, end of T_SYNONYM_COLLECTION. types: @@ -617,8 +714,6 @@ public section. "! A decimal percentage that represents Watson's confidence in the recognized "! entity. CONFIDENCE type NUMBER, - "! Any metadata for the entity. - METADATA type MAP, "! The recognized capture groups for the entity, as defined by the entity pattern. GROUPS type STANDARD TABLE OF T_CAPTURE_GROUP WITH NON-UNIQUE DEFAULT KEY, "! An object containing detailed information about the entity recognized in the @@ -647,7 +742,9 @@ public section. begin of T_RUNTIME_INTENT, "! The name of the recognized intent. INTENT type STRING, - "! A decimal percentage that represents Watson's confidence in the intent. + "! A decimal percentage that represents Watson's confidence in the intent. If + "! you are specifying an intent as part of a request, but you do not have a + "! calculated confidence value, specify `1`. CONFIDENCE type DOUBLE, end of T_RUNTIME_INTENT. types: @@ -678,21 +775,23 @@ public section. VALUE type T_DIA_ND_OUTPUT_OPT_ELEM_VALUE, end of T_DIA_NODE_OUTPUT_OPT_ELEMENT. types: - "!- "! An object that describes a response with response type
- "! `option`. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_OPTION, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, "! The title or introductory text to show before the response. TITLE type STRING, - "! The description to show with the the response. + "! The description to show with the response. DESCRIPTION type STRING, "! The preferred type of control to display. PREFERENCE type STRING, "! An array of objects describing the options from which the user can choose. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_OPTION. types: "! No documentation available. @@ -702,9 +801,7 @@ public section. TEXT type STRING, end of T_DIA_ND_OTPT_TEXT_VALUES_ELEM. types: - "!- "! An object that describes a response with response type
- "! `text`. + "! No documentation available. begin of T_DIA_ND_OUTPUT_RESP_TYPE_TEXT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -717,6 +814,8 @@ public section. "! The delimiter to use as a separator between responses when "! `selection_policy`=`multiline`. DELIMITER type STRING, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OUTPUT_RESP_TYPE_TEXT. types: "! No documentation available. @@ -741,6 +840,91 @@ public section. "! The timestamp for the most recent update to the object. UPDATED type DATETIME, end of T_BASE_WORKSPACE. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_VD, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the video. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the video cannot be seen. + ALT_TEXT type STRING, + end of T_RT_RESP_GNRC_RT_RESP_TYP_VD. + types: + "!+ "! Information for transferring to the web chat integration.
+ begin of T_CHANNEL_TRANSFER_TARGET_CHAT, + "! The URL of the target web chat. + URL type STRING, + end of T_CHANNEL_TRANSFER_TARGET_CHAT. + types: + "!+ "! An object specifying target channels available for the
+ "! transfer. Each property of this object represents an available transfer target. + "! Currently, the only supported property is **chat**, representing the web chat + "! integration. + begin of T_CHANNEL_TRANSFER_TARGET, + "! Information for transferring to the web chat integration. + CHAT type T_CHANNEL_TRANSFER_TARGET_CHAT, + end of T_CHANNEL_TRANSFER_TARGET. + types: + "!+ "! Information used by an integration to transfer the
+ "! conversation to a different channel. + begin of T_CHANNEL_TRANSFER_INFO, + "! An object specifying target channels available for the transfer. Each property + "! of this object represents an available transfer target. Currently, the only + "! supported property is **chat**, representing the web chat integration. + TARGET type T_CHANNEL_TRANSFER_TARGET, + end of T_CHANNEL_TRANSFER_INFO. + types: + "! No documentation available. + begin of T_DIA_ND_OTPT_RESP_TYP_CHNNL_1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel.- "! An object that describes a response with response type
- "! `text`. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_TEXT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, "! The text of the response. TEXT type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_TEXT. types: "! No documentation available. @@ -831,6 +1017,25 @@ public section. "! The timestamp for the most recent update to the object. UPDATED type DATETIME, end of T_UPDATE_EXAMPLE. + types: + "! No documentation available. + begin of T_DIA_ND_OTPT_RESP_TYPE_IFRAME, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the embeddable content. + SOURCE type STRING, + "! An optional title to show before the response. + TITLE type STRING, + "! An optional description to show with the response. + DESCRIPTION type STRING, + "! The URL of an image that shows a preview of the embedded content. + IMAGE_URL type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_DIA_ND_OTPT_RESP_TYPE_IFRAME. types: "!"! An object describing a contextual entity mention.
@@ -844,24 +1049,40 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, end of T_ENTITY_MENTION. types: - "!- "! An object that describes a response with response type
- "! `image`. + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_IMG, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The URL of the image. + "! The `https:` URL of the image. SOURCE type STRING, "! The title or introductory text to show before the response. TITLE type STRING, - "! The description to show with the the response. + "! The description to show with the response. DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! Descriptive text that can be used for screen readers or other situations where + "! the image cannot be seen. + ALT_TEXT type STRING, end of T_RT_RESP_GNRC_RT_RESP_TYP_IMG. types: - "!- "! An object that describes a response with response type
- "! `text`. + "! No documentation available. + begin of T_RT_RESP_TYPE_USER_DEFINED, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! An object containing any properties for the user-defined response type. + USER_DEFINED type JSONOBJECT, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_TYPE_USER_DEFINED. + types: + "! No documentation available. begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP1, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -874,11 +1095,11 @@ public section. "! The delimiter to use as a separator between responses when "! `selection_policy`=`multiline`. DELIMITER type STRING, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP1. types: - "!- "! An object that describes a response with response type
- "! `search_skill`. + "! No documentation available. begin of T_DIA_ND_OTPT_RESP_TYP_SRCH_S1, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel.- "! The pagination data for the returned objects.
+ "! The pagination data for the returned objects. For more + "! information about using pagination, see [Pagination](#pagination). begin of T_LOG_PAGINATION, "! The URL that will return the next page of results, if any. NEXT_URL type STRING, @@ -936,9 +1161,7 @@ public section. TARGET type MAP, end of T_DIA_ND_OTPT_CNNCT_T_AGNT_TR1. types: - "!- "! An object that describes a response with response type
- "! `connect_to_agent`. + "! No documentation available. begin of T_RT_RESP_TYP_CONNECT_TO_AGENT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -959,15 +1182,17 @@ public section. "! property of the relevant node or the **topic** property of the dialog node "! response. TOPIC type STRING, - "! The ID of the dialog node that the **topic** property is taken from. The + "! The unique ID of the dialog node that the **topic** property is taken from. The "! **topic** property is populated using the value of the dialog node's "! **title** property. DIALOG_NODE type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_TYP_CONNECT_TO_AGENT. types: - "!- "! An object that describes a response with response type
- "! `connect_to_agent`. + "! No documentation available. begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP5, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -984,6 +1209,8 @@ public section. "! Routing or other contextual information to be used by target service desk "! systems. TRANSFER_INFO type T_DIA_ND_OTPT_CNNCT_T_AGNT_TR1, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP5. types: "! No documentation available. @@ -994,7 +1221,7 @@ public section. "! - It cannot consist of only whitespace characters. VALUE type STRING, "! Any metadata related to the entity value. - METADATA type MAP, + METADATA type JSONOBJECT, "! Specifies the type of entity value. TYPE type STRING, "! An array of synonyms for the entity value. A value can specify either synonyms @@ -1014,11 +1241,34 @@ public section. "! The timestamp for the most recent update to the object. UPDATED type DATETIME, end of T_CREATE_VALUE. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_CH1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel."! An object defining the message input, intents, and entities
"! to be sent to the Watson Assistant service if the user selects the - "! corresponding disambiguation option. + "! corresponding disambiguation option.+ "! An object that identifies the dialog element that generated
+ "! the error message. + begin of T_LOG_MESSAGE_SOURCE, + "! A string that indicates the type of dialog element that generated the error + "! message. + TYPE type STRING, + "! The unique identifier of the dialog node that generated the error message. + DIALOG_NODE type STRING, + end of T_LOG_MESSAGE_SOURCE. types: "!"! Log message details.
@@ -1163,6 +1440,10 @@ public section. LEVEL type STRING, "! The text of the log message. MSG type STRING, + "! A code that indicates the category to which the error message belongs. + CODE type STRING, + "! An object that identifies the dialog element that generated the error message. + SOURCE type T_LOG_MESSAGE_SOURCE, end of T_LOG_MESSAGE. types: "! No documentation available. @@ -1182,8 +1463,6 @@ public section. NODES_VISITED_DETAILS type STANDARD TABLE OF T_DIALOG_NODE_VISITED_DETAILS WITH NON-UNIQUE DEFAULT KEY, "! An array of up to 50 messages logged with the request. LOG_MESSAGES type STANDARD TABLE OF T_LOG_MESSAGE WITH NON-UNIQUE DEFAULT KEY, - "! An array of responses to the user. - TEXT type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, "! Output intended for any channel. It is the responsibility of the client "! application to implement the supported response types. GENERIC type STANDARD TABLE OF T_RUNTIME_RESPONSE_GENERIC WITH NON-UNIQUE DEFAULT KEY, @@ -1195,24 +1474,42 @@ public section. INPUT type STANDARD TABLE OF T_BULK_CLASSIFY_UTTERANCE WITH NON-UNIQUE DEFAULT KEY, end of T_BULK_CLASSIFY_INPUT. types: - "!- "! An object that describes a response with response type
- "! `image`. + "! No documentation available. begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP3, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The URL of the image. + "! The `https:` URL of the image. SOURCE type STRING, "! An optional title to show before the response. TITLE type STRING, "! An optional description to show with the response. DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! Descriptive text that can be used for screen readers or other situations where + "! the image cannot be seen. + ALT_TEXT type STRING, end of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP3. types: - "!- "! An object that describes a response with response type
- "! `connect_to_agent`. + "! No documentation available. + begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP7, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel.
@@ -1244,7 +1545,8 @@ public section.
begin of T_DIALOG_NODE_COLLECTION,
"! An array of objects describing the dialog nodes defined for the workspace.
DIALOG_NODES type STANDARD TABLE OF T_DIALOG_NODE WITH NON-UNIQUE DEFAULT KEY,
- "! The pagination data for the returned objects.
+ "! The pagination data for the returned objects. For more information about using
+ "! pagination, see [Pagination](#pagination).
PAGINATION type T_PAGINATION,
end of T_DIALOG_NODE_COLLECTION.
types:
@@ -1256,9 +1558,15 @@ public section.
DEPLOYMENT type STRING,
"! A string value that identifies the user who is interacting with the workspace.
"! The client must provide a unique identifier for each individual end user who
- "! accesses the application. For Plus and Premium plans, this user ID is used to
+ "! accesses the application. For user-based plans, this user ID is used to
"! identify unique users for billing purposes. This string cannot contain carriage
- "! return, newline, or tab characters.
+ "! return, newline, or tab characters. If no value is specified in the input,
+ "! **user_id** is automatically set to the value of
+ "! **context.conversation_id**.
+ "!
+ "! **Note:** This property is the same as the **user_id** property at the root of
+ "! the message body. If **user_id** is specified in both locations in a message
+ "! request, the value specified at the root is used.
USER_ID type STRING,
end of T_MESSAGE_CONTEXT_METADATA.
types:
@@ -1266,10 +1574,12 @@ public section.
"! State information for the conversation. To maintain state,
- "! An object that describes a response with response type
- "! `pause`. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_PAUSE, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1423,11 +1751,26 @@ public section. TIME type INTEGER, "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_PAUSE. types: - "!- "! An object that describes a response with response type
- "! `connect_to_agent`. + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_US1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! An object containing any properties for the user-defined response type. + USER_DEFINED type JSONOBJECT, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_US1. + types: + "! No documentation available. begin of T_DIA_ND_OTPT_RESP_TYP_CNNCT_1, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1444,11 +1787,52 @@ public section. "! Routing or other contextual information to be used by target service desk "! systems. TRANSFER_INFO type T_DIA_ND_OTPT_CNNCT_T_AGNT_TR1, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OTPT_RESP_TYP_CNNCT_1. types: - "!- "! An object that describes a response with response type
- "! `pause`. + "! No documentation available. + begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OT10, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the audio clip. + SOURCE type STRING, + "! An optional title to show before the response. + TITLE type STRING, + "! An optional description to show with the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the audio player cannot be seen. + ALT_TEXT type STRING, + end of T_DIA_ND_OTPT_GNRC_DIA_ND_OT10. + types: + "! No documentation available. + begin of T_RUNTIME_RESPONSE_TYPE_IFRAME, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the embeddable content. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the response. + DESCRIPTION type STRING, + "! The URL of an image that shows a preview of the embedded content. + IMAGE_URL type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RUNTIME_RESPONSE_TYPE_IFRAME. + types: + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_PS, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1457,6 +1841,10 @@ public section. TIME type INTEGER, "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_GNRC_RT_RESP_TYP_PS. types: "! No documentation available. @@ -1500,7 +1888,7 @@ public section. "! newline, or tab characters. DESCRIPTION type STRING, "! Any metadata related to the entity. - METADATA type MAP, + METADATA type JSONOBJECT, "! Whether to use fuzzy matching for the entity. FUZZY_MATCH type BOOLEAN, "! The timestamp for creation of the object. @@ -1533,15 +1921,26 @@ public section. "! The timestamp for the most recent update to the object. UPDATED type DATETIME, "! Any metadata related to the workspace. - METADATA type MAP, + METADATA type JSONOBJECT, "! Whether training data from the workspace (including artifacts such as intents "! and entities) can be used by IBM for general service improvements. `true` "! indicates that workspace training data is not to be used. LEARNING_OPT_OUT type BOOLEAN, "! Global settings for the workspace. SYSTEM_SETTINGS type T_WORKSPACE_SYSTEM_SETTINGS, - "! The current status of the workspace. + "! The current status of the workspace:- "! An object that describes a response with response type
- "! `pause`. + "! No documentation available. begin of T_DIA_ND_OTPT_RESP_TYPE_PAUSE, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1630,11 +2030,11 @@ public section. "! Whether to send a "user is typing" event during the pause. Ignored if "! the channel does not support this event. TYPING type BOOLEAN, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OTPT_RESP_TYPE_PAUSE. types: - "!- "! An object that describes a response with response type
- "! `suggestion`. + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_SG1, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1644,21 +2044,28 @@ public section. "! An array of objects describing the possible matching dialog nodes from which the "! user can choose. SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_GNRC_RT_RESP_TYP_SG1. types: - "!- "! An object that describes a response with response type
- "! `image`. + "! No documentation available. begin of T_DIA_ND_OUTPUT_RESP_TYPE_IMG, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The URL of the image. + "! The `https:` URL of the image. SOURCE type STRING, "! An optional title to show before the response. TITLE type STRING, "! An optional description to show with the response. DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! Descriptive text that can be used for screen readers or other situations where + "! the image cannot be seen. + ALT_TEXT type STRING, end of T_DIA_ND_OUTPUT_RESP_TYPE_IMG. types: "! No documentation available. @@ -1671,9 +2078,29 @@ public section. CODE type INTEGER, end of T_ERROR_RESPONSE. types: - "!- "! An object that describes a response with response type
- "! `option`. + "! No documentation available. + begin of T_DIA_ND_OTPT_RESP_TYPE_AUDIO, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the audio clip. + SOURCE type STRING, + "! An optional title to show before the response. + TITLE type STRING, + "! An optional description to show with the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the audio player cannot be seen. + ALT_TEXT type STRING, + end of T_DIA_ND_OTPT_RESP_TYPE_AUDIO. + types: + "! No documentation available. begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP4, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1687,7 +2114,21 @@ public section. "! An array of objects describing the options from which the user can choose. You "! can include up to 20 options. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP4. + types: + "! No documentation available. + begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP8, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! An object containing any properties for the user-defined response type. The + "! total size of this object cannot exceed 5000 bytes. + USER_DEFINED type JSONOBJECT, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP8. types: "! No documentation available. begin of T_BASE_MESSAGE, @@ -1709,11 +2150,21 @@ public section. OUTPUT type T_OUTPUT_DATA, "! An array of objects describing any actions requested by the dialog node. ACTIONS type STANDARD TABLE OF T_DIALOG_NODE_ACTION WITH NON-UNIQUE DEFAULT KEY, + "! A string value that identifies the user who is interacting with the workspace. + "! The client must provide a unique identifier for each individual end user who + "! accesses the application. For user-based plans, this user ID is used to + "! identify unique users for billing purposes. This string cannot contain carriage + "! return, newline, or tab characters. If no value is specified in the input, + "! **user_id** is automatically set to the value of + "! **context.conversation_id**.- "! An object that describes a response with response type
- "! `suggestion`. + "! No documentation available. begin of T_RT_RESPONSE_TYPE_SUGGESTION, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1723,13 +2174,18 @@ public section. "! An array of objects describing the possible matching dialog nodes from which the "! user can choose. SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESPONSE_TYPE_SUGGESTION. types: "! No documentation available. begin of T_ENTITY_MENTION_COLLECTION, "! An array of objects describing the entity mentions defined for an entity. EXAMPLES type STANDARD TABLE OF T_ENTITY_MENTION WITH NON-UNIQUE DEFAULT KEY, - "! The pagination data for the returned objects. + "! The pagination data for the returned objects. For more information about using + "! pagination, see [Pagination](#pagination). PAGINATION type T_PAGINATION, end of T_ENTITY_MENTION_COLLECTION. types: @@ -1746,20 +2202,22 @@ public section. UPDATED type DATETIME, end of T_UPDATE_SYNONYM. types: - "!- "! An object that describes a response with response type
- "! `text`. + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_TXT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, "! The text of the response. TEXT type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_GNRC_RT_RESP_TYP_TXT. types: "!"! For internal use only.
- T_SYSTEM_RESPONSE type MAP. + T_SYSTEM_RESPONSE type JSONOBJECT. types: "! No documentation available. begin of T_BASE_INTENT, @@ -1778,9 +2236,7 @@ public section. UPDATED type DATETIME, end of T_BASE_INTENT. types: - "!- "! An object that describes a response with response type
- "! `pause`. + "! No documentation available. begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP2, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1790,6 +2246,8 @@ public section. "! Whether to send a "user is typing" event during the pause. Ignored if "! the channel does not support this event. TYPING type BOOLEAN, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP2. types: "! No documentation available. @@ -1853,9 +2311,7 @@ public section. SPECIFIC_YEAR type NUMBER, end of T_RT_ENTTY_INTRPRTTN_SYS_DATE. types: - "!- "! An object that describes a response with response type
- "! `search_skill`. + "! No documentation available. begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OTP6, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel.- "! An object that describes a response with response type
- "! `option`. + "! No documentation available. + begin of T_RUNTIME_RESPONSE_TYPE_AUDIO, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the audio clip. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the audio player cannot be seen. + ALT_TEXT type STRING, + end of T_RUNTIME_RESPONSE_TYPE_AUDIO. + types: + "! No documentation available. begin of T_DIA_ND_OUTPUT_RESP_TYPE_OPT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1896,7 +2374,31 @@ public section. "! An array of objects describing the options from which the user can choose. You "! can include up to 20 options. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OUTPUT_RESP_TYPE_OPT. + types: + "! No documentation available. + begin of T_DIA_ND_OTPT_RESP_TYPE_VIDEO, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the video. + SOURCE type STRING, + "! An optional title to show before the response. + TITLE type STRING, + "! An optional description to show with the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the video cannot be seen. + ALT_TEXT type STRING, + end of T_DIA_ND_OTPT_RESP_TYPE_VIDEO. types: "! No documentation available. begin of T_BASE_COUNTEREXAMPLE, @@ -1911,20 +2413,44 @@ public section. UPDATED type DATETIME, end of T_BASE_COUNTEREXAMPLE. types: - "!- "! An object that describes a response with response type
- "! `image`. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_IMAGE, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The URL of the image. + "! The `https:` URL of the image. SOURCE type STRING, "! The title or introductory text to show before the response. TITLE type STRING, - "! The description to show with the the response. + "! The description to show with the response. DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! Descriptive text that can be used for screen readers or other situations where + "! the image cannot be seen. + ALT_TEXT type STRING, end of T_RUNTIME_RESPONSE_TYPE_IMAGE. + types: + "! No documentation available. + begin of T_DIA_ND_OTPT_GNRC_DIA_ND_OT11, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the embeddable content. + SOURCE type STRING, + "! An optional title to show before the response. + TITLE type STRING, + "! An optional description to show with the response. + DESCRIPTION type STRING, + "! The URL of an image that shows a preview of the embedded content. + IMAGE_URL type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_DIA_ND_OTPT_GNRC_DIA_ND_OT11. types: "! No documentation available. begin of T_UPDATE_WORKSPACE, @@ -1948,15 +2474,26 @@ public section. "! The timestamp for the most recent update to the object. UPDATED type DATETIME, "! Any metadata related to the workspace. - METADATA type MAP, + METADATA type JSONOBJECT, "! Whether training data from the workspace (including artifacts such as intents "! and entities) can be used by IBM for general service improvements. `true` "! indicates that workspace training data is not to be used. LEARNING_OPT_OUT type BOOLEAN, "! Global settings for the workspace. SYSTEM_SETTINGS type T_WORKSPACE_SYSTEM_SETTINGS, - "! The current status of the workspace. + "! The current status of the workspace:"! A request sent to the workspace, including the user input
@@ -2052,6 +2619,18 @@ public section. OUTPUT type T_OUTPUT_DATA, "! An array of objects describing any actions requested by the dialog node. ACTIONS type STANDARD TABLE OF T_DIALOG_NODE_ACTION WITH NON-UNIQUE DEFAULT KEY, + "! A string value that identifies the user who is interacting with the workspace. + "! The client must provide a unique identifier for each individual end user who + "! accesses the application. For user-based plans, this user ID is used to + "! identify unique users for billing purposes. This string cannot contain carriage + "! return, newline, or tab characters. If no value is specified in the input, + "! **user_id** is automatically set to the value of + "! **context.conversation_id**.- "! An object that describes a response with response type
- "! `option`. + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_IF1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the embeddable content. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the response. + DESCRIPTION type STRING, + "! The URL of an image that shows a preview of the embedded content. + IMAGE_URL type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_IF1. + types: + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_OPT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, "! The title or introductory text to show before the response. TITLE type STRING, - "! The description to show with the the response. + "! The description to show with the response. DESCRIPTION type STRING, "! The preferred type of control to display. PREFERENCE type STRING, "! An array of objects describing the options from which the user can choose. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_GNRC_RT_RESP_TYP_OPT. + types: + "! No documentation available. + begin of T_DIA_ND_OTPT_RESP_TYP_USR_DF1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! An object containing any properties for the user-defined response type. The + "! total size of this object cannot exceed 5000 bytes. + USER_DEFINED type JSONOBJECT, + "! An array of objects specifying channels for which the response is intended. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_DIA_ND_OTPT_RESP_TYP_USR_DF1. types: "!"! For internal use only.
@@ -2155,20 +2791,25 @@ constants: T_WS_SYSTM_STTNGS_DSMBGTN type string value '|', T_DIALOG_NODE_OUTPUT_MODIFIERS type string value '|', T_DIALOG_NODE_NEXT_STEP type string value '|BEHAVIOR|', + T_STATUS_ERROR type string value '|', T_DIALOG_NODE_OUTPUT type string value '|', T_DIALOG_NODE_CONTEXT type string value '|', T_DIALOG_NODE type string value '|DIALOG_NODE|', T_VALUE type string value '|VALUE|TYPE|', + T_WORKSPACE_COUNTS type string value '|', T_WEBHOOK type string value '|URL|NAME|', T_WS_SYSTM_STTNGS_SYSTM_ENTTS type string value '|', T_MENTION type string value '|ENTITY|LOCATION|', T_EXAMPLE type string value '|TEXT|', T_INTENT type string value '|INTENT|', + T_WS_SYSTEM_SETTINGS_NLP type string value '|', T_WS_SYSTEM_SETTINGS_TOOLING type string value '|', T_WORKSPACE_SYSTEM_SETTINGS type string value '|', T_COUNTEREXAMPLE type string value '|TEXT|', T_ENTITY type string value '|ENTITY|', - T_WORKSPACE type string value '|NAME|LANGUAGE|WORKSPACE_ID|LEARNING_OPT_OUT|', + T_WORKSPACE type string value '|NAME|LANGUAGE|LEARNING_OPT_OUT|', + T_RESPONSE_GENERIC_CHANNEL type string value '|', + T_RUNTIME_RESPONSE_TYPE_VIDEO type string value '|RESPONSE_TYPE|SOURCE|', T_SYNONYM type string value '|SYNONYM|', T_PAGINATION type string value '|REFRESH_URL|', T_SYNONYM_COLLECTION type string value '|SYNONYMS|PAGINATION|', @@ -2177,20 +2818,28 @@ constants: T_CAPTURE_GROUP type string value '|GROUP|', T_RUNTIME_ENTITY_ALTERNATIVE type string value '|', T_RUNTIME_ENTITY_ROLE type string value '|', - T_RUNTIME_ENTITY type string value '|ENTITY|LOCATION|VALUE|', - T_RUNTIME_INTENT type string value '|INTENT|CONFIDENCE|', + T_RUNTIME_ENTITY type string value '|ENTITY|VALUE|', + T_RUNTIME_INTENT type string value '|INTENT|', T_DIA_ND_OUTPUT_OPT_ELEM_VALUE type string value '|', T_DIA_NODE_OUTPUT_OPT_ELEMENT type string value '|LABEL|VALUE|', T_RUNTIME_RESPONSE_TYPE_OPTION type string value '|RESPONSE_TYPE|TITLE|OPTIONS|', T_DIA_ND_OTPT_TEXT_VALUES_ELEM type string value '|', T_DIA_ND_OUTPUT_RESP_TYPE_TEXT type string value '|RESPONSE_TYPE|VALUES|', T_BASE_WORKSPACE type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_VD type string value '|RESPONSE_TYPE|SOURCE|', + T_CHANNEL_TRANSFER_TARGET_CHAT type string value '|', + T_CHANNEL_TRANSFER_TARGET type string value '|', + T_CHANNEL_TRANSFER_INFO type string value '|TARGET|', + T_DIA_ND_OTPT_RESP_TYP_CHNNL_1 type string value '|RESPONSE_TYPE|MESSAGE_TO_USER|TRANSFER_INFO|', + T_RT_RESP_TYPE_CHANNEL_TRANS type string value '|RESPONSE_TYPE|MESSAGE_TO_USER|TRANSFER_INFO|', T_BASE_ENTITY type string value '|', T_RUNTIME_RESPONSE_TYPE_TEXT type string value '|RESPONSE_TYPE|TEXT|', T_RT_ENTTY_INTRPRTTN_SYS_TIME type string value '|', T_UPDATE_EXAMPLE type string value '|', + T_DIA_ND_OTPT_RESP_TYPE_IFRAME type string value '|RESPONSE_TYPE|SOURCE|', T_ENTITY_MENTION type string value '|TEXT|INTENT|LOCATION|', T_RT_RESP_GNRC_RT_RESP_TYP_IMG type string value '|RESPONSE_TYPE|SOURCE|', + T_RT_RESP_TYPE_USER_DEFINED type string value '|RESPONSE_TYPE|USER_DEFINED|', T_DIA_ND_OTPT_GNRC_DIA_ND_OTP1 type string value '|RESPONSE_TYPE|VALUES|', T_DIA_ND_OTPT_RESP_TYP_SRCH_S1 type string value '|RESPONSE_TYPE|QUERY|QUERY_TYPE|', T_EXAMPLE_COLLECTION type string value '|EXAMPLES|PAGINATION|', @@ -2200,6 +2849,7 @@ constants: T_RT_RESP_TYP_CONNECT_TO_AGENT type string value '|RESPONSE_TYPE|', T_DIA_ND_OTPT_GNRC_DIA_ND_OTP5 type string value '|RESPONSE_TYPE|', T_CREATE_VALUE type string value '|VALUE|', + T_RT_RESP_GNRC_RT_RESP_TYP_CH1 type string value '|RESPONSE_TYPE|MESSAGE_TO_USER|TRANSFER_INFO|', T_DIALOG_SUGGESTION_VALUE type string value '|', T_DIALOG_SUGGESTION type string value '|LABEL|VALUE|', T_UPDATE_VALUE type string value '|', @@ -2210,20 +2860,25 @@ constants: T_WORKSPACE_REFERENCE type string value '|', T_VALUE_COLLECTION type string value '|VALUES|PAGINATION|', T_DIALOG_NODE_VISITED_DETAILS type string value '|', - T_LOG_MESSAGE type string value '|LEVEL|MSG|', - T_OUTPUT_DATA type string value '|LOG_MESSAGES|TEXT|', + T_LOG_MESSAGE_SOURCE type string value '|', + T_LOG_MESSAGE type string value '|LEVEL|MSG|CODE|', + T_OUTPUT_DATA type string value '|LOG_MESSAGES|', T_BULK_CLASSIFY_INPUT type string value '|INPUT|', T_DIA_ND_OTPT_GNRC_DIA_ND_OTP3 type string value '|RESPONSE_TYPE|SOURCE|', + T_DIA_ND_OTPT_GNRC_DIA_ND_OTP7 type string value '|RESPONSE_TYPE|MESSAGE_TO_USER|TRANSFER_INFO|', T_RT_RESP_GNRC_RT_RESP_TYP_CN1 type string value '|RESPONSE_TYPE|', T_DIALOG_NODE_COLLECTION type string value '|DIALOG_NODES|PAGINATION|', T_MESSAGE_CONTEXT_METADATA type string value '|', T_CONTEXT type string value '|', - T_MESSAGE_RESPONSE type string value '|INPUT|INTENTS|ENTITIES|CONTEXT|OUTPUT|', + T_MESSAGE_RESPONSE type string value '|INPUT|INTENTS|ENTITIES|CONTEXT|OUTPUT|USER_ID|', T_BASE_VALUE type string value '|', T_UPDATE_ENTITY type string value '|', T_UPDATE_DIALOG_NODE type string value '|', T_RUNTIME_RESPONSE_TYPE_PAUSE type string value '|RESPONSE_TYPE|TIME|', + T_RT_RESP_GNRC_RT_RESP_TYP_US1 type string value '|RESPONSE_TYPE|USER_DEFINED|', T_DIA_ND_OTPT_RESP_TYP_CNNCT_1 type string value '|RESPONSE_TYPE|', + T_DIA_ND_OTPT_GNRC_DIA_ND_OT10 type string value '|RESPONSE_TYPE|SOURCE|', + T_RUNTIME_RESPONSE_TYPE_IFRAME type string value '|RESPONSE_TYPE|SOURCE|', T_RT_RESP_GNRC_RT_RESP_TYP_PS type string value '|RESPONSE_TYPE|TIME|', T_ERROR_DETAIL type string value '|MESSAGE|', T_CREATE_INTENT type string value '|INTENT|', @@ -2239,7 +2894,9 @@ constants: T_RT_RESP_GNRC_RT_RESP_TYP_SG1 type string value '|RESPONSE_TYPE|TITLE|SUGGESTIONS|', T_DIA_ND_OUTPUT_RESP_TYPE_IMG type string value '|RESPONSE_TYPE|SOURCE|', T_ERROR_RESPONSE type string value '|ERROR|CODE|', + T_DIA_ND_OTPT_RESP_TYPE_AUDIO type string value '|RESPONSE_TYPE|SOURCE|', T_DIA_ND_OTPT_GNRC_DIA_ND_OTP4 type string value '|RESPONSE_TYPE|TITLE|OPTIONS|', + T_DIA_ND_OTPT_GNRC_DIA_ND_OTP8 type string value '|RESPONSE_TYPE|USER_DEFINED|', T_BASE_MESSAGE type string value '|', T_RT_RESPONSE_TYPE_SUGGESTION type string value '|RESPONSE_TYPE|TITLE|SUGGESTIONS|', T_ENTITY_MENTION_COLLECTION type string value '|EXAMPLES|PAGINATION|', @@ -2249,19 +2906,26 @@ constants: T_DIA_ND_OTPT_GNRC_DIA_ND_OTP2 type string value '|RESPONSE_TYPE|TIME|', T_RT_ENTTY_INTRPRTTN_SYS_DATE type string value '|', T_DIA_ND_OTPT_GNRC_DIA_ND_OTP6 type string value '|RESPONSE_TYPE|QUERY|QUERY_TYPE|', + T_RUNTIME_RESPONSE_TYPE_AUDIO type string value '|RESPONSE_TYPE|SOURCE|', T_DIA_ND_OUTPUT_RESP_TYPE_OPT type string value '|RESPONSE_TYPE|TITLE|OPTIONS|', + T_DIA_ND_OTPT_RESP_TYPE_VIDEO type string value '|RESPONSE_TYPE|SOURCE|', T_BASE_COUNTEREXAMPLE type string value '|', T_RUNTIME_RESPONSE_TYPE_IMAGE type string value '|RESPONSE_TYPE|SOURCE|', + T_DIA_ND_OTPT_GNRC_DIA_ND_OT11 type string value '|RESPONSE_TYPE|SOURCE|', T_UPDATE_WORKSPACE type string value '|', T_BASE_DIALOG_NODE type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_AD type string value '|RESPONSE_TYPE|SOURCE|', T_MESSAGE_REQUEST type string value '|', T_LOG type string value '|REQUEST|RESPONSE|LOG_ID|REQUEST_TIMESTAMP|RESPONSE_TIMESTAMP|WORKSPACE_ID|LANGUAGE|', T_BASE_OUTPUT type string value '|', T_LOG_COLLECTION type string value '|LOGS|PAGINATION|', + T_DIA_ND_OTPT_GNRC_DIA_ND_OTP9 type string value '|RESPONSE_TYPE|SOURCE|', T_AUDIT_PROPERTIES type string value '|', T_WORKSPACE_COLLECTION type string value '|WORKSPACES|PAGINATION|', T_BASE_SYNONYM type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_IF1 type string value '|RESPONSE_TYPE|SOURCE|', T_RT_RESP_GNRC_RT_RESP_TYP_OPT type string value '|RESPONSE_TYPE|TITLE|OPTIONS|', + T_DIA_ND_OTPT_RESP_TYP_USR_DF1 type string value '|RESPONSE_TYPE|USER_DEFINED|', __DUMMY type string value SPACE, end of C_REQUIRED_FIELDS . @@ -2301,6 +2965,7 @@ constants: INTENTS type string value 'intents', ENTITIES type string value 'entities', ALTERNATE_INTENTS type string value 'alternate_intents', + USER_ID type string value 'user_id', NODES_VISITED type string value 'nodes_visited', NODES_VISITED_DETAILS type string value 'nodes_visited_details', SYNONYM type string value 'synonym', @@ -2316,6 +2981,9 @@ constants: COUNTEREXAMPLE type string value 'counterexample', GROUP type string value 'group', LOCATION type string value 'location', + TARGET type string value 'target', + CHAT type string value 'chat', + URL type string value 'url', CONVERSATION_ID type string value 'conversation_id', SYSTEM type string value 'system', PAGINATION type string value 'pagination', @@ -2325,6 +2993,7 @@ constants: LEARNING_OPT_OUT type string value 'learning_opt_out', SYSTEM_SETTINGS type string value 'system_settings', STATUS type string value 'status', + STATUS_ERRORS type string value 'status_errors', WEBHOOKS type string value 'webhooks', PARAMETERS type string value 'parameters', RESULT_VARIABLE type string value 'result_variable', @@ -2337,12 +3006,16 @@ constants: OVERWRITE type string value 'overwrite', LABEL type string value 'label', RESPONSE_TYPE type string value 'response_type', + SOURCE type string value 'source', + CHANNELS type string value 'channels', + CHANNEL_OPTIONS type string value 'channel_options', + ALT_TEXT type string value 'alt_text', + MESSAGE_TO_USER type string value 'message_to_user', + TRANSFER_INFO type string value 'transfer_info', MESSAGE_TO_HUMAN_AGENT type string value 'message_to_human_agent', AGENT_AVAILABLE type string value 'agent_available', AGENT_UNAVAILABLE type string value 'agent_unavailable', - TRANSFER_INFO type string value 'transfer_info', - TARGET type string value 'target', - SOURCE type string value 'source', + IMAGE_URL type string value 'image_url', PREFERENCE type string value 'preference', OPTIONS type string value 'options', TIME type string value 'time', @@ -2353,6 +3026,7 @@ constants: DISCOVERY_VERSION type string value 'discovery_version', SELECTION_POLICY type string value 'selection_policy', DELIMITER type string value 'delimiter', + USER_DEFINED type string value 'user_defined', PATH type string value 'path', ERROR type string value 'error', ERRORS type string value 'errors', @@ -2369,7 +3043,6 @@ constants: MATCHED type string value 'matched', NEXT_CURSOR type string value 'next_cursor', DEPLOYMENT type string value 'deployment', - USER_ID type string value 'user_id', SPELLING_SUGGESTIONS type string value 'spelling_suggestions', SPELLING_AUTO_CORRECT type string value 'spelling_auto_correct', SUGGESTED_TEXT type string value 'suggested_text', @@ -2378,6 +3051,7 @@ constants: REFRESH_URL type string value 'refresh_url', TOTAL type string value 'total', REFRESH_CURSOR type string value 'refresh_cursor', + CHANNEL type string value 'channel', CONFIDENCE type string value 'confidence', GROUPS type string value 'groups', INTERPRETATION type string value 'interpretation', @@ -2411,14 +3085,16 @@ constants: TIMEZONE type string value 'timezone', TOPIC type string value 'topic', SUGGESTIONS type string value 'suggestions', - URL type string value 'url', HEADERS type string value 'headers', + COUNTS type string value 'counts', WORKSPACES type string value 'workspaces', + NODE type string value 'node', TOOLING type string value 'tooling', DISAMBIGUATION type string value 'disambiguation', HUMAN_AGENT_ASSIST type string value 'human_agent_assist', SYSTEM_ENTITIES type string value 'system_entities', OFF_TOPIC type string value 'off_topic', + NLP type string value 'nlp', PROMPT type string value 'prompt', NONE_OF_THE_ABOVE_PROMPT type string value 'none_of_the_above_prompt', ENABLED type string value 'enabled', @@ -2426,6 +3102,7 @@ constants: RANDOMIZE type string value 'randomize', MAX_SUGGESTIONS type string value 'max_suggestions', SUGGESTION_TEXT_POLICY type string value 'suggestion_text_policy', + MODEL type string value 'model', STORE_GENERIC_RESPONSES type string value 'store_generic_responses', end of C_ABAPNAME_DICTIONARY . @@ -2478,7 +3155,7 @@ constants: "! method is useful for testing and comparing the performance of different "! workspaces.Create workspace
"! Create a workspace based on component objects. You must provide workspace - "! components defining the content of the new workspace. + "! components defining the content of the new workspace.Update workspace
"! Update an existing workspace with new or modified data. You must provide - "! component objects defining the content of the updated workspace. + "! component objects defining the content of the updated workspace.Create workspace asynchronously
+ "! Create a workspace asynchronously based on component objects. You must provide + "! workspace components defining the content of the new workspace.Update workspace asynchronously
+ "! Update an existing workspace asynchronously with new or modified data. You must + "! provide component objects defining the content of the updated workspace.Export workspace asynchronously
+ "! Export the entire workspace asynchronously, including all workspace + "! content.List intents
"! List the intents for a workspace. @@ -2675,7 +3463,7 @@ constants: importing !I_WORKSPACE_ID type STRING !I_EXPORT type BOOLEAN default c_boolean_false - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -2841,7 +3629,7 @@ constants: importing !I_WORKSPACE_ID type STRING !I_INTENT type STRING - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -2990,7 +3778,7 @@ constants: methods LIST_COUNTEREXAMPLES importing !I_WORKSPACE_ID type STRING - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -3133,7 +3921,7 @@ constants: importing !I_WORKSPACE_ID type STRING !I_EXPORT type BOOLEAN default c_boolean_false - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -3334,7 +4122,7 @@ constants: !I_WORKSPACE_ID type STRING !I_ENTITY type STRING !I_EXPORT type BOOLEAN default c_boolean_false - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -3514,7 +4302,7 @@ constants: !I_WORKSPACE_ID type STRING !I_ENTITY type STRING !I_VALUE type STRING - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -3676,7 +4464,7 @@ constants: methods LIST_DIALOG_NODES importing !I_WORKSPACE_ID type STRING - !I_PAGE_LIMIT type INTEGER optional + !I_PAGE_LIMIT type INTEGER default 100 !I_INCLUDE_COUNT type BOOLEAN default c_boolean_false !I_SORT type STRING optional !I_CURSOR type STRING optional @@ -3720,7 +4508,7 @@ constants: "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. "! @parameter I_DIALOG_NODE | - "! The dialog node ID (for example, `get_order`). + "! The dialog node ID (for example, `node_1_1479323581900`). "! @parameter I_INCLUDE_AUDIT | "! Whether to include the audit properties (`created` and `updated` timestamps) in "! the response. @@ -3747,7 +4535,7 @@ constants: "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. "! @parameter I_DIALOG_NODE | - "! The dialog node ID (for example, `get_order`). + "! The dialog node ID (for example, `node_1_1479323581900`). "! @parameter I_BODY | "! The updated content of the dialog node.List log events in a workspace
- "! List the events from the log of a specific workspace. + "! List the events from the log of a specific workspace.List log events in all workspaces
- "! List the events from the logs of all workspaces in the service instance. + "! List the events from the logs of all workspaces in the service instance.+ "! An object that identifies the dialog element that generated
+ "! the error message. + T_LOG_MESSAGE_SOURCE type JSONOBJECT. types: "!"! Dialog log message details.
@@ -32,49 +96,47 @@ public section. LEVEL type STRING, "! The text of the log message. MESSAGE type STRING, + "! A code that indicates the category to which the error message belongs. + CODE type STRING, + "! An object that identifies the dialog element that generated the error message. + SOURCE type T_LOG_MESSAGE_SOURCE, end of T_DIALOG_LOG_MESSAGE. types: - "! No documentation available. - begin of T_DIALOG_NODES_VISITED, - "! A dialog node that was triggered during processing of the input message. + "!+ "! An objects containing detailed diagnostic information about
+ "! a dialog node that was visited during processing of the input message. + begin of T_DIALOG_NODE_VISITED, + "! A dialog node that was visited during processing of the input message. DIALOG_NODE type STRING, "! The title of the dialog node. TITLE type STRING, "! The conditions that trigger the dialog node. CONDITIONS type STRING, - end of T_DIALOG_NODES_VISITED. + end of T_DIALOG_NODE_VISITED. types: "!"! Additional detailed information about a message response and
"! how it was generated. begin of T_MESSAGE_OUTPUT_DEBUG, - "! An array of objects containing detailed diagnostic information about the nodes - "! that were triggered during processing of the input message. - NODES_VISITED type STANDARD TABLE OF T_DIALOG_NODES_VISITED WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects containing detailed diagnostic information about dialog + "! nodes that were visited during processing of the input message. + NODES_VISITED type STANDARD TABLE OF T_DIALOG_NODE_VISITED WITH NON-UNIQUE DEFAULT KEY, "! An array of up to 50 messages logged with the request. LOG_MESSAGES type STANDARD TABLE OF T_DIALOG_LOG_MESSAGE WITH NON-UNIQUE DEFAULT KEY, "! Assistant sets this to true when this message response concludes or interrupts a "! dialog. BRANCH_EXITED type BOOLEAN, - "! When `branch_exited` is set to `true` by the Assistant, the + "! When `branch_exited` is set to `true` by the assistant, the "! `branch_exited_reason` specifies whether the dialog completed by itself or got "! interrupted. BRANCH_EXITED_REASON type STRING, + "! An array of objects containing detailed diagnostic information about dialog + "! nodes and actions that were visited during processing of the input + "! message.+ "! An optional object containing analytics data. Currently,
+ "! this data is used only for events sent to the Segment extension. + begin of T_REQUEST_ANALYTICS, + "! The browser that was used to send the message that triggered the event. + BROWSER type STRING, + "! The type of device that was used to send the message that triggered the event. + DEVICE type STRING, + "! The URL of the web page that was used to send the message that triggered the + "! event. + PAGEURL type STRING, + end of T_REQUEST_ANALYTICS. + types: + "!+ "! A reference to a media file to be sent as an attachment with
+ "! the message. + begin of T_MESSAGE_INPUT_ATTACHMENT, + "! The URL of the media file. + URL type STRING, + "! The media content type (such as a MIME type) of the attachment. + MEDIA_TYPE type STRING, + end of T_MESSAGE_INPUT_ATTACHMENT. types: "!"! Optional properties that control how the assistant responds.
@@ -292,14 +382,30 @@ public section. begin of T_RUNTIME_INTENT, "! The name of the recognized intent. INTENT type STRING, - "! A decimal percentage that represents Watson's confidence in the intent. + "! A decimal percentage that represents Watson's confidence in the intent. If + "! you are specifying an intent as part of a request, but you do not have a + "! calculated confidence value, specify `1`. CONFIDENCE type DOUBLE, + "! The skill that identified the intent. Currently, the only possible values are + "! `main skill` for the dialog skill (if enabled) and `actions skill` for the + "! action skill."! An input object that includes the input text.
begin of T_MESSAGE_INPUT, - "! The type of user input. Currently, only text input is supported. + "! The type of the message:- "! An object that describes a response with response type
- "! `option`. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_OPTION, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -350,194 +463,366 @@ public section. PREFERENCE type STRING, "! An array of objects describing the options from which the user can choose. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_OPTION. types: "!- "! An object defining the message input to be sent to the
- "! assistant if the user selects the corresponding disambiguation option. - begin of T_DIALOG_SUGGESTION_VALUE, - "! An input object that includes the input text. - INPUT type T_MESSAGE_INPUT, - end of T_DIALOG_SUGGESTION_VALUE. + "! An object describing an error that occurred during + "! processing of an asynchronous operation. + begin of T_STATUS_ERROR, + "! The text of the error message. + MESSAGE type STRING, + end of T_STATUS_ERROR. types: - "! No documentation available. - begin of T_DIALOG_SUGGESTION, - "! The user-facing label for the suggestion. This label is taken from the **title** - "! or **user_label** property of the corresponding dialog node, depending on the - "! disambiguation options. - LABEL type STRING, - "! An object defining the message input to be sent to the assistant if the user - "! selects the corresponding disambiguation option. - VALUE type T_DIALOG_SUGGESTION_VALUE, - "! The dialog output that will be returned from the Watson Assistant service if the - "! user selects the corresponding option. - OUTPUT type MAP, - end of T_DIALOG_SUGGESTION. + "!+ "! The messages included with responses from the search
+ "! integration. + begin of T_SEARCH_SETTINGS_MESSAGES, + "! The message to include in the response to a successful query. + SUCCESS type STRING, + "! The message to include in the response when the query encounters an error. + ERROR type STRING, + "! The message to include in the response when there is no result from the query. + NO_RESULT type STRING, + end of T_SEARCH_SETTINGS_MESSAGES. types: "!- "! Detailed information about how an autolearned model affected
- "! the response. - begin of T_MSSG_OTPT_DBG_AT_LEARN_MODEL, - "! Whether the model was consulted successfully. - OUTCOME type STRING, - "! How the model was applied. - MODEL_TYPE type STRING, - "! Unique identifier of the autolearned model. - MODEL_ID type STRING, - "! Possible responses the assistant would have returned with autolearning applied, - "! either as disambiguation suggestions or alternate responses. Included only if - "! the response was generated with autolearning in preview mode. (Preview mode - "! means that autolearning is enabled, but is not being applied.). - SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, - end of T_MSSG_OTPT_DBG_AT_LEARN_MODEL. + "! The mapping between fields in the Watson Discovery + "! collection and properties in the search response. + begin of T_SRCH_SETTINGS_SCHEMA_MAPPING, + "! The field in the collection to map to the **url** property of the response. + URL type STRING, + "! The field in the collection to map to the **body** property in the response. + BODY type STRING, + "! The field in the collection to map to the **title** property for the schema. + TITLE type STRING, + end of T_SRCH_SETTINGS_SCHEMA_MAPPING. types: "!- "! Detailed information about how autolearning (if enabled)
- "! affected the response.- "! An object containing segments of text from search results
- "! with query-matching text highlighted using HTML `<em>` tags. - begin of T_SEARCH_RESULT_HIGHLIGHT, - "! An array of strings containing segments taken from body text in the search - "! results, with query-matching substrings highlighted. - BODY type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! An array of strings containing segments taken from title text in the search - "! results, with query-matching substrings highlighted. - TITLE type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! An array of strings containing segments taken from URLs in the search results, - "! with query-matching substrings highlighted. - URL type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_SEARCH_RESULT_HIGHLIGHT. + "! Configuration settings for the Watson Discovery service + "! instance used by the search integration. + begin of T_SEARCH_SETTINGS_DISCOVERY, + "! The ID for the Watson Discovery service instance. + INSTANCE_ID type STRING, + "! The ID for the Watson Discovery project. + PROJECT_ID type STRING, + "! The URL for the Watson Discovery service instance. + URL type STRING, + "! The maximum number of primary results to include in the response. + MAX_PRIMARY_RESULTS type INTEGER, + "! The maximum total number of primary and additional results to include in the + "! response. + MAX_TOTAL_RESULTS type INTEGER, + "! The minimum confidence threshold for included results. Any results with a + "! confidence below this threshold will be discarded. + CONFIDENCE_THRESHOLD type DOUBLE, + "! Whether to include the most relevant passages of text in the **highlight** + "! property of each result. + HIGHLIGHT type BOOLEAN, + "! Whether to use the answer finding feature to emphasize answers within + "! highlighted passages. This property is ignored if **highlight**=`false`.- "! An object that describes a response with response type
- "! `suggestion`. - begin of T_RT_RESP_GNRC_RT_RESP_TYP_SG1, - "! The type of response returned by the dialog node. The specified response type - "! must be supported by the client application or channel. - RESPONSE_TYPE type STRING, - "! The title or introductory text to show before the response. - TITLE type STRING, - "! An array of objects describing the possible matching dialog nodes from which the - "! user can choose. - SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, - end of T_RT_RESP_GNRC_RT_RESP_TYP_SG1. + "! An object describing the search skill configuration. + begin of T_SEARCH_SETTINGS, + "! Configuration settings for the Watson Discovery service instance used by the + "! search integration. + DISCOVERY type T_SEARCH_SETTINGS_DISCOVERY, + "! The messages included with responses from the search integration. + MESSAGES type T_SEARCH_SETTINGS_MESSAGES, + "! The mapping between fields in the Watson Discovery collection and properties in + "! the search response. + SCHEMA_MAPPING type T_SRCH_SETTINGS_SCHEMA_MAPPING, + end of T_SEARCH_SETTINGS. types: - "! No documentation available. - begin of T_ERROR_DETAIL, - "! Description of a specific constraint violation. - MESSAGE type STRING, - "! The location of the constraint violation. + "!+ "! A warning describing an error in the search skill
+ "! configuration. + begin of T_SEARCH_SKILL_WARNING, + "! The error code. + CODE type STRING, + "! The location of the error in the search skill configuration object. PATH type STRING, - end of T_ERROR_DETAIL. + "! The error message. + MESSAGE type STRING, + end of T_SEARCH_SKILL_WARNING. types: "! No documentation available. - begin of T_ERROR_RESPONSE, - "! General description of an error. - ERROR type STRING, - "! Collection of specific constraint violations associated with the error. - ERRORS type STANDARD TABLE OF T_ERROR_DETAIL WITH NON-UNIQUE DEFAULT KEY, - "! HTTP status code for the error response. - CODE type INTEGER, - end of T_ERROR_RESPONSE. + begin of T_SKILL_IMPORT, + "! The name of the skill. This string cannot contain carriage return, newline, or + "! tab characters. + NAME type STRING, + "! The description of the skill. This string cannot contain carriage return, + "! newline, or tab characters. + DESCRIPTION type STRING, + "! An object containing the conversational content of an action or dialog skill. + WORKSPACE type JSONOBJECT, + "! The skill ID of the skill. + SKILL_ID type STRING, + "! The current status of the skill:- "! An object containing search result metadata from the
- "! Discovery service. - begin of T_SEARCH_RESULT_METADATA, - "! The confidence score for the given result. For more information about how the - "! confidence is calculated, see the Discovery service - "! [documentation](../discovery#query-your-collection). - CONFIDENCE type DOUBLE, - "! An unbounded measure of the relevance of a particular result, dependent on the - "! query and matching document. A higher score indicates a greater match to the - "! query parameters. - SCORE type DOUBLE, - end of T_SEARCH_RESULT_METADATA. + "! Status information about the skills for the assistant. + "! Included in responses only if **status**=`Available`. + begin of T_ASSISTANT_STATE, + "! Whether the action skill is disabled in the draft environment. + ACTION_DISABLED type BOOLEAN, + "! Whether the dialog skill is disabled in the draft environment. + DIALOG_DISABLED type BOOLEAN, + end of T_ASSISTANT_STATE. types: "! No documentation available. - begin of T_SEARCH_RESULT, - "! The unique identifier of the document in the Discovery service collection.+ "! The search skill orchestration settings for the environment.
+ begin of T_BASE_ENV_ORCHESTRATION, + "! Whether assistants deployed to the environment fall back to a search skill when + "! responding to messages that do not match any intent. If no search skill is + "! configured for the assistant, this property is ignored. + SEARCH_SKILL_FALLBACK type BOOLEAN, + end of T_BASE_ENV_ORCHESTRATION. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_VD, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the video. + SOURCE type STRING, + "! The title or introductory text to show before the response. TITLE type STRING, - "! The URL of the original data object in its native data source. - URL type STRING, - "! An object containing segments of text from search results with query-matching - "! text highlighted using HTML `<em>` tags. - HIGHLIGHT type T_SEARCH_RESULT_HIGHLIGHT, - end of T_SEARCH_RESULT. + "! The description to show with the the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the video cannot be seen. + ALT_TEXT type STRING, + end of T_RT_RESP_GNRC_RT_RESP_TYP_VD. types: "!- "! Optional properties that control how the assistant responds.
- begin of T_MESSAGE_INPUT_OPT_STATELESS, - "! Whether to restart dialog processing at the root of the dialog, regardless of - "! any previously visited nodes. **Note:** This does not affect `turn_count` or - "! any other context variables. - RESTART type BOOLEAN, - "! Whether to return more than one intent. Set to `true` to return all matching - "! intents. - ALTERNATE_INTENTS type BOOLEAN, - "! Spelling correction options for the message. Any options specified on an - "! individual message override the settings configured for the skill. - SPELLING type T_MESSAGE_INPUT_OPT_SPELLING, - "! Whether to return additional diagnostic information. Set to `true` to return - "! additional information in the `output.debug` property. - DEBUG type BOOLEAN, - end of T_MESSAGE_INPUT_OPT_STATELESS. + "! Information for transferring to the web chat integration. + begin of T_CHANNEL_TRANSFER_TARGET_CHAT, + "! The URL of the target web chat. + URL type STRING, + end of T_CHANNEL_TRANSFER_TARGET_CHAT. types: "!- "! An input object that includes the input text.
- begin of T_BASE_MESSAGE_INPUT, - "! The type of user input. Currently, only text input is supported. - MESSAGE_TYPE type STRING, - "! The text of the user input. This string cannot contain carriage return, newline, - "! or tab characters. - TEXT type STRING, - "! Intents to use when evaluating the user input. Include intents from the previous - "! response to continue using those intents rather than trying to recognize - "! intents in the new input. - INTENTS type STANDARD TABLE OF T_RUNTIME_INTENT WITH NON-UNIQUE DEFAULT KEY, - "! Entities to use when evaluating the message. Include entities from the previous - "! response to continue using those entities rather than detecting entities in the - "! new input. - ENTITIES type STANDARD TABLE OF T_RUNTIME_ENTITY WITH NON-UNIQUE DEFAULT KEY, - "! For internal use only. - SUGGESTION_ID type STRING, - end of T_BASE_MESSAGE_INPUT. + "! An object specifying target channels available for the + "! transfer. Each property of this object represents an available transfer target. + "! Currently, the only supported property is **chat**, representing the web chat + "! integration. + begin of T_CHANNEL_TRANSFER_TARGET, + "! Information for transferring to the web chat integration. + CHAT type T_CHANNEL_TRANSFER_TARGET_CHAT, + end of T_CHANNEL_TRANSFER_TARGET. types: "!- "! An object that describes a response with response type
- "! `text`. + "! Information used by an integration to transfer the + "! conversation to a different channel. + begin of T_CHANNEL_TRANSFER_INFO, + "! An object specifying target channels available for the transfer. Each property + "! of this object represents an available transfer target. Currently, the only + "! supported property is **chat**, representing the web chat integration. + TARGET type T_CHANNEL_TRANSFER_TARGET, + end of T_CHANNEL_TRANSFER_INFO. + types: + "! No documentation available. + begin of T_RT_RESP_TYPE_CHANNEL_TRANS, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel.+ "! An object describing the release that is currently deployed
+ "! in the environment. + begin of T_BASE_ENV_RELEASE_REFERENCE, + "! The name of the deployed release. + RELEASE type STRING, + end of T_BASE_ENV_RELEASE_REFERENCE. types: "! No documentation available. begin of T_RT_ENTTY_INTRPRTTN_SYS_TIME, @@ -597,83 +890,225 @@ public section. "! A recognized time zone mentioned as part of a time value (for example, `EST`). TIMEZONE type STRING, end of T_RT_ENTTY_INTRPRTTN_SYS_TIME. + types: + "! No documentation available. + begin of T_RELEASE_SKILL, + "! The skill ID of the skill. + SKILL_ID type STRING, + "! The type of the skill. + TYPE type STRING, + "! The name of the skill snapshot that is saved as part of the release (for + "! example, `draft` or `1`). + SNAPSHOT type STRING, + end of T_RELEASE_SKILL. types: "!- "! Built-in system properties that apply to all skills used by
- "! the assistant. - begin of T_MSSG_CONTEXT_GLOBAL_SYSTEM, - "! The user time zone. The assistant uses the time zone to correctly resolve - "! relative time references. - TIMEZONE type STRING, - "! A string value that identifies the user who is interacting with the assistant. - "! The client must provide a unique identifier for each individual end user who - "! accesses the application. For Plus and Premium plans, this user ID is used to - "! identify unique users for billing purposes. This string cannot contain carriage - "! return, newline, or tab characters. - USER_ID type STRING, - "! A counter that is automatically incremented with each turn of the conversation. - "! A value of 1 indicates that this is the the first turn of a new conversation, - "! which can affect the behavior of some skills (for example, triggering the start - "! node of a dialog). - TURN_COUNT type INTEGER, - "! The language code for localization in the user input. The specified locale - "! overrides the default for the assistant, and is used for interpreting entity - "! values in user input such as date values. For example, `04/03/2018` might be - "! interpreted either as April 3 or March 4, depending on the locale.+ "! Autolearning options for the message. For more information
+ "! about autolearning, see the + "! [documentation](/docs/watson-assistant?topic=watson-assistant-autolearn).+ "! Built-in system properties that apply to all skills used by
+ "! the assistant. + begin of T_MSSG_CONTEXT_GLOBAL_SYSTEM, + "! The user time zone. The assistant uses the time zone to correctly resolve + "! relative time references. + TIMEZONE type STRING, + "! A string value that identifies the user who is interacting with the assistant. + "! The client must provide a unique identifier for each individual end user who + "! accesses the application. For user-based plans, this user ID is used to + "! identify unique users for billing purposes. This string cannot contain carriage + "! return, newline, or tab characters. If no value is specified in the input, + "! **user_id** is automatically set to the value of + "! **context.global.session_id**."! Session context data that is shared by all skills used by
- "! the Assistant. + "! the assistant. begin of T_MESSAGE_CONTEXT_GLOBAL, "! Built-in system properties that apply to all skills used by the assistant. SYSTEM type T_MSSG_CONTEXT_GLOBAL_SYSTEM, "! The session ID. SESSION_ID type STRING, end of T_MESSAGE_CONTEXT_GLOBAL. - types: - "!- "! Autolearning options for the message.
"! System context data used by the skill.
@@ -687,102 +1122,136 @@ public section. end of T_MESSAGE_CONTEXT_SKILL_SYSTEM. types: "!- "! Session context data that is shared by all skills used by
- "! the Assistant. - begin of T_MSSG_CNTXT_GLOBAL_STATELESS, - "! Built-in system properties that apply to all skills used by the assistant. - SYSTEM type T_MSSG_CONTEXT_GLOBAL_SYSTEM, - "! The unique identifier of the session. - SESSION_ID type STRING, - end of T_MSSG_CNTXT_GLOBAL_STATELESS. - types: - "! No documentation available. - begin of T_MESSAGE_CONTEXT_STATELESS, - "! Session context data that is shared by all skills used by the Assistant. - GLOBAL type T_MSSG_CNTXT_GLOBAL_STATELESS, - "! Information specific to particular skills used by the assistant.- "! An input object that includes the input text.
- begin of T_MESSAGE_INPUT_STATELESS, - "! The type of user input. Currently, only text input is supported. - MESSAGE_TYPE type STRING, - "! The text of the user input. This string cannot contain carriage return, newline, - "! or tab characters. - TEXT type STRING, - "! Intents to use when evaluating the user input. Include intents from the previous - "! response to continue using those intents rather than trying to recognize - "! intents in the new input. - INTENTS type STANDARD TABLE OF T_RUNTIME_INTENT WITH NON-UNIQUE DEFAULT KEY, - "! Entities to use when evaluating the message. Include entities from the previous - "! response to continue using those entities rather than detecting entities in the - "! new input. - ENTITIES type STANDARD TABLE OF T_RUNTIME_ENTITY WITH NON-UNIQUE DEFAULT KEY, - "! For internal use only. - SUGGESTION_ID type STRING, - "! Optional properties that control how the assistant responds. - OPTIONS type T_MESSAGE_INPUT_OPT_STATELESS, - end of T_MESSAGE_INPUT_STATELESS. + "! Context variables that are used by the dialog skill. + begin of T_MESSAGE_CONTEXT_SKILL_DIALOG, + "! An object containing any arbitrary variables that can be read and written by a + "! particular skill. + USER_DEFINED type JSONOBJECT, + "! System context data used by the skill. + SYSTEM type T_MESSAGE_CONTEXT_SKILL_SYSTEM, + end of T_MESSAGE_CONTEXT_SKILL_DIALOG. types: "!- "! A stateless message request formatted for the Watson
- "! Assistant service. - begin of T_MESSAGE_REQUEST_STATELESS, - "! An input object that includes the input text. - INPUT type T_MESSAGE_INPUT_STATELESS, - "! Context data for the conversation. You can use this property to set or modify - "! context variables, which can also be accessed by dialog nodes. The context is - "! not stored by the assistant. To maintain session state, include the context - "! from the previous response.- "! An object that describes a response with response type
- "! `image`. + "! No documentation available. + begin of T_MESSAGE_CONTEXT, + "! Session context data that is shared by all skills used by the assistant. + GLOBAL type T_MESSAGE_CONTEXT_GLOBAL, + "! Context data specific to particular skills used by the assistant. + SKILLS type T_MESSAGE_CONTEXT_SKILLS, + "! An object containing context data that is specific to particular integrations. + "! For more information, see the + "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-int + "! egrations). + INTEGRATIONS type JSONOBJECT, + end of T_MESSAGE_CONTEXT. + types: + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_IMG, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The URL of the image. + "! The `https:` URL of the image. SOURCE type STRING, "! The title to show before the response. TITLE type STRING, "! The description to show with the the response. DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! Descriptive text that can be used for screen readers or other situations where + "! the image cannot be seen. + ALT_TEXT type STRING, end of T_RT_RESP_GNRC_RT_RESP_TYP_IMG. + types: + "! No documentation available. + begin of T_TURN_EVENT_NODE_SOURCE, + "! The type of turn event. + TYPE type STRING, + "! A dialog node that was visited during processing of the input message. + DIALOG_NODE type STRING, + "! The title of the dialog node. + TITLE type STRING, + "! The condition that triggered the dialog node. + CONDITION type STRING, + end of T_TURN_EVENT_NODE_SOURCE. + types: + "! No documentation available. + begin of T_MSSG_OTPT_DBG_TRN_EVNT_TRN_8, + "! The type of turn event. + EVENT type STRING, + "! No documentation available. + SOURCE type T_TURN_EVENT_NODE_SOURCE, + "! The reason the dialog node was visited. + REASON type STRING, + end of T_MSSG_OTPT_DBG_TRN_EVNT_TRN_8. types: "!- "! An object that describes a response with response type
- "! `suggestion`. - begin of T_RT_RESPONSE_TYPE_SUGGESTION, + "! Session context data that is shared by all skills used by + "! the assistant. + begin of T_MSSG_CNTXT_GLOBAL_STATELESS, + "! Built-in system properties that apply to all skills used by the assistant. + SYSTEM type T_MSSG_CONTEXT_GLOBAL_SYSTEM, + "! The unique identifier of the session. + SESSION_ID type STRING, + end of T_MSSG_CNTXT_GLOBAL_STATELESS. + types: + "! No documentation available. + begin of T_MESSAGE_CONTEXT_STATELESS, + "! Session context data that is shared by all skills used by the assistant. + GLOBAL type T_MSSG_CNTXT_GLOBAL_STATELESS, + "! Context data specific to particular skills used by the assistant. + SKILLS type T_MESSAGE_CONTEXT_SKILLS, + "! An object containing context data that is specific to particular integrations. + "! For more information, see the + "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-int + "! egrations). + INTEGRATIONS type JSONOBJECT, + end of T_MESSAGE_CONTEXT_STATELESS. + types: + "! No documentation available. + begin of T_RT_RESP_TYPE_USER_DEFINED, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The title or introductory text to show before the response. - TITLE type STRING, - "! An array of objects describing the possible matching dialog nodes from which the - "! user can choose. - SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, - end of T_RT_RESPONSE_TYPE_SUGGESTION. - types: - "!- "! The user input utterance to classify.
- begin of T_BULK_CLASSIFY_UTTERANCE, - "! The text of the input utterance. - TEXT type STRING, - end of T_BULK_CLASSIFY_UTTERANCE. + "! An object containing any properties for the user-defined response type. + USER_DEFINED type JSONOBJECT, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_TYPE_USER_DEFINED. types: "!- "! The pagination data for the returned objects.
+ "! The pagination data for the returned objects. For more + "! information about using pagination, see [Pagination](#pagination). begin of T_LOG_PAGINATION, "! The URL that will return the next page of results, if any. NEXT_URL type STRING, @@ -791,17 +1260,6 @@ public section. "! A token identifying the next page of results. NEXT_CURSOR type STRING, end of T_LOG_PAGINATION. - types: - "!- "! An object that describes a response with response type
- "! `text`. - begin of T_RT_RESP_GNRC_RT_RESP_TYP_TXT, - "! The type of response returned by the dialog node. The specified response type - "! must be supported by the client application or channel. - RESPONSE_TYPE type STRING, - "! The text of the response. - TEXT type STRING, - end of T_RT_RESP_GNRC_RT_RESP_TYP_TXT. types: "! No documentation available. begin of T_AGENT_AVAILABILITY_MESSAGE, @@ -817,9 +1275,7 @@ public section. TARGET type MAP, end of T_DIA_ND_OTPT_CNNCT_T_AGNT_TR1. types: - "!- "! An object that describes a response with response type
- "! `connect_to_agent`. + "! No documentation available. begin of T_RT_RESP_TYP_CONNECT_TO_AGENT, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -840,10 +1296,11 @@ public section. "! property of the relevant node or the **topic** property of the dialog node "! response. TOPIC type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_TYP_CONNECT_TO_AGENT. - types: - "! No documentation available. - T_RUNTIME_RESPONSE_GENERIC type JSONOBJECT. types: "!"! Properties describing any spelling corrections in the user
@@ -860,6 +1317,9 @@ public section. "! spelling correction is enabled and autocorrection is disabled. SUGGESTED_TEXT type STRING, end of T_MESSAGE_OUTPUT_SPELLING. + types: + "! No documentation available. + T_RUNTIME_RESPONSE_GENERIC type JSONOBJECT. types: "!"! Assistant output to be rendered or processed by the client.
@@ -880,11 +1340,60 @@ public section. "! An object containing any custom properties included in the response. This object "! includes any arbitrary properties defined in the dialog JSON editor as part of "! the dialog node output. - USER_DEFINED type MAP, + USER_DEFINED type JSONOBJECT, "! Properties describing any spelling corrections in the user input that was "! received. SPELLING type T_MESSAGE_OUTPUT_SPELLING, end of T_MESSAGE_OUTPUT. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_CH1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel.+ "! An object defining the message input to be sent to the
+ "! assistant if the user selects the corresponding disambiguation option."! Optional properties that control how the assistant responds.
@@ -905,71 +1414,29 @@ public section. T_EMPTY_RESPONSE type JSONOBJECT. types: "! No documentation available. - begin of T_SESSION_RESPONSE, - "! The session ID. - SESSION_ID type STRING, - end of T_SESSION_RESPONSE. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_DT, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + end of T_RT_RESP_GNRC_RT_RESP_TYP_DT. types: "! No documentation available. - begin of T_RT_ENTTY_INTRPRTTN_SYS_DATE, - "! The calendar used to represent a recognized date (for example, `Gregorian`). - CALENDAR_TYPE type STRING, - "! A unique identifier used to associate a time and date. If the user input - "! contains a date and time that are mentioned together (for example, `Today at - "! 5`, the same **datetime_link** value is returned for both the `@sys-date` - "! and `@sys-time` entities). - DATETIME_LINK type STRING, - "! A locale-specific holiday name (such as `thanksgiving` or `christmas`). This - "! property is included when a `@sys-date` entity is recognized based on a - "! holiday name in the user input. - FESTIVAL type STRING, - "! The precision or duration of a time range specified by a recognized - "! `@sys-time` or `@sys-date` entity. - GRANULARITY type STRING, - "! A unique identifier used to associate multiple recognized `@sys-date`, - "! `@sys-time`, or `@sys-number` entities that are recognized as a range - "! of values in the user's input (for example, `from July 4 until July 14` or - "! `from 20 to 25`). - RANGE_LINK type STRING, - "! The word in the user input that indicates that a `sys-date` or `sys-time` entity - "! is part of an implied range where only one date or time is specified (for - "! example, `since` or `until`). - RANGE_MODIFIER type STRING, - "! A recognized mention of a relative day, represented numerically as an offset - "! from the current date (for example, `-1` for `yesterday` or `10` for `in ten - "! days`). - RELATIVE_DAY type NUMBER, - "! A recognized mention of a relative month, represented numerically as an offset - "! from the current month (for example, `1` for `next month` or `-3` for `three - "! months ago`). - RELATIVE_MONTH type NUMBER, - "! A recognized mention of a relative week, represented numerically as an offset - "! from the current week (for example, `2` for `in two weeks` or `-1` for `last - "! week). - RELATIVE_WEEK type NUMBER, - "! A recognized mention of a relative date range for a weekend, represented - "! numerically as an offset from the current weekend (for example, `0` for `this - "! weekend` or `-1` for `last weekend`). - RELATIVE_WEEKEND type NUMBER, - "! A recognized mention of a relative year, represented numerically as an offset - "! from the current year (for example, `1` for `next year` or `-5` for `five years - "! ago`). - RELATIVE_YEAR type NUMBER, - "! A recognized mention of a specific date, represented numerically as the date - "! within the month (for example, `30` for `June 30`.). - SPECIFIC_DAY type NUMBER, - "! A recognized mention of a specific day of the week as a lowercase string (for - "! example, `monday`). - SPECIFIC_DAY_OF_WEEK type STRING, - "! A recognized mention of a specific month, represented numerically (for example, - "! `7` for `July`). - SPECIFIC_MONTH type NUMBER, - "! A recognized mention of a specific quarter, represented numerically (for - "! example, `3` for `the third quarter`). - SPECIFIC_QUARTER type NUMBER, - "! A recognized mention of a specific year (for example, `2016`). - SPECIFIC_YEAR type NUMBER, - end of T_RT_ENTTY_INTRPRTTN_SYS_DATE. + begin of T_TURN_EVENT_CALLOUT_CALLOUT, + "! The type of callout. Currently, the only supported value is + "! `integration_interaction` (for calls to extensions). + TYPE type STRING, + "! For internal use only. + INTERNAL type JSONOBJECT, + "! The name of the variable where the callout result is stored. + RESULT_VARIABLE type STRING, + end of T_TURN_EVENT_CALLOUT_CALLOUT. + types: + "!+ "! The user input utterance to classify.
+ begin of T_BULK_CLASSIFY_UTTERANCE, + "! The text of the input utterance. + TEXT type STRING, + end of T_BULK_CLASSIFY_UTTERANCE. types: "! No documentation available. begin of T_BULK_CLASSIFY_OUTPUT, @@ -987,6 +1454,36 @@ public section. "! input utterances. OUTPUT type STANDARD TABLE OF T_BULK_CLASSIFY_OUTPUT WITH NON-UNIQUE DEFAULT KEY, end of T_BULK_CLASSIFY_RESPONSE. + types: + "! No documentation available. + begin of T_ENVIRONMENT, + "! The name of the environment. + NAME type STRING, + "! The description of the environment. + DESCRIPTION type STRING, + "! The assistant ID of the assistant the environment is associated with. + ASSISTANT_ID type STRING, + "! The environment ID of the environment. + ENVIRONMENT_ID type STRING, + "! The type of the environment. All environments other than the `draft` and `live` + "! environments have the type `staging`. + ENVIRONMENT type STRING, + "! An object describing the release that is currently deployed in the environment. + RELEASE_REFERENCE type T_BASE_ENV_RELEASE_REFERENCE, + "! The search skill orchestration settings for the environment. + ORCHESTRATION type T_BASE_ENV_ORCHESTRATION, + "! The session inactivity timeout setting for the environment (in seconds). + SESSION_TIMEOUT type INTEGER, + "! An array of objects describing the integrations that exist in the environment. + INTEGRATION_REFERENCES type STANDARD TABLE OF T_INTEGRATION_REFERENCE WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects identifying the skills (such as action and dialog) that + "! exist in the environment. + SKILL_REFERENCES type STANDARD TABLE OF T_ENVIRONMENT_SKILL WITH NON-UNIQUE DEFAULT KEY, + "! The timestamp for creation of the object. + CREATED type DATETIME, + "! The timestamp for the most recent update to the object. + UPDATED type DATETIME, + end of T_ENVIRONMENT. types: "! No documentation available. begin of T_BULK_CLASSIFY_INPUT, @@ -994,24 +1491,77 @@ public section. INPUT type STANDARD TABLE OF T_BULK_CLASSIFY_UTTERANCE WITH NON-UNIQUE DEFAULT KEY, end of T_BULK_CLASSIFY_INPUT. types: - "!- "! An object that describes a response with response type
- "! `image`. - begin of T_RUNTIME_RESPONSE_TYPE_IMAGE, - "! The type of response returned by the dialog node. The specified response type - "! must be supported by the client application or channel. - RESPONSE_TYPE type STRING, - "! The URL of the image. - SOURCE type STRING, - "! The title to show before the response. - TITLE type STRING, - "! The description to show with the the response. + "! No documentation available. + begin of T_BASE_ENVIRONMENT, + "! The name of the environment. + NAME type STRING, + "! The description of the environment. DESCRIPTION type STRING, - end of T_RUNTIME_RESPONSE_TYPE_IMAGE. + "! The assistant ID of the assistant the environment is associated with. + ASSISTANT_ID type STRING, + "! The environment ID of the environment. + ENVIRONMENT_ID type STRING, + "! The type of the environment. All environments other than the `draft` and `live` + "! environments have the type `staging`. + ENVIRONMENT type STRING, + "! An object describing the release that is currently deployed in the environment. + RELEASE_REFERENCE type T_BASE_ENV_RELEASE_REFERENCE, + "! The search skill orchestration settings for the environment. + ORCHESTRATION type T_BASE_ENV_ORCHESTRATION, + "! The session inactivity timeout setting for the environment (in seconds). + SESSION_TIMEOUT type INTEGER, + "! An array of objects describing the integrations that exist in the environment. + INTEGRATION_REFERENCES type STANDARD TABLE OF T_INTEGRATION_REFERENCE WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects identifying the skills (such as action and dialog) that + "! exist in the environment. + SKILL_REFERENCES type STANDARD TABLE OF T_ENVIRONMENT_SKILL WITH NON-UNIQUE DEFAULT KEY, + "! The timestamp for creation of the object. + CREATED type DATETIME, + "! The timestamp for the most recent update to the object. + UPDATED type DATETIME, + end of T_BASE_ENVIRONMENT. types: "!- "! An object that describes a response with response type
- "! `connect_to_agent`. + "! An object that identifies the dialog element that generated + "! the error message. + begin of T_LOG_MESSAGE_SOURCE_HANDLER, + "! A string that indicates the type of dialog element that generated the error + "! message. + TYPE type STRING, + "! The unique identifier of the action that generated the error message. + ACTION type STRING, + "! The unique identifier of the step that generated the error message. + STEP type STRING, + "! The unique identifier of the handler that generated the error message. + HANDLER type STRING, + end of T_LOG_MESSAGE_SOURCE_HANDLER. + types: + "! No documentation available. + begin of T_BASE_MESSAGE_CONTEXT_SKILL, + "! An object containing any arbitrary variables that can be read and written by a + "! particular skill. + USER_DEFINED type JSONOBJECT, + "! System context data used by the skill. + SYSTEM type T_MESSAGE_CONTEXT_SKILL_SYSTEM, + end of T_BASE_MESSAGE_CONTEXT_SKILL. + types: + "! No documentation available. + begin of T_TURN_EVENT_ACTION_FINISHED, + "! The type of turn event. + EVENT type STRING, + "! No documentation available. + SOURCE type T_TURN_EVENT_ACTION_SOURCE, + "! The time when the action started processing the message. + ACTION_START_TIME type STRING, + "! The type of condition (if any) that is defined for the action. + CONDITION_TYPE type STRING, + "! The reason the action finished processing. + REASON type STRING, + "! The state of all action variables at the time the action finished. + ACTION_VARIABLES type JSONOBJECT, + end of T_TURN_EVENT_ACTION_FINISHED. + types: + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_CN1, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1032,6 +1582,10 @@ public section. "! property of the relevant node or the **topic** property of the dialog node "! response. TOPIC type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_GNRC_RT_RESP_TYP_CN1. types: "!
@@ -1046,53 +1600,93 @@ public section.
"! **return_context**=`true` in the message request. Full context is always
"! included in logs.
CONTEXT type T_MESSAGE_CONTEXT,
+ "! A string value that identifies the user who is interacting with the assistant.
+ "! The client must provide a unique identifier for each individual end user who
+ "! accesses the application. For user-based plans, this user ID is used to
+ "! identify unique users for billing purposes. This string cannot contain carriage
+ "! return, newline, or tab characters. If no value is specified in the input,
+ "! **user_id** is automatically set to the value of
+ "! **context.global.session_id**.
+ "!
+ "! **Note:** This property is the same as the **user_id** property in the global
+ "! system context.
+ USER_ID type STRING,
end of T_MESSAGE_RESPONSE.
types:
- "!
- "! A stateful message request formatted for the Watson
- "! Assistant service. - begin of T_MESSAGE_REQUEST, - "! An input object that includes the input text. - INPUT type T_MESSAGE_INPUT, - "! Context data for the conversation. You can use this property to set or modify - "! context variables, which can also be accessed by dialog nodes. The context is - "! stored by the assistant on a per-session basis.- "! An object that describes a response with response type
- "! `pause`. + "! The pagination data for the returned objects. For more + "! information about using pagination, see [Pagination](#pagination). + begin of T_PAGINATION, + "! The URL that will return the same page of results. + REFRESH_URL type STRING, + "! The URL that will return the next page of results. + NEXT_URL type STRING, + "! The total number of objects that satisfy the request. This total includes all + "! results, not just those included in the current page. + TOTAL type INTEGER, + "! Reserved for future use. + MATCHED type INTEGER, + "! A token identifying the current page of results. + REFRESH_CURSOR type STRING, + "! A token identifying the next page of results. + NEXT_CURSOR type STRING, + end of T_PAGINATION. + types: + "! No documentation available. + begin of T_ENVIRONMENT_COLLECTION, + "! An array of objects describing the environments associated with an assistant. + ENVIRONMENTS type STANDARD TABLE OF T_ENVIRONMENT WITH NON-UNIQUE DEFAULT KEY, + "! The pagination data for the returned objects. For more information about using + "! pagination, see [Pagination](#pagination). + PAGINATION type T_PAGINATION, + end of T_ENVIRONMENT_COLLECTION. + types: + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_PAUSE, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1101,19 +1695,96 @@ public section. TIME type INTEGER, "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_PAUSE. types: "! No documentation available. - begin of T_LOG_COLLECTION, - "! An array of objects describing log events. - LOGS type STANDARD TABLE OF T_LOG WITH NON-UNIQUE DEFAULT KEY, - "! The pagination data for the returned objects. - PAGINATION type T_LOG_PAGINATION, - end of T_LOG_COLLECTION. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_US1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! An object containing any properties for the user-defined response type. + USER_DEFINED type JSONOBJECT, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_US1. + types: + "!+ "! An object containing segments of text from search results
+ "! with query-matching text highlighted using HTML `<em>` tags. + begin of T_SEARCH_RESULT_HIGHLIGHT, + "! An array of strings containing segments taken from body text in the search + "! results, with query-matching substrings highlighted. + BODY type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! An array of strings containing segments taken from title text in the search + "! results, with query-matching substrings highlighted. + TITLE type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! An array of strings containing segments taken from URLs in the search results, + "! with query-matching substrings highlighted. + URL type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_SEARCH_RESULT_HIGHLIGHT. + types: + "!+ "! An object containing search result metadata from the
+ "! Discovery service. + begin of T_SEARCH_RESULT_METADATA, + "! The confidence score for the given result, as returned by the Discovery service. + "! + CONFIDENCE type DOUBLE, + "! An unbounded measure of the relevance of a particular result, dependent on the + "! query and matching document. A higher score indicates a greater match to the + "! query parameters. + SCORE type DOUBLE, + end of T_SEARCH_RESULT_METADATA. types: "!- "! An object that describes a response with response type
- "! `search`. + "! An object specifing a segment of text that was identified as + "! a direct answer to the search query. + begin of T_SEARCH_RESULT_ANSWER, + "! The text of the answer. + TEXT type STRING, + "! The confidence score for the answer, as returned by the Discovery service. + CONFIDENCE type DOUBLE, + end of T_SEARCH_RESULT_ANSWER. + types: + "! No documentation available. + begin of T_SEARCH_RESULT, + "! The unique identifier of the document in the Discovery service collection.- "! Information specific to particular skills used by the
- "! assistant.- "! An object that describes a response with response type
- "! `pause`. + "! No documentation available. + begin of T_RUNTIME_RESPONSE_TYPE_IFRAME, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the embeddable content. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the the response. + DESCRIPTION type STRING, + "! The URL of an image that shows a preview of the embedded content. + IMAGE_URL type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RUNTIME_RESPONSE_TYPE_IFRAME. + types: + "! No documentation available. begin of T_RT_RESP_GNRC_RT_RESP_TYP_PS, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. @@ -1148,6 +1842,10 @@ public section. TIME type INTEGER, "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESP_GNRC_RT_RESP_TYP_PS. types: "!
@@ -1159,134 +1857,969 @@ public section.
"! variables. The context is not stored by the assistant; to maintain session
"! state, include the context from the response in the next message.
CONTEXT type T_MESSAGE_CONTEXT_STATELESS,
+ "! A string value that identifies the user who is interacting with the assistant.
+ "! The client must provide a unique identifier for each individual end user who
+ "! accesses the application. For user-based plans, this user ID is used to
+ "! identify unique users for billing purposes. This string cannot contain carriage
+ "! return, newline, or tab characters. If no value is specified in the input,
+ "! **user_id** is automatically set to the value of
+ "! **context.global.session_id**.
+ "!
+ "! **Note:** This property is the same as the **user_id** property in the global
+ "! system context.
+ USER_ID type STRING,
end of T_MESSAGE_RESPONSE_STATELESS.
+ types:
+ "! No documentation available.
+ begin of T_ERROR_DETAIL,
+ "! Description of a specific constraint violation.
+ MESSAGE type STRING,
+ "! The location of the constraint violation.
+ PATH type STRING,
+ end of T_ERROR_DETAIL.
+ types:
+ "! No documentation available.
+ begin of T_TURN_EVENT_HANDLER_VISITED,
+ "! The type of turn event.
+ EVENT type STRING,
+ "! No documentation available.
+ SOURCE type T_TURN_EVENT_ACTION_SOURCE,
+ "! The time when the action started processing the message.
+ ACTION_START_TIME type STRING,
+ end of T_TURN_EVENT_HANDLER_VISITED.
types:
"!
"! Session context data that is shared by all skills used by
- "! the Assistant. + "! the assistant. begin of T_BASE_MESSAGE_CONTEXT_GLOBAL, "! Built-in system properties that apply to all skills used by the assistant. SYSTEM type T_MSSG_CONTEXT_GLOBAL_SYSTEM, end of T_BASE_MESSAGE_CONTEXT_GLOBAL. types: "!- "! Contains information specific to a particular skill used by
- "! the Assistant. The property name must be the same as the name of the skill (for - "! example, `main skill`). - begin of T_MESSAGE_CONTEXT_SKILL, - "! Arbitrary variables that can be read and written by a particular skill. - USER_DEFINED type MAP, - "! System context data used by the skill. - SYSTEM type T_MESSAGE_CONTEXT_SKILL_SYSTEM, - end of T_MESSAGE_CONTEXT_SKILL. + "! An object that identifies the dialog element that generated + "! the error message. + begin of T_LOG_MESSAGE_SOURCE_DIA_NODE, + "! A string that indicates the type of dialog element that generated the error + "! message. + TYPE type STRING, + "! The unique identifier of the dialog node that generated the error message. + DIALOG_NODE type STRING, + end of T_LOG_MESSAGE_SOURCE_DIA_NODE. types: - "!- "! An object that describes a response with response type
- "! `search`. - begin of T_RT_RESP_GNRC_RT_RESP_TYP_SR1, + "! No documentation available. + begin of T_RT_ENTTY_INTRPRTTN_SYS_NUM, + "! A recognized numeric value, represented as an integer or double. + NUMERIC_VALUE type NUMBER, + "! A unique identifier used to associate multiple recognized `@sys-date`, + "! `@sys-time`, or `@sys-number` entities that are recognized as a range + "! of values in the user's input (for example, `from July 4 until July 14` or + "! `from 20 to 25`). + RANGE_LINK type STRING, + "! The type of numeric value recognized in the user input (`integer` or + "! `rational`). + SUBTYPE type STRING, + end of T_RT_ENTTY_INTRPRTTN_SYS_NUM. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_SG1, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel. RESPONSE_TYPE type STRING, - "! The title or introductory text to show before the response. This text is defined - "! in the search skill configuration. - HEADER type STRING, - "! An array of objects that contains the search results to be displayed in the - "! initial response to the user. - PRIMARY_RESULTS type STANDARD TABLE OF T_SEARCH_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! An array of objects that contains additional search results that can be - "! displayed to the user upon request. - ADDITIONAL_RESULTS type STANDARD TABLE OF T_SEARCH_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_RT_RESP_GNRC_RT_RESP_TYP_SR1. + "! The title or introductory text to show before the response. + TITLE type STRING, + "! An array of objects describing the possible matching dialog nodes from which the + "! user can choose. + SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_SG1. + types: + "! No documentation available. + begin of T_ERROR_RESPONSE, + "! General description of an error. + ERROR type STRING, + "! Collection of specific constraint violations associated with the error. + ERRORS type STANDARD TABLE OF T_ERROR_DETAIL WITH NON-UNIQUE DEFAULT KEY, + "! HTTP status code for the error response. + CODE type INTEGER, + end of T_ERROR_RESPONSE. types: "!- "! An object that describes a response with response type
- "! `option`. - begin of T_RT_RESP_GNRC_RT_RESP_TYP_OPT, + "! Optional properties that control how the assistant responds. + begin of T_MESSAGE_INPUT_OPT_STATELESS, + "! Whether to restart dialog processing at the root of the dialog, regardless of + "! any previously visited nodes. **Note:** This does not affect `turn_count` or + "! any other context variables. + RESTART type BOOLEAN, + "! Whether to return more than one intent. Set to `true` to return all matching + "! intents. + ALTERNATE_INTENTS type BOOLEAN, + "! Spelling correction options for the message. Any options specified on an + "! individual message override the settings configured for the skill. + SPELLING type T_MESSAGE_INPUT_OPT_SPELLING, + "! Whether to return additional diagnostic information. Set to `true` to return + "! additional information in the `output.debug` property. + DEBUG type BOOLEAN, + end of T_MESSAGE_INPUT_OPT_STATELESS. + types: + "!+ "! An input object that includes the input text.
+ begin of T_BASE_MESSAGE_INPUT, + "! The type of the message:+ "! An input object that includes the input text.
+ begin of T_MESSAGE_INPUT_STATELESS, + "! The type of the message:+ "! A stateless message request formatted for the Watson
+ "! Assistant service. + begin of T_MESSAGE_REQUEST_STATELESS, + "! An input object that includes the input text. + INPUT type T_MESSAGE_INPUT_STATELESS, + "! Context data for the conversation. You can use this property to set or modify + "! context variables, which can also be accessed by dialog nodes. The context is + "! not stored by the assistant. To maintain session state, include the context + "! from the previous response.+ "! An object that identifies the dialog element that generated
+ "! the error message. + begin of T_LOG_MESSAGE_SOURCE_STEP, + "! A string that indicates the type of dialog element that generated the error + "! message. + TYPE type STRING, + "! The unique identifier of the action that generated the error message. + ACTION type STRING, + "! The unique identifier of the step that generated the error message. + STEP type STRING, + end of T_LOG_MESSAGE_SOURCE_STEP. + types: + "! No documentation available. + begin of T_TURN_EVENT_STEP_ANSWERED, + "! The type of turn event. + EVENT type STRING, + "! No documentation available. + SOURCE type T_TURN_EVENT_ACTION_SOURCE, + "! The type of condition (if any) that is defined for the action. + CONDITION_TYPE type STRING, + "! The time when the action started processing the message. + ACTION_START_TIME type STRING, + "! Whether the step was answered in response to a prompt from the assistant. If + "! this property is `false`, the user provided the answer without visiting the + "! step. + PROMPTED type BOOLEAN, + end of T_TURN_EVENT_STEP_ANSWERED. + types: + "! No documentation available. + begin of T_SKILLS_ASYNC_REQUEST_STATUS, + "! The assistant ID of the assistant. + ASSISTANT_ID type STRING, + "! The current status of the asynchronous operation:List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_DIALOG_LOG_MESSAGE type string value '|LEVEL|MESSAGE|', - T_DIALOG_NODES_VISITED type string value '|', - T_MESSAGE_OUTPUT_DEBUG type string value '|', - T_RT_ENTTY_INTRPRTTN_SYS_NUM type string value '|', - T_RT_ENTITY_INTERPRETATION type string value '|', - T_MESSAGE_INPUT_OPT_SPELLING type string value '|', - T_CAPTURE_GROUP type string value '|GROUP|', - T_RUNTIME_ENTITY_ALTERNATIVE type string value '|', - T_RUNTIME_ENTITY_ROLE type string value '|', - T_RUNTIME_ENTITY type string value '|ENTITY|LOCATION|VALUE|', - T_MESSAGE_INPUT_OPTIONS type string value '|', - T_RUNTIME_INTENT type string value '|INTENT|CONFIDENCE|', + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the audio player cannot be seen. + ALT_TEXT type STRING, + end of T_RUNTIME_RESPONSE_TYPE_AUDIO. + types: + "! No documentation available. + begin of T_MSSG_OTPT_DBG_TRN_EVNT_TRN_7, + "! The type of turn event. + EVENT type STRING, + "! No documentation available. + SOURCE type T_TURN_EVENT_ACTION_SOURCE, + "! No documentation available. + ERROR type T_TURN_EVENT_SEARCH_ERROR, + end of T_MSSG_OTPT_DBG_TRN_EVNT_TRN_7. + types: + "!+ "! An object that identifies the dialog element that generated
+ "! the error message. + begin of T_LOG_MESSAGE_SOURCE_ACTION, + "! A string that indicates the type of dialog element that generated the error + "! message. + TYPE type STRING, + "! The unique identifier of the action that generated the error message. + ACTION type STRING, + end of T_LOG_MESSAGE_SOURCE_ACTION. + types: + "! No documentation available. + begin of T_RUNTIME_RESPONSE_TYPE_IMAGE, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the image. + SOURCE type STRING, + "! The title to show before the response. + TITLE type STRING, + "! The description to show with the the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! Descriptive text that can be used for screen readers or other situations where + "! the image cannot be seen. + ALT_TEXT type STRING, + end of T_RUNTIME_RESPONSE_TYPE_IMAGE. + types: + "! No documentation available. + begin of T_TURN_EVENT_STEP_VISITED, + "! The type of turn event. + EVENT type STRING, + "! No documentation available. + SOURCE type T_TURN_EVENT_ACTION_SOURCE, + "! The type of condition (if any) that is defined for the action. + CONDITION_TYPE type STRING, + "! The time when the action started processing the message. + ACTION_START_TIME type STRING, + "! Whether the step collects a customer response. + HAS_QUESTION type BOOLEAN, + end of T_TURN_EVENT_STEP_VISITED. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_AD, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the audio clip. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the the response. + DESCRIPTION type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + "! For internal use only. + CHANNEL_OPTIONS type JSONOBJECT, + "! Descriptive text that can be used for screen readers or other situations where + "! the audio player cannot be seen. + ALT_TEXT type STRING, + end of T_RT_RESP_GNRC_RT_RESP_TYP_AD. + types: + "! No documentation available. + begin of T_TURN_EVENT_ACTION_VISITED, + "! The type of turn event. + EVENT type STRING, + "! No documentation available. + SOURCE type T_TURN_EVENT_ACTION_SOURCE, + "! The time when the action started processing the message. + ACTION_START_TIME type STRING, + "! The type of condition (if any) that is defined for the action. + CONDITION_TYPE type STRING, + "! The reason the action was visited. + REASON type STRING, + "! The variable where the result of the call to the action is stored. Included only + "! if **reason**=`subaction_return`. + RESULT_VARIABLE type STRING, + end of T_TURN_EVENT_ACTION_VISITED. + types: + "!+ "! A stateful message request formatted for the Watson
+ "! Assistant service. + begin of T_MESSAGE_REQUEST, + "! An input object that includes the input text. + INPUT type T_MESSAGE_INPUT, + "! Context data for the conversation. You can use this property to set or modify + "! context variables, which can also be accessed by dialog nodes. The context is + "! stored by the assistant on a per-session basis.+ "! A request to deploy a release to the specified environment.
+ begin of T_DEPLOY_RELEASE_REQUEST, + "! The environment ID of the environment where the release is to be deployed. + ENVIRONMENT_ID type STRING, + end of T_DEPLOY_RELEASE_REQUEST. + types: + "! No documentation available. + begin of T_AUDIT_PROPERTIES, + "! The timestamp for creation of the object. + CREATED type DATETIME, + "! The timestamp for the most recent update to the object. + UPDATED type DATETIME, + end of T_AUDIT_PROPERTIES. + types: + "! No documentation available. + begin of T_CREATE_SESSION, + "! An optional object containing analytics data. Currently, this data is used only + "! for events sent to the Segment extension. + ANALYTICS type T_REQUEST_ANALYTICS, + end of T_CREATE_SESSION. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_SR1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The title or introductory text to show before the response. This text is defined + "! in the search skill configuration. + HEADER type STRING, + "! An array of objects that contains the search results to be displayed in the + "! initial response to the user. + PRIMARY_RESULTS type STANDARD TABLE OF T_SEARCH_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects that contains additional search results that can be + "! displayed to the user upon request. + ADDITIONAL_RESULTS type STANDARD TABLE OF T_SEARCH_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_SR1. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_IF1, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The `https:` URL of the embeddable content. + SOURCE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the the response. + DESCRIPTION type STRING, + "! The URL of an image that shows a preview of the embedded content. + IMAGE_URL type STRING, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_IF1. + types: + "! No documentation available. + begin of T_RT_RESP_GNRC_RT_RESP_TYP_OPT, + "! The type of response returned by the dialog node. The specified response type + "! must be supported by the client application or channel. + RESPONSE_TYPE type STRING, + "! The title or introductory text to show before the response. + TITLE type STRING, + "! The description to show with the the response. + DESCRIPTION type STRING, + "! The preferred type of control to display. + PREFERENCE type STRING, + "! An array of objects describing the options from which the user can choose. + OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of objects specifying channels for which the response is intended. If + "! **channels** is present, the response is intended for a built-in integration + "! and should not be handled by an API client. + CHANNELS type STANDARD TABLE OF T_RESPONSE_GENERIC_CHANNEL WITH NON-UNIQUE DEFAULT KEY, + end of T_RT_RESP_GNRC_RT_RESP_TYP_OPT. + +constants: + "!List of required fields per type.
+ begin of C_REQUIRED_FIELDS, + T_RESPONSE_GENERIC_CHANNEL type string value '|', + T_RUNTIME_RESPONSE_TYPE_VIDEO type string value '|RESPONSE_TYPE|SOURCE|', + T_TURN_EVENT_ACTION_SOURCE type string value '|', + T_TURN_EVENT_SEARCH_ERROR type string value '|', + T_TURN_EVENT_SEARCH type string value '|', + T_DIALOG_LOG_MESSAGE type string value '|LEVEL|MESSAGE|CODE|', + T_DIALOG_NODE_VISITED type string value '|', + T_MESSAGE_OUTPUT_DEBUG type string value '|', + T_RT_ENTITY_INTERPRETATION type string value '|', + T_MESSAGE_INPUT_OPT_SPELLING type string value '|', + T_CAPTURE_GROUP type string value '|GROUP|', + T_RUNTIME_ENTITY_ALTERNATIVE type string value '|', + T_RUNTIME_ENTITY_ROLE type string value '|', + T_RUNTIME_ENTITY type string value '|ENTITY|VALUE|', + T_REQUEST_ANALYTICS type string value '|', + T_MESSAGE_INPUT_ATTACHMENT type string value '|URL|', + T_MESSAGE_INPUT_OPTIONS type string value '|', + T_RUNTIME_INTENT type string value '|INTENT|', T_MESSAGE_INPUT type string value '|', T_DIA_ND_OUTPUT_OPT_ELEM_VALUE type string value '|', T_DIA_NODE_OUTPUT_OPT_ELEMENT type string value '|LABEL|VALUE|', T_RUNTIME_RESPONSE_TYPE_OPTION type string value '|RESPONSE_TYPE|TITLE|OPTIONS|', - T_DIALOG_SUGGESTION_VALUE type string value '|', - T_DIALOG_SUGGESTION type string value '|LABEL|VALUE|', - T_MSSG_OTPT_DBG_AT_LEARN_MODEL type string value '|', - T_MSSG_OUTPUT_DEBUG_AUTO_LEARN type string value '|', - T_SEARCH_RESULT_HIGHLIGHT type string value '|', - T_RT_RESP_GNRC_RT_RESP_TYP_SG1 type string value '|RESPONSE_TYPE|TITLE|SUGGESTIONS|', - T_ERROR_DETAIL type string value '|MESSAGE|', - T_ERROR_RESPONSE type string value '|ERROR|CODE|', - T_SEARCH_RESULT_METADATA type string value '|', - T_SEARCH_RESULT type string value '|ID|RESULT_METADATA|', - T_MESSAGE_INPUT_OPT_STATELESS type string value '|', - T_BASE_MESSAGE_INPUT type string value '|', + T_STATUS_ERROR type string value '|', + T_SEARCH_SETTINGS_MESSAGES type string value '|SUCCESS|ERROR|NO_RESULT|', + T_SRCH_SETTINGS_SCHEMA_MAPPING type string value '|URL|BODY|TITLE|', + T_SRCH_STTNGS_DSCVRY_ATHNTCTN type string value '|', + T_SEARCH_SETTINGS_DISCOVERY type string value '|INSTANCE_ID|PROJECT_ID|URL|AUTHENTICATION|', + T_SEARCH_SETTINGS type string value '|DISCOVERY|MESSAGES|SCHEMA_MAPPING|', + T_SEARCH_SKILL_WARNING type string value '|', + T_SKILL_IMPORT type string value '|LANGUAGE|TYPE|', + T_ASSISTANT_STATE type string value '|ACTION_DISABLED|DIALOG_DISABLED|', + T_SKILLS_IMPORT type string value '|ASSISTANT_SKILLS|ASSISTANT_STATE|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_3 type string value '|', + T_SKILL type string value '|LANGUAGE|TYPE|', + T_BASE_ENV_ORCHESTRATION type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_VD type string value '|RESPONSE_TYPE|SOURCE|', + T_CHANNEL_TRANSFER_TARGET_CHAT type string value '|', + T_CHANNEL_TRANSFER_TARGET type string value '|', + T_CHANNEL_TRANSFER_INFO type string value '|TARGET|', + T_RT_RESP_TYPE_CHANNEL_TRANS type string value '|RESPONSE_TYPE|MESSAGE_TO_USER|TRANSFER_INFO|', T_RUNTIME_RESPONSE_TYPE_TEXT type string value '|RESPONSE_TYPE|TEXT|', T_DIALOG_NODE_ACTION type string value '|NAME|RESULT_VARIABLE|', + T_BASE_ENV_RELEASE_REFERENCE type string value '|', T_RT_ENTTY_INTRPRTTN_SYS_TIME type string value '|', + T_RELEASE_SKILL type string value '|SKILL_ID|', + T_RELEASE_CONTENT type string value '|', + T_ENVIRONMENT_REFERENCE type string value '|', + T_RELEASE type string value '|', + T_INTEGRATION_REFERENCE type string value '|', + T_ENVIRONMENT_SKILL type string value '|SKILL_ID|', + T_UPDATE_ENVIRONMENT type string value '|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_2 type string value '|', + T_MESSAGE_INPUT_OPT_AUTO_LEARN type string value '|', T_MSSG_CONTEXT_GLOBAL_SYSTEM type string value '|', T_MESSAGE_CONTEXT_GLOBAL type string value '|', - T_MESSAGE_INPUT_OPT_AUTO_LEARN type string value '|', - T_MESSAGE_CONTEXT type string value '|', T_MESSAGE_CONTEXT_SKILL_SYSTEM type string value '|', + T_MESSAGE_CONTEXT_SKILL_ACTION type string value '|', + T_MESSAGE_CONTEXT_SKILL_DIALOG type string value '|', + T_MESSAGE_CONTEXT_SKILLS type string value '|', + T_MESSAGE_CONTEXT type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_IMG type string value '|RESPONSE_TYPE|SOURCE|', + T_TURN_EVENT_NODE_SOURCE type string value '|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_8 type string value '|', T_MSSG_CNTXT_GLOBAL_STATELESS type string value '|', T_MESSAGE_CONTEXT_STATELESS type string value '|', - T_MESSAGE_INPUT_STATELESS type string value '|', - T_MESSAGE_REQUEST_STATELESS type string value '|', - T_RT_RESP_GNRC_RT_RESP_TYP_IMG type string value '|RESPONSE_TYPE|SOURCE|', - T_RT_RESPONSE_TYPE_SUGGESTION type string value '|RESPONSE_TYPE|TITLE|SUGGESTIONS|', - T_BULK_CLASSIFY_UTTERANCE type string value '|TEXT|', + T_RT_RESP_TYPE_USER_DEFINED type string value '|RESPONSE_TYPE|USER_DEFINED|', T_LOG_PAGINATION type string value '|', - T_RT_RESP_GNRC_RT_RESP_TYP_TXT type string value '|RESPONSE_TYPE|TEXT|', T_AGENT_AVAILABILITY_MESSAGE type string value '|', T_DIA_ND_OTPT_CNNCT_T_AGNT_TR1 type string value '|', T_RT_RESP_TYP_CONNECT_TO_AGENT type string value '|RESPONSE_TYPE|', T_MESSAGE_OUTPUT_SPELLING type string value '|', T_MESSAGE_OUTPUT type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_CH1 type string value '|RESPONSE_TYPE|MESSAGE_TO_USER|TRANSFER_INFO|', + T_DIALOG_SUGGESTION_VALUE type string value '|', + T_DIALOG_SUGGESTION type string value '|LABEL|VALUE|', T_BASE_MESSAGE_INPUT_OPTIONS type string value '|', - T_SESSION_RESPONSE type string value '|SESSION_ID|', - T_RT_ENTTY_INTRPRTTN_SYS_DATE type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_DT type string value '|RESPONSE_TYPE|', + T_TURN_EVENT_CALLOUT_CALLOUT type string value '|', + T_BULK_CLASSIFY_UTTERANCE type string value '|TEXT|', T_BULK_CLASSIFY_OUTPUT type string value '|', T_BULK_CLASSIFY_RESPONSE type string value '|', + T_ENVIRONMENT type string value '|SESSION_TIMEOUT|SKILL_REFERENCES|', T_BULK_CLASSIFY_INPUT type string value '|INPUT|', - T_RUNTIME_RESPONSE_TYPE_IMAGE type string value '|RESPONSE_TYPE|SOURCE|', + T_BASE_ENVIRONMENT type string value '|', + T_LOG_MESSAGE_SOURCE_HANDLER type string value '|TYPE|ACTION|HANDLER|', + T_BASE_MESSAGE_CONTEXT_SKILL type string value '|', + T_TURN_EVENT_ACTION_FINISHED type string value '|', T_RT_RESP_GNRC_RT_RESP_TYP_CN1 type string value '|RESPONSE_TYPE|', - T_MESSAGE_RESPONSE type string value '|OUTPUT|', - T_MESSAGE_REQUEST type string value '|', - T_LOG type string value '|LOG_ID|REQUEST|RESPONSE|ASSISTANT_ID|SESSION_ID|SKILL_ID|SNAPSHOT|REQUEST_TIMESTAMP|RESPONSE_TIMESTAMP|LANGUAGE|', + T_MESSAGE_RESPONSE type string value '|OUTPUT|USER_ID|', + T_TURN_EVENT_CALLOUT_ERROR type string value '|', + T_TURN_EVENT_CALLOUT type string value '|', + T_ASSISTANT_SKILL type string value '|SKILL_ID|', + T_ASSISTANT_DATA type string value '|LANGUAGE|', + T_PAGINATION type string value '|REFRESH_URL|', + T_ENVIRONMENT_COLLECTION type string value '|ENVIRONMENTS|PAGINATION|', T_RUNTIME_RESPONSE_TYPE_PAUSE type string value '|RESPONSE_TYPE|TIME|', - T_LOG_COLLECTION type string value '|LOGS|PAGINATION|', + T_RT_RESP_GNRC_RT_RESP_TYP_US1 type string value '|RESPONSE_TYPE|USER_DEFINED|', + T_SEARCH_RESULT_HIGHLIGHT type string value '|', + T_SEARCH_RESULT_METADATA type string value '|', + T_SEARCH_RESULT_ANSWER type string value '|TEXT|CONFIDENCE|', + T_SEARCH_RESULT type string value '|ID|RESULT_METADATA|', T_RUNTIME_RESPONSE_TYPE_SEARCH type string value '|RESPONSE_TYPE|HEADER|PRIMARY_RESULTS|ADDITIONAL_RESULTS|', + T_SKILLS_EXPORT type string value '|ASSISTANT_SKILLS|ASSISTANT_STATE|', + T_RUNTIME_RESPONSE_TYPE_IFRAME type string value '|RESPONSE_TYPE|SOURCE|', T_RT_RESP_GNRC_RT_RESP_TYP_PS type string value '|RESPONSE_TYPE|TIME|', T_MESSAGE_RESPONSE_STATELESS type string value '|OUTPUT|CONTEXT|', + T_ERROR_DETAIL type string value '|MESSAGE|', + T_TURN_EVENT_HANDLER_VISITED type string value '|', T_BASE_MESSAGE_CONTEXT_GLOBAL type string value '|', - T_MESSAGE_CONTEXT_SKILL type string value '|', + T_LOG_MESSAGE_SOURCE_DIA_NODE type string value '|TYPE|DIALOG_NODE|', + T_RT_ENTTY_INTRPRTTN_SYS_NUM type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_SG1 type string value '|RESPONSE_TYPE|TITLE|SUGGESTIONS|', + T_ERROR_RESPONSE type string value '|ERROR|CODE|', + T_MESSAGE_INPUT_OPT_STATELESS type string value '|', + T_BASE_MESSAGE_INPUT type string value '|', + T_UPDATE_SKILL type string value '|', + T_BASE_SKILL type string value '|', + T_RUNTIME_RESPONSE_TYPE_DATE type string value '|RESPONSE_TYPE|', + T_RELEASE_COLLECTION type string value '|RELEASES|PAGINATION|', + T_ASSISTANT_COLLECTION type string value '|ASSISTANTS|PAGINATION|', + T_TURN_EVENT_NODE_VISITED type string value '|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_5 type string value '|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_6 type string value '|', + T_MESSAGE_INPUT_STATELESS type string value '|', + T_MESSAGE_REQUEST_STATELESS type string value '|', + T_RT_RESPONSE_TYPE_SUGGESTION type string value '|RESPONSE_TYPE|TITLE|SUGGESTIONS|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_4 type string value '|', + T_LOG_MESSAGE_SOURCE_STEP type string value '|TYPE|ACTION|STEP|', + T_TURN_EVENT_STEP_ANSWERED type string value '|', + T_SKILLS_ASYNC_REQUEST_STATUS type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_TXT type string value '|RESPONSE_TYPE|TEXT|', + T_SESSION_RESPONSE type string value '|SESSION_ID|', + T_RT_ENTTY_INTRPRTTN_SYS_DATE type string value '|', + T_RUNTIME_RESPONSE_TYPE_AUDIO type string value '|RESPONSE_TYPE|SOURCE|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_7 type string value '|', + T_LOG_MESSAGE_SOURCE_ACTION type string value '|TYPE|ACTION|', + T_RUNTIME_RESPONSE_TYPE_IMAGE type string value '|RESPONSE_TYPE|SOURCE|', + T_TURN_EVENT_STEP_VISITED type string value '|', + T_RT_RESP_GNRC_RT_RESP_TYP_AD type string value '|RESPONSE_TYPE|SOURCE|', + T_TURN_EVENT_ACTION_VISITED type string value '|', + T_MESSAGE_REQUEST type string value '|', + T_LOG type string value '|LOG_ID|REQUEST|RESPONSE|ASSISTANT_ID|SESSION_ID|SKILL_ID|SNAPSHOT|REQUEST_TIMESTAMP|RESPONSE_TIMESTAMP|LANGUAGE|', + T_MSSG_OTPT_DBG_TRN_EVNT_TRN_1 type string value '|', + T_LOG_COLLECTION type string value '|LOGS|PAGINATION|', + T_BASE_SKILL_REFERENCE type string value '|SKILL_ID|', + T_DEPLOY_RELEASE_REQUEST type string value '|ENVIRONMENT_ID|', + T_AUDIT_PROPERTIES type string value '|', + T_CREATE_SESSION type string value '|', T_RT_RESP_GNRC_RT_RESP_TYP_SR1 type string value '|RESPONSE_TYPE|HEADER|PRIMARY_RESULTS|ADDITIONAL_RESULTS|', + T_RT_RESP_GNRC_RT_RESP_TYP_IF1 type string value '|RESPONSE_TYPE|SOURCE|', T_RT_RESP_GNRC_RT_RESP_TYP_OPT type string value '|RESPONSE_TYPE|TITLE|OPTIONS|', __DUMMY type string value SPACE, end of C_REQUIRED_FIELDS . @@ -1295,6 +2828,31 @@ constants: "!Map ABAP identifiers to service identifiers.
begin of C_ABAPNAME_DICTIONARY, MESSAGE type string value 'message', + ASSISTANTS type string value 'assistants', + PAGINATION type string value 'pagination', + ASSISTANT_ID type string value 'assistant_id', + NAME type string value 'name', + DESCRIPTION type string value 'description', + LANGUAGE type string value 'language', + ASSISTANT_SKILLS type string value 'assistant_skills', + ASSISTANT_SKILL type string value 'assistant_skill', + ASSISTANT_ENVIRONMENTS type string value 'assistant_environments', + ASSISTANT_ENVIRONMENT type string value 'assistant_environment', + SKILL_ID type string value 'skill_id', + TYPE type string value 'type', + ACTION_DISABLED type string value 'action_disabled', + DIALOG_DISABLED type string value 'dialog_disabled', + CREATED type string value 'created', + UPDATED type string value 'updated', + ENVIRONMENT_ID type string value 'environment_id', + ENVIRONMENT type string value 'environment', + RELEASE_REFERENCE type string value 'release_reference', + ORCHESTRATION type string value 'orchestration', + SESSION_TIMEOUT type string value 'session_timeout', + INTEGRATION_REFERENCES type string value 'integration_references', + INTEGRATION_REFERENCE type string value 'integration_reference', + SKILL_REFERENCES type string value 'skill_references', + SKILL_REFERENCE type string value 'skill_reference', SYSTEM type string value 'system', MESSAGE_TYPE type string value 'message_type', TEXT type string value 'text', @@ -1303,51 +2861,77 @@ constants: ENTITIES type string value 'entities', ENTITY type string value 'entity', SUGGESTION_ID type string value 'suggestion_id', + ATTACHMENTS type string value 'attachments', + ANALYTICS type string value 'analytics', RESTART type string value 'restart', ALTERNATE_INTENTS type string value 'alternate_intents', SPELLING type string value 'spelling', + USER_DEFINED type string value 'user_defined', + INNER type string value 'inner', + WORKSPACE type string value 'workspace', + STATUS type string value 'status', + STATUS_ERRORS type string value 'status_errors', + STATUS_DESCRIPTION type string value 'status_description', + DIALOG_SETTINGS type string value 'dialog_settings', + WORKSPACE_ID type string value 'workspace_id', + VALID type string value 'valid', + NEXT_SNAPSHOT_VERSION type string value 'next_snapshot_version', + SEARCH_SETTINGS type string value 'search_settings', + WARNINGS type string value 'warnings', INPUT type string value 'input', OUTPUT type string value 'output', + TARGET type string value 'target', + CHAT type string value 'chat', + URL type string value 'url', LEVEL type string value 'level', - NAME type string value 'name', - TYPE type string value 'type', + CODE type string value 'code', + SOURCE type string value 'source', PARAMETERS type string value 'parameters', - INNER type string value 'inner', RESULT_VARIABLE type string value 'result_variable', CREDENTIALS type string value 'credentials', - TARGET type string value 'target', LABEL type string value 'label', VALUE type string value 'value', + DIALOG_NODE type string value 'dialog_node', + TITLE type string value 'title', + CONDITIONS type string value 'conditions', + ENVIRONMENTS type string value 'environments', + DISABLED type string value 'disabled', + SNAPSHOT type string value 'snapshot', PATH type string value 'path', ERROR type string value 'error', ERRORS type string value 'errors', - CODE type string value 'code', + INTEGRATION_ID type string value 'integration_id', LOG_ID type string value 'log_id', REQUEST type string value 'request', RESPONSE type string value 'response', - ASSISTANT_ID type string value 'assistant_id', SESSION_ID type string value 'session_id', - SKILL_ID type string value 'skill_id', - SNAPSHOT type string value 'snapshot', REQUEST_TIMESTAMP type string value 'request_timestamp', RESPONSE_TIMESTAMP type string value 'response_timestamp', - LANGUAGE type string value 'language', CUSTOMER_ID type string value 'customer_id', LOGS type string value 'logs', - PAGINATION type string value 'pagination', + ACTION type string value 'action', + STEP type string value 'step', + HANDLER type string value 'handler', NEXT_URL type string value 'next_url', MATCHED type string value 'matched', NEXT_CURSOR type string value 'next_cursor', GLOBAL type string value 'global', SKILLS type string value 'skills', + INTEGRATIONS type string value 'integrations', + ACTION_VARIABLES type string value 'action_variables', + SKILL_VARIABLES type string value 'skill_variables', TIMEZONE type string value 'timezone', USER_ID type string value 'user_id', TURN_COUNT type string value 'turn_count', LOCALE type string value 'locale', REFERENCE_TIME type string value 'reference_time', - USER_DEFINED type string value 'user_defined', + SESSION_START_TIME type string value 'session_start_time', STATE type string value 'state', + SKIP_USER_INPUT type string value 'skip_user_input', + MAIN_SKILL type string value 'main skill', + ACTIONS_SKILL type string value 'actions skill', OPTIONS type string value 'options', + MEDIA_TYPE type string value 'media_type', DEBUG type string value 'debug', RETURN_CONTEXT type string value 'return_context', EXPORT type string value 'export', @@ -1361,22 +2945,28 @@ constants: LOG_MESSAGES type string value 'log_messages', BRANCH_EXITED type string value 'branch_exited', BRANCH_EXITED_REASON type string value 'branch_exited_reason', - PREVIEW type string value 'preview', - DISAMBIGUATION type string value 'disambiguation', - ALTERNATE_RESPONSES type string value 'alternate_responses', - OUTCOME type string value 'outcome', - MODEL_TYPE type string value 'model_type', - MODEL_ID type string value 'model_id', + TURN_EVENTS type string value 'turn_events', ORIGINAL_TEXT type string value 'original_text', SUGGESTED_TEXT type string value 'suggested_text', CONTEXT type string value 'context', + REFRESH_URL type string value 'refresh_url', + TOTAL type string value 'total', + REFRESH_CURSOR type string value 'refresh_cursor', + RELEASE type string value 'release', + ENVIRONMENT_REFERENCES type string value 'environment_references', + CONTENT type string value 'content', + RELEASES type string value 'releases', + BROWSER type string value 'browser', + DEVICE type string value 'device', + PAGEURL type string value 'pageUrl', + CHANNEL type string value 'channel', LOCATION type string value 'location', CONFIDENCE type string value 'confidence', - METADATA type string value 'metadata', GROUPS type string value 'groups', INTERPRETATION type string value 'interpretation', ALTERNATIVES type string value 'alternatives', ROLE type string value 'role', + SKILL type string value 'skill', CALENDAR_TYPE type string value 'calendar_type', DATETIME_LINK type string value 'datetime_link', FESTIVAL type string value 'festival', @@ -1403,14 +2993,16 @@ constants: SPECIFIC_MINUTE type string value 'specific_minute', SPECIFIC_SECOND type string value 'specific_second', RESPONSE_TYPE type string value 'response_type', + CHANNELS type string value 'channels', + CHANNEL_OPTIONS type string value 'channel_options', + ALT_TEXT type string value 'alt_text', + MESSAGE_TO_USER type string value 'message_to_user', + TRANSFER_INFO type string value 'transfer_info', MESSAGE_TO_HUMAN_AGENT type string value 'message_to_human_agent', AGENT_AVAILABLE type string value 'agent_available', AGENT_UNAVAILABLE type string value 'agent_unavailable', - TRANSFER_INFO type string value 'transfer_info', TOPIC type string value 'topic', - SOURCE type string value 'source', - TITLE type string value 'title', - DESCRIPTION type string value 'description', + IMAGE_URL type string value 'image_url', PREFERENCE type string value 'preference', TIME type string value 'time', TYPING type string value 'typing', @@ -1420,12 +3012,36 @@ constants: ID type string value 'id', RESULT_METADATA type string value 'result_metadata', BODY type string value 'body', - URL type string value 'url', HIGHLIGHT type string value 'highlight', + ANSWERS type string value 'answers', SCORE type string value 'score', + DISCOVERY type string value 'discovery', + MESSAGES type string value 'messages', + SCHEMA_MAPPING type string value 'schema_mapping', + INSTANCE_ID type string value 'instance_id', + PROJECT_ID type string value 'project_id', + MAX_PRIMARY_RESULTS type string value 'max_primary_results', + MAX_TOTAL_RESULTS type string value 'max_total_results', + CONFIDENCE_THRESHOLD type string value 'confidence_threshold', + FIND_ANSWERS type string value 'find_answers', + AUTHENTICATION type string value 'authentication', + BASIC type string value 'basic', + BEARER type string value 'bearer', + SUCCESS type string value 'success', + NO_RESULT type string value 'no_result', + ASSISTANT_STATE type string value 'assistant_state', + EVENT type string value 'event', + ACTION_START_TIME type string value 'action_start_time', + CONDITION_TYPE type string value 'condition_type', + REASON type string value 'reason', + ACTION_TITLE type string value 'action_title', + CONDITION type string value 'condition', + CALLOUT type string value 'callout', + INTERNAL type string value 'internal', + PROMPTED type string value 'prompted', + HAS_QUESTION type string value 'has_question', + SEARCH_SKILL_FALLBACK type string value 'search_skill_fallback', GROUP type string value 'group', - DIALOG_NODE type string value 'dialog_node', - CONDITIONS type string value 'conditions', end of C_ABAPNAME_DICTIONARY . @@ -1437,29 +3053,122 @@ constants: redefinition . - "!Create a session
- "! Create a new session. A session is used to send user input to a skill and - "! receive responses. It also maintains the state of the conversation. A session - "! persists until it is deleted, or until it times out because of inactivity. (For - "! more information, see the - "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant- - "! settings). - "! - "! @parameter I_ASSISTANT_ID | - "! Unique identifier of the assistant. To find the assistant ID in the Watson - "! Assistant user interface, open the assistant settings and click **API - "! Details**. For information about creating assistants, see the - "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant- - "! add#assistant-add-task).Create an assistant
+ "! Create a new assistant.List assistants
+ "! List the assistants associated with a Watson Assistant service instance.Delete assistant
+ "! Delete an assistant.Create a session
+ "! Create a new session. A session is used to send user input to a skill and + "! receive responses. It also maintains the state of the conversation. A session + "! persists until it is deleted, or until it times out because of inactivity. (For + "! more information, see the + "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant- + "! settings). + "! + "! @parameter I_ASSISTANT_ID | + "! The assistant ID or the environment ID of the environment where the assistant is + "! deployed, depending on the type of request:List log events for an assistant
- "! List the events from the log of an assistant.List log events for an assistant
+ "! List the events from the log of an assistant.Delete labeled data
+ "! Deletes all data associated with a specified customer ID. The method has no + "! effect if no data is associated with the customer ID.List environments
+ "! List the environments associated with an assistant.Get environment
+ "! Get information about an environment. For more information about environments, + "! see + "! [Environments](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assista + "! nt-publish-overview#environments).Update environment
+ "! Update an environment with new or modified data. For more information about + "! environments, see + "! [Environments](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assista + "! nt-publish-overview#environments).Create release
+ "! Create a new release using the current content of the dialog and action skills + "! in the draft environment. (In the Watson Assistant user interface, a release is + "! called a *version*.)List releases
+ "! List the releases associated with an assistant. (In the Watson Assistant user + "! interface, a release is called a *version*.)Get release
+ "! Get information about a release.Delete release
+ "! Delete a release. (In the Watson Assistant user interface, a release is called a + "! *version*.)Deploy release
+ "! Update the environment with the content of the release. All snapshots saved as + "! part of the release become active in the environment.Get skill
+ "! Get information about a skill.Update skill
+ "! Update a skill with new or modified data.Export skills
+ "! Asynchronously export the action skill and dialog skill (if enabled) for the + "! assistant. Use this method to save all skill data so that you can import it to + "! a different assistant using the **Import skills** method.Import skills
+ "! Asynchronously import skills into an existing assistant from a previously + "! exported file.Get status of skills import
+ "! Retrieve the status of an asynchronous import operation previously initiated by + "! using the **Import skills** method.Delete labeled data
- "! Deletes all data associated with a specified customer ID. The method has no - "! effect if no data is associated with the customer ID.Compare and Comply
-"! IBM Watson™ Compare and Comply analyzes governing documents to provide -"! details about critical aspects of the documents.- "! The numeric location of the identified element in the
- "! document, represented with two integers labeled `begin` and `end`. - begin of T_LOCATION, - "! The element's `begin` index. - BEGIN type LONG, - "! The element's `end` index. - END type LONG, - end of T_LOCATION. - types: - "!- "! A pair of `nature` and `party` objects. The `nature` object
- "! identifies the effect of the element on the identified `party`, and the `party` - "! object identifies the affected party. - begin of T_LABEL, - "! The identified `nature` of the element. - NATURE type STRING, - "! The identified `party` of the element. - PARTY type STRING, - end of T_LABEL. - types: - "!- "! Identification of a specific type.
- begin of T_TYPE_LABEL_COMPARISON, - "! A pair of `nature` and `party` objects. The `nature` object identifies the - "! effect of the element on the identified `party`, and the `party` object - "! identifies the affected party. - LABEL type T_LABEL, - end of T_TYPE_LABEL_COMPARISON. - types: - "!- "! The locations of each paragraph in the input document.
- begin of T_PARAGRAPHS, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_PARAGRAPHS. - types: - "!- "! Document counts.
- begin of T_DOC_COUNTS, - "! Total number of documents. - TOTAL type INTEGER, - "! Number of pending documents. - PENDING type INTEGER, - "! Number of documents successfully processed. - SUCCESSFUL type INTEGER, - "! Number of documents not successfully processed. - FAILED type INTEGER, - end of T_DOC_COUNTS. - types: - "!- "! Identification of a specific type.
- begin of T_TYPE_LABEL, - "! A pair of `nature` and `party` objects. The `nature` object identifies the - "! effect of the element on the identified `party`, and the `party` object - "! identifies the affected party. - LABEL type T_LABEL, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The type of modification of the feedback entry in the updated labels response. - MODIFICATION type STRING, - end of T_TYPE_LABEL. - types: - "!- "! Brief information about the input document.
- begin of T_SHORT_DOC, - "! The title of the input document, if identified. - TITLE type STRING, - "! The MD5 hash of the input document. - HASH type STRING, - end of T_SHORT_DOC. - types: - "!- "! Information defining an element's subject matter.
- begin of T_CATEGORY, - "! The category of the associated element. - LABEL type STRING, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The type of modification of the feedback entry in the updated labels response. - MODIFICATION type STRING, - end of T_CATEGORY. - types: - "!- "! The original labeling from the input document, without the
- "! submitted feedback. - begin of T_ORIGINAL_LABELS_OUT, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - end of T_ORIGINAL_LABELS_OUT. - types: - "!- "! The updated labeling from the input document, accounting for
- "! the submitted feedback. - begin of T_UPDATED_LABELS_OUT, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - end of T_UPDATED_LABELS_OUT. - types: - "!- "! Pagination details, if required by the length of the output.
- begin of T_PAGINATION, - "! A token identifying the current page of results. - REFRESH_CURSOR type STRING, - "! A token identifying the next page of results. - NEXT_CURSOR type STRING, - "! The URL that returns the current page of results. - REFRESH_URL type STRING, - "! The URL that returns the next page of results. - NEXT_URL type STRING, - "! Reserved for future use. - TOTAL type LONG, - end of T_PAGINATION. - types: - "!- "! Information returned from the **Add Feedback** method.
- begin of T_FEEDBACK_DATA_OUTPUT, - "! A string identifying the user adding the feedback. The only permitted value is - "! `element_classification`. - FEEDBACK_TYPE type STRING, - "! Brief information about the input document. - DOCUMENT type T_SHORT_DOC, - "! An optional string identifying the model ID. The only permitted value is - "! `contracts`. - MODEL_ID type STRING, - "! An optional string identifying the version of the model used. - MODEL_VERSION type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text to which the feedback applies. - TEXT type STRING, - "! The original labeling from the input document, without the submitted feedback. - ORIGINAL_LABELS type T_ORIGINAL_LABELS_OUT, - "! The updated labeling from the input document, accounting for the submitted - "! feedback. - UPDATED_LABELS type T_UPDATED_LABELS_OUT, - "! Pagination details, if required by the length of the output. - PAGINATION type T_PAGINATION, - end of T_FEEDBACK_DATA_OUTPUT. - types: - "!- "! List of document attributes.
- begin of T_ATTRIBUTE, - "! The type of attribute. - TYPE type STRING, - "! The text associated with the attribute. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_ATTRIBUTE. - types: - "!- "! Information defining an element's subject matter.
- begin of T_CATEGORY_COMPARISON, - "! The category of the associated element. - LABEL type STRING, - end of T_CATEGORY_COMPARISON. - types: - "!- "! Element that does not align semantically between two
- "! compared documents. - begin of T_UNALIGNED_ELEMENT, - "! The label assigned to the document by the value of the `file_1_label` or - "! `file_2_label` parameters on the **Compare two documents** method. - DOCUMENT_LABEL type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text of the element. - TEXT type STRING, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL_COMPARISON WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY_COMPARISON WITH NON-UNIQUE DEFAULT KEY, - "! List of document attributes. - ATTRIBUTES type STANDARD TABLE OF T_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, - end of T_UNALIGNED_ELEMENT. - types: - "!- "! The updated labeling from the input document, accounting for
- "! the submitted feedback. - begin of T_UPDATED_LABELS_IN, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - end of T_UPDATED_LABELS_IN. - types: - "!- "! An array that contains the `text` value of a row header that
- "! is applicable to this body cell. - T_ROW_HEADER_TEXTS type TT_String. - types: - "!- "! A list of `begin` and `end` indexes that indicate the
- "! locations of the elements in the input document. - begin of T_ELEMENT_LOCATIONS, - "! An integer that indicates the starting position of the element in the input - "! document. - BEGIN type INTEGER, - "! An integer that indicates the ending position of the element in the input - "! document. - END type INTEGER, - end of T_ELEMENT_LOCATIONS. - types: - "!- "! The leading sentences in a section or subsection of the
- "! input document. - begin of T_LEADING_SENTENCE, - "! The text of the leading sentence. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! An array of `location` objects that lists the locations of detected leading - "! sentences. - ELEMENT_LOCATIONS type STANDARD TABLE OF T_ELEMENT_LOCATIONS WITH NON-UNIQUE DEFAULT KEY, - end of T_LEADING_SENTENCE. - types: - "!- "! An array containing one object per section or subsection
- "! detected in the input document. Sections and subsections are not nested; - "! instead, they are flattened out and can be placed back in order by using the - "! `begin` and `end` values of the element and the `level` value of the section. - begin of T_SECTION_TITLES, - "! The text of the section title, if identified. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! An integer indicating the level at which the section is located in the input - "! document. For example, `1` represents a top-level section, `2` represents a - "! subsection within the level `1` section, and so forth. - LEVEL type INTEGER, - "! An array of `location` objects that lists the locations of detected section - "! titles. - ELEMENT_LOCATIONS type STANDARD TABLE OF T_ELEMENT_LOCATIONS WITH NON-UNIQUE DEFAULT KEY, - end of T_SECTION_TITLES. - types: - "!- "! The structure of the input document.
- begin of T_DOC_STRUCTURE, - "! An array containing one object per section or subsection identified in the input - "! document. - SECTION_TITLES type STANDARD TABLE OF T_SECTION_TITLES WITH NON-UNIQUE DEFAULT KEY, - "! An array containing one object per section or subsection, in parallel with the - "! `section_titles` array, that details the leading sentences in the corresponding - "! section or subsection. - LEADING_SENTENCES type STANDARD TABLE OF T_LEADING_SENTENCE WITH NON-UNIQUE DEFAULT KEY, - "! An array containing one object per paragraph, in parallel with the - "! `section_titles` and `leading_sentences` arrays. - PARAGRAPHS type STANDARD TABLE OF T_PARAGRAPHS WITH NON-UNIQUE DEFAULT KEY, - end of T_DOC_STRUCTURE. - types: - "!- "! If you provide customization input, the normalized version
- "! of the column header texts according to the customization; otherwise, the same - "! value as `column_header_texts`. - T_COLUMN_HEADER_TEXTS_NORM type TT_String. - types: - "! No documentation available. - begin of T_ERROR_RESPONSE, - "! The HTTP error status code. - CODE type INTEGER, - "! A message describing the error. - ERROR type STRING, - end of T_ERROR_RESPONSE. - types: - "!- "! A contact.
- begin of T_CONTACT, - "! A string listing the name of the contact. - NAME type STRING, - "! A string listing the role of the contact. - ROLE type STRING, - end of T_CONTACT. - types: - "!- "! The table's section title, if identified.
- begin of T_SECTION_TITLE, - "! The text of the section title, if identified. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_SECTION_TITLE. - types: - "!- "! Column-level cells, each applicable as a header to other
- "! cells in the same column as itself, of the current table. - begin of T_COLUMN_HEADERS, - "! The unique ID of the cell in the current table. - CELL_ID type STRING, - "! The location of the column header cell in the current table as defined by its - "! `begin` and `end` offsets, respectfully, in the input document. - LOCATION type JSONOBJECT, - "! The textual contents of this cell from the input document without associated - "! markup content. - TEXT type STRING, - "! If you provide customization input, the normalized version of the cell text - "! according to the customization; otherwise, the same value as `text`. - TEXT_NORMALIZED type STRING, - "! The `begin` index of this cell's `row` location in the current table. - ROW_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `row` location in the current table. - ROW_INDEX_END type LONG, - "! The `begin` index of this cell's `column` location in the current table. - COLUMN_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `column` location in the current table. - COLUMN_INDEX_END type LONG, - end of T_COLUMN_HEADERS. - types: - "!- "! Text that is related to the contents of the table and that
- "! precedes or follows the current table. - begin of T_CONTEXTS, - "! The related text. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_CONTEXTS. - types: - "!- "! If identified, the title or caption of the current table of
- "! the form `Table x.: ...`. Empty when no title is identified. When exposed, the - "! `title` is also excluded from the `contexts` array of the same table. - begin of T_TABLE_TITLE, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text of the identified table title or caption. - TEXT type STRING, - end of T_TABLE_TITLE. - types: - "!- "! Cells that are not table header, column header, or row
- "! header cells. - begin of T_BODY_CELLS, - "! The unique ID of the cell in the current table. - CELL_ID type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The textual contents of this cell from the input document without associated - "! markup content. - TEXT type STRING, - "! The `begin` index of this cell's `row` location in the current table. - ROW_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `row` location in the current table. - ROW_INDEX_END type LONG, - "! The `begin` index of this cell's `column` location in the current table. - COLUMN_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `column` location in the current table. - COLUMN_INDEX_END type LONG, - "! An array that contains the `id` value of a row header that is applicable to this - "! body cell. - ROW_HEADER_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! An array that contains the `text` value of a row header that is applicable to - "! this body cell. - ROW_HEADER_TEXTS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! If you provide customization input, the normalized version of the row header - "! texts according to the customization; otherwise, the same value as - "! `row_header_texts`. - ROW_HEADER_TEXTS_NORMALIZED type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! An array that contains the `id` value of a column header that is applicable to - "! the current cell. - COLUMN_HEADER_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! An array that contains the `text` value of a column header that is applicable to - "! the current cell. - COLUMN_HEADER_TEXTS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! If you provide customization input, the normalized version of the column header - "! texts according to the customization; otherwise, the same value as - "! `column_header_texts`. - COLUMN_HEADER_TEXTS_NORMALIZED type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! No documentation available. - ATTRIBUTES type STANDARD TABLE OF T_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, - end of T_BODY_CELLS. - types: - "!- "! A key in a key-value pair.
- begin of T_KEY, - "! The unique ID of the key in the table. - CELL_ID type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text content of the table cell without HTML markup. - TEXT type STRING, - end of T_KEY. - types: - "!- "! A value in a key-value pair.
- begin of T_VALUE, - "! The unique ID of the value in the table. - CELL_ID type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text content of the table cell without HTML markup. - TEXT type STRING, - end of T_VALUE. - types: - "!- "! Key-value pairs detected across cell boundaries.
- begin of T_KEY_VALUE_PAIR, - "! A key in a key-value pair. - KEY type T_KEY, - "! A list of values in a key-value pair. - VALUE type STANDARD TABLE OF T_VALUE WITH NON-UNIQUE DEFAULT KEY, - end of T_KEY_VALUE_PAIR. - types: - "!- "! The contents of the current table's header.
- begin of T_TABLE_HEADERS, - "! The unique ID of the cell in the current table. - CELL_ID type STRING, - "! The location of the table header cell in the current table as defined by its - "! `begin` and `end` offsets, respectfully, in the input document. - LOCATION type JSONOBJECT, - "! The textual contents of the cell from the input document without associated - "! markup content. - TEXT type STRING, - "! The `begin` index of this cell's `row` location in the current table. - ROW_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `row` location in the current table. - ROW_INDEX_END type LONG, - "! The `begin` index of this cell's `column` location in the current table. - COLUMN_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `column` location in the current table. - COLUMN_INDEX_END type LONG, - end of T_TABLE_HEADERS. - types: - "!- "! Row-level cells, each applicable as a header to other cells
- "! in the same row as itself, of the current table. - begin of T_ROW_HEADERS, - "! The unique ID of the cell in the current table. - CELL_ID type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The textual contents of this cell from the input document without associated - "! markup content. - TEXT type STRING, - "! If you provide customization input, the normalized version of the cell text - "! according to the customization; otherwise, the same value as `text`. - TEXT_NORMALIZED type STRING, - "! The `begin` index of this cell's `row` location in the current table. - ROW_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `row` location in the current table. - ROW_INDEX_END type LONG, - "! The `begin` index of this cell's `column` location in the current table. - COLUMN_INDEX_BEGIN type LONG, - "! The `end` index of this cell's `column` location in the current table. - COLUMN_INDEX_END type LONG, - end of T_ROW_HEADERS. - types: - "!- "! The contents of the tables extracted from a document.
- begin of T_TABLES, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The textual contents of the current table from the input document without - "! associated markup content. - TEXT type STRING, - "! The table's section title, if identified. - SECTION_TITLE type T_SECTION_TITLE, - "! If identified, the title or caption of the current table of the form `Table x.: - "! ...`. Empty when no title is identified. When exposed, the `title` is also - "! excluded from the `contexts` array of the same table. - TITLE type T_TABLE_TITLE, - "! An array of table-level cells that apply as headers to all the other cells in - "! the current table. - TABLE_HEADERS type STANDARD TABLE OF T_TABLE_HEADERS WITH NON-UNIQUE DEFAULT KEY, - "! An array of row-level cells, each applicable as a header to other cells in the - "! same row as itself, of the current table. - ROW_HEADERS type STANDARD TABLE OF T_ROW_HEADERS WITH NON-UNIQUE DEFAULT KEY, - "! An array of column-level cells, each applicable as a header to other cells in - "! the same column as itself, of the current table. - COLUMN_HEADERS type STANDARD TABLE OF T_COLUMN_HEADERS WITH NON-UNIQUE DEFAULT KEY, - "! An array of cells that are neither table header nor column header nor row header - "! cells, of the current table with corresponding row and column header - "! associations. - BODY_CELLS type STANDARD TABLE OF T_BODY_CELLS WITH NON-UNIQUE DEFAULT KEY, - "! An array of objects that list text that is related to the table contents and - "! that precedes or follows the current table. - CONTEXTS type STANDARD TABLE OF T_CONTEXTS WITH NON-UNIQUE DEFAULT KEY, - "! An array of key-value pairs identified in the current table. - KEY_VALUE_PAIRS type STANDARD TABLE OF T_KEY_VALUE_PAIR WITH NON-UNIQUE DEFAULT KEY, - end of T_TABLES. - types: - "!- "! Information about the parsed input document.
- begin of T_DOC_INFO, - "! The full text of the parsed document in HTML format. - HTML type STRING, - "! The title of the parsed document. If the service did not detect a title, the - "! value of this element is `null`. - TITLE type STRING, - "! The MD5 hash of the input document. - HASH type STRING, - end of T_DOC_INFO. - types: - "!- "! The analysis of the document's tables.
- begin of T_TABLE_RETURN, - "! Information about the parsed input document. - DOCUMENT type T_DOC_INFO, - "! The ID of the model used to extract the table contents. The value for table - "! extraction is `tables`. - MODEL_ID type STRING, - "! The version of the `tables` model ID. - MODEL_VERSION type STRING, - "! Definitions of the tables identified in the input document. - TABLES type STANDARD TABLE OF T_TABLES WITH NON-UNIQUE DEFAULT KEY, - end of T_TABLE_RETURN. - types: - "!- "! Information about the document and the submitted feedback.
- begin of T_FEEDBACK_RETURN, - "! The unique ID of the feedback object. - FEEDBACK_ID type STRING, - "! An optional string identifying the person submitting feedback. - USER_ID type STRING, - "! An optional comment from the person submitting the feedback. - COMMENT type STRING, - "! Timestamp listing the creation time of the feedback submission. - CREATED type DATETIME, - "! Information returned from the **Add Feedback** method. - FEEDBACK_DATA type T_FEEDBACK_DATA_OUTPUT, - end of T_FEEDBACK_RETURN. - types: - "!- "! The details of the normalized text, if applicable. This
- "! element is optional; it is returned only if normalized text exists. - begin of T_INTERPRETATION, - "! The value that was located in the normalized text. - VALUE type STRING, - "! An integer or float expressing the numeric value of the `value` key. - NUMERIC_VALUE type NUMBER, - "! A string listing the unit of the value that was found in the normalized - "! text.- "! A monetary amount identified in the input document.
- begin of T_CONTRACT_AMTS, - "! The confidence level in the identification of the contract amount. - CONFIDENCE_LEVEL type STRING, - "! The monetary amount. - TEXT type STRING, - "! The normalized form of the amount, which is listed as a string. This element is - "! optional; it is returned only if normalized text exists. - TEXT_NORMALIZED type STRING, - "! The details of the normalized text, if applicable. This element is optional; it - "! is returned only if normalized text exists. - INTERPRETATION type T_INTERPRETATION, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_CONTRACT_AMTS. - types: - "!- "! The contract currencies that are declared in the document.
- begin of T_CONTRACT_CURRENCIES, - "! The confidence level in the identification of the contract currency. - CONFIDENCE_LEVEL type STRING, - "! The contract currency. - TEXT type STRING, - "! The normalized form of the contract currency, which is listed as a string in - "! [ISO-4217](https://www.iso.org/iso-4217-currency-codes.html) format. This - "! element is optional; it is returned only if normalized text exists. - TEXT_NORMALIZED type STRING, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_CONTRACT_CURRENCIES. - types: - "!- "! The document's payment duration or durations.
- begin of T_PAYMENT_TERMS, - "! The confidence level in the identification of the payment term. - CONFIDENCE_LEVEL type STRING, - "! The payment term (duration). - TEXT type STRING, - "! The normalized form of the payment term, which is listed as a string. This - "! element is optional; it is returned only if normalized text exists. - TEXT_NORMALIZED type STRING, - "! The details of the normalized text, if applicable. This element is optional; it - "! is returned only if normalized text exists. - INTERPRETATION type T_INTERPRETATION, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_PAYMENT_TERMS. - types: - "!- "! A component part of the document.
- begin of T_ELEMENT, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text of the element. - TEXT type STRING, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - "! List of document attributes. - ATTRIBUTES type STANDARD TABLE OF T_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, - end of T_ELEMENT. - types: - "!- "! Termination dates identified in the input document.
- begin of T_TERMINATION_DATES, - "! The confidence level in the identification of the termination date. - CONFIDENCE_LEVEL type STRING, - "! The termination date. - TEXT type STRING, - "! The normalized form of the termination date, which is listed as a string. This - "! element is optional; it is returned only if normalized text exists. - TEXT_NORMALIZED type STRING, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_TERMINATION_DATES. - types: - "!- "! The contract type identified in the input document.
- begin of T_CONTRACT_TYPES, - "! The confidence level in the identification of the contract type. - CONFIDENCE_LEVEL type STRING, - "! The contract type. - TEXT type STRING, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_CONTRACT_TYPES. - types: - "!- "! An effective date.
- begin of T_EFFECTIVE_DATES, - "! The confidence level in the identification of the effective date. - CONFIDENCE_LEVEL type STRING, - "! The effective date, listed as a string. - TEXT type STRING, - "! The normalized form of the effective date, which is listed as a string. This - "! element is optional; it is returned only if normalized text exists. - TEXT_NORMALIZED type STRING, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_EFFECTIVE_DATES. - types: - "!- "! A mention of a party.
- begin of T_MENTION, - "! The name of the party. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_MENTION. - types: - "!- "! A party's address.
- begin of T_ADDRESS, - "! A string listing the address. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_ADDRESS. - types: - "!- "! A party and its corresponding role, including address and
- "! contact information if identified. - begin of T_PARTIES, - "! The normalized form of the party's name. - PARTY type STRING, - "! A string identifying the party's role. - ROLE type STRING, - "! A string that identifies the importance of the party. - IMPORTANCE type STRING, - "! A list of the party's address or addresses. - ADDRESSES type STANDARD TABLE OF T_ADDRESS WITH NON-UNIQUE DEFAULT KEY, - "! A list of the names and roles of contacts identified in the input document. - CONTACTS type STANDARD TABLE OF T_CONTACT WITH NON-UNIQUE DEFAULT KEY, - "! A list of the party's mentions in the input document. - MENTIONS type STANDARD TABLE OF T_MENTION WITH NON-UNIQUE DEFAULT KEY, - end of T_PARTIES. - types: - "!- "! Basic information about the input document.
- begin of T_DOCUMENT, - "! Document title, if detected. - TITLE type STRING, - "! The input document converted into HTML format. - HTML type STRING, - "! The MD5 hash value of the input document. - HASH type STRING, - "! The label applied to the input document with the calling method's - "! `file_1_label` or `file_2_label` value. This field is specified only in the - "! output of the **Comparing two documents** method. - LABEL type STRING, - end of T_DOCUMENT. - types: - "!- "! The duration or durations of the contract.
- begin of T_CONTRACT_TERMS, - "! The confidence level in the identification of the contract term. - CONFIDENCE_LEVEL type STRING, - "! The contract term (duration). - TEXT type STRING, - "! The normalized form of the contract term, which is listed as a string. This - "! element is optional; it is returned only if normalized text exists. - TEXT_NORMALIZED type STRING, - "! The details of the normalized text, if applicable. This element is optional; it - "! is returned only if normalized text exists. - INTERPRETATION type T_INTERPRETATION, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - end of T_CONTRACT_TERMS. - types: - "!- "! The analysis of objects returned by the **Element
- "! classification** method. - begin of T_CLASSIFY_RETURN, - "! Basic information about the input document. - DOCUMENT type T_DOCUMENT, - "! The analysis model used to classify the input document. For the **Element - "! classification** method, the only valid value is `contracts`. - MODEL_ID type STRING, - "! The version of the analysis model identified by the value of the `model_id` key. - "! - MODEL_VERSION type STRING, - "! Document elements identified by the service. - ELEMENTS type STANDARD TABLE OF T_ELEMENT WITH NON-UNIQUE DEFAULT KEY, - "! The date or dates on which the document becomes effective. - EFFECTIVE_DATES type STANDARD TABLE OF T_EFFECTIVE_DATES WITH NON-UNIQUE DEFAULT KEY, - "! The monetary amounts that identify the total amount of the contract that needs - "! to be paid from one party to another. - CONTRACT_AMOUNTS type STANDARD TABLE OF T_CONTRACT_AMTS WITH NON-UNIQUE DEFAULT KEY, - "! The dates on which the document is to be terminated. - TERMINATION_DATES type STANDARD TABLE OF T_TERMINATION_DATES WITH NON-UNIQUE DEFAULT KEY, - "! The contract type as declared in the document. - CONTRACT_TYPES type STANDARD TABLE OF T_CONTRACT_TYPES WITH NON-UNIQUE DEFAULT KEY, - "! The durations of the contract. - CONTRACT_TERMS type STANDARD TABLE OF T_CONTRACT_TERMS WITH NON-UNIQUE DEFAULT KEY, - "! The document's payment durations. - PAYMENT_TERMS type STANDARD TABLE OF T_PAYMENT_TERMS WITH NON-UNIQUE DEFAULT KEY, - "! The contract currencies as declared in the document. - CONTRACT_CURRENCIES type STANDARD TABLE OF T_CONTRACT_CURRENCIES WITH NON-UNIQUE DEFAULT KEY, - "! Definition of tables identified in the input document. - TABLES type STANDARD TABLE OF T_TABLES WITH NON-UNIQUE DEFAULT KEY, - "! The structure of the input document. - DOCUMENT_STRUCTURE type T_DOC_STRUCTURE, - "! Definitions of the parties identified in the input document. - PARTIES type STANDARD TABLE OF T_PARTIES WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFY_RETURN. - types: - "!- "! The original labeling from the input document, without the
- "! submitted feedback. - begin of T_ORIGINAL_LABELS_IN, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - end of T_ORIGINAL_LABELS_IN. - types: - "!- "! Details of semantically aligned elements.
- begin of T_ELEMENT_PAIR, - "! The label of the document (that is, the value of either the `file_1_label` or - "! `file_2_label` parameters) in which the element occurs. - DOCUMENT_LABEL type STRING, - "! The contents of the element. - TEXT type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! Description of the action specified by the element and whom it affects. - TYPES type STANDARD TABLE OF T_TYPE_LABEL_COMPARISON WITH NON-UNIQUE DEFAULT KEY, - "! List of functional categories into which the element falls; in other words, the - "! subject matter of the element. - CATEGORIES type STANDARD TABLE OF T_CATEGORY_COMPARISON WITH NON-UNIQUE DEFAULT KEY, - "! List of document attributes. - ATTRIBUTES type STANDARD TABLE OF T_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, - end of T_ELEMENT_PAIR. - types: - "! No documentation available. - begin of T_ALIGNED_ELEMENT, - "! Identifies two elements that semantically align between the compared documents. - ELEMENT_PAIR type STANDARD TABLE OF T_ELEMENT_PAIR WITH NON-UNIQUE DEFAULT KEY, - "! Specifies whether the aligned element is identical. Elements are considered - "! identical despite minor differences such as leading punctuation, - "! end-of-sentence punctuation, whitespace, the presence or absence of definite or - "! indefinite articles, and others. - IDENTICAL_TEXT type BOOLEAN, - "! Hashed values that you can send to IBM to provide feedback or receive support. - PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Indicates that the elements aligned are contractual clauses of significance. - SIGNIFICANT_ELEMENTS type BOOLEAN, - end of T_ALIGNED_ELEMENT. - types: - "!- "! The comparison of the two submitted documents.
- begin of T_COMPARE_RETURN, - "! The analysis model used to compare the input documents. For the **Compare two - "! documents** method, the only valid value is `contracts`. - MODEL_ID type STRING, - "! The version of the analysis model identified by the value of the `model_id` key. - "! - MODEL_VERSION type STRING, - "! Information about the documents being compared. - DOCUMENTS type STANDARD TABLE OF T_DOCUMENT WITH NON-UNIQUE DEFAULT KEY, - "! A list of pairs of elements that semantically align between the compared - "! documents. - ALIGNED_ELEMENTS type STANDARD TABLE OF T_ALIGNED_ELEMENT WITH NON-UNIQUE DEFAULT KEY, - "! A list of elements that do not semantically align between the compared - "! documents. - UNALIGNED_ELEMENTS type STANDARD TABLE OF T_UNALIGNED_ELEMENT WITH NON-UNIQUE DEFAULT KEY, - end of T_COMPARE_RETURN. - types: - "!- "! The HTML converted from an input document.
- begin of T_HTMLRETURN, - "! The number of pages in the input document. - NUM_PAGES type STRING, - "! The author of the input document, if identified. - AUTHOR type STRING, - "! The publication date of the input document, if identified. - PUBLICATION_DATE type STRING, - "! The title of the input document, if identified. - TITLE type STRING, - "! The HTML version of the input document. - HTML type STRING, - end of T_HTMLRETURN. - types: - "!- "! Feedback data for submission.
- begin of T_FEEDBACK_DATA_INPUT, - "! The type of feedback. The only permitted value is `element_classification`. - FEEDBACK_TYPE type STRING, - "! Brief information about the input document. - DOCUMENT type T_SHORT_DOC, - "! An optional string identifying the model ID. The only permitted value is - "! `contracts`. - MODEL_ID type STRING, - "! An optional string identifying the version of the model used. - MODEL_VERSION type STRING, - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. - LOCATION type T_LOCATION, - "! The text on which to submit feedback. - TEXT type STRING, - "! The original labeling from the input document, without the submitted feedback. - ORIGINAL_LABELS type T_ORIGINAL_LABELS_IN, - "! The updated labeling from the input document, accounting for the submitted - "! feedback. - UPDATED_LABELS type T_UPDATED_LABELS_IN, - end of T_FEEDBACK_DATA_INPUT. - types: - "!- "! An array that contains the `id` value of a row header that
- "! is applicable to this body cell. - T_ROW_HEADER_IDS type TT_String. - types: - "!- "! The batch-request status.
- begin of T_BATCH_STATUS, - "! The method to be run against the documents. Possible values are - "! `html_conversion`, `element_classification`, and `tables`. - FUNCTION type STRING, - "! The geographical location of the Cloud Object Storage input bucket as listed on - "! the **Endpoint** tab of your COS instance; for example, `us-geo`, `eu-geo`, or - "! `ap-geo`. - INPUT_BUCKET_LOCATION type STRING, - "! The name of the Cloud Object Storage input bucket. - INPUT_BUCKET_NAME type STRING, - "! The geographical location of the Cloud Object Storage output bucket as listed on - "! the **Endpoint** tab of your COS instance; for example, `us-geo`, `eu-geo`, or - "! `ap-geo`. - OUTPUT_BUCKET_LOCATION type STRING, - "! The name of the Cloud Object Storage output bucket. - OUTPUT_BUCKET_NAME type STRING, - "! The unique identifier for the batch request. - BATCH_ID type STRING, - "! Document counts. - DOCUMENT_COUNTS type T_DOC_COUNTS, - "! The status of the batch request. - STATUS type STRING, - "! The creation time of the batch request. - CREATED type DATETIME, - "! The time of the most recent update to the batch request. - UPDATED type DATETIME, - end of T_BATCH_STATUS. - types: - "!- "! The results of a successful **List Batches** request.
- begin of T_BATCHES, - "! A list of the status of all batch requests. - BATCHES type STANDARD TABLE OF T_BATCH_STATUS WITH NON-UNIQUE DEFAULT KEY, - end of T_BATCHES. - types: - "! No documentation available. - begin of T_INLINE_OBJECT, - "! The document to convert. - FILE type FILE, - end of T_INLINE_OBJECT. - types: - "!- "! An array that contains the `id` value of a column header
- "! that is applicable to the current cell. - T_COLUMN_HEADER_IDS type TT_String. - types: - "!- "! If you provide customization input, the normalized version
- "! of the row header texts according to the customization; otherwise, the same - "! value as `row_header_texts`. - T_ROW_HEADER_TEXTS_NORMALIZED type TT_String. - types: - "!- "! An array that contains the `text` value of a column header
- "! that is applicable to the current cell. - T_COLUMN_HEADER_TEXTS type TT_String. - types: - "!- "! The status and message of the deletion request.
- begin of T_FEEDBACK_DELETED, - "! HTTP return code. - STATUS type INTEGER, - "! Status message returned from the service. - MESSAGE type STRING, - end of T_FEEDBACK_DELETED. - types: - "!- "! The feedback to be added to an element in the document.
- begin of T_FEEDBACK_INPUT, - "! An optional string identifying the user. - USER_ID type STRING, - "! An optional comment on or description of the feedback. - COMMENT type STRING, - "! Feedback data for submission. - FEEDBACK_DATA type T_FEEDBACK_DATA_INPUT, - end of T_FEEDBACK_INPUT. - types: - "! No documentation available. - begin of T_INLINE_OBJECT1, - "! The document to classify. - FILE type FILE, - end of T_INLINE_OBJECT1. - types: - "! No documentation available. - begin of T_INLINE_OBJECT2, - "! The document on which to run table extraction. - FILE type FILE, - end of T_INLINE_OBJECT2. - types: - "! No documentation available. - begin of T_INLINE_OBJECT3, - "! The first document to compare. - FILE_1 type FILE, - "! The second document to compare. - FILE_2 type FILE, - end of T_INLINE_OBJECT3. - types: - "! No documentation available. - begin of T_INLINE_OBJECT4, - "! A JSON file containing the input Cloud Object Storage credentials. At a minimum, - "! the credentials must enable `READ` permissions on the bucket defined by the - "! `input_bucket_name` parameter. - INPUT_CREDENTIALS_FILE type FILE, - "! The geographical location of the Cloud Object Storage input bucket as listed on - "! the **Endpoint** tab of your Cloud Object Storage instance; for example, - "! `us-geo`, `eu-geo`, or `ap-geo`. - INPUT_BUCKET_LOCATION type STRING, - "! The name of the Cloud Object Storage input bucket. - INPUT_BUCKET_NAME type STRING, - "! A JSON file that lists the Cloud Object Storage output credentials. At a - "! minimum, the credentials must enable `READ` and `WRITE` permissions on the - "! bucket defined by the `output_bucket_name` parameter. - OUTPUT_CREDENTIALS_FILE type FILE, - "! The geographical location of the Cloud Object Storage output bucket as listed on - "! the **Endpoint** tab of your Cloud Object Storage instance; for example, - "! `us-geo`, `eu-geo`, or `ap-geo`. - OUTPUT_BUCKET_LOCATION type STRING, - "! The name of the Cloud Object Storage output bucket. - OUTPUT_BUCKET_NAME type STRING, - end of T_INLINE_OBJECT4. - types: - "!- "! The results of a successful **Get Feedback** request for a
- "! single feedback entry. - begin of T_GET_FEEDBACK, - "! A string uniquely identifying the feedback entry. - FEEDBACK_ID type STRING, - "! A timestamp identifying the creation time of the feedback entry. - CREATED type DATETIME, - "! A string containing the user's comment about the feedback entry. - COMMENT type STRING, - "! Information returned from the **Add Feedback** method. - FEEDBACK_DATA type T_FEEDBACK_DATA_OUTPUT, - end of T_GET_FEEDBACK. - types: - "!- "! The results of a successful **List Feedback** request for
- "! all feedback. - begin of T_FEEDBACK_LIST, - "! A list of all feedback for the document. - FEEDBACK type STANDARD TABLE OF T_GET_FEEDBACK WITH NON-UNIQUE DEFAULT KEY, - end of T_FEEDBACK_LIST. - types: - "!- "! A list of values in a key-value pair.
- T_VALUES type STANDARD TABLE OF T_VALUE WITH NON-UNIQUE DEFAULT KEY. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_LOCATION type string value '|BEGIN|END|', - T_LABEL type string value '|NATURE|PARTY|', - T_TYPE_LABEL_COMPARISON type string value '|', - T_PARAGRAPHS type string value '|', - T_DOC_COUNTS type string value '|', - T_TYPE_LABEL type string value '|', - T_SHORT_DOC type string value '|', - T_CATEGORY type string value '|', - T_ORIGINAL_LABELS_OUT type string value '|', - T_UPDATED_LABELS_OUT type string value '|', - T_PAGINATION type string value '|', - T_FEEDBACK_DATA_OUTPUT type string value '|', - T_ATTRIBUTE type string value '|', - T_CATEGORY_COMPARISON type string value '|', - T_UNALIGNED_ELEMENT type string value '|', - T_UPDATED_LABELS_IN type string value '|TYPES|CATEGORIES|', - T_ELEMENT_LOCATIONS type string value '|', - T_LEADING_SENTENCE type string value '|', - T_SECTION_TITLES type string value '|', - T_DOC_STRUCTURE type string value '|', - T_ERROR_RESPONSE type string value '|CODE|ERROR|', - T_CONTACT type string value '|', - T_SECTION_TITLE type string value '|', - T_COLUMN_HEADERS type string value '|', - T_CONTEXTS type string value '|', - T_TABLE_TITLE type string value '|', - T_BODY_CELLS type string value '|', - T_KEY type string value '|', - T_VALUE type string value '|', - T_KEY_VALUE_PAIR type string value '|', - T_TABLE_HEADERS type string value '|', - T_ROW_HEADERS type string value '|', - T_TABLES type string value '|', - T_DOC_INFO type string value '|', - T_TABLE_RETURN type string value '|', - T_FEEDBACK_RETURN type string value '|', - T_INTERPRETATION type string value '|', - T_CONTRACT_AMTS type string value '|', - T_CONTRACT_CURRENCIES type string value '|', - T_PAYMENT_TERMS type string value '|', - T_ELEMENT type string value '|', - T_TERMINATION_DATES type string value '|', - T_CONTRACT_TYPES type string value '|', - T_EFFECTIVE_DATES type string value '|', - T_MENTION type string value '|', - T_ADDRESS type string value '|', - T_PARTIES type string value '|', - T_DOCUMENT type string value '|', - T_CONTRACT_TERMS type string value '|', - T_CLASSIFY_RETURN type string value '|', - T_ORIGINAL_LABELS_IN type string value '|TYPES|CATEGORIES|', - T_ELEMENT_PAIR type string value '|', - T_ALIGNED_ELEMENT type string value '|', - T_COMPARE_RETURN type string value '|', - T_HTMLRETURN type string value '|', - T_FEEDBACK_DATA_INPUT type string value '|FEEDBACK_TYPE|LOCATION|TEXT|ORIGINAL_LABELS|UPDATED_LABELS|', - T_BATCH_STATUS type string value '|', - T_BATCHES type string value '|', - T_INLINE_OBJECT type string value '|FILE|', - T_FEEDBACK_DELETED type string value '|', - T_FEEDBACK_INPUT type string value '|FEEDBACK_DATA|', - T_INLINE_OBJECT1 type string value '|FILE|', - T_INLINE_OBJECT2 type string value '|FILE|', - T_INLINE_OBJECT3 type string value '|FILE_1|FILE_2|', - T_INLINE_OBJECT4 type string value '|INPUT_CREDENTIALS_FILE|INPUT_BUCKET_LOCATION|INPUT_BUCKET_NAME|OUTPUT_CREDENTIALS_FILE|OUTPUT_BUCKET_LOCATION|OUTPUT_BUCKET_NAME|', - T_GET_FEEDBACK type string value '|', - T_FEEDBACK_LIST type string value '|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - NUM_PAGES type string value 'num_pages', - AUTHOR type string value 'author', - PUBLICATION_DATE type string value 'publication_date', - TITLE type string value 'title', - HTML type string value 'html', - DOCUMENT type string value 'document', - MODEL_ID type string value 'model_id', - MODEL_VERSION type string value 'model_version', - ELEMENTS type string value 'elements', - EFFECTIVE_DATES type string value 'effective_dates', - CONTRACT_AMOUNTS type string value 'contract_amounts', - TERMINATION_DATES type string value 'termination_dates', - CONTRACT_TYPES type string value 'contract_types', - CONTRACT_TERMS type string value 'contract_terms', - PAYMENT_TERMS type string value 'payment_terms', - CONTRACT_CURRENCIES type string value 'contract_currencies', - TABLES type string value 'tables', - DOCUMENT_STRUCTURE type string value 'document_structure', - PARTIES type string value 'parties', - SECTION_TITLES type string value 'section_titles', - LEADING_SENTENCES type string value 'leading_sentences', - PARAGRAPHS type string value 'paragraphs', - DOCUMENTS type string value 'documents', - ALIGNED_ELEMENTS type string value 'aligned_elements', - UNALIGNED_ELEMENTS type string value 'unaligned_elements', - ELEMENT_PAIR type string value 'element_pair', - IDENTICAL_TEXT type string value 'identical_text', - PROVENANCE_IDS type string value 'provenance_ids', - SIGNIFICANT_ELEMENTS type string value 'significant_elements', - DOCUMENT_LABEL type string value 'document_label', - LOCATION type string value 'location', - TEXT type string value 'text', - TYPES type string value 'types', - CATEGORIES type string value 'categories', - ATTRIBUTES type string value 'attributes', - LABEL type string value 'label', - MODIFICATION type string value 'modification', - HASH type string value 'hash', - CODE type string value 'code', - ERROR type string value 'error', - SECTION_TITLE type string value 'section_title', - TABLE_HEADERS type string value 'table_headers', - ROW_HEADERS type string value 'row_headers', - COLUMN_HEADERS type string value 'column_headers', - BODY_CELLS type string value 'body_cells', - CONTEXTS type string value 'contexts', - KEY_VALUE_PAIRS type string value 'key_value_pairs', - LEVEL type string value 'level', - ELEMENT_LOCATIONS type string value 'element_locations', - BEGIN type string value 'begin', - END type string value 'end', - CELL_ID type string value 'cell_id', - ROW_INDEX_BEGIN type string value 'row_index_begin', - ROW_INDEX_END type string value 'row_index_end', - COLUMN_INDEX_BEGIN type string value 'column_index_begin', - COLUMN_INDEX_END type string value 'column_index_end', - TEXT_NORMALIZED type string value 'text_normalized', - KEY type string value 'key', - VALUE type string value 'value', - ROW_HEADER_IDS type string value 'row_header_ids', - ROW_HEADER_TEXTS type string value 'row_header_texts', - ROW_HEADER_TEXTS_NORMALIZED type string value 'row_header_texts_normalized', - COLUMN_HEADER_IDS type string value 'column_header_ids', - COLUMN_HEADER_TEXTS type string value 'column_header_texts', - COLUMN_HEADER_TEXTS_NORMALIZED type string value 'column_header_texts_normalized', - USER_ID type string value 'user_id', - COMMENT type string value 'comment', - FEEDBACK_DATA type string value 'feedback_data', - FEEDBACK_ID type string value 'feedback_id', - CREATED type string value 'created', - FEEDBACK_TYPE type string value 'feedback_type', - ORIGINAL_LABELS type string value 'original_labels', - UPDATED_LABELS type string value 'updated_labels', - PAGINATION type string value 'pagination', - REFRESH_CURSOR type string value 'refresh_cursor', - NEXT_CURSOR type string value 'next_cursor', - REFRESH_URL type string value 'refresh_url', - NEXT_URL type string value 'next_url', - TOTAL type string value 'total', - FEEDBACK type string value 'feedback', - STATUS type string value 'status', - MESSAGE type string value 'message', - TYPE type string value 'type', - NATURE type string value 'nature', - PARTY type string value 'party', - FUNCTION type string value 'function', - INPUT_BUCKET_LOCATION type string value 'input_bucket_location', - INPUT_BUCKET_NAME type string value 'input_bucket_name', - OUTPUT_BUCKET_LOCATION type string value 'output_bucket_location', - OUTPUT_BUCKET_NAME type string value 'output_bucket_name', - BATCH_ID type string value 'batch_id', - DOCUMENT_COUNTS type string value 'document_counts', - UPDATED type string value 'updated', - BATCHES type string value 'batches', - PENDING type string value 'pending', - SUCCESSFUL type string value 'successful', - FAILED type string value 'failed', - ROLE type string value 'role', - IMPORTANCE type string value 'importance', - ADDRESSES type string value 'addresses', - CONTACTS type string value 'contacts', - MENTIONS type string value 'mentions', - NAME type string value 'name', - CONFIDENCE_LEVEL type string value 'confidence_level', - INTERPRETATION type string value 'interpretation', - NUMERIC_VALUE type string value 'numeric_value', - UNIT type string value 'unit', - FILE type string value 'file', - FILE_1 type string value 'file_1', - FILE_2 type string value 'file_2', - INPUT_CREDENTIALS_FILE type string value 'input_credentials_file', - OUTPUT_CREDENTIALS_FILE type string value 'output_credentials_file', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Convert document to HTML
- "! Converts a document to HTML. - "! - "! @parameter I_FILE | - "! The document to convert. - "! @parameter I_FILE_CONTENT_TYPE | - "! The content type of file. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_HTMLRETURN - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CONVERT_TO_HTML - importing - !I_FILE type FILE - !I_FILE_CONTENT_TYPE type STRING optional - !I_MODEL type STRING optional - !I_contenttype type string default 'multipart/form-data' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_HTMLRETURN - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Classify the elements of a document
- "! Analyzes the structural and semantic elements of a document. - "! - "! @parameter I_FILE | - "! The document to classify. - "! @parameter I_FILE_CONTENT_TYPE | - "! The content type of file. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_CLASSIFY_RETURN - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CLASSIFY_ELEMENTS - importing - !I_FILE type FILE - !I_FILE_CONTENT_TYPE type STRING optional - !I_MODEL type STRING optional - !I_contenttype type string default 'multipart/form-data' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CLASSIFY_RETURN - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Extract a document's tables
- "! Analyzes the tables in a document. - "! - "! @parameter I_FILE | - "! The document on which to run table extraction. - "! @parameter I_FILE_CONTENT_TYPE | - "! The content type of file. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_TABLE_RETURN - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods EXTRACT_TABLES - importing - !I_FILE type FILE - !I_FILE_CONTENT_TYPE type STRING optional - !I_MODEL type STRING optional - !I_contenttype type string default 'multipart/form-data' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TABLE_RETURN - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Compare two documents
- "! Compares two input documents. Documents must be in the same format. - "! - "! @parameter I_FILE_1 | - "! The first document to compare. - "! @parameter I_FILE_2 | - "! The second document to compare. - "! @parameter I_FILE_1_CONTENT_TYPE | - "! The content type of file1. - "! @parameter I_FILE_2_CONTENT_TYPE | - "! The content type of file2. - "! @parameter I_FILE_1_LABEL | - "! A text label for the first document. - "! @parameter I_FILE_2_LABEL | - "! A text label for the second document. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_COMPARE_RETURN - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods COMPARE_DOCUMENTS - importing - !I_FILE_1 type FILE - !I_FILE_2 type FILE - !I_FILE_1_CONTENT_TYPE type STRING optional - !I_FILE_2_CONTENT_TYPE type STRING optional - !I_FILE_1_LABEL type STRING default 'file_1' - !I_FILE_2_LABEL type STRING default 'file_2' - !I_MODEL type STRING optional - !I_contenttype type string default 'multipart/form-data' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COMPARE_RETURN - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Add feedback
- "! Adds feedback in the form of _labels_ from a subject-matter expert (SME) to a - "! governing document.List the feedback in a document
- "! Lists the feedback in a document. - "! - "! @parameter I_FEEDBACK_TYPE | - "! An optional string that filters the output to include only feedback with the - "! specified feedback type. The only permitted value is `element_classification`. - "! @parameter I_DOCUMENT_TITLE | - "! An optional string that filters the output to include only feedback from the - "! document with the specified `document_title`. - "! @parameter I_MODEL_ID | - "! An optional string that filters the output to include only feedback with the - "! specified `model_id`. The only permitted value is `contracts`. - "! @parameter I_MODEL_VERSION | - "! An optional string that filters the output to include only feedback with the - "! specified `model_version`. - "! @parameter I_CATEGORY_REMOVED | - "! An optional string in the form of a comma-separated list of categories. If it is - "! specified, the service filters the output to include only feedback that has at - "! least one category from the list removed. - "! @parameter I_CATEGORY_ADDED | - "! An optional string in the form of a comma-separated list of categories. If this - "! is specified, the service filters the output to include only feedback that has - "! at least one category from the list added. - "! @parameter I_CATEGORY_NOT_CHANGED | - "! An optional string in the form of a comma-separated list of categories. If this - "! is specified, the service filters the output to include only feedback that has - "! at least one category from the list unchanged. - "! @parameter I_TYPE_REMOVED | - "! An optional string of comma-separated `nature`:`party` pairs. If this is - "! specified, the service filters the output to include only feedback that has at - "! least one `nature`:`party` pair from the list removed. - "! @parameter I_TYPE_ADDED | - "! An optional string of comma-separated `nature`:`party` pairs. If this is - "! specified, the service filters the output to include only feedback that has at - "! least one `nature`:`party` pair from the list removed. - "! @parameter I_TYPE_NOT_CHANGED | - "! An optional string of comma-separated `nature`:`party` pairs. If this is - "! specified, the service filters the output to include only feedback that has at - "! least one `nature`:`party` pair from the list unchanged. - "! @parameter I_PAGE_LIMIT | - "! An optional integer specifying the number of documents that you want the service - "! to return. - "! @parameter I_CURSOR | - "! An optional string that returns the set of documents after the previous set. Use - "! this parameter with the `page_limit` parameter. - "! @parameter I_SORT | - "! An optional comma-separated list of fields in the document to sort on. You can - "! optionally specify the sort direction by prefixing the value of the field with - "! `-` for descending order or `+` for ascending order (the default). Currently - "! permitted sorting fields are `created`, `user_id`, and `document_title`. - "! @parameter I_INCLUDE_TOTAL | - "! An optional boolean value. If specified as `true`, the `pagination` object in - "! the output includes a value called `total` that gives the total count of - "! feedback created. - "! @parameter E_RESPONSE | - "! Service return value of type T_FEEDBACK_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_FEEDBACK - importing - !I_FEEDBACK_TYPE type STRING optional - !I_DOCUMENT_TITLE type STRING optional - !I_MODEL_ID type STRING optional - !I_MODEL_VERSION type STRING optional - !I_CATEGORY_REMOVED type STRING optional - !I_CATEGORY_ADDED type STRING optional - !I_CATEGORY_NOT_CHANGED type STRING optional - !I_TYPE_REMOVED type STRING optional - !I_TYPE_ADDED type STRING optional - !I_TYPE_NOT_CHANGED type STRING optional - !I_PAGE_LIMIT type INTEGER optional - !I_CURSOR type STRING optional - !I_SORT type STRING optional - !I_INCLUDE_TOTAL type BOOLEAN optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_FEEDBACK_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get a specified feedback entry
- "! Gets a feedback entry with a specified `feedback_id`. - "! - "! @parameter I_FEEDBACK_ID | - "! A string that specifies the feedback entry to be included in the output. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_GET_FEEDBACK - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_FEEDBACK - importing - !I_FEEDBACK_ID type STRING - !I_MODEL type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_GET_FEEDBACK - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete a specified feedback entry
- "! Deletes a feedback entry with a specified `feedback_id`. - "! - "! @parameter I_FEEDBACK_ID | - "! A string that specifies the feedback entry to be deleted from the document. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_FEEDBACK_DELETED - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_FEEDBACK - importing - !I_FEEDBACK_ID type STRING - !I_MODEL type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_FEEDBACK_DELETED - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Submit a batch-processing request
- "! Run Compare and Comply methods over a collection of input documents.List submitted batch-processing jobs
- "! Lists batch-processing jobs submitted by users. - "! - "! @parameter E_RESPONSE | - "! Service return value of type T_BATCHES - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_BATCHES - importing - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_BATCHES - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get information about a specific batch-processing job
- "! Gets information about a batch-processing job with a specified ID. - "! - "! @parameter I_BATCH_ID | - "! The ID of the batch-processing job whose information you want to retrieve. - "! @parameter E_RESPONSE | - "! Service return value of type T_BATCH_STATUS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_BATCH - importing - !I_BATCH_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_BATCH_STATUS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update a pending or active batch-processing job
- "! Updates a pending or active batch-processing job. You can rescan the input - "! bucket to check for new documents or cancel a job. - "! - "! @parameter I_BATCH_ID | - "! The ID of the batch-processing job you want to update. - "! @parameter I_ACTION | - "! The action you want to perform on the specified batch-processing job. - "! @parameter I_MODEL | - "! The analysis model to be used by the service. For the **Element classification** - "! and **Compare two documents** methods, the default is `contracts`. For the - "! **Extract tables** method, the default is `tables`. These defaults apply to the - "! standalone methods as well as to the methods' use in batch-processing - "! requests. - "! @parameter E_RESPONSE | - "! Service return value of type T_BATCH_STATUS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods UPDATE_BATCH - importing - !I_BATCH_ID type STRING - !I_ACTION type STRING - !I_MODEL type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_BATCH_STATUS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - -protected section. - -private section. - -ENDCLASS. - -class ZCL_IBMC_COMPARE_COMPLY_V1 IMPLEMENTATION. - -*Discovery
-"! IBM Watson™ Discovery is a cognitive search and content analytics engine -"! that you can add to applications to identify patterns, trends and actionable -"! insights to drive better decision-making. Securely unify structured and -"! unstructured data with pre-enriched content, and use a simplified query -"! language to eliminate the need for manual filtering of results.- "! An aggregation produced by Discovery to analyze the input
- "! provided. - begin of T_QUERY_AGGREGATION, - "! The type of aggregation command used. For example: term, filter, max, min, etc. - TYPE type STRING, - "! Array of aggregation results. - RESULTS type STANDARD TABLE OF DATA_REFERENCE WITH NON-UNIQUE DEFAULT KEY, - "! Number of matching results. - MATCHING_RESULTS type INTEGER, - "! Aggregations returned by Discovery. - AGGREGATIONS type STANDARD TABLE OF DATA_REFERENCE WITH NON-UNIQUE DEFAULT KEY, - end of T_QUERY_AGGREGATION. - types: - "!- "! Aggregation results for the specified query.
- begin of T_AGGREGATION_RESULT, - "! Key that matched the aggregation type. - KEY type STRING, - "! Number of matching results. - MATCHING_RESULTS type INTEGER, - "! Aggregations returned in the case of chained aggregations. - AGGREGATIONS type STANDARD TABLE OF T_QUERY_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, - end of T_AGGREGATION_RESULT. - types: - "!- "! Training status details.
- begin of T_TRAINING_STATUS, - "! The total number of training examples uploaded to this collection. - TOTAL_EXAMPLES type INTEGER, - "! When `true`, the collection has been successfully trained. - AVAILABLE type BOOLEAN, - "! When `true`, the collection is currently processing training. - PROCESSING type BOOLEAN, - "! When `true`, the collection has a sufficent amount of queries added for training - "! to occur. - MINIMUM_QUERIES_ADDED type BOOLEAN, - "! When `true`, the collection has a sufficent amount of examples added for - "! training to occur. - MINIMUM_EXAMPLES_ADDED type BOOLEAN, - "! When `true`, the collection has a sufficent amount of diversity in labeled - "! results for training to occur. - SUFFICIENT_LABEL_DIVERSITY type BOOLEAN, - "! The number of notices associated with this data set. - NOTICES type INTEGER, - "! The timestamp of when the collection was successfully trained. - SUCCESSFULLY_TRAINED type DATETIME, - "! The timestamp of when the data was uploaded. - DATA_UPDATED type DATETIME, - end of T_TRAINING_STATUS. - types: - "!- "! Object describing the current status of the wordlist.
- begin of T_TOKEN_DICT_STATUS_RESPONSE, - "! Current wordlist status for the specified collection. - STATUS type STRING, - "! The type for this wordlist. Can be `tokenization_dictionary` or `stopwords`. - TYPE type STRING, - end of T_TOKEN_DICT_STATUS_RESPONSE. - types: - "!- "! An object specifying the relations enrichment and related
- "! parameters. - begin of T_NLU_ENRICHMENT_RELATIONS, - "! *For use with `natural_language_understanding` enrichments only.* The - "! enrichement model to use with relationship extraction. May be a custom model - "! provided by Watson Knowledge Studio, the default public model is`en-news`. - MODEL type STRING, - end of T_NLU_ENRICHMENT_RELATIONS. - types: - "!- "! An object specifying the sentiment extraction enrichment and
- "! related parameters. - begin of T_NLU_ENRICHMENT_SENTIMENT, - "! When `true`, sentiment analysis is performed on the entire field. - DOCUMENT type BOOLEAN, - "! A comma-separated list of target strings that will have any associated sentiment - "! analyzed. - TARGETS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_NLU_ENRICHMENT_SENTIMENT. - types: - "!- "! An object specifiying the semantic roles enrichment and
- "! related parameters. - begin of T_NL_ENRICHMENT_SEMANTIC_ROLES, - "! When `true`, entities are extracted from the identified sentence parts. - ENTITIES type BOOLEAN, - "! When `true`, keywords are extracted from the identified sentence parts. - KEYWORDS type BOOLEAN, - "! The maximum number of semantic roles enrichments to extact from each instance of - "! the specified field. - LIMIT type INTEGER, - end of T_NL_ENRICHMENT_SEMANTIC_ROLES. - types: - "!- "! An object speficying the Entities enrichment and related
- "! parameters. - begin of T_NLU_ENRICHMENT_ENTITIES, - "! When `true`, sentiment analysis of entities will be performed on the specified - "! field. - SENTIMENT type BOOLEAN, - "! When `true`, emotion detection of entities will be performed on the specified - "! field. - EMOTION type BOOLEAN, - "! The maximum number of entities to extract for each instance of the specified - "! field. - LIMIT type INTEGER, - "! When `true`, the number of mentions of each identified entity is recorded. The - "! default is `false`. - MENTIONS type BOOLEAN, - "! When `true`, the types of mentions for each idetifieid entity is recorded. The - "! default is `false`. - MENTION_TYPES type BOOLEAN, - "! When `true`, a list of sentence locations for each instance of each identified - "! entity is recorded. The default is `false`. - SENTENCE_LOCATIONS type BOOLEAN, - "! The enrichement model to use with entity extraction. May be a custom model - "! provided by Watson Knowledge Studio, or the default public model `alchemy`. - MODEL type STRING, - end of T_NLU_ENRICHMENT_ENTITIES. - types: - "!- "! An object specifying the emotion detection enrichment and
- "! related parameters. - begin of T_NLU_ENRICHMENT_EMOTION, - "! When `true`, emotion detection is performed on the entire field. - DOCUMENT type BOOLEAN, - "! A comma-separated list of target strings that will have any associated emotions - "! detected. - TARGETS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_NLU_ENRICHMENT_EMOTION. - types: - "!- "! An object specifiying the concepts enrichment and related
- "! parameters. - begin of T_NLU_ENRICHMENT_CONCEPTS, - "! The maximum number of concepts enrichments to extact from each instance of the - "! specified field. - LIMIT type INTEGER, - end of T_NLU_ENRICHMENT_CONCEPTS. - types: - "!- "! An object specifying the Keyword enrichment and related
- "! parameters. - begin of T_NLU_ENRICHMENT_KEYWORDS, - "! When `true`, sentiment analysis of keywords will be performed on the specified - "! field. - SENTIMENT type BOOLEAN, - "! When `true`, emotion detection of keywords will be performed on the specified - "! field. - EMOTION type BOOLEAN, - "! The maximum number of keywords to extract for each instance of the specified - "! field. - LIMIT type INTEGER, - end of T_NLU_ENRICHMENT_KEYWORDS. - types: - "!- "! Object containing Natural Language Understanding features to
- "! be used. - begin of T_NLU_ENRICHMENT_FEATURES, - "! An object specifying the Keyword enrichment and related parameters. - KEYWORDS type T_NLU_ENRICHMENT_KEYWORDS, - "! An object speficying the Entities enrichment and related parameters. - ENTITIES type T_NLU_ENRICHMENT_ENTITIES, - "! An object specifying the sentiment extraction enrichment and related parameters. - "! - SENTIMENT type T_NLU_ENRICHMENT_SENTIMENT, - "! An object specifying the emotion detection enrichment and related parameters. - EMOTION type T_NLU_ENRICHMENT_EMOTION, - "! An object that indicates the Categories enrichment will be applied to the - "! specified field. - CATEGORIES type MAP, - "! An object specifiying the semantic roles enrichment and related parameters. - SEMANTIC_ROLES type T_NL_ENRICHMENT_SEMANTIC_ROLES, - "! An object specifying the relations enrichment and related parameters. - RELATIONS type T_NLU_ENRICHMENT_RELATIONS, - "! An object specifiying the concepts enrichment and related parameters. - CONCEPTS type T_NLU_ENRICHMENT_CONCEPTS, - end of T_NLU_ENRICHMENT_FEATURES. - types: - "!- "! An object representing the configuration options to use for
- "! the `natural_language_understanding` enrichments. - begin of T_NLU_ENRICHMENT_OPTIONS, - "! Object containing Natural Language Understanding features to be used. - FEATURES type T_NLU_ENRICHMENT_FEATURES, - "! ISO 639-1 code indicating the language to use for the analysis. This code - "! overrides the automatic language detection performed by the service. Valid - "! codes are `ar` (Arabic), `en` (English), `fr` (French), `de` (German), `it` - "! (Italian), `pt` (Portuguese), `ru` (Russian), `es` (Spanish), and `sv` - "! (Swedish). **Note:** Not all features support all languages, automatic - "! detection is recommended. - LANGUAGE type STRING, - end of T_NLU_ENRICHMENT_OPTIONS. - types: - "!- "! An object defining a single tokenizaion rule.
- begin of T_TOKEN_DICT_RULE, - "! The string to tokenize. - TEXT type STRING, - "! Array of tokens that the `text` field is split into when found. - TOKENS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Array of tokens that represent the content of the `text` field in an alternate - "! character set. - READINGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The part of speech that the `text` string belongs to. For example `noun`. Custom - "! parts of speech can be specified. - PART_OF_SPEECH type STRING, - end of T_TOKEN_DICT_RULE. - types: - "!- "! Tokenization dictionary describing how words are tokenized
- "! during ingestion and at query time. - begin of T_TOKEN_DICT, - "! An array of tokenization rules. Each rule contains, the original `text` string, - "! component `tokens`, any alternate character set `readings`, and which - "! `part_of_speech` the text is from. - TOKENIZATION_RULES type STANDARD TABLE OF T_TOKEN_DICT_RULE WITH NON-UNIQUE DEFAULT KEY, - end of T_TOKEN_DICT. - types: - "! No documentation available. - begin of T_FILTER, - "! The match the aggregated results queried for. - MATCH type STRING, - end of T_FILTER. - types: - "!- "! Object defining which URL to crawl and how to crawl it.
- begin of T_SOURCE_OPTIONS_WEB_CRAWL, - "! The starting URL to crawl. - URL type STRING, - "! When `true`, crawls of the specified URL are limited to the host part of the - "! **url** field. - LIMIT_TO_STARTING_HOSTS type BOOLEAN, - "! The number of concurrent URLs to fetch. `gentle` means one URL is fetched at a - "! time with a delay between each call. `normal` means as many as two URLs are - "! fectched concurrently with a short delay between fetch calls. `aggressive` - "! means that up to ten URLs are fetched concurrently with a short delay between - "! fetch calls. - CRAWL_SPEED type STRING, - "! When `true`, allows the crawl to interact with HTTPS sites with SSL certificates - "! with untrusted signers. - ALLOW_UNTRUSTED_CERTIFICATE type BOOLEAN, - "! The maximum number of hops to make from the initial URL. When a page is crawled - "! each link on that page will also be crawled if it is within the - "! **maximum_hops** from the initial URL. The first page crawled is 0 hops, each - "! link crawled from the first page is 1 hop, each link crawled from those pages - "! is 2 hops, and so on. - MAXIMUM_HOPS type INTEGER, - "! The maximum milliseconds to wait for a response from the web server. - REQUEST_TIMEOUT type INTEGER, - "! When `true`, the crawler will ignore any `robots.txt` encountered by the - "! crawler. This should only ever be done when crawling a web site the user owns. - "! This must be be set to `true` when a **gateway_id** is specied in the - "! **credentials**. - OVERRIDE_ROBOTS_TXT type BOOLEAN, - "! Array of URL's to be excluded while crawling. The crawler will not follow - "! links which contains this string. For example, listing `https://ibm.com/watson` - "! also excludes `https://ibm.com/watson/discovery`. - BLACKLIST type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_SOURCE_OPTIONS_WEB_CRAWL. - types: - "!- "! An object that indicates the Categories enrichment will be
- "! applied to the specified field. - T_NLU_ENRICHMENT_CATEGORIES type MAP. - types: - "!- "! Object containing details of the stored credentials.
- "! Object containing credential information.
- begin of T_CREDENTIALS, - "! Unique identifier for this set of credentials. - CREDENTIAL_ID type STRING, - "! The source that this credentials object connects to.- "! Object containing array of credential definitions.
- begin of T_CREDENTIALS_LIST, - "! An array of credential definitions that were created for this instance. - CREDENTIALS type STANDARD TABLE OF T_CREDENTIALS WITH NON-UNIQUE DEFAULT KEY, - end of T_CREDENTIALS_LIST. - types: - "!- "! Summary of the collection usage in the environment.
- begin of T_COLLECTION_USAGE, - "! Number of active collections in the environment. - AVAILABLE type INTEGER, - "! Total number of collections allowed in the environment. - MAXIMUM_ALLOWED type INTEGER, - end of T_COLLECTION_USAGE. - types: - "!- "! Summary of the disk usage statistics for the environment.
- begin of T_DISK_USAGE, - "! Number of bytes within the environment's disk capacity that are currently - "! used to store data. - USED_BYTES type INTEGER, - "! Total number of bytes available in the environment's disk capacity. - MAXIMUM_ALLOWED_BYTES type INTEGER, - end of T_DISK_USAGE. - types: - "!- "! Summary of the document usage statistics for the
- "! environment. - begin of T_ENVIRONMENT_DOCUMENTS, - "! Number of documents indexed for the environment. - AVAILABLE type INTEGER, - "! Total number of documents allowed in the environment's capacity. - MAXIMUM_ALLOWED type INTEGER, - end of T_ENVIRONMENT_DOCUMENTS. - types: - "!- "! Details about the resource usage and capacity of the
- "! environment. - begin of T_INDEX_CAPACITY, - "! Summary of the document usage statistics for the environment. - DOCUMENTS type T_ENVIRONMENT_DOCUMENTS, - "! Summary of the disk usage statistics for the environment. - DISK_USAGE type T_DISK_USAGE, - "! Summary of the collection usage in the environment. - COLLECTIONS type T_COLLECTION_USAGE, - end of T_INDEX_CAPACITY. - types: - "!- "! Information about the Continuous Relevancy Training for this
- "! environment. - begin of T_SEARCH_STATUS, - "! Current scope of the training. Always returned as `environment`. - SCOPE type STRING, - "! The current status of Continuous Relevancy Training for this environment. - STATUS type STRING, - "! Long description of the current Continuous Relevancy Training status. - STATUS_DESCRIPTION type STRING, - "! The date stamp of the most recent completed training for this environment. - LAST_TRAINED type DATE, - end of T_SEARCH_STATUS. - types: - "!- "! Details about an environment.
- begin of T_ENVIRONMENT, - "! Unique identifier for the environment. - ENVIRONMENT_ID type STRING, - "! Name that identifies the environment. - NAME type STRING, - "! Description of the environment. - DESCRIPTION type STRING, - "! Creation date of the environment, in the format - "! `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. - CREATED type DATETIME, - "! Date of most recent environment update, in the format - "! `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. - UPDATED type DATETIME, - "! Current status of the environment. `resizing` is displayed when a request to - "! increase the environment size has been made, but is still in the process of - "! being completed. - STATUS type STRING, - "! If `true`, the environment contains read-only collections that are maintained by - "! IBM. - READ_ONLY type BOOLEAN, - "! Current size of the environment. - SIZE type STRING, - "! The new size requested for this environment. Only returned when the environment - "! *status* is `resizing`.- "! Response object containing an array of configured
- "! environments. - begin of T_LIST_ENVIRONMENTS_RESPONSE, - "! An array of [environments] that are available for the service instance. - ENVIRONMENTS type STANDARD TABLE OF T_ENVIRONMENT WITH NON-UNIQUE DEFAULT KEY, - end of T_LIST_ENVIRONMENTS_RESPONSE. - types: - "!- "! Gatway deletion confirmation.
- begin of T_GATEWAY_DELETE, - "! The gateway ID of the deleted gateway. - GATEWAY_ID type STRING, - "! The status of the request. - STATUS type STRING, - end of T_GATEWAY_DELETE. - types: - "!- "! Training example details.
- begin of T_TRAINING_EXAMPLE, - "! The document ID associated with this training example. - DOCUMENT_ID type STRING, - "! The cross reference associated with this training example. - CROSS_REFERENCE type STRING, - "! The relevance of the training example. - RELEVANCE type INTEGER, - end of T_TRAINING_EXAMPLE. - types: - "!- "! Training query details.
- begin of T_TRAINING_QUERY, - "! The query ID associated with the training query. - QUERY_ID type STRING, - "! The natural text query for the training query. - NATURAL_LANGUAGE_QUERY type STRING, - "! The filter used on the collection before the **natural_language_query** is - "! applied. - FILTER type STRING, - "! Array of training examples. - EXAMPLES type STANDARD TABLE OF T_TRAINING_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAINING_QUERY. - types: - "!- "! A passage query result.
- begin of T_QUERY_PASSAGES, - "! The unique identifier of the document from which the passage has been extracted. - "! - DOCUMENT_ID type STRING, - "! The confidence score of the passages's analysis. A higher score indicates - "! greater confidence. - PASSAGE_SCORE type DOUBLE, - "! The content of the extracted passage. - PASSAGE_TEXT type STRING, - "! The position of the first character of the extracted passage in the originating - "! field. - START_OFFSET type INTEGER, - "! The position of the last character of the extracted passage in the originating - "! field. - END_OFFSET type INTEGER, - "! The label of the field from which the passage has been extracted. - FIELD type STRING, - end of T_QUERY_PASSAGES. - types: - "!- "! Object containing normalization operations.
- begin of T_NORMALIZATION_OPERATION, - "! Identifies what type of operation to perform.- "! Font matching configuration.
- begin of T_FONT_SETTING, - "! The HTML heading level that any content with the matching font is converted to. - LEVEL type INTEGER, - "! The minimum size of the font to match. - MIN_SIZE type INTEGER, - "! The maximum size of the font to match. - MAX_SIZE type INTEGER, - "! When `true`, the font is matched if it is bold. - BOLD type BOOLEAN, - "! When `true`, the font is matched if it is italic. - ITALIC type BOOLEAN, - "! The name of the font. - NAME type STRING, - end of T_FONT_SETTING. - types: - "!- "! Microsoft Word styles to convert into a specified HTML head
- "! level. - begin of T_WORD_STYLE, - "! HTML head level that content matching this style is tagged with. - LEVEL type INTEGER, - "! Array of word style names to convert. - NAMES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_WORD_STYLE. - types: - "!- "! Object containing heading detection conversion settings for
- "! Microsoft Word documents. - begin of T_WORD_HEADING_DETECTION, - "! Array of font matching configurations. - FONTS type STANDARD TABLE OF T_FONT_SETTING WITH NON-UNIQUE DEFAULT KEY, - "! Array of Microsoft Word styles to convert. - STYLES type STANDARD TABLE OF T_WORD_STYLE WITH NON-UNIQUE DEFAULT KEY, - end of T_WORD_HEADING_DETECTION. - types: - "!- "! Object containing heading detection conversion settings for
- "! PDF documents. - begin of T_PDF_HEADING_DETECTION, - "! Array of font matching configurations. - FONTS type STANDARD TABLE OF T_FONT_SETTING WITH NON-UNIQUE DEFAULT KEY, - end of T_PDF_HEADING_DETECTION. - types: - "!- "! A list of PDF conversion settings.
- begin of T_PDF_SETTINGS, - "! Object containing heading detection conversion settings for PDF documents. - HEADING type T_PDF_HEADING_DETECTION, - end of T_PDF_SETTINGS. - types: - "!- "! Object that defines a box folder to crawl with this
- "! configuration. - begin of T_SOURCE_OPTIONS_FOLDER, - "! The Box user ID of the user who owns the folder to crawl. - OWNER_USER_ID type STRING, - "! The Box folder ID of the folder to crawl. - FOLDER_ID type STRING, - "! The maximum number of documents to crawl for this folder. By default, all - "! documents in the folder are crawled. - LIMIT type INTEGER, - end of T_SOURCE_OPTIONS_FOLDER. - types: - "!- "! Object defining a cloud object store bucket to crawl.
- begin of T_SOURCE_OPTIONS_BUCKETS, - "! The name of the cloud object store bucket to crawl. - NAME type STRING, - "! The number of documents to crawl from this cloud object store bucket. If not - "! specified, all documents in the bucket are crawled. - LIMIT type INTEGER, - end of T_SOURCE_OPTIONS_BUCKETS. - types: - "!- "! Object containing the schedule information for the source.
- begin of T_SOURCE_SCHEDULE, - "! When `true`, the source is re-crawled based on the **frequency** field in this - "! object. When `false` the source is not re-crawled; When `false` and connecting - "! to Salesforce the source is crawled annually. - ENABLED type BOOLEAN, - "! The time zone to base source crawl times on. Possible values correspond to the - "! IANA (Internet Assigned Numbers Authority) time zones list. - TIME_ZONE type STRING, - "! The crawl schedule in the specified **time_zone**.- "! Object that defines a Salesforce document object type crawl
- "! with this configuration. - begin of T_SOURCE_OPTIONS_OBJECT, - "! The name of the Salesforce document object to crawl. For example, `case`. - NAME type STRING, - "! The maximum number of documents to crawl for this document object. By default, - "! all documents in the document object are crawled. - LIMIT type INTEGER, - end of T_SOURCE_OPTIONS_OBJECT. - types: - "!- "! Object that defines a Microsoft SharePoint site collection
- "! to crawl with this configuration. - begin of T_SOURCE_OPTIONS_SITE_COLL, - "! The Microsoft SharePoint Online site collection path to crawl. The path must be - "! be relative to the **organization_url** that was specified in the credentials - "! associated with this source configuration. - SITE_COLLECTION_PATH1 type STRING, - "! The maximum number of documents to crawl for this site collection. By default, - "! all documents in the site collection are crawled. - LIMIT type INTEGER, - end of T_SOURCE_OPTIONS_SITE_COLL. - types: - "!- "! The **options** object defines which items to crawl from the
- "! source system. - begin of T_SOURCE_OPTIONS, - "! Array of folders to crawl from the Box source. Only valid, and required, when - "! the **type** field of the **source** object is set to `box`. - FOLDERS type STANDARD TABLE OF T_SOURCE_OPTIONS_FOLDER WITH NON-UNIQUE DEFAULT KEY, - "! Array of Salesforce document object types to crawl from the Salesforce source. - "! Only valid, and required, when the **type** field of the **source** object is - "! set to `salesforce`. - OBJECTS type STANDARD TABLE OF T_SOURCE_OPTIONS_OBJECT WITH NON-UNIQUE DEFAULT KEY, - "! Array of Microsoft SharePointoint Online site collections to crawl from the - "! SharePoint source. Only valid and required when the **type** field of the - "! **source** object is set to `sharepoint`. - SITE_COLLECTIONS type STANDARD TABLE OF T_SOURCE_OPTIONS_SITE_COLL WITH NON-UNIQUE DEFAULT KEY, - "! Array of Web page URLs to begin crawling the web from. Only valid and required - "! when the **type** field of the **source** object is set to `web_crawl`. - URLS type STANDARD TABLE OF T_SOURCE_OPTIONS_WEB_CRAWL WITH NON-UNIQUE DEFAULT KEY, - "! Array of cloud object store buckets to begin crawling. Only valid and required - "! when the **type** field of the **source** object is set to - "! `cloud_object_store`, and the **crawl_all_buckets** field is `false` or not - "! specified. - BUCKETS type STANDARD TABLE OF T_SOURCE_OPTIONS_BUCKETS WITH NON-UNIQUE DEFAULT KEY, - "! When `true`, all buckets in the specified cloud object store are crawled. If set - "! to `true`, the **buckets** array must not be specified. - CRAWL_ALL_BUCKETS type BOOLEAN, - end of T_SOURCE_OPTIONS. - types: - "!- "! Object containing source parameters for the configuration.
- begin of T_SOURCE, - "! The type of source to connect to.- "! Object containing an array of XPaths.
- begin of T_XPATH_PATTERNS, - "! An array to XPaths. - XPATHS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_XPATH_PATTERNS. - types: - "!- "! Options which are specific to a particular enrichment.
- begin of T_ENRICHMENT_OPTIONS, - "! Object containing Natural Language Understanding features to be used. - FEATURES type T_NLU_ENRICHMENT_FEATURES, - "! ISO 639-1 code indicating the language to use for the analysis. This code - "! overrides the automatic language detection performed by the service. Valid - "! codes are `ar` (Arabic), `en` (English), `fr` (French), `de` (German), `it` - "! (Italian), `pt` (Portuguese), `ru` (Russian), `es` (Spanish), and `sv` - "! (Swedish). **Note:** Not all features support all languages, automatic - "! detection is recommended. - LANGUAGE type STRING, - "! *For use with `elements` enrichments only.* The element extraction model to use. - "! Models available are: `contract`. - MODEL type STRING, - end of T_ENRICHMENT_OPTIONS. - types: - "!- "! Enrichment step to perform on the document. Each enrichment
- "! is performed on the specified field in the order that they are listed in the - "! configuration. - begin of T_ENRICHMENT, - "! Describes what the enrichment step does. - DESCRIPTION type STRING, - "! Field where enrichments will be stored. This field must already exist or be at - "! most 1 level deeper than an existing field. For example, if `text` is a - "! top-level field with no sub-fields, `text.foo` is a valid destination but - "! `text.foo.bar` is not. - DESTINATION_FIELD type STRING, - "! Field to be enriched.- "! A list of Document Segmentation settings.
- begin of T_SEGMENT_SETTINGS, - "! Enables/disables the Document Segmentation feature. - ENABLED type BOOLEAN, - "! Defines the heading level that splits into document segments. Valid values are - "! h1, h2, h3, h4, h5, h6. The content of the header field that the segmentation - "! splits at is used as the **title** field for that segmented result. Only valid - "! if used with a collection that has **enabled** set to `false` in the - "! **smart_document_understanding** object. - SELECTOR_TAGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Defines the annotated smart document understanding fields that the document is - "! split on. The content of the annotated field that the segmentation splits at is - "! used as the **title** field for that segmented result. For example, if the - "! field `sub-title` is specified, when a document is uploaded each time the smart - "! documement understanding conversion encounters a field of type `sub-title` the - "! document is split at that point and the content of the field used as the title - "! of the remaining content. Thnis split is performed for all instances of the - "! listed fields in the uploaded document. Only valid if used with a collection - "! that has **enabled** set to `true` in the **smart_document_understanding** - "! object. - ANNOTATED_FIELDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_SEGMENT_SETTINGS. - types: - "!- "! A list of Word conversion settings.
- begin of T_WORD_SETTINGS, - "! Object containing heading detection conversion settings for Microsoft Word - "! documents. - HEADING type T_WORD_HEADING_DETECTION, - end of T_WORD_SETTINGS. - types: - "!- "! A list of HTML conversion settings.
- begin of T_HTML_SETTINGS, - "! Array of HTML tags that are excluded completely. - EXCLUDE_TAGS_COMPLETELY type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Array of HTML tags which are excluded but still retain content. - EXCLUDE_TAGS_KEEP_CONTENT type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Object containing an array of XPaths. - KEEP_CONTENT type T_XPATH_PATTERNS, - "! Object containing an array of XPaths. - EXCLUDE_CONTENT type T_XPATH_PATTERNS, - "! An array of HTML tag attributes to keep in the converted document. - KEEP_TAG_ATTRIBUTES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! Array of HTML tag attributes to exclude. - EXCLUDE_TAG_ATTRIBUTES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_HTML_SETTINGS. - types: - "!- "! Document conversion settings.
- begin of T_CONVERSIONS, - "! A list of PDF conversion settings. - PDF type T_PDF_SETTINGS, - "! A list of Word conversion settings. - WORD type T_WORD_SETTINGS, - "! A list of HTML conversion settings. - HTML type T_HTML_SETTINGS, - "! A list of Document Segmentation settings. - SEGMENT type T_SEGMENT_SETTINGS, - "! Defines operations that can be used to transform the final output JSON into a - "! normalized form. Operations are executed in the order that they appear in the - "! array. - JSON_NORMALIZATIONS type STANDARD TABLE OF T_NORMALIZATION_OPERATION WITH NON-UNIQUE DEFAULT KEY, - "! When `true`, automatic text extraction from images (this includes images - "! embedded in supported document formats, for example PDF, and suppported image - "! formats, for example TIFF) is performed on documents uploaded to the - "! collection. This field is supported on **Advanced** and higher plans only. - "! **Lite** plans do not support image text recognition. - IMAGE_TEXT_RECOGNITION type BOOLEAN, - end of T_CONVERSIONS. - types: - "!- "! A custom configuration for the environment.
- begin of T_CONFIGURATION, - "! The unique identifier of the configuration. - CONFIGURATION_ID type STRING, - "! The name of the configuration. - NAME type STRING, - "! The creation date of the configuration in the format - "! yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. - CREATED type DATETIME, - "! The timestamp of when the configuration was last updated in the format - "! yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. - UPDATED type DATETIME, - "! The description of the configuration, if available. - DESCRIPTION type STRING, - "! Document conversion settings. - CONVERSIONS type T_CONVERSIONS, - "! An array of document enrichment settings for the configuration. - ENRICHMENTS type STANDARD TABLE OF T_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY, - "! Defines operations that can be used to transform the final output JSON into a - "! normalized form. Operations are executed in the order that they appear in the - "! array. - NORMALIZATIONS type STANDARD TABLE OF T_NORMALIZATION_OPERATION WITH NON-UNIQUE DEFAULT KEY, - "! Object containing source parameters for the configuration. - SOURCE type T_SOURCE, - end of T_CONFIGURATION. - types: - "!- "! Object containing an array of available configurations.
- begin of T_LIST_CONFIGURATIONS_RESPONSE, - "! An array of configurations that are available for the service instance. - CONFIGURATIONS type STANDARD TABLE OF T_CONFIGURATION WITH NON-UNIQUE DEFAULT KEY, - end of T_LIST_CONFIGURATIONS_RESPONSE. - types: - "!- "! Object containing source crawl status information.
- begin of T_SOURCE_STATUS, - "! The current status of the source crawl for this collection. This field returns - "! `not_configured` if the default configuration for this source does not have a - "! **source** object defined.- "! Object returned after credentials are deleted.
- begin of T_DELETE_CREDENTIALS, - "! The unique identifier of the credentials that have been deleted. - CREDENTIAL_ID type STRING, - "! The status of the deletion request. - STATUS type STRING, - end of T_DELETE_CREDENTIALS. - types: - "!- "! A notice produced for the collection.
- begin of T_NOTICE, - "! Identifies the notice. Many notices might have the same ID. This field exists so - "! that user applications can programmatically identify a notice and take - "! automatic corrective action. Typical notice IDs include: `index_failed`, - "! `index_failed_too_many_requests`, `index_failed_incompatible_field`, - "! `index_failed_cluster_unavailable`, `ingestion_timeout`, `ingestion_error`, - "! `bad_request`, `internal_error`, `missing_model`, `unsupported_model`, - "! `smart_document_understanding_failed_incompatible_field`, - "! `smart_document_understanding_failed_internal_error`, - "! `smart_document_understanding_failed_internal_error`, - "! `smart_document_understanding_failed_warning`, - "! `smart_document_understanding_page_error`, - "! `smart_document_understanding_page_warning`. **Note:** This is not a complete - "! list, other values might be returned. - NOTICE_ID type STRING, - "! The creation date of the collection in the format - "! yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. - CREATED type DATETIME, - "! Unique identifier of the document. - DOCUMENT_ID type STRING, - "! Unique identifier of the query used for relevance training. - QUERY_ID type STRING, - "! Severity level of the notice. - SEVERITY type STRING, - "! Ingestion or training step in which the notice occurred. Typical step values - "! include: `classify_elements`, `smartDocumentUnderstanding`, `ingestion`, - "! `indexing`, `convert`. **Note:** This is not a complete list, other values - "! might be returned. - STEP type STRING, - "! The description of the notice. - DESCRIPTION type STRING, - end of T_NOTICE. - types: - "!- "! Information returned after an uploaded document is accepted.
- begin of T_DOCUMENT_ACCEPTED, - "! The unique identifier of the ingested document. - DOCUMENT_ID type STRING, - "! Status of the document in the ingestion process. A status of `processing` is - "! returned for documents that are ingested with a *version* date before - "! `2019-01-01`. The `pending` status is returned for all others. - STATUS type STRING, - "! Array of notices produced by the document-ingestion process. - NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, - end of T_DOCUMENT_ACCEPTED. - types: - "!- "! Object describing a specific gateway.
- begin of T_GATEWAY, - "! The gateway ID of the gateway. - GATEWAY_ID type STRING, - "! The user defined name of the gateway. - NAME type STRING, - "! The current status of the gateway. `connected` means the gateway is connected to - "! the remotly installed gateway. `idle` means this gateway is not currently in - "! use. - STATUS type STRING, - "! The generated **token** for this gateway. The value of this field is used when - "! configuring the remotly installed gateway. - TOKEN type STRING, - "! The generated **token_id** for this gateway. The value of this field is used - "! when configuring the remotly installed gateway. - TOKEN_ID type STRING, - end of T_GATEWAY. - types: - "!- "! Aggregation result data for the requested metric.
- begin of T_METRIC_AGGREGATION_RESULT, - "! Date in string form representing the start of this interval. - KEY_AS_STRING type DATETIME, - "! Unix epoch time equivalent of the **key_as_string**, that represents the start - "! of this interval. - KEY type LONG, - "! Number of matching results. - MATCHING_RESULTS type INTEGER, - "! The number of queries with associated events divided by the total number of - "! queries for the interval. Only returned with **event_rate** metrics. - EVENT_RATE type DOUBLE, - end of T_METRIC_AGGREGATION_RESULT. - types: - "!- "! An aggregation analyzing log information for queries and
- "! events. - begin of T_METRIC_AGGREGATION, - "! The measurement interval for this metric. Metric intervals are always 1 day - "! (`1d`). - INTERVAL type STRING, - "! The event type associated with this metric result. This field, when present, - "! will always be `click`. - EVENT_TYPE type STRING, - "! Array of metric aggregation query results. - RESULTS type STANDARD TABLE OF T_METRIC_AGGREGATION_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_METRIC_AGGREGATION. - types: - "!- "! The response generated from a call to a **metrics** method.
- begin of T_METRIC_RESPONSE, - "! Array of metric aggregations. - AGGREGATIONS type STANDARD TABLE OF T_METRIC_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, - end of T_METRIC_RESPONSE. - types: - "!- "! Metadata of a query result.
- begin of T_QUERY_RESULT_METADATA, - "! An unbounded measure of the relevance of a particular result, dependent on the - "! query and matching document. A higher score indicates a greater match to the - "! query parameters. - SCORE type DOUBLE, - "! The confidence score for the given result. Calculated based on how relevant the - "! result is estimated to be. confidence can range from `0.0` to `1.0`. The higher - "! the number, the more relevant the document. The `confidence` value for a result - "! was calculated using the model specified in the `document_retrieval_strategy` - "! field of the result set. - CONFIDENCE type DOUBLE, - end of T_QUERY_RESULT_METADATA. - types: - "!- "! Query result object.
- begin of T_QUERY_NOTICES_RESULT, - "! The unique identifier of the document. - ID type STRING, - "! Metadata of the document. - METADATA type MAP, - "! The collection ID of the collection containing the document for this result. - COLLECTION_ID type STRING, - "! Metadata of a query result. - RESULT_METADATA type T_QUERY_RESULT_METADATA, - "! The internal status code returned by the ingestion subsystem indicating the - "! overall result of ingesting the source document. - CODE type INTEGER, - "! Name of the original source file (if available). - FILENAME type STRING, - "! The type of the original source file. - FILE_TYPE type STRING, - "! The SHA-1 hash of the original source file (formatted as a hexadecimal string). - SHA1 type STRING, - "! Array of notices for the document. - NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, - end of T_QUERY_NOTICES_RESULT. - types: - "!- "! Each object in the **results** array corresponds to an
- "! individual document returned by the original query. - begin of T_LOG_QRY_RESP_RSLT_DOCS_RSLT, - "! The result rank of this document. A position of `1` indicates that it was the - "! first returned result. - POSITION type INTEGER, - "! The **document_id** of the document that this result represents. - DOCUMENT_ID type STRING, - "! The raw score of this result. A higher score indicates a greater match to the - "! query parameters. - SCORE type DOUBLE, - "! The confidence score of the result's analysis. A higher score indicating - "! greater confidence. - CONFIDENCE type DOUBLE, - "! The **collection_id** of the document represented by this result. - COLLECTION_ID type STRING, - end of T_LOG_QRY_RESP_RSLT_DOCS_RSLT. - types: - "!- "! Object containing result information that was returned by
- "! the query used to create this log entry. Only returned with logs of type - "! `query`. - begin of T_LOG_QUERY_RESP_RESULT_DOCS, - "! Array of log query response results. - RESULTS type STANDARD TABLE OF T_LOG_QRY_RESP_RSLT_DOCS_RSLT WITH NON-UNIQUE DEFAULT KEY, - "! The number of results returned in the query associate with this log. - COUNT type INTEGER, - end of T_LOG_QUERY_RESP_RESULT_DOCS. - types: - "!- "! Object containing field details.
- begin of T_FIELD, - "! The name of the field. - FIELD type STRING, - "! The type of the field. - TYPE type STRING, - end of T_FIELD. - types: - "!- "! Query event data object.
- begin of T_EVENT_DATA, - "! The **environment_id** associated with the query that the event is associated - "! with. - ENVIRONMENT_ID type STRING, - "! The session token that was returned as part of the query results that this event - "! is associated with. - SESSION_TOKEN type STRING, - "! The optional timestamp for the event that was created. If not provided, the time - "! that the event was created in the log was used. - CLIENT_TIMESTAMP type DATETIME, - "! The rank of the result item which the event is associated with. - DISPLAY_RANK type INTEGER, - "! The **collection_id** of the document that this event is associated with. - COLLECTION_ID type STRING, - "! The **document_id** of the document that this event is associated with. - DOCUMENT_ID type STRING, - "! The query identifier stored in the log. The query and any events associated with - "! that query are stored with the same **query_id**. - QUERY_ID type STRING, - end of T_EVENT_DATA. - types: - "!- "! An object defining the event being created.
- begin of T_CREATE_EVENT_OBJECT, - "! The event type to be created. - TYPE type STRING, - "! Query event data object. - DATA type T_EVENT_DATA, - end of T_CREATE_EVENT_OBJECT. - types: - "! No documentation available. - begin of T_NESTED, - "! The area of the results the aggregation was restricted to. - PATH type STRING, - end of T_NESTED. - types: - "!- "! Object that describes a long query.
- begin of T_QUERY_LARGE, - "! A cacheable query that excludes documents that don't mention the query - "! content. Filter searches are better for metadata-type searches and for - "! assessing the concepts in the data set. - FILTER type STRING, - "! A query search returns all documents in your data set with full enrichments and - "! full text, but with the most relevant documents listed first. Use a query - "! search when you want to find the most relevant search results. - QUERY type STRING, - "! A natural language query that returns relevant documents by utilizing training - "! data and natural language understanding. - NATURAL_LANGUAGE_QUERY type STRING, - "! A passages query that returns the most relevant passages from the results. - PASSAGES type BOOLEAN, - "! An aggregation search that returns an exact answer by combining query search - "! with filters. Useful for applications to build lists, tables, and time series. - "! For a full list of possible aggregations, see the Query reference. - AGGREGATION type STRING, - "! Number of results to return. - COUNT type INTEGER, - "! A comma-separated list of the portion of the document hierarchy to return. - RETURN type STRING, - "! The number of query results to skip at the beginning. For example, if the total - "! number of results that are returned is 10 and the offset is 8, it returns the - "! last two results. - OFFSET type INTEGER, - "! A comma-separated list of fields in the document to sort on. You can optionally - "! specify a sort direction by prefixing the field with `-` for descending or `+` - "! for ascending. Ascending is the default sort direction if no prefix is - "! specified. This parameter cannot be used in the same query as the **bias** - "! parameter. - SORT type STRING, - "! When true, a highlight field is returned for each result which contains the - "! fields which match the query with `<em></em>` tags around the - "! matching query terms. - HIGHLIGHT type BOOLEAN, - "! A comma-separated list of fields that passages are drawn from. If this parameter - "! not specified, then all top-level fields are included. - PASSAGES_FIELDS type STRING, - "! The maximum number of passages to return. The search returns fewer passages if - "! the requested total is not found. The default is `10`. The maximum is `100`. - PASSAGES_COUNT type INTEGER, - "! The approximate number of characters that any one passage will have. - PASSAGES_CHARACTERS type INTEGER, - "! When `true`, and used with a Watson Discovery News collection, duplicate results - "! (based on the contents of the **title** field) are removed. Duplicate - "! comparison is limited to the current query only; **offset** is not considered. - "! This parameter is currently Beta functionality. - DEDUPLICATE type BOOLEAN, - "! When specified, duplicate results based on the field specified are removed from - "! the returned results. Duplicate comparison is limited to the current query - "! only, **offset** is not considered. This parameter is currently Beta - "! functionality. - DEDUPLICATE_FIELD type STRING, - "! When `true`, results are returned based on their similarity to the document IDs - "! specified in the **similar.document_ids** parameter. - SIMILAR type BOOLEAN, - "! A comma-separated list of document IDs to find similar documents.- "! Object containing user-defined name.
- begin of T_GATEWAY_NAME, - "! User-defined name. - NAME type STRING, - end of T_GATEWAY_NAME. - types: - "!- "! Object containing collection document count information.
- begin of T_DOCUMENT_COUNTS, - "! The total number of available documents in the collection. - AVAILABLE type LONG, - "! The number of documents in the collection that are currently being processed. - PROCESSING type LONG, - "! The number of documents in the collection that failed to be ingested. - FAILED type LONG, - "! The number of documents that have been uploaded to the collection, but have not - "! yet started processing. - PENDING type LONG, - end of T_DOCUMENT_COUNTS. - types: - "!- "! Information about custom smart document understanding fields
- "! that exist in this collection. - begin of T_SDU_STATUS_CUSTOM_FIELDS, - "! The number of custom fields defined for this collection. - DEFINED type LONG, - "! The maximum number of custom fields that are allowed in this collection. - MAXIMUM_ALLOWED type LONG, - end of T_SDU_STATUS_CUSTOM_FIELDS. - types: - "!- "! Object containing smart document understanding information
- "! for this collection. - begin of T_SDU_STATUS, - "! When `true`, smart document understanding conversion is enabled for this - "! collection. All collections created with a version date after `2019-04-30` have - "! smart document understanding enabled. If `false`, documents added to the - "! collection are converted using the **conversion** settings specified in the - "! configuration associated with the collection. - ENABLED type BOOLEAN, - "! The total number of pages annotated using smart document understanding in this - "! collection. - TOTAL_ANNOTATED_PAGES type LONG, - "! The current number of pages that can be used for training smart document - "! understanding. The `total_pages` number is calculated as the total number of - "! pages identified from the documents listed in the **total_documents** field. - TOTAL_PAGES type LONG, - "! The total number of documents in this collection that can be used to train smart - "! document understanding. For **lite** plan collections, the maximum is the first - "! 20 uploaded documents (not including HTML or JSON documents). For other plans, - "! the maximum is the first 40 uploaded documents (not including HTML or JSON - "! documents). When the maximum is reached, additional documents uploaded to the - "! collection are not considered for training smart document understanding. - TOTAL_DOCUMENTS type LONG, - "! Information about custom smart document understanding fields that exist in this - "! collection. - CUSTOM_FIELDS type T_SDU_STATUS_CUSTOM_FIELDS, - end of T_SDU_STATUS. - types: - "!- "! Object containing information about the crawl status of this
- "! collection. - begin of T_COLLECTION_CRAWL_STATUS, - "! Object containing source crawl status information. - SOURCE_CRAWL type T_SOURCE_STATUS, - end of T_COLLECTION_CRAWL_STATUS. - types: - "!- "! Summary of the disk usage statistics for this collection.
- begin of T_COLLECTION_DISK_USAGE, - "! Number of bytes used by the collection. - USED_BYTES type INTEGER, - end of T_COLLECTION_DISK_USAGE. - types: - "!- "! A collection for storing documents.
- begin of T_COLLECTION, - "! The unique identifier of the collection. - COLLECTION_ID type STRING, - "! The name of the collection. - NAME type STRING, - "! The description of the collection. - DESCRIPTION type STRING, - "! The creation date of the collection in the format - "! yyyy-MM-dd'T'HH:mmcon:ss.SSS'Z'. - CREATED type DATETIME, - "! The timestamp of when the collection was last updated in the format - "! yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. - UPDATED type DATETIME, - "! The status of the collection. - STATUS type STRING, - "! The unique identifier of the collection's configuration. - CONFIGURATION_ID type STRING, - "! The language of the documents stored in the collection. Permitted values include - "! `en` (English), `de` (German), and `es` (Spanish). - LANGUAGE type STRING, - "! Object containing collection document count information. - DOCUMENT_COUNTS type T_DOCUMENT_COUNTS, - "! Summary of the disk usage statistics for this collection. - DISK_USAGE type T_COLLECTION_DISK_USAGE, - "! Training status details. - TRAINING_STATUS type T_TRAINING_STATUS, - "! Object containing information about the crawl status of this collection. - CRAWL_STATUS type T_COLLECTION_CRAWL_STATUS, - "! Object containing smart document understanding information for this collection. - SMART_DOCUMENT_UNDERSTANDING type T_SDU_STATUS, - end of T_COLLECTION. - types: - "!- "! Array of Microsoft Word styles to convert.
- T_WORD_STYLES type STANDARD TABLE OF T_WORD_STYLE WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! An object representing the configuration options to use for
- "! the `elements` enrichment. - begin of T_ELEMENTS_ENRICHMENT_OPTIONS, - "! *For use with `elements` enrichments only.* The element extraction model to use. - "! Models available are: `contract`. - MODEL type STRING, - end of T_ELEMENTS_ENRICHMENT_OPTIONS. - types: - "!- "! Object containing information about a new environment.
- begin of T_CREATE_ENVIRONMENT_REQUEST, - "! Name that identifies the environment. - NAME type STRING, - "! Description of the environment. - DESCRIPTION type STRING, - "! Size of the environment. In the Lite plan the default and only accepted value is - "! `LT`, in all other plans the default is `S`. - SIZE type STRING, - end of T_CREATE_ENVIRONMENT_REQUEST. - types: - "!- "! Object containing specification for a new collection.
- begin of T_CREATE_COLLECTION_REQUEST, - "! The name of the collection to be created. - NAME type STRING, - "! A description of the collection. - DESCRIPTION type STRING, - "! The ID of the configuration in which the collection is to be created. - CONFIGURATION_ID type STRING, - "! The language of the documents stored in the collection, in the form of an ISO - "! 639-1 language code. - LANGUAGE type STRING, - end of T_CREATE_COLLECTION_REQUEST. - types: - "! No documentation available. - begin of T_INLINE_OBJECT, - "! The content of the stopword list to ingest. - STOPWORD_FILE type FILE, - end of T_INLINE_OBJECT. - types: - "!- "! Query result object.
- begin of T_QUERY_RESULT, - "! The unique identifier of the document. - ID type STRING, - "! Metadata of the document. - METADATA type MAP, - "! The collection ID of the collection containing the document for this result. - COLLECTION_ID type STRING, - "! Metadata of a query result. - RESULT_METADATA type T_QUERY_RESULT_METADATA, - end of T_QUERY_RESULT. - types: - "!- "! Top hit information for this query.
- begin of T_TOP_HITS_RESULTS, - "! Number of matching results. - MATCHING_RESULTS type INTEGER, - "! Top results returned by the aggregation. - HITS type STANDARD TABLE OF T_QUERY_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_TOP_HITS_RESULTS. - types: - "!- "! Response object returned when deleting a colleciton.
- begin of T_DELETE_COLLECTION_RESPONSE, - "! The unique identifier of the collection that is being deleted. - COLLECTION_ID type STRING, - "! The status of the collection. The status of a successful deletion operation is - "! `deleted`. - STATUS type STRING, - end of T_DELETE_COLLECTION_RESPONSE. - types: - "! No documentation available. - begin of T_TERM, - "! The field where the aggregation is located in the document. - FIELD type STRING, - "! The number of terms identified. - COUNT type INTEGER, - end of T_TERM. - types: - "!- "! An object containing an array of autocompletion suggestions.
- begin of T_COMPLETIONS, - "! Array of autcomplete suggestion based on the provided prefix. - COMPLETIONS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_COMPLETIONS. - types: - "!- "! An object contain retrieval type information.
- begin of T_RETRIEVAL_DETAILS, - "! Indentifies the document retrieval strategy used for this query. - "! `relevancy_training` indicates that the results were returned using a relevancy - "! trained model. `continuous_relevancy_training` indicates that the results were - "! returned using the continuous relevancy training model created by result - "! feedback analysis. `untrained` means the results were returned using the - "! standard untrained model.- "! Response object returned when deleting an environment.
- begin of T_DELETE_ENVIRONMENT_RESPONSE, - "! The unique identifier for the environment. - ENVIRONMENT_ID type STRING, - "! Status of the environment. - STATUS type STRING, - end of T_DELETE_ENVIRONMENT_RESPONSE. - types: - "!- "! The list of fetched fields.
- "! Object containing collection update information.
- begin of T_UPDATE_COLLECTION_REQUEST, - "! The name of the collection. - NAME type STRING, - "! A description of the collection. - DESCRIPTION type STRING, - "! The ID of the configuration in which the collection is to be updated. - CONFIGURATION_ID type STRING, - end of T_UPDATE_COLLECTION_REQUEST. - types: - "!- "! Object containing gateways array.
- begin of T_GATEWAY_LIST, - "! Array of configured gateway connections. - GATEWAYS type STANDARD TABLE OF T_GATEWAY WITH NON-UNIQUE DEFAULT KEY, - end of T_GATEWAY_LIST. - types: - "!- "! Aggregation result data for the requested metric.
- begin of T_METRIC_TOKEN_AGGR_RESULT, - "! The content of the **natural_language_query** parameter used in the query that - "! this result represents. - KEY type STRING, - "! Number of matching results. - MATCHING_RESULTS type INTEGER, - "! The number of queries with associated events divided by the total number of - "! queries currently stored (queries and events are stored in the log for 30 - "! days). - EVENT_RATE type DOUBLE, - end of T_METRIC_TOKEN_AGGR_RESULT. - types: - "!- "! An aggregation analyzing log information for queries and
- "! events. - begin of T_METRIC_TOKEN_AGGREGATION, - "! The event type associated with this metric result. This field, when present, - "! will always be `click`. - EVENT_TYPE type STRING, - "! Array of results for the metric token aggregation. - RESULTS type STANDARD TABLE OF T_METRIC_TOKEN_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_METRIC_TOKEN_AGGREGATION. - types: - "!- "! Object that describes a long query.
- begin of T_COLL_QUERY_LARGE, - "! A cacheable query that excludes documents that don't mention the query - "! content. Filter searches are better for metadata-type searches and for - "! assessing the concepts in the data set. - FILTER type STRING, - "! A query search returns all documents in your data set with full enrichments and - "! full text, but with the most relevant documents listed first. Use a query - "! search when you want to find the most relevant search results. - QUERY type STRING, - "! A natural language query that returns relevant documents by utilizing training - "! data and natural language understanding. - NATURAL_LANGUAGE_QUERY type STRING, - "! A passages query that returns the most relevant passages from the results. - PASSAGES type BOOLEAN, - "! An aggregation search that returns an exact answer by combining query search - "! with filters. Useful for applications to build lists, tables, and time series. - "! For a full list of possible aggregations, see the Query reference. - AGGREGATION type STRING, - "! Number of results to return. - COUNT type INTEGER, - "! A comma-separated list of the portion of the document hierarchy to return. - RETURN type STRING, - "! The number of query results to skip at the beginning. For example, if the total - "! number of results that are returned is 10 and the offset is 8, it returns the - "! last two results. - OFFSET type INTEGER, - "! A comma-separated list of fields in the document to sort on. You can optionally - "! specify a sort direction by prefixing the field with `-` for descending or `+` - "! for ascending. Ascending is the default sort direction if no prefix is - "! specified. This parameter cannot be used in the same query as the **bias** - "! parameter. - SORT type STRING, - "! When true, a highlight field is returned for each result which contains the - "! fields which match the query with `<em></em>` tags around the - "! matching query terms. - HIGHLIGHT type BOOLEAN, - "! A comma-separated list of fields that passages are drawn from. If this parameter - "! not specified, then all top-level fields are included. - PASSAGES_FIELDS type STRING, - "! The maximum number of passages to return. The search returns fewer passages if - "! the requested total is not found. The default is `10`. The maximum is `100`. - PASSAGES_COUNT type INTEGER, - "! The approximate number of characters that any one passage will have. - PASSAGES_CHARACTERS type INTEGER, - "! When `true`, and used with a Watson Discovery News collection, duplicate results - "! (based on the contents of the **title** field) are removed. Duplicate - "! comparison is limited to the current query only; **offset** is not considered. - "! This parameter is currently Beta functionality. - DEDUPLICATE type BOOLEAN, - "! When specified, duplicate results based on the field specified are removed from - "! the returned results. Duplicate comparison is limited to the current query - "! only, **offset** is not considered. This parameter is currently Beta - "! functionality. - DEDUPLICATE_FIELD type STRING, - "! When `true`, results are returned based on their similarity to the document IDs - "! specified in the **similar.document_ids** parameter. - SIMILAR type BOOLEAN, - "! A comma-separated list of document IDs to find similar documents.- "! Object containing environment update information.
- begin of T_UPDATE_ENVIRONMENT_REQUEST, - "! Name that identifies the environment. - NAME type STRING, - "! Description of the environment. - DESCRIPTION type STRING, - "! Size that the environment should be increased to. Environment size cannot be - "! modified when using a Lite plan. Environment size can only increased and not - "! decreased. - SIZE type STRING, - end of T_UPDATE_ENVIRONMENT_REQUEST. - types: - "!- "! Information returned when a configuration is deleted.
- begin of T_DEL_CONFIGURATION_RESPONSE, - "! The unique identifier for the configuration. - CONFIGURATION_ID type STRING, - "! Status of the configuration. A deleted configuration has the status deleted. - STATUS type STRING, - "! An array of notice messages, if any. - NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, - end of T_DEL_CONFIGURATION_RESPONSE. - types: - "!- "! A response containing the documents and aggregations for the
- "! query. - begin of T_QUERY_RESPONSE, - "! The number of matching results for the query. - MATCHING_RESULTS type INTEGER, - "! Array of document results for the query. - RESULTS type STANDARD TABLE OF T_QUERY_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! Array of aggregation results for the query. - AGGREGATIONS type STANDARD TABLE OF T_QUERY_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, - "! Array of passage results for the query. - PASSAGES type STANDARD TABLE OF T_QUERY_PASSAGES WITH NON-UNIQUE DEFAULT KEY, - "! The number of duplicate results removed. - DUPLICATES_REMOVED type INTEGER, - "! The session token for this query. The session token can be used to add events - "! associated with this query to the query and event log.- "! Training query to add.
- begin of T_NEW_TRAINING_QUERY, - "! The natural text query for the new training query. - NATURAL_LANGUAGE_QUERY type STRING, - "! The filter used on the collection before the **natural_language_query** is - "! applied. - FILTER type STRING, - "! Array of training examples. - EXAMPLES type STANDARD TABLE OF T_TRAINING_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, - end of T_NEW_TRAINING_QUERY. - types: - "!- "! Status information about a submitted document.
- begin of T_DOCUMENT_STATUS, - "! The unique identifier of the document. - DOCUMENT_ID type STRING, - "! The unique identifier for the configuration. - CONFIGURATION_ID type STRING, - "! Status of the document in the ingestion process. - STATUS type STRING, - "! Description of the document status. - STATUS_DESCRIPTION type STRING, - "! Name of the original source file (if available). - FILENAME type STRING, - "! The type of the original source file. - FILE_TYPE type STRING, - "! The SHA-1 hash of the original source file (formatted as a hexadecimal string). - SHA1 type STRING, - "! Array of notices produced by the document-ingestion process. - NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, - end of T_DOCUMENT_STATUS. - types: - "!- "! Object that describes a long query.
- begin of T_FED_QUERY_LARGE, - "! A cacheable query that excludes documents that don't mention the query - "! content. Filter searches are better for metadata-type searches and for - "! assessing the concepts in the data set. - FILTER type STRING, - "! A query search returns all documents in your data set with full enrichments and - "! full text, but with the most relevant documents listed first. Use a query - "! search when you want to find the most relevant search results. - QUERY type STRING, - "! A natural language query that returns relevant documents by utilizing training - "! data and natural language understanding. - NATURAL_LANGUAGE_QUERY type STRING, - "! A passages query that returns the most relevant passages from the results. - PASSAGES type BOOLEAN, - "! An aggregation search that returns an exact answer by combining query search - "! with filters. Useful for applications to build lists, tables, and time series. - "! For a full list of possible aggregations, see the Query reference. - AGGREGATION type STRING, - "! Number of results to return. - COUNT type INTEGER, - "! A comma-separated list of the portion of the document hierarchy to return. - RETURN type STRING, - "! The number of query results to skip at the beginning. For example, if the total - "! number of results that are returned is 10 and the offset is 8, it returns the - "! last two results. - OFFSET type INTEGER, - "! A comma-separated list of fields in the document to sort on. You can optionally - "! specify a sort direction by prefixing the field with `-` for descending or `+` - "! for ascending. Ascending is the default sort direction if no prefix is - "! specified. This parameter cannot be used in the same query as the **bias** - "! parameter. - SORT type STRING, - "! When true, a highlight field is returned for each result which contains the - "! fields which match the query with `<em></em>` tags around the - "! matching query terms. - HIGHLIGHT type BOOLEAN, - "! A comma-separated list of fields that passages are drawn from. If this parameter - "! not specified, then all top-level fields are included. - PASSAGES_FIELDS type STRING, - "! The maximum number of passages to return. The search returns fewer passages if - "! the requested total is not found. The default is `10`. The maximum is `100`. - PASSAGES_COUNT type INTEGER, - "! The approximate number of characters that any one passage will have. - PASSAGES_CHARACTERS type INTEGER, - "! When `true`, and used with a Watson Discovery News collection, duplicate results - "! (based on the contents of the **title** field) are removed. Duplicate - "! comparison is limited to the current query only; **offset** is not considered. - "! This parameter is currently Beta functionality. - DEDUPLICATE type BOOLEAN, - "! When specified, duplicate results based on the field specified are removed from - "! the returned results. Duplicate comparison is limited to the current query - "! only, **offset** is not considered. This parameter is currently Beta - "! functionality. - DEDUPLICATE_FIELD type STRING, - "! When `true`, results are returned based on their similarity to the document IDs - "! specified in the **similar.document_ids** parameter. - SIMILAR type BOOLEAN, - "! A comma-separated list of document IDs to find similar documents.- "! An error response object.
- begin of T_ERROR_RESPONSE, - "! The HTTP error status code. - CODE type INTEGER, - "! A message describing the error. - ERROR type STRING, - end of T_ERROR_RESPONSE. - types: - "!- "! An expansion definition. Each object respresents one set of
- "! expandable strings. For example, you could have expansions for the word `hot` - "! in one object, and expansions for the word `cold` in another. - begin of T_EXPANSION, - "! A list of terms that will be expanded for this expansion. If specified, only the - "! items in this list are expanded. - INPUT_TERMS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! A list of terms that this expansion will be expanded to. If specified without - "! **input_terms**, it also functions as the input term list. - EXPANDED_TERMS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - end of T_EXPANSION. - types: - "!- "! The query expansion definitions for the specified
- "! collection. - begin of T_EXPANSIONS, - "! An array of query expansion definitions.- "! An object defining the event being created.
- begin of T_CREATE_EVENT_RESPONSE, - "! The event type that was created. - TYPE type STRING, - "! Query event data object. - DATA type T_EVENT_DATA, - end of T_CREATE_EVENT_RESPONSE. - types: - "!- "! An array of document enrichment settings for the
- "! configuration. - T_ENRICHMENTS type STANDARD TABLE OF T_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! The response generated from a call to a **metrics** method
- "! that evaluates tokens. - begin of T_METRIC_TOKEN_RESPONSE, - "! Array of metric token aggregations. - AGGREGATIONS type STANDARD TABLE OF T_METRIC_TOKEN_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, - end of T_METRIC_TOKEN_RESPONSE. - types: - "!- "! Object containing an array of training examples.
- begin of T_TRAINING_EXAMPLE_LIST, - "! Array of training examples. - EXAMPLES type STANDARD TABLE OF T_TRAINING_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAINING_EXAMPLE_LIST. - types: - "!- "! Information returned when a document is deleted.
- begin of T_DELETE_DOCUMENT_RESPONSE, - "! The unique identifier of the document. - DOCUMENT_ID type STRING, - "! Status of the document. A deleted document has the status deleted. - STATUS type STRING, - end of T_DELETE_DOCUMENT_RESPONSE. - types: - "! No documentation available. - begin of T_TOP_HITS, - "! Number of top hits returned by the aggregation. - SIZE type INTEGER, - "! No documentation available. - HITS type T_TOP_HITS_RESULTS, - end of T_TOP_HITS. - types: - "!- "! Individual result object for a **logs** query. Each object
- "! represents either a query to a Discovery collection or an event that is - "! associated with a query. - begin of T_LOG_QUERY_RESPONSE_RESULT, - "! The environment ID that is associated with this log entry. - ENVIRONMENT_ID type STRING, - "! The **customer_id** label that was specified in the header of the query or event - "! API call that corresponds to this log entry. - CUSTOMER_ID type STRING, - "! The type of log entry returned.- "! Object containing results that match the requested **logs**
- "! query. - begin of T_LOG_QUERY_RESPONSE, - "! Number of matching results. - MATCHING_RESULTS type INTEGER, - "! Array of log query response results. - RESULTS type STANDARD TABLE OF T_LOG_QUERY_RESPONSE_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_LOG_QUERY_RESPONSE. - types: - "!- "! Defines operations that can be used to transform the final
- "! output JSON into a normalized form. Operations are executed in the order that - "! they appear in the array. - T_NORMALIZATIONS type STANDARD TABLE OF T_NORMALIZATION_OPERATION WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! Training example to add.
- begin of T_TRAINING_EXAMPLE_PATCH, - "! The example to add. - CROSS_REFERENCE type STRING, - "! The relevance value for this example. - RELEVANCE type INTEGER, - end of T_TRAINING_EXAMPLE_PATCH. - types: - "!- "! Response object containing an array of collection details.
- begin of T_LIST_COLLECTIONS_RESPONSE, - "! An array containing information about each collection in the environment. - COLLECTIONS type STANDARD TABLE OF T_COLLECTION WITH NON-UNIQUE DEFAULT KEY, - end of T_LIST_COLLECTIONS_RESPONSE. - types: - "! No documentation available. - begin of T_CALCULATION, - "! The field where the aggregation is located in the document. - FIELD type STRING, - "! Value of the aggregation. - VALUE type DOUBLE, - end of T_CALCULATION. - types: - "!- "! Training information for a specific collection.
- begin of T_TRAINING_DATA_SET, - "! The environment id associated with this training data set. - ENVIRONMENT_ID type STRING, - "! The collection id associated with this training data set. - COLLECTION_ID type STRING, - "! Array of training queries. - QUERIES type STANDARD TABLE OF T_TRAINING_QUERY WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAINING_DATA_SET. - types: - "!- "! Array of font matching configurations.
- T_FONT_SETTINGS type STANDARD TABLE OF T_FONT_SETTING WITH NON-UNIQUE DEFAULT KEY. - types: - "!- "! Object containing notice query results.
- begin of T_QUERY_NOTICES_RESPONSE, - "! The number of matching results. - MATCHING_RESULTS type INTEGER, - "! Array of document results that match the query. - RESULTS type STANDARD TABLE OF T_QUERY_NOTICES_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! Array of aggregation results that match the query. - AGGREGATIONS type STANDARD TABLE OF T_QUERY_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, - "! Array of passage results that match the query. - PASSAGES type STANDARD TABLE OF T_QUERY_PASSAGES WITH NON-UNIQUE DEFAULT KEY, - "! The number of duplicates removed from this notices query. - DUPLICATES_REMOVED type INTEGER, - end of T_QUERY_NOTICES_RESPONSE. - types: - "! No documentation available. - begin of T_HISTOGRAM, - "! The field where the aggregation is located in the document. - FIELD type STRING, - "! Interval of the aggregation. (For 'histogram' type). - INTERVAL type INTEGER, - end of T_HISTOGRAM. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_QUERY_AGGREGATION type string value '|', - T_AGGREGATION_RESULT type string value '|', - T_TRAINING_STATUS type string value '|', - T_TOKEN_DICT_STATUS_RESPONSE type string value '|', - T_NLU_ENRICHMENT_RELATIONS type string value '|', - T_NLU_ENRICHMENT_SENTIMENT type string value '|', - T_NL_ENRICHMENT_SEMANTIC_ROLES type string value '|', - T_NLU_ENRICHMENT_ENTITIES type string value '|', - T_NLU_ENRICHMENT_EMOTION type string value '|', - T_NLU_ENRICHMENT_CONCEPTS type string value '|', - T_NLU_ENRICHMENT_KEYWORDS type string value '|', - T_NLU_ENRICHMENT_FEATURES type string value '|', - T_NLU_ENRICHMENT_OPTIONS type string value '|', - T_TOKEN_DICT_RULE type string value '|TEXT|TOKENS|PART_OF_SPEECH|', - T_TOKEN_DICT type string value '|', - T_FILTER type string value '|', - T_SOURCE_OPTIONS_WEB_CRAWL type string value '|URL|', - T_CREDENTIAL_DETAILS type string value '|', - T_CREDENTIALS type string value '|', - T_CREDENTIALS_LIST type string value '|', - T_COLLECTION_USAGE type string value '|', - T_DISK_USAGE type string value '|', - T_ENVIRONMENT_DOCUMENTS type string value '|', - T_INDEX_CAPACITY type string value '|', - T_SEARCH_STATUS type string value '|', - T_ENVIRONMENT type string value '|', - T_LIST_ENVIRONMENTS_RESPONSE type string value '|', - T_GATEWAY_DELETE type string value '|', - T_TRAINING_EXAMPLE type string value '|', - T_TRAINING_QUERY type string value '|', - T_QUERY_PASSAGES type string value '|', - T_NORMALIZATION_OPERATION type string value '|', - T_FONT_SETTING type string value '|', - T_WORD_STYLE type string value '|', - T_WORD_HEADING_DETECTION type string value '|', - T_PDF_HEADING_DETECTION type string value '|', - T_PDF_SETTINGS type string value '|', - T_SOURCE_OPTIONS_FOLDER type string value '|OWNER_USER_ID|FOLDER_ID|', - T_SOURCE_OPTIONS_BUCKETS type string value '|NAME|', - T_SOURCE_SCHEDULE type string value '|', - T_SOURCE_OPTIONS_OBJECT type string value '|NAME|', - T_SOURCE_OPTIONS_SITE_COLL type string value '|SITE_COLLECTION_PATH1|', - T_SOURCE_OPTIONS type string value '|', - T_SOURCE type string value '|', - T_XPATH_PATTERNS type string value '|', - T_ENRICHMENT_OPTIONS type string value '|', - T_ENRICHMENT type string value '|DESTINATION_FIELD|SOURCE_FIELD|ENRICHMENT|', - T_SEGMENT_SETTINGS type string value '|', - T_WORD_SETTINGS type string value '|', - T_HTML_SETTINGS type string value '|', - T_CONVERSIONS type string value '|', - T_CONFIGURATION type string value '|NAME|', - T_LIST_CONFIGURATIONS_RESPONSE type string value '|', - T_SOURCE_STATUS type string value '|', - T_DELETE_CREDENTIALS type string value '|', - T_NOTICE type string value '|', - T_DOCUMENT_ACCEPTED type string value '|', - T_GATEWAY type string value '|', - T_METRIC_AGGREGATION_RESULT type string value '|', - T_METRIC_AGGREGATION type string value '|', - T_METRIC_RESPONSE type string value '|', - T_QUERY_RESULT_METADATA type string value '|SCORE|', - T_QUERY_NOTICES_RESULT type string value '|', - T_LOG_QRY_RESP_RSLT_DOCS_RSLT type string value '|', - T_LOG_QUERY_RESP_RESULT_DOCS type string value '|', - T_FIELD type string value '|', - T_EVENT_DATA type string value '|ENVIRONMENT_ID|SESSION_TOKEN|COLLECTION_ID|DOCUMENT_ID|', - T_CREATE_EVENT_OBJECT type string value '|TYPE|DATA|', - T_NESTED type string value '|', - T_QUERY_LARGE type string value '|', - T_GATEWAY_NAME type string value '|', - T_DOCUMENT_COUNTS type string value '|', - T_SDU_STATUS_CUSTOM_FIELDS type string value '|', - T_SDU_STATUS type string value '|', - T_COLLECTION_CRAWL_STATUS type string value '|', - T_COLLECTION_DISK_USAGE type string value '|', - T_COLLECTION type string value '|', - T_ELEMENTS_ENRICHMENT_OPTIONS type string value '|', - T_CREATE_ENVIRONMENT_REQUEST type string value '|NAME|', - T_CREATE_COLLECTION_REQUEST type string value '|NAME|', - T_INLINE_OBJECT type string value '|STOPWORD_FILE|', - T_QUERY_RESULT type string value '|', - T_TOP_HITS_RESULTS type string value '|', - T_DELETE_COLLECTION_RESPONSE type string value '|COLLECTION_ID|STATUS|', - T_TERM type string value '|', - T_COMPLETIONS type string value '|', - T_RETRIEVAL_DETAILS type string value '|', - T_DELETE_ENVIRONMENT_RESPONSE type string value '|ENVIRONMENT_ID|STATUS|', - T_LST_COLLECTION_FIELDS_RESP type string value '|', - T_UPDATE_COLLECTION_REQUEST type string value '|NAME|', - T_GATEWAY_LIST type string value '|', - T_METRIC_TOKEN_AGGR_RESULT type string value '|', - T_METRIC_TOKEN_AGGREGATION type string value '|', - T_COLL_QUERY_LARGE type string value '|', - T_UPDATE_ENVIRONMENT_REQUEST type string value '|', - T_DEL_CONFIGURATION_RESPONSE type string value '|CONFIGURATION_ID|STATUS|', - T_QUERY_RESPONSE type string value '|', - T_TIMESLICE type string value '|', - T_NEW_TRAINING_QUERY type string value '|', - T_DOCUMENT_STATUS type string value '|DOCUMENT_ID|STATUS|STATUS_DESCRIPTION|NOTICES|', - T_FED_QUERY_LARGE type string value '|COLLECTION_IDS|', - T_ERROR_RESPONSE type string value '|CODE|ERROR|', - T_EXPANSION type string value '|EXPANDED_TERMS|', - T_EXPANSIONS type string value '|EXPANSIONS|', - T_CREATE_EVENT_RESPONSE type string value '|', - T_METRIC_TOKEN_RESPONSE type string value '|', - T_TRAINING_EXAMPLE_LIST type string value '|', - T_DELETE_DOCUMENT_RESPONSE type string value '|', - T_TOP_HITS type string value '|', - T_LOG_QUERY_RESPONSE_RESULT type string value '|', - T_LOG_QUERY_RESPONSE type string value '|', - T_TRAINING_EXAMPLE_PATCH type string value '|', - T_LIST_COLLECTIONS_RESPONSE type string value '|', - T_CALCULATION type string value '|', - T_TRAINING_DATA_SET type string value '|', - T_QUERY_NOTICES_RESPONSE type string value '|', - T_HISTOGRAM type string value '|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - ENVIRONMENT_ID type string value 'environment_id', - NAME type string value 'name', - DESCRIPTION type string value 'description', - CREATED type string value 'created', - UPDATED type string value 'updated', - STATUS type string value 'status', - READ_ONLY type string value 'read_only', - SIZE type string value 'size', - REQUESTED_SIZE type string value 'requested_size', - INDEX_CAPACITY type string value 'index_capacity', - SEARCH_STATUS type string value 'search_status', - DOCUMENTS type string value 'documents', - DISK_USAGE type string value 'disk_usage', - COLLECTIONS type string value 'collections', - USED_BYTES type string value 'used_bytes', - MAXIMUM_ALLOWED_BYTES type string value 'maximum_allowed_bytes', - AVAILABLE type string value 'available', - MAXIMUM_ALLOWED type string value 'maximum_allowed', - ENVIRONMENTS type string value 'environments', - CONFIGURATION_ID type string value 'configuration_id', - LANGUAGE type string value 'language', - COLLECTION_ID type string value 'collection_id', - DOCUMENT_COUNTS type string value 'document_counts', - TRAINING_STATUS type string value 'training_status', - CRAWL_STATUS type string value 'crawl_status', - SMART_DOCUMENT_UNDERSTANDING type string value 'smart_document_understanding', - PROCESSING type string value 'processing', - FAILED type string value 'failed', - PENDING type string value 'pending', - CONVERSIONS type string value 'conversions', - ENRICHMENTS type string value 'enrichments', - ENRICHMENT type string value 'enrichment', - NORMALIZATIONS type string value 'normalizations', - NORMALIZATION type string value 'normalization', - SOURCE type string value 'source', - PDF type string value 'pdf', - WORD type string value 'word', - HTML type string value 'html', - SEGMENT type string value 'segment', - JSON_NORMALIZATIONS type string value 'json_normalizations', - IMAGE_TEXT_RECOGNITION type string value 'image_text_recognition', - HEADING type string value 'heading', - FONTS type string value 'fonts', - FONT_SETTING type string value 'font_setting', - STYLES type string value 'styles', - WORD_STYLE type string value 'word_style', - LEVEL type string value 'level', - NAMES type string value 'names', - EXCLUDE_TAGS_COMPLETELY type string value 'exclude_tags_completely', - EXCLUDE_TAGS_KEEP_CONTENT type string value 'exclude_tags_keep_content', - KEEP_CONTENT type string value 'keep_content', - EXCLUDE_CONTENT type string value 'exclude_content', - KEEP_TAG_ATTRIBUTES type string value 'keep_tag_attributes', - EXCLUDE_TAG_ATTRIBUTES type string value 'exclude_tag_attributes', - ENABLED type string value 'enabled', - SELECTOR_TAGS type string value 'selector_tags', - ANNOTATED_FIELDS type string value 'annotated_fields', - XPATHS type string value 'xpaths', - MIN_SIZE type string value 'min_size', - MAX_SIZE type string value 'max_size', - BOLD type string value 'bold', - ITALIC type string value 'italic', - DESTINATION_FIELD type string value 'destination_field', - SOURCE_FIELD type string value 'source_field', - OVERWRITE type string value 'overwrite', - IGNORE_DOWNSTREAM_ERRORS type string value 'ignore_downstream_errors', - OPTIONS type string value 'options', - FEATURES type string value 'features', - MODEL type string value 'model', - OPERATION type string value 'operation', - CONFIGURATIONS type string value 'configurations', - NOTICES type string value 'notices', - DOCUMENT_ID type string value 'document_id', - STATUS_DESCRIPTION type string value 'status_description', - FILENAME type string value 'filename', - FILE_TYPE type string value 'file_type', - SHA1 type string value 'sha1', - FIELDS type string value 'fields', - FIELD type string value 'field', - TYPE type string value 'type', - MATCHING_RESULTS type string value 'matching_results', - RESULTS type string value 'results', - AGGREGATIONS type string value 'aggregations', - PASSAGES type string value 'passages', - DUPLICATES_REMOVED type string value 'duplicates_removed', - SESSION_TOKEN type string value 'session_token', - RETRIEVAL_DETAILS type string value 'retrieval_details', - SUGGESTED_QUERY type string value 'suggested_query', - ID type string value 'id', - METADATA type string value 'metadata', - INNER type string value 'inner', - RESULT_METADATA type string value 'result_metadata', - SCORE type string value 'score', - CONFIDENCE type string value 'confidence', - CODE type string value 'code', - KEY type string value 'key', - INTERVAL type string value 'interval', - VALUE type string value 'value', - COUNT type string value 'count', - MATCH type string value 'match', - PATH type string value 'path', - ANOMALY type string value 'anomaly', - HITS type string value 'hits', - TOTAL_EXAMPLES type string value 'total_examples', - MINIMUM_QUERIES_ADDED type string value 'minimum_queries_added', - MINIMUM_EXAMPLES_ADDED type string value 'minimum_examples_added', - SUFFICIENT_LABEL_DIVERSITY type string value 'sufficient_label_diversity', - SUCCESSFULLY_TRAINED type string value 'successfully_trained', - DATA_UPDATED type string value 'data_updated', - QUERIES type string value 'queries', - QUERY_ID type string value 'query_id', - NATURAL_LANGUAGE_QUERY type string value 'natural_language_query', - FILTER type string value 'filter', - EXAMPLES type string value 'examples', - CROSS_REFERENCE type string value 'cross_reference', - RELEVANCE type string value 'relevance', - NOTICE_ID type string value 'notice_id', - SEVERITY type string value 'severity', - STEP type string value 'step', - ERROR type string value 'error', - PASSAGE_SCORE type string value 'passage_score', - PASSAGE_TEXT type string value 'passage_text', - START_OFFSET type string value 'start_offset', - END_OFFSET type string value 'end_offset', - KEYWORDS type string value 'keywords', - ENTITIES type string value 'entities', - SENTIMENT type string value 'sentiment', - EMOTION type string value 'emotion', - CATEGORIES type string value 'categories', - SEMANTIC_ROLES type string value 'semantic_roles', - RELATIONS type string value 'relations', - CONCEPTS type string value 'concepts', - LIMIT type string value 'limit', - MENTIONS type string value 'mentions', - MENTION_TYPES type string value 'mention_types', - SENTENCE_LOCATIONS type string value 'sentence_locations', - DOCUMENT type string value 'document', - TARGETS type string value 'targets', - TARGET type string value 'target', - EXPANSIONS type string value 'expansions', - INPUT_TERMS type string value 'input_terms', - EXPANDED_TERMS type string value 'expanded_terms', - DATA type string value 'data', - CLIENT_TIMESTAMP type string value 'client_timestamp', - DISPLAY_RANK type string value 'display_rank', - EVENT_TYPE type string value 'event_type', - KEY_AS_STRING type string value 'key_as_string', - EVENT_RATE type string value 'event_rate', - CUSTOMER_ID type string value 'customer_id', - DOCUMENT_TYPE type string value 'document_type', - DOCUMENT_RESULTS type string value 'document_results', - CREATED_TIMESTAMP type string value 'created_timestamp', - RESULT_TYPE type string value 'result_type', - POSITION type string value 'position', - CREDENTIALS type string value 'credentials', - CREDENTIAL_ID type string value 'credential_id', - SOURCE_TYPE type string value 'source_type', - CREDENTIAL_DETAILS type string value 'credential_details', - CREDENTIAL_TYPE type string value 'credential_type', - CLIENT_ID type string value 'client_id', - ENTERPRISE_ID type string value 'enterprise_id', - URL type string value 'url', - USERNAME type string value 'username', - ORGANIZATION_URL type string value 'organization_url', - SITE_COLLECTION_PATH type string value 'site_collection.path', - CLIENT_SECRET type string value 'client_secret', - PUBLIC_KEY_ID type string value 'public_key_id', - PRIVATE_KEY type string value 'private_key', - PASSPHRASE type string value 'passphrase', - PASSWORD type string value 'password', - GATEWAY_ID type string value 'gateway_id', - SOURCE_VERSION type string value 'source_version', - WEB_APPLICATION_URL type string value 'web_application_url', - DOMAIN type string value 'domain', - ENDPOINT type string value 'endpoint', - ACCESS_KEY_ID type string value 'access_key_id', - SECRET_ACCESS_KEY type string value 'secret_access_key', - NEXT_CRAWL type string value 'next_crawl', - SCHEDULE type string value 'schedule', - TIME_ZONE type string value 'time_zone', - FREQUENCY type string value 'frequency', - FOLDERS type string value 'folders', - OBJECTS type string value 'objects', - SITE_COLLECTIONS type string value 'site_collections', - URLS type string value 'urls', - BUCKETS type string value 'buckets', - CRAWL_ALL_BUCKETS type string value 'crawl_all_buckets', - OWNER_USER_ID type string value 'owner_user_id', - FOLDER_ID type string value 'folder_id', - SITE_COLLECTION_PATH1 type string value 'site_collection_path', - SCOPE type string value 'scope', - LAST_TRAINED type string value 'last_trained', - QUERY type string value 'query', - AGGREGATION type string value 'aggregation', - RETURN type string value 'return', - OFFSET type string value 'offset', - SORT type string value 'sort', - HIGHLIGHT type string value 'highlight', - PASSAGES_FIELDS type string value 'passages.fields', - PASSAGES_COUNT type string value 'passages.count', - PASSAGES_CHARACTERS type string value 'passages.characters', - DEDUPLICATE type string value 'deduplicate', - DEDUPLICATE_FIELD type string value 'deduplicate.field', - SIMILAR type string value 'similar', - SIMILAR_DOCUMENT_IDS type string value 'similar.document_ids', - SIMILAR_FIELDS type string value 'similar.fields', - BIAS type string value 'bias', - TOKENIZATION_RULES type string value 'tokenization_rules', - TEXT type string value 'text', - TOKENS type string value 'tokens', - READINGS type string value 'readings', - PART_OF_SPEECH type string value 'part_of_speech', - DOCUMENT_RETRIEVAL_STRATEGY type string value 'document_retrieval_strategy', - LIMIT_TO_STARTING_HOSTS type string value 'limit_to_starting_hosts', - CRAWL_SPEED type string value 'crawl_speed', - ALLOW_UNTRUSTED_CERTIFICATE type string value 'allow_untrusted_certificate', - MAXIMUM_HOPS type string value 'maximum_hops', - REQUEST_TIMEOUT type string value 'request_timeout', - OVERRIDE_ROBOTS_TXT type string value 'override_robots_txt', - BLACKLIST type string value 'blacklist', - GATEWAYS type string value 'gateways', - TOKEN type string value 'token', - TOKEN_ID type string value 'token_id', - TOTAL_ANNOTATED_PAGES type string value 'total_annotated_pages', - TOTAL_PAGES type string value 'total_pages', - TOTAL_DOCUMENTS type string value 'total_documents', - CUSTOM_FIELDS type string value 'custom_fields', - COMPLETIONS type string value 'completions', - COLLECTION_IDS type string value 'collection_ids', - SPELLING_SUGGESTIONS type string value 'spelling_suggestions', - DEFINED type string value 'defined', - SOURCE_CRAWL type string value 'source_crawl', - STOPWORD_FILE type string value 'stopword_file', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Create an environment
- "! Creates a new environment for private data. An environment must be created - "! before collections can be created.List environments
- "! List existing environments for the service instance. - "! - "! @parameter I_NAME | - "! Show only the environment with the given name. - "! @parameter E_RESPONSE | - "! Service return value of type T_LIST_ENVIRONMENTS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_ENVIRONMENTS - importing - !I_NAME type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_LIST_ENVIRONMENTS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get environment info
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter E_RESPONSE | - "! Service return value of type T_ENVIRONMENT - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_ENVIRONMENT - importing - !I_ENVIRONMENT_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_ENVIRONMENT - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update an environment
- "! Updates an environment. The environment's **name** and **description** - "! parameters can be changed. You must specify a **name** for the environment. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_BODY | - "! An object that defines the environment's name and, optionally, description. - "! - "! @parameter E_RESPONSE | - "! Service return value of type T_ENVIRONMENT - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods UPDATE_ENVIRONMENT - importing - !I_ENVIRONMENT_ID type STRING - !I_BODY type T_UPDATE_ENVIRONMENT_REQUEST - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_ENVIRONMENT - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete environment
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter E_RESPONSE | - "! Service return value of type T_DELETE_ENVIRONMENT_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_ENVIRONMENT - importing - !I_ENVIRONMENT_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_DELETE_ENVIRONMENT_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!List fields across collections
- "! Gets a list of the unique fields (and their types) stored in the indexes of the - "! specified collections. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_IDS | - "! A comma-separated list of collection IDs to be queried against. - "! @parameter E_RESPONSE | - "! Service return value of type T_LST_COLLECTION_FIELDS_RESP - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_FIELDS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_IDS type TT_STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_LST_COLLECTION_FIELDS_RESP - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Add configuration
- "! Creates a new configuration.List configurations
- "! Lists existing configurations for the service instance. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_NAME | - "! Find configurations with the given name. - "! @parameter E_RESPONSE | - "! Service return value of type T_LIST_CONFIGURATIONS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_CONFIGURATIONS - importing - !I_ENVIRONMENT_ID type STRING - !I_NAME type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_LIST_CONFIGURATIONS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get configuration details
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_CONFIGURATION_ID | - "! The ID of the configuration. - "! @parameter E_RESPONSE | - "! Service return value of type T_CONFIGURATION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_CONFIGURATION - importing - !I_ENVIRONMENT_ID type STRING - !I_CONFIGURATION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CONFIGURATION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update a configuration
- "! Replaces an existing configuration.Delete a configuration
- "! The deletion is performed unconditionally. A configuration deletion request - "! succeeds even if the configuration is referenced by a collection or document - "! ingestion. However, documents that have already been submitted for processing - "! continue to use the deleted configuration. Documents are always processed with - "! a snapshot of the configuration as it existed at the time the document was - "! submitted. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_CONFIGURATION_ID | - "! The ID of the configuration. - "! @parameter E_RESPONSE | - "! Service return value of type T_DEL_CONFIGURATION_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_CONFIGURATION - importing - !I_ENVIRONMENT_ID type STRING - !I_CONFIGURATION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_DEL_CONFIGURATION_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Create a collection
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_BODY | - "! Input an object that allows you to add a collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_COLLECTION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CREATE_COLLECTION - importing - !I_ENVIRONMENT_ID type STRING - !I_BODY type T_CREATE_COLLECTION_REQUEST - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COLLECTION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!List collections
- "! Lists existing collections for the service instance. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_NAME | - "! Find collections with the given name. - "! @parameter E_RESPONSE | - "! Service return value of type T_LIST_COLLECTIONS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_COLLECTIONS - importing - !I_ENVIRONMENT_ID type STRING - !I_NAME type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_LIST_COLLECTIONS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get collection details
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_COLLECTION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_COLLECTION - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COLLECTION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update a collection
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_BODY | - "! Input an object that allows you to update a collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_COLLECTION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods UPDATE_COLLECTION - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_BODY type T_UPDATE_COLLECTION_REQUEST - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COLLECTION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete a collection
- "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_DELETE_COLLECTION_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_COLLECTION - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_DELETE_COLLECTION_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!List collection fields
- "! Gets a list of the unique fields (and their types) stored in the index. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_LST_COLLECTION_FIELDS_RESP - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_COLLECTION_FIELDS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_LST_COLLECTION_FIELDS_RESP - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Get the expansion list
- "! Returns the current expansion list for the specified collection. If an expansion - "! list is not specified, an object with empty expansion arrays is returned. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_EXPANSIONS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_EXPANSIONS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_EXPANSIONS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Create or update expansion list
- "! Create or replace the Expansion list for this collection. The maximum number of - "! expanded terms per collection is `500`.Delete the expansion list
- "! Remove the expansion information for this collection. The expansion list must be - "! deleted to disable query expansion for a collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_EXPANSIONS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get tokenization dictionary status
- "! Returns the current status of the tokenization dictionary for the specified - "! collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_TOKEN_DICT_STATUS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_TOKENIZATION_DICT_STATUS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Create tokenization dictionary
- "! Upload a custom tokenization dictionary to use with the specified collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_TOKENIZATION_DICTIONARY | - "! An object that represents the tokenization dictionary to be uploaded. - "! @parameter E_RESPONSE | - "! Service return value of type T_TOKEN_DICT_STATUS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CREATE_TOKENIZATION_DICTIONARY - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_TOKENIZATION_DICTIONARY type T_TOKEN_DICT optional - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete tokenization dictionary
- "! Delete the tokenization dictionary from the collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_TOKENIZATION_DICTIONARY - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get stopword list status
- "! Returns the current status of the stopword list for the specified collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_TOKEN_DICT_STATUS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_STOPWORD_LIST_STATUS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Create stopword list
- "! Upload a custom stopword list to use with the specified collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_STOPWORD_FILE | - "! The content of the stopword list to ingest. - "! @parameter I_STOPWORD_FILENAME | - "! The filename for stopwordFile. - "! @parameter E_RESPONSE | - "! Service return value of type T_TOKEN_DICT_STATUS_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CREATE_STOPWORD_LIST - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_STOPWORD_FILE type FILE - !I_STOPWORD_FILENAME type STRING - !I_STOPWORD_FILE_CT type STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL - !I_contenttype type string default 'multipart/form-data' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete a custom stopword list
- "! Delete a custom stopword list from the collection. After a custom stopword list - "! is deleted, the default list is used for the collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_STOPWORD_LIST - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Add a document
- "! Add a document to a collection with optional metadata.Get document details
- "! Fetch status details about a submitted document. **Note:** this operation does - "! not return the document itself. Instead, it returns only the document's - "! processing status and any notices (warnings or errors) that were generated when - "! the document was ingested. Use the query API to retrieve the actual document - "! content. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_DOCUMENT_ID | - "! The ID of the document. - "! @parameter E_RESPONSE | - "! Service return value of type T_DOCUMENT_STATUS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_DOCUMENT_STATUS - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_DOCUMENT_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_DOCUMENT_STATUS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update a document
- "! Replace an existing document or add a document with a specified **document_id**. - "! Starts ingesting a document with optional metadata.Delete a document
- "! If the given document ID is invalid, or if the document is not found, then the a - "! success response is returned (HTTP status code `200`) with the status set to - "! 'deleted'. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_DOCUMENT_ID | - "! The ID of the document. - "! @parameter E_RESPONSE | - "! Service return value of type T_DELETE_DOCUMENT_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_DOCUMENT - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_DOCUMENT_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_DELETE_DOCUMENT_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Query a collection
- "! By using this method, you can construct long queries. For details, see the - "! [Discovery - "! documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-conce - "! pts#query-concepts). - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_LONG | - "! An object that represents the query to be submitted. - "! @parameter I_X_WATSON_LOGGING_OPT_OUT | - "! If `true`, queries are not stored in the Discovery **Logs** endpoint. - "! @parameter E_RESPONSE | - "! Service return value of type T_QUERY_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods QUERY - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_LONG type T_COLL_QUERY_LARGE optional - !I_X_WATSON_LOGGING_OPT_OUT type BOOLEAN default c_boolean_false - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_QUERY_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Query system notices
- "! Queries for notices (errors or warnings) that might have been generated by the - "! system. Notices are generated when ingesting documents and performing relevance - "! training. See the [Discovery - "! documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-conce - "! pts#query-concepts) for more details on the query language. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_FILTER | - "! A cacheable query that excludes documents that don't mention the query - "! content. Filter searches are better for metadata-type searches and for - "! assessing the concepts in the data set. - "! @parameter I_QUERY | - "! A query search returns all documents in your data set with full enrichments and - "! full text, but with the most relevant documents listed first. - "! @parameter I_NATURAL_LANGUAGE_QUERY | - "! A natural language query that returns relevant documents by utilizing training - "! data and natural language understanding. - "! @parameter I_PASSAGES | - "! A passages query that returns the most relevant passages from the results. - "! @parameter I_AGGREGATION | - "! An aggregation search that returns an exact answer by combining query search - "! with filters. Useful for applications to build lists, tables, and time series. - "! For a full list of possible aggregations, see the Query reference. - "! @parameter I_COUNT | - "! Number of results to return. The maximum for the **count** and **offset** values - "! together in any one query is **10000**. - "! @parameter I_RETURN | - "! A comma-separated list of the portion of the document hierarchy to return. - "! @parameter I_OFFSET | - "! The number of query results to skip at the beginning. For example, if the total - "! number of results that are returned is 10 and the offset is 8, it returns the - "! last two results. The maximum for the **count** and **offset** values together - "! in any one query is **10000**. - "! @parameter I_SORT | - "! A comma-separated list of fields in the document to sort on. You can optionally - "! specify a sort direction by prefixing the field with `-` for descending or `+` - "! for ascending. Ascending is the default sort direction if no prefix is - "! specified. - "! @parameter I_HIGHLIGHT | - "! When true, a highlight field is returned for each result which contains the - "! fields which match the query with `<em></em>` tags around the - "! matching query terms. - "! @parameter I_PASSAGES_FIELDS | - "! A comma-separated list of fields that passages are drawn from. If this parameter - "! not specified, then all top-level fields are included. - "! @parameter I_PASSAGES_COUNT | - "! The maximum number of passages to return. The search returns fewer passages if - "! the requested total is not found. - "! @parameter I_PASSAGES_CHARACTERS | - "! The approximate number of characters that any one passage will have. - "! @parameter I_DEDUPLICATE_FIELD | - "! When specified, duplicate results based on the field specified are removed from - "! the returned results. Duplicate comparison is limited to the current query - "! only, **offset** is not considered. This parameter is currently Beta - "! functionality. - "! @parameter I_SIMILAR | - "! When `true`, results are returned based on their similarity to the document IDs - "! specified in the **similar.document_ids** parameter. - "! @parameter I_SIMILAR_DOCUMENT_IDS | - "! A comma-separated list of document IDs to find similar documents.Query multiple collections
- "! By using this method, you can construct long queries that search multiple - "! collection. For details, see the [Discovery - "! documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-conce - "! pts#query-concepts). - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_QUERY_LONG | - "! No documentation available. - "! @parameter I_X_WATSON_LOGGING_OPT_OUT | - "! If `true`, queries are not stored in the Discovery **Logs** endpoint. - "! @parameter E_RESPONSE | - "! Service return value of type T_QUERY_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods FEDERATED_QUERY - importing - !I_ENVIRONMENT_ID type STRING - !I_QUERY_LONG type T_FED_QUERY_LARGE - !I_X_WATSON_LOGGING_OPT_OUT type BOOLEAN default c_boolean_false - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_QUERY_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Query multiple collection system notices
- "! Queries for notices (errors or warnings) that might have been generated by the - "! system. Notices are generated when ingesting documents and performing relevance - "! training. See the [Discovery - "! documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-conce - "! pts#query-concepts) for more details on the query language. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_IDS | - "! A comma-separated list of collection IDs to be queried against. - "! @parameter I_FILTER | - "! A cacheable query that excludes documents that don't mention the query - "! content. Filter searches are better for metadata-type searches and for - "! assessing the concepts in the data set. - "! @parameter I_QUERY | - "! A query search returns all documents in your data set with full enrichments and - "! full text, but with the most relevant documents listed first. - "! @parameter I_NATURAL_LANGUAGE_QUERY | - "! A natural language query that returns relevant documents by utilizing training - "! data and natural language understanding. - "! @parameter I_AGGREGATION | - "! An aggregation search that returns an exact answer by combining query search - "! with filters. Useful for applications to build lists, tables, and time series. - "! For a full list of possible aggregations, see the Query reference. - "! @parameter I_COUNT | - "! Number of results to return. The maximum for the **count** and **offset** values - "! together in any one query is **10000**. - "! @parameter I_RETURN | - "! A comma-separated list of the portion of the document hierarchy to return. - "! @parameter I_OFFSET | - "! The number of query results to skip at the beginning. For example, if the total - "! number of results that are returned is 10 and the offset is 8, it returns the - "! last two results. The maximum for the **count** and **offset** values together - "! in any one query is **10000**. - "! @parameter I_SORT | - "! A comma-separated list of fields in the document to sort on. You can optionally - "! specify a sort direction by prefixing the field with `-` for descending or `+` - "! for ascending. Ascending is the default sort direction if no prefix is - "! specified. - "! @parameter I_HIGHLIGHT | - "! When true, a highlight field is returned for each result which contains the - "! fields which match the query with `<em></em>` tags around the - "! matching query terms. - "! @parameter I_DEDUPLICATE_FIELD | - "! When specified, duplicate results based on the field specified are removed from - "! the returned results. Duplicate comparison is limited to the current query - "! only, **offset** is not considered. This parameter is currently Beta - "! functionality. - "! @parameter I_SIMILAR | - "! When `true`, results are returned based on their similarity to the document IDs - "! specified in the **similar.document_ids** parameter. - "! @parameter I_SIMILAR_DOCUMENT_IDS | - "! A comma-separated list of document IDs to find similar documents.Get Autocomplete Suggestions
- "! Returns completion query suggestions for the specified prefix. /n/n - "! **Important:** this method is only valid when using the Cloud Pak version of - "! Discovery. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_PREFIX | - "! The prefix to use for autocompletion. For example, the prefix `Ho` could - "! autocomplete to `Hot`, `Housing`, or `How do I upgrade`. Possible completions - "! are. - "! @parameter I_FIELD | - "! The field in the result documents that autocompletion suggestions are identified - "! from. - "! @parameter I_COUNT | - "! The number of autocompletion suggestions to return. - "! @parameter E_RESPONSE | - "! Service return value of type T_COMPLETIONS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_AUTOCOMPLETION - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_PREFIX type STRING - !I_FIELD type STRING optional - !I_COUNT type INTEGER optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COMPLETIONS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!List training data
- "! Lists the training data for the specified collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_DATA_SET - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_TRAINING_DATA - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_DATA_SET - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Add query to training data
- "! Adds a query to the training data for this collection. The query can contain a - "! filter and natural language query. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_BODY | - "! The body of the training data query that is to be added to the collection's - "! training data. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_QUERY - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods ADD_TRAINING_DATA - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_BODY type T_NEW_TRAINING_QUERY - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_QUERY - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete all training data
- "! Deletes all training data from a collection. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_ALL_TRAINING_DATA - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get details about a query
- "! Gets details for a specific training data query, including the query string and - "! all examples. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_QUERY - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_TRAINING_DATA - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_QUERY - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete a training data query
- "! Removes the training data query and all associated examples from the training - "! data set. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_TRAINING_DATA - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!List examples for a training data query
- "! List all examples for this training data query. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_EXAMPLE_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_TRAINING_EXAMPLES - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_EXAMPLE_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Add example to training data query
- "! Adds a example to this training data query. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @parameter I_BODY | - "! The body of the example that is to be added to the specified query. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_EXAMPLE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CREATE_TRAINING_EXAMPLE - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - !I_BODY type T_TRAINING_EXAMPLE - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_EXAMPLE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete example for training data query
- "! Deletes the example document with the given ID from the training data query. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @parameter I_EXAMPLE_ID | - "! The ID of the document as it is indexed. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_TRAINING_EXAMPLE - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - !I_EXAMPLE_ID type STRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Change label or cross reference for example
- "! Changes the label or cross reference query for this training data example. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @parameter I_EXAMPLE_ID | - "! The ID of the document as it is indexed. - "! @parameter I_BODY | - "! The body of the example that is to be added to the specified query. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_EXAMPLE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods UPDATE_TRAINING_EXAMPLE - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - !I_EXAMPLE_ID type STRING - !I_BODY type T_TRAINING_EXAMPLE_PATCH - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_EXAMPLE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get details for training data example
- "! Gets the details for this training example. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_COLLECTION_ID | - "! The ID of the collection. - "! @parameter I_QUERY_ID | - "! The ID of the query used for training. - "! @parameter I_EXAMPLE_ID | - "! The ID of the document as it is indexed. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_EXAMPLE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_TRAINING_EXAMPLE - importing - !I_ENVIRONMENT_ID type STRING - !I_COLLECTION_ID type STRING - !I_QUERY_ID type STRING - !I_EXAMPLE_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_EXAMPLE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Delete labeled data
- "! Deletes all data associated with a specified customer ID. The method has no - "! effect if no data is associated with the customer ID.Create event
- "! The **Events** API can be used to create log entries that are associated with - "! specific queries. For example, you can record which documents in the results - "! set were "clicked" by a user and when that click occurred. - "! - "! @parameter I_QUERY_EVENT | - "! An object that defines a query event to be added to the log. - "! @parameter E_RESPONSE | - "! Service return value of type T_CREATE_EVENT_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CREATE_EVENT - importing - !I_QUERY_EVENT type T_CREATE_EVENT_OBJECT - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CREATE_EVENT_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Search the query and event log
- "! Searches the query and event log to find query sessions that match the specified - "! criteria. Searching the **logs** endpoint uses the standard Discovery query - "! syntax for the parameters that are supported. - "! - "! @parameter I_FILTER | - "! A cacheable query that excludes documents that don't mention the query - "! content. Filter searches are better for metadata-type searches and for - "! assessing the concepts in the data set. - "! @parameter I_QUERY | - "! A query search returns all documents in your data set with full enrichments and - "! full text, but with the most relevant documents listed first. - "! @parameter I_COUNT | - "! Number of results to return. The maximum for the **count** and **offset** values - "! together in any one query is **10000**. - "! @parameter I_OFFSET | - "! The number of query results to skip at the beginning. For example, if the total - "! number of results that are returned is 10 and the offset is 8, it returns the - "! last two results. The maximum for the **count** and **offset** values together - "! in any one query is **10000**. - "! @parameter I_SORT | - "! A comma-separated list of fields in the document to sort on. You can optionally - "! specify a sort direction by prefixing the field with `-` for descending or `+` - "! for ascending. Ascending is the default sort direction if no prefix is - "! specified. - "! @parameter E_RESPONSE | - "! Service return value of type T_LOG_QUERY_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods QUERY_LOG - importing - !I_FILTER type STRING optional - !I_QUERY type STRING optional - !I_COUNT type INTEGER optional - !I_OFFSET type INTEGER optional - !I_SORT type TT_STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_LOG_QUERY_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Number of queries over time
- "! Total number of queries using the **natural_language_query** parameter over a - "! specific time window. - "! - "! @parameter I_START_TIME | - "! Metric is computed from data recorded after this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_END_TIME | - "! Metric is computed from data recorded before this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_RESULT_TYPE | - "! The type of result to consider when calculating the metric. - "! @parameter E_RESPONSE | - "! Service return value of type T_METRIC_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_METRICS_QUERY - importing - !I_START_TIME type DATETIME optional - !I_END_TIME type DATETIME optional - !I_RESULT_TYPE type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_METRIC_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Number of queries with an event over time
- "! Total number of queries using the **natural_language_query** parameter that have - "! a corresponding "click" event over a specified time window. This - "! metric requires having integrated event tracking in your application using the - "! **Events** API. - "! - "! @parameter I_START_TIME | - "! Metric is computed from data recorded after this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_END_TIME | - "! Metric is computed from data recorded before this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_RESULT_TYPE | - "! The type of result to consider when calculating the metric. - "! @parameter E_RESPONSE | - "! Service return value of type T_METRIC_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_METRICS_QUERY_EVENT - importing - !I_START_TIME type DATETIME optional - !I_END_TIME type DATETIME optional - !I_RESULT_TYPE type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_METRIC_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Number of queries with no search results over time
- "! Total number of queries using the **natural_language_query** parameter that have - "! no results returned over a specified time window. - "! - "! @parameter I_START_TIME | - "! Metric is computed from data recorded after this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_END_TIME | - "! Metric is computed from data recorded before this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_RESULT_TYPE | - "! The type of result to consider when calculating the metric. - "! @parameter E_RESPONSE | - "! Service return value of type T_METRIC_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_METRICS_QUERY_NO_RESULTS - importing - !I_START_TIME type DATETIME optional - !I_END_TIME type DATETIME optional - !I_RESULT_TYPE type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_METRIC_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Percentage of queries with an associated event
- "! The percentage of queries using the **natural_language_query** parameter that - "! have a corresponding "click" event over a specified time window. - "! This metric requires having integrated event tracking in your application using - "! the **Events** API. - "! - "! @parameter I_START_TIME | - "! Metric is computed from data recorded after this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_END_TIME | - "! Metric is computed from data recorded before this timestamp; must be in - "! `YYYY-MM-DDThh:mm:ssZ` format. - "! @parameter I_RESULT_TYPE | - "! The type of result to consider when calculating the metric. - "! @parameter E_RESPONSE | - "! Service return value of type T_METRIC_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_METRICS_EVENT_RATE - importing - !I_START_TIME type DATETIME optional - !I_END_TIME type DATETIME optional - !I_RESULT_TYPE type STRING optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_METRIC_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Most frequent query tokens with an event
- "! The most frequent query tokens parsed from the **natural_language_query** - "! parameter and their corresponding "click" event rate within the - "! recording period (queries and events are stored for 30 days). A query token is - "! an individual word or unigram within the query string. - "! - "! @parameter I_COUNT | - "! Number of results to return. The maximum for the **count** and **offset** values - "! together in any one query is **10000**. - "! @parameter E_RESPONSE | - "! Service return value of type T_METRIC_TOKEN_RESPONSE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_METRICS_QUERY_TOKEN_EVENT - importing - !I_COUNT type INTEGER optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_METRIC_TOKEN_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!List credentials
- "! List all the source credentials that have been created for this service - "! instance.Create credentials
- "! Creates a set of credentials to connect to a remote source. Created credentials - "! are used in a configuration to associate a collection with the remote - "! source.View Credentials
- "! Returns details about the specified credentials.Update credentials
- "! Updates an existing set of source credentials.Delete credentials
- "! Deletes a set of stored credentials from your Discovery instance. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_CREDENTIAL_ID | - "! The unique identifier for a set of source credentials. - "! @parameter E_RESPONSE | - "! Service return value of type T_DELETE_CREDENTIALS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_CREDENTIALS - importing - !I_ENVIRONMENT_ID type STRING - !I_CREDENTIAL_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_DELETE_CREDENTIALS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!List Gateways
- "! List the currently configured gateways. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter E_RESPONSE | - "! Service return value of type T_GATEWAY_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_GATEWAYS - importing - !I_ENVIRONMENT_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_GATEWAY_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Create Gateway
- "! Create a gateway configuration to use with a remotely installed gateway. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_GATEWAY_NAME | - "! The name of the gateway to created. - "! @parameter E_RESPONSE | - "! Service return value of type T_GATEWAY - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CREATE_GATEWAY - importing - !I_ENVIRONMENT_ID type STRING - !I_GATEWAY_NAME type T_GATEWAY_NAME optional - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_GATEWAY - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!List Gateway Details
- "! List information about the specified gateway. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_GATEWAY_ID | - "! The requested gateway ID. - "! @parameter E_RESPONSE | - "! Service return value of type T_GATEWAY - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_GATEWAY - importing - !I_ENVIRONMENT_ID type STRING - !I_GATEWAY_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_GATEWAY - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete Gateway
- "! Delete the specified gateway configuration. - "! - "! @parameter I_ENVIRONMENT_ID | - "! The ID of the environment. - "! @parameter I_GATEWAY_ID | - "! The requested gateway ID. - "! @parameter E_RESPONSE | - "! Service return value of type T_GATEWAY_DELETE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_GATEWAY - importing - !I_ENVIRONMENT_ID type STRING - !I_GATEWAY_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_GATEWAY_DELETE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - -protected section. - -private section. - -ENDCLASS. - -class ZCL_IBMC_DISCOVERY_V1 IMPLEMENTATION. - -*Discovery v2
+"! IBM Watson® Discovery is a cognitive search and content analytics engine +"! that you can add to applications to identify patterns, trends and actionable +"! insights to drive better decision-making. Securely unify structured and +"! unstructured data with pre-enriched content, and use a simplified query +"! language to eliminate the need for manual filtering of results.+ "! A macro-average computes metric independently for each class
+ "! and then takes the average. Class refers to the classification label that is + "! specified in the **answer_field**. + begin of T_MDL_EVALUATION_MACRO_AVERAGE, + "! A metric that measures how many of the overall documents are classified + "! correctly. + PRECISION type DOUBLE, + "! A metric that measures how often documents that should be classified into + "! certain classes are classified into those classes. + RECALL type DOUBLE, + "! A metric that measures whether the optimal balance between precision and recall + "! is reached. The F1 score can be interpreted as a weighted average of the + "! precision and recall values. An F1 score reaches its best value at 1 and worst + "! value at 0. + F1 type DOUBLE, + end of T_MDL_EVALUATION_MACRO_AVERAGE. + types: + "!+ "! An object that measures the metrics from a training run for
+ "! each classification label separately. + begin of T_PER_CLASS_MODEL_EVALUATION, + "! Class name. Each class name is derived from a value in the **answer_field**. + NAME type STRING, + "! A metric that measures how many of the overall documents are classified + "! correctly. + PRECISION type DOUBLE, + "! A metric that measures how often documents that should be classified into + "! certain classes are classified into those classes. + RECALL type DOUBLE, + "! A metric that measures whether the optimal balance between precision and recall + "! is reached. The F1 score can be interpreted as a weighted average of the + "! precision and recall values. An F1 score reaches its best value at 1 and worst + "! value at 0. + F1 type DOUBLE, + end of T_PER_CLASS_MODEL_EVALUATION. + types: + "!+ "! A micro-average aggregates the contributions of all classes
+ "! to compute the average metric. Classes refers to the classification labels that + "! are specified in the **answer_field**. + begin of T_MDL_EVALUATION_MICRO_AVERAGE, + "! A metric that measures how many of the overall documents are classified + "! correctly. + PRECISION type DOUBLE, + "! A metric that measures how often documents that should be classified into + "! certain classes are classified into those classes. + RECALL type DOUBLE, + "! A metric that measures whether the optimal balance between precision and recall + "! is reached. The F1 score can be interpreted as a weighted average of the + "! precision and recall values. An F1 score reaches its best value at 1 and worst + "! value at 0. + F1 type DOUBLE, + end of T_MDL_EVALUATION_MICRO_AVERAGE. + types: + "!+ "! An object that contains information about a trained document
+ "! classifier model. + begin of T_CLASSIFIER_MODEL_EVALUATION, + "! A micro-average aggregates the contributions of all classes to compute the + "! average metric. Classes refers to the classification labels that are specified + "! in the **answer_field**. + MICRO_AVERAGE type T_MDL_EVALUATION_MICRO_AVERAGE, + "! A macro-average computes metric independently for each class and then takes the + "! average. Class refers to the classification label that is specified in the + "! **answer_field**. + MACRO_AVERAGE type T_MDL_EVALUATION_MACRO_AVERAGE, + "! An array of evaluation metrics, one set of metrics for each class, where class + "! refers to the classification label that is specified in the **answer_field**. + PER_CLASS type STANDARD TABLE OF T_PER_CLASS_MODEL_EVALUATION WITH NON-UNIQUE DEFAULT KEY, + end of T_CLASSIFIER_MODEL_EVALUATION. + types: + "!+ "! Information about a document classifier model.
+ begin of T_DOCUMENT_CLASSIFIER_MODEL, + "! A unique identifier of the document classifier model. + MODEL_ID type STRING, + "! A human-readable name of the document classifier model. + NAME type STRING, + "! A description of the document classifier model. + DESCRIPTION type STRING, + "! The date that the document classifier model was created. + CREATED type DATETIME, + "! The date that the document classifier model was last updated. + UPDATED type DATETIME, + "! Name of the CSV file that contains the training data that is used to train the + "! document classifier model. + TRAINING_DATA_FILE type STRING, + "! Name of the CSV file that contains data that is used to test the document + "! classifier model. If no test data is provided, a subset of the training data is + "! used for testing purposes. + TEST_DATA_FILE type STRING, + "! The status of the training run. + STATUS type STRING, + "! An object that contains information about a trained document classifier model. + EVALUATION type T_CLASSIFIER_MODEL_EVALUATION, + "! A unique identifier of the enrichment that is generated by this document + "! classifier model. + ENRICHMENT_ID type STRING, + "! The date that the document classifier model was deployed. + DEPLOYED_AT type DATETIME, + end of T_DOCUMENT_CLASSIFIER_MODEL. + types: + "!+ "! Relevancy training status information for this project.
+ begin of T_PRJCT_LST_DTLS_RLVNCY_TRNNG1, + "! When the training data was updated. + DATA_UPDATED type STRING, + "! The total number of examples. + TOTAL_EXAMPLES type INTEGER, + "! When `true`, sufficient label diversity is present to allow training for this + "! project. + SUFFICIENT_LABEL_DIVERSITY type BOOLEAN, + "! When `true`, the relevancy training is in processing. + PROCESSING type BOOLEAN, + "! When `true`, the minimum number of examples required to train has been met. + MINIMUM_EXAMPLES_ADDED type BOOLEAN, + "! The time that the most recent successful training occurred. + SUCCESSFULLY_TRAINED type STRING, + "! When `true`, relevancy training is available when querying collections in the + "! project. + AVAILABLE type BOOLEAN, + "! The number of notices generated during the relevancy training. + NOTICES type INTEGER, + "! When `true`, the minimum number of queries required to train has been met. + MINIMUM_QUERIES_ADDED type BOOLEAN, + end of T_PRJCT_LST_DTLS_RLVNCY_TRNNG1. + types: + "!+ "! Details about a specific project.
+ begin of T_PROJECT_LIST_DETAILS, + "! The unique identifier of this project. + PROJECT_ID type STRING, + "! The human readable name of this project. + NAME type STRING, + "! The type of project.+ "! A list of projects in this instance.
+ begin of T_LIST_PROJECTS_RESPONSE, + "! An array of project details. + PROJECTS type STANDARD TABLE OF T_PROJECT_LIST_DETAILS WITH NON-UNIQUE DEFAULT KEY, + end of T_LIST_PROJECTS_RESPONSE. + types: + "!+ "! Result for the `pair` aggregation.
+ begin of T_QUERY_PAIR_AGGR_RESULT, + "! Array of subaggregations of type `term`, `group_by`, `histogram`, or + "! `timeslice`. Each element of the matrix that is returned contains a + "! **relevancy** value that is calculated from the combination of each value from + "! the first and second aggregations. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_PAIR_AGGR_RESULT. + types: + "!+ "! Calculates relevancy values using combinations of document
+ "! sets from results of the specified pair of aggregations. + begin of T_QUERY_AGGR_QUERY_PAIR_AGGR, + "! Specifies that the aggregation type is `pair`. + TYPE type STRING, + "! Specifies the first aggregation in the pair. The aggregation must be a `term`, + "! `group_by`, `histogram`, or `timeslice` aggregation type. + FIRST type STRING, + "! Specifies the second aggregation in the pair. The aggregation must be a `term`, + "! `group_by`, `histogram`, or `timeslice` aggregation type. + SECOND type STRING, + "! Indicates whether to include estimated matching result information. + SHW_ESTIMATED_MATCHING_RESULTS type BOOLEAN, + "! Indicates whether to include total matching documents information. + SHOW_TOTAL_MATCHING_DOCUMENTS type BOOLEAN, + "! An array of aggregations. + RESULTS type STANDARD TABLE OF T_QUERY_PAIR_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_AGGR_QUERY_PAIR_AGGR. + types: + "!+ "! Configuration for table retrieval.
+ begin of T_QUERY_LARGE_TABLE_RESULTS, + "! Whether to enable table retrieval. + ENABLED type BOOLEAN, + "! Maximum number of tables to return. + COUNT type INTEGER, + end of T_QUERY_LARGE_TABLE_RESULTS. + types: + "!+ "! Result information for a curated query.
+ begin of T_CURATION_RESULT, + "! The document ID of the curated result. + DOCUMENT_ID type STRING, + "! The collection ID of the curated result. + COLLECTION_ID type STRING, + "! Text to return in the `passage_text` field when this curated document is + "! returned for the specified natural language query. If **passages.per_document** + "! is `true`, the text snippet that you specify is returned as the top passage + "! instead of the original passage that is chosen by search. Only one text snippet + "! can be specified per document. If **passages.max_per_document** is greater than + "! `1`, the snippet is returned first, followed by the passages that are chosen by + "! search. + SNIPPET type STRING, + end of T_CURATION_RESULT. + types: + "!+ "! Object that contains an array of curated results.
+ begin of T_CURATED_RESULTS, + "! Array of curated results. + CURATED_RESULTS type STANDARD TABLE OF T_CURATION_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_CURATED_RESULTS. + types: + "!+ "! The numeric location of the identified element in the
+ "! document, represented with two integers labeled `begin` and `end`. + begin of T_TABLE_ELEMENT_LOCATION, + "! The element's `begin` index. + BEGIN type LONG, + "! The element's `end` index. + END type LONG, + end of T_TABLE_ELEMENT_LOCATION. + types: + "!+ "! Object that contains example response details for a training
+ "! query. + begin of T_TRAINING_EXAMPLE, + "! The document ID associated with this training example. + DOCUMENT_ID type STRING, + "! The collection ID associated with this training example. + COLLECTION_ID type STRING, + "! The relevance of the training example. + RELEVANCE type INTEGER, + "! The date and time the example was created. + CREATED type DATETIME, + "! The date and time the example was updated. + UPDATED type DATETIME, + end of T_TRAINING_EXAMPLE. + types: + "!+ "! Object that contains training query details.
+ begin of T_TRAINING_QUERY, + "! The query ID associated with the training query. + QUERY_ID type STRING, + "! The natural text query that is used as the training query. + NATURAL_LANGUAGE_QUERY type STRING, + "! The filter used on the collection before the **natural_language_query** is + "! applied. + FILTER type STRING, + "! The date and time the query was created. + CREATED type DATETIME, + "! The date and time the query was updated. + UPDATED type DATETIME, + "! Array of training examples. + EXAMPLES type STANDARD TABLE OF T_TRAINING_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, + end of T_TRAINING_QUERY. + types: + "!+ "! A value in a key-value pair.
+ begin of T_TABLE_CELL_VALUES, + "! The unique ID of the value in the table. + CELL_ID type STRING, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + "! The text content of the table cell without HTML markup. + TEXT type STRING, + end of T_TABLE_CELL_VALUES. + types: + "!+ "! A key in a key-value pair.
+ begin of T_TABLE_CELL_KEY, + "! The unique ID of the key in the table. + CELL_ID type STRING, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + "! The text content of the table cell without HTML markup. + TEXT type STRING, + end of T_TABLE_CELL_KEY. + types: + "!+ "! Key-value pairs detected across cell boundaries.
+ begin of T_TABLE_KEY_VALUE_PAIRS, + "! A key in a key-value pair. + KEY type T_TABLE_CELL_KEY, + "! A list of values in a key-value pair. + VALUE type STANDARD TABLE OF T_TABLE_CELL_VALUES WITH NON-UNIQUE DEFAULT KEY, + end of T_TABLE_KEY_VALUE_PAIRS. + types: + "!+ "! Aggregation results. For more information about supported
+ "! aggregation types, see the [product + "! documentation](/docs/discovery-data?topic=discovery-data-query-aggregations). + T_QUERY_SUB_AGGREGATION type JSONOBJECT. + types: + "!+ "! Curation status information.
+ begin of T_CURATION_STATUS, + "! The curation ID of the curation. + CURATION_ID type STRING, + "! The current status of the specified curation. + STATUS type STRING, + end of T_CURATION_STATUS. + types: + "!+ "! A query response that contains the matching documents for
+ "! the preceding aggregations. + begin of T_QUERY_TOP_HITS_AGGR_RESULT, + "! Number of matching results. + MATCHING_RESULTS type INTEGER, + "! An array of the document results in an ordered list. + HITS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TOP_HITS_AGGR_RESULT. + types: + "!+ "! Curated query and responses.
+ begin of T_CURATION, + "! The curation ID of this curation. + CURATION_ID type STRING, + "! The curated natural language query. + NATURAL_LANGUAGE_QUERY type STRING, + "! Array of curated results. + CURATED_RESULTS type STANDARD TABLE OF T_CURATION_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_CURATION. + types: + "!+ "! Title label.
+ begin of T_CMPNNT_STTNGS_FLDS_SHWN_TTL, + "! Use a specific field as the title. + FIELD type STRING, + end of T_CMPNNT_STTNGS_FLDS_SHWN_TTL. + types: + "!+ "! Display settings for aggregations.
+ begin of T_COMPONENT_SETTINGS_AGGR, + "! Identifier used to map aggregation settings to aggregation configuration. + NAME type STRING, + "! User-friendly alias for the aggregation. + LABEL type STRING, + "! Whether users is allowed to select more than one of the aggregation terms. + MULTIPLE_SELECTIONS_ALLOWED type BOOLEAN, + "! Type of visualization to use when rendering the aggregation. + VISUALIZATION_TYPE type STRING, + end of T_COMPONENT_SETTINGS_AGGR. + types: + "!+ "! Body label.
+ begin of T_CMPNNT_STTNGS_FLDS_SHWN_BODY, + "! Use the whole passage as the body. + USE_PASSAGE type BOOLEAN, + "! Use a specific field as the title. + FIELD type STRING, + end of T_CMPNNT_STTNGS_FLDS_SHWN_BODY. + types: + "!+ "! Fields shown in the results section of the UI.
+ begin of T_CMPNNT_SETTINGS_FIELDS_SHOWN, + "! Body label. + BODY type T_CMPNNT_STTNGS_FLDS_SHWN_BODY, + "! Title label. + TITLE type T_CMPNNT_STTNGS_FLDS_SHWN_TTL, + end of T_CMPNNT_SETTINGS_FIELDS_SHOWN. + types: + "!+ "! The default component settings for this project.
+ begin of T_COMPONENT_SETTINGS_RESPONSE, + "! Fields shown in the results section of the UI. + FIELDS_SHOWN type T_CMPNNT_SETTINGS_FIELDS_SHOWN, + "! Whether or not autocomplete is enabled. + AUTOCOMPLETE type BOOLEAN, + "! Whether or not structured search is enabled. + STRUCTURED_SEARCH type BOOLEAN, + "! Number or results shown per page. + RESULTS_PER_PAGE type INTEGER, + "! a list of component setting aggregations. + AGGREGATIONS type STANDARD TABLE OF T_COMPONENT_SETTINGS_AGGR WITH NON-UNIQUE DEFAULT KEY, + end of T_COMPONENT_SETTINGS_RESPONSE. + types: + "!+ "! Object that contains suggested refinement settings.
+ "! Default project query settings for table results.
+ begin of T_DFLT_QRY_PARAMS_TAB_RESULTS, + "! When `true`, a table results for the query are returned by default. + ENABLED type BOOLEAN, + "! The number of table results to return by default. + COUNT type INTEGER, + "! The number of table results to include in each result document. + PER_DOCUMENT type INTEGER, + end of T_DFLT_QRY_PARAMS_TAB_RESULTS. + types: + "!+ "! Default settings configuration for passage search options.
+ begin of T_DFLT_QUERY_PARAMS_PASSAGES, + "! When `true`, a passage search is performed by default. + ENABLED type BOOLEAN, + "! The number of passages to return. + COUNT type INTEGER, + "! An array of field names to perform the passage search on. + FIELDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The approximate number of characters that each returned passage will contain. + CHARACTERS type INTEGER, + "! When `true` the number of passages that can be returned from a single document + "! is restricted to the *max_per_document* value. + PER_DOCUMENT type BOOLEAN, + "! The default maximum number of passages that can be taken from a single document + "! as the result of a passage query. + MAX_PER_DOCUMENT type INTEGER, + end of T_DFLT_QUERY_PARAMS_PASSAGES. + types: + "!+ "! Default query parameters for this project.
+ begin of T_DEFAULT_QUERY_PARAMS, + "! An array of collection identifiers to query. If empty or omitted all collections + "! in the project are queried. + COLLECTION_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! Default settings configuration for passage search options. + PASSAGES type T_DFLT_QUERY_PARAMS_PASSAGES, + "! Default project query settings for table results. + TABLE_RESULTS type T_DFLT_QRY_PARAMS_TAB_RESULTS, + "! A string representing the default aggregation query for the project. + AGGREGATION type STRING, + "! Object that contains suggested refinement settings.+ "! Detailed information about the specified project.
+ begin of T_PROJECT_DETAILS, + "! The unique identifier of this project. + PROJECT_ID type STRING, + "! The human readable name of this project. + NAME type STRING, + "! The type of project.+ "! Information returned after an uploaded document is accepted.
+ begin of T_DOCUMENT_ACCEPTED, + "! The unique identifier of the ingested document. + DOCUMENT_ID type STRING, + "! Status of the document in the ingestion process. A status of `processing` is + "! returned for documents that are ingested with a *version* date before + "! `2019-01-01`. The `pending` status is returned for all others. + STATUS type STRING, + end of T_DOCUMENT_ACCEPTED. + types: + "!+ "! Result for the `trend` aggregation.
+ begin of T_QUERY_TREND_AGGR_RESULT, + "! Array of subaggregations of type `term` or `group_by` and `timeslice`. Each + "! element of the matrix that is returned contains a **trend_indicator** that is + "! calculated from the combination of each aggregation value and segment of time. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TREND_AGGR_RESULT. + types: + "!+ "! Detects sharp and unexpected changes in the frequency of a
+ "! facet or facet value over time based on the past history of frequency changes + "! of the facet value. + begin of T_QUERY_TREND_AGGREGATION, + "! Specifies that the aggregation type is `trend`. + TYPE type STRING, + "! Specifies the `term` or `group_by` aggregation for the facet that you want to + "! analyze. + FACET type STRING, + "! Specifies the `timeslice` aggregation that defines the time segments. + TIME_SEGMENTS type STRING, + "! Indicates whether to include estimated matching result information. + SHW_ESTIMATED_MATCHING_RESULTS type BOOLEAN, + "! Indicates whether to include total matching documents information. + SHOW_TOTAL_MATCHING_DOCUMENTS type BOOLEAN, + "! An array of aggregations. + RESULTS type STANDARD TABLE OF T_QUERY_TREND_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TREND_AGGREGATION. + types: + "!+ "! Object that contains a potential answer to the specified
+ "! query. + begin of T_RESULT_PASSAGE_ANSWER, + "! Answer text for the specified query as identified by Discovery. + ANSWER_TEXT type STRING, + "! The position of the first character of the extracted answer in the originating + "! field. + START_OFFSET type INTEGER, + "! The position after the last character of the extracted answer in the originating + "! field. + END_OFFSET type INTEGER, + "! An estimate of the probability that the answer is relevant. + CONFIDENCE type DOUBLE, + end of T_RESULT_PASSAGE_ANSWER. + types: + "!+ "! A passage query response.
+ begin of T_QUERY_RESPONSE_PASSAGE, + "! The content of the extracted passage. + PASSAGE_TEXT type STRING, + "! The confidence score of the passage's analysis. A higher score indicates + "! greater confidence. The score is used to rank the passages from all documents + "! and is returned only if **passages.per_document** is `false`. + PASSAGE_SCORE type DOUBLE, + "! The unique identifier of the ingested document. + DOCUMENT_ID type STRING, + "! The unique identifier of the collection. + COLLECTION_ID type STRING, + "! The position of the first character of the extracted passage in the originating + "! field. + START_OFFSET type INTEGER, + "! The position after the last character of the extracted passage in the + "! originating field. + END_OFFSET type INTEGER, + "! The label of the field from which the passage has been extracted. + FIELD type STRING, + "! An array of extracted answers to the specified query. Returned for natural + "! language queries when **passages.per_document** is `false`. + ANSWERS type STANDARD TABLE OF T_RESULT_PASSAGE_ANSWER WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_RESPONSE_PASSAGE. + types: + "!+ "! An object that contains configuration settings for a
+ "! document classifier model training run. + begin of T_DOC_CLASSIFIER_MODEL_TRAIN, + "! The name of the document classifier model. + NAME type STRING, + "! A description of the document classifier model. + DESCRIPTION type STRING, + "! A tuning parameter in an optimization algorithm that determines the step size at + "! each iteration of the training process. It influences how much of any newly + "! acquired information overrides the existing information, and therefore is said + "! to represent the speed at which a machine learning model learns. The default + "! value is `0.1`. + LEARNING_RATE type DOUBLE, + "! Avoids overfitting by shrinking the coefficient of less important features to + "! zero, which removes some features altogether. You can specify many values for + "! hyper-parameter optimization. The default value is `[0.000001]`. + L1_REGULARIZATION_STRENGTHS type STANDARD TABLE OF DOUBLE WITH NON-UNIQUE DEFAULT KEY, + "! A method you can apply to avoid overfitting your model on the training data. You + "! can specify many values for hyper-parameter optimization. The default value is + "! `[0.000001]`. + L2_REGULARIZATION_STRENGTHS type STANDARD TABLE OF DOUBLE WITH NON-UNIQUE DEFAULT KEY, + "! Maximum number of training steps to complete. This setting is useful if you need + "! the training process to finish in a specific time frame to fit into an + "! automated process. The default value is ten million. + TRAINING_MAX_STEPS type INTEGER, + "! Stops the training run early if the improvement ratio is not met by the time the + "! process reaches a certain point. The default value is `0.00001`. + IMPROVEMENT_RATIO type DOUBLE, + end of T_DOC_CLASSIFIER_MODEL_TRAIN. + types: + "!+ "! Calculates relevancy values using combinations of document
+ "! sets from results of the specified pair of aggregations. + begin of T_QUERY_PAIR_AGGREGATION, + "! Specifies that the aggregation type is `pair`. + TYPE type STRING, + "! Specifies the first aggregation in the pair. The aggregation must be a `term`, + "! `group_by`, `histogram`, or `timeslice` aggregation type. + FIRST type STRING, + "! Specifies the second aggregation in the pair. The aggregation must be a `term`, + "! `group_by`, `histogram`, or `timeslice` aggregation type. + SECOND type STRING, + "! Indicates whether to include estimated matching result information. + SHW_ESTIMATED_MATCHING_RESULTS type BOOLEAN, + "! Indicates whether to include total matching documents information. + SHOW_TOTAL_MATCHING_DOCUMENTS type BOOLEAN, + "! An array of aggregations. + RESULTS type STANDARD TABLE OF T_QUERY_PAIR_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_PAIR_AGGREGATION. + types: + "!+ "! Returns a scalar calculation across all documents for the
+ "! field specified. Possible calculations include min, max, sum, average, and + "! unique_count. + begin of T_QUERY_CALCULATION_AGGR, + "! Specifies the calculation type, such as 'average`, `max`, `min`, `sum`, or + "! `unique_count`. + TYPE type STRING, + "! The field to perform the calculation on. + FIELD type STRING, + "! The value of the calculation. + VALUE type DOUBLE, + end of T_QUERY_CALCULATION_AGGR. + types: + "!+ "! An object that describes the Smart Document Understanding
+ "! model for a collection. + begin of T_CLLCTN_DTLS_SMRT_DOC_UNDRST1, + "! When `true`, smart document understanding conversion is enabled for the + "! collection. + ENABLED type BOOLEAN, + "! Specifies the type of Smart Document Understanding (SDU) model that is enabled + "! for the collection. The following types of models are supported:+ "! An object describing an enrichment for a collection.
+ begin of T_COLLECTION_ENRICHMENT, + "! The unique identifier of this enrichment. For more information about how to + "! determine the ID of an enrichment, see [the product + "! documentation](/docs/discovery-data?topic=discovery-data-manage-enrichments#enr + "! ichments-ids). + ENRICHMENT_ID type STRING, + "! An array of field names that the enrichment is applied to.+ "! A collection for storing documents.
+ begin of T_COLLECTION_DETAILS, + "! The unique identifier of the collection. + COLLECTION_ID type STRING, + "! The name of the collection. + NAME type STRING, + "! A description of the collection. + DESCRIPTION type STRING, + "! The date that the collection was created. + CREATED type DATETIME, + "! The language of the collection. For a list of supported languages, see the + "! [product + "! documentation](/docs/discovery-data?topic=discovery-data-language-support). + LANGUAGE type STRING, + "! An array of enrichments that are applied to this collection. To get a list of + "! enrichments that are available for a project, use the [List + "! enrichments](#listenrichments) method.+ "! An object with details for creating federated document
+ "! classifier models. + begin of T_CLASSIFIER_FEDERATED_MODEL, + "! Name of the field that contains the values from which multiple classifier models + "! are defined. For example, you can specify a field that lists product lines to + "! create a separate model per product line. + FIELD type STRING, + end of T_CLASSIFIER_FEDERATED_MODEL. + types: + "!+ "! An object that describes enrichments that are applied to the
+ "! training and test data that is used by the document classifier. + begin of T_DOC_CLASSIFIER_ENRICHMENT, + "! A unique identifier of the enrichment. + ENRICHMENT_ID type STRING, + "! An array of field names where the enrichment is applied. + FIELDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_DOC_CLASSIFIER_ENRICHMENT. + types: + "!+ "! Information about a document classifier.
+ begin of T_DOCUMENT_CLASSIFIER, + "! A unique identifier of the document classifier. + CLASSIFIER_ID type STRING, + "! A human-readable name of the document classifier. + NAME type STRING, + "! A description of the document classifier. + DESCRIPTION type STRING, + "! The date that the document classifier was created. + CREATED type DATETIME, + "! The language of the training data that is associated with the document + "! classifier. Language is specified by using the ISO 639-1 language code, such as + "! `en` for English or `ja` for Japanese. + LANGUAGE type STRING, + "! An array of enrichments to apply to the data that is used to train and test the + "! document classifier. The output from the enrichments is used as features by the + "! classifier to classify the document content both during training and at run + "! time. + ENRICHMENTS type STANDARD TABLE OF T_DOC_CLASSIFIER_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY, + "! An array of fields that are used to train the document classifier. The same set + "! of fields must exist in the training data, the test data, and the documents + "! where the resulting document classifier enrichment is applied at run time. + RECOGNIZED_FIELDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The name of the field from the training and test data that contains the + "! classification labels. + ANSWER_FIELD type STRING, + "! Name of the CSV file with training data that is used to train the document + "! classifier. + TRAINING_DATA_FILE type STRING, + "! Name of the CSV file with data that is used to test the document classifier. If + "! no test data is provided, a subset of the training data is used for testing + "! purposes. + TEST_DATA_FILE type STRING, + "! An object with details for creating federated document classifier models. + FEDERATED_CLASSIFICATION type T_CLASSIFIER_FEDERATED_MODEL, + end of T_DOCUMENT_CLASSIFIER. + types: + "!+ "! An object that contains a list of document classifier
+ "! definitions. + begin of T_DOCUMENT_CLASSIFIERS, + "! An array of document classifier definitions. + CLASSIFIERS type STANDARD TABLE OF T_DOCUMENT_CLASSIFIER WITH NON-UNIQUE DEFAULT KEY, + end of T_DOCUMENT_CLASSIFIERS. + types: + "!+ "! Top value result for the `term` aggregation.
+ begin of T_QUERY_TERM_AGGR_RESULT, + "! Value of the field with a nonzero frequency in the document set. + KEY type STRING, + "! Number of documents that contain the 'key'. + MATCHING_RESULTS type INTEGER, + "! The relevancy score for this result. Returned only if `relevancy:true` is + "! specified in the request. + RELEVANCY type DOUBLE, + "! Number of documents in the collection that contain the term in the specified + "! field. Returned only when `relevancy:true` is specified in the request. + TOTAL_MATCHING_DOCUMENTS type INTEGER, + "! Number of documents that are estimated to match the query and also meet the + "! condition. Returned only when `relevancy:true` is specified in the request. + ESTIMATED_MATCHING_RESULTS type DOUBLE, + "! An array of subaggregations. Returned only when this aggregation is combined + "! with other aggregations in the request or is returned as a subaggregation. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TERM_AGGR_RESULT. + types: + "!+ "! An array of values, each being the `id` value of a column
+ "! header that is applicable to the current cell. + begin of T_TABLE_COLUMN_HEADER_IDS, + "! The `id` value of a column header. + ID type STRING, + end of T_TABLE_COLUMN_HEADER_IDS. + types: + "!+ "! A list of values in a key-value pair.
+ T_TABLE_CELL_VALUE type STANDARD TABLE OF T_TABLE_CELL_VALUES WITH NON-UNIQUE DEFAULT KEY. + types: + "!+ "! A timeslice interval segment.
+ begin of T_QUERY_TIMESLICE_AGGR_RESULT, + "! String date value of the upper bound for the timeslice interval in ISO-8601 + "! format. + KEY_AS_STRING type STRING, + "! Numeric date value of the upper bound for the timeslice interval in UNIX + "! milliseconds since epoch. + KEY type LONG, + "! Number of documents with the specified key as the upper bound. + MATCHING_RESULTS type LONG, + "! An array of subaggregations. Returned only when this aggregation is returned as + "! a subaggregation. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TIMESLICE_AGGR_RESULT. + types: + "!+ "! A specialized histogram aggregation that uses dates to
+ "! create interval segments. + begin of T_QRY_AGGR_QRY_TIMESLICE_AGGR, + "! Specifies that the aggregation type is `timeslice`. + TYPE type STRING, + "! The date field name used to create the timeslice. + FIELD type STRING, + "! The date interval value. Valid values are seconds, minutes, hours, days, weeks, + "! and years. + INTERVAL type STRING, + "! Identifier that can optionally be specified in the query request of this + "! aggregation. + NAME type STRING, + "! Array of aggregation results. + RESULTS type STANDARD TABLE OF T_QUERY_TIMESLICE_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QRY_AGGR_QRY_TIMESLICE_AGGR. + types: + "!+ "! Object that contains field details.
+ begin of T_FIELD, + "! The name of the field. + FIELD type STRING, + "! The type of the field. + TYPE type STRING, + "! The collection Id of the collection where the field was found. + COLLECTION_ID type STRING, + end of T_FIELD. + types: + "!+ "! Finds results from documents that are similar to documents
+ "! of interest. Use this parameter to add a *More like these* function to your + "! search. You can include this parameter with or without a **query**, **filter** + "! or **natural_language_query** parameter. + begin of T_QUERY_LARGE_SIMILAR, + "! When `true`, includes documents in the query results that are similar to + "! documents you specify. + ENABLED type BOOLEAN, + "! The list of documents of interest. Required if **enabled** is `true`. + DOCUMENT_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! Looks for similarities in the specified subset of fields in the documents. If + "! not specified, all of the document fields are used. + FIELDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_LARGE_SIMILAR. + types: + "!+ "! Histogram numeric interval result.
+ begin of T_QUERY_HISTOGRAM_AGGR_RESULT, + "! The value of the upper bound for the numeric segment. + KEY type LONG, + "! Number of documents with the specified key as the upper bound. + MATCHING_RESULTS type INTEGER, + "! An array of subaggregations. Returned only when this aggregation is returned as + "! a subaggregation. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_HISTOGRAM_AGGR_RESULT. + types: + "!+ "! Numeric interval segments to categorize documents by using
+ "! field values from a single numeric field to describe the category. + begin of T_QUERY_HISTOGRAM_AGGREGATION, + "! Specifies that the aggregation type is `histogram`. + TYPE type STRING, + "! The numeric field name used to create the histogram. + FIELD type STRING, + "! The size of the sections that the results are split into. + INTERVAL type INTEGER, + "! Identifier that can optionally be specified in the query request of this + "! aggregation. + NAME type STRING, + "! Array of numeric intervals. + RESULTS type STANDARD TABLE OF T_QUERY_HISTOGRAM_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_HISTOGRAM_AGGREGATION. + types: + "!+ "! An array of values, each being the `id` value of a row
+ "! header that is applicable to this body cell. + begin of T_TABLE_ROW_HEADER_IDS, + "! The `id` values of a row header. + ID type STRING, + end of T_TABLE_ROW_HEADER_IDS. + types: + "!+ "! Relevancy training status information for this project.
+ begin of T_PROJECT_REL_TRAIN_STATUS, + "! When the training data was updated. + DATA_UPDATED type STRING, + "! The total number of examples. + TOTAL_EXAMPLES type INTEGER, + "! When `true`, sufficient label diversity is present to allow training for this + "! project. + SUFFICIENT_LABEL_DIVERSITY type BOOLEAN, + "! When `true`, the relevancy training is in processing. + PROCESSING type BOOLEAN, + "! When `true`, the minimum number of examples required to train has been met. + MINIMUM_EXAMPLES_ADDED type BOOLEAN, + "! The time that the most recent successful training occurred. + SUCCESSFULLY_TRAINED type STRING, + "! When `true`, relevancy training is available when querying collections in the + "! project. + AVAILABLE type BOOLEAN, + "! The number of notices generated during the relevancy training. + NOTICES type INTEGER, + "! When `true`, the minimum number of queries required to train has been met. + MINIMUM_QUERIES_ADDED type BOOLEAN, + end of T_PROJECT_REL_TRAIN_STATUS. + types: + "!+ "! An object that defines how to aggregate query results.
+ T_QUERY_AGGREGATION type JSONOBJECT. + types: + "!+ "! Numeric interval segments to categorize documents by using
+ "! field values from a single numeric field to describe the category. + begin of T_QRY_AGGR_QRY_HISTOGRAM_AGGR, + "! Specifies that the aggregation type is `histogram`. + TYPE type STRING, + "! The numeric field name used to create the histogram. + FIELD type STRING, + "! The size of the sections that the results are split into. + INTERVAL type INTEGER, + "! Identifier that can optionally be specified in the query request of this + "! aggregation. + NAME type STRING, + "! Array of numeric intervals. + RESULTS type STANDARD TABLE OF T_QUERY_HISTOGRAM_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QRY_AGGR_QRY_HISTOGRAM_AGGR. + types: + "!+ "! Result of the document analysis.
+ begin of T_ANALYZED_RESULT, + "! Metadata that was specified with the request. + METADATA type JSONOBJECT, + end of T_ANALYZED_RESULT. + types: + "!+ "! Configuration for passage retrieval.
+ begin of T_QUERY_LARGE_PASSAGES, + "! A passages query that returns the most relevant passages from the results. + ENABLED type BOOLEAN, + "! If `true`, ranks the documents by document quality, and then returns the + "! highest-ranked passages per document in a `document_passages` field for each + "! document entry in the results list of the response.+ "! Configuration for suggested refinements.
+ "! Object that describes a long query.
+ begin of T_QUERY_LARGE, + "! A comma-separated list of collection IDs to be queried against. + COLLECTION_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! Searches for documents that match the Discovery Query Language criteria that is + "! specified as input. Filter calls are cached and are faster than query calls + "! because the results are not ordered by relevance. When used with the + "! **aggregation**, **query**, or **natural_language_query** parameters, the + "! **filter** parameter runs first. This parameter is useful for limiting results + "! to those that contain specific metadata values. + FILTER type STRING, + "! A query search that is written in the Discovery Query Language and returns all + "! matching documents in your data set with full enrichments and full text, and + "! with the most relevant documents listed first. Use a query search when you want + "! to find the most relevant search results. + QUERY type STRING, + "! A natural language query that returns relevant documents by using training data + "! and natural language understanding. + NATURAL_LANGUAGE_QUERY type STRING, + "! An aggregation search that returns an exact answer by combining query search + "! with filters. Useful for applications to build lists, tables, and time series. + "! For more information about the supported types of aggregations, see the + "! [Discovery + "! documentation](/docs/discovery-data?topic=discovery-data-query-aggregations). + AGGREGATION type STRING, + "! Number of results to return. + COUNT type INTEGER, + "! A list of the fields in the document hierarchy to return. You can specify both + "! root-level (`text`) and nested (`extracted_metadata.filename`) fields. If this + "! parameter is an empty list, then all fields are returned. + RETURN type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The number of query results to skip at the beginning. For example, if the total + "! number of results that are returned is 10 and the offset is 8, it returns the + "! last two results. + OFFSET type INTEGER, + "! A comma-separated list of fields in the document to sort on. You can optionally + "! specify a sort direction by prefixing the field with `-` for descending or `+` + "! for ascending. Ascending is the default sort direction if no prefix is + "! specified. + SORT type STRING, + "! When `true`, a highlight field is returned for each result that contains fields + "! that match the query. The matching query terms are emphasized with surrounding + "! `<em></em>` tags. This parameter is ignored if **passages.enabled** + "! and **passages.per_document** are `true`, in which case passages are returned + "! for each document instead of highlights. + HIGHLIGHT type BOOLEAN, + "! When `true` and the **natural_language_query** parameter is used, the + "! **natural_language_query** parameter is spell checked. The most likely + "! correction is returned in the **suggested_query** field of the response (if one + "! exists). + SPELLING_SUGGESTIONS type BOOLEAN, + "! Configuration for table retrieval. + TABLE_RESULTS type T_QUERY_LARGE_TABLE_RESULTS, + "! Configuration for suggested refinements.+ "! An object that contains options for the current enrichment.
+ "! Starting with version `2020-08-30`, the enrichment options are not included in + "! responses from the List Enrichments method. + begin of T_ENRICHMENT_OPTIONS, + "! An array of supported languages for this enrichment. When creating an + "! enrichment, only specify a language that is used by the model or in the + "! dictionary. Required when **type** is `dictionary`. Optional when **type** is + "! `rule_based`. Not valid when creating any other type of enrichment. + LANGUAGES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! The name of the entity type. This value is used as the field name in the index. + "! Required when **type** is `dictionary` or `regular_expression`. Not valid when + "! creating any other type of enrichment. + ENTITY_TYPE type STRING, + "! The regular expression to apply for this enrichment. Required when **type** is + "! `regular_expression`. Not valid when creating any other type of enrichment. + REGULAR_EXPRESSION type STRING, + "! The name of the result document field that this enrichment creates. Required + "! when **type** is `rule_based` or `classifier`. Not valid when creating any + "! other type of enrichment. + RESULT_FIELD type STRING, + "! A unique identifier of the document classifier. Required when **type** is + "! `classifier`. Not valid when creating any other type of enrichment. + CLASSIFIER_ID type STRING, + "! A unique identifier of the document classifier model. Required when **type** is + "! `classifier`. Not valid when creating any other type of enrichment. + MODEL_ID type STRING, + "! Specifies a threshold. Only classes with evaluation confidence scores that are + "! higher than the specified threshold are included in the output. Optional when + "! **type** is `classifier`. Not valid when creating any other type of enrichment. + "! + CONFIDENCE_THRESHOLD type DOUBLE, + "! Evaluates only the classes that fall in the top set of results when ranked by + "! confidence. For example, if set to `5`, then the top five classes for each + "! document are evaluated. If set to 0, the **confidence_threshold** is used to + "! determine the predicted classes. Optional when **type** is `classifier`. Not + "! valid when creating any other type of enrichment. + TOP_K type INTEGER, + end of T_ENRICHMENT_OPTIONS. + types: + "!+ "! Information about a specific enrichment.
+ begin of T_ENRICHMENT, + "! The unique identifier of this enrichment. + ENRICHMENT_ID type STRING, + "! The human readable name for this enrichment. + NAME type STRING, + "! The description of this enrichment. + DESCRIPTION type STRING, + "! The type of this enrichment. + TYPE type STRING, + "! An object that contains options for the current enrichment. Starting with + "! version `2020-08-30`, the enrichment options are not included in responses from + "! the List Enrichments method. + OPTIONS type T_ENRICHMENT_OPTIONS, + end of T_ENRICHMENT. + types: + "!+ "! Result group for the `group_by` aggregation.
+ begin of T_QUERY_GROUP_BY_AGGR_RESULT, + "! The condition that is met by the documents in this group. For example, + "! `YEARTXT<2000`. + KEY type STRING, + "! Number of documents that meet the query and condition. + MATCHING_RESULTS type INTEGER, + "! The relevancy for this group. Returned only if `relevancy:true` is specified in + "! the request. + RELEVANCY type DOUBLE, + "! Number of documents that meet the condition in the whole set of documents in + "! this collection. Returned only when `relevancy:true` is specified in the + "! request. + TOTAL_MATCHING_DOCUMENTS type INTEGER, + "! The number of documents that are estimated to match the query and condition. + "! Returned only when `relevancy:true` is specified in the request. + ESTIMATED_MATCHING_RESULTS type DOUBLE, + "! An array of subaggregations. Returned only when this aggregation is returned as + "! a subaggregation. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_GROUP_BY_AGGR_RESULT. + types: + "!+ "! Separates document results into groups that meet the
+ "! conditions you specify. + begin of T_QRY_AGGR_QUERY_GROUP_BY_AGGR, + "! Specifies that the aggregation type is `group_by`. + TYPE type STRING, + "! An array of results. + RESULTS type STANDARD TABLE OF T_QUERY_GROUP_BY_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QRY_AGGR_QUERY_GROUP_BY_AGGR. + types: + "!+ "! A collection for storing documents.
+ begin of T_COLLECTION, + "! The unique identifier of the collection. + COLLECTION_ID type STRING, + "! The name of the collection. + NAME type STRING, + end of T_COLLECTION. + types: + "!+ "! An object that contains a list of document classifier model
+ "! definitions. + begin of T_DOCUMENT_CLASSIFIER_MODELS, + "! An array of document classifier model definitions. + MODELS type STANDARD TABLE OF T_DOCUMENT_CLASSIFIER_MODEL WITH NON-UNIQUE DEFAULT KEY, + end of T_DOCUMENT_CLASSIFIER_MODELS. + types: + "!+ "! If you provide customization input, the normalized version
+ "! of the row header texts according to the customization; otherwise, the same + "! value as `row_header_texts`. + begin of T_TAB_ROW_HEADER_TEXTS_NORM, + "! The normalized version of a row header text. + TEXT_NORMALIZED type STRING, + end of T_TAB_ROW_HEADER_TEXTS_NORM. + types: + "!+ "! List of document attributes.
+ begin of T_DOCUMENT_ATTRIBUTE, + "! The type of attribute. + TYPE type STRING, + "! The text associated with the attribute. + TEXT type STRING, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + end of T_DOCUMENT_ATTRIBUTE. + types: + "!+ "! An array of values, each being the `text` value of a row
+ "! header that is applicable to this body cell. + begin of T_TABLE_ROW_HEADER_TEXTS, + "! The `text` value of a row header. + TEXT type STRING, + end of T_TABLE_ROW_HEADER_TEXTS. + types: + "!+ "! An array of values, each being the `text` value of a column
+ "! header that is applicable to the current cell. + begin of T_TABLE_COLUMN_HEADER_TEXTS, + "! The `text` value of a column header. + TEXT type STRING, + end of T_TABLE_COLUMN_HEADER_TEXTS. + types: + "!+ "! If you provide customization input, the normalized version
+ "! of the column header texts according to the customization; otherwise, the same + "! value as `column_header_texts`. + begin of T_TAB_COLUMN_HEADER_TEXTS_NORM, + "! The normalized version of a column header text. + TEXT_NORMALIZED type STRING, + end of T_TAB_COLUMN_HEADER_TEXTS_NORM. + types: + "!+ "! Cells that are not table header, column header, or row
+ "! header cells. + begin of T_TABLE_BODY_CELLS, + "! The unique ID of the cell in the current table. + CELL_ID type STRING, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + "! The textual contents of this cell from the input document without associated + "! markup content. + TEXT type STRING, + "! The `begin` index of this cell's `row` location in the current table. + ROW_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `row` location in the current table. + ROW_INDEX_END type LONG, + "! The `begin` index of this cell's `column` location in the current table. + COLUMN_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `column` location in the current table. + COLUMN_INDEX_END type LONG, + "! A list of table row header ids. + ROW_HEADER_IDS type STANDARD TABLE OF T_TABLE_ROW_HEADER_IDS WITH NON-UNIQUE DEFAULT KEY, + "! A list of table row header texts. + ROW_HEADER_TEXTS type STANDARD TABLE OF T_TABLE_ROW_HEADER_TEXTS WITH NON-UNIQUE DEFAULT KEY, + "! A list of table row header texts normalized. + ROW_HEADER_TEXTS_NORMALIZED type STANDARD TABLE OF T_TAB_ROW_HEADER_TEXTS_NORM WITH NON-UNIQUE DEFAULT KEY, + "! A list of table column header ids. + COLUMN_HEADER_IDS type STANDARD TABLE OF T_TABLE_COLUMN_HEADER_IDS WITH NON-UNIQUE DEFAULT KEY, + "! A list of table column header texts. + COLUMN_HEADER_TEXTS type STANDARD TABLE OF T_TABLE_COLUMN_HEADER_TEXTS WITH NON-UNIQUE DEFAULT KEY, + "! A list of table column header texts normalized. + COLUMN_HEADER_TEXTS_NORMALIZED type STANDARD TABLE OF T_TAB_COLUMN_HEADER_TEXTS_NORM WITH NON-UNIQUE DEFAULT KEY, + "! A list of document attributes. + ATTRIBUTES type STANDARD TABLE OF T_DOCUMENT_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, + end of T_TABLE_BODY_CELLS. + types: + "!+ "! Text and associated location within a table.
+ begin of T_TABLE_TEXT_LOCATION, + "! The text retrieved. + TEXT type STRING, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + end of T_TABLE_TEXT_LOCATION. + types: + "!+ "! Returns the top documents ranked by the score of the query.
+ begin of T_QUERY_TOP_HITS_AGGREGATION, + "! Specifies that the aggregation type is `top_hits`. + TYPE type STRING, + "! The number of documents to return. + SIZE type INTEGER, + "! Identifier specified in the query request of this aggregation. + NAME type STRING, + "! A query response that contains the matching documents for the preceding + "! aggregations. + HITS type T_QUERY_TOP_HITS_AGGR_RESULT, + end of T_QUERY_TOP_HITS_AGGREGATION. + types: + "!+ "! Information about the child documents that are generated
+ "! from a single document during ingestion or other processing. + begin of T_DOCUMENT_DETAILS_CHILDREN, + "! Indicates whether the child documents have any notices. The value is `false` if + "! the document does not have child documents. + HAVE_NOTICES type BOOLEAN, + "! Number of child documents. The value is `0` when processing of the document + "! doesn't generate any child documents. + COUNT type INTEGER, + end of T_DOCUMENT_DETAILS_CHILDREN. + types: + "!+ "! A notice produced for the collection.
+ begin of T_NOTICE, + "! Identifies the notice. Many notices might have the same ID. This field exists so + "! that user applications can programmatically identify a notice and take + "! automatic corrective action. Typical notice IDs include:+ "! Information about a document.
+ begin of T_DOCUMENT_DETAILS, + "! The unique identifier of the document. + DOCUMENT_ID type STRING, + "! Date and time that the document is added to the collection. For a child + "! document, the date and time when the process that generates the child document + "! runs. The date-time format is + "! `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. + CREATED type DATETIME, + "! Date and time that the document is finished being processed and is indexed. This + "! date changes whenever the document is reprocessed, including for enrichment + "! changes. The date-time format is + "! `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`. + UPDATED type DATETIME, + "! The status of the ingestion of the document. The possible values are:+ "! A restriction that alters the document set that is used by
+ "! the aggregations that it precedes. Subsequent aggregations are applied to + "! nested documents from the specified field. + begin of T_QUERY_AGGR_QUERY_NESTED_AGGR, + "! Specifies that the aggregation type is `nested`. + TYPE type STRING, + "! The path to the document field to scope subsequent aggregations to. + PATH type STRING, + "! Number of nested documents found in the specified field. + MATCHING_RESULTS type LONG, + "! An array of subaggregations. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_AGGR_QUERY_NESTED_AGGR. + types: + "!+ "! An object that contains an array of autocompletion
+ "! suggestions. + begin of T_COMPLETIONS, + "! Array of autocomplete suggestion based on the provided prefix. + COMPLETIONS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_COMPLETIONS. + types: + "!+ "! An object that contains a new name and description for an
+ "! enrichment. + begin of T_UPDATE_ENRICHMENT, + "! A new name for the enrichment. + NAME type STRING, + "! A new description for the enrichment. + DESCRIPTION type STRING, + end of T_UPDATE_ENRICHMENT. + types: + "!+ "! A suggested additional query term or terms user to filter
+ "! results. **Note**: The `suggested_refinements` parameter is deprecated. + begin of T_QUERY_SUGGESTED_REFINEMENT, + "! The text used to filter. + TEXT type STRING, + end of T_QUERY_SUGGESTED_REFINEMENT. + types: + "!+ "! The contents of the current table's header.
+ begin of T_TABLE_HEADERS, + "! The unique ID of the cell in the current table. + CELL_ID type STRING, + "! The location of the table header cell in the current table as defined by its + "! `begin` and `end` offsets, respectfully, in the input document. + LOCATION type JSONOBJECT, + "! The textual contents of the cell from the input document without associated + "! markup content. + TEXT type STRING, + "! The `begin` index of this cell's `row` location in the current table. + ROW_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `row` location in the current table. + ROW_INDEX_END type LONG, + "! The `begin` index of this cell's `column` location in the current table. + COLUMN_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `column` location in the current table. + COLUMN_INDEX_END type LONG, + end of T_TABLE_HEADERS. + types: + "!+ "! An object contain retrieval type information.
+ begin of T_RETRIEVAL_DETAILS, + "! Identifies the document retrieval strategy used for this query. + "! `relevancy_training` indicates that the results were returned using a relevancy + "! trained model.+ "! Information about a specific enrichment.
+ begin of T_CREATE_ENRICHMENT, + "! The human readable name for this enrichment. + NAME type STRING, + "! The description of this enrichment. + DESCRIPTION type STRING, + "! The type of this enrichment. The following types are supported:+ "! The list of fetched fields.
+ "! Returns the top documents ranked by the score of the query.
+ begin of T_QRY_AGGR_QUERY_TOP_HITS_AGGR, + "! Specifies that the aggregation type is `top_hits`. + TYPE type STRING, + "! The number of documents to return. + SIZE type INTEGER, + "! Identifier specified in the query request of this aggregation. + NAME type STRING, + "! A query response that contains the matching documents for the preceding + "! aggregations. + HITS type T_QUERY_TOP_HITS_AGGR_RESULT, + end of T_QRY_AGGR_QUERY_TOP_HITS_AGGR. + types: + "!+ "! A passage query result.
+ begin of T_QUERY_RESULT_PASSAGE, + "! The content of the extracted passage. + PASSAGE_TEXT type STRING, + "! The position of the first character of the extracted passage in the originating + "! field. + START_OFFSET type INTEGER, + "! The position after the last character of the extracted passage in the + "! originating field. + END_OFFSET type INTEGER, + "! The label of the field from which the passage has been extracted. + FIELD type STRING, + "! An arry of extracted answers to the specified query. Returned for natural + "! language queries when **passages.per_document** is `true`. + ANSWERS type STANDARD TABLE OF T_RESULT_PASSAGE_ANSWER WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_RESULT_PASSAGE. + types: + "!+ "! List of words to filter out of text that is submitted in
+ "! queries. + begin of T_STOP_WORD_LIST, + "! List of stop words. + STOPWORDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + end of T_STOP_WORD_LIST. + types: + "!+ "! Object specifying the training queries contained in the
+ "! identified training set. + begin of T_TRAINING_QUERY_SET, + "! Array of training queries. At least 50 queries are required for training to + "! begin. A maximum of 10,000 queries are returned. + QUERIES type STANDARD TABLE OF T_TRAINING_QUERY WITH NON-UNIQUE DEFAULT KEY, + end of T_TRAINING_QUERY_SET. + types: + "!+ "! Metadata of a query result.
+ begin of T_QUERY_RESULT_METADATA, + "! The document retrieval source that produced this search result. + DOCUMENT_RETRIEVAL_SOURCE type STRING, + "! The collection id associated with this training data set. + COLLECTION_ID type STRING, + "! The confidence score for the given result. Calculated based on how relevant the + "! result is estimated to be. The score can range from `0.0` to `1.0`. The higher + "! the number, the more relevant the document. The `confidence` value for a result + "! was calculated using the model specified in the `document_retrieval_strategy` + "! field of the result set. This field is returned only if the + "! **natural_language_query** parameter is specified in the query. + CONFIDENCE type DOUBLE, + end of T_QUERY_RESULT_METADATA. + types: + "!+ "! Result document for the specified query.
+ begin of T_QUERY_RESULT, + "! The unique identifier of the document. + DOCUMENT_ID type STRING, + "! Metadata of the document. + METADATA type JSONOBJECT, + "! Metadata of a query result. + RESULT_METADATA type T_QUERY_RESULT_METADATA, + "! Passages from the document that best matches the query. Returned if + "! **passages.per_document** is `true`. + DOCUMENT_PASSAGES type STANDARD TABLE OF T_QUERY_RESULT_PASSAGE WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_RESULT. + types: + "!+ "! Column-level cells, each applicable as a header to other
+ "! cells in the same column as itself, of the current table. + begin of T_TABLE_COLUMN_HEADERS, + "! The unique ID of the cell in the current table. + CELL_ID type STRING, + "! The location of the column header cell in the current table as defined by its + "! `begin` and `end` offsets, respectfully, in the input document. + LOCATION type JSONOBJECT, + "! The textual contents of this cell from the input document without associated + "! markup content. + TEXT type STRING, + "! If you provide customization input, the normalized version of the cell text + "! according to the customization; otherwise, the same value as `text`. + TEXT_NORMALIZED type STRING, + "! The `begin` index of this cell's `row` location in the current table. + ROW_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `row` location in the current table. + ROW_INDEX_END type LONG, + "! The `begin` index of this cell's `column` location in the current table. + COLUMN_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `column` location in the current table. + COLUMN_INDEX_END type LONG, + end of T_TABLE_COLUMN_HEADERS. + types: + "!+ "! Row-level cells, each applicable as a header to other cells
+ "! in the same row as itself, of the current table. + begin of T_TABLE_ROW_HEADERS, + "! The unique ID of the cell in the current table. + CELL_ID type STRING, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + "! The textual contents of this cell from the input document without associated + "! markup content. + TEXT type STRING, + "! If you provide customization input, the normalized version of the cell text + "! according to the customization; otherwise, the same value as `text`. + TEXT_NORMALIZED type STRING, + "! The `begin` index of this cell's `row` location in the current table. + ROW_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `row` location in the current table. + ROW_INDEX_END type LONG, + "! The `begin` index of this cell's `column` location in the current table. + COLUMN_INDEX_BEGIN type LONG, + "! The `end` index of this cell's `column` location in the current table. + COLUMN_INDEX_END type LONG, + end of T_TABLE_ROW_HEADERS. + types: + "!+ "! Full table object retrieved from Table Understanding
+ "! Enrichment. + begin of T_TABLE_RESULT_TABLE, + "! The numeric location of the identified element in the document, represented with + "! two integers labeled `begin` and `end`. + LOCATION type T_TABLE_ELEMENT_LOCATION, + "! The textual contents of the current table from the input document without + "! associated markup content. + TEXT type STRING, + "! Text and associated location within a table. + SECTION_TITLE type T_TABLE_TEXT_LOCATION, + "! Text and associated location within a table. + TITLE type T_TABLE_TEXT_LOCATION, + "! An array of table-level cells that apply as headers to all the other cells in + "! the current table. + TABLE_HEADERS type STANDARD TABLE OF T_TABLE_HEADERS WITH NON-UNIQUE DEFAULT KEY, + "! An array of row-level cells, each applicable as a header to other cells in the + "! same row as itself, of the current table. + ROW_HEADERS type STANDARD TABLE OF T_TABLE_ROW_HEADERS WITH NON-UNIQUE DEFAULT KEY, + "! An array of column-level cells, each applicable as a header to other cells in + "! the same column as itself, of the current table. + COLUMN_HEADERS type STANDARD TABLE OF T_TABLE_COLUMN_HEADERS WITH NON-UNIQUE DEFAULT KEY, + "! An array of key-value pairs identified in the current table. + KEY_VALUE_PAIRS type STANDARD TABLE OF T_TABLE_KEY_VALUE_PAIRS WITH NON-UNIQUE DEFAULT KEY, + "! An array of cells that are neither table header nor column header nor row header + "! cells, of the current table with corresponding row and column header + "! associations. + BODY_CELLS type STANDARD TABLE OF T_TABLE_BODY_CELLS WITH NON-UNIQUE DEFAULT KEY, + "! An array of lists of textual entries across the document related to the current + "! table being parsed. + CONTEXTS type STANDARD TABLE OF T_TABLE_TEXT_LOCATION WITH NON-UNIQUE DEFAULT KEY, + end of T_TABLE_RESULT_TABLE. + types: + "!+ "! A tables whose content or context match a search query.
+ begin of T_QUERY_TABLE_RESULT, + "! The identifier for the retrieved table. + TABLE_ID type STRING, + "! The identifier of the document the table was retrieved from. + SOURCE_DOCUMENT_ID type STRING, + "! The identifier of the collection the table was retrieved from. + COLLECTION_ID type STRING, + "! HTML snippet of the table info. + TABLE_HTML type STRING, + "! The offset of the table html snippet in the original document html. + TABLE_HTML_OFFSET type INTEGER, + "! Full table object retrieved from Table Understanding Enrichment. + TABLE type T_TABLE_RESULT_TABLE, + end of T_QUERY_TABLE_RESULT. + types: + "!+ "! A response that contains the documents and aggregations for
+ "! the query. + begin of T_QUERY_RESPONSE, + "! The number of matching results for the query. Results that match due to a + "! curation only are not counted in the total. + MATCHING_RESULTS type INTEGER, + "! Array of document results for the query. + RESULTS type STANDARD TABLE OF T_QUERY_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! Array of aggregations for the query. + AGGREGATIONS type STANDARD TABLE OF T_QUERY_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, + "! An object contain retrieval type information. + RETRIEVAL_DETAILS type T_RETRIEVAL_DETAILS, + "! Suggested correction to the submitted **natural_language_query** value. + SUGGESTED_QUERY type STRING, + "! Array of suggested refinements. **Note**: The `suggested_refinements` parameter + "! that identified dynamic facets from the data is deprecated. + SUGGESTED_REFINEMENTS type STANDARD TABLE OF T_QUERY_SUGGESTED_REFINEMENT WITH NON-UNIQUE DEFAULT KEY, + "! Array of table results. + TABLE_RESULTS type STANDARD TABLE OF T_QUERY_TABLE_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! Passages that best match the query from across all of the collections in the + "! project. Returned if **passages.per_document** is `false`. + PASSAGES type STANDARD TABLE OF T_QUERY_RESPONSE_PASSAGE WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_RESPONSE. + types: + "!+ "! An object that contains the converted document and any
+ "! identified enrichments. Root-level fields from the original file are returned + "! also. + begin of T_ANALYZED_DOCUMENT, + "! Array of notices that are triggered when the files are processed. + NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, + "! Result of the document analysis. + RESULT type T_ANALYZED_RESULT, + end of T_ANALYZED_DOCUMENT. + types: + "!+ "! A specialized histogram aggregation that uses dates to
+ "! create interval segments. + begin of T_QUERY_TIMESLICE_AGGREGATION, + "! Specifies that the aggregation type is `timeslice`. + TYPE type STRING, + "! The date field name used to create the timeslice. + FIELD type STRING, + "! The date interval value. Valid values are seconds, minutes, hours, days, weeks, + "! and years. + INTERVAL type STRING, + "! Identifier that can optionally be specified in the query request of this + "! aggregation. + NAME type STRING, + "! Array of aggregation results. + RESULTS type STANDARD TABLE OF T_QUERY_TIMESLICE_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TIMESLICE_AGGREGATION. + types: + "!+ "! Error response information.
+ begin of T_ERROR_RESPONSE, + "! The HTTP error status code. + CODE type INTEGER, + "! A message describing the error. + ERROR type STRING, + end of T_ERROR_RESPONSE. + types: + "!+ "! An expansion definition. Each object respresents one set of
+ "! expandable strings. For example, you could have expansions for the word `hot` + "! in one object, and expansions for the word `cold` in another. Follow these + "! guidelines when you add terms:+ "! The query expansion definitions for the specified
+ "! collection. + begin of T_EXPANSIONS, + "! An array of query expansion definitions.+ "! An object that contains a new name or description for a
+ "! document classifier model. + begin of T_UPD_DOC_CLASSIFIER_MODEL, + "! A new name for the enrichment. + NAME type STRING, + "! A new description for the enrichment. + DESCRIPTION type STRING, + end of T_UPD_DOC_CLASSIFIER_MODEL. + types: + "!+ "! An object that contains an array of enrichment definitions.
+ begin of T_ENRICHMENTS, + "! An array of enrichment definitions. + ENRICHMENTS type STANDARD TABLE OF T_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY, + end of T_ENRICHMENTS. + types: + "!+ "! Information returned when a document is deleted.
+ begin of T_DELETE_DOCUMENT_RESPONSE, + "! The unique identifier of the document. + DOCUMENT_ID type STRING, + "! Status of the document. A deleted document has the status deleted. + STATUS type STRING, + end of T_DELETE_DOCUMENT_RESPONSE. + types: + "!+ "! Detects sharp and unexpected changes in the frequency of a
+ "! facet or facet value over time based on the past history of frequency changes + "! of the facet value. + begin of T_QUERY_AGGR_QUERY_TREND_AGGR, + "! Specifies that the aggregation type is `trend`. + TYPE type STRING, + "! Specifies the `term` or `group_by` aggregation for the facet that you want to + "! analyze. + FACET type STRING, + "! Specifies the `timeslice` aggregation that defines the time segments. + TIME_SEGMENTS type STRING, + "! Indicates whether to include estimated matching result information. + SHW_ESTIMATED_MATCHING_RESULTS type BOOLEAN, + "! Indicates whether to include total matching documents information. + SHOW_TOTAL_MATCHING_DOCUMENTS type BOOLEAN, + "! An array of aggregations. + RESULTS type STANDARD TABLE OF T_QUERY_TREND_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_AGGR_QUERY_TREND_AGGR. + types: + "!+ "! A modifier that narrows the document set of the
+ "! subaggregations it precedes. + begin of T_QUERY_AGGR_QUERY_FILTER_AGGR, + "! Specifies that the aggregation type is `filter`. + TYPE type STRING, + "! The filter that is written in Discovery Query Language syntax and is applied to + "! the documents before subaggregations are run. + MATCH type STRING, + "! Number of documents that match the filter. + MATCHING_RESULTS type LONG, + "! An array of subaggregations. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_AGGR_QUERY_FILTER_AGGR. + types: + "!+ "! An object that contains a new name or description for a
+ "! document classifier, updated training data, or new or updated test data. + begin of T_UPDATE_DOCUMENT_CLASSIFIER, + "! A new name for the classifier. + NAME type STRING, + "! A new description for the classifier. + DESCRIPTION type STRING, + end of T_UPDATE_DOCUMENT_CLASSIFIER. + types: + "!+ "! Array of queries with curated responses for the specified
+ "! project. + begin of T_CURATIONS, + "! The project ID of the project that contains these curations. + PROJECT_ID type STRING, + "! Array of curated queries and responses. + CURATIONS type STANDARD TABLE OF T_CURATION WITH NON-UNIQUE DEFAULT KEY, + end of T_CURATIONS. + types: + "!+ "! Detailed information about the specified project.
+ begin of T_PROJECT_CREATION, + "! The human readable name of this project. + NAME type STRING, + "! The type of project.+ "! Returns results from the field that is specified.
+ begin of T_QUERY_TERM_AGGREGATION, + "! Specifies that the aggregation type is `term`. + TYPE type STRING, + "! The field in the document where the values come from. + FIELD type STRING, + "! The number of results returned. Not returned if `relevancy:true` is specified in + "! the request. + COUNT type INTEGER, + "! Identifier specified in the query request of this aggregation. Not returned if + "! `relevancy:true` is specified in the request. + NAME type STRING, + "! An array of results. + RESULTS type STANDARD TABLE OF T_QUERY_TERM_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TERM_AGGREGATION. + types: + "!+ "! A restriction that alters the document set that is used by
+ "! the aggregations that it precedes. Subsequent aggregations are applied to + "! nested documents from the specified field. + begin of T_QUERY_NESTED_AGGREGATION, + "! Specifies that the aggregation type is `nested`. + TYPE type STRING, + "! The path to the document field to scope subsequent aggregations to. + PATH type STRING, + "! Number of nested documents found in the specified field. + MATCHING_RESULTS type LONG, + "! An array of subaggregations. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_NESTED_AGGREGATION. + types: + "!+ "! Object that contains a new name for the specified project.
+ begin of T_PROJECT_NAME, + "! The new name to give this project. + NAME type STRING, + end of T_PROJECT_NAME. + types: + "!+ "! Response object that contains an array of documents.
+ begin of T_LIST_DOCUMENTS_RESPONSE, + "! The number of matching results for the document query. + MATCHING_RESULTS type INTEGER, + "! An array that lists the documents in a collection. Only the document ID of each + "! document is returned in the list. You can use the [Get document](#getdocument) + "! method to get more information about an individual document. + DOCUMENTS type STANDARD TABLE OF T_DOCUMENT_DETAILS WITH NON-UNIQUE DEFAULT KEY, + end of T_LIST_DOCUMENTS_RESPONSE. + types: + "!+ "! Result for the `topic` aggregation.
+ begin of T_QUERY_TOPIC_AGGR_RESULT, + "! Array of subaggregations of type `term` or `group_by` and `timeslice`. Each + "! element of the matrix that is returned contains a **topic_indicator** that is + "! calculated from the combination of each aggregation value and segment of time. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TOPIC_AGGR_RESULT. + types: + "!+ "! Detects how much the frequency of a given facet value
+ "! deviates from the expected average for the given time period. This aggregation + "! type does not use data from previous time periods. It calculates an index by + "! using the averages of frequency counts of other facet values for the given time + "! period. + begin of T_QUERY_AGGR_QUERY_TOPIC_AGGR, + "! Specifies that the aggregation type is `topic`. + TYPE type STRING, + "! Specifies the `term` or `group_by` aggregation for the facet that you want to + "! analyze. + FACET type STRING, + "! Specifies the `timeslice` aggregation that defines the time segments. + TIME_SEGMENTS type STRING, + "! Indicates whether to include estimated matching result information. + SHW_ESTIMATED_MATCHING_RESULTS type BOOLEAN, + "! Indicates whether to include total matching documents information. + SHOW_TOTAL_MATCHING_DOCUMENTS type BOOLEAN, + "! An array of aggregations. + RESULTS type STANDARD TABLE OF T_QUERY_TOPIC_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_AGGR_QUERY_TOPIC_AGGR. + types: + "!+ "! Details about a specific project.
+ begin of T_PROJECT_CREATION_DETAILS, + "! The human readable name of this project. + NAME type STRING, + "! The type of project.+ "! Separates document results into groups that meet the
+ "! conditions you specify. + begin of T_QUERY_GROUP_BY_AGGREGATION, + "! Specifies that the aggregation type is `group_by`. + TYPE type STRING, + "! An array of results. + RESULTS type STANDARD TABLE OF T_QUERY_GROUP_BY_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_GROUP_BY_AGGREGATION. + types: + "!+ "! An object that manages the settings and data that is
+ "! required to train a document classification model. + begin of T_CREATE_DOCUMENT_CLASSIFIER, + "! A human-readable name of the document classifier. + NAME type STRING, + "! A description of the document classifier. + DESCRIPTION type STRING, + "! The language of the training data that is associated with the document + "! classifier. Language is specified by using the ISO 639-1 language code, such as + "! `en` for English or `ja` for Japanese. + LANGUAGE type STRING, + "! The name of the field from the training and test data that contains the + "! classification labels. + ANSWER_FIELD type STRING, + "! An array of enrichments to apply to the data that is used to train and test the + "! document classifier. The output from the enrichments is used as features by the + "! classifier to classify the document content both during training and at run + "! time. + ENRICHMENTS type STANDARD TABLE OF T_DOC_CLASSIFIER_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY, + "! An object with details for creating federated document classifier models. + FEDERATED_CLASSIFICATION type T_CLASSIFIER_FEDERATED_MODEL, + end of T_CREATE_DOCUMENT_CLASSIFIER. + types: + "!+ "! Returns results from the field that is specified.
+ begin of T_QUERY_AGGR_QUERY_TERM_AGGR, + "! Specifies that the aggregation type is `term`. + TYPE type STRING, + "! The field in the document where the values come from. + FIELD type STRING, + "! The number of results returned. Not returned if `relevancy:true` is specified in + "! the request. + COUNT type INTEGER, + "! Identifier specified in the query request of this aggregation. Not returned if + "! `relevancy:true` is specified in the request. + NAME type STRING, + "! An array of results. + RESULTS type STANDARD TABLE OF T_QUERY_TERM_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_AGGR_QUERY_TERM_AGGR. + types: + "!+ "! Detects how much the frequency of a given facet value
+ "! deviates from the expected average for the given time period. This aggregation + "! type does not use data from previous time periods. It calculates an index by + "! using the averages of frequency counts of other facet values for the given time + "! period. + begin of T_QUERY_TOPIC_AGGREGATION, + "! Specifies that the aggregation type is `topic`. + TYPE type STRING, + "! Specifies the `term` or `group_by` aggregation for the facet that you want to + "! analyze. + FACET type STRING, + "! Specifies the `timeslice` aggregation that defines the time segments. + TIME_SEGMENTS type STRING, + "! Indicates whether to include estimated matching result information. + SHW_ESTIMATED_MATCHING_RESULTS type BOOLEAN, + "! Indicates whether to include total matching documents information. + SHOW_TOTAL_MATCHING_DOCUMENTS type BOOLEAN, + "! An array of aggregations. + RESULTS type STANDARD TABLE OF T_QUERY_TOPIC_AGGR_RESULT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_TOPIC_AGGREGATION. + types: + "!+ "! Response object that contains an array of collection
+ "! details. + begin of T_LIST_COLLECTIONS_RESPONSE, + "! An array that contains information about each collection in the project. + COLLECTIONS type STANDARD TABLE OF T_COLLECTION WITH NON-UNIQUE DEFAULT KEY, + end of T_LIST_COLLECTIONS_RESPONSE. + types: + "!+ "! A modifier that narrows the document set of the
+ "! subaggregations it precedes. + begin of T_QUERY_FILTER_AGGREGATION, + "! Specifies that the aggregation type is `filter`. + TYPE type STRING, + "! The filter that is written in Discovery Query Language syntax and is applied to + "! the documents before subaggregations are run. + MATCH type STRING, + "! Number of documents that match the filter. + MATCHING_RESULTS type LONG, + "! An array of subaggregations. + AGGREGATIONS type STANDARD TABLE OF JSONOBJECT WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_FILTER_AGGREGATION. + types: + "!+ "! An object that represents the collection to be updated.
+ begin of T_UPDATE_COLLECTION, + "! The new name of the collection. + NAME type STRING, + "! The new description of the collection. + DESCRIPTION type STRING, + "! An array of enrichments that are applied to this collection. + ENRICHMENTS type STANDARD TABLE OF T_COLLECTION_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY, + end of T_UPDATE_COLLECTION. + types: + "!+ "! Object that contains notice query results.
+ begin of T_QUERY_NOTICES_RESPONSE, + "! The number of matching results. + MATCHING_RESULTS type INTEGER, + "! Array of document results that match the query. + NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, + end of T_QUERY_NOTICES_RESPONSE. + types: + "!+ "! Returns a scalar calculation across all documents for the
+ "! field specified. Possible calculations include min, max, sum, average, and + "! unique_count. + begin of T_QRY_AGGR_QRY_CLCLTN_AGGR, + "! Specifies the calculation type, such as 'average`, `max`, `min`, `sum`, or + "! `unique_count`. + TYPE type STRING, + "! The field to perform the calculation on. + FIELD type STRING, + "! The value of the calculation. + VALUE type DOUBLE, + end of T_QRY_AGGR_QRY_CLCLTN_AGGR. + +constants: + "!List of required fields per type.
+ begin of C_REQUIRED_FIELDS, + T_MDL_EVALUATION_MACRO_AVERAGE type string value '|PRECISION|RECALL|F1|', + T_PER_CLASS_MODEL_EVALUATION type string value '|NAME|PRECISION|RECALL|F1|', + T_MDL_EVALUATION_MICRO_AVERAGE type string value '|PRECISION|RECALL|F1|', + T_CLASSIFIER_MODEL_EVALUATION type string value '|MICRO_AVERAGE|MACRO_AVERAGE|PER_CLASS|', + T_DOCUMENT_CLASSIFIER_MODEL type string value '|NAME|', + T_PRJCT_LST_DTLS_RLVNCY_TRNNG1 type string value '|', + T_PROJECT_LIST_DETAILS type string value '|', + T_LIST_PROJECTS_RESPONSE type string value '|', + T_QUERY_PAIR_AGGR_RESULT type string value '|', + T_QUERY_AGGR_QUERY_PAIR_AGGR type string value '|', + T_QUERY_LARGE_TABLE_RESULTS type string value '|', + T_CURATION_RESULT type string value '|', + T_CURATED_RESULTS type string value '|', + T_TABLE_ELEMENT_LOCATION type string value '|BEGIN|END|', + T_TRAINING_EXAMPLE type string value '|DOCUMENT_ID|COLLECTION_ID|RELEVANCE|', + T_TRAINING_QUERY type string value '|NATURAL_LANGUAGE_QUERY|EXAMPLES|', + T_TABLE_CELL_VALUES type string value '|', + T_TABLE_CELL_KEY type string value '|', + T_TABLE_KEY_VALUE_PAIRS type string value '|', + T_CURATION_STATUS type string value '|', + T_QUERY_TOP_HITS_AGGR_RESULT type string value '|MATCHING_RESULTS|', + T_CURATION type string value '|', + T_CMPNNT_STTNGS_FLDS_SHWN_TTL type string value '|', + T_COMPONENT_SETTINGS_AGGR type string value '|', + T_CMPNNT_STTNGS_FLDS_SHWN_BODY type string value '|', + T_CMPNNT_SETTINGS_FIELDS_SHOWN type string value '|', + T_COMPONENT_SETTINGS_RESPONSE type string value '|', + T_DFLT_QRY_PRMS_SGGSTD_RFNMNTS type string value '|', + T_DFLT_QRY_PARAMS_TAB_RESULTS type string value '|', + T_DFLT_QUERY_PARAMS_PASSAGES type string value '|', + T_DEFAULT_QUERY_PARAMS type string value '|', + T_PROJECT_DETAILS type string value '|', + T_DOCUMENT_ACCEPTED type string value '|', + T_QUERY_TREND_AGGR_RESULT type string value '|', + T_QUERY_TREND_AGGREGATION type string value '|', + T_RESULT_PASSAGE_ANSWER type string value '|', + T_QUERY_RESPONSE_PASSAGE type string value '|', + T_DOC_CLASSIFIER_MODEL_TRAIN type string value '|NAME|', + T_QUERY_PAIR_AGGREGATION type string value '|', + T_QUERY_CALCULATION_AGGR type string value '|FIELD|', + T_CLLCTN_DTLS_SMRT_DOC_UNDRST1 type string value '|', + T_COLLECTION_ENRICHMENT type string value '|', + T_COLLECTION_DETAILS type string value '|NAME|', + T_CLASSIFIER_FEDERATED_MODEL type string value '|FIELD|', + T_DOC_CLASSIFIER_ENRICHMENT type string value '|ENRICHMENT_ID|FIELDS|', + T_DOCUMENT_CLASSIFIER type string value '|NAME|', + T_DOCUMENT_CLASSIFIERS type string value '|', + T_QUERY_TERM_AGGR_RESULT type string value '|KEY|MATCHING_RESULTS|', + T_TABLE_COLUMN_HEADER_IDS type string value '|', + T_QUERY_TIMESLICE_AGGR_RESULT type string value '|KEY_AS_STRING|KEY|MATCHING_RESULTS|', + T_QRY_AGGR_QRY_TIMESLICE_AGGR type string value '|FIELD|INTERVAL|', + T_FIELD type string value '|', + T_QUERY_LARGE_SIMILAR type string value '|', + T_QUERY_HISTOGRAM_AGGR_RESULT type string value '|KEY|MATCHING_RESULTS|', + T_QUERY_HISTOGRAM_AGGREGATION type string value '|FIELD|INTERVAL|', + T_TABLE_ROW_HEADER_IDS type string value '|', + T_PROJECT_REL_TRAIN_STATUS type string value '|', + T_QRY_AGGR_QRY_HISTOGRAM_AGGR type string value '|FIELD|INTERVAL|', + T_ANALYZED_RESULT type string value '|', + T_QUERY_LARGE_PASSAGES type string value '|', + T_QRY_LRG_SGGSTD_REFINEMENTS type string value '|', + T_QUERY_LARGE type string value '|', + T_ENRICHMENT_OPTIONS type string value '|', + T_ENRICHMENT type string value '|', + T_QUERY_GROUP_BY_AGGR_RESULT type string value '|KEY|MATCHING_RESULTS|', + T_QRY_AGGR_QUERY_GROUP_BY_AGGR type string value '|', + T_COLLECTION type string value '|', + T_DOCUMENT_CLASSIFIER_MODELS type string value '|', + T_TAB_ROW_HEADER_TEXTS_NORM type string value '|', + T_DOCUMENT_ATTRIBUTE type string value '|', + T_TABLE_ROW_HEADER_TEXTS type string value '|', + T_TABLE_COLUMN_HEADER_TEXTS type string value '|', + T_TAB_COLUMN_HEADER_TEXTS_NORM type string value '|', + T_TABLE_BODY_CELLS type string value '|', + T_TABLE_TEXT_LOCATION type string value '|', + T_QUERY_TOP_HITS_AGGREGATION type string value '|SIZE|', + T_DOCUMENT_DETAILS_CHILDREN type string value '|', + T_NOTICE type string value '|', + T_DOCUMENT_DETAILS type string value '|', + T_QUERY_AGGR_QUERY_NESTED_AGGR type string value '|PATH|MATCHING_RESULTS|', + T_COMPLETIONS type string value '|', + T_UPDATE_ENRICHMENT type string value '|NAME|', + T_QUERY_SUGGESTED_REFINEMENT type string value '|', + T_TABLE_HEADERS type string value '|', + T_RETRIEVAL_DETAILS type string value '|', + T_CREATE_ENRICHMENT type string value '|', + T_LIST_FIELDS_RESPONSE type string value '|', + T_QRY_AGGR_QUERY_TOP_HITS_AGGR type string value '|SIZE|', + T_QUERY_RESULT_PASSAGE type string value '|', + T_STOP_WORD_LIST type string value '|STOPWORDS|', + T_TRAINING_QUERY_SET type string value '|', + T_QUERY_RESULT_METADATA type string value '|COLLECTION_ID|', + T_QUERY_RESULT type string value '|DOCUMENT_ID|RESULT_METADATA|', + T_TABLE_COLUMN_HEADERS type string value '|', + T_TABLE_ROW_HEADERS type string value '|', + T_TABLE_RESULT_TABLE type string value '|', + T_QUERY_TABLE_RESULT type string value '|', + T_QUERY_RESPONSE type string value '|', + T_ANALYZED_DOCUMENT type string value '|', + T_QUERY_TIMESLICE_AGGREGATION type string value '|FIELD|INTERVAL|', + T_ERROR_RESPONSE type string value '|CODE|ERROR|', + T_EXPANSION type string value '|EXPANDED_TERMS|', + T_EXPANSIONS type string value '|EXPANSIONS|', + T_UPD_DOC_CLASSIFIER_MODEL type string value '|', + T_ENRICHMENTS type string value '|', + T_DELETE_DOCUMENT_RESPONSE type string value '|', + T_QUERY_AGGR_QUERY_TREND_AGGR type string value '|', + T_QUERY_AGGR_QUERY_FILTER_AGGR type string value '|MATCH|MATCHING_RESULTS|', + T_UPDATE_DOCUMENT_CLASSIFIER type string value '|', + T_CURATIONS type string value '|', + T_PROJECT_CREATION type string value '|NAME|TYPE|', + T_QUERY_TERM_AGGREGATION type string value '|', + T_QUERY_NESTED_AGGREGATION type string value '|PATH|MATCHING_RESULTS|', + T_PROJECT_NAME type string value '|', + T_LIST_DOCUMENTS_RESPONSE type string value '|', + T_QUERY_TOPIC_AGGR_RESULT type string value '|', + T_QUERY_AGGR_QUERY_TOPIC_AGGR type string value '|', + T_PROJECT_CREATION_DETAILS type string value '|NAME|TYPE|', + T_QUERY_GROUP_BY_AGGREGATION type string value '|', + T_CREATE_DOCUMENT_CLASSIFIER type string value '|NAME|LANGUAGE|ANSWER_FIELD|', + T_QUERY_AGGR_QUERY_TERM_AGGR type string value '|', + T_QUERY_TOPIC_AGGREGATION type string value '|', + T_LIST_COLLECTIONS_RESPONSE type string value '|', + T_QUERY_FILTER_AGGREGATION type string value '|MATCH|MATCHING_RESULTS|', + T_UPDATE_COLLECTION type string value '|', + T_QUERY_NOTICES_RESPONSE type string value '|', + T_QRY_AGGR_QRY_CLCLTN_AGGR type string value '|FIELD|', + __DUMMY type string value SPACE, + end of C_REQUIRED_FIELDS . + +constants: + "!Map ABAP identifiers to service identifiers.
+ begin of C_ABAPNAME_DICTIONARY, + COLLECTIONS type string value 'collections', + MATCHING_RESULTS type string value 'matching_results', + DOCUMENTS type string value 'documents', + BEGIN type string value 'begin', + END type string value 'end', + RESULTS type string value 'results', + AGGREGATIONS type string value 'aggregations', + RETRIEVAL_DETAILS type string value 'retrieval_details', + SUGGESTED_QUERY type string value 'suggested_query', + SUGGESTED_REFINEMENTS type string value 'suggested_refinements', + TABLE_RESULTS type string value 'table_results', + PASSAGES type string value 'passages', + DOCUMENT_ID type string value 'document_id', + METADATA type string value 'metadata', + INNER type string value 'inner', + RESULT_METADATA type string value 'result_metadata', + DOCUMENT_PASSAGES type string value 'document_passages', + DOCUMENT_RETRIEVAL_SOURCE type string value 'document_retrieval_source', + COLLECTION_ID type string value 'collection_id', + CONFIDENCE type string value 'confidence', + PASSAGE_TEXT type string value 'passage_text', + START_OFFSET type string value 'start_offset', + END_OFFSET type string value 'end_offset', + FIELD type string value 'field', + ANSWERS type string value 'answers', + PASSAGE_SCORE type string value 'passage_score', + TABLE_ID type string value 'table_id', + SOURCE_DOCUMENT_ID type string value 'source_document_id', + TABLE_HTML type string value 'table_html', + TABLE_HTML_OFFSET type string value 'table_html_offset', + TABLE type string value 'table', + TEXT type string value 'text', + TYPE type string value 'type', + COUNT type string value 'count', + NAME type string value 'name', + KEY type string value 'key', + RELEVANCY type string value 'relevancy', + TOTAL_MATCHING_DOCUMENTS type string value 'total_matching_documents', + ESTIMATED_MATCHING_RESULTS type string value 'estimated_matching_results', + INTERVAL type string value 'interval', + KEY_AS_STRING type string value 'key_as_string', + PATH type string value 'path', + MATCH type string value 'match', + VALUE type string value 'value', + SIZE type string value 'size', + HITS type string value 'hits', + FIRST type string value 'first', + SECOND type string value 'second', + SHW_ESTIMATED_MATCHING_RESULTS type string value 'show_estimated_matching_results', + SHOW_TOTAL_MATCHING_DOCUMENTS type string value 'show_total_matching_documents', + FACET type string value 'facet', + TIME_SEGMENTS type string value 'time_segments', + CELL_ID type string value 'cell_id', + LOCATION type string value 'location', + ROW_INDEX_BEGIN type string value 'row_index_begin', + ROW_INDEX_END type string value 'row_index_end', + COLUMN_INDEX_BEGIN type string value 'column_index_begin', + COLUMN_INDEX_END type string value 'column_index_end', + TEXT_NORMALIZED type string value 'text_normalized', + ROW_HEADER_IDS type string value 'row_header_ids', + ROW_HEADER_TEXTS type string value 'row_header_texts', + ROW_HEADER_TEXTS_NORMALIZED type string value 'row_header_texts_normalized', + COLUMN_HEADER_IDS type string value 'column_header_ids', + COLUMN_HEADER_TEXTS type string value 'column_header_texts', + COLUMN_HEADER_TEXTS_NORMALIZED type string value 'column_header_texts_normalized', + ATTRIBUTES type string value 'attributes', + ID type string value 'id', + SECTION_TITLE type string value 'section_title', + TITLE type string value 'title', + TABLE_HEADERS type string value 'table_headers', + ROW_HEADERS type string value 'row_headers', + COLUMN_HEADERS type string value 'column_headers', + KEY_VALUE_PAIRS type string value 'key_value_pairs', + BODY_CELLS type string value 'body_cells', + CONTEXTS type string value 'contexts', + CODE type string value 'code', + ERROR type string value 'error', + COLLECTION_IDS type string value 'collection_ids', + FILTER type string value 'filter', + QUERY type string value 'query', + NATURAL_LANGUAGE_QUERY type string value 'natural_language_query', + AGGREGATION type string value 'aggregation', + RETURN type string value 'return', + RETURN_FIELD type string value 'return_field', + OFFSET type string value 'offset', + SORT type string value 'sort', + HIGHLIGHT type string value 'highlight', + SPELLING_SUGGESTIONS type string value 'spelling_suggestions', + SIMILAR type string value 'similar', + DOCUMENT_RETRIEVAL_STRATEGY type string value 'document_retrieval_strategy', + COMPLETIONS type string value 'completions', + FIELDS_SHOWN type string value 'fields_shown', + AUTOCOMPLETE type string value 'autocomplete', + STRUCTURED_SEARCH type string value 'structured_search', + RESULTS_PER_PAGE type string value 'results_per_page', + BODY type string value 'body', + USE_PASSAGE type string value 'use_passage', + LABEL type string value 'label', + MULTIPLE_SELECTIONS_ALLOWED type string value 'multiple_selections_allowed', + VISUALIZATION_TYPE type string value 'visualization_type', + STATUS type string value 'status', + QUERY_ID type string value 'query_id', + CREATED type string value 'created', + UPDATED type string value 'updated', + EXAMPLES type string value 'examples', + RELEVANCE type string value 'relevance', + QUERIES type string value 'queries', + FIELDS type string value 'fields', + NOTICES type string value 'notices', + NOTICE_ID type string value 'notice_id', + SEVERITY type string value 'severity', + STEP type string value 'step', + DESCRIPTION type string value 'description', + PROJECT_ID type string value 'project_id', + CURATIONS type string value 'curations', + CURATION_ID type string value 'curation_id', + CURATED_RESULTS type string value 'curated_results', + SNIPPET type string value 'snippet', + LANGUAGE type string value 'language', + ENRICHMENTS type string value 'enrichments', + SMART_DOCUMENT_UNDERSTANDING type string value 'smart_document_understanding', + CHILDREN type string value 'children', + FILENAME type string value 'filename', + FILE_TYPE type string value 'file_type', + SHA256 type string value 'sha256', + ENRICHMENT_ID type string value 'enrichment_id', + PROJECTS type string value 'projects', + RELEVANCY_TRAINING_STATUS type string value 'relevancy_training_status', + COLLECTION_COUNT type string value 'collection_count', + DEFAULT_QUERY_PARAMETERS type string value 'default_query_parameters', + DATA_UPDATED type string value 'data_updated', + TOTAL_EXAMPLES type string value 'total_examples', + SUFFICIENT_LABEL_DIVERSITY type string value 'sufficient_label_diversity', + PROCESSING type string value 'processing', + MINIMUM_EXAMPLES_ADDED type string value 'minimum_examples_added', + SUCCESSFULLY_TRAINED type string value 'successfully_trained', + AVAILABLE type string value 'available', + MINIMUM_QUERIES_ADDED type string value 'minimum_queries_added', + OPTIONS type string value 'options', + LANGUAGES type string value 'languages', + ENTITY_TYPE type string value 'entity_type', + REGULAR_EXPRESSION type string value 'regular_expression', + RESULT_FIELD type string value 'result_field', + CLASSIFIER_ID type string value 'classifier_id', + MODEL_ID type string value 'model_id', + CONFIDENCE_THRESHOLD type string value 'confidence_threshold', + TOP_K type string value 'top_k', + RESULT type string value 'result', + ANSWER_TEXT type string value 'answer_text', + CLASSIFIERS type string value 'classifiers', + RECOGNIZED_FIELDS type string value 'recognized_fields', + ANSWER_FIELD type string value 'answer_field', + TRAINING_DATA_FILE type string value 'training_data_file', + TEST_DATA_FILE type string value 'test_data_file', + FEDERATED_CLASSIFICATION type string value 'federated_classification', + MODELS type string value 'models', + EVALUATION type string value 'evaluation', + DEPLOYED_AT type string value 'deployed_at', + MICRO_AVERAGE type string value 'micro_average', + MACRO_AVERAGE type string value 'macro_average', + PER_CLASS type string value 'per_class', + PRECISION type string value 'precision', + RECALL type string value 'recall', + F1 type string value 'f1', + LEARNING_RATE type string value 'learning_rate', + L1_REGULARIZATION_STRENGTHS type string value 'l1_regularization_strengths', + L2_REGULARIZATION_STRENGTHS type string value 'l2_regularization_strengths', + TRAINING_MAX_STEPS type string value 'training_max_steps', + IMPROVEMENT_RATIO type string value 'improvement_ratio', + STOPWORDS type string value 'stopwords', + EXPANSIONS type string value 'expansions', + INPUT_TERMS type string value 'input_terms', + EXPANDED_TERMS type string value 'expanded_terms', + HAVE_NOTICES type string value 'have_notices', + ENABLED type string value 'enabled', + CHARACTERS type string value 'characters', + PER_DOCUMENT type string value 'per_document', + MAX_PER_DOCUMENT type string value 'max_per_document', + FIND_ANSWERS type string value 'find_answers', + MAX_ANSWERS_PER_PASSAGE type string value 'max_answers_per_passage', + DOCUMENT_IDS type string value 'document_ids', + MODEL type string value 'model', + end of C_ABAPNAME_DICTIONARY . + + + methods GET_APPNAME + redefinition . + methods GET_REQUEST_PROP + redefinition . + methods GET_SDK_VERSION_DATE + redefinition . + + + "!List projects
+ "! Lists existing projects for this instance. + "! + "! @parameter E_RESPONSE | + "! Service return value of type T_LIST_PROJECTS_RESPONSE + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_PROJECTS + importing + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_LIST_PROJECTS_RESPONSE + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create a project
+ "! Create a new project for this instance + "! + "! @parameter I_PROJECTCREATION | + "! An object that represents the project to be created. + "! @parameter E_RESPONSE | + "! Service return value of type T_PROJECT_DETAILS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods CREATE_PROJECT + importing + !I_PROJECTCREATION type T_PROJECT_CREATION + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_PROJECT_DETAILS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Get project
+ "! Get details on the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter E_RESPONSE | + "! Service return value of type T_PROJECT_DETAILS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_PROJECT + importing + !I_PROJECT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_PROJECT_DETAILS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update a project
+ "! Update the specified project's name. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_PROJECTNAME | + "! An object that represents the new name of the project. + "! @parameter E_RESPONSE | + "! Service return value of type T_PROJECT_DETAILS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_PROJECT + importing + !I_PROJECT_ID type STRING + !I_PROJECTNAME type T_PROJECT_NAME optional + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_PROJECT_DETAILS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete a project
+ "! Deletes the specified project.List fields
+ "! Gets a list of the unique fields (and their types) stored in the specified + "! collections. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_IDS | + "! Comma separated list of the collection IDs. If this parameter is not specified, + "! all collections in the project are used. + "! @parameter E_RESPONSE | + "! Service return value of type T_LIST_FIELDS_RESPONSE + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_FIELDS + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_IDS type TT_STRING optional + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_LIST_FIELDS_RESPONSE + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!List collections
+ "! Lists existing collections for the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter E_RESPONSE | + "! Service return value of type T_LIST_COLLECTIONS_RESPONSE + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_COLLECTIONS + importing + !I_PROJECT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_LIST_COLLECTIONS_RESPONSE + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create a collection
+ "! Create a new collection in the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTIONDETAILS | + "! An object that represents the collection to be created. + "! @parameter E_RESPONSE | + "! Service return value of type T_COLLECTION_DETAILS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods CREATE_COLLECTION + importing + !I_PROJECT_ID type STRING + !I_COLLECTIONDETAILS type T_COLLECTION_DETAILS + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_COLLECTION_DETAILS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Get collection
+ "! Get details about the specified collection. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @parameter E_RESPONSE | + "! Service return value of type T_COLLECTION_DETAILS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_COLLECTION + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_COLLECTION_DETAILS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update a collection
+ "! Updates the specified collection's name, description, and enrichments. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @parameter I_UPDATECOLLECTION | + "! An object that represents the collection to be updated. + "! @parameter E_RESPONSE | + "! Service return value of type T_COLLECTION_DETAILS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_COLLECTION + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + !I_UPDATECOLLECTION type T_UPDATE_COLLECTION + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_COLLECTION_DETAILS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete a collection
+ "! Deletes the specified collection from the project. All documents stored in the + "! specified collection and not shared is also deleted. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_COLLECTION + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!List documents
+ "! Lists the documents in the specified collection. The list includes only the + "! document ID of each document and returns information for up to 10,000 + "! documents.Add a document
+ "! Add a document to a collection with optional metadata.Get document details
+ "! Get details about a specific document, whether the document is added by + "! uploading a file or by crawling an external data source.Update a document
+ "! Replace an existing document or add a document with a specified document ID. + "! Starts ingesting a document with optional metadata.Delete a document
+ "! Deletes the document with the document ID that you specify from the collection. + "! Removes uploaded documents from the collection permanently. If you delete a + "! document that was added by crawling an external data source, the document will + "! be added again with the next scheduled crawl of the data source. The delete + "! function removes the document from the collection, not from the external data + "! source.Query a project
+ "! Search your data by submitting queries that are written in natural language or + "! formatted in the Discovery Query Language. For more information, see the + "! [Discovery + "! documentation](/docs/discovery-data?topic=discovery-data-query-concepts). The + "! default query parameters differ by project type. For more information about the + "! project default settings, see the [Discovery + "! documentation](/docs/discovery-data?topic=discovery-data-query-defaults). See + "! [the Projects API documentation](#create-project) for details about how to set + "! custom default query settings.Get Autocomplete Suggestions
+ "! Returns completion query suggestions for the specified prefix. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_PREFIX | + "! The prefix to use for autocompletion. For example, the prefix `Ho` could + "! autocomplete to `hot`, `housing`, or `how`. + "! @parameter I_COLLECTION_IDS | + "! Comma separated list of the collection IDs. If this parameter is not specified, + "! all collections in the project are used. + "! @parameter I_FIELD | + "! The field in the result documents that autocompletion suggestions are identified + "! from. + "! @parameter I_COUNT | + "! The number of autocompletion suggestions to return. + "! @parameter E_RESPONSE | + "! Service return value of type T_COMPLETIONS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_AUTOCOMPLETION + importing + !I_PROJECT_ID type STRING + !I_PREFIX type STRING + !I_COLLECTION_IDS type TT_STRING optional + !I_FIELD type STRING optional + !I_COUNT type INTEGER default 5 + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_COMPLETIONS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Query collection notices
+ "! Finds collection-level notices (errors and warnings) that are generated when + "! documents are ingested. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @parameter I_FILTER | + "! Searches for documents that match the Discovery Query Language criteria that is + "! specified as input. Filter calls are cached and are faster than query calls + "! because the results are not ordered by relevance. When used with the + "! `aggregation`, `query`, or `natural_language_query` parameters, the `filter` + "! parameter runs first. This parameter is useful for limiting results to those + "! that contain specific metadata values. + "! @parameter I_QUERY | + "! A query search that is written in the Discovery Query Language and returns all + "! matching documents in your data set with full enrichments and full text, and + "! with the most relevant documents listed first. + "! @parameter I_NATURAL_LANGUAGE_QUERY | + "! A natural language query that returns relevant documents by using training data + "! and natural language understanding. + "! @parameter I_COUNT | + "! Number of results to return. The maximum for the **count** and **offset** values + "! together in any one query is **10,000**. + "! @parameter I_OFFSET | + "! The number of query results to skip at the beginning. For example, if the total + "! number of results that are returned is 10 and the offset is 8, it returns the + "! last two results. The maximum for the **count** and **offset** values together + "! in any one query is **10000**. + "! @parameter E_RESPONSE | + "! Service return value of type T_QUERY_NOTICES_RESPONSE + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods QUERY_COLLECTION_NOTICES + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + !I_FILTER type STRING optional + !I_QUERY type STRING optional + !I_NATURAL_LANGUAGE_QUERY type STRING optional + !I_COUNT type INTEGER default 10 + !I_OFFSET type INTEGER optional + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_QUERY_NOTICES_RESPONSE + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Query project notices
+ "! Finds project-level notices (errors and warnings). Currently, project-level + "! notices are generated by relevancy training. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_FILTER | + "! Searches for documents that match the Discovery Query Language criteria that is + "! specified as input. Filter calls are cached and are faster than query calls + "! because the results are not ordered by relevance. When used with the + "! `aggregation`, `query`, or `natural_language_query` parameters, the `filter` + "! parameter runs first. This parameter is useful for limiting results to those + "! that contain specific metadata values. + "! @parameter I_QUERY | + "! A query search that is written in the Discovery Query Language and returns all + "! matching documents in your data set with full enrichments and full text, and + "! with the most relevant documents listed first. + "! @parameter I_NATURAL_LANGUAGE_QUERY | + "! A natural language query that returns relevant documents by using training data + "! and natural language understanding. + "! @parameter I_COUNT | + "! Number of results to return. The maximum for the **count** and **offset** values + "! together in any one query is **10,000**. + "! @parameter I_OFFSET | + "! The number of query results to skip at the beginning. For example, if the total + "! number of results that are returned is 10 and the offset is 8, it returns the + "! last two results. The maximum for the **count** and **offset** values together + "! in any one query is **10000**. + "! @parameter E_RESPONSE | + "! Service return value of type T_QUERY_NOTICES_RESPONSE + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods QUERY_NOTICES + importing + !I_PROJECT_ID type STRING + !I_FILTER type STRING optional + !I_QUERY type STRING optional + !I_NATURAL_LANGUAGE_QUERY type STRING optional + !I_COUNT type INTEGER default 10 + !I_OFFSET type INTEGER optional + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_QUERY_NOTICES_RESPONSE + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!Get a custom stop words list
+ "! Returns the custom stop words list that is used by the collection. For + "! information about the default stop words lists that are applied to queries, see + "! [the product + "! documentation](/docs/discovery-data?topic=discovery-data-stopwords). + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @parameter E_RESPONSE | + "! Service return value of type T_STOP_WORD_LIST + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_STOPWORD_LIST + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_STOP_WORD_LIST + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create a custom stop words list
+ "! Adds a list of custom stop words. Stop words are words that you want the service + "! to ignore when they occur in a query because they're not useful in + "! distinguishing the semantic meaning of the query. The stop words list cannot + "! contain more than 1 million characters.Delete a custom stop words list
+ "! Deletes a custom stop words list to stop using it in queries against the + "! collection. After a custom stop words list is deleted, the default stop words + "! list is used. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_STOPWORD_LIST + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Get the expansion list
+ "! Returns the current expansion list for the specified collection. If an expansion + "! list is not specified, an empty expansions array is returned. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @parameter E_RESPONSE | + "! Service return value of type T_EXPANSIONS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_EXPANSIONS + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_EXPANSIONS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create or update an expansion list
+ "! Creates or replaces the expansion list for this collection. An expansion list + "! introduces alternative wording for key terms that are mentioned in your + "! collection. By identifying synonyms or common misspellings, you expand the + "! scope of a query beyond exact matches. The maximum number of expanded terms + "! allowed per collection is 5,000. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @parameter I_BODY | + "! An object that defines the expansion list. + "! @parameter E_RESPONSE | + "! Service return value of type T_EXPANSIONS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods CREATE_EXPANSIONS + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + !I_BODY type T_EXPANSIONS + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_EXPANSIONS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete the expansion list
+ "! Removes the expansion information for this collection. To disable query + "! expansion for a collection, delete the expansion list. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_COLLECTION_ID | + "! The ID of the collection. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_EXPANSIONS + importing + !I_PROJECT_ID type STRING + !I_COLLECTION_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!List component settings
+ "! Returns default configuration settings for components. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter E_RESPONSE | + "! Service return value of type T_COMPONENT_SETTINGS_RESPONSE + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_COMPONENT_SETTINGS + importing + !I_PROJECT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_COMPONENT_SETTINGS_RESPONSE + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!List training queries
+ "! List the training queries for the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter E_RESPONSE | + "! Service return value of type T_TRAINING_QUERY_SET + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_TRAINING_QUERIES + importing + !I_PROJECT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_TRAINING_QUERY_SET + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete training queries
+ "! Removes all training queries for the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_TRAINING_QUERIES + importing + !I_PROJECT_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create training query
+ "! Add a query to the training data for this project. The query can contain a + "! filter and natural language query. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_TRAININGQUERY | + "! An object that represents the query to be submitted. At least 50 queries are + "! required for training to begin. A maximum of 10,000 queries are allowed. + "! @parameter E_RESPONSE | + "! Service return value of type T_TRAINING_QUERY + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods CREATE_TRAINING_QUERY + importing + !I_PROJECT_ID type STRING + !I_TRAININGQUERY type T_TRAINING_QUERY + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_TRAINING_QUERY + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Get a training data query
+ "! Get details for a specific training data query, including the query string and + "! all examples + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_QUERY_ID | + "! The ID of the query used for training. + "! @parameter E_RESPONSE | + "! Service return value of type T_TRAINING_QUERY + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_TRAINING_QUERY + importing + !I_PROJECT_ID type STRING + !I_QUERY_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_TRAINING_QUERY + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update a training query
+ "! Updates an existing training query and it's examples. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_QUERY_ID | + "! The ID of the query used for training. + "! @parameter I_BODY | + "! The body of the example that is to be added to the specified query. + "! @parameter E_RESPONSE | + "! Service return value of type T_TRAINING_QUERY + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_TRAINING_QUERY + importing + !I_PROJECT_ID type STRING + !I_QUERY_ID type STRING + !I_BODY type T_TRAINING_QUERY + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_TRAINING_QUERY + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete a training data query
+ "! Removes details from a training data query, including the query string and all + "! examples. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_QUERY_ID | + "! The ID of the query used for training. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_TRAINING_QUERY + importing + !I_PROJECT_ID type STRING + !I_QUERY_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!List enrichments
+ "! Lists the enrichments available to this project. The *Part of Speech* and + "! *Sentiment of Phrases* enrichments might be listed, but are reserved for + "! internal use only. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter E_RESPONSE | + "! Service return value of type T_ENRICHMENTS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_ENRICHMENTS + importing + !I_PROJECT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_ENRICHMENTS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create an enrichment
+ "! Create an enrichment for use with the specified project. To apply the enrichment + "! to a collection in the project, use the [Collections + "! API](/apidocs/discovery-data#createcollection). + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_ENRICHMENT | + "! Information about a specific enrichment. + "! @parameter I_FILE | + "! The enrichment file to upload. Expected file types per enrichment are as + "! follows:Get enrichment
+ "! Get details about a specific enrichment. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_ENRICHMENT_ID | + "! The ID of the enrichment. + "! @parameter E_RESPONSE | + "! Service return value of type T_ENRICHMENT + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_ENRICHMENT + importing + !I_PROJECT_ID type STRING + !I_ENRICHMENT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_ENRICHMENT + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update an enrichment
+ "! Updates an existing enrichment's name and description. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_ENRICHMENT_ID | + "! The ID of the enrichment. + "! @parameter I_UPDATEENRICHMENT | + "! An object that lists the new name and description for an enrichment. + "! @parameter E_RESPONSE | + "! Service return value of type T_ENRICHMENT + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_ENRICHMENT + importing + !I_PROJECT_ID type STRING + !I_ENRICHMENT_ID type STRING + !I_UPDATEENRICHMENT type T_UPDATE_ENRICHMENT + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_ENRICHMENT + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete an enrichment
+ "! Deletes an existing enrichment from the specified project.List document classifiers
+ "! Get a list of the document classifiers in a project. Returns only the name and + "! classifier ID of each document classifier. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter E_RESPONSE | + "! Service return value of type T_DOCUMENT_CLASSIFIERS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_DOCUMENT_CLASSIFIERS + importing + !I_PROJECT_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DOCUMENT_CLASSIFIERS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create a document classifier
+ "! Create a document classifier. You can use the API to create a document + "! classifier in any project type. After you create a document classifier, you can + "! use the Enrichments API to create a classifier enrichment, and then the + "! Collections API to apply the enrichment to a collection in the project.Get a document classifier
+ "! Get details about a specific document classifier. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @parameter E_RESPONSE | + "! Service return value of type T_DOCUMENT_CLASSIFIER + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_DOCUMENT_CLASSIFIER + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DOCUMENT_CLASSIFIER + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update a document classifier
+ "! Update the document classifier name or description, update the training data, or + "! add or update the test data. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @parameter I_CLASSIFIER | + "! An object that contains a new name or description for a document classifier, + "! updated training data, or new or updated test data. + "! @parameter I_TRAINING_DATA | + "! The training data CSV file to upload. The CSV file must have headers. The file + "! must include a field that contains the text you want to classify and a field + "! that contains the classification labels that you want to use to classify your + "! data. If you want to specify multiple values in a single column, use a + "! semicolon as the value separator. For a sample file, see [the product + "! documentation](/docs/discovery-data?topic=discovery-data-cm-doc-classifier). + "! @parameter I_TEST_DATA | + "! The CSV with test data to upload. The column values in the test file must be the + "! same as the column values in the training data file. If no test data is + "! provided, the training data is split into two separate groups of training and + "! test data. + "! @parameter E_RESPONSE | + "! Service return value of type T_DOCUMENT_CLASSIFIER + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_DOCUMENT_CLASSIFIER + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + !I_CLASSIFIER type T_UPDATE_DOCUMENT_CLASSIFIER + !I_TRAINING_DATA type FILE optional + !I_TEST_DATA type FILE optional + !I_TRAINING_DATA_CT type STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL + !I_TEST_DATA_CT type STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL + !I_contenttype type string default 'multipart/form-data' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DOCUMENT_CLASSIFIER + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete a document classifier
+ "! Deletes an existing document classifier from the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_DOCUMENT_CLASSIFIER + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!List document classifier models
+ "! Get a list of the document classifier models in a project. Returns only the name + "! and model ID of each document classifier model. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @parameter E_RESPONSE | + "! Service return value of type T_DOCUMENT_CLASSIFIER_MODELS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LST_DOCUMENT_CLASSIFIER_MODELS + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DOCUMENT_CLASSIFIER_MODELS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Create a document classifier model
+ "! Create a document classifier model by training a model that uses the data and + "! classifier settings defined in the specified document classifier.Get a document classifier model
+ "! Get details about a specific document classifier model. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @parameter I_MODEL_ID | + "! The ID of the classifier model. + "! @parameter E_RESPONSE | + "! Service return value of type T_DOCUMENT_CLASSIFIER_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_DOCUMENT_CLASSIFIER_MODEL + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + !I_MODEL_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DOCUMENT_CLASSIFIER_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update a document classifier model
+ "! Update the document classifier model name or description. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @parameter I_MODEL_ID | + "! The ID of the classifier model. + "! @parameter I_UPDTDCMNTCLSSFRMDL | + "! An object that lists a new name or description for a document classifier model. + "! @parameter E_RESPONSE | + "! Service return value of type T_DOCUMENT_CLASSIFIER_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPD_DOCUMENT_CLASSIFIER_MODEL + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + !I_MODEL_ID type STRING + !I_UPDTDCMNTCLSSFRMDL type T_UPD_DOC_CLASSIFIER_MODEL + !I_contenttype type string default 'application/json' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DOCUMENT_CLASSIFIER_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete a document classifier model
+ "! Deletes an existing document classifier model from the specified project. + "! + "! @parameter I_PROJECT_ID | + "! The ID of the project. This information can be found from the *Integrate and + "! Deploy* page in Discovery. + "! @parameter I_CLASSIFIER_ID | + "! The ID of the classifier. + "! @parameter I_MODEL_ID | + "! The ID of the classifier model. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DEL_DOCUMENT_CLASSIFIER_MODEL + importing + !I_PROJECT_ID type STRING + !I_CLASSIFIER_ID type STRING + !I_MODEL_ID type STRING + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + "!Analyze a Document
+ "! Process a document and return it for realtime use. Supports JSON files + "! only.Delete labeled data
+ "! Deletes all data associated with a specified customer ID. The method has no + "! effect if no data is associated with the customer ID.Get model details
"! Gets information about a translation model, including training status for custom - "! models. Use this API call to poll the status of your customization request. A - "! successfully completed training has a status of `available`. + "! models. Use this method to poll the status of your customization request. A + "! successfully completed training request has a status of `available`. "! "! @parameter I_MODEL_ID | "! Model ID of the model to get. @@ -672,18 +690,50 @@ constants: ZCX_IBMC_SERVICE_EXCEPTION . "!Translate document
"! Submit a document for translation. You can submit the document contents in the - "! `file` parameter, or you can reference a previously submitted document by + "! `file` parameter, or you can specify a previously submitted document by "! document ID. The maximum file size for document translation isNatural Language Classifier
-"! IBM Watson™ Natural Language Classifier uses machine learning algorithms -"! to return the top matching predefined classes for short text input. You create -"! and train a classifier to connect predefined classes to example texts so that -"! the service can apply those classes to new inputs.- "! Response payload for HTTP errors.
- begin of T_ERROR_RESPONSE, - "! HTTP status code. - CODE type INTEGER, - "! Error name. - ERROR type STRING, - "! Error description. - DESCRIPTION type STRING, - end of T_ERROR_RESPONSE. - types: - "!- "! Request payload to classify.
- begin of T_CLASSIFY_INPUT, - "! The submitted phrase. The maximum length is 2048 characters. - TEXT type STRING, - end of T_CLASSIFY_INPUT. - types: - "! No documentation available. - begin of T_INLINE_OBJECT, - "! Metadata in JSON format. The metadata identifies the language of the data, and - "! an optional name to identify the classifier. Specify the language with the - "! 2-letter primary language code as assigned in ISO standard 639.- "! Class and confidence.
- begin of T_CLASSIFIED_CLASS, - "! A decimal percentage that represents the confidence that Watson has in this - "! class. Higher values represent higher confidences. - CONFIDENCE type DOUBLE, - "! Class label. - CLASS_NAME type STRING, - end of T_CLASSIFIED_CLASS. - types: - "!- "! Response from the classifier for a phrase in a collection.
- begin of T_COLLECTION_ITEM, - "! The submitted phrase. The maximum length is 2048 characters. - TEXT type STRING, - "! The class with the highest confidence. - TOP_CLASS type STRING, - "! An array of up to ten class-confidence pairs sorted in descending order of - "! confidence. - CLASSES type STANDARD TABLE OF T_CLASSIFIED_CLASS WITH NON-UNIQUE DEFAULT KEY, - end of T_COLLECTION_ITEM. - types: - "!- "! A classifier for natural language phrases.
- begin of T_CLASSIFIER, - "! User-supplied name for the classifier. - NAME type STRING, - "! Link to the classifier. - URL type STRING, - "! The state of the classifier. - STATUS type STRING, - "! Unique identifier for this classifier. - CLASSIFIER_ID type STRING, - "! Date and time (UTC) the classifier was created. - CREATED type DATETIME, - "! Additional detail about the status. - STATUS_DESCRIPTION type STRING, - "! The language used for the classifier. - LANGUAGE type STRING, - end of T_CLASSIFIER. - types: - "!- "! List of available classifiers.
- begin of T_CLASSIFIER_LIST, - "! The classifiers available to the user. Returns an empty array if no classifiers - "! are available. - CLASSIFIERS type STANDARD TABLE OF T_CLASSIFIER WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFIER_LIST. - types: - "!- "! Response from the classifier for a phrase.
- begin of T_CLASSIFICATION, - "! Unique identifier for this classifier. - CLASSIFIER_ID type STRING, - "! Link to the classifier. - URL type STRING, - "! The submitted phrase. - TEXT type STRING, - "! The class with the highest confidence. - TOP_CLASS type STRING, - "! An array of up to ten class-confidence pairs sorted in descending order of - "! confidence. - CLASSES type STANDARD TABLE OF T_CLASSIFIED_CLASS WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFICATION. - types: - "!- "! Request payload to classify.
- begin of T_CLASSIFY_COLLECTION_INPUT, - "! The submitted phrases. - COLLECTION type STANDARD TABLE OF T_CLASSIFY_INPUT WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFY_COLLECTION_INPUT. - types: - "!- "! Response payload for Cloud errors.
- begin of T_ERROR_CLOUD, - "! HTTP status code. - CODE type INTEGER, - "! Error name. - ERROR type STRING, - end of T_ERROR_CLOUD. - types: - "! No documentation available. - T_EMPTY type JSONOBJECT. - types: - "!- "! Response from the classifier for multiple phrases.
- begin of T_CLASSIFICATION_COLLECTION, - "! Unique identifier for this classifier. - CLASSIFIER_ID type STRING, - "! Link to the classifier. - URL type STRING, - "! An array of classifier responses for each submitted phrase. - COLLECTION type STANDARD TABLE OF T_COLLECTION_ITEM WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFICATION_COLLECTION. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_ERROR_RESPONSE type string value '|', - T_CLASSIFY_INPUT type string value '|TEXT|', - T_INLINE_OBJECT type string value '|TRAINING_METADATA|TRAINING_DATA|', - T_CLASSIFIED_CLASS type string value '|', - T_COLLECTION_ITEM type string value '|', - T_CLASSIFIER type string value '|URL|CLASSIFIER_ID|', - T_CLASSIFIER_LIST type string value '|CLASSIFIERS|', - T_CLASSIFICATION type string value '|', - T_CLASSIFY_COLLECTION_INPUT type string value '|COLLECTION|', - T_ERROR_CLOUD type string value '|', - T_CLASSIFICATION_COLLECTION type string value '|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - CODE type string value 'code', - ERROR type string value 'error', - DESCRIPTION type string value 'description', - CLASSIFIERS type string value 'classifiers', - NAME type string value 'name', - URL type string value 'url', - STATUS type string value 'status', - CLASSIFIER_ID type string value 'classifier_id', - CREATED type string value 'created', - STATUS_DESCRIPTION type string value 'status_description', - LANGUAGE type string value 'language', - COLLECTION type string value 'collection', - TEXT type string value 'text', - TOP_CLASS type string value 'top_class', - CLASSES type string value 'classes', - CONFIDENCE type string value 'confidence', - CLASS_NAME type string value 'class_name', - CLASSIFY_INPUT type string value 'classify_input', - TRAINING_METADATA type string value 'training_metadata', - TRAINING_DATA type string value 'training_data', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Classify a phrase
- "! Returns label information for the input. The status must be `Available` before - "! you can use the classifier to classify text. - "! - "! @parameter I_CLASSIFIER_ID | - "! Classifier ID to use. - "! @parameter I_BODY | - "! Phrase to classify. - "! @parameter E_RESPONSE | - "! Service return value of type T_CLASSIFICATION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods CLASSIFY - importing - !I_CLASSIFIER_ID type STRING - !I_BODY type T_CLASSIFY_INPUT - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CLASSIFICATION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Classify multiple phrases
- "! Returns label information for multiple phrases. The status must be `Available` - "! before you can use the classifier to classify text.Create classifier
- "! Sends data to create and train a classifier and returns information about the - "! new classifier. - "! - "! @parameter I_TRAINING_METADATA | - "! Metadata in JSON format. The metadata identifies the language of the data, and - "! an optional name to identify the classifier. Specify the language with the - "! 2-letter primary language code as assigned in ISO standard 639.List classifiers
- "! Returns an empty array if no classifiers are available. - "! - "! @parameter E_RESPONSE | - "! Service return value of type T_CLASSIFIER_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_CLASSIFIERS - importing - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CLASSIFIER_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get information about a classifier
- "! Returns status and other information about a classifier. - "! - "! @parameter I_CLASSIFIER_ID | - "! Classifier ID to query. - "! @parameter E_RESPONSE | - "! Service return value of type T_CLASSIFIER - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_CLASSIFIER - importing - !I_CLASSIFIER_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CLASSIFIER - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete classifier
- "! - "! @parameter I_CLASSIFIER_ID | - "! Classifier ID to delete. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_CLASSIFIER - importing - !I_CLASSIFIER_ID type STRING - !I_accept type string default 'application/json' - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - -protected section. - -private section. - -ENDCLASS. - -class ZCL_IBMC_NAT_LANG_CLASS_V1 IMPLEMENTATION. - -*+ "! A list of messages describing model training issues when
+ "! model status is `error`. + begin of T_NOTICE, + "! Describes deficiencies or inconsistencies in training data. + MESSAGE type STRING, + end of T_NOTICE. + types: + "!+ "! Classifications model.
+ begin of T_CLASSIFICATIONS_MODEL, + "! An optional name for the model. + NAME type STRING, + "! An optional map of metadata key-value pairs to store with this model. + USER_METADATA type JSONOBJECT, + "! The 2-letter language code of this model. + LANGUAGE type STRING, + "! An optional description of the model. + DESCRIPTION type STRING, + "! An optional version string. + MODEL_VERSION type STRING, + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + WORKSPACE_ID type STRING, + "! The description of the version. + VERSION_DESCRIPTION type STRING, + "! The service features that are supported by the custom model. + FEATURES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! When the status is `available`, the model is ready to use. + STATUS type STRING, + "! Unique model ID. + MODEL_ID type STRING, + "! dateTime indicating when the model was created. + CREATED type DATETIME, + "! No documentation available. + NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, + "! dateTime of last successful model training. + LAST_TRAINED type DATETIME, + "! dateTime of last successful model deployment. + LAST_DEPLOYED type DATETIME, + end of T_CLASSIFICATIONS_MODEL. + types: + "!+ "! List of classifications models.
+ begin of T_CLASSIFICATIONS_MODEL_LIST, + "! The classifications models. + MODELS type STANDARD TABLE OF T_CLASSIFICATIONS_MODEL WITH NON-UNIQUE DEFAULT KEY, + end of T_CLASSIFICATIONS_MODEL_LIST. types: "!"! An entity that corresponds with an argument in a relation.
@@ -391,6 +449,16 @@ public section. "! No documentation available. SENTENCES type STANDARD TABLE OF T_SENTENCE_RESULT WITH NON-UNIQUE DEFAULT KEY, end of T_SYNTAX_RESULT. + types: + "!+ "! A classification of the analyzed text.
+ begin of T_CLASSIFICATIONS_RESULT, + "! Classification assigned to the text. + CLASS_NAME type STRING, + "! Confidence score for the classification. Higher values indicate greater + "! confidence. + CONFIDENCE type DOUBLE, + end of T_CLASSIFICATIONS_RESULT. types: "!"! The general concepts referenced or alluded to in the
@@ -418,7 +486,7 @@ public section. "!"! A categorization of the analyzed text.
begin of T_CATEGORIES_RESULT, - "! The path to the category through the 5-level taxonomy hierarchy. For more + "! The path to the category through the multi-level taxonomy hierarchy. For more "! information about the categories, see [Categories "! hierarchy](https://cloud.ibm.com/docs/natural-language-understanding?topic=natu "! ral-language-understanding-categories#categories-hierarchy). @@ -452,6 +520,8 @@ public section. KEYWORDS type STANDARD TABLE OF T_KEYWORDS_RESULT WITH NON-UNIQUE DEFAULT KEY, "! The categories that the service assigned to the analyzed text. CATEGORIES type STANDARD TABLE OF T_CATEGORIES_RESULT WITH NON-UNIQUE DEFAULT KEY, + "! The classifications assigned to the analyzed text. + CLASSIFICATIONS type STANDARD TABLE OF T_CLASSIFICATIONS_RESULT WITH NON-UNIQUE DEFAULT KEY, "! The anger, disgust, fear, joy, or sadness conveyed by the content. EMOTION type T_EMOTION_RESULT, "! Webpage metadata, such as the author and the title of the page. @@ -557,26 +627,40 @@ public section. "! An optional name for the model. NAME type STRING, "! An optional map of metadata key-value pairs to store with this model. - USER_METADATA type MAP, + USER_METADATA type JSONOBJECT, "! The 2-letter language code of this model. LANGUAGE type STRING, "! An optional description of the model. DESCRIPTION type STRING, "! An optional version string. MODEL_VERSION type STRING, - "! Deprecated — use `model_version`. - VERSION type STRING, "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural "! Language Understanding. WORKSPACE_ID type STRING, "! The description of the version. VERSION_DESCRIPTION type STRING, + "! The advanced rules feature is deprecated. Existing models are supported until 24 + "! June 2021, but after 10 June 2021, you will not be able to deploy advanced + "! rules models to Natural Language Understanding. After 24 June 2021, advanced + "! rules models will not run in Natural Language Understanding.+ "! (Experimental) Returns a summary of content.
"! Returns important keywords in the content.
- "! Returns a five-level taxonomy of the content. The top three
- "! categories are returned.+ "! Returns a hierarchical taxonomy of the content. The top
+ "! three categories are returned by default."! Analysis features and options.
begin of T_FEATURES, + "! Returns text classifications for the content. + CLASSIFICATIONS type T_CLASSIFICATIONS_OPTIONS, "! Returns high-level concepts in the content. For example, a research paper about "! deep learning might return the concept, "Artificial Intelligence" "! although the term is not mentioned.- "! Advanced rules model.
+ "! Metadata associated with this custom model. + begin of T_CLSSFCTNS_MDL_FL_AND_MTDT, + "! An optional name for the model. + NAME type STRING, + "! An optional map of metadata key-value pairs to store with this model. + USER_METADATA type JSONOBJECT, + "! The 2-letter language code of this model. + LANGUAGE type STRING, + "! An optional description of the model. + DESCRIPTION type STRING, + "! An optional version string. + MODEL_VERSION type STRING, + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + WORKSPACE_ID type STRING, + "! The description of the version. + VERSION_DESCRIPTION type STRING, + "! Training data in JSON format. For more information, see [Classifications + "! training data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-classifications#classification-training-data-requi + "! rements). + TRAINING_DATA type FILE, + end of T_CLSSFCTNS_MDL_FL_AND_MTDT. + types: + "!+ "! The advanced rules feature is deprecated. Existing models
+ "! are supported until 24 June 2021, but after 10 June 2021, you will not be able + "! to deploy advanced rules models to Natural Language Understanding. After 24 + "! June 2021, advanced rules models will not run in Natural Language + "! Understanding.+ "! Categories model.
+ begin of T_CATEGORIES_MODEL, + "! An optional name for the model. + NAME type STRING, + "! An optional map of metadata key-value pairs to store with this model. + USER_METADATA type JSONOBJECT, + "! The 2-letter language code of this model. + LANGUAGE type STRING, + "! An optional description of the model. + DESCRIPTION type STRING, + "! An optional version string. + MODEL_VERSION type STRING, + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + WORKSPACE_ID type STRING, + "! The description of the version. + VERSION_DESCRIPTION type STRING, + "! The service features that are supported by the custom model. + FEATURES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, + "! When the status is `available`, the model is ready to use. + STATUS type STRING, + "! Unique model ID. + MODEL_ID type STRING, + "! dateTime indicating when the model was created. + CREATED type DATETIME, + "! No documentation available. + NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, + "! dateTime of last successful model training. + LAST_TRAINED type DATETIME, + "! dateTime of last successful model deployment. + LAST_DEPLOYED type DATETIME, + end of T_CATEGORIES_MODEL. + types: + "!+ "! List of categories models.
+ begin of T_CATEGORIES_MODEL_LIST, + "! The categories models. + MODELS type STANDARD TABLE OF T_CATEGORIES_MODEL WITH NON-UNIQUE DEFAULT KEY, + end of T_CATEGORIES_MODEL_LIST. + types: + "!+ "! Optional classifications training parameters along with
+ "! model train requests. + begin of T_CLSSFCTNS_TRNNG_PARAMETERS, + "! Model type selector to train either a single_label or a multi_label classifier. + MODEL_TYPE type STRING, + end of T_CLSSFCTNS_TRNNG_PARAMETERS. + types: + "!+ "! Metadata associated with this custom model.
+ begin of T_CLSSFCTNS_MDL_FL_MTDT_AND_T1, + "! An optional name for the model. + NAME type STRING, + "! An optional map of metadata key-value pairs to store with this model. + USER_METADATA type JSONOBJECT, + "! The 2-letter language code of this model. + LANGUAGE type STRING, + "! An optional description of the model. + DESCRIPTION type STRING, + "! An optional version string. + MODEL_VERSION type STRING, + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + WORKSPACE_ID type STRING, + "! The description of the version. + VERSION_DESCRIPTION type STRING, + "! Training data in JSON format. For more information, see [Classifications + "! training data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-classifications#classification-training-data-requi + "! rements). + TRAINING_DATA type FILE, + "! Optional classifications training parameters along with model train requests. + TRAINING_PARAMETERS type T_CLSSFCTNS_TRNNG_PARAMETERS, + end of T_CLSSFCTNS_MDL_FL_MTDT_AND_T1. types: "! No documentation available. begin of T_SEMANTIC_ROLES_SUBJECT, @@ -835,15 +1046,6 @@ public section. "! An array of extracted keywords. KEYWORDS type STANDARD TABLE OF T_SEMANTIC_ROLES_KEYWORD WITH NON-UNIQUE DEFAULT KEY, end of T_SEMANTIC_ROLES_SUBJECT. - types: - "!- "! (Experimental) Returns a summary of content.
"! (Experimental) Summary of content.
@@ -853,20 +1055,24 @@ public section. end of T_SUMMARIZATION_RESULT. types: "!- "! Advanced rules model.
+ "! The advanced rules feature is deprecated. Existing models + "! are supported until 24 June 2021, but after 10 June 2021, you will not be able + "! to deploy advanced rules models to Natural Language Understanding. After 24 + "! June 2021, advanced rules models will not run in Natural Language + "! Understanding.- "! List of advanced rules models.
+ "! The advanced rules feature is deprecated. Existing models + "! are supported until 24 June 2021, but after 10 June 2021, you will not be able + "! to deploy advanced rules models to Natural Language Understanding. After 24 + "! June 2021, advanced rules models will not run in Natural Language + "! Understanding.+ "! Metadata associated with this custom model.
+ begin of T_CTGRS_MDL_FILE_AND_METADATA, + "! An optional name for the model. + NAME type STRING, + "! An optional map of metadata key-value pairs to store with this model. + USER_METADATA type JSONOBJECT, + "! The 2-letter language code of this model. + LANGUAGE type STRING, + "! An optional description of the model. + DESCRIPTION type STRING, + "! An optional version string. + MODEL_VERSION type STRING, + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + WORKSPACE_ID type STRING, + "! The description of the version. + VERSION_DESCRIPTION type STRING, + "! Training data in JSON format. For more information, see [Categories training + "! data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-categories##categories-training-data-requirements) + "! . + TRAINING_DATA type FILE, + end of T_CTGRS_MDL_FILE_AND_METADATA. types: "!"! Link to the corresponding DBpedia resource.
@@ -997,15 +1237,13 @@ public section. "! An optional name for the model. NAME type STRING, "! An optional map of metadata key-value pairs to store with this model. - USER_METADATA type MAP, + USER_METADATA type JSONOBJECT, "! The 2-letter language code of this model. LANGUAGE type STRING, "! An optional description of the model. DESCRIPTION type STRING, "! An optional version string. MODEL_VERSION type STRING, - "! Deprecated — use `model_version`. - VERSION type STRING, "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural "! Language Understanding. WORKSPACE_ID type STRING, @@ -1013,8 +1251,8 @@ public section. VERSION_DESCRIPTION type STRING, "! Training data in CSV format. For more information, see [Sentiment training data "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n - "! atural-language-understanding-customizing#sentiment-training-data-requirements). - "! + "! atural-language-understanding-custom-sentiment#sentiment-training-data-requireme + "! nts). TRAINING_DATA type FILE, end of T_SNTMNT_MDL_FILE_AND_METADATA. types: @@ -1024,15 +1262,13 @@ public section. "! An optional name for the model. NAME type STRING, "! An optional map of metadata key-value pairs to store with this model. - USER_METADATA type MAP, + USER_METADATA type JSONOBJECT, "! The 2-letter language code of this model. LANGUAGE type STRING, "! An optional description of the model. DESCRIPTION type STRING, "! An optional version string. MODEL_VERSION type STRING, - "! Deprecated — use `model_version`. - VERSION type STRING, "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural "! Language Understanding. WORKSPACE_ID type STRING, @@ -1064,6 +1300,9 @@ constants: T_SEMANTIC_ROLES_RESULT type string value '|', T_SEMANTIC_ROLES_OPTIONS type string value '|', T_MODEL_METADATA type string value '|LANGUAGE|', + T_NOTICE type string value '|', + T_CLASSIFICATIONS_MODEL type string value '|LANGUAGE|STATUS|MODEL_ID|CREATED|', + T_CLASSIFICATIONS_MODEL_LIST type string value '|', T_RELATION_ENTITY type string value '|', T_RELATION_ARGUMENT type string value '|', T_RELATIONS_RESULT type string value '|', @@ -1086,6 +1325,7 @@ constants: T_TOKEN_RESULT type string value '|', T_SENTENCE_RESULT type string value '|', T_SYNTAX_RESULT type string value '|', + T_CLASSIFICATIONS_RESULT type string value '|', T_CONCEPTS_RESULT type string value '|', T_CTGRS_RESULT_EXPLANATION type string value '|', T_CATEGORIES_RESULT type string value '|', @@ -1099,18 +1339,24 @@ constants: T_SEMANTIC_ROLES_ACTION type string value '|', T_SYNTAX_OPTIONS_TOKENS type string value '|', T_FILE_AND_METADATA type string value '|LANGUAGE|', + T_SUMMARIZATION_OPTIONS type string value '|', T_KEYWORDS_OPTIONS type string value '|', T_RELATIONS_OPTIONS type string value '|', T_ENTITIES_OPTIONS type string value '|', T_CONCEPTS_OPTIONS type string value '|', T_SYNTAX_OPTIONS type string value '|', + T_CLASSIFICATIONS_OPTIONS type string value '|', T_CATEGORIES_OPTIONS type string value '|', T_FEATURES type string value '|', + T_CLSSFCTNS_MDL_FL_AND_MTDT type string value '|LANGUAGE|TRAINING_DATA|', T_BASE_ADVANCED_RULES_MODEL type string value '|LANGUAGE|', T_ANALYSIS_RESULTS_USAGE type string value '|', T_ANALYSIS_RESULTS type string value '|', + T_CATEGORIES_MODEL type string value '|LANGUAGE|STATUS|MODEL_ID|CREATED|', + T_CATEGORIES_MODEL_LIST type string value '|', + T_CLSSFCTNS_TRNNG_PARAMETERS type string value '|', + T_CLSSFCTNS_MDL_FL_MTDT_AND_T1 type string value '|LANGUAGE|TRAINING_DATA|', T_SEMANTIC_ROLES_SUBJECT type string value '|', - T_SUMMARIZATION_OPTIONS type string value '|', T_SUMMARIZATION_RESULT type string value '|', T_ADVANCED_RULES_MODEL type string value '|LANGUAGE|STATUS|MODEL_ID|CREATED|', T_ADVANCED_RULES_MODEL_LIST type string value '|', @@ -1118,6 +1364,7 @@ constants: T_SEMANTIC_ROLES_OBJECT type string value '|', T_PARAMETERS type string value '|FEATURES|', T_SENTIMENT_MODEL type string value '|', + T_CTGRS_MDL_FILE_AND_METADATA type string value '|LANGUAGE|TRAINING_DATA|', T_SNTMNT_MDL_FILE_AND_METADATA type string value '|LANGUAGE|TRAINING_DATA|', T_MODEL_FILE_AND_METADATA type string value '|LANGUAGE|FILE|', T_DELETE_MODEL_RESULTS type string value '|', @@ -1133,13 +1380,13 @@ constants: LANGUAGE type string value 'language', DESCRIPTION type string value 'description', MODEL_VERSION type string value 'model_version', - VERSION type string value 'version', WORKSPACE_ID type string value 'workspace_id', VERSION_DESCRIPTION type string value 'version_description', FEATURES type string value 'features', STATUS type string value 'status', MODEL_ID type string value 'model_id', CREATED type string value 'created', + NOTICES type string value 'notices', LAST_TRAINED type string value 'last_trained', LAST_DEPLOYED type string value 'last_deployed', MODELS type string value 'models', @@ -1152,6 +1399,7 @@ constants: FALLBACK_TO_RAW type string value 'fallback_to_raw', RETURN_ANALYZED_TEXT type string value 'return_analyzed_text', LIMIT_TEXT_CHARACTERS type string value 'limit_text_characters', + CLASSIFICATIONS type string value 'classifications', CONCEPTS type string value 'concepts', EMOTION type string value 'emotion', ENTITIES type string value 'entities', @@ -1160,9 +1408,11 @@ constants: RELATIONS type string value 'relations', SEMANTIC_ROLES type string value 'semantic_roles', SENTIMENT type string value 'sentiment', + SUMMARIZATION type string value 'summarization', CATEGORIES type string value 'categories', SYNTAX type string value 'syntax', DELETED type string value 'deleted', + VERSION type string value 'version', TRAINING_DATA type string value 'training_data', FILE type string value 'file', ANALYZED_TEXT type string value 'analyzed_text', @@ -1170,6 +1420,7 @@ constants: USAGE type string value 'usage', TEXT_CHARACTERS type string value 'text_characters', TEXT_UNITS type string value 'text_units', + MESSAGE type string value 'message', RELEVANCE type string value 'relevance', DBPEDIA_RESOURCE type string value 'dbpedia_resource', SUBTYPE type string value 'subtype', @@ -1182,6 +1433,7 @@ constants: LABEL type string value 'label', SCORE type string value 'score', EXPLANATION type string value 'explanation', + CLASS_NAME type string value 'class_name', DOCUMENT type string value 'document', TARGETS type string value 'targets', ANGER type string value 'anger', @@ -1208,8 +1460,10 @@ constants: PART_OF_SPEECH type string value 'part_of_speech', LEMMA type string value 'lemma', LIMIT type string value 'limit', + TRAINING_PARAMETERS type string value 'training_parameters', CODE type string value 'code', ERROR type string value 'error', + MODEL_TYPE type string value 'model_type', RELEVANT_TEXT type string value 'relevant_text', end of C_ABAPNAME_DICTIONARY . @@ -1225,6 +1479,7 @@ constants: "!Analyze text
"! Analyzes text, HTML, or a public webpage for the following features:Create categories model
+ "! (Beta) Creates a custom categories model by uploading training data and + "! associated metadata. The model begins the training and deploying process and is + "! ready to use when the `status` is `available`. + "! + "! @parameter I_LANGUAGE | + "! The 2-letter language code of this model. + "! @parameter I_TRAINING_DATA | + "! Training data in JSON format. For more information, see [Categories training + "! data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-categories##categories-training-data-requirements) + "! . + "! @parameter I_TRAINING_DATA_CONTENT_TYPE | + "! The content type of trainingData. + "! @parameter I_NAME | + "! An optional name for the model. + "! @parameter I_USER_METADATA | + "! An optional map of metadata key-value pairs to store with this model. + "! @parameter I_DESCRIPTION | + "! An optional description of the model. + "! @parameter I_MODEL_VERSION | + "! An optional version string. + "! @parameter I_WORKSPACE_ID | + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + "! @parameter I_VERSION_DESCRIPTION | + "! The description of the version. + "! @parameter E_RESPONSE | + "! Service return value of type T_CATEGORIES_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods CREATE_CATEGORIES_MODEL + importing + !I_LANGUAGE type STRING + !I_TRAINING_DATA type FILE + !I_TRAINING_DATA_CONTENT_TYPE type STRING optional + !I_NAME type STRING optional + !I_USER_METADATA type JSONOBJECT optional + !I_DESCRIPTION type STRING optional + !I_MODEL_VERSION type STRING optional + !I_WORKSPACE_ID type STRING optional + !I_VERSION_DESCRIPTION type STRING optional + !I_contenttype type string default 'multipart/form-data' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CATEGORIES_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!List categories models
+ "! (Beta) Returns all custom categories models associated with this service + "! instance. + "! + "! @parameter E_RESPONSE | + "! Service return value of type T_CATEGORIES_MODEL_LIST + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_CATEGORIES_MODELS + importing + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CATEGORIES_MODEL_LIST + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Get categories model details
+ "! (Beta) Returns the status of the categories model with the given model ID. + "! + "! @parameter I_MODEL_ID | + "! ID of the model. + "! @parameter E_RESPONSE | + "! Service return value of type T_CATEGORIES_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_CATEGORIES_MODEL + importing + !I_MODEL_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CATEGORIES_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update categories model
+ "! (Beta) Overwrites the training data associated with this custom categories model + "! and retrains the model. The new model replaces the current deployment. + "! + "! @parameter I_MODEL_ID | + "! ID of the model. + "! @parameter I_LANGUAGE | + "! The 2-letter language code of this model. + "! @parameter I_TRAINING_DATA | + "! Training data in JSON format. For more information, see [Categories training + "! data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-categories##categories-training-data-requirements) + "! . + "! @parameter I_TRAINING_DATA_CONTENT_TYPE | + "! The content type of trainingData. + "! @parameter I_NAME | + "! An optional name for the model. + "! @parameter I_USER_METADATA | + "! An optional map of metadata key-value pairs to store with this model. + "! @parameter I_DESCRIPTION | + "! An optional description of the model. + "! @parameter I_MODEL_VERSION | + "! An optional version string. + "! @parameter I_WORKSPACE_ID | + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + "! @parameter I_VERSION_DESCRIPTION | + "! The description of the version. + "! @parameter E_RESPONSE | + "! Service return value of type T_CATEGORIES_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_CATEGORIES_MODEL + importing + !I_MODEL_ID type STRING + !I_LANGUAGE type STRING + !I_TRAINING_DATA type FILE + !I_TRAINING_DATA_CONTENT_TYPE type STRING optional + !I_NAME type STRING optional + !I_USER_METADATA type JSONOBJECT optional + !I_DESCRIPTION type STRING optional + !I_MODEL_VERSION type STRING optional + !I_WORKSPACE_ID type STRING optional + !I_VERSION_DESCRIPTION type STRING optional + !I_contenttype type string default 'multipart/form-data' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CATEGORIES_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete categories model
+ "! (Beta) Un-deploys the custom categories model with the given model ID and + "! deletes all associated customer data, including any training data or binary + "! artifacts. + "! + "! @parameter I_MODEL_ID | + "! ID of the model. + "! @parameter E_RESPONSE | + "! Service return value of type T_DELETE_MODEL_RESULTS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_CATEGORIES_MODEL + importing + !I_MODEL_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DELETE_MODEL_RESULTS + raising + ZCX_IBMC_SERVICE_EXCEPTION . -protected section. - -private section. - -ENDCLASS. - -class ZCL_IBMC_NAT_LANG_UNDRSTND_V1 IMPLEMENTATION. - -*Create classifications model
+ "! Creates a custom classifications model by uploading training data and associated + "! metadata. The model begins the training and deploying process and is ready to + "! use when the `status` is `available`. + "! + "! @parameter I_LANGUAGE | + "! The 2-letter language code of this model. + "! @parameter I_TRAINING_DATA | + "! Training data in JSON format. For more information, see [Classifications + "! training data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-classifications#classification-training-data-requi + "! rements). + "! @parameter I_TRAINING_DATA_CONTENT_TYPE | + "! The content type of trainingData. + "! @parameter I_NAME | + "! An optional name for the model. + "! @parameter I_USER_METADATA | + "! An optional map of metadata key-value pairs to store with this model. + "! @parameter I_DESCRIPTION | + "! An optional description of the model. + "! @parameter I_MODEL_VERSION | + "! An optional version string. + "! @parameter I_WORKSPACE_ID | + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + "! @parameter I_VERSION_DESCRIPTION | + "! The description of the version. + "! @parameter I_TRAINING_PARAMETERS | + "! Optional classifications training parameters along with model train requests. + "! @parameter E_RESPONSE | + "! Service return value of type T_CLASSIFICATIONS_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods CREATE_CLASSIFICATIONS_MODEL + importing + !I_LANGUAGE type STRING + !I_TRAINING_DATA type FILE + !I_TRAINING_DATA_CONTENT_TYPE type STRING optional + !I_NAME type STRING optional + !I_USER_METADATA type JSONOBJECT optional + !I_DESCRIPTION type STRING optional + !I_MODEL_VERSION type STRING optional + !I_WORKSPACE_ID type STRING optional + !I_VERSION_DESCRIPTION type STRING optional + !I_TRAINING_PARAMETERS type T_CLSSFCTNS_TRNNG_PARAMETERS optional + !I_contenttype type string default 'multipart/form-data' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CLASSIFICATIONS_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!List classifications models
+ "! Returns all custom classifications models associated with this service instance. + "! + "! + "! @parameter E_RESPONSE | + "! Service return value of type T_CLASSIFICATIONS_MODEL_LIST + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods LIST_CLASSIFICATIONS_MODELS + importing + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CLASSIFICATIONS_MODEL_LIST + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Get classifications model details
+ "! Returns the status of the classifications model with the given model ID. + "! + "! @parameter I_MODEL_ID | + "! ID of the model. + "! @parameter E_RESPONSE | + "! Service return value of type T_CLASSIFICATIONS_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods GET_CLASSIFICATIONS_MODEL + importing + !I_MODEL_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CLASSIFICATIONS_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Update classifications model
+ "! Overwrites the training data associated with this custom classifications model + "! and retrains the model. The new model replaces the current deployment. + "! + "! @parameter I_MODEL_ID | + "! ID of the model. + "! @parameter I_LANGUAGE | + "! The 2-letter language code of this model. + "! @parameter I_TRAINING_DATA | + "! Training data in JSON format. For more information, see [Classifications + "! training data + "! requirements](https://cloud.ibm.com/docs/natural-language-understanding?topic=n + "! atural-language-understanding-classifications#classification-training-data-requi + "! rements). + "! @parameter I_TRAINING_DATA_CONTENT_TYPE | + "! The content type of trainingData. + "! @parameter I_NAME | + "! An optional name for the model. + "! @parameter I_USER_METADATA | + "! An optional map of metadata key-value pairs to store with this model. + "! @parameter I_DESCRIPTION | + "! An optional description of the model. + "! @parameter I_MODEL_VERSION | + "! An optional version string. + "! @parameter I_WORKSPACE_ID | + "! ID of the Watson Knowledge Studio workspace that deployed this model to Natural + "! Language Understanding. + "! @parameter I_VERSION_DESCRIPTION | + "! The description of the version. + "! @parameter I_TRAINING_PARAMETERS | + "! Optional classifications training parameters along with model train requests. + "! @parameter E_RESPONSE | + "! Service return value of type T_CLASSIFICATIONS_MODEL + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods UPDATE_CLASSIFICATIONS_MODEL + importing + !I_MODEL_ID type STRING + !I_LANGUAGE type STRING + !I_TRAINING_DATA type FILE + !I_TRAINING_DATA_CONTENT_TYPE type STRING optional + !I_NAME type STRING optional + !I_USER_METADATA type JSONOBJECT optional + !I_DESCRIPTION type STRING optional + !I_MODEL_VERSION type STRING optional + !I_WORKSPACE_ID type STRING optional + !I_VERSION_DESCRIPTION type STRING optional + !I_TRAINING_PARAMETERS type T_CLSSFCTNS_TRNNG_PARAMETERS optional + !I_contenttype type string default 'multipart/form-data' + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_CLASSIFICATIONS_MODEL + raising + ZCX_IBMC_SERVICE_EXCEPTION . + "!Delete classifications model
+ "! Un-deploys the custom classifications model with the given model ID and deletes + "! all associated customer data, including any training data or binary artifacts. + "! + "! @parameter I_MODEL_ID | + "! ID of the model. + "! @parameter E_RESPONSE | + "! Service return value of type T_DELETE_MODEL_RESULTS + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods DELETE_CLASSIFICATIONS_MODEL + importing + !I_MODEL_ID type STRING + !I_accept type string default 'application/json' + exporting + !E_RESPONSE type T_DELETE_MODEL_RESULTS + raising + ZCX_IBMC_SERVICE_EXCEPTION . + + +protected section. + +private section. + +ENDCLASS. + +class ZCL_IBMC_NAT_LANG_UNDRSTND_V1 IMPLEMENTATION. + +*Personality Insights
-"! IBM® will begin sunsetting IBM Watson™ Personality Insights on 1 -"! December 2020. For a period of one year from this date, you will still be able -"! to use Watson Personality Insights. However, as of 1 December 2021, the -"! offering will no longer be available.<br/><br/>As an alternative, -"! we encourage you to consider migrating to IBM Watson™ Natural Language -"! Understanding, a service on IBM Cloud® that uses deep learning to extract -"! data and insights from text such as keywords, categories, sentiment, emotion, -"! and syntax to provide insights for your business or industry. For more -"! information, see [About Natural Language -"! Understanding](https://cloud.ibm.com/docs/natural-language-understanding?topic= -"! natural-language-understanding-about).- "! The characteristics that the service inferred from the input
- "! content. - begin of T_TRAIT, - "! The unique, non-localized identifier of the characteristic to which the results - "! pertain. IDs have the form- "! The temporal behavior for the input content.
- begin of T_BEHAVIOR, - "! The unique, non-localized identifier of the characteristic to which the results - "! pertain. IDs have the form `behavior_{value}`. - TRAIT_ID type STRING, - "! The user-visible, localized name of the characteristic. - NAME type STRING, - "! The category of the characteristic: `behavior` for temporal data. - CATEGORY type STRING, - "! For JSON content that is timestamped, the percentage of timestamped input data - "! that occurred during that day of the week or hour of the day. The range is 0 to - "! 1. - PERCENTAGE type DOUBLE, - end of T_BEHAVIOR. - types: - "!- "! A consumption preference that the service inferred from the
- "! input content. - begin of T_CONSUMPTION_PREFERENCES, - "! The unique, non-localized identifier of the consumption preference to which the - "! results pertain. IDs have the form - "! `consumption_preferences_{preference}`. - CONSUMPTION_PREFERENCE_ID type STRING, - "! The user-visible, localized name of the consumption preference. - NAME type STRING, - "! The score for the consumption preference:- "! A warning message that is associated with the input content.
- begin of T_WARNING, - "! The identifier of the warning message. - WARNING_ID type STRING, - "! The message associated with the `warning_id`:- "! The consumption preferences that the service inferred from
- "! the input content. - begin of T_CNSMPTN_PREFERENCES_CATEGORY, - "! The unique, non-localized identifier of the consumption preferences category to - "! which the results pertain. IDs have the form - "! `consumption_preferences_{category}`. - CNSMPTN_PREFERENCE_CATEGORY_ID type STRING, - "! The user-visible name of the consumption preferences category. - NAME type STRING, - "! Detailed results inferred from the input text for the individual preferences of - "! the category. - CONSUMPTION_PREFERENCES type STANDARD TABLE OF T_CONSUMPTION_PREFERENCES WITH NON-UNIQUE DEFAULT KEY, - end of T_CNSMPTN_PREFERENCES_CATEGORY. - types: - "!- "! The personality profile that the service generated for the
- "! input content. - begin of T_PROFILE, - "! The language model that was used to process the input. - PROCESSED_LANGUAGE type STRING, - "! The number of words from the input that were used to produce the profile. - WORD_COUNT type INTEGER, - "! When guidance is appropriate, a string that provides a message that indicates - "! the number of words found and where that value falls in the range of required - "! or suggested number of words. - WORD_COUNT_MESSAGE type STRING, - "! A recursive array of `Trait` objects that provides detailed results for the Big - "! Five personality characteristics (dimensions and facets) inferred from the - "! input text. - PERSONALITY type STANDARD TABLE OF T_TRAIT WITH NON-UNIQUE DEFAULT KEY, - "! Detailed results for the Needs characteristics inferred from the input text. - NEEDS type STANDARD TABLE OF T_TRAIT WITH NON-UNIQUE DEFAULT KEY, - "! Detailed results for the Values characteristics inferred from the input text. - VALUES type STANDARD TABLE OF T_TRAIT WITH NON-UNIQUE DEFAULT KEY, - "! For JSON content that is timestamped, detailed results about the social behavior - "! disclosed by the input in terms of temporal characteristics. The results - "! include information about the distribution of the content over the days of the - "! week and the hours of the day. - BEHAVIOR type STANDARD TABLE OF T_BEHAVIOR WITH NON-UNIQUE DEFAULT KEY, - "! If the **consumption_preferences** parameter is `true`, detailed results for - "! each category of consumption preferences. Each element of the array provides - "! information inferred from the input text for the individual preferences of that - "! category. - CONSUMPTION_PREFERENCES type STANDARD TABLE OF T_CNSMPTN_PREFERENCES_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - "! An array of warning messages that are associated with the input text for the - "! request. The array is empty if the input generated no warnings. - WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, - end of T_PROFILE. - types: - "!- "! An input content item that the service is to analyze.
- begin of T_CONTENT_ITEM, - "! The content that is to be analyzed. The service supports up to 20 MB of content - "! for all `ContentItem` objects combined. - CONTENT type STRING, - "! A unique identifier for this content item. - ID type STRING, - "! A timestamp that identifies when this content was created. Specify a value in - "! milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required only - "! for results that include temporal behavior data. - CREATED type LONG, - "! A timestamp that identifies when this content was last updated. Specify a value - "! in milliseconds since the UNIX Epoch (January 1, 1970, at 0:00 UTC). Required - "! only for results that include temporal behavior data. - UPDATED type LONG, - "! The MIME type of the content. The default is plain text. The tags are stripped - "! from HTML content before it is analyzed; plain text is processed as submitted. - CONTENTTYPE type STRING, - "! The language identifier (two-letter ISO 639-1 identifier) for the language of - "! the content item. The default is `en` (English). Regional variants are treated - "! as their parent language; for example, `en-US` is interpreted as `en`. A - "! language specified with the **Content-Type** parameter overrides the value of - "! this parameter; any content items that specify a different language are - "! ignored. Omit the **Content-Type** parameter to base the language on the most - "! prevalent specification among the content items; again, content items that - "! specify a different language are ignored. You can specify any combination of - "! languages for the input and response content. - LANGUAGE type STRING, - "! The unique ID of the parent content item for this item. Used to identify - "! hierarchical relationships between posts/replies, messages/replies, and so on. - PARENTID type STRING, - "! Indicates whether this content item is a reply to another content item. - REPLY type BOOLEAN, - "! Indicates whether this content item is a forwarded/copied version of another - "! content item. - FORWARD type BOOLEAN, - end of T_CONTENT_ITEM. - types: - "!- "! A CSV file that contains the results of the personality
- "! profile that the service generated for the input content. - T_CSV_FILE type String. - types: - "!- "! The error response from a failed request.
- begin of T_ERROR_MODEL, - "! The HTTP status code. - CODE type INTEGER, - "! A service-specific error code. - SUB_CODE type STRING, - "! A description of the error. - ERROR type STRING, - "! A URL to documentation explaining the cause and possibly solutions for the - "! error. - HELP type STRING, - end of T_ERROR_MODEL. - types: - "!- "! The full input content that the service is to analyze.
- begin of T_CONTENT, - "! An array of `ContentItem` objects that provides the text that is to be analyzed. - "! - CONTENTITEMS type STANDARD TABLE OF T_CONTENT_ITEM WITH NON-UNIQUE DEFAULT KEY, - end of T_CONTENT. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_TRAIT type string value '|TRAIT_ID|NAME|CATEGORY|PERCENTILE|', - T_BEHAVIOR type string value '|TRAIT_ID|NAME|CATEGORY|PERCENTAGE|', - T_CONSUMPTION_PREFERENCES type string value '|CONSUMPTION_PREFERENCE_ID|NAME|SCORE|', - T_WARNING type string value '|WARNING_ID|MESSAGE|', - T_CNSMPTN_PREFERENCES_CATEGORY type string value '|CNSMPTN_PREFERENCE_CATEGORY_ID|NAME|CONSUMPTION_PREFERENCES|', - T_PROFILE type string value '|PROCESSED_LANGUAGE|WORD_COUNT|PERSONALITY|NEEDS|VALUES|WARNINGS|', - T_CONTENT_ITEM type string value '|CONTENT|', - T_ERROR_MODEL type string value '|CODE|ERROR|', - T_CONTENT type string value '|CONTENTITEMS|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - PROCESSED_LANGUAGE type string value 'processed_language', - WORD_COUNT type string value 'word_count', - WORD_COUNT_MESSAGE type string value 'word_count_message', - PERSONALITY type string value 'personality', - NEEDS type string value 'needs', - VALUES type string value 'values', - BEHAVIOR type string value 'behavior', - CONSUMPTION_PREFERENCES type string value 'consumption_preferences', - WARNINGS type string value 'warnings', - TRAIT_ID type string value 'trait_id', - NAME type string value 'name', - CATEGORY type string value 'category', - PERCENTILE type string value 'percentile', - RAW_SCORE type string value 'raw_score', - SIGNIFICANT type string value 'significant', - CHILDREN type string value 'children', - PERCENTAGE type string value 'percentage', - CNSMPTN_PREFERENCE_CATEGORY_ID type string value 'consumption_preference_category_id', - CONSUMPTION_PREFERENCE_ID type string value 'consumption_preference_id', - SCORE type string value 'score', - WARNING_ID type string value 'warning_id', - MESSAGE type string value 'message', - CONTENTITEMS type string value 'contentItems', - CONTENT_ITEM type string value 'content_item', - CONTENT type string value 'content', - ID type string value 'id', - CREATED type string value 'created', - UPDATED type string value 'updated', - CONTENTTYPE type string value 'contenttype', - LANGUAGE type string value 'language', - PARENTID type string value 'parentid', - REPLY type string value 'reply', - FORWARD type string value 'forward', - CODE type string value 'code', - SUB_CODE type string value 'sub_code', - ERROR type string value 'error', - HELP type string value 'help', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Get profile
- "! Generates a personality profile for the author of the input text. The service - "! accepts a maximum of 20 MB of input content, but it requires much less text to - "! produce an accurate profile. The service can analyze text in Arabic, English, - "! Japanese, Korean, or Spanish. It can return its results in a variety of - "! languages.Get profile as csv
- "! Generates a personality profile for the author of the input text. The service - "! accepts a maximum of 20 MB of input content, but it requires much less text to - "! produce an accurate profile. The service can analyze text in Arabic, English, - "! Japanese, Korean, or Spanish. It can return its results in a variety of - "! languages.DateTime type, format 2018-10-23T15:18:18.914xxxZ
- DATETIME(27) type c . - types TT_STRING type ZIF_IBMC_SERVICE_ARCH~TT_STRING . + datetime(27) type c . + types tt_string type ZIF_IBMC_service_arch~tt_string . types: - TT_BOOLEAN type standard table of ZIF_IBMC_SERVICE_ARCH~BOOLEAN with non-unique default key . + tt_boolean type standard table of ZIF_IBMC_service_arch~boolean with non-unique default key . types: - TT_CHAR type standard table of ZIF_IBMC_SERVICE_ARCH~CHAR with non-unique default key . + tt_char type standard table of ZIF_IBMC_service_arch~char with non-unique default key . types: - TT_INTEGER type standard table of INTEGER with non-unique default key . + tt_integer type standard table of integer with non-unique default key . types: - TT_SHORT type standard table of SHORT with non-unique default key . + tt_short type standard table of short with non-unique default key . types: - TT_LONG type standard table of LONG with non-unique default key . + tt_long type standard table of long with non-unique default key . types: - TT_FLOAT type standard table of FLOAT with non-unique default key . + tt_float type standard table of float with non-unique default key . types: - TT_DOUBLE type standard table of DOUBLE with non-unique default key . + tt_double type standard table of double with non-unique default key . types: - TT_NUMBER type standard table of NUMBER with non-unique default key . + tt_number type standard table of number with non-unique default key . types: - TT_FILE type standard table of FILE with non-unique default key . + tt_file type standard table of file with non-unique default key . types: - begin of TS_MAP_FILE, - KEY type STRING, - DATA type FILE, - end of TS_MAP_FILE . + begin of ts_map_file, + key type string, + data type file, + end of ts_map_file . types: - TT_MAP_FILE type standard table of TS_MAP_FILE with non-unique default key . + tt_map_file type standard table of ts_map_file with non-unique default key . types: - begin of TS_FILE_WITH_METADATA, - FILENAME type string, - CONTENT_TYPE type string, - DATA type xstring, - end of TS_FILE_WITH_METADATA . + begin of ts_file_with_metadata, + filename type string, + content_type type string, + data type xstring, + end of ts_file_with_metadata . types: - TT_FILE_WITH_METADATA type standard table of TS_FILE_WITH_METADATA with non-unique default key . - types TS_FORM_PART type ZIF_IBMC_SERVICE_ARCH~TS_FORM_PART . - types TT_FORM_PART type ZIF_IBMC_SERVICE_ARCH~TT_FORM_PART . - - constants C_BOOLEAN_FALSE type BOOLEAN value SPACE ##NO_TEXT. - constants C_BOOLEAN_TRUE type BOOLEAN value 'X' ##NO_TEXT. - constants C_TRIBOOL_FALSE type BOOLEAN value '-' ##NO_TEXT. - constants C_DEFAULT type STRING value 'DEFAULT' ##NO_TEXT. - constants C_SUBRC_UNKNOWN type SY-SUBRC value 999999 ##NO_TEXT. - constants C_MSGID type SY-MSGID value 'ZIBMC' ##NO_TEXT. - constants C_I_ZERO type I value -2147481648 ##NO_TEXT. - constants C_I8_ZERO type INT8 value -9223372036854775608 ##NO_TEXT. - constants C_F_ZERO type F value '-2147481.648' ##NO_TEXT. - constants C_BLANK type STRING value '&#§§#&__%$X' ##NO_TEXT. + tt_file_with_metadata type standard table of ts_file_with_metadata with non-unique default key . + types ts_form_part type ZIF_IBMC_service_arch~ts_form_part . + types tt_form_part type ZIF_IBMC_service_arch~tt_form_part . + + constants c_boolean_false type boolean value space ##NO_TEXT. + constants c_boolean_true type boolean value 'X' ##NO_TEXT. + constants c_tribool_false type boolean value '-' ##NO_TEXT. + constants c_default type string value 'DEFAULT' ##NO_TEXT. + constants c_subrc_unknown type sy-subrc value 999999 ##NO_TEXT. + constants c_msgid type sy-msgid value 'ZIBMC' ##NO_TEXT. + constants c_i_zero type i value -2147481648 ##NO_TEXT. + constants c_i8_zero type int8 value -9223372036854775608 ##NO_TEXT. + constants c_f_zero type f value '-2147481.648' ##NO_TEXT. + constants c_blank type string value '&#!-#&__%$X' ##NO_TEXT. constants: - begin of C_DATATYPE, + begin of c_datatype, string type char value 'g', struct type char value 'v', - end of C_DATATYPE . - data P_REQUEST_PROP_DEFAULT type TS_REQUEST_PROP . - data P_DEBUG_MODE type CHAR value SPACE ##NO_TEXT. - data P_VERSION type STRING . + end of c_datatype . + data p_request_prop_default type ts_request_prop . + data p_debug_mode type char value space ##NO_TEXT. + data p_version type string . "!Raises an exception.
"! @@ -107,19 +107,19 @@ public section. "! @parameter I_HTTP_STATUS | HTTP status code if exception is triggered by HTTP error "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised. "! - class-methods RAISE_EXCEPTION + class-methods raise_exception importing - !I_MSGNO type SY-MSGNO optional - !I_MSGV1 type STRING optional - !I_MSGV2 type STRING optional - !I_MSGV3 type STRING optional - !I_MSGV4 type STRING optional - !I_TEXT type STRING optional - !I_SUBRC type SY-SUBRC default C_SUBRC_UNKNOWN - !I_PREVIOUS type ref to CX_ROOT optional - !I_HTTP_STATUS type TS_HTTP_STATUS optional + !i_msgno type sy-msgno optional + !i_msgv1 type string optional + !i_msgv2 type string optional + !i_msgv3 type string optional + !i_msgv4 type string optional + !i_text type string optional + !i_subrc type sy-subrc default c_subrc_unknown + !i_previous type ref to cx_root optional + !i_http_status type ts_http_status optional raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Returns field type and length of a given parameter.
"! "! @parameter I_FIELD | Field of type that is supposed to be determined. @@ -127,23 +127,23 @@ public section. "! @parameter E_RELATIVE_TYPE | Relative type (= data type) of I_FIELD. "! @parameter E_LENGTH | Length of type of I_FIELD. "! - class-methods GET_FIELD_TYPE + class-methods get_field_type importing - !I_FIELD type ANY + !i_field type any exporting - !E_TECHNICAL_TYPE type ZIF_IBMC_SERVICE_ARCH~CHAR - !E_RELATIVE_TYPE type STRING - !E_LENGTH type I . + !e_technical_type type ZIF_IBMC_service_arch~char + !e_relative_type type string + !e_length type i . "!Returns component names of a given structure.
"! "! @parameter I_STRUCTURE | Structure with components. "! @parameter E_COMPONENTS | Internal table of component names. "! - class-methods GET_COMPONENTS + class-methods get_components importing - !I_STRUCTURE type ANY + !i_structure type any exporting - value(E_COMPONENTS) type ZIF_IBMC_SERVICE_ARCH~TT_STRING . + value(e_components) type ZIF_IBMC_service_arch~tt_string . "!Parses a JSON string into an ABAP structure.
"! "! @parameter I_JSON | JSON string. @@ -151,103 +151,103 @@ public section. "! @parameter C_ABAP | ABAP structure to be filled "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - class-methods PARSE_JSON + class-methods parse_json importing - !I_JSON type STRING - !I_DICTIONARY type ANY optional + !i_json type string + !i_dictionary type any optional changing - value(C_ABAP) type ANY + value(c_abap) type any raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Method for internal use.
"! - methods GET_REQUEST_PROP + methods get_request_prop importing - !I_AUTH_METHOD type STRING default C_DEFAULT + !i_auth_method type string default c_default returning - value(E_REQUEST_PROP) type TS_REQUEST_PROP . + value(e_request_prop) type ts_request_prop . "!Returns data type of a given parameter.
"! "! @parameter I_FIELD | Field of type that is supposed to be determined. "! @parameter E_DATATYPE | Technical type (= base type) of I_FIELD. "! - class-methods GET_DATATYPE + class-methods get_datatype importing - !I_FIELD type ANY + !i_field type any returning - value(E_DATATYPE) type ZIF_IBMC_SERVICE_ARCH~CHAR . + value(e_datatype) type ZIF_IBMC_service_arch~char . "!Unescape unicode codepoints to characters in a string
, "! e.g. '\u0041 b \u0063' -> 'A b c' "! "! @parameter I_IN | String with unicode codepoints. "! @parameter E_OUT | Unescaped string. "! - class-methods UNESCAPE_UNICODE + class-methods unescape_unicode importing - !I_IN type STRING + !i_in type string returning - value(E_OUT) type STRING . + value(e_out) type string . "!Returns the file extension for a mime type
, "! e.g. 'text/plain' -> 'txt' "! "! @parameter I_MIME_TYPE | MIME type. "! @parameter E_EXTENSION | File extension (without leading dot). "! - class-methods GET_FILE_EXTENSION + class-methods get_file_extension importing - value(I_MIME_TYPE) type STRING + value(i_mime_type) type string returning - value(E_EXTENSION) type STRING . + value(e_extension) type string . "!Moves a referenced data structure to an ABAP structure.
"! "! @parameter I_DATA_REFERENCE | Reference to data object. "! @parameter E_ABAP | ABAP structure to be filled. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - class-methods MOVE_DATA_REFERENCE_TO_ABAP + class-methods move_data_reference_to_abap importing - !I_DATA_REFERENCE type DATA_REFERENCE + !i_data_reference type data_reference exporting - value(E_ABAP) type ANY + value(e_abap) type any raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Method for internal use.
"! - class-methods ADD_QUERY_PARAMETER + class-methods add_query_parameter importing - !I_PARAMETER type STRING - !I_VALUE type STRING - !I_IS_BOOLEAN type BOOLEAN default C_BOOLEAN_FALSE + !i_parameter type string + !i_value type string + !i_is_boolean type boolean default c_boolean_false changing - !C_URL type TS_URL . + !c_url type ts_url . "!Method for internal use.
"! - class-methods ADD_HEADER_PARAMETER + class-methods add_header_parameter importing - !I_PARAMETER type STRING - !I_VALUE type STRING - !I_IS_BOOLEAN type BOOLEAN default C_BOOLEAN_FALSE + !i_parameter type string + !i_value type string + !i_is_boolean type boolean default c_boolean_false changing - !C_HEADERS type ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP-HEADERS . + !c_headers type ZIF_IBMC_service_arch~ts_request_prop-headers . "!Method for internal use.
"! - class-methods GET_FULL_URL + class-methods get_full_url importing - !I_URL type TS_URL + !i_url type ts_url returning - value(E_URL) type STRING . + value(e_url) type string . "!Returns the service name.
"! "! @parameter E_APPNAME | Name of the service. "! - methods GET_APPNAME + methods get_appname returning - value(E_APPNAME) type STRING . + value(e_appname) type string . "!Method for internal use.
"! - class-methods NORMALIZE_URL + class-methods normalize_url changing - !C_URL type TS_URL . + !c_url type ts_url . "!Extracts a JSON string from an ABAP structure.
"! "! @parameter I_NAME | Name of component to be extracted. @@ -260,27 +260,27 @@ public section. "! @parameter I_LOWER_CASE | If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case. "! @parameter E_JSON | JSON string. "! - class-methods ABAP_TO_JSON + class-methods abap_to_json importing - !I_NAME type STRING optional - !I_VALUE type ANY - !I_DICTIONARY type ANY optional - !I_REQUIRED_FIELDS type ANY optional - !I_LOWER_CASE type BOOLEAN default C_BOOLEAN_TRUE + !i_name type string optional + !i_value type any + !i_dictionary type any optional + !i_required_fields type any optional + !i_lower_case type boolean default c_boolean_true returning - value(E_JSON) type STRING . + value(e_json) type string . "!Throws an exception, if HTTP response indicates an error.
"! "! @parameter I_RESPONSE | HTTP response to be checked. "! @parameter I_URL | URL that the request has been sent to. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - methods CHECK_HTTP_RESPONSE + methods check_http_response importing - !I_RESPONSE type TO_REST_RESPONSE optional - !I_URL type TS_URL optional + !i_response type to_rest_response optional + !i_url type ts_url optional raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Class constructor.
"! "! @parameter I_URL | URL of the service. @@ -294,82 +294,95 @@ public section. "! @parameter I_SSL_ID | ID of PSE, not applicable on SAP Cloud Platform. "! @parameter I_DEBUG_MODE | not used. "! - methods CONSTRUCTOR + methods constructor importing - !I_URL type STRING optional - !I_HOST type STRING optional - !I_PROXY_HOST type STRING optional - !I_PROXY_PORT type STRING optional - !I_USERNAME type STRING optional - !I_PASSWORD type STRING optional - !I_APIKEY type STRING optional - !I_ACCESS_TOKEN type TS_ACCESS_TOKEN optional - !I_SSL_ID type ZIF_IBMC_SERVICE_ARCH~TY_SSL_ID optional - !I_DEBUG_MODE type CHAR default SPACE . + !i_url type string optional + !i_host type string optional + !i_proxy_host type string optional + !i_proxy_port type string optional + !i_username type string optional + !i_password type string optional + !i_apikey type string optional + !i_access_token type ts_access_token optional + !i_ssl_id type ZIF_IBMC_service_arch~ty_ssl_id optional + !i_debug_mode type char default space . "!Method for internal use.
"! - methods GET_REST_CLIENT + methods get_rest_client importing - !I_REQUEST_PROP type TS_REQUEST_PROP + !i_request_prop type ts_request_prop returning - value(E_CLIENT) type TS_CLIENT + value(e_client) type ts_client raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Method for internal use.
"! - methods GET_ACCESS_TOKEN + methods get_access_token importing - !I_REQUEST_PROP type TS_REQUEST_PROP optional + !i_request_prop type ts_request_prop optional returning - value(E_ACCESS_TOKEN) type TS_ACCESS_TOKEN + value(e_access_token) type ts_access_token raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Sends a HTTP DELETE request.
"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - methods HTTP_DELETE + methods http_delete importing - !I_REQUEST_PROP type TS_REQUEST_PROP + !i_request_prop type ts_request_prop returning - value(E_RESPONSE) type TO_REST_RESPONSE + value(e_response) type to_rest_response raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Sets an access token explicitly.
"! "! @parameter I_ACCESS_TOKEN | Access token. "! - methods SET_ACCESS_TOKEN + methods set_access_token importing - !I_ACCESS_TOKEN type TS_ACCESS_TOKEN . + !i_access_token type ts_access_token . "!Sends a HTTP GET request.
"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - methods HTTP_GET + methods http_get importing - !I_REQUEST_PROP type TS_REQUEST_PROP + !i_request_prop type ts_request_prop returning - value(E_RESPONSE) type TO_REST_RESPONSE + value(e_response) type to_rest_response raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Sends a HTTP POST request.
"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - methods HTTP_POST + methods http_post importing - !I_REQUEST_PROP type TS_REQUEST_PROP + !i_request_prop type ts_request_prop returning - value(E_RESPONSE) type TO_REST_RESPONSE + value(e_response) type to_rest_response raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . + "!Sends a HTTP PATCH request.
+ "! + "! @parameter I_REQUEST_PROP | Request properties. + "! @parameter E_RESPONSE | Response returned by service. + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods http_patch + importing + !i_request_prop type ts_request_prop + returning + value(e_response) type to_rest_response + raising + ZCX_IBMC_service_exception . "!Sends a HTTP POST request with multipart body.
"! "! @parameter I_REQUEST_PROP | Request properties. @@ -377,52 +390,52 @@ public section. "! @parameter E_RESPONSE | Response returned by service. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - methods HTTP_POST_MULTIPART + methods http_post_multipart importing - !I_REQUEST_PROP type TS_REQUEST_PROP - !IT_FORM_PART type TT_FORM_PART + !i_request_prop type ts_request_prop + !it_form_part type tt_form_part returning - value(E_RESPONSE) type TO_REST_RESPONSE + value(e_response) type to_rest_response raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . "!Sends a HTTP PUT request.
"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! - methods HTTP_PUT + methods http_put importing - !I_REQUEST_PROP type TS_REQUEST_PROP + !i_request_prop type ts_request_prop returning - value(E_RESPONSE) type TO_REST_RESPONSE + value(e_response) type to_rest_response raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . protected section. "!Method for internal use.
- methods ADJUST_REQUEST_PROP + methods adjust_request_prop changing - !C_REQUEST_PROP type TS_REQUEST_PROP . + !c_request_prop type ts_request_prop . "!Method for internal use.
- class-methods MERGE_STRUCTURE + class-methods merge_structure importing - !I_ALTERNATIVE type ANY + !i_alternative type any changing - !C_BASE type ANY . + !c_base type any . "!Method for internal use.
- methods SET_DEFAULT_QUERY_PARAMETERS + methods set_default_query_parameters changing - !C_URL type TS_URL . + !c_url type ts_url . "!Method for internal use.
- methods SET_URI_AND_AUTHORIZATION + methods set_uri_and_authorization importing - !I_CLIENT type TS_CLIENT - !I_REQUEST_PROP type TS_REQUEST_PROP + !i_client type ts_client + !i_request_prop type ts_request_prop returning - value(E_URI) type STRING + value(e_uri) type string raising - ZCX_IBMC_SERVICE_EXCEPTION . + ZCX_IBMC_service_exception . private section. ENDCLASS. @@ -431,6 +444,16 @@ ENDCLASS. CLASS ZCL_IBMC_SERVICE IMPLEMENTATION. +*Returns the user's time zone.
"! @@ -51,7 +46,7 @@ CLASS zcl_ibmc_service_arch DEFINITION "! CLASS-METHODS get_timezone RETURNING - VALUE(e_timezone) TYPE zif_ibmc_service_arch~ty_timezone . + VALUE(e_timezone) TYPE ZIF_IBMC_SERVICE_ARCH~ty_timezone . "!Returns an ABAP module identifier.
"! "! @parameter E_PROGNAME | ABAP module identifier @@ -71,7 +66,7 @@ CLASS zcl_ibmc_service_arch DEFINITION RETURNING VALUE(e_binary) TYPE xstring RAISING - zcx_ibmc_service_exception . + ZCX_IBMC_SERVICE_EXCEPTION . "!Returns a HTTP/REST client based on an URL.
"! "! @parameter I_URL | URL @@ -86,7 +81,7 @@ CLASS zcl_ibmc_service_arch DEFINITION EXPORTING !e_client TYPE ts_client RAISING - zcx_ibmc_service_exception . + ZCX_IBMC_SERVICE_EXCEPTION . "!Returns the default proxy host and port.
"! "! @parameter I_URL | target URL @@ -139,9 +134,9 @@ CLASS zcl_ibmc_service_arch DEFINITION METHODS add_form_part IMPORTING !i_client TYPE ts_client - !it_form_part TYPE zif_ibmc_service_arch~tt_form_part + !it_form_part TYPE ZIF_IBMC_SERVICE_ARCH~tt_form_part RAISING - zcx_ibmc_service_exception . + ZCX_IBMC_SERVICE_EXCEPTION . "!Executes a HTTP request.
"! "! @parameter I_CLIENT | HTTP/REST client @@ -152,11 +147,11 @@ CLASS zcl_ibmc_service_arch DEFINITION CLASS-METHODS execute IMPORTING !i_client TYPE ts_client - !i_method TYPE zif_ibmc_service_arch~char + !i_method TYPE ZIF_IBMC_SERVICE_ARCH~char RETURNING VALUE(e_response) TYPE to_rest_response RAISING - zcx_ibmc_service_exception . + ZCX_IBMC_SERVICE_EXCEPTION . "!Reads character data from a HTTP response.
"! "! @parameter I_RESPONSE | HTTP response @@ -203,10 +198,10 @@ CLASS zcl_ibmc_service_arch DEFINITION "! CLASS-METHODS get_response_header IMPORTING - !i_response type to_rest_response - !i_header_field type string + !i_response TYPE to_rest_response + !i_header_field TYPE string RETURNING - VALUE(e_value) type string . + VALUE(e_value) TYPE string . "!Returns the status of a REST response.
"! "! @parameter I_REST_RESPONSE | HTTP/REST response @@ -228,14 +223,44 @@ CLASS zcl_ibmc_service_arch DEFINITION RETURNING VALUE(e_utf8) TYPE xstring RAISING - zcx_ibmc_service_exception . + ZCX_IBMC_SERVICE_EXCEPTION . + "!Finds (and replaces) a regular expression.
+ "! + "! @parameter I_REGEX | Regular expression + "! @parameter I_WITH | Replacement (if omitted, FIND is performed) + "! @parameter I_ALL_OCCURRENCES | 'X' if ALL OCCURRENCES OF should be used + "! @parameter I_IGNORING_CASE | 'X', if IGNORING CASE should be used + "! @parameter I_IN | String to be searched + "! @parameter E_OFFSET | Returns position of occurrence + "! @parameter C_SUBMATCH1 | 1st submatch + "! @parameter C_SUBMATCH2 | 2nd submatch + "! @parameter C_SUBMATCH3 | 3rd submatch + "! @parameter C_IN | String to be searched and returned + "! @parameter E_SUBRC | sy-subrc of FIND / REPLACE + "! + CLASS-METHODS find_regex + IMPORTING + !i_regex TYPE string + !i_with TYPE string OPTIONAL + !i_all_occurrences TYPE ZIF_IBMC_SERVICE_ARCH=>boolean DEFAULT 'X' + !i_ignoring_case TYPE ZIF_IBMC_SERVICE_ARCH=>boolean OPTIONAL + !i_in TYPE string OPTIONAL + EXPORTING + !e_offset TYPE int4 + CHANGING + !c_submatch1 TYPE string OPTIONAL + !c_submatch2 TYPE string OPTIONAL + !c_submatch3 TYPE string OPTIONAL + !c_in TYPE string OPTIONAL + RETURNING + VALUE(e_subrc) TYPE sysubrc . PROTECTED SECTION. PRIVATE SECTION. ENDCLASS. -CLASS zcl_ibmc_service_arch IMPLEMENTATION. +CLASS ZCL_IBMC_SERVICE_ARCH IMPLEMENTATION. METHOD base64_decode. @@ -300,16 +325,19 @@ CLASS zcl_ibmc_service_arch IMPLEMENTATION. TRY. CASE i_method. - WHEN zif_ibmc_service_arch~c_method_get. + WHEN ZIF_IBMC_SERVICE_ARCH~c_method_get. lv_method = 'GET'. e_response = i_client-http->execute( if_web_http_client=>get ). - WHEN zif_ibmc_service_arch~c_method_post. + WHEN ZIF_IBMC_SERVICE_ARCH~c_method_post. lv_method = 'POST'. e_response = i_client-http->execute( if_web_http_client=>post ). - WHEN zif_ibmc_service_arch~c_method_put. + WHEN ZIF_IBMC_SERVICE_ARCH~c_method_put. lv_method = 'PUT'. e_response = i_client-http->execute( if_web_http_client=>put ). - WHEN zif_ibmc_service_arch~c_method_delete. + WHEN ZIF_IBMC_SERVICE_ARCH~c_method_patch. + lv_method = 'PATCH'. + e_response = i_client-http->execute( if_web_http_client=>patch ). + WHEN ZIF_IBMC_SERVICE_ARCH~c_method_delete. lv_method = 'DELETE'. e_response = i_client-http->execute( if_web_http_client=>delete ). ENDCASE. @@ -327,8 +355,8 @@ CLASS zcl_ibmc_service_arch IMPLEMENTATION. METHOD add_form_part. DATA: - ls_form_part TYPE zif_ibmc_service_arch~ts_form_part, - lo_part TYPE REF TO if_web_http_request. + ls_form_part TYPE ZIF_IBMC_SERVICE_ARCH~ts_form_part, + lo_part TYPE REF TO if_web_http_request. LOOP AT it_form_part INTO ls_form_part. @@ -345,7 +373,7 @@ CLASS zcl_ibmc_service_arch IMPLEMENTATION. ENDIF. IF NOT ls_form_part-xdata IS INITIAL. - data(lv_length) = xstrlen( ls_form_part-xdata ). + DATA(lv_length) = xstrlen( ls_form_part-xdata ). lo_part->set_binary( i_data = ls_form_part-xdata i_offset = 0 i_length = lv_length ). ENDIF. @@ -364,7 +392,7 @@ CLASS zcl_ibmc_service_arch IMPLEMENTATION. METHOD get_http_status. - DATA: ls_status TYPE ts_http_stat. + DATA: ls_status TYPE if_web_http_response=>http_status. ls_status = i_rest_response->get_status( ). e_status-code = ls_status-code. @@ -453,5 +481,81 @@ CLASS zcl_ibmc_service_arch IMPLEMENTATION. i_client-request->set_uri_path( i_uri_path = i_uri ). ENDMETHOD. -ENDCLASS. + +*Factory method to instantiate a service specific wrapper class.
+ "!Factory method to instantiate a service wrapper class.
"! "! @parameter I_INSTANCE_ID | "! Value of field INSTANCE_UID in table ZIBMC_CONFIG. @@ -200,6 +200,13 @@ ENDCLASS. CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. +*"! If processing metrics are requested, information about the
"! service's processing of the input audio. Processing metrics are not - "! available with the synchronous **Recognize audio** method. + "! available with the synchronous [Recognize audio](#recognize) method. begin of T_PROCESSING_METRICS, "! Detailed timing information about the service's processing of the input "! audio. @@ -286,9 +299,14 @@ public section. "!"! Component results for a speech recognition request.
begin of T_SPEECH_RECOGNITION_RESULT, - "! An indication of whether the transcription results are final. If `true`, the - "! results for this utterance are not updated further; no additional results are - "! sent for a `result_index` once its results are indicated as final. + "! An indication of whether the transcription results are final:"! Information about an existing custom language model.
begin of T_LANGUAGE_MODEL, - "! The customization ID (GUID) of the custom language model. The **Create a custom - "! language model** method returns only this field of the object; it does not - "! return the other fields. + "! The customization ID (GUID) of the custom language model. The [Create a custom + "! language model](#createlanguagemodel) method returns only this field of the + "! object; it does not return the other fields. CUSTOMIZATION_ID type STRING, "! The date and time in Coordinated Universal Time (UTC) at which the custom "! language model was created. The value is provided in full ISO 8601 format @@ -701,12 +766,18 @@ public section. "! when a language model is first added but has yet to be updated. The value is "! provided in full ISO 8601 format (YYYY-MM-DDThh:mm:ss.sTZD). UPDATED type STRING, - "! The language identifier of the custom language model (for example, `en-US`). + "! The language identifier of the custom language model (for example, `en-US`). The + "! value matches the five-character language identifier from the name of the base + "! model for the custom model. This value might be different from the value of the + "! `dialect` field. LANGUAGE type STRING, - "! The dialect of the language for the custom language model. For non-Spanish - "! models, the field matches the language of the base model; for example, `en-US` - "! for either of the US English language models. For Spanish models, the field - "! indicates the dialect for which the model was created:"! Information about an existing custom acoustic model.
begin of T_ACOUSTIC_MODEL, - "! The customization ID (GUID) of the custom acoustic model. The **Create a custom - "! acoustic model** method returns only this field of the object; it does not - "! return the other fields. + "! The customization ID (GUID) of the custom acoustic model. The [Create a custom + "! acoustic model](#createacousticmodel) method returns only this field of the + "! object; it does not return the other fields. CUSTOMIZATION_ID type STRING, "! The date and time in Coordinated Universal Time (UTC) at which the custom "! acoustic model was created. The value is provided in full ISO 8601 format @@ -785,8 +856,8 @@ public section. LANGUAGE type STRING, "! A list of the available versions of the custom acoustic model. Each element of "! the array indicates a version of the base model with which the custom model can - "! be used. Multiple versions exist only if the custom model has been upgraded; - "! otherwise, only a single version is shown. + "! be used. Multiple versions exist only if the custom model has been upgraded to + "! a new version of its base model. Otherwise, only a single version is shown. VERSIONS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, "! The GUID of the credentials for the instance of the service that owns the custom "! acoustic model. @@ -836,10 +907,10 @@ public section. "! encoding if it encounters non-ASCII characters.- "! Additional service features that are supported with the
- "! model. + "! Indicates whether select service features are supported with + "! the model. begin of T_SUPPORTED_FEATURES, "! Indicates whether the customization interface can be used to create a custom "! language model based on the language model. CUSTOM_LANGUAGE_MODEL type BOOLEAN, + "! Indicates whether the customization interface can be used to create a custom + "! acoustic model based on the language model. + CUSTOM_ACOUSTIC_MODEL type BOOLEAN, "! Indicates whether the `speaker_labels` parameter can be used with the language "! model."! Information about the new custom language model.
begin of T_CREATE_LANGUAGE_MODEL, - "! A user-defined name for the new custom language model. Use a name that is unique - "! among all custom language models that you own. Use a localized name that + "! A user-defined name for the new custom language model. Use a localized name that "! matches the language of the custom model. Use a name that describes the domain "! of the custom model, such as `Medical custom model` or `Legal custom model`. + "! Use a name that is unique among all custom language models that you own."! Information about the new custom acoustic model.
begin of T_CREATE_ACOUSTIC_MODEL, - "! A user-defined name for the new custom acoustic model. Use a name that is unique - "! among all custom acoustic models that you own. Use a localized name that + "! A user-defined name for the new custom acoustic model. Use a localized name that "! matches the language of the custom model. Use a name that describes the "! acoustic environment of the custom model, such as `Mobile custom model` or - "! `Noisy car custom model`. + "! `Noisy car custom model`. Use a name that is unique among all custom acoustic + "! models that you own.Unregister a callback
- "! Unregisters a callback URL that was previously allowlisted with a **Register a - "! callback** request for use with the asynchronous interface. Once unregistered, - "! the URL can no longer be used with asynchronous recognition requests.List corpora
"! Lists information about all corpora from a custom language model. The - "! information includes the total number of words and out-of-vocabulary (OOV) - "! words, name, and status of each corpus. You must use credentials for the - "! instance of the service that owns a model to list its corpora.Get a corpus
"! Gets information about a corpus from a custom language model. The information - "! includes the total number of words and out-of-vocabulary (OOV) words, name, and - "! status of the corpus. You must use credentials for the instance of the service - "! that owns a model to list its corpora.Delete a corpus
- "! Deletes an existing corpus from a custom language model. The service removes any - "! out-of-vocabulary (OOV) words that are associated with the corpus from the - "! custom model's words resource unless they were also added by another - "! corpus or grammar, or they were modified in some way with the **Add custom - "! words** or **Add a custom word** method. Removing a corpus does not affect the - "! custom model until you train the model with the **Train a custom language - "! model** method. You must use credentials for the instance of the service that - "! owns a model to delete its corpora.List custom words
"! Lists information about custom words from a custom language model. You can list "! all words from the custom model's words resource, only custom words that - "! were added or modified by the user, or only out-of-vocabulary (OOV) words that - "! were extracted from corpora or are recognized by grammars. You can also - "! indicate the order in which the service is to return words; by default, the - "! service lists words in ascending alphabetical order. You must use credentials - "! for the instance of the service that owns a model to list information about its - "! words.Add custom words
- "! Adds one or more custom words to a custom language model. The service populates - "! the words resource for a custom model with out-of-vocabulary (OOV) words from - "! each corpus or grammar that is added to the model. You can use this method to - "! add additional words or to modify existing words in the words resource. The - "! words resource for a model can contain a maximum of 90 thousand custom (OOV) - "! words. This includes words that the service extracts from corpora and grammars - "! and words that you add directly.Add a custom word
- "! Adds a custom word to a custom language model. The service populates the words + "! Adds a custom word to a custom language model. You can use this method to add a + "! word or to modify an existing word in the words resource. _For custom models + "! that are based on previous-generation models_, the service populates the words "! resource for a custom model with out-of-vocabulary (OOV) words from each corpus - "! or grammar that is added to the model. You can use this method to add a word or - "! to modify an existing word in the words resource. The words resource for a - "! model can contain a maximum of 90 thousand custom (OOV) words. This includes - "! words that the service extracts from corpora and grammars and words that you - "! add directly.List grammars
- "! Lists information about all grammars from a custom language model. The - "! information includes the total number of out-of-vocabulary (OOV) words, name, - "! and status of each grammar. You must use credentials for the instance of the - "! service that owns a model to list its grammars.Get a grammar
- "! Gets information about a grammar from a custom language model. The information - "! includes the total number of out-of-vocabulary (OOV) words, name, and status of - "! the grammar. You must use credentials for the instance of the service that owns - "! a model to list its grammars.Delete a grammar
- "! Deletes an existing grammar from a custom language model. The service removes - "! any out-of-vocabulary (OOV) words associated with the grammar from the custom - "! model's words resource unless they were also added by another resource or - "! they were modified in some way with the **Add custom words** or **Add a custom - "! word** method. Removing a grammar does not affect the custom model until you - "! train the model with the **Train a custom language model** method. You must use - "! credentials for the instance of the service that owns a model to delete its - "! grammar.+ "! Information about a speaker model.
+ begin of T_SPEAKER, + "! The speaker ID (GUID) of the speaker. + SPEAKER_ID type STRING, + "! The user-defined name of the speaker. + NAME type STRING, + end of T_SPEAKER. + types: + "!+ "! Information about a custom prompt.
+ begin of T_PROMPT, + "! The user-specified text of the prompt. + PROMPT type STRING, + "! The user-specified identifier (name) of the prompt. + PROMPT_ID type STRING, + "! The status of the prompt:"! Information about a word for the custom model.
@@ -65,9 +113,9 @@ public section. "!"! Information about an existing custom model.
begin of T_CUSTOM_MODEL, - "! The customization ID (GUID) of the custom model. The **Create a custom model** - "! method returns only this field. It does not not return the other fields of this - "! object. + "! The customization ID (GUID) of the custom model. The [Create a custom + "! model](#createcustommodel) method returns only this field. It does not not + "! return the other fields of this object. CUSTOMIZATION_ID type STRING, "! The name of the custom model. NAME type STRING, @@ -89,10 +137,15 @@ public section. DESCRIPTION type STRING, "! An array of `Word` objects that lists the words and their translations from the "! custom model. The words are listed in alphabetical order, with uppercase - "! letters listed before lowercase letters. The array is empty if the custom model - "! contains no words. This field is returned only by the **Get a voice** method - "! and only when you specify the customization ID of a custom model. + "! letters listed before lowercase letters. The array is empty if no words are + "! defined for the custom model. This field is returned only by the [Get a custom + "! model](#getcustommodel) method. WORDS type STANDARD TABLE OF T_WORD WITH NON-UNIQUE DEFAULT KEY, + "! An array of `Prompt` objects that provides information about the prompts that + "! are defined for the specified custom model. The array is empty if no prompts + "! are defined for the custom model. This field is returned only by the [Get a + "! custom model](#getcustommodel) method. + PROMPTS type STANDARD TABLE OF T_PROMPT WITH NON-UNIQUE DEFAULT KEY, end of T_CUSTOM_MODEL. types: "!@@ -129,10 +182,52 @@ public section. "! Additional service features that are supported with the voice. SUPPORTED_FEATURES type T_SUPPORTED_FEATURES, "! Returns information about a specified custom model. This field is returned only - "! by the **Get a voice** method and only when you specify the customization ID of - "! a custom model. + "! by the [Get a voice](#getvoice) method and only when you specify the + "! customization ID of a custom model. CUSTOMIZATION type T_CUSTOM_MODEL, end of T_VOICE. + types: + "!
+ "! A prompt that a speaker has defined for a custom model.
+ begin of T_SPEAKER_PROMPT, + "! The user-specified text of the prompt. + PROMPT type STRING, + "! The user-specified identifier (name) of the prompt. + PROMPT_ID type STRING, + "! The status of the prompt:+ "! A custom models for which the speaker has defined prompts.
+ begin of T_SPEAKER_CUSTOM_MODEL, + "! The customization ID (GUID) of a custom model for which the speaker has defined + "! one or more prompts. + CUSTOMIZATION_ID type STRING, + "! An array of `SpeakerPrompt` objects that provides information about each prompt + "! that the user has defined for the custom model. + PROMPTS type STANDARD TABLE OF T_SPEAKER_PROMPT WITH NON-UNIQUE DEFAULT KEY, + end of T_SPEAKER_CUSTOM_MODEL. + types: + "!+ "! Custom models for which the speaker has defined prompts.
+ begin of T_SPEAKER_CUSTOM_MODELS, + "! An array of `SpeakerCustomModel` objects. Each object provides information about + "! the prompts that are defined for a specified speaker in the custom models that + "! are owned by a specified service instance. The array is empty if no prompts are + "! defined for the speaker. + CUSTOMIZATIONS type STANDARD TABLE OF T_SPEAKER_CUSTOM_MODEL WITH NON-UNIQUE DEFAULT KEY, + end of T_SPEAKER_CUSTOM_MODELS. types: "!"! The error response from a failed request.
@@ -146,23 +241,30 @@ public section. end of T_ERROR_MODEL. types: "!- "! For the **Add custom words** method, one or more words that
- "! are to be added or updated for the custom model and the translation for each - "! specified word.+ "! The speaker ID of the speaker model.
+ begin of T_SPEAKER_MODEL, + "! The speaker ID (GUID) of the speaker model. + SPEAKER_ID type STRING, + end of T_SPEAKER_MODEL. types: "!"! Information about all available voices.
@@ -170,6 +272,46 @@ public section. "! A list of available voices. VOICES type STANDARD TABLE OF T_VOICE WITH NON-UNIQUE DEFAULT KEY, end of T_VOICES. + types: + "!+ "! Information about the prompt that is to be added to a custom
+ "! model. The following example of a `PromptMetadata` object includes both the + "! required prompt text and an optional speaker model ID:"! Information about the updated custom model.
@@ -191,15 +333,22 @@ public section. "!"! Information about the new custom model.
begin of T_CREATE_CUSTOM_MODEL, - "! The name of the new custom model. + "! The name of the new custom model. Use a localized name that matches the language + "! of the custom model. Use a name that describes the purpose of the custom model, + "! such as `Medical custom model` or `Legal custom model`. Use a name that is + "! unique among all custom models that you own.+ "! Information about all speaker models for the service
+ "! instance. + begin of T_SPEAKERS, + "! An array of `Speaker` objects that provides information about the speakers for + "! the service instance. The array is empty if the service instance has no + "! speakers. + SPEAKERS type STANDARD TABLE OF T_SPEAKER WITH NON-UNIQUE DEFAULT KEY, + end of T_SPEAKERS. types: "!"! The pronunciation of the specified text.
@@ -220,6 +384,16 @@ public section. "! custom model is specified, the pronunciation also reflects that custom model. PRONUNCIATION type STRING, end of T_PRONUNCIATION. + types: + "!+ "! Information about the custom prompts that are defined for a
+ "! custom model. + begin of T_PROMPTS, + "! An array of `Prompt` objects that provides information about the prompts that + "! are defined for the specified custom model. The array is empty if no prompts + "! are defined for the custom model. + PROMPTS type STANDARD TABLE OF T_PROMPT WITH NON-UNIQUE DEFAULT KEY, + end of T_PROMPTS. types: "!"! Information about existing custom models.
@@ -253,17 +427,27 @@ public section. constants: "!List of required fields per type.
begin of C_REQUIRED_FIELDS, + T_SPEAKER type string value '|SPEAKER_ID|NAME|', + T_PROMPT type string value '|PROMPT|PROMPT_ID|STATUS|', T_WORD type string value '|WORD|TRANSLATION|', T_CUSTOM_MODEL type string value '|CUSTOMIZATION_ID|', T_SUPPORTED_FEATURES type string value '|CUSTOM_PRONUNCIATION|VOICE_TRANSFORMATION|', T_VOICE type string value '|URL|GENDER|NAME|LANGUAGE|DESCRIPTION|CUSTOMIZABLE|SUPPORTED_FEATURES|', + T_SPEAKER_PROMPT type string value '|PROMPT|PROMPT_ID|STATUS|', + T_SPEAKER_CUSTOM_MODEL type string value '|CUSTOMIZATION_ID|PROMPTS|', + T_SPEAKER_CUSTOM_MODELS type string value '|CUSTOMIZATIONS|', T_ERROR_MODEL type string value '|ERROR|CODE|', T_WORDS type string value '|WORDS|', + T_SPEAKER_MODEL type string value '|SPEAKER_ID|', T_VOICES type string value '|VOICES|', + T_PROMPT_METADATA type string value '|PROMPT_TEXT|', + T_INLINE_OBJECT type string value '|METADATA|FILE|', T_UPDATE_CUSTOM_MODEL type string value '|', T_CREATE_CUSTOM_MODEL type string value '|NAME|', T_TEXT type string value '|TEXT|', + T_SPEAKERS type string value '|SPEAKERS|', T_PRONUNCIATION type string value '|PRONUNCIATION|', + T_PROMPTS type string value '|PROMPTS|', T_CUSTOM_MODELS type string value '|CUSTOMIZATIONS|', T_TRANSLATION type string value '|TRANSLATION|', __DUMMY type string value SPACE, @@ -290,13 +474,22 @@ constants: CREATED type string value 'created', LAST_MODIFIED type string value 'last_modified', WORDS type string value 'words', + PROMPTS type string value 'prompts', WORD type string value 'word', TRANSLATION type string value 'translation', PART_OF_SPEECH type string value 'part_of_speech', PRONUNCIATION type string value 'pronunciation', + PROMPT type string value 'prompt', + PROMPT_ID type string value 'prompt_id', + STATUS type string value 'status', ERROR type string value 'error', + SPEAKER_ID type string value 'speaker_id', + SPEAKERS type string value 'speakers', + PROMPT_TEXT type string value 'prompt_text', CODE type string value 'code', CODE_DESCRIPTION type string value 'code_description', + METADATA type string value 'metadata', + FILE type string value 'file', end of C_ABAPNAME_DICTIONARY . @@ -313,11 +506,19 @@ constants: "! the name, language, gender, and other details about the voice. The ordering of "! the list of voices can change from call to call; do not rely on an alphabetized "! or static list of voices. To see information about a specific voice, use the - "! **Get a voice** method.List custom models
"! Lists metadata such as the name and description for all custom models that are "! owned by an instance of the service. Specify a language to list the custom - "! models for that language only. To see the words in addition to the metadata for - "! a specific custom model, use the **List a custom model** method. You must use - "! credentials for the instance of the service that owns a model to list - "! information about it.Get a custom model
"! Gets all information about a specified custom model. In addition to metadata "! such as the name and description of the custom model, the output includes the - "! words and their translations as defined in the model. To see just the metadata - "! for a model, use the **List custom models** method.List custom prompts
+ "! Lists information about all custom prompts that are defined for a custom model. + "! The information includes the prompt ID, prompt text, status, and optional + "! speaker ID for each prompt of the custom model. You must use credentials for + "! the instance of the service that owns the custom model. The same information + "! about all of the prompts for a custom model is also provided by the [Get a + "! custom model](#getcustommodel) method. That method provides complete details + "! about a specified custom model, including its language, owner, custom words, + "! and more. Custom prompts are supported only for use with US English custom + "! models and voices.Add a custom prompt
+ "! Adds a custom prompt to a custom model. A prompt is defined by the text that is + "! to be spoken, the audio for that text, a unique user-specified ID for the + "! prompt, and an optional speaker ID. The information is used to generate + "! prosodic data that is not visible to the user. This data is used by the service + "! to produce the synthesized audio upon request. You must use credentials for the + "! instance of the service that owns a custom model to add a prompt to it. You can + "! add a maximum of 1000 custom prompts to a single custom model.Get a custom prompt
+ "! Gets information about a specified custom prompt for a specified custom model. + "! The information includes the prompt ID, prompt text, status, and optional + "! speaker ID for each prompt of the custom model. You must use credentials for + "! the instance of the service that owns the custom model. Custom prompts are + "! supported only for use with US English custom models and voices.Delete a custom prompt
+ "! Deletes an existing custom prompt from a custom model. The service deletes the + "! prompt with the specified ID. You must use credentials for the instance of the + "! service that owns the custom model from which the prompt is to be deleted. + "!List speaker models
+ "! Lists information about all speaker models that are defined for a service + "! instance. The information includes the speaker ID and speaker name of each + "! defined speaker. You must use credentials for the instance of a service to list + "! its speakers. Speaker models and the custom prompts with which they are used + "! are supported only for use with US English custom models and voices.Create a speaker model
+ "! Creates a new speaker model, which is an optional enrollment token for users who + "! are to add prompts to custom models. A speaker model contains information about + "! a user's voice. The service extracts this information from a WAV audio + "! sample that you pass as the body of the request. Associating a speaker model + "! with a prompt is optional, but the information that is extracted from the + "! speaker model helps the service learn about the speaker's voice.Get a speaker model
+ "! Gets information about all prompts that are defined by a specified speaker for + "! all custom models that are owned by a service instance. The information is + "! grouped by the customization IDs of the custom models. For each custom model, + "! the information lists information about each prompt that is defined for that + "! custom model by the speaker. You must use credentials for the instance of the + "! service that owns a speaker model to list its prompts. Speaker models and the + "! custom prompts with which they are used are supported only for use with US + "! English custom models and voices.Delete a speaker model
+ "! Deletes an existing speaker model from the service instance. The service deletes + "! the enrolled speaker with the specified speaker ID. You must use credentials + "! for the instance of the service that owns a speaker model to delete the + "! speaker.Delete labeled data
"! Deletes all data that is associated with a specified customer ID. The method "! deletes all data for the customer ID, regardless of the method by which the @@ -1026,7 +1628,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20210312144443'. + e_sdk_version_date = '20231212104240'. endmethod. @@ -1147,6 +1749,9 @@ endmethod. * | [--->] I_ACCEPT TYPE STRING (default ='audio/ogg;codecs=opus') * | [--->] I_VOICE TYPE STRING (default ='en-US_MichaelV3Voice') * | [--->] I_CUSTOMIZATION_ID TYPE STRING(optional) +* | [--->] I_SPELL_OUT_MODE TYPE STRING (default ='default') +* | [--->] I_RATE_PERCENTAGE TYPE INTEGER (default =0) +* | [--->] I_PITCH_PERCENTAGE TYPE INTEGER (default =0) * | [--->] I_contenttype TYPE string (default ='application/json') * | [<---] E_RESPONSE TYPE FILE * | [!CX!] ZCX_IBMC_SERVICE_EXCEPTION @@ -1192,6 +1797,36 @@ method SYNTHESIZE. c_url = ls_request_prop-url ) ##NO_TEXT. endif. + if i_SPELL_OUT_MODE is supplied. + lv_queryparam = escape( val = i_SPELL_OUT_MODE format = cl_abap_format=>e_uri_full ). + add_query_parameter( + exporting + i_parameter = `spell_out_mode` + i_value = lv_queryparam + changing + c_url = ls_request_prop-url ) ##NO_TEXT. + endif. + + if i_RATE_PERCENTAGE is supplied. + lv_queryparam = i_RATE_PERCENTAGE. + add_query_parameter( + exporting + i_parameter = `rate_percentage` + i_value = lv_queryparam + changing + c_url = ls_request_prop-url ) ##NO_TEXT. + endif. + + if i_PITCH_PERCENTAGE is supplied. + lv_queryparam = i_PITCH_PERCENTAGE. + add_query_parameter( + exporting + i_parameter = `pitch_percentage` + i_value = lv_queryparam + changing + c_url = ls_request_prop-url ) ##NO_TEXT. + endif. + " process header parameters data: lv_headerparam type string ##NEEDED. @@ -1233,13 +1868,24 @@ method SYNTHESIZE. lv_bodyparam =Tone Analyzer
-"! The IBM Watson™ Tone Analyzer service uses linguistic analysis to detect -"! emotional and language tones in written text. The service can analyze tone at -"! both the document and sentence levels. You can use the service to understand -"! how your written communications are perceived and then to improve the tone of -"! your communications. Businesses can use the service to learn the tone of their -"! customers' communications and to respond to each customer appropriately, -"! or to understand and improve their customer conversations.- "! The score for a tone from the input content.
- begin of T_TONE_SCORE, - "! The score for the tone.- "! The category for a tone from the input content.
- begin of T_TONE_CATEGORY, - "! An array of `ToneScore` objects that provides the results for the tones of the - "! category. - TONES type STANDARD TABLE OF T_TONE_SCORE WITH NON-UNIQUE DEFAULT KEY, - "! The unique, non-localized identifier of the category for the results. The - "! service can return results for the following category IDs: `emotion_tone`, - "! `language_tone`, and `social_tone`. - CATEGORY_ID type STRING, - "! The user-visible, localized name of the category. - CATEGORY_NAME type STRING, - end of T_TONE_CATEGORY. - types: - "!- "! Input for the general-purpose endpoint.
- begin of T_TONE_INPUT, - "! The input content that the service is to analyze. - TEXT type STRING, - end of T_TONE_INPUT. - types: - "!- "! The score for an utterance from the input content.
- begin of T_TONE_CHAT_SCORE, - "! The score for the tone in the range of 0.5 to 1. A score greater than 0.75 - "! indicates a high likelihood that the tone is perceived in the utterance. - SCORE type DOUBLE, - "! The unique, non-localized identifier of the tone for the results. The service - "! returns results only for tones whose scores meet a minimum threshold of 0.5. - TONE_ID type STRING, - "! The user-visible, localized name of the tone. - TONE_NAME type STRING, - end of T_TONE_CHAT_SCORE. - types: - "!- "! An utterance for the input of the general-purpose endpoint.
- begin of T_UTTERANCE, - "! An utterance contributed by a user in the conversation that is to be analyzed. - "! The utterance can contain multiple sentences. - TEXT type STRING, - "! A string that identifies the user who contributed the utterance specified by the - "! `text` parameter. - USER type STRING, - end of T_UTTERANCE. - types: - "!- "! Input for the customer-engagement endpoint.
- begin of T_TONE_CHAT_INPUT, - "! An array of `Utterance` objects that provides the input content that the service - "! is to analyze. - UTTERANCES type STANDARD TABLE OF T_UTTERANCE WITH NON-UNIQUE DEFAULT KEY, - end of T_TONE_CHAT_INPUT. - types: - "!- "! The results of the analysis for the individual sentences of
- "! the input content. - begin of T_SENTENCE_ANALYSIS, - "! The unique identifier of a sentence of the input content. The first sentence has - "! ID 0, and the ID of each subsequent sentence is incremented by one. - SENTENCE_ID type INTEGER, - "! The text of the input sentence. - TEXT type STRING, - "! **`2017-09-21`:** An array of `ToneScore` objects that provides the results of - "! the analysis for each qualifying tone of the sentence. The array includes - "! results for any tone whose score is at least 0.5. The array is empty if no tone - "! has a score that meets this threshold. **`2016-05-19`:** Not returned. - TONES type STANDARD TABLE OF T_TONE_SCORE WITH NON-UNIQUE DEFAULT KEY, - "! **`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` - "! objects that provides the results of the tone analysis for the sentence. The - "! service returns results only for the tones specified with the `tones` parameter - "! of the request. - TONE_CATEGORIES type STANDARD TABLE OF T_TONE_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - "! **`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the first - "! character of the sentence in the overall input content. - INPUT_FROM type INTEGER, - "! **`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the last - "! character of the sentence in the overall input content. - INPUT_TO type INTEGER, - end of T_SENTENCE_ANALYSIS. - types: - "!- "! The results of the analysis for an utterance of the input
- "! content. - begin of T_UTTERANCE_ANALYSIS, - "! The unique identifier of the utterance. The first utterance has ID 0, and the ID - "! of each subsequent utterance is incremented by one. - UTTERANCE_ID type INTEGER, - "! The text of the utterance. - UTTERANCE_TEXT type STRING, - "! An array of `ToneChatScore` objects that provides results for the most prevalent - "! tones of the utterance. The array includes results for any tone whose score is - "! at least 0.5. The array is empty if no tone has a score that meets this - "! threshold. - TONES type STANDARD TABLE OF T_TONE_CHAT_SCORE WITH NON-UNIQUE DEFAULT KEY, - "! **`2017-09-21`:** An error message if the utterance contains more than 500 - "! characters. The service does not analyze the utterance. **`2016-05-19`:** Not - "! returned. - ERROR type STRING, - end of T_UTTERANCE_ANALYSIS. - types: - "!- "! The results of the analysis for the utterances of the input
- "! content. - begin of T_UTTERANCE_ANALYSES, - "! An array of `UtteranceAnalysis` objects that provides the results for each - "! utterance of the input. - UTTERANCES_TONE type STANDARD TABLE OF T_UTTERANCE_ANALYSIS WITH NON-UNIQUE DEFAULT KEY, - "! **`2017-09-21`:** A warning message if the content contains more than 50 - "! utterances. The service analyzes only the first 50 utterances. - "! **`2016-05-19`:** Not returned. - WARNING type STRING, - end of T_UTTERANCE_ANALYSES. - types: - "!- "! The error response from a failed request.
- begin of T_ERROR_MODEL, - "! The HTTP status code. - CODE type INTEGER, - "! A service-specific error code. - SUB_CODE type STRING, - "! A description of the error. - ERROR type STRING, - "! A URL to documentation explaining the cause and possibly solutions for the - "! error. - HELP type STRING, - end of T_ERROR_MODEL. - types: - "!- "! The results of the analysis for the full input content.
- begin of T_DOCUMENT_ANALYSIS, - "! **`2017-09-21`:** An array of `ToneScore` objects that provides the results of - "! the analysis for each qualifying tone of the document. The array includes - "! results for any tone whose score is at least 0.5. The array is empty if no tone - "! has a score that meets this threshold. **`2016-05-19`:** Not returned. - TONES type STANDARD TABLE OF T_TONE_SCORE WITH NON-UNIQUE DEFAULT KEY, - "! **`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` - "! objects that provides the results of the tone analysis for the full document of - "! the input content. The service returns results only for the tones specified - "! with the `tones` parameter of the request. - TONE_CATEGORIES type STANDARD TABLE OF T_TONE_CATEGORY WITH NON-UNIQUE DEFAULT KEY, - "! **`2017-09-21`:** A warning message if the overall content exceeds 128 KB or - "! contains more than 1000 sentences. The service analyzes only the first 1000 - "! sentences for document-level analysis and the first 100 sentences for - "! sentence-level analysis. **`2016-05-19`:** Not returned. - WARNING type STRING, - end of T_DOCUMENT_ANALYSIS. - types: - "!- "! The tone analysis results for the input from the
- "! general-purpose endpoint. - begin of T_TONE_ANALYSIS, - "! The results of the analysis for the full input content. - DOCUMENT_TONE type T_DOCUMENT_ANALYSIS, - "! An array of `SentenceAnalysis` objects that provides the results of the analysis - "! for the individual sentences of the input content. The service returns results - "! only for the first 100 sentences of the input. The field is omitted if the - "! `sentences` parameter of the request is set to `false`. - SENTENCES_TONE type STANDARD TABLE OF T_SENTENCE_ANALYSIS WITH NON-UNIQUE DEFAULT KEY, - end of T_TONE_ANALYSIS. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_TONE_SCORE type string value '|SCORE|TONE_ID|TONE_NAME|', - T_TONE_CATEGORY type string value '|TONES|CATEGORY_ID|CATEGORY_NAME|', - T_TONE_INPUT type string value '|TEXT|', - T_TONE_CHAT_SCORE type string value '|SCORE|TONE_ID|TONE_NAME|', - T_UTTERANCE type string value '|TEXT|', - T_TONE_CHAT_INPUT type string value '|UTTERANCES|', - T_SENTENCE_ANALYSIS type string value '|SENTENCE_ID|TEXT|', - T_UTTERANCE_ANALYSIS type string value '|UTTERANCE_ID|UTTERANCE_TEXT|TONES|', - T_UTTERANCE_ANALYSES type string value '|UTTERANCES_TONE|', - T_ERROR_MODEL type string value '|CODE|ERROR|', - T_DOCUMENT_ANALYSIS type string value '|', - T_TONE_ANALYSIS type string value '|DOCUMENT_TONE|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - TEXT type string value 'text', - UTTERANCES type string value 'utterances', - USER type string value 'user', - DOCUMENT_TONE type string value 'document_tone', - SENTENCES_TONE type string value 'sentences_tone', - TONES type string value 'tones', - TONE_CATEGORIES type string value 'tone_categories', - WARNING type string value 'warning', - SENTENCE_ID type string value 'sentence_id', - INPUT_FROM type string value 'input_from', - INPUT_TO type string value 'input_to', - SCORE type string value 'score', - TONE_ID type string value 'tone_id', - TONE_NAME type string value 'tone_name', - CATEGORY_ID type string value 'category_id', - CATEGORY_NAME type string value 'category_name', - UTTERANCES_TONE type string value 'utterances_tone', - UTTERANCE_ID type string value 'utterance_id', - UTTERANCE_TEXT type string value 'utterance_text', - ERROR type string value 'error', - CODE type string value 'code', - SUB_CODE type string value 'sub_code', - HELP type string value 'help', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Analyze general tone
- "! Use the general-purpose endpoint to analyze the tone of your input content. The - "! service analyzes the content for emotional and language tones. The method - "! always analyzes the tone of the full document; by default, it also analyzes the - "! tone of each individual sentence of the content.Analyze customer-engagement tone
- "! Use the customer-engagement endpoint to analyze the tone of customer service and - "! customer support conversations. For each utterance of a conversation, the - "! method reports the most prevalent subset of the following seven tones: sad, - "! frustrated, satisfied, excited, polite, impolite, and sympathetic.Visual Recognition
-"! IBM Watson™ Visual Recognition is discontinued. Existing instances are -"! supported until 1 December 2021, but as of 7 January 2021, you can't -"! create instances. Any instance that is provisioned on 1 December 2021 will be -"! deleted.- "! Number of images processed for the API call.
- T_IMAGES_PROCESSED type Integer. - types: - "!- "! Result of a class within a classifier.
- begin of T_CLASS_RESULT, - "! Name of the class.- "! Classifier and score combination.
- begin of T_CLASSIFIER_RESULT, - "! Name of the classifier. - NAME type STRING, - "! ID of a classifier identified in the image. - CLASSIFIER_ID type STRING, - "! Classes within the classifier. - CLASSES type STANDARD TABLE OF T_CLASS_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFIER_RESULT. - types: - "!- "! Information about what might have caused a failure, such as
- "! an image that is too large. Not returned when there is no error. - begin of T_ERROR_INFO, - "! HTTP status code. - CODE type INTEGER, - "! Human-readable error description. For example, `File size limit exceeded`. - DESCRIPTION type STRING, - "! Codified error string. For example, `limit_exceeded`. - ERROR_ID type STRING, - end of T_ERROR_INFO. - types: - "!- "! Results for one image.
- begin of T_CLASSIFIED_IMAGE, - "! Source of the image before any redirects. Not returned when the image is - "! uploaded. - SOURCE_URL type STRING, - "! Fully resolved URL of the image after redirects are followed. Not returned when - "! the image is uploaded. - RESOLVED_URL type STRING, - "! Relative path of the image file if uploaded directly. Not returned when the - "! image is passed by URL. - IMAGE type STRING, - "! Information about what might have caused a failure, such as an image that is too - "! large. Not returned when there is no error. - ERROR type T_ERROR_INFO, - "! The classifiers. - CLASSIFIERS type STANDARD TABLE OF T_CLASSIFIER_RESULT WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFIED_IMAGE. - types: - "!- "! Information about something that went wrong.
- begin of T_WARNING_INFO, - "! Codified warning string, such as `limit_reached`. - WARNING_ID type STRING, - "! Information about the error. - DESCRIPTION type STRING, - end of T_WARNING_INFO. - types: - "!- "! Results for all images.
- begin of T_CLASSIFIED_IMAGES, - "! Number of custom classes identified in the images. - CUSTOM_CLASSES type INTEGER, - "! Number of images processed for the API call. - IMAGES_PROCESSED type INTEGER, - "! Classified images. - IMAGES type STANDARD TABLE OF T_CLASSIFIED_IMAGE WITH NON-UNIQUE DEFAULT KEY, - "! Information about what might cause less than optimal output. For example, a - "! request sent with a corrupt .zip file and a list of image URLs will still - "! complete, but does not return the expected output. Not returned when there is - "! no warning. - WARNINGS type STANDARD TABLE OF T_WARNING_INFO WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFIED_IMAGES. - types: - "!- "! Knowledge graph of the property. For example,
- "! `/fruit/pome/apple/eating apple/Granny Smith`. Included only if identified. - T_TYPE_HIERARCHY type String. - types: - "!- "! A category within a classifier.
- begin of T_CLASS, - "! The name of the class. - CLASS type STRING, - end of T_CLASS. - types: - "!- "! Empty object.
- T_EMPTY type JSONOBJECT. - types: - "!- "! Error information.
- begin of T_ERROR_RESPONSE, - "! HTTP error code. - CODE type INTEGER, - "! Human-readable error string, like 'Invalid image file'. - ERROR type STRING, - end of T_ERROR_RESPONSE. - types: - "! No documentation available. - begin of T_INLINE_OBJECT1, - "! The name of the new classifier. Encode special characters in UTF-8. - NAME type STRING, - "! A .zip file of images that depict the visual subject of a class in the new - "! classifier. You can include more than one positive example file in a call.- "! Information about a classifier.
- begin of T_CLASSIFIER, - "! ID of a classifier identified in the image. - CLASSIFIER_ID type STRING, - "! Name of the classifier. - NAME type STRING, - "! Unique ID of the account who owns the classifier. Might not be returned by some - "! requests. - OWNER type STRING, - "! Training status of classifier. - STATUS type STRING, - "! Whether the classifier can be downloaded as a Core ML model after the training - "! status is `ready`. - CORE_ML_ENABLED type BOOLEAN, - "! If classifier training has failed, this field might explain why. - EXPLANATION type STRING, - "! Date and time in Coordinated Universal Time (UTC) that the classifier was - "! created. - CREATED type DATETIME, - "! Classes that define a classifier. - CLASSES type STANDARD TABLE OF T_CLASS WITH NON-UNIQUE DEFAULT KEY, - "! Date and time in Coordinated Universal Time (UTC) that the classifier was - "! updated. Might not be returned by some requests. Identical to `updated` and - "! retained for backward compatibility. - RETRAINED type DATETIME, - "! Date and time in Coordinated Universal Time (UTC) that the classifier was most - "! recently updated. The field matches either `retrained` or `created`. Might not - "! be returned by some requests. - UPDATED type DATETIME, - end of T_CLASSIFIER. - types: - "!- "! Number of custom classes identified in the images.
- T_CUSTOM_CLASSES_PROCESSED type Integer. - types: - "!- "! Confidence score for the property in the range of 0 to 1. A
- "! higher score indicates greater likelihood that the class is depicted in the - "! image. The default threshold for returning scores from a classifier is 0.5. - T_CONFIDENCE_SCORE type Float. - types: - "!- "! Relative path of the image file if uploaded directly. Not
- "! returned when the image is passed by URL. - T_IMAGE_FILE type String. - types: - "!- "! Error information.
- begin of T_ERROR_HTML, - "! HTML description of the error. - ERROR1 type STRING, - end of T_ERROR_HTML. - types: - "!- "! Source of the image before any redirects. Not returned when
- "! the image is uploaded. - T_SOURCE_URL type String. - types: - "!- "! Fully resolved URL of the image after redirects are
- "! followed. Not returned when the image is uploaded. - T_RESOLVED_URL type String. - types: - "!- "! A container for the list of classifiers.
- begin of T_CLASSIFIERS, - "! List of classifiers. - CLASSIFIERS type STANDARD TABLE OF T_CLASSIFIER WITH NON-UNIQUE DEFAULT KEY, - end of T_CLASSIFIERS. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_CLASS_RESULT type string value '|CLASS|SCORE|', - T_CLASSIFIER_RESULT type string value '|NAME|CLASSIFIER_ID|CLASSES|', - T_ERROR_INFO type string value '|CODE|DESCRIPTION|ERROR_ID|', - T_CLASSIFIED_IMAGE type string value '|CLASSIFIERS|', - T_WARNING_INFO type string value '|WARNING_ID|DESCRIPTION|', - T_CLASSIFIED_IMAGES type string value '|IMAGES|', - T_CLASS type string value '|CLASS|', - T_ERROR_RESPONSE type string value '|CODE|ERROR|', - T_INLINE_OBJECT1 type string value '|NAME|POSITIVE_EXAMPLES|', - T_INLINE_OBJECT type string value '|', - T_INLINE_OBJECT2 type string value '|', - T_CLASSIFIER type string value '|CLASSIFIER_ID|NAME|', - T_ERROR_HTML type string value '|', - T_CLASSIFIERS type string value '|CLASSIFIERS|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - WARNING_ID type string value 'warning_id', - DESCRIPTION type string value 'description', - CODE type string value 'code', - ERROR_ID type string value 'error_id', - CLASSIFIERS type string value 'classifiers', - CLASSIFIER_ID type string value 'classifier_id', - NAME type string value 'name', - OWNER type string value 'owner', - STATUS type string value 'status', - CORE_ML_ENABLED type string value 'core_ml_enabled', - EXPLANATION type string value 'explanation', - CREATED type string value 'created', - CLASSES type string value 'classes', - RETRAINED type string value 'retrained', - UPDATED type string value 'updated', - CLASS type string value 'class', - SOURCE_URL type string value 'source_url', - RESOLVED_URL type string value 'resolved_url', - IMAGE type string value 'image', - ERROR type string value 'error', - ERROR1 type string value 'Error', - SCORE type string value 'score', - TYPE_HIERARCHY type string value 'type_hierarchy', - CUSTOM_CLASSES type string value 'custom_classes', - IMAGES_PROCESSED type string value 'images_processed', - IMAGES type string value 'images', - WARNINGS type string value 'warnings', - IMAGES_FILE type string value 'images_file', - URL type string value 'url', - THRESHOLD type string value 'threshold', - OWNERS type string value 'owners', - CLASSIFIER_IDS type string value 'classifier_ids', - POSITIVE_EXAMPLES type string value 'positive_examples', - NEGATIVE_EXAMPLES type string value 'negative_examples', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Classify images
- "! Classify images with built-in or custom classifiers. - "! - "! @parameter I_IMAGES_FILE | - "! An image file (.gif, .jpg, .png, .tif) or .zip file with images. Maximum image - "! size is 10 MB. Include no more than 20 images and limit the .zip file to 100 - "! MB. Encode the image and .zip file names in UTF-8 if they contain non-ASCII - "! characters. The service assumes UTF-8 encoding if it encounters non-ASCII - "! characters.Create a classifier
- "! Train a new multi-faceted classifier on the uploaded image data. Create your - "! custom classifier with positive or negative example training images. Include at - "! least two sets of examples, either two positive example files or one positive - "! and one negative file. You can upload a maximum of 256 MB per call.Retrieve a list of classifiers
- "! - "! @parameter I_VERBOSE | - "! Specify `true` to return details about the classifiers. Omit this parameter to - "! return a brief list of classifiers. - "! @parameter E_RESPONSE | - "! Service return value of type T_CLASSIFIERS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_CLASSIFIERS - importing - !I_VERBOSE type BOOLEAN optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CLASSIFIERS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Retrieve classifier details
- "! Retrieve information about a custom classifier. - "! - "! @parameter I_CLASSIFIER_ID | - "! The ID of the classifier. - "! @parameter E_RESPONSE | - "! Service return value of type T_CLASSIFIER - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_CLASSIFIER - importing - !I_CLASSIFIER_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_CLASSIFIER - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update a classifier
- "! Update a custom classifier by adding new positive or negative classes or by - "! adding new images to existing classes. You must supply at least one set of - "! positive or negative examples. For details, see [Updating custom - "! classifiers](https://cloud.ibm.com/docs/visual-recognition?topic=visual-recogni - "! tion-customizing#updating-custom-classifiers).Delete a classifier
- "! - "! @parameter I_CLASSIFIER_ID | - "! The ID of the classifier. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_CLASSIFIER - importing - !I_CLASSIFIER_ID type STRING - !I_accept type string default 'application/json' - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Retrieve a Core ML model of a classifier
- "! Download a Core ML model file (.mlmodel) of a custom classifier that returns - "! <tt>"core_ml_enabled": true</tt> in the classifier - "! details. - "! - "! @parameter I_CLASSIFIER_ID | - "! The ID of the classifier. - "! @parameter E_RESPONSE | - "! Service return value of type FILE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_CORE_ML_MODEL - importing - !I_CLASSIFIER_ID type STRING - !I_accept type string default 'application/octet-stream' - exporting - !E_RESPONSE type FILE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Delete labeled data
- "! Deletes all data associated with a specified customer ID. The method has no - "! effect if no data is associated with the customer ID.Visual Recognition v4
-"! IBM Watson™ Visual Recognition is discontinued. Existing instances are -"! supported until 1 December 2021, but as of 7 January 2021, you can't -"! create instances. Any instance that is provisioned on 1 December 2021 will be -"! deleted.- "! Defines the location of the bounding box around the object.
- begin of T_LOCATION, - "! Y-position of top-left pixel of the bounding box. - TOP type INTEGER, - "! X-position of top-left pixel of the bounding box. - LEFT type INTEGER, - "! Width in pixels of of the bounding box. - WIDTH type INTEGER, - "! Height in pixels of the bounding box. - HEIGHT type INTEGER, - end of T_LOCATION. - types: - "!- "! Training status for the objects in the collection.
- begin of T_OBJECT_TRAINING_STATUS, - "! Whether you can analyze images in the collection with the **objects** feature. - READY type BOOLEAN, - "! Whether training is in progress. - IN_PROGRESS type BOOLEAN, - "! Whether there are changes to the training data since the most recent training. - DATA_CHANGED type BOOLEAN, - "! Whether the most recent training failed. - LATEST_FAILED type BOOLEAN, - "! Whether the model can be downloaded after the training status is `ready`. - RSCNN_READY type BOOLEAN, - "! Details about the training. If training is in progress, includes information - "! about the status. If training is not in progress, includes a success message or - "! information about why training failed. - DESCRIPTION type STRING, - end of T_OBJECT_TRAINING_STATUS. - types: - "!- "! Training status information for the collection.
- begin of T_TRAINING_STATUS, - "! Training status for the objects in the collection. - OBJECTS type T_OBJECT_TRAINING_STATUS, - end of T_TRAINING_STATUS. - types: - "!- "! Basic information about an object.
- begin of T_OBJECT_METADATA, - "! The name of the object. - OBJECT type STRING, - "! Number of bounding boxes with this object name in the collection. - COUNT type INTEGER, - end of T_OBJECT_METADATA. - types: - "!- "! The source type of the image.
- begin of T_IMAGE_SOURCE, - "! The source type of the image. - TYPE type STRING, - "! Name of the image file if uploaded. Not returned when the image is passed by - "! URL. - FILENAME type STRING, - "! Name of the .zip file of images if uploaded. Not returned when the image is - "! passed directly or by URL. - ARCHIVE_FILENAME type STRING, - "! Source of the image before any redirects. Not returned when the image is - "! uploaded. - SOURCE_URL type STRING, - "! Fully resolved URL of the image after redirects are followed. Not returned when - "! the image is uploaded. - RESOLVED_URL type STRING, - end of T_IMAGE_SOURCE. - types: - "!- "! Details about the training data.
- begin of T_TRAINING_DATA_OBJECT, - "! The name of the object. - OBJECT type STRING, - "! Defines the location of the bounding box around the object. - LOCATION type T_LOCATION, - end of T_TRAINING_DATA_OBJECT. - types: - "!- "! Training data for all objects.
- begin of T_TRAINING_DATA_OBJECTS, - "! Training data for specific objects. - OBJECTS type STANDARD TABLE OF T_TRAINING_DATA_OBJECT WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAINING_DATA_OBJECTS. - types: - "!- "! Training status information for the collection.
- begin of T_COLLECTION_TRAINING_STATUS, - "! Training status for the objects in the collection. - OBJECTS type T_OBJECT_TRAINING_STATUS, - end of T_COLLECTION_TRAINING_STATUS. - types: - "!- "! Details about a collection.
- begin of T_COLLECTION, - "! The identifier of the collection. - COLLECTION_ID type STRING, - "! The name of the collection. - NAME type STRING, - "! The description of the collection. - DESCRIPTION type STRING, - "! Date and time in Coordinated Universal Time (UTC) that the collection was - "! created. - CREATED type DATETIME, - "! Date and time in Coordinated Universal Time (UTC) that the collection was most - "! recently updated. - UPDATED type DATETIME, - "! Number of images in the collection. - IMAGE_COUNT type INTEGER, - "! Training status information for the collection. - TRAINING_STATUS type T_COLLECTION_TRAINING_STATUS, - end of T_COLLECTION. - types: - "!- "! Height and width of an image.
- begin of T_IMAGE_DIMENSIONS, - "! Height in pixels of the image. - HEIGHT type INTEGER, - "! Width in pixels of the image. - WIDTH type INTEGER, - end of T_IMAGE_DIMENSIONS. - types: - "!- "! Defines the location of the bounding box around the object.
- begin of T_OBJECT_DETAIL_LOCATION, - "! Y-position of top-left pixel of the bounding box. - TOP type INTEGER, - "! X-position of top-left pixel of the bounding box. - LEFT type INTEGER, - "! Width in pixels of of the bounding box. - WIDTH type INTEGER, - "! Height in pixels of the bounding box. - HEIGHT type INTEGER, - end of T_OBJECT_DETAIL_LOCATION. - types: - "!- "! Details about the specific area of the problem.
- begin of T_ERROR_TARGET, - "! The parameter or property that is the focus of the problem. - TYPE type STRING, - "! The property that is identified with the problem. - NAME type STRING, - end of T_ERROR_TARGET. - types: - "!- "! Details about an error.
- begin of T_ERROR, - "! Identifier of the problem. - CODE type STRING, - "! An explanation of the problem with possible solutions. - MESSAGE type STRING, - "! A URL for more information about the solution. - MORE_INFO type STRING, - "! Details about the specific area of the problem. - TARGET type T_ERROR_TARGET, - end of T_ERROR. - types: - "!- "! A container for the list of request-level problems.
- begin of T_ERROR_RESPONSE, - "! A container for the problems in the request. - ERRORS type STANDARD TABLE OF T_ERROR WITH NON-UNIQUE DEFAULT KEY, - "! A unique identifier of the request. - TRACE type STRING, - end of T_ERROR_RESPONSE. - types: - "!- "! Details about an object and its location.
- begin of T_BASE_OBJECT, - "! The name of the object. The name can contain alphanumeric, underscore, hyphen, - "! space, and dot characters. It cannot begin with the reserved prefix `sys-`. - OBJECT type STRING, - "! Defines the location of the bounding box around the object. - LOCATION type T_LOCATION, - end of T_BASE_OBJECT. - types: - "! No documentation available. - begin of T_INLINE_OBJECT, - "! The IDs of the collections to analyze. - COLLECTION_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! The features to analyze. - FEATURES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, - "! An array of image files (.jpg or .png) or .zip files with images.- "! Details about an object in the collection.
- begin of T_OBJECT_DETAIL, - "! The label for the object. - OBJECT type STRING, - "! Defines the location of the bounding box around the object. - LOCATION type T_OBJECT_DETAIL_LOCATION, - "! Confidence score for the object in the range of 0 to 1. A higher score indicates - "! greater likelihood that the object is depicted at this location in the image. - SCORE type FLOAT, - end of T_OBJECT_DETAIL. - types: - "!- "! The objects in a collection that are detected in an image.
- begin of T_COLLECTION_OBJECTS, - "! The identifier of the collection. - COLLECTION_ID type STRING, - "! The identified objects in a collection. - OBJECTS type STANDARD TABLE OF T_OBJECT_DETAIL WITH NON-UNIQUE DEFAULT KEY, - end of T_COLLECTION_OBJECTS. - types: - "!- "! Container for the list of collections that have objects
- "! detected in an image. - begin of T_DETECTED_OBJECTS, - "! The collections with identified objects. - COLLECTIONS type STANDARD TABLE OF T_COLLECTION_OBJECTS WITH NON-UNIQUE DEFAULT KEY, - end of T_DETECTED_OBJECTS. - types: - "!- "! A file returned in the response.
- T_JPEG_IMAGE type FILE. - types: - "!- "! A container for the list of collections.
- begin of T_COLLECTIONS_LIST, - "! The collections in this service instance. - COLLECTIONS type STANDARD TABLE OF T_COLLECTION WITH NON-UNIQUE DEFAULT KEY, - end of T_COLLECTIONS_LIST. - types: - "!- "! Details about the training event.
- begin of T_TRAINING_EVENT, - "! Trained object type. Only `objects` is currently supported. - TYPE type STRING, - "! Identifier of the trained collection. - COLLECTION_ID type STRING, - "! Date and time in Coordinated Universal Time (UTC) that training on the - "! collection finished. - COMPLETION_TIME type DATETIME, - "! Training status of the training event. - STATUS type STRING, - "! The total number of images that were used in training for this training event. - IMAGE_COUNT type INTEGER, - end of T_TRAINING_EVENT. - types: - "!- "! Details about the training events.
- begin of T_TRAINING_EVENTS, - "! The starting day for the returned training events in Coordinated Universal Time - "! (UTC). If not specified in the request, it identifies the earliest training - "! event. - START_TIME type DATETIME, - "! The ending day for the returned training events in Coordinated Universal Time - "! (UTC). If not specified in the request, it lists the current time. - END_TIME type DATETIME, - "! The total number of training events in the response for the start and end times. - "! - COMPLETED_EVENTS type INTEGER, - "! The total number of images that were used in training for the start and end - "! times. - TRAINED_IMAGES type INTEGER, - "! The completed training events for the start and end time. - EVENTS type STANDARD TABLE OF T_TRAINING_EVENT WITH NON-UNIQUE DEFAULT KEY, - end of T_TRAINING_EVENTS. - types: - "!- "! Details about an image.
- begin of T_IMAGE_DETAILS, - "! The identifier of the image. - IMAGE_ID type STRING, - "! Date and time in Coordinated Universal Time (UTC) that the image was most - "! recently updated. - UPDATED type DATETIME, - "! Date and time in Coordinated Universal Time (UTC) that the image was created. - CREATED type DATETIME, - "! The source type of the image. - SOURCE type T_IMAGE_SOURCE, - "! Height and width of an image. - DIMENSIONS type T_IMAGE_DIMENSIONS, - "! Details about the errors. - ERRORS type STANDARD TABLE OF T_ERROR WITH NON-UNIQUE DEFAULT KEY, - "! Training data for all objects. - TRAINING_DATA type T_TRAINING_DATA_OBJECTS, - end of T_IMAGE_DETAILS. - types: - "!- "! Details about a problem.
- begin of T_WARNING, - "! Identifier of the problem. - CODE type STRING, - "! An explanation of the problem with possible solutions. - MESSAGE type STRING, - "! A URL for more information about the solution. - MORE_INFO type STRING, - end of T_WARNING. - types: - "!- "! List of information about the images.
- begin of T_IMAGE_DETAILS_LIST, - "! The images in the collection. - IMAGES type STANDARD TABLE OF T_IMAGE_DETAILS WITH NON-UNIQUE DEFAULT KEY, - "! Information about what might cause less than optimal output. - WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, - "! A unique identifier of the request. Included only when an error or warning is - "! returned. - TRACE type STRING, - end of T_IMAGE_DETAILS_LIST. - types: - "!- "! Empty response.
- T_EMPTY type JSONOBJECT. - types: - "!- "! Basic information about an image.
- begin of T_IMAGE_SUMMARY, - "! The identifier of the image. - IMAGE_ID type STRING, - "! Date and time in Coordinated Universal Time (UTC) that the image was most - "! recently updated. - UPDATED type DATETIME, - end of T_IMAGE_SUMMARY. - types: - "!- "! Container for the training data.
- begin of T_BASE_TRAINING_DATA_OBJECTS, - "! Training data for specific objects. - OBJECTS type STANDARD TABLE OF T_TRAINING_DATA_OBJECT WITH NON-UNIQUE DEFAULT KEY, - end of T_BASE_TRAINING_DATA_OBJECTS. - types: - "! No documentation available. - begin of T_INLINE_OBJECT1, - "! An array of image files (.jpg or .png) or .zip files with images.- "! List of images.
- begin of T_IMAGE_SUMMARY_LIST, - "! The images in the collection. - IMAGES type STANDARD TABLE OF T_IMAGE_SUMMARY WITH NON-UNIQUE DEFAULT KEY, - end of T_IMAGE_SUMMARY_LIST. - types: - "!- "! Details about an image.
- begin of T_IMAGE, - "! The source type of the image. - SOURCE type T_IMAGE_SOURCE, - "! Height and width of an image. - DIMENSIONS type T_IMAGE_DIMENSIONS, - "! Container for the list of collections that have objects detected in an image. - OBJECTS type T_DETECTED_OBJECTS, - "! A container for the problems in the request. - ERRORS type STANDARD TABLE OF T_ERROR WITH NON-UNIQUE DEFAULT KEY, - end of T_IMAGE. - types: - "!- "! Results for all images.
- begin of T_ANALYZE_RESPONSE, - "! Analyzed images. - IMAGES type STANDARD TABLE OF T_IMAGE WITH NON-UNIQUE DEFAULT KEY, - "! Information about what might cause less than optimal output. - WARNINGS type STANDARD TABLE OF T_WARNING WITH NON-UNIQUE DEFAULT KEY, - "! A unique identifier of the request. Included only when an error or warning is - "! returned. - TRACE type STRING, - end of T_ANALYZE_RESPONSE. - types: - "!- "! Base details about a collection.
- begin of T_BASE_COLLECTION, - "! The identifier of the collection. - COLLECTION_ID type STRING, - "! The name of the collection. The name can contain alphanumeric, underscore, - "! hyphen, and dot characters. It cannot begin with the reserved prefix `sys-`. - NAME type STRING, - "! The description of the collection. - DESCRIPTION type STRING, - "! Date and time in Coordinated Universal Time (UTC) that the collection was - "! created. - CREATED type DATETIME, - "! Date and time in Coordinated Universal Time (UTC) that the collection was most - "! recently updated. - UPDATED type DATETIME, - "! Number of images in the collection. - IMAGE_COUNT type INTEGER, - "! Training status information for the collection. - TRAINING_STATUS type T_TRAINING_STATUS, - end of T_BASE_COLLECTION. - types: - "!- "! Basic information about an updated object.
- begin of T_UPDATE_OBJECT_METADATA, - "! The updated name of the object. The name can contain alphanumeric, underscore, - "! hyphen, space, and dot characters. It cannot begin with the reserved prefix - "! `sys-`. - OBJECT type STRING, - "! Number of bounding boxes in the collection with the updated object name. - COUNT type INTEGER, - end of T_UPDATE_OBJECT_METADATA. - types: - "!- "! List of objects.
- begin of T_OBJECT_METADATA_LIST, - "! Number of unique named objects in the collection. - OBJECT_COUNT type INTEGER, - "! The objects in the collection. - OBJECTS type STANDARD TABLE OF T_OBJECT_METADATA WITH NON-UNIQUE DEFAULT KEY, - end of T_OBJECT_METADATA_LIST. - -constants: - "!List of required fields per type.
- begin of C_REQUIRED_FIELDS, - T_LOCATION type string value '|TOP|LEFT|WIDTH|HEIGHT|', - T_OBJECT_TRAINING_STATUS type string value '|READY|IN_PROGRESS|DATA_CHANGED|LATEST_FAILED|RSCNN_READY|DESCRIPTION|', - T_TRAINING_STATUS type string value '|OBJECTS|', - T_OBJECT_METADATA type string value '|', - T_IMAGE_SOURCE type string value '|TYPE|', - T_TRAINING_DATA_OBJECT type string value '|', - T_TRAINING_DATA_OBJECTS type string value '|', - T_COLLECTION_TRAINING_STATUS type string value '|OBJECTS|', - T_COLLECTION type string value '|COLLECTION_ID|NAME|DESCRIPTION|CREATED|UPDATED|IMAGE_COUNT|TRAINING_STATUS|', - T_IMAGE_DIMENSIONS type string value '|', - T_OBJECT_DETAIL_LOCATION type string value '|TOP|LEFT|WIDTH|HEIGHT|', - T_ERROR_TARGET type string value '|TYPE|NAME|', - T_ERROR type string value '|CODE|MESSAGE|', - T_ERROR_RESPONSE type string value '|ERRORS|TRACE|', - T_BASE_OBJECT type string value '|', - T_INLINE_OBJECT type string value '|COLLECTION_IDS|FEATURES|', - T_OBJECT_DETAIL type string value '|OBJECT|LOCATION|SCORE|', - T_COLLECTION_OBJECTS type string value '|COLLECTION_ID|OBJECTS|', - T_DETECTED_OBJECTS type string value '|', - T_COLLECTIONS_LIST type string value '|COLLECTIONS|', - T_TRAINING_EVENT type string value '|', - T_TRAINING_EVENTS type string value '|', - T_IMAGE_DETAILS type string value '|SOURCE|', - T_WARNING type string value '|CODE|MESSAGE|', - T_IMAGE_DETAILS_LIST type string value '|', - T_IMAGE_SUMMARY type string value '|', - T_BASE_TRAINING_DATA_OBJECTS type string value '|', - T_INLINE_OBJECT1 type string value '|', - T_IMAGE_SUMMARY_LIST type string value '|IMAGES|', - T_IMAGE type string value '|SOURCE|DIMENSIONS|OBJECTS|', - T_ANALYZE_RESPONSE type string value '|IMAGES|', - T_BASE_COLLECTION type string value '|', - T_UPDATE_OBJECT_METADATA type string value '|OBJECT|', - T_OBJECT_METADATA_LIST type string value '|OBJECT_COUNT|', - __DUMMY type string value SPACE, - end of C_REQUIRED_FIELDS . - -constants: - "!Map ABAP identifiers to service identifiers.
- begin of C_ABAPNAME_DICTIONARY, - CODE type string value 'code', - MESSAGE type string value 'message', - MORE_INFO type string value 'more_info', - TARGET type string value 'target', - TYPE type string value 'type', - NAME type string value 'name', - ERRORS type string value 'errors', - TRACE type string value 'trace', - IMAGES type string value 'images', - WARNINGS type string value 'warnings', - COLLECTION_ID type string value 'collection_id', - DESCRIPTION type string value 'description', - CREATED type string value 'created', - UPDATED type string value 'updated', - IMAGE_COUNT type string value 'image_count', - TRAINING_STATUS type string value 'training_status', - COLLECTIONS type string value 'collections', - START_TIME type string value 'start_time', - END_TIME type string value 'end_time', - COMPLETED_EVENTS type string value 'completed_events', - TRAINED_IMAGES type string value 'trained_images', - EVENTS type string value 'events', - COMPLETION_TIME type string value 'completion_time', - STATUS type string value 'status', - OBJECTS type string value 'objects', - OBJECT_COUNT type string value 'object_count', - OBJECT type string value 'object', - COUNT type string value 'count', - READY type string value 'ready', - IN_PROGRESS type string value 'in_progress', - DATA_CHANGED type string value 'data_changed', - LATEST_FAILED type string value 'latest_failed', - RSCNN_READY type string value 'rscnn_ready', - IMAGE_ID type string value 'image_id', - SOURCE type string value 'source', - DIMENSIONS type string value 'dimensions', - TRAINING_DATA type string value 'training_data', - HEIGHT type string value 'height', - WIDTH type string value 'width', - LOCATION type string value 'location', - FILENAME type string value 'filename', - ARCHIVE_FILENAME type string value 'archive_filename', - SOURCE_URL type string value 'source_url', - RESOLVED_URL type string value 'resolved_url', - SCORE type string value 'score', - TOP type string value 'top', - LEFT type string value 'left', - COLLECTION_IDS type string value 'collection_ids', - FEATURES type string value 'features', - IMAGES_FILE type string value 'images_file', - IMAGE_URL type string value 'image_url', - THRESHOLD type string value 'threshold', - end of C_ABAPNAME_DICTIONARY . - - - methods GET_APPNAME - redefinition . - methods GET_REQUEST_PROP - redefinition . - methods GET_SDK_VERSION_DATE - redefinition . - - - "!Analyze images
- "! Analyze images by URL, by file, or both against your own collection. Make sure - "! that **training_status.objects.ready** is `true` for the feature before you use - "! a collection to analyze images.Create a collection
- "! Create a collection that can be used to store images.List collections
- "! Retrieves a list of collections for the service instance. - "! - "! @parameter E_RESPONSE | - "! Service return value of type T_COLLECTIONS_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_COLLECTIONS - importing - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COLLECTIONS_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get collection details
- "! Get details of one collection. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_COLLECTION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_COLLECTION - importing - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COLLECTION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update a collection
- "! Update the name or description of a collection.Delete a collection
- "! Delete a collection from the service instance. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_COLLECTION - importing - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get a model
- "! Download a model that you can deploy to detect objects in images. The collection - "! must include a generated model, which is indicated in the response for the - "! collection details as `"rscnn_ready": true`. If the value is `false`, - "! train or retrain the collection to generate the model.Add images
- "! Add images to a collection by URL, by file, or both.List images
- "! Retrieves a list of images in a collection. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_IMAGE_SUMMARY_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_IMAGES - importing - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_IMAGE_SUMMARY_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get image details
- "! Get the details of an image in a collection. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter I_IMAGE_ID | - "! The identifier of the image. - "! @parameter E_RESPONSE | - "! Service return value of type T_IMAGE_DETAILS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_IMAGE_DETAILS - importing - !I_COLLECTION_ID type STRING - !I_IMAGE_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_IMAGE_DETAILS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete an image
- "! Delete one image from a collection. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter I_IMAGE_ID | - "! The identifier of the image. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_IMAGE - importing - !I_COLLECTION_ID type STRING - !I_IMAGE_ID type STRING - !I_accept type string default 'application/json' - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get a JPEG file of an image
- "! Download a JPEG representation of an image. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter I_IMAGE_ID | - "! The identifier of the image. - "! @parameter I_SIZE | - "! The image size. Specify `thumbnail` to return a version that maintains the - "! original aspect ratio but is no larger than 200 pixels in the larger dimension. - "! For example, an original 800 x 1000 image is resized to 160 x 200 pixels. - "! @parameter E_RESPONSE | - "! Service return value of type FILE - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_JPEG_IMAGE - importing - !I_COLLECTION_ID type STRING - !I_IMAGE_ID type STRING - !I_SIZE type STRING default 'full' - !I_accept type string default 'image/jpeg' - exporting - !E_RESPONSE type FILE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!List object metadata
- "! Retrieves a list of object names in a collection. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_OBJECT_METADATA_LIST - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods LIST_OBJECT_METADATA - importing - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_OBJECT_METADATA_LIST - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Update an object name
- "! Update the name of an object. A successful request updates the training data for - "! all images that use the object. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter I_OBJECT | - "! The name of the object. - "! @parameter I_UPDATEOBJECTMETADATA | - "! No documentation available. - "! @parameter E_RESPONSE | - "! Service return value of type T_UPDATE_OBJECT_METADATA - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods UPDATE_OBJECT_METADATA - importing - !I_COLLECTION_ID type STRING - !I_OBJECT type STRING - !I_UPDATEOBJECTMETADATA type T_UPDATE_OBJECT_METADATA - !I_contenttype type string default 'application/json' - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_UPDATE_OBJECT_METADATA - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Get object metadata
- "! Get the number of bounding boxes for a single object in a collection. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter I_OBJECT | - "! The name of the object. - "! @parameter E_RESPONSE | - "! Service return value of type T_OBJECT_METADATA - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_OBJECT_METADATA - importing - !I_COLLECTION_ID type STRING - !I_OBJECT type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_OBJECT_METADATA - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Delete an object
- "! Delete one object from a collection. A successful request deletes the training - "! data from all images that use the object. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter I_OBJECT | - "! The name of the object. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods DELETE_OBJECT - importing - !I_COLLECTION_ID type STRING - !I_OBJECT type STRING - !I_accept type string default 'application/json' - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Train a collection
- "! Start training on images in a collection. The collection must have enough - "! training data and untrained data (the **training_status.objects.data_changed** - "! is `true`). If training is in progress, the request queues the next training - "! job. - "! - "! @parameter I_COLLECTION_ID | - "! The identifier of the collection. - "! @parameter E_RESPONSE | - "! Service return value of type T_COLLECTION - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods TRAIN - importing - !I_COLLECTION_ID type STRING - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_COLLECTION - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "!Add training data to an image
- "! Add, update, or delete training data for an image. Encode the object name in - "! UTF-8 if it contains non-ASCII characters. The service assumes UTF-8 encoding - "! if it encounters non-ASCII characters.Get training usage
- "! Information about the completed training events. You can use this information to - "! determine how close you are to the training limits for the month. - "! - "! @parameter I_START_TIME | - "! The earliest day to include training events. Specify dates in YYYY-MM-DD format. - "! If empty or not specified, the earliest training event is included. - "! @parameter I_END_TIME | - "! The most recent day to include training events. Specify dates in YYYY-MM-DD - "! format. All events for the day are included. If empty or not specified, the - "! current day is used. Specify the same value as `start_time` to request events - "! for a single day. - "! @parameter E_RESPONSE | - "! Service return value of type T_TRAINING_EVENTS - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. - "! - methods GET_TRAINING_USAGE - importing - !I_START_TIME type DATE optional - !I_END_TIME type DATE optional - !I_accept type string default 'application/json' - exporting - !E_RESPONSE type T_TRAINING_EVENTS - raising - ZCX_IBMC_SERVICE_EXCEPTION . - - "!Delete labeled data
- "! Deletes all data associated with a specified customer ID. The method has no - "! effect if no data is associated with the customer ID.