diff --git a/.abapgit.xml b/.abapgit.xml index db8bb57..1c0111e 100644 --- a/.abapgit.xml +++ b/.abapgit.xml @@ -13,7 +13,7 @@ /.travis.yml /.gitlab-ci.yml /abaplint.json - /MIGRATION-V0.2.0.md + /MIGRATION-V0.3.0.md diff --git a/MIGRATION-V0.2.0.md b/MIGRATION-V0.3.0.md similarity index 69% rename from MIGRATION-V0.2.0.md rename to MIGRATION-V0.3.0.md index 9aee169..bcc81ed 100644 --- a/MIGRATION-V0.2.0.md +++ b/MIGRATION-V0.3.0.md @@ -1,7 +1,17 @@ -# Upgrading to ABAP SDK version 0.2.0 +# Upgrading to ABAP SDK version 0.3.0 ## Breaking changes +### Breaking changes by service +#### Factory Method +- Parameter `I_PROXY_SERVICE` of method `ZCL_IBMC_SERVICE_EXT=>GET_INSTANCE` is renamed to `I_PROXY_PORT`. + +#### Visual Recognition V4 +- Parameter `I_UPDATEOBJECTMETADATA` of method `UPDATE_OBJECT_METADATA` is required (previously this was optional). + +## +## Special instructions when directly upgrading from versions earlier than 0.2.0 + ### Table conversion necessary after pull The ABAP SDK for IBM Watson is now enabled to separate configuration data by storing data into client-specific tables. To achieve this tables `ZIBMC_TOKEN` and `ZIBMC_CONFIG` were made client-specific by adding a column holding the SAP client number. diff --git a/README.md b/README.md index 74dac15..8f38e53 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # ABAP SDK for IBM Watson, using SAP NetWeaver -ABAP client library to use the [IBM Watson APIs][wdc]. This is a Community SDK written by ABAPers for the ABAPers in the Open Source community, to provide easy usage of IBM Watson Developer Services in innovation initiatives combined with any SAP Application which is run on SAP NetWeaver 7.50 and above, such as SAP ECC or SAP S/4HANA. It is the choice and responsibility of application developers how this Community SDK is used. +ABAP client library to use the [IBM Watson APIs][wdc]. This is a Community SDK written by ABAPers for the ABAPers in the Open Source community, to provide easy usage of IBM Watson Developer Services in innovation initiatives combined with any SAP Application which is run on SAP NetWeaver 7.50 and above, such as SAP Business Suite or SAP S/4HANA on-premises edition. It is the choice and responsibility of application developers how this Community SDK is used. Additionally, as the ABAP SDK is a community release it is not updated with the same schedule as IBM-supported SDKs. Please see more information in [Questions](#questions). @@ -11,7 +11,7 @@ Additionally, as the ABAP SDK is a community release it is not updated with the | **abap-sdk-nwas** | [abap-sdk-scp](https://github.com/watson-developer-cloud/abap-sdk-scp) | |---|---| | for SAP NetWeaver AS ABAP 7.50+ | for SAP Cloud Platform ABAP Environment 2002+ | -| tested on SAP ECC and SAP S/4HANA | | +| tested on SAP Business Suite and SAP S/4HANA on-premises edition | | | `this repository` | | --- @@ -38,8 +38,8 @@ Additionally, as the ABAP SDK is a community release it is not updated with the ## ANNOUNCEMENTS -### Minor version 0.2.0 released -Version v0.2.0 of the SDK has been released and includes two breaking changes - see what's changed in the [migration guide](MIGRATION-V0.2.0.md). +### Minor version 0.3.0 released +Version v0.3.0 of the SDK has been released and includes one breaking change - see what's changed in the [migration guide](MIGRATION-V0.3.0.md). ## Before you begin * You need an [IBM Cloud][ibm_cloud_onboarding] account. @@ -211,7 +211,7 @@ Using the client library requires two steps: exporting i_url = i_apikey = -... + ... importing eo_instance = lo_service_class ). ``` @@ -343,8 +343,8 @@ Using the client library requires two steps: zcl_ibmc_service_ext=>get_instance( exporting i_url = 'https://api.eu-gb.personality-insights.watson.cloud.ibm.com/instances/' - i_apikey = lv_apikey - i_version = '2018-05-01' + i_apikey = lv_apikey + i_version = '2018-05-01' importing eo_instance = lo_personality_insights ). @@ -393,7 +393,7 @@ Using the client library requires two steps: " get Watson Language Translator service instance zcl_ibmc_service_ext=>get_instance( exporting - i_url = 'https://api.us-south.language-translator.watson.cloud.ibm.com/instances/' + i_url = 'https://api.us-south.language-translator.watson.cloud.ibm.com/instances/' i_apikey = lv_apikey i_version = '2018-05-01' importing diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v1.html index 0d659ce..834e8f8 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v1.html @@ -1,28 +1,75 @@ -Class ZCL_IBMC_ASSISTANT_V1

Class ZCL_IBMC_ASSISTANT_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Watson Assistant v1

+Class ZCL_IBMC_ASSISTANT_V1

Class ZCL_IBMC_ASSISTANT_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Watson Assistant v1

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and an integrated dialog editor to create conversation flows between your apps and your users.

The Assistant v1 API provides authoring methods your application can use to - create or update a workspace.

Types

Visibility and LevelNameDocumentation
publict_audit_properties (structured type) No documentation available.
publict_base_counterexample (structured type) No documentation available.
publict_base_dialog_node (structured type) No documentation available.
publict_base_entity (structured type) No documentation available.
publict_base_example (structured type) No documentation available.
publict_base_intent (structured type) No documentation available.
publict_base_message (structured type) No documentation available.
publict_base_output (structured type) An output object that includes the response to the user, the dialog nodes that - were triggered, and messages from the log.
publict_base_synonym (structured type) No documentation available.
publict_base_value (structured type) No documentation available.
publict_base_workspace (structured type) No documentation available.
publict_capture_group (structured type) A recognized capture group for a pattern-based entity.
publict_context (structured type) State information for the conversation. To maintain state, include the context - from the previous response.
publict_counterexample (structured type) No documentation available.
publict_counterexample_collection (structured type) No documentation available.
publict_create_entity (structured type) No documentation available.
publict_create_intent (structured type) No documentation available.
publict_create_value (structured type) No documentation available.
publict_create_workspace (structured type) No documentation available.
publict_dialog_node (structured type) No documentation available.
publict_dialog_node_action (structured type) No documentation available.
publict_dialog_node_collection (structured type) An array of dialog nodes.
publict_dialog_node_next_step (structured type) The next step to execute following this dialog node.
publict_dialog_node_output (structured type) The output of the dialog node. For more information about how to specify dialog - node output, see the - [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-ove - rview#dialog-overview-responses).
publict_dialog_node_output_generic (structured type) No documentation available.
publict_dialog_node_output_modifiers (structured type) Options that modify how specified output is handled.
publict_dialog_node_visited_details (structured type) No documentation available.
publict_dialog_suggestion (structured type) No documentation available.
publict_dialog_suggestion_output (structured type) The dialog output that will be returned from the Watson Assistant service if the - user selects the corresponding option.
publict_dialog_suggestion_value (structured type) 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.
publict_dia_nd_otpt_resp_type_pause (structured type) No documentation available.
publict_dia_nd_otpt_resp_typ_cnnct_1 (structured type) No documentation available.
publict_dia_nd_otpt_resp_typ_srch_s1 (structured type) No documentation available.
publict_dia_nd_otpt_text_values_elem (structured type) No documentation available.
publict_dia_nd_output_opt_elem_value (structured type) An object defining the message input to be sent to the Watson Assistant service - if the user selects the corresponding option.
publict_dia_nd_output_resp_type_img (structured type) No documentation available.
publict_dia_nd_output_resp_type_opt (structured type) No documentation available.
publict_dia_nd_output_resp_type_text (structured type) No documentation available.
publict_dia_node_output_opt_element (structured type) No documentation available.
publict_dia_suggestion_resp_generic (structured type) No documentation available.
publict_empty_response type JSONOBJECT No documentation available.
publict_entity (structured type) No documentation available.
publict_entity_collection (structured type) An array of objects describing the entities for the workspace.
publict_entity_mention (structured type) An object describing a contextual entity mention.
publict_entity_mention_collection (structured type) No documentation available.
publict_error_detail (structured type) No documentation available.
publict_error_response (structured type) No documentation available.
publict_example (structured type) No documentation available.
publict_example_collection (structured type) No documentation available.
publict_intent (structured type) No documentation available.
publict_intent_collection (structured type) No documentation available.
publict_log (structured type) No documentation available.
publict_log_collection (structured type) No documentation available.
publict_log_message (structured type) Log message details.
publict_log_pagination (structured type) The pagination data for the returned objects.
publict_mention (structured type) A mention of a contextual entity.
publict_message_context_metadata (structured type) Metadata related to the message.
publict_message_input (structured type) An input object that includes the input text.
publict_message_request (structured type) A request sent to the workspace, including the user input and context.
publict_message_response (structured type) The response sent by the workspace, including the output text, detected intents - and entities, and context.
publict_output_data (structured type) An output object that includes the response to the user, the dialog nodes that - were triggered, and messages from the log.
publict_pagination (structured type) The pagination data for the returned objects.
publict_rt_entity_interpretation (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_date (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_num (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_time (structured type) No documentation available.
publict_rt_response_type_suggestion (structured type) No documentation available.
publict_rt_resp_typ_connect_to_agent (structured type) No documentation available.
publict_runtime_entity (structured type) A term from the request that was identified as an entity.
publict_runtime_entity_alternative (structured type) An alternative value for the recognized entity.
publict_runtime_entity_role (structured type) An object describing the role played by a system entity that is specifies the - beginning or end of a range recognized in the user input. This property is - included only if the new system entities are enabled for the workspace.
publict_runtime_intent (structured type) An intent identified in the user input.
publict_runtime_response_generic (structured type) No documentation available.
publict_runtime_response_type_image (structured type) No documentation available.
publict_runtime_response_type_option (structured type) No documentation available.
publict_runtime_response_type_pause (structured type) No documentation available.
publict_runtime_response_type_text (structured type) No documentation available.
publict_synonym (structured type) No documentation available.
publict_synonym_collection (structured type) No documentation available.
publict_system_response type MAP For internal use only.
publict_update_counterexample (structured type) No documentation available.
publict_update_dialog_node (structured type) No documentation available.
publict_update_entity (structured type) No documentation available.
publict_update_example (structured type) No documentation available.
publict_update_intent (structured type) No documentation available.
publict_update_synonym (structured type) No documentation available.
publict_update_value (structured type) No documentation available.
publict_update_workspace (structured type) No documentation available.
publict_value (structured type) No documentation available.
publict_value_collection (structured type) No documentation available.
publict_webhook (structured type) A webhook that can be used by dialog nodes to make programmatic calls to an - external function.
+ create or update a workspace.

Types

Visibility and LevelNameDocumentation
publict_audit_properties (structured type) No documentation available.
publict_base_counterexample (structured type) No documentation available.
publict_base_dialog_node (structured type) No documentation available.
publict_base_entity (structured type) No documentation available.
publict_base_example (structured type) No documentation available.
publict_base_intent (structured type) No documentation available.
publict_base_message (structured type) No documentation available.
publict_base_output (structured type)

+ An output object that includes the response to the user, the

+ dialog nodes that were triggered, and messages from the log.
publict_base_synonym (structured type) No documentation available.
publict_base_value (structured type) No documentation available.
publict_base_workspace (structured type) No documentation available.
publict_capture_group (structured type)

+ A recognized capture group for a pattern-based entity.

publict_context (structured type)

+ State information for the conversation. To maintain state,

+ include the context from the previous response.
publict_counterexample (structured type) No documentation available.
publict_counterexample_collection (structured type) No documentation available.
publict_create_entity (structured type) No documentation available.
publict_create_intent (structured type) No documentation available.
publict_create_value (structured type) No documentation available.
publict_create_workspace (structured type) No documentation available.
publict_dialog_node (structured type) No documentation available.
publict_dialog_node_action (structured type) No documentation available.
publict_dialog_node_collection (structured type)

+ An array of dialog nodes.

publict_dialog_node_next_step (structured type)

+ The next step to execute following this dialog node.

publict_dialog_node_output (structured type)

+ The output of the dialog node. For more information about

+ how to specify dialog node output, see the + [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-ove + rview#dialog-overview-responses).
publict_dialog_node_output_generic (structured type) No documentation available.
publict_dialog_node_output_modifiers (structured type)

+ Options that modify how specified output is handled.

publict_dialog_node_visited_details (structured type) No documentation available.
publict_dialog_suggestion (structured type) No documentation available.
publict_dialog_suggestion_output (structured type)

+ The dialog output that will be returned from the Watson

+ Assistant service if the user selects the corresponding option.
publict_dialog_suggestion_value (structured type)

+ 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.
publict_dia_nd_otpt_resp_type_pause (structured type) No documentation available.
publict_dia_nd_otpt_resp_typ_cnnct_1 (structured type) No documentation available.
publict_dia_nd_otpt_resp_typ_srch_s1 (structured type) No documentation available.
publict_dia_nd_otpt_text_values_elem (structured type) No documentation available.
publict_dia_nd_output_opt_elem_value (structured type)

+ An object defining the message input to be sent to the

+ Watson Assistant service if the user selects the corresponding option.
publict_dia_nd_output_resp_type_img (structured type) No documentation available.
publict_dia_nd_output_resp_type_opt (structured type) No documentation available.
publict_dia_nd_output_resp_type_text (structured type) No documentation available.
publict_dia_node_output_opt_element (structured type) No documentation available.
publict_dia_suggestion_resp_generic (structured type) No documentation available.
publict_empty_response type JSONOBJECT No documentation available.
publict_entity (structured type) No documentation available.
publict_entity_collection (structured type)

+ An array of objects describing the entities for the

+ workspace.
publict_entity_mention (structured type)

+ An object describing a contextual entity mention.

publict_entity_mention_collection (structured type) No documentation available.
publict_error_detail (structured type) No documentation available.
publict_error_response (structured type) No documentation available.
publict_example (structured type) No documentation available.
publict_example_collection (structured type) No documentation available.
publict_intent (structured type) No documentation available.
publict_intent_collection (structured type) No documentation available.
publict_log (structured type) No documentation available.
publict_log_collection (structured type) No documentation available.
publict_log_message (structured type)

+ Log message details.

publict_log_pagination (structured type)

+ The pagination data for the returned objects.

publict_mention (structured type)

+ A mention of a contextual entity.

publict_message_context_metadata (structured type)

+ Metadata related to the message.

publict_message_input (structured type)

+ An input object that includes the input text.

publict_message_request (structured type)

+ A request sent to the workspace, including the user input

+ and context.
publict_message_response (structured type)

+ The response sent by the workspace, including the output

+ text, detected intents and entities, and context.
publict_output_data (structured type)

+ An output object that includes the response to the user, the

+ dialog nodes that were triggered, and messages from the log.
publict_pagination (structured type)

+ The pagination data for the returned objects.

publict_rt_entity_interpretation (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_date (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_num (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_time (structured type) No documentation available.
publict_rt_response_type_suggestion (structured type) No documentation available.
publict_rt_resp_typ_connect_to_agent (structured type) No documentation available.
publict_runtime_entity (structured type)

+ A term from the request that was identified as an entity.

publict_runtime_entity_alternative (structured type)

+ An alternative value for the recognized entity.

publict_runtime_entity_role (structured type)

+ An object describing the role played by a system entity that

+ is specifies the beginning or end of a range recognized in the user input. This + property is included only if the new system entities are enabled for the + workspace.
publict_runtime_intent (structured type)

+ An intent identified in the user input.

publict_runtime_response_generic (structured type) No documentation available.
publict_runtime_response_type_image (structured type) No documentation available.
publict_runtime_response_type_option (structured type) No documentation available.
publict_runtime_response_type_pause (structured type) No documentation available.
publict_runtime_response_type_text (structured type) No documentation available.
publict_synonym (structured type) No documentation available.
publict_synonym_collection (structured type) No documentation available.
publict_system_response type MAP

+ For internal use only.

publict_update_counterexample (structured type) No documentation available.
publict_update_dialog_node (structured type) No documentation available.
publict_update_entity (structured type) No documentation available.
publict_update_example (structured type) No documentation available.
publict_update_intent (structured type) No documentation available.
publict_update_synonym (structured type) No documentation available.
publict_update_value (structured type) No documentation available.
publict_update_workspace (structured type) No documentation available.
publict_value (structured type) No documentation available.
publict_value_collection (structured type) No documentation available.
publict_webhook (structured type)

+ A webhook that can be used by dialog nodes to make

+ programmatic calls to an external function.
+
+ **Note:** Currently, only a single webhook named `main_webhook` is supported.
publict_webhook_header (structured type)

+ A key/value pair defining an HTTP header and a value.

publict_workspace (structured type) No documentation available.
publict_workspace_collection (structured type) No documentation available.
publict_workspace_system_settings (structured type)

+ Global settings for the workspace.

publict_ws_system_settings_off_topic (structured type)

+ Workspace settings related to detection of irrelevant input.

publict_ws_system_settings_tooling (structured type)

+ Workspace settings related to the Watson Assistant user

+ interface.
publict_ws_systm_sttngs_dsmbgtn (structured type)

+ Workspace settings related to the disambiguation

+ feature.
+
+ **Note:** This feature is available only to Plus and Premium users.
publict_ws_systm_sttngs_systm_entts (structured type)

+ Workspace settings related to the behavior of system

+ entities.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
create_counterexample
importingi_workspace_idtype STRING
i_bodytype T_COUNTEREXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE
raisingzcx_ibmc_service_exception

Create counterexample

+ Add a new counterexample to a workspace. Counterexamples are examples that have + been marked as irrelevant input.

- **Note:** Currently, only a single webhook named `main_webhook` is supported.
publict_webhook_header (structured type) A key/value pair defining an HTTP header and a value.
publict_workspace (structured type) No documentation available.
publict_workspace_collection (structured type) No documentation available.
publict_workspace_system_settings (structured type) Global settings for the workspace.
publict_ws_system_settings_off_topic (structured type) Workspace settings related to detection of irrelevant input.
publict_ws_system_settings_tooling (structured type) Workspace settings related to the Watson Assistant user interface.
publict_ws_systm_sttngs_dsmbgtn (structured type) Workspace settings related to the disambiguation feature.
+ If you want to add multiple counterexamples with a single API call, consider + using the **[Update workspace](#update-workspace)** method instead.

- **Note:** This feature is available only to Plus and Premium users.
publict_ws_systm_sttngs_systm_entts (structured type) Workspace settings related to the behavior of system entities.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
create_counterexample
importingi_workspace_idtype STRING
i_bodytype T_COUNTEREXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE
raisingzcx_ibmc_service_exception
 Create counterexample. + This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -33,7 +80,15 @@ the response.
e_response Service return value of type T_COUNTEREXAMPLE -
public instance
create_dialog_node
importingi_workspace_idtype STRING
i_bodytype T_DIALOG_NODE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE
raisingzcx_ibmc_service_exception
 Create dialog node. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_dialog_node
importingi_workspace_idtype STRING
i_bodytype T_DIALOG_NODE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE
raisingzcx_ibmc_service_exception

Create dialog node

+ Create a new dialog node.
+
+ If you want to create multiple dialog nodes with a single API call, consider + using the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -44,7 +99,15 @@ the response.
e_response Service return value of type T_DIALOG_NODE -
public instance
create_entity
importingi_workspace_idtype STRING
i_bodytype T_CREATE_ENTITY
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY
raisingzcx_ibmc_service_exception
 Create entity. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_entity
importingi_workspace_idtype STRING
i_bodytype T_CREATE_ENTITY
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY
raisingzcx_ibmc_service_exception

Create entity

+ Create a new entity, or enable a system entity.
+
+ If you want to create multiple entities with a single API call, consider using + the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -55,7 +118,15 @@ the response.
e_response Service return value of type T_ENTITY -
public instance
create_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_bodytype T_EXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE
raisingzcx_ibmc_service_exception
Create user input example. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_bodytype T_EXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE
raisingzcx_ibmc_service_exception

Create user input example

+ Add a new user input example to an intent.
+
+ If you want to add multiple exaples with a single API call, consider using the + **[Update intent](#update-intent)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -68,7 +139,15 @@ the response.
e_response Service return value of type T_EXAMPLE -
public instance
create_intent
importingi_workspace_idtype STRING
i_bodytype T_CREATE_INTENT
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT
raisingzcx_ibmc_service_exception
Create intent. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_intent
importingi_workspace_idtype STRING
i_bodytype T_CREATE_INTENT
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT
raisingzcx_ibmc_service_exception

Create intent

+ Create a new intent.
+
+ If you want to create multiple intents with a single API call, consider using + the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 2000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -79,7 +158,16 @@ the response.
e_response Service return value of type T_INTENT -
public instance
create_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_bodytype T_SYNONYM
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM
raisingzcx_ibmc_service_exception
Create entity value synonym. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_bodytype T_SYNONYM
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM
raisingzcx_ibmc_service_exception

Create entity value synonym

+ Add a new synonym to an entity value.
+
+ If you want to create multiple synonyms with a single API call, consider using + the **[Update entity](#update-entity)** or **[Update entity + value](#update-entity-value)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -94,7 +182,15 @@ the response.
e_response Service return value of type T_SYNONYM -
public instance
create_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_bodytype T_CREATE_VALUE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE
raisingzcx_ibmc_service_exception
Create entity value. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_bodytype T_CREATE_VALUE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE
raisingzcx_ibmc_service_exception

Create entity value

+ Create a new value for an entity.
+
+ If you want to create multiple entity values with a single API call, consider + using the **[Update entity](#update-entity)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -107,7 +203,13 @@ the response.
e_response Service return value of type T_VALUE -
public instance
create_workspace
importingi_bodytype T_CREATE_WORKSPACE optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE
raisingzcx_ibmc_service_exception
Create workspace. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_workspace
importingi_bodytype T_CREATE_WORKSPACE optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE
raisingzcx_ibmc_service_exception

Create workspace

+ Create a workspace based on component objects. You must provide workspace + components defining the content of the new workspace.
+
+ This operation is limited to 30 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_body The content of the new workspace.
@@ -120,25 +222,46 @@ the response.
e_response Service return value of type T_WORKSPACE -
public instance
delete_counterexample
importingi_workspace_idtype STRING
i_texttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete counterexample. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_counterexample
importingi_workspace_idtype STRING
i_texttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete counterexample

+ Delete a counterexample from a workspace. Counterexamples are examples that have + been marked as irrelevant input.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace.
i_text The text of a user input counterexample (for example, `What are you wearing?`). -
public instance
delete_dialog_node
importingi_workspace_idtype STRING
i_dialog_nodetype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete dialog node. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_dialog_node
importingi_workspace_idtype STRING
i_dialog_nodetype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete dialog node

+ Delete a dialog node from a workspace.
+
+ This operation is limited to 500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace.
i_dialog_node The dialog node ID (for example, `get_order`). -
public instance
delete_entity
importingi_workspace_idtype STRING
i_entitytype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete entity. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_entity
importingi_workspace_idtype STRING
i_entitytype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete entity

+ Delete an entity from a workspace, or disable a system entity.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace.
i_entity The name of the entity. -
public instance
delete_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_texttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete user input example. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_texttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete user input example

+ Delete a user input example from an intent.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -146,13 +269,23 @@ The intent name.
i_text The text of the user input example. -
public instance
delete_intent
importingi_workspace_idtype STRING
i_intenttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete intent. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_intent
importingi_workspace_idtype STRING
i_intenttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete intent

+ Delete an intent from a workspace.
+
+ This operation is limited to 2000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace.
i_intent The intent name. -
public instance
delete_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_synonymtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete entity value synonym. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_synonymtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete entity value synonym

+ Delete a synonym from an entity value.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -162,11 +295,28 @@ The text of the entity value.
i_synonym The text of the synonym. -
public instance
delete_user_data
importingi_customer_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete labeled data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_user_data
importingi_customer_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_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.
+
+ You associate a customer ID with data by passing the `X-Watson-Metadata` header + with a request that passes data. For more information about personal data and + customer IDs, see [Information + security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-secu + rity#information-security).
+
+ This operation is limited to 4 requests per minute. For more information, see + **Rate limiting**.
Parameters
i_customer_id The customer ID for which all data is to be deleted. -
public instance
delete_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete entity value. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete entity value

+ Delete a value from an entity.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -174,11 +324,22 @@ The name of the entity.
i_value The text of the entity value. -
public instance
delete_workspace
importingi_workspace_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete workspace. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_workspace
importingi_workspace_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete workspace

+ Delete a workspace from the service instance.
+
+ This operation is limited to 30 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. -
public instanceget_appname redefinition public instance
get_counterexample
importingi_workspace_idtype STRING
i_texttype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE
raisingzcx_ibmc_service_exception
Get counterexample. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_counterexample
importingi_workspace_idtype STRING
i_texttype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE
raisingzcx_ibmc_service_exception

Get counterexample

+ Get information about a counterexample. Counterexamples are examples that have + been marked as irrelevant input.
+
+ This operation is limited to 6000 requests per 5 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -189,7 +350,12 @@ the response.
e_response Service return value of type T_COUNTEREXAMPLE -
public instance
get_dialog_node
importingi_workspace_idtype STRING
i_dialog_nodetype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE
raisingzcx_ibmc_service_exception
Get dialog node. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_dialog_node
importingi_workspace_idtype STRING
i_dialog_nodetype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE
raisingzcx_ibmc_service_exception

Get dialog node

+ Get information about a dialog node.
+
+ This operation is limited to 6000 requests per 5 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -200,7 +366,13 @@ the response.
e_response Service return value of type T_DIALOG_NODE -
public instance
get_entity
importingi_workspace_idtype STRING
i_entitytype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY
raisingzcx_ibmc_service_exception
Get entity. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_entity
importingi_workspace_idtype STRING
i_entitytype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY
raisingzcx_ibmc_service_exception

Get entity

+ Get information about an entity, optionally including all entity content.
+
+ With **export**=`false`, this operation is limited to 6000 requests per 5 + minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For + more information, see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -216,7 +388,12 @@ the response.
e_response Service return value of type T_ENTITY -
public instance
get_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_texttype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE
raisingzcx_ibmc_service_exception
Get user input example. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_texttype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE
raisingzcx_ibmc_service_exception

Get user input example

+ Get information about a user input example.
+
+ This operation is limited to 6000 requests per 5 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -229,7 +406,13 @@ the response.
e_response Service return value of type T_EXAMPLE -
public instance
get_intent
importingi_workspace_idtype STRING
i_intenttype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT
raisingzcx_ibmc_service_exception
Get intent. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_intent
importingi_workspace_idtype STRING
i_intenttype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT
raisingzcx_ibmc_service_exception

Get intent

+ Get information about an intent, optionally including all intent content.
+
+ With **export**=`false`, this operation is limited to 6000 requests per 5 + minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For + more information, see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -245,7 +428,12 @@ the response.
e_response Service return value of type T_INTENT -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_synonymtype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM
raisingzcx_ibmc_service_exception
Get entity value synonym. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_synonymtype STRING
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM
raisingzcx_ibmc_service_exception

Get entity value synonym

+ Get information about a synonym of an entity value.
+
+ This operation is limited to 6000 requests per 5 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -260,7 +448,12 @@ the response.
e_response Service return value of type T_SYNONYM -
public instance
get_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE
raisingzcx_ibmc_service_exception
Get entity value. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE
raisingzcx_ibmc_service_exception

Get entity value

+ Get information about an entity value.
+
+ This operation is limited to 6000 requests per 5 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -278,7 +471,14 @@ the response.
e_response Service return value of type T_VALUE -
public instance
get_workspace
importingi_workspace_idtype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_sorttype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE
raisingzcx_ibmc_service_exception
Get information about a workspace. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_workspace
importingi_workspace_idtype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_sorttype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE
raisingzcx_ibmc_service_exception

Get information about a workspace

+ Get information about a workspace, optionally including all workspace + content.
+
+ With **export**=`false`, this operation is limited to 6000 requests per 5 + minutes. With **export**=`true`, the limit is 20 requests per 30 minutes. For + more information, see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -296,7 +496,13 @@ objects by unique identifier, in ascending alphabetical order.
e_response Service return value of type T_WORKSPACE -
public instance
list_all_logs
importingi_filtertype STRING
i_sorttype STRING optional
i_page_limittype INTEGER optional
i_cursortype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LOG_COLLECTION
raisingzcx_ibmc_service_exception
List log events in all workspaces. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_all_logs
importingi_filtertype STRING
i_sorttype STRING optional
i_page_limittype INTEGER optional
i_cursortype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LOG_COLLECTION
raisingzcx_ibmc_service_exception

List log events in all workspaces

+ List the events from the logs of all workspaces in the service instance.
+
+ If **cursor** is not specified, this operation is limited to 40 requests per 30 + minutes. If **cursor** is specified, the limit is 120 requests per minute. For + more information, see **Rate limiting**.
Parameters
i_filter A cacheable parameter that limits the results to those matching the specified @@ -314,7 +520,13 @@ A token identifying the page of results to retrieve.
e_response Service return value of type T_LOG_COLLECTION -
public instance
list_counterexamples
importingi_workspace_idtype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE_COLLECTION
raisingzcx_ibmc_service_exception
List counterexamples. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_counterexamples
importingi_workspace_idtype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE_COLLECTION
raisingzcx_ibmc_service_exception

List counterexamples

+ List the counterexamples for a workspace. Counterexamples are examples that have + been marked as irrelevant input.
+
+ This operation is limited to 2500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -330,7 +542,12 @@ the response.
e_response Service return value of type T_COUNTEREXAMPLE_COLLECTION -
public instance
list_dialog_nodes
importingi_workspace_idtype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE_COLLECTION
raisingzcx_ibmc_service_exception
List dialog nodes. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_dialog_nodes
importingi_workspace_idtype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE_COLLECTION
raisingzcx_ibmc_service_exception

List dialog nodes

+ List the dialog nodes for a workspace.
+
+ This operation is limited to 2500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -346,7 +563,13 @@ the response.
e_response Service return value of type T_DIALOG_NODE_COLLECTION -
public instance
list_entities
importingi_workspace_idtype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY_COLLECTION
raisingzcx_ibmc_service_exception
List entities. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_entities
importingi_workspace_idtype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY_COLLECTION
raisingzcx_ibmc_service_exception

List entities

+ List the entities for a workspace.
+
+ With **export**=`false`, this operation is limited to 1000 requests per 30 + minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For + more information, see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -367,7 +590,13 @@ the response.
e_response Service return value of type T_ENTITY_COLLECTION -
public instance
list_examples
importingi_workspace_idtype STRING
i_intenttype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE_COLLECTION
raisingzcx_ibmc_service_exception
List user input examples. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_examples
importingi_workspace_idtype STRING
i_intenttype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE_COLLECTION
raisingzcx_ibmc_service_exception

List user input examples

+ List the user input examples for an intent, optionally including contextual + entity mentions.
+
+ This operation is limited to 2500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -385,7 +614,13 @@ the response.
e_response Service return value of type T_EXAMPLE_COLLECTION -
public instance
list_intents
importingi_workspace_idtype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT_COLLECTION
raisingzcx_ibmc_service_exception
List intents. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_intents
importingi_workspace_idtype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT_COLLECTION
raisingzcx_ibmc_service_exception

List intents

+ List the intents for a workspace.
+
+ With **export**=`false`, this operation is limited to 2000 requests per 30 + minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For + more information, see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -406,7 +641,13 @@ the response.
e_response Service return value of type T_INTENT_COLLECTION -
public instance
list_logs
importingi_workspace_idtype STRING
i_sorttype STRING optional
i_filtertype STRING optional
i_page_limittype INTEGER optional
i_cursortype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LOG_COLLECTION
raisingzcx_ibmc_service_exception
List log events in a workspace. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_logs
importingi_workspace_idtype STRING
i_sorttype STRING optional
i_filtertype STRING optional
i_page_limittype INTEGER optional
i_cursortype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LOG_COLLECTION
raisingzcx_ibmc_service_exception

List log events in a workspace

+ List the events from the log of a specific workspace.
+
+ If **cursor** is not specified, this operation is limited to 40 requests per 30 + minutes. If **cursor** is specified, the limit is 120 requests per minute. For + more information, see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -424,7 +665,13 @@ A token identifying the page of results to retrieve.
e_response Service return value of type T_LOG_COLLECTION -
public instance
list_mentions
importingi_workspace_idtype STRING
i_entitytype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY_MENTION_COLLECTION
raisingzcx_ibmc_service_exception
List entity mentions. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_mentions
importingi_workspace_idtype STRING
i_entitytype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY_MENTION_COLLECTION
raisingzcx_ibmc_service_exception

List entity mentions

+ List mentions for a contextual entity. An entity mention is an occurrence of a + contextual entity in the context of an intent user input example.
+
+ This operation is limited to 200 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -440,7 +687,12 @@ the response.
e_response Service return value of type T_ENTITY_MENTION_COLLECTION -
public instance
list_synonyms
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM_COLLECTION
raisingzcx_ibmc_service_exception
List entity value synonyms. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_synonyms
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM_COLLECTION
raisingzcx_ibmc_service_exception

List entity value synonyms

+ List the synonyms for an entity value.
+
+ This operation is limited to 2500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -460,7 +712,12 @@ the response.
e_response Service return value of type T_SYNONYM_COLLECTION -
public instance
list_values
importingi_workspace_idtype STRING
i_entitytype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE_COLLECTION
raisingzcx_ibmc_service_exception
List entity values. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_values
importingi_workspace_idtype STRING
i_entitytype STRING
i_exporttype BOOLEAN default C_BOOLEAN_FALSE
i_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE_COLLECTION
raisingzcx_ibmc_service_exception

List entity values

+ List the values for an entity.
+
+ This operation is limited to 2500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -483,7 +740,12 @@ the response.
e_response Service return value of type T_VALUE_COLLECTION -
public instance
list_workspaces
importingi_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE_COLLECTION
raisingzcx_ibmc_service_exception
List workspaces. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_workspaces
importingi_page_limittype INTEGER optional
i_sorttype STRING optional
i_cursortype STRING optional
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE_COLLECTION
raisingzcx_ibmc_service_exception

List workspaces

+ List the workspaces associated with a Watson Assistant service instance.
+
+ This operation is limited to 500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_page_limit The number of records to return in each page of results. @@ -497,19 +759,39 @@ the response.
e_response Service return value of type T_WORKSPACE_COLLECTION -
public instance
message
importingi_workspace_idtype STRING
i_bodytype T_MESSAGE_REQUEST optional
i_nodes_visited_detailstype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_MESSAGE_RESPONSE
raisingzcx_ibmc_service_exception
Get response to user input. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
message
importingi_workspace_idtype STRING
i_bodytype T_MESSAGE_REQUEST optional
i_nodes_visited_detailstype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_MESSAGE_RESPONSE
raisingzcx_ibmc_service_exception

Get response to user input

+ Send user input to a workspace and receive a response.
+
+ **Important:** This method has been superseded by the new v2 runtime API. The v2 + API offers significant advantages, including ease of deployment, automatic + state management, versioning, and search capabilities. For more information, + see the + [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-api-overvi + ew).
+
+ There is no rate limit for this operation.
Parameters
i_workspace_id Unique identifier of the workspace.
i_body - The message to be sent. This includes the user's input, along with optional + The message to be sent. This includes the user's input, along with optional intents, entities, and context from the last response.
i_nodes_visited_details Whether to include additional diagnostic information about the dialog nodes that were visited during processing of the message.
e_response Service return value of type T_MESSAGE_RESPONSE -
public instance
update_counterexample
importingi_workspace_idtype STRING
i_texttype STRING
i_bodytype T_UPDATE_COUNTEREXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE
raisingzcx_ibmc_service_exception
Update counterexample. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_counterexample
importingi_workspace_idtype STRING
i_texttype STRING
i_bodytype T_UPDATE_COUNTEREXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COUNTEREXAMPLE
raisingzcx_ibmc_service_exception

Update counterexample

+ Update the text of a counterexample. Counterexamples are examples that have been + marked as irrelevant input.
+
+ If you want to update multiple counterexamples with a single API call, consider + using the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -522,7 +804,15 @@ the response.
e_response Service return value of type T_COUNTEREXAMPLE -
public instance
update_dialog_node
importingi_workspace_idtype STRING
i_dialog_nodetype STRING
i_bodytype T_UPDATE_DIALOG_NODE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE
raisingzcx_ibmc_service_exception
Update dialog node. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_dialog_node
importingi_workspace_idtype STRING
i_dialog_nodetype STRING
i_bodytype T_UPDATE_DIALOG_NODE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DIALOG_NODE
raisingzcx_ibmc_service_exception

Update dialog node

+ Update an existing dialog node with new or modified data.
+
+ If you want to update multiple dialog nodes with a single API call, consider + using the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 500 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -541,7 +831,16 @@ the response.
e_response Service return value of type T_DIALOG_NODE -
public instance
update_entity
importingi_workspace_idtype STRING
i_entitytype STRING
i_bodytype T_UPDATE_ENTITY
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY
raisingzcx_ibmc_service_exception
Update entity. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_entity
importingi_workspace_idtype STRING
i_entitytype STRING
i_bodytype T_UPDATE_ENTITY
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENTITY
raisingzcx_ibmc_service_exception

Update entity

+ Update an existing entity with new or modified data. You must provide component + objects defining the content of the updated entity.
+
+ If you want to update multiple entities with a single API call, consider using + the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -570,7 +869,15 @@ the response.
e_response Service return value of type T_ENTITY -
public instance
update_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_texttype STRING
i_bodytype T_UPDATE_EXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE
raisingzcx_ibmc_service_exception
Update user input example. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_example
importingi_workspace_idtype STRING
i_intenttype STRING
i_texttype STRING
i_bodytype T_UPDATE_EXAMPLE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXAMPLE
raisingzcx_ibmc_service_exception

Update user input example

+ Update the text of a user input example.
+
+ If you want to update multiple examples with a single API call, consider using + the **[Update intent](#update-intent)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -585,7 +892,16 @@ the response.
e_response Service return value of type T_EXAMPLE -
public instance
update_intent
importingi_workspace_idtype STRING
i_intenttype STRING
i_bodytype T_UPDATE_INTENT
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT
raisingzcx_ibmc_service_exception
Update intent. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_intent
importingi_workspace_idtype STRING
i_intenttype STRING
i_bodytype T_UPDATE_INTENT
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_INTENT
raisingzcx_ibmc_service_exception

Update intent

+ Update an existing intent with new or modified data. You must provide component + objects defining the content of the updated intent.
+
+ If you want to update multiple intents with a single API call, consider using + the **[Update workspace](#update-workspace)** method instead.
+
+ This operation is limited to 2000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -616,7 +932,16 @@ the response.
e_response Service return value of type T_INTENT -
public instance
update_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_synonymtype STRING
i_bodytype T_UPDATE_SYNONYM
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM
raisingzcx_ibmc_service_exception
Update entity value synonym. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_synonym
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_synonymtype STRING
i_bodytype T_UPDATE_SYNONYM
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SYNONYM
raisingzcx_ibmc_service_exception

Update entity value synonym

+ Update an existing entity value synonym with new text.
+
+ If you want to update multiple synonyms with a single API call, consider using + the **[Update entity](#update-entity)** or **[Update entity + value](#update-entity-value)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -633,7 +958,16 @@ the response.
e_response Service return value of type T_SYNONYM -
public instance
update_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_bodytype T_UPDATE_VALUE
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE
raisingzcx_ibmc_service_exception
Update entity value. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_value
importingi_workspace_idtype STRING
i_entitytype STRING
i_valuetype STRING
i_bodytype T_UPDATE_VALUE
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VALUE
raisingzcx_ibmc_service_exception

Update entity value

+ Update an existing entity value with new or modified data. You must provide + component objects defining the content of the updated entity value.
+
+ If you want to update multiple entity values with a single API call, consider + using the **[Update entity](#update-entity)** method instead.
+
+ This operation is limited to 1000 requests per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -666,7 +1000,13 @@ the response.
e_response Service return value of type T_VALUE -
public instance
update_workspace
importingi_workspace_idtype STRING
i_bodytype T_UPDATE_WORKSPACE optional
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE
raisingzcx_ibmc_service_exception
Update workspace. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_workspace
importingi_workspace_idtype STRING
i_bodytype T_UPDATE_WORKSPACE optional
i_appendtype BOOLEAN default C_BOOLEAN_FALSE
i_include_audittype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORKSPACE
raisingzcx_ibmc_service_exception

Update workspace

+ Update an existing workspace with new or modified data. You must provide + component objects defining the content of the updated workspace.
+
+ This operation is limited to 30 request per 30 minutes. For more information, + see **Rate limiting**.
Parameters
i_workspace_id Unique identifier of the workspace. @@ -692,4 +1032,5 @@ the response.
e_response Service return value of type T_WORKSPACE -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v2.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v2.html index bfe5c2b..3e1dd19 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v2.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_assistant_v2.html @@ -1,20 +1,50 @@ -Class ZCL_IBMC_ASSISTANT_V2

Class ZCL_IBMC_ASSISTANT_V2

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Watson Assistant v2

+Class ZCL_IBMC_ASSISTANT_V2

Class ZCL_IBMC_ASSISTANT_V2

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Watson Assistant v2

The IBM Watson™ Assistant service combines machine learning, natural language understanding, and an integrated dialog editor to create conversation flows between your apps and your users.

The Assistant v2 API provides runtime methods your client application can use to - send user input to an assistant and receive a response.

Types

Visibility and LevelNameDocumentation
publict_capture_group (structured type) No documentation available.
publict_dialog_log_message (structured type) Dialog log message details.
publict_dialog_nodes_visited (structured type) No documentation available.
publict_dialog_node_action (structured type) No documentation available.
publict_dialog_suggestion (structured type) No documentation available.
publict_dialog_suggestion_value (structured type) An object defining the message input to be sent to the assistant if the user - selects the corresponding disambiguation option.
publict_dia_nd_output_opt_elem_value (structured type) An object defining the message input to be sent to the assistant if the user - selects the corresponding option.
publict_dia_node_output_opt_element (structured type) No documentation available.
publict_empty_response type JSONOBJECT No documentation available.
publict_error_detail (structured type) No documentation available.
publict_error_response (structured type) No documentation available.
publict_message_context (structured type) No documentation available.
publict_message_context_global (structured type) Information that is shared by all skills used by the Assistant.
publict_message_context_skill (structured type) Contains information specific to a particular skill used by the Assistant.
publict_message_context_skills type MAP Information specific to particular skills used by the Assistant.
-
- **Note:** Currently, only a single property named `main skill` is supported. - This object contains variables that apply to the dialog skill used by the - assistant.
publict_message_input (structured type) An input object that includes the input text.
publict_message_input_options (structured type) Optional properties that control how the assistant responds.
publict_message_output (structured type) Assistant output to be rendered or processed by the client.
publict_message_output_debug (structured type) Additional detailed information about a message response and how it was - generated.
publict_message_request (structured type) A request formatted for the Watson Assistant service.
publict_message_response (structured type) A response from the Watson Assistant service.
publict_mssg_context_global_system (structured type) Built-in system properties that apply to all skills used by the assistant.
publict_rt_entity_interpretation (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_date (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_num (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_time (structured type) No documentation available.
publict_rt_response_type_suggestion (structured type) No documentation available.
publict_rt_resp_typ_connect_to_agent (structured type) No documentation available.
publict_runtime_entity (structured type) The entity value that was recognized in the user input.
publict_runtime_entity_alternative (structured type) An alternative value for the recognized entity.
publict_runtime_entity_role (structured type) An object describing the role played by a system entity that is specifies the - beginning or end of a range recognized in the user input. This property is - included only if the new system entities are enabled for the skill.
publict_runtime_intent (structured type) An intent identified in the user input.
publict_runtime_response_generic (structured type) No documentation available.
publict_runtime_response_type_image (structured type) No documentation available.
publict_runtime_response_type_option (structured type) No documentation available.
publict_runtime_response_type_pause (structured type) No documentation available.
publict_runtime_response_type_search (structured type) No documentation available.
publict_runtime_response_type_text (structured type) No documentation available.
publict_search_result (structured type) No documentation available.
publict_search_result_highlight (structured type) An object containing segments of text from search results with query-matching - text highlighted using HTML <em> tags.
publict_search_result_metadata (structured type) An object containing search result metadata from the Discovery service.
publict_session_response (structured type) No documentation available.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
create_session
importingi_assistant_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SESSION_RESPONSE
raisingzcx_ibmc_service_exception
 Create a session. + send user input to an assistant and receive a response.

Types

Visibility and LevelNameDocumentation
publict_capture_group (structured type) No documentation available.
publict_dialog_log_message (structured type)

+ Dialog log message details.

publict_dialog_nodes_visited (structured type) No documentation available.
publict_dialog_node_action (structured type) No documentation available.
publict_dialog_suggestion (structured type) No documentation available.
publict_dialog_suggestion_value (structured type)

+ An object defining the message input to be sent to the

+ assistant if the user selects the corresponding disambiguation option.
publict_dia_nd_output_opt_elem_value (structured type)

+ An object defining the message input to be sent to the

+ assistant if the user selects the corresponding option.
publict_dia_node_output_opt_element (structured type) No documentation available.
publict_empty_response type JSONOBJECT No documentation available.
publict_error_detail (structured type) No documentation available.
publict_error_response (structured type) No documentation available.
publict_message_context (structured type) No documentation available.
publict_message_context_global (structured type)

+ Information that is shared by all skills used by the

+ Assistant.
publict_message_context_skill (structured type)

+ Contains information specific to a particular skill used by

+ the Assistant.
publict_message_context_skills type MAP

+ Information specific to particular skills used by the

+ Assistant.
+
+ **Note:** Currently, only a single property named `main skill` is supported. + This object contains variables that apply to the dialog skill used by the + assistant.
publict_message_input (structured type)

+ An input object that includes the input text.

publict_message_input_options (structured type)

+ Optional properties that control how the assistant responds.

publict_message_output (structured type)

+ Assistant output to be rendered or processed by the client.

publict_message_output_debug (structured type)

+ Additional detailed information about a message response and

+ how it was generated.
publict_message_request (structured type)

+ A request formatted for the Watson Assistant service.

publict_message_response (structured type)

+ A response from the Watson Assistant service.

publict_mssg_context_global_system (structured type)

+ Built-in system properties that apply to all skills used by

+ the assistant.
publict_rt_entity_interpretation (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_date (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_num (structured type) No documentation available.
publict_rt_entty_intrprttn_sys_time (structured type) No documentation available.
publict_rt_response_type_suggestion (structured type) No documentation available.
publict_rt_resp_typ_connect_to_agent (structured type) No documentation available.
publict_runtime_entity (structured type)

+ The entity value that was recognized in the user input.

publict_runtime_entity_alternative (structured type)

+ An alternative value for the recognized entity.

publict_runtime_entity_role (structured type)

+ An object describing the role played by a system entity that

+ is specifies the beginning or end of a range recognized in the user input. This + property is included only if the new system entities are enabled for the skill.
publict_runtime_intent (structured type)

+ An intent identified in the user input.

publict_runtime_response_generic (structured type) No documentation available.
publict_runtime_response_type_image (structured type) No documentation available.
publict_runtime_response_type_option (structured type) No documentation available.
publict_runtime_response_type_pause (structured type) No documentation available.
publict_runtime_response_type_search (structured type) No documentation available.
publict_runtime_response_type_text (structured type) No documentation available.
publict_search_result (structured type) No documentation available.
publict_search_result_highlight (structured type)

+ An object containing segments of text from search results

+ with query-matching text highlighted using HTML <em> tags.
publict_search_result_metadata (structured type)

+ An object containing search result metadata from the

+ Discovery service.
publict_session_response (structured type) No documentation available.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
create_session
importingi_assistant_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SESSION_RESPONSE
raisingzcx_ibmc_service_exception

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).
Parameters
i_assistant_id Unique identifier of the assistant. To find the assistant ID in the Watson @@ -26,7 +56,12 @@ **Note:** Currently, the v2 API does not support creating assistants.
e_response Service return value of type T_SESSION_RESPONSE -
public instance
delete_session
importingi_assistant_idtype STRING
i_session_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Delete session. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_session
importingi_assistant_idtype STRING
i_session_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete session

+ Deletes a session explicitly before it times out. (For more information about + the session inactivity timeout, see the + [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-assistant- + settings)).
Parameters
i_assistant_id Unique identifier of the assistant. To find the assistant ID in the Watson @@ -38,7 +73,11 @@ **Note:** Currently, the v2 API does not support creating assistants.
i_session_id Unique identifier of the session. -
public instanceget_appname redefinition 
public instanceget_request_prop redefinition 
public instanceget_sdk_version_date redefinition 
public instance
message
importingi_assistant_idtype STRING
i_session_idtype STRING
i_requesttype T_MESSAGE_REQUEST optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_MESSAGE_RESPONSE
raisingzcx_ibmc_service_exception
 Send user input to assistant. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
message
importingi_assistant_idtype STRING
i_session_idtype STRING
i_requesttype T_MESSAGE_REQUEST optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_MESSAGE_RESPONSE
raisingzcx_ibmc_service_exception

Send user input to assistant

+ Send user input to an assistant and receive a response.
+
+ There is no rate limit for this operation.
Parameters
i_assistant_id Unique identifier of the assistant. To find the assistant ID in the Watson @@ -51,8 +90,9 @@
i_session_id Unique identifier of the session.
i_request - The message to be sent. This includes the user's input, along with optional + The message to be sent. This includes the user's input, along with optional content such as intents and entities.
e_response Service return value of type T_MESSAGE_RESPONSE -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_compare_comply_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_compare_comply_v1.html index 76290f7..f12dd88 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_compare_comply_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_compare_comply_v1.html @@ -1,37 +1,118 @@ -Class ZCL_IBMC_COMPARE_COMPLY_V1

Class ZCL_IBMC_COMPARE_COMPLY_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Compare and Comply

+Class ZCL_IBMC_COMPARE_COMPLY_V1

Class ZCL_IBMC_COMPARE_COMPLY_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Compare and Comply

IBM Watson™ Compare and Comply analyzes governing documents to provide - details about critical aspects of the documents.

Types

Visibility and LevelNameDocumentation
publict_address (structured type) A party's address.
publict_aligned_element (structured type) No documentation available.
publict_attribute (structured type) List of document attributes.
publict_batches (structured type) The results of a successful **List Batches** request.
publict_batch_status (structured type) The batch-request status.
publict_body_cells (structured type) Cells that are not table header, column header, or row header cells.
publict_category (structured type) Information defining an element's subject matter.
publict_category_comparison (structured type) Information defining an element's subject matter.
publict_classify_return (structured type) The analysis of objects returned by the **Element classification** method.
publict_column_headers (structured type) Column-level cells, each applicable as a header to other cells in the same - column as itself, of the current table.
publict_column_header_ids type TT_STRING An array that contains the `id` value of a column header that is applicable to - the current cell.
publict_column_header_texts type TT_STRING An array that contains the `text` value of a column header that is applicable to - the current cell.
publict_column_header_texts_norm type TT_STRING 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`.
publict_compare_return (structured type) The comparison of the two submitted documents.
publict_contact (structured type) A contact.
publict_contexts (structured type) Text that is related to the contents of the table and that precedes or follows - the current table.
publict_contract_amts (structured type) A monetary amount identified in the input document.
publict_contract_currencies (structured type) The contract currencies that are declared in the document.
publict_contract_terms (structured type) The duration or durations of the contract.
publict_contract_types (structured type) The contract type identified in the input document.
publict_document (structured type) Basic information about the input document.
publict_doc_counts (structured type) Document counts.
publict_doc_info (structured type) Information about the parsed input document.
publict_doc_structure (structured type) The structure of the input document.
publict_effective_dates (structured type) An effective date.
publict_element (structured type) A component part of the document.
publict_element_locations (structured type) A list of `begin` and `end` indexes that indicate the locations of the elements - in the input document.
publict_element_pair (structured type) Details of semantically aligned elements.
publict_error_response (structured type) No documentation available.
publict_feedback_data_input (structured type) Feedback data for submission.
publict_feedback_data_output (structured type) Information returned from the **Add Feedback** method.
publict_feedback_deleted (structured type) The status and message of the deletion request.
publict_feedback_input (structured type) The feedback to be added to an element in the document.
publict_feedback_list (structured type) The results of a successful **List Feedback** request for all feedback.
publict_feedback_return (structured type) Information about the document and the submitted feedback.
publict_get_feedback (structured type) The results of a successful **Get Feedback** request for a single feedback - entry.
publict_htmlreturn (structured type) The HTML converted from an input document.
publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_inline_object2 (structured type) No documentation available.
publict_inline_object3 (structured type) No documentation available.
publict_inline_object4 (structured type) No documentation available.
publict_interpretation (structured type) The details of the normalized text, if applicable. This element is optional; it - is returned only if normalized text exists.
publict_key (structured type) A key in a key-value pair.
publict_key_value_pair (structured type) Key-value pairs detected across cell boundaries.
publict_label (structured type) 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.
publict_leading_sentence (structured type) The leading sentences in a section or subsection of the input document.
publict_location (structured type) The numeric location of the identified element in the document, represented with - two integers labeled `begin` and `end`.
publict_mention (structured type) A mention of a party.
publict_original_labels_in (structured type) The original labeling from the input document, without the submitted feedback.
publict_original_labels_out (structured type) The original labeling from the input document, without the submitted feedback.
publict_pagination (structured type) Pagination details, if required by the length of the output.
publict_paragraphs (structured type) The locations of each paragraph in the input document.
publict_parties (structured type) A party and its corresponding role, including address and contact information if - identified.
publict_payment_terms (structured type) The document's payment duration or durations.
publict_row_headers (structured type) Row-level cells, each applicable as a header to other cells in the same row as - itself, of the current table.
publict_row_header_ids type TT_STRING An array that contains the `id` value of a row header that is applicable to this - body cell.
publict_row_header_texts type TT_STRING An array that contains the `text` value of a row header that is applicable to - this body cell.
publict_row_header_texts_normalized type TT_STRING 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`.
publict_section_title (structured type) The table's section title, if identified.
publict_section_titles (structured type) 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.
publict_short_doc (structured type) Brief information about the input document.
publict_tables (structured type) The contents of the tables extracted from a document.
publict_table_headers (structured type) The contents of the current table's header.
publict_table_return (structured type) The analysis of the document's tables.
publict_table_title (structured type) 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.
publict_termination_dates (structured type) Termination dates identified in the input document.
publict_type_label (structured type) Identification of a specific type.
publict_type_label_comparison (structured type) Identification of a specific type.
publict_unaligned_element (structured type) Element that does not align semantically between two compared documents.
publict_updated_labels_in (structured type) The updated labeling from the input document, accounting for the submitted - feedback.
publict_updated_labels_out (structured type) The updated labeling from the input document, accounting for the submitted - feedback.
publict_value (structured type) A value in a key-value pair.
publict_values TYPE STANDARD TABLE OF T_VALUE WITH NON-UNIQUE DEFAULT KEY A list of values in a key-value pair.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
add_feedback
importingi_feedback_datatype T_FEEDBACK_INPUT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_FEEDBACK_RETURN
raisingzcx_ibmc_service_exception
 Add feedback. + details about critical aspects of the documents.

Types

Visibility and LevelNameDocumentation
publict_address (structured type)

+ A party's address.

publict_aligned_element (structured type) No documentation available.
publict_attribute (structured type)

+ List of document attributes.

publict_batches (structured type)

+ The results of a successful **List Batches** request.

publict_batch_status (structured type)

+ The batch-request status.

publict_body_cells (structured type)

+ Cells that are not table header, column header, or row

+ header cells.
publict_category (structured type)

+ Information defining an element's subject matter.

publict_category_comparison (structured type)

+ Information defining an element's subject matter.

publict_classify_return (structured type)

+ The analysis of objects returned by the **Element

+ classification** method.
publict_column_headers (structured type)

+ Column-level cells, each applicable as a header to other

+ cells in the same column as itself, of the current table.
publict_column_header_ids type TT_STRING

+ An array that contains the `id` value of a column header

+ that is applicable to the current cell.
publict_column_header_texts type TT_STRING

+ An array that contains the `text` value of a column header

+ that is applicable to the current cell.
publict_column_header_texts_norm type TT_STRING

+ 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`.
publict_compare_return (structured type)

+ The comparison of the two submitted documents.

publict_contact (structured type)

+ A contact.

publict_contexts (structured type)

+ Text that is related to the contents of the table and that

+ precedes or follows the current table.
publict_contract_amts (structured type)

+ A monetary amount identified in the input document.

publict_contract_currencies (structured type)

+ The contract currencies that are declared in the document.

publict_contract_terms (structured type)

+ The duration or durations of the contract.

publict_contract_types (structured type)

+ The contract type identified in the input document.

publict_document (structured type)

+ Basic information about the input document.

publict_doc_counts (structured type)

+ Document counts.

publict_doc_info (structured type)

+ Information about the parsed input document.

publict_doc_structure (structured type)

+ The structure of the input document.

publict_effective_dates (structured type)

+ An effective date.

publict_element (structured type)

+ A component part of the document.

publict_element_locations (structured type)

+ A list of `begin` and `end` indexes that indicate the

+ locations of the elements in the input document.
publict_element_pair (structured type)

+ Details of semantically aligned elements.

publict_error_response (structured type) No documentation available.
publict_feedback_data_input (structured type)

+ Feedback data for submission.

publict_feedback_data_output (structured type)

+ Information returned from the **Add Feedback** method.

publict_feedback_deleted (structured type)

+ The status and message of the deletion request.

publict_feedback_input (structured type)

+ The feedback to be added to an element in the document.

publict_feedback_list (structured type)

+ The results of a successful **List Feedback** request for

+ all feedback.
publict_feedback_return (structured type)

+ Information about the document and the submitted feedback.

publict_get_feedback (structured type)

+ The results of a successful **Get Feedback** request for a

+ single feedback entry.
publict_htmlreturn (structured type)

+ The HTML converted from an input document.

publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_inline_object2 (structured type) No documentation available.
publict_inline_object3 (structured type) No documentation available.
publict_inline_object4 (structured type) No documentation available.
publict_interpretation (structured type)

+ The details of the normalized text, if applicable. This

+ element is optional; it is returned only if normalized text exists.
publict_key (structured type)

+ A key in a key-value pair.

publict_key_value_pair (structured type)

+ Key-value pairs detected across cell boundaries.

publict_label (structured type)

+ 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.
publict_leading_sentence (structured type)

+ The leading sentences in a section or subsection of the

+ input document.
publict_location (structured type)

+ The numeric location of the identified element in the

+ document, represented with two integers labeled `begin` and `end`.
publict_mention (structured type)

+ A mention of a party.

publict_original_labels_in (structured type)

+ The original labeling from the input document, without the

+ submitted feedback.
publict_original_labels_out (structured type)

+ The original labeling from the input document, without the

+ submitted feedback.
publict_pagination (structured type)

+ Pagination details, if required by the length of the output.

publict_paragraphs (structured type)

+ The locations of each paragraph in the input document.

publict_parties (structured type)

+ A party and its corresponding role, including address and

+ contact information if identified.
publict_payment_terms (structured type)

+ The document's payment duration or durations.

publict_row_headers (structured type)

+ Row-level cells, each applicable as a header to other cells

+ in the same row as itself, of the current table.
publict_row_header_ids type TT_STRING

+ An array that contains the `id` value of a row header that

+ is applicable to this body cell.
publict_row_header_texts type TT_STRING

+ An array that contains the `text` value of a row header that

+ is applicable to this body cell.
publict_row_header_texts_normalized type TT_STRING

+ 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`.
publict_section_title (structured type)

+ The table's section title, if identified.

publict_section_titles (structured type)

+ 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.
publict_short_doc (structured type)

+ Brief information about the input document.

publict_tables (structured type)

+ The contents of the tables extracted from a document.

publict_table_headers (structured type)

+ The contents of the current table's header.

publict_table_return (structured type)

+ The analysis of the document's tables.

publict_table_title (structured type)

+ 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.
publict_termination_dates (structured type)

+ Termination dates identified in the input document.

publict_type_label (structured type)

+ Identification of a specific type.

publict_type_label_comparison (structured type)

+ Identification of a specific type.

publict_unaligned_element (structured type)

+ Element that does not align semantically between two

+ compared documents.
publict_updated_labels_in (structured type)

+ The updated labeling from the input document, accounting for

+ the submitted feedback.
publict_updated_labels_out (structured type)

+ The updated labeling from the input document, accounting for

+ the submitted feedback.
publict_value (structured type)

+ A value in a key-value pair.

publict_values TYPE STANDARD TABLE OF T_VALUE WITH NON-UNIQUE DEFAULT KEY

+ A list of values in a key-value pair.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
add_feedback
importingi_feedback_datatype T_FEEDBACK_INPUT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_FEEDBACK_RETURN
raisingzcx_ibmc_service_exception

Add feedback

+ Adds feedback in the form of _labels_ from a subject-matter expert (SME) to a + governing document.
+ **Important:** Feedback is not immediately incorporated into the training model, + nor is it guaranteed to be incorporated at a later date. Instead, submitted + feedback is used to suggest future updates to the training model.
Parameters
i_feedback_data An object that defines the feedback to be submitted.
e_response Service return value of type T_FEEDBACK_RETURN -
public instance
classify_elements
importingi_filetype FILE
i_file_content_typetype STRING optional
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFY_RETURN
raisingzcx_ibmc_service_exception
 Classify the elements of a document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
classify_elements
importingi_filetype FILE
i_file_content_typetype STRING optional
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFY_RETURN
raisingzcx_ibmc_service_exception

Classify the elements of a document

+ Analyzes the structural and semantic elements of a document.
Parameters
i_file The document to classify. @@ -41,11 +122,13 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_CLASSIFY_RETURN -
public instance
compare_documents
importingi_file_1type FILE
i_file_2type FILE
i_file_1_content_typetype STRING optional
i_file_2_content_typetype STRING optional
i_file_1_labeltype STRING default 'file_1'
i_file_2_labeltype STRING default 'file_2'
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COMPARE_RETURN
raisingzcx_ibmc_service_exception
 Compare two documents. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
compare_documents
importingi_file_1type FILE
i_file_2type FILE
i_file_1_content_typetype STRING optional
i_file_2_content_typetype STRING optional
i_file_1_labeltype STRING default 'file_1'
i_file_2_labeltype STRING default 'file_2'
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COMPARE_RETURN
raisingzcx_ibmc_service_exception

Compare two documents

+ Compares two input documents. Documents must be in the same format.
Parameters
i_file_1 The first document to compare. @@ -63,11 +146,13 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_COMPARE_RETURN -
public instance
convert_to_html
importingi_filetype FILE
i_file_content_typetype STRING optional
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_HTMLRETURN
raisingzcx_ibmc_service_exception
Convert document to HTML. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
convert_to_html
importingi_filetype FILE
i_file_content_typetype STRING optional
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_HTMLRETURN
raisingzcx_ibmc_service_exception

Convert document to HTML

+ Converts a document to HTML.
Parameters
i_file The document to convert. @@ -77,11 +162,21 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_HTMLRETURN -
public instance
create_batch
importingi_functiontype STRING
i_input_credentials_filetype FILE
i_input_bucket_locationtype STRING
i_input_bucket_nametype STRING
i_output_credentials_filetype FILE
i_output_bucket_locationtype STRING
i_output_bucket_nametype STRING
i_modeltype STRING optional
i_input_credentials_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_output_credentials_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCH_STATUS
raisingzcx_ibmc_service_exception
Submit a batch-processing request. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_batch
importingi_functiontype STRING
i_input_credentials_filetype FILE
i_input_bucket_locationtype STRING
i_input_bucket_nametype STRING
i_output_credentials_filetype FILE
i_output_bucket_locationtype STRING
i_output_bucket_nametype STRING
i_modeltype STRING optional
i_input_credentials_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_output_credentials_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCH_STATUS
raisingzcx_ibmc_service_exception

Submit a batch-processing request

+ Run Compare and Comply methods over a collection of input documents.
+
+ **Important:** Batch processing requires the use of the [IBM Cloud Object + Storage + service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-o + bject-storage-about#about-ibm-cloud-object-storage). The use of IBM Cloud Object + Storage with Compare and Comply is discussed at [Using batch + processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-co + mply-batching#before-you-batch).
Parameters
i_function The Compare and Comply method to run across the submitted input documents. @@ -109,11 +204,13 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_BATCH_STATUS -
public instance
delete_feedback
importingi_feedback_idtype STRING
i_modeltype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_FEEDBACK_DELETED
raisingzcx_ibmc_service_exception
Delete a specified feedback entry. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_feedback
importingi_feedback_idtype STRING
i_modeltype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_FEEDBACK_DELETED
raisingzcx_ibmc_service_exception

Delete a specified feedback entry

+ Deletes a feedback entry with a specified `feedback_id`.
Parameters
i_feedback_id A string that specifies the feedback entry to be deleted from the document. @@ -121,11 +218,13 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_FEEDBACK_DELETED -
public instance
extract_tables
importingi_filetype FILE
i_file_content_typetype STRING optional
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TABLE_RETURN
raisingzcx_ibmc_service_exception
Extract a document's tables. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
extract_tables
importingi_filetype FILE
i_file_content_typetype STRING optional
i_modeltype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TABLE_RETURN
raisingzcx_ibmc_service_exception

Extract a document's tables

+ Analyzes the tables in a document.
Parameters
i_file The document on which to run table extraction. @@ -135,17 +234,21 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_TABLE_RETURN -
public instanceget_appname redefinition public instance
get_batch
importingi_batch_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCH_STATUS
raisingzcx_ibmc_service_exception
Get information about a specific batch-processing job. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_batch
importingi_batch_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCH_STATUS
raisingzcx_ibmc_service_exception

Get information about a specific batch-processing job

+ Gets information about a batch-processing job with a specified ID.
Parameters
i_batch_id The ID of the batch-processing job whose information you want to retrieve.
e_response Service return value of type T_BATCH_STATUS -
public instance
get_feedback
importingi_feedback_idtype STRING
i_modeltype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GET_FEEDBACK
raisingzcx_ibmc_service_exception
Get a specified feedback entry. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_feedback
importingi_feedback_idtype STRING
i_modeltype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GET_FEEDBACK
raisingzcx_ibmc_service_exception

Get a specified feedback entry

+ Gets a feedback entry with a specified `feedback_id`.
Parameters
i_feedback_id A string that specifies the feedback entry to be included in the output. @@ -153,15 +256,19 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_GET_FEEDBACK -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_batches
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCHES
raisingzcx_ibmc_service_exception
List submitted batch-processing jobs. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_batches
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCHES
raisingzcx_ibmc_service_exception

List submitted batch-processing jobs

+ Lists batch-processing jobs submitted by users.
Parameters
e_response Service return value of type T_BATCHES -
public instance
list_feedback
importingi_feedback_typetype STRING optional
i_beforetype DATE optional
i_aftertype DATE optional
i_document_titletype STRING optional
i_model_idtype STRING optional
i_model_versiontype STRING optional
i_category_removedtype STRING optional
i_category_addedtype STRING optional
i_category_not_changedtype STRING optional
i_type_removedtype STRING optional
i_type_addedtype STRING optional
i_type_not_changedtype STRING optional
i_page_limittype INTEGER optional
i_cursortype STRING optional
i_sorttype STRING optional
i_include_totaltype BOOLEAN optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_FEEDBACK_LIST
raisingzcx_ibmc_service_exception
List the feedback in a document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_feedback
importingi_feedback_typetype STRING optional
i_beforetype DATE optional
i_aftertype DATE optional
i_document_titletype STRING optional
i_model_idtype STRING optional
i_model_versiontype STRING optional
i_category_removedtype STRING optional
i_category_addedtype STRING optional
i_category_not_changedtype STRING optional
i_type_removedtype STRING optional
i_type_addedtype STRING optional
i_type_not_changedtype STRING optional
i_page_limittype INTEGER optional
i_cursortype STRING optional
i_sorttype STRING optional
i_include_totaltype BOOLEAN optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_FEEDBACK_LIST
raisingzcx_ibmc_service_exception

List the feedback in a document

+ Lists the feedback in a document.
Parameters
i_feedback_type An optional string that filters the output to include only feedback with the @@ -222,7 +329,10 @@ feedback created.
e_response Service return value of type T_FEEDBACK_LIST -
public instance
update_batch
importingi_batch_idtype STRING
i_actiontype STRING
i_modeltype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCH_STATUS
raisingzcx_ibmc_service_exception
Update a pending or active batch-processing job. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_batch
importingi_batch_idtype STRING
i_actiontype STRING
i_modeltype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_BATCH_STATUS
raisingzcx_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.
Parameters
i_batch_id The ID of the batch-processing job you want to update. @@ -232,8 +342,9 @@ 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. - + standalone methods as well as to the methods' use in batch-processing + requests.
e_response Service return value of type T_BATCH_STATUS -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_discovery_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_discovery_v1.html index 2fc702f..311dac6 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_discovery_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_discovery_v1.html @@ -1,43 +1,213 @@ -Class ZCL_IBMC_DISCOVERY_V1

Class ZCL_IBMC_DISCOVERY_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Discovery

+Class ZCL_IBMC_DISCOVERY_V1

Class ZCL_IBMC_DISCOVERY_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

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.

Types

Visibility and LevelNameDocumentation
publict_aggregation_result (structured type) Aggregation results for the specified query.
publict_calculation (structured type) No documentation available.
publict_collection (structured type) A collection for storing documents.
publict_collection_crawl_status (structured type) Object containing information about the crawl status of this collection.
publict_collection_disk_usage (structured type) Summary of the disk usage statistics for this collection.
publict_collection_usage (structured type) Summary of the collection usage in the environment.
publict_coll_query_large (structured type) Object that describes a long query.
publict_completions (structured type) An object containing an array of autocompletion suggestions.
publict_configuration (structured type) A custom configuration for the environment.
publict_conversions (structured type) Document conversion settings.
publict_create_collection_request (structured type) Object containing specification for a new collection.
publict_create_environment_request (structured type) Object containing information about a new environment.
publict_create_event_object (structured type) An object defining the event being created.
publict_create_event_response (structured type) An object defining the event being created.
publict_credentials (structured type) Object containing credential information.
publict_credentials_list (structured type) Object containing array of credential definitions.
publict_credential_details (structured type) Object containing details of the stored credentials.
+ language to eliminate the need for manual filtering of results.

Types

Visibility and LevelNameDocumentation
publict_aggregation_result (structured type)

+ Aggregation results for the specified query.

publict_calculation (structured type) No documentation available.
publict_collection (structured type)

+ A collection for storing documents.

publict_collection_crawl_status (structured type)

+ Object containing information about the crawl status of this

+ collection.
publict_collection_disk_usage (structured type)

+ Summary of the disk usage statistics for this collection.

publict_collection_usage (structured type)

+ Summary of the collection usage in the environment.

publict_coll_query_large (structured type)

+ Object that describes a long query.

publict_completions (structured type)

+ An object containing an array of autocompletion suggestions.

publict_configuration (structured type)

+ A custom configuration for the environment.

publict_conversions (structured type)

+ Document conversion settings.

publict_create_collection_request (structured type)

+ Object containing specification for a new collection.

publict_create_environment_request (structured type)

+ Object containing information about a new environment.

publict_create_event_object (structured type)

+ An object defining the event being created.

publict_create_event_response (structured type)

+ An object defining the event being created.

publict_credentials (structured type)

+ Object containing credential information.

publict_credentials_list (structured type)

+ Object containing array of credential definitions.

publict_credential_details (structured type)

+ Object containing details of the stored credentials.


+
+ Obtain credentials for your source from the administrator of the source.
publict_delete_collection_response (structured type)

+ Response object returned when deleting a colleciton.

publict_delete_credentials (structured type)

+ Object returned after credentials are deleted.

publict_delete_document_response (structured type)

+ Information returned when a document is deleted.

publict_delete_environment_response (structured type)

+ Response object returned when deleting an environment.

publict_del_configuration_response (structured type)

+ Information returned when a configuration is deleted.

publict_disk_usage (structured type)

+ Summary of the disk usage statistics for the environment.

publict_document_accepted (structured type)

+ Information returned after an uploaded document is accepted.

publict_document_counts (structured type)

+ Object containing collection document count information.

publict_document_status (structured type)

+ Status information about a submitted document.

publict_elements_enrichment_options (structured type)

+ An object representing the configuration options to use for

+ the `elements` enrichment.
publict_enrichment (structured type)

+ 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.
publict_enrichments TYPE STANDARD TABLE OF T_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY

+ An array of document enrichment settings for the

+ configuration.
publict_enrichment_options (structured type)

+ Options which are specific to a particular enrichment.

publict_environment (structured type)

+ Details about an environment.

publict_environment_documents (structured type)

+ Summary of the document usage statistics for the

+ environment.
publict_error_response (structured type)

+ An error response object.

publict_event_data (structured type)

+ Query event data object.

publict_expansion (structured type)

+ 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.
publict_expansions (structured type)

+ The query expansion definitions for the specified

+ collection.
publict_fed_query_large (structured type)

+ Object that describes a long query.

publict_field (structured type)

+ Object containing field details.

publict_filter (structured type) No documentation available.
publict_font_setting (structured type)

+ Font matching configuration.

publict_font_settings TYPE STANDARD TABLE OF T_FONT_SETTING WITH NON-UNIQUE DEFAULT KEY

+ Array of font matching configurations.

publict_gateway (structured type)

+ Object describing a specific gateway.

publict_gateway_delete (structured type)

+ Gatway deletion confirmation.

publict_gateway_list (structured type)

+ Object containing gateways array.

publict_gateway_name (structured type)

+ Object containing user-defined name.

publict_histogram (structured type) No documentation available.
publict_html_settings (structured type)

+ A list of HTML conversion settings.

publict_index_capacity (structured type)

+ Details about the resource usage and capacity of the

+ environment.
publict_inline_object (structured type) No documentation available.
publict_list_collections_response (structured type)

+ Response object containing an array of collection details.

publict_list_configurations_response (structured type)

+ Object containing an array of available configurations.

publict_list_environments_response (structured type)

+ Response object containing an array of configured

+ environments.
publict_log_qry_resp_rslt_docs_rslt (structured type)

+ Each object in the **results** array corresponds to an

+ individual document returned by the original query.
publict_log_query_response (structured type)

+ Object containing results that match the requested **logs**

+ query.
publict_log_query_response_result (structured type)

+ 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.
publict_log_query_resp_result_docs (structured type)

+ Object containing result information that was returned by

+ the query used to create this log entry. Only returned with logs of type + `query`.
publict_lst_collection_fields_resp (structured type)

+ The list of fetched fields.


+
+ The fields are returned using a fully qualified name format, however, the format + differs slightly from that used by the query operations.
+
+ * Fields which contain nested JSON objects are assigned a type of + "nested".
+
+ * Fields which belong to a nested object are prefixed with `.properties` (for + example, `warnings.properties.severity` means that the `warnings` object has a + property called `severity`).
+
+ * Fields returned from the News collection are prefixed with + `v{N}-fullnews-t3-{YEAR}.mappings` (for example, + `v5-fullnews-t3-2016.mappings.text.properties.author`).
publict_metric_aggregation (structured type)

+ An aggregation analyzing log information for queries and

+ events.
publict_metric_aggregation_result (structured type)

+ Aggregation result data for the requested metric.

publict_metric_response (structured type)

+ The response generated from a call to a **metrics** method.

publict_metric_token_aggregation (structured type)

+ An aggregation analyzing log information for queries and

+ events.
publict_metric_token_aggr_result (structured type)

+ Aggregation result data for the requested metric.

publict_metric_token_response (structured type)

+ The response generated from a call to a **metrics** method

+ that evaluates tokens.
publict_nested (structured type) No documentation available.
publict_new_training_query (structured type)

+ Training query to add.

publict_nlu_enrichment_categories type MAP

+ An object that indicates the Categories enrichment will be

+ applied to the specified field.
publict_nlu_enrichment_concepts (structured type)

+ An object specifiying the concepts enrichment and related

+ parameters.
publict_nlu_enrichment_emotion (structured type)

+ An object specifying the emotion detection enrichment and

+ related parameters.
publict_nlu_enrichment_entities (structured type)

+ An object speficying the Entities enrichment and related

+ parameters.
publict_nlu_enrichment_features (structured type)

+ Object containing Natural Language Understanding features to

+ be used.
publict_nlu_enrichment_keywords (structured type)

+ An object specifying the Keyword enrichment and related

+ parameters.
publict_nlu_enrichment_options (structured type)

+ An object representing the configuration options to use for

+ the `natural_language_understanding` enrichments.
publict_nlu_enrichment_relations (structured type)

+ An object specifying the relations enrichment and related

+ parameters.
publict_nlu_enrichment_sentiment (structured type)

+ An object specifying the sentiment extraction enrichment and

+ related parameters.
publict_nl_enrichment_semantic_roles (structured type)

+ An object specifiying the semantic roles enrichment and

+ related parameters.
publict_normalizations TYPE STANDARD TABLE OF T_NORMALIZATION_OPERATION 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.
publict_normalization_operation (structured type)

+ Object containing normalization operations.

publict_notice (structured type)

+ A notice produced for the collection.

publict_pdf_heading_detection (structured type)

+ Object containing heading detection conversion settings for

+ PDF documents.
publict_pdf_settings (structured type)

+ A list of PDF conversion settings.

publict_query_aggregation (structured type)

+ An aggregation produced by Discovery to analyze the input

+ provided.
publict_query_large (structured type)

+ Object that describes a long query.

publict_query_notices_response (structured type)

+ Object containing notice query results.

publict_query_notices_result (structured type)

+ Query result object.

publict_query_passages (structured type)

+ A passage query result.

publict_query_response (structured type)

+ A response containing the documents and aggregations for the

+ query.
publict_query_result (structured type)

+ Query result object.

publict_query_result_metadata (structured type)

+ Metadata of a query result.

publict_retrieval_details (structured type)

+ An object contain retrieval type information.

publict_sdu_status (structured type)

+ Object containing smart document understanding information

+ for this collection.
publict_sdu_status_custom_fields (structured type)

+ Information about custom smart document understanding fields

+ that exist in this collection.
publict_search_status (structured type)

+ Information about the Continuous Relevancy Training for this

+ environment.
publict_segment_settings (structured type)

+ A list of Document Segmentation settings.

publict_source (structured type)

+ Object containing source parameters for the configuration.

publict_source_options (structured type)

+ The **options** object defines which items to crawl from the

+ source system.
publict_source_options_buckets (structured type)

+ Object defining a cloud object store bucket to crawl.

publict_source_options_folder (structured type)

+ Object that defines a box folder to crawl with this

+ configuration.
publict_source_options_object (structured type)

+ Object that defines a Salesforce document object type crawl

+ with this configuration.
publict_source_options_site_coll (structured type)

+ Object that defines a Microsoft SharePoint site collection

+ to crawl with this configuration.
publict_source_options_web_crawl (structured type)

+ Object defining which URL to crawl and how to crawl it.

publict_source_schedule (structured type)

+ Object containing the schedule information for the source.

publict_source_status (structured type)

+ Object containing source crawl status information.

publict_term (structured type) No documentation available.
publict_timeslice (structured type) No documentation available.
publict_token_dict (structured type)

+ Tokenization dictionary describing how words are tokenized

+ during ingestion and at query time.
publict_token_dict_rule (structured type)

+ An object defining a single tokenizaion rule.

publict_token_dict_status_response (structured type)

+ Object describing the current status of the wordlist.

publict_top_hits (structured type) No documentation available.
publict_top_hits_results (structured type)

+ Top hit information for this query.

publict_training_data_set (structured type)

+ Training information for a specific collection.

publict_training_example (structured type)

+ Training example details.

publict_training_example_list (structured type)

+ Object containing an array of training examples.

publict_training_example_patch (structured type)

+ Training example to add.

publict_training_query (structured type)

+ Training query details.

publict_training_status (structured type)

+ Training status details.

publict_update_collection_request (structured type)

+ Object containing collection update information.

publict_update_environment_request (structured type)

+ Object containing environment update information.

publict_word_heading_detection (structured type)

+ Object containing heading detection conversion settings for

+ Microsoft Word documents.
publict_word_settings (structured type)

+ A list of Word conversion settings.

publict_word_style (structured type)

+ Microsoft Word styles to convert into a specified HTML head

+ level.
publict_word_styles TYPE STANDARD TABLE OF T_WORD_STYLE WITH NON-UNIQUE DEFAULT KEY

+ Array of Microsoft Word styles to convert.

publict_xpath_patterns (structured type)

+ Object containing an array of XPaths.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
add_document
importingi_environment_idtype STRING
i_collection_idtype STRING
i_filetype FILE optional
i_filenametype STRING optional
i_file_content_typetype STRING optional
i_metadatatype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_ACCEPTED
raisingzcx_ibmc_service_exception

Add a document

+ Add a document to a collection with optional metadata.

- Obtain credentials for your source from the administrator of the source.
publict_delete_collection_response (structured type) Response object returned when deleting a colleciton.
publict_delete_credentials (structured type) Object returned after credentials are deleted.
publict_delete_document_response (structured type) Information returned when a document is deleted.
publict_delete_environment_response (structured type) Response object returned when deleting an environment.
publict_del_configuration_response (structured type) Information returned when a configuration is deleted.
publict_disk_usage (structured type) Summary of the disk usage statistics for the environment.
publict_document_accepted (structured type) Information returned after an uploaded document is accepted.
publict_document_counts (structured type) Object containing collection document count information.
publict_document_status (structured type) Status information about a submitted document.
publict_elements_enrichment_options (structured type) An object representing the configuration options to use for the `elements` - enrichment.
publict_enrichment (structured type) 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.
publict_enrichments TYPE STANDARD TABLE OF T_ENRICHMENT WITH NON-UNIQUE DEFAULT KEY An array of document enrichment settings for the configuration.
publict_enrichment_options (structured type) Options which are specific to a particular enrichment.
publict_environment (structured type) Details about an environment.
publict_environment_documents (structured type) Summary of the document usage statistics for the environment.
publict_error_response (structured type) An error response object.
publict_event_data (structured type) Query event data object.
publict_expansion (structured type) 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.
publict_expansions (structured type) The query expansion definitions for the specified collection.
publict_fed_query_large (structured type) Object that describes a long query.
publict_field (structured type) Object containing field details.
publict_filter (structured type) No documentation available.
publict_font_setting (structured type) Font matching configuration.
publict_font_settings TYPE STANDARD TABLE OF T_FONT_SETTING WITH NON-UNIQUE DEFAULT KEY Array of font matching configurations.
publict_gateway (structured type) Object describing a specific gateway.
publict_gateway_delete (structured type) Gatway deletion confirmation.
publict_gateway_list (structured type) Object containing gateways array.
publict_gateway_name (structured type) Object containing user-defined name.
publict_histogram (structured type) No documentation available.
publict_html_settings (structured type) A list of HTML conversion settings.
publict_index_capacity (structured type) Details about the resource usage and capacity of the environment.
publict_inline_object (structured type) No documentation available.
publict_list_collections_response (structured type) Response object containing an array of collection details.
publict_list_configurations_response (structured type) Object containing an array of available configurations.
publict_list_environments_response (structured type) Response object containing an array of configured environments.
publict_log_qry_resp_rslt_docs_rslt (structured type) Each object in the **results** array corresponds to an individual document - returned by the original query.
publict_log_query_response (structured type) Object containing results that match the requested **logs** query.
publict_log_query_response_result (structured type) 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.
publict_log_query_resp_result_docs (structured type) Object containing result information that was returned by the query used to - create this log entry. Only returned with logs of type `query`.
publict_lst_collection_fields_resp (structured type) The list of fetched fields.
+ * The **version** query parameter is still required.

- The fields are returned using a fully qualified name format, however, the format - differs slightly from that used by the query operations.
+ * Returns immediately after the system has accepted the document for + processing.

- * Fields which contain nested JSON objects are assigned a type of - "nested".
+ * The user must provide document content, metadata, or both. If the request is + missing both document content and metadata, it is rejected.

- * Fields which belong to a nested object are prefixed with `.properties` (for - example, `warnings.properties.severity` means that the `warnings` object has a - property called `severity`).
+ * The user can set the **Content-Type** parameter on the **file** part to + indicate the media type of the document. If the **Content-Type** parameter is + missing or is one of the generic media types (for example, + `application/octet-stream`), then the service attempts to automatically detect + the document's media type.

- * Fields returned from the News collection are prefixed with - `v{N}-fullnews-t3-{YEAR}.mappings` (for example, - `v5-fullnews-t3-2016.mappings.text.properties.author`).
publict_metric_aggregation (structured type) An aggregation analyzing log information for queries and events.
publict_metric_aggregation_result (structured type) Aggregation result data for the requested metric.
publict_metric_response (structured type) The response generated from a call to a **metrics** method.
publict_metric_token_aggregation (structured type) An aggregation analyzing log information for queries and events.
publict_metric_token_aggr_result (structured type) Aggregation result data for the requested metric.
publict_metric_token_response (structured type) The response generated from a call to a **metrics** method that evaluates - tokens.
publict_nested (structured type) No documentation available.
publict_new_training_query (structured type) Training query to add.
publict_nlu_enrichment_categories type MAP An object that indicates the Categories enrichment will be applied to the - specified field.
publict_nlu_enrichment_concepts (structured type) An object specifiying the concepts enrichment and related parameters.
publict_nlu_enrichment_emotion (structured type) An object specifying the emotion detection enrichment and related parameters.
publict_nlu_enrichment_entities (structured type) An object speficying the Entities enrichment and related parameters.
publict_nlu_enrichment_features (structured type) Object containing Natural Language Understanding features to be used.
publict_nlu_enrichment_keywords (structured type) An object specifying the Keyword enrichment and related parameters.
publict_nlu_enrichment_options (structured type) An object representing the configuration options to use for the - `natural_language_understanding` enrichments.
publict_nlu_enrichment_relations (structured type) An object specifying the relations enrichment and related parameters.
publict_nlu_enrichment_sentiment (structured type) An object specifying the sentiment extraction enrichment and related parameters. -
publict_nl_enrichment_semantic_roles (structured type) An object specifiying the semantic roles enrichment and related parameters.
publict_normalizations TYPE STANDARD TABLE OF T_NORMALIZATION_OPERATION 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.
publict_normalization_operation (structured type) Object containing normalization operations.
publict_notice (structured type) A notice produced for the collection.
publict_pdf_heading_detection (structured type) Object containing heading detection conversion settings for PDF documents.
publict_pdf_settings (structured type) A list of PDF conversion settings.
publict_query_aggregation (structured type) An aggregation produced by Discovery to analyze the input provided.
publict_query_large (structured type) Object that describes a long query.
publict_query_notices_response (structured type) Object containing notice query results.
publict_query_notices_result (structured type) Query result object.
publict_query_passages (structured type) A passage query result.
publict_query_response (structured type) A response containing the documents and aggregations for the query.
publict_query_result (structured type) Query result object.
publict_query_result_metadata (structured type) Metadata of a query result.
publict_retrieval_details (structured type) An object contain retrieval type information.
publict_sdu_status (structured type) Object containing smart document understanding information for this collection.
publict_sdu_status_custom_fields (structured type) Information about custom smart document understanding fields that exist in this - collection.
publict_search_status (structured type) Information about the Continuous Relevancy Training for this environment.
publict_segment_settings (structured type) A list of Document Segmentation settings.
publict_source (structured type) Object containing source parameters for the configuration.
publict_source_options (structured type) The **options** object defines which items to crawl from the source system.
publict_source_options_buckets (structured type) Object defining a cloud object store bucket to crawl.
publict_source_options_folder (structured type) Object that defines a box folder to crawl with this configuration.
publict_source_options_object (structured type) Object that defines a Salesforce document object type crawl with this - configuration.
publict_source_options_site_coll (structured type) Object that defines a Microsoft SharePoint site collection to crawl with this - configuration.
publict_source_options_web_crawl (structured type) Object defining which URL to crawl and how to crawl it.
publict_source_schedule (structured type) Object containing the schedule information for the source.
publict_source_status (structured type) Object containing source crawl status information.
publict_term (structured type) No documentation available.
publict_timeslice (structured type) No documentation available.
publict_token_dict (structured type) Tokenization dictionary describing how words are tokenized during ingestion and - at query time.
publict_token_dict_rule (structured type) An object defining a single tokenizaion rule.
publict_token_dict_status_response (structured type) Object describing the current status of the wordlist.
publict_top_hits (structured type) No documentation available.
publict_top_hits_results (structured type) Top hit information for this query.
publict_training_data_set (structured type) Training information for a specific collection.
publict_training_example (structured type) Training example details.
publict_training_example_list (structured type) Object containing an array of training examples.
publict_training_example_patch (structured type) Training example to add.
publict_training_query (structured type) Training query details.
publict_training_status (structured type) Training status details.
publict_update_collection_request (structured type) Object containing collection update information.
publict_update_environment_request (structured type) Object containing environment update information.
publict_word_heading_detection (structured type) Object containing heading detection conversion settings for Microsoft Word - documents.
publict_word_settings (structured type) A list of Word conversion settings.
publict_word_style (structured type) Microsoft Word styles to convert into a specified HTML head level.
publict_word_styles TYPE STANDARD TABLE OF T_WORD_STYLE WITH NON-UNIQUE DEFAULT KEY Array of Microsoft Word styles to convert.
publict_xpath_patterns (structured type) Object containing an array of XPaths.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
add_document
importingi_environment_idtype STRING
i_collection_idtype STRING
i_filetype FILE optional
i_filenametype STRING optional
i_file_content_typetype STRING optional
i_metadatatype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_ACCEPTED
raisingzcx_ibmc_service_exception
 Add a document. + * The following field names are reserved and will be filtered out if present + after normalization: `id`, `score`, `highlight`, and any field with the prefix + of: `_`, `+`, or `-`
+
+ * Fields with empty name values after normalization are filtered out before + indexing.
+
+ * Fields containing the following characters after normalization are filtered + out before indexing: `#` and `,`
+
+ **Note:** Documents can be added with a specific **document_id** by using the + **/v1/environments/{environment_id}/collections/{collection_id&# + 125;/documents** method.
Parameters
i_environment_id The ID of the environment. @@ -55,23 +225,27 @@
i_metadata The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: ``` {
- "Creator": "Johnny Appleseed",
- "Subject": "Apples"
+ "Creator": "Johnny Appleseed",
+ "Subject": "Apples"
} ```.
e_response Service return value of type T_DOCUMENT_ACCEPTED -
public instance
add_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_bodytype T_NEW_TRAINING_QUERY
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_QUERY
raisingzcx_ibmc_service_exception
 Add query to training data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_bodytype T_NEW_TRAINING_QUERY
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_QUERY
raisingzcx_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.
Parameters
i_environment_id The ID of the environment.
i_collection_id The ID of the collection.
i_body - The body of the training data query that is to be added to the collection's + The body of the training data query that is to be added to the collection's training data.
e_response Service return value of type T_TRAINING_QUERY -
public instance
create_collection
importingi_environment_idtype STRING
i_bodytype T_CREATE_COLLECTION_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
 Create a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_collection
importingi_environment_idtype STRING
i_bodytype T_CREATE_COLLECTION_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception

Create a collection

Parameters
i_environment_id The ID of the environment. @@ -79,7 +253,20 @@ Input an object that allows you to add a collection.
e_response Service return value of type T_COLLECTION -
public instance
create_configuration
importingi_environment_idtype STRING
i_configurationtype T_CONFIGURATION
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CONFIGURATION
raisingzcx_ibmc_service_exception
Add configuration. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_configuration
importingi_environment_idtype STRING
i_configurationtype T_CONFIGURATION
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CONFIGURATION
raisingzcx_ibmc_service_exception

Add configuration

+ Creates a new configuration.
+
+ If the input configuration contains the **configuration_id**, **created**, or + **updated** properties, then they are ignored and overridden by the system, and + an error is not returned so that the overridden fields do not need to be + removed when copying a configuration.
+
+ The configuration can contain unrecognized JSON fields. Any such fields are + ignored and do not generate an error. This makes it easier to use newer + configuration files with older versions of the API and the service. It also + makes it possible for the tooling to add additional metadata and information to + the configuration.
Parameters
i_environment_id The ID of the environment. @@ -102,7 +289,14 @@ the configuration.
e_response Service return value of type T_CONFIGURATION -
public instance
create_credentials
importingi_environment_idtype STRING
i_credentials_parametertype T_CREDENTIALS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS
raisingzcx_ibmc_service_exception
Create credentials. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_credentials
importingi_environment_idtype STRING
i_credentials_parametertype T_CREDENTIALS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS
raisingzcx_ibmc_service_exception

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.
+
+ **Note:** All credentials are sent over an encrypted connection and encrypted at + rest.
Parameters
i_environment_id The ID of the environment. @@ -110,7 +304,13 @@ An object that defines an individual set of source credentials.
e_response Service return value of type T_CREDENTIALS -
public instance
create_environment
importingi_bodytype T_CREATE_ENVIRONMENT_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENVIRONMENT
raisingzcx_ibmc_service_exception
Create an environment. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_environment
importingi_bodytype T_CREATE_ENVIRONMENT_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENVIRONMENT
raisingzcx_ibmc_service_exception

Create an environment

+ Creates a new environment for private data. An environment must be created + before collections can be created.
+
+ **Note**: You can create only one environment for private data per service + instance. An attempt to create another environment results in an error.
Parameters
i_body An object that defines an environment name and optional description. The fields @@ -118,13 +318,21 @@ based on customer ID.
e_response Service return value of type T_ENVIRONMENT -
public instance
create_event
importingi_query_eventtype T_CREATE_EVENT_OBJECT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREATE_EVENT_RESPONSE
raisingzcx_ibmc_service_exception
Create event. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_event
importingi_query_eventtype T_CREATE_EVENT_OBJECT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREATE_EVENT_RESPONSE
raisingzcx_ibmc_service_exception

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.
Parameters
i_query_event An object that defines a query event to be added to the log.
e_response Service return value of type T_CREATE_EVENT_RESPONSE -
public instance
create_expansions
importingi_environment_idtype STRING
i_collection_idtype STRING
i_bodytype T_EXPANSIONS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXPANSIONS
raisingzcx_ibmc_service_exception
Create or update expansion list. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_expansions
importingi_environment_idtype STRING
i_collection_idtype STRING
i_bodytype T_EXPANSIONS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXPANSIONS
raisingzcx_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`.
+ The current expansion list is replaced with the uploaded content.
Parameters
i_environment_id The ID of the environment. @@ -134,7 +342,9 @@ An object that defines the expansion list.
e_response Service return value of type T_EXPANSIONS -
public instance
create_gateway
importingi_environment_idtype STRING
i_gateway_nametype T_GATEWAY_NAME optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY
raisingzcx_ibmc_service_exception
Create Gateway. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_gateway
importingi_environment_idtype STRING
i_gateway_nametype T_GATEWAY_NAME optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY
raisingzcx_ibmc_service_exception

Create Gateway

+ Create a gateway configuration to use with a remotely installed gateway.
Parameters
i_environment_id The ID of the environment. @@ -142,7 +352,9 @@ The name of the gateway to created.
e_response Service return value of type T_GATEWAY -
public instance
create_stopword_list
importingi_environment_idtype STRING
i_collection_idtype STRING
i_stopword_filetype FILE
i_stopword_filenametype STRING
i_stopword_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception
Create stopword list. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_stopword_list
importingi_environment_idtype STRING
i_collection_idtype STRING
i_stopword_filetype FILE
i_stopword_filenametype STRING
i_stopword_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception

Create stopword list

+ Upload a custom stopword list to use with the specified collection.
Parameters
i_environment_id The ID of the environment. @@ -154,7 +366,9 @@ The filename for stopwordFile.
e_response Service return value of type T_TOKEN_DICT_STATUS_RESPONSE -
public instance
create_tokenization_dictionary
importingi_environment_idtype STRING
i_collection_idtype STRING
i_tokenization_dictionarytype T_TOKEN_DICT optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception
Create tokenization dictionary. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_tokenization_dictionary
importingi_environment_idtype STRING
i_collection_idtype STRING
i_tokenization_dictionarytype T_TOKEN_DICT optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception

Create tokenization dictionary

+ Upload a custom tokenization dictionary to use with the specified collection.
Parameters
i_environment_id The ID of the environment. @@ -164,7 +378,9 @@ An object that represents the tokenization dictionary to be uploaded.
e_response Service return value of type T_TOKEN_DICT_STATUS_RESPONSE -
public instance
create_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_bodytype T_TRAINING_EXAMPLE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE
raisingzcx_ibmc_service_exception
Add example to training data query. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_bodytype T_TRAINING_EXAMPLE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE
raisingzcx_ibmc_service_exception

Add example to training data query

+ Adds a example to this training data query.
Parameters
i_environment_id The ID of the environment. @@ -176,13 +392,16 @@ The body of the example that is to be added to the specified query.
e_response Service return value of type T_TRAINING_EXAMPLE -
public instance
delete_all_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception
Delete all training data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_all_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception

Delete all training data

+ Deletes all training data from a collection.
Parameters
i_environment_id The ID of the environment.
i_collection_id The ID of the collection. -
public instance
delete_collection
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_COLLECTION_RESPONSE
raisingzcx_ibmc_service_exception
Delete a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_collection
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_COLLECTION_RESPONSE
raisingzcx_ibmc_service_exception

Delete a collection

Parameters
i_environment_id The ID of the environment. @@ -190,7 +409,14 @@ The ID of the collection.
e_response Service return value of type T_DELETE_COLLECTION_RESPONSE -
public instance
delete_configuration
importingi_environment_idtype STRING
i_configuration_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DEL_CONFIGURATION_RESPONSE
raisingzcx_ibmc_service_exception
Delete a configuration. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_configuration
importingi_environment_idtype STRING
i_configuration_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DEL_CONFIGURATION_RESPONSE
raisingzcx_ibmc_service_exception

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.
Parameters
i_environment_id The ID of the environment. @@ -198,7 +424,9 @@ The ID of the configuration.
e_response Service return value of type T_DEL_CONFIGURATION_RESPONSE -
public instance
delete_credentials
importingi_environment_idtype STRING
i_credential_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_CREDENTIALS
raisingzcx_ibmc_service_exception
Delete credentials. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_credentials
importingi_environment_idtype STRING
i_credential_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_CREDENTIALS
raisingzcx_ibmc_service_exception

Delete credentials

+ Deletes a set of stored credentials from your Discovery instance.
Parameters
i_environment_id The ID of the environment. @@ -206,7 +434,11 @@ The unique identifier for a set of source credentials.
e_response Service return value of type T_DELETE_CREDENTIALS -
public instance
delete_document
importingi_environment_idtype STRING
i_collection_idtype STRING
i_document_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_DOCUMENT_RESPONSE
raisingzcx_ibmc_service_exception
Delete a document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_document
importingi_environment_idtype STRING
i_collection_idtype STRING
i_document_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_DOCUMENT_RESPONSE
raisingzcx_ibmc_service_exception

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'.
Parameters
i_environment_id The ID of the environment. @@ -216,19 +448,25 @@ The ID of the document.
e_response Service return value of type T_DELETE_DOCUMENT_RESPONSE -
public instance
delete_environment
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_ENVIRONMENT_RESPONSE
raisingzcx_ibmc_service_exception
Delete environment. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_environment
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_ENVIRONMENT_RESPONSE
raisingzcx_ibmc_service_exception

Delete environment

Parameters
i_environment_id The ID of the environment.
e_response Service return value of type T_DELETE_ENVIRONMENT_RESPONSE -
public instance
delete_expansions
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception
Delete the expansion list. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_expansions
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception

Delete the expansion list

+ Remove the expansion information for this collection. The expansion list must be + deleted to disable query expansion for a collection.
Parameters
i_environment_id The ID of the environment.
i_collection_id The ID of the collection. -
public instance
delete_gateway
importingi_environment_idtype STRING
i_gateway_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY_DELETE
raisingzcx_ibmc_service_exception
Delete Gateway. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_gateway
importingi_environment_idtype STRING
i_gateway_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY_DELETE
raisingzcx_ibmc_service_exception

Delete Gateway

+ Delete the specified gateway configuration.
Parameters
i_environment_id The ID of the environment. @@ -236,19 +474,27 @@ The requested gateway ID.
e_response Service return value of type T_GATEWAY_DELETE -
public instance
delete_stopword_list
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception
Delete a custom stopword list. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_stopword_list
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_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.
Parameters
i_environment_id The ID of the environment.
i_collection_id The ID of the collection. -
public instance
delete_tokenization_dictionary
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception
Delete tokenization dictionary. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_tokenization_dictionary
importingi_environment_idtype STRING
i_collection_idtype STRING
raisingzcx_ibmc_service_exception

Delete tokenization dictionary

+ Delete the tokenization dictionary from the collection.
Parameters
i_environment_id The ID of the environment.
i_collection_id The ID of the collection. -
public instance
delete_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
raisingzcx_ibmc_service_exception
Delete a training data query. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
raisingzcx_ibmc_service_exception

Delete a training data query

+ Removes the training data query and all associated examples from the training + data set.
Parameters
i_environment_id The ID of the environment. @@ -256,7 +502,9 @@ The ID of the collection.
i_query_id The ID of the query used for training. -
public instance
delete_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_example_idtype STRING
raisingzcx_ibmc_service_exception
Delete example for training data query. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_example_idtype STRING
raisingzcx_ibmc_service_exception

Delete example for training data query

+ Deletes the example document with the given ID from the training data query.
Parameters
i_environment_id The ID of the environment. @@ -266,11 +514,25 @@ The ID of the query used for training.
i_example_id The ID of the document as it is indexed. -
public instance
delete_user_data
importingi_customer_idtype STRING
raisingzcx_ibmc_service_exception
Delete labeled data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_user_data
importingi_customer_idtype STRING
raisingzcx_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.
+
+ You associate a customer ID with data by passing the **X-Watson-Metadata** + header with a request that passes data. For more information about personal + data and customer IDs, see [Information + security](https://cloud.ibm.com/docs/services/discovery?topic=discovery-informa + tion-security#information-security).
Parameters
i_customer_id The customer ID for which all data is to be deleted. -
public instance
federated_query
importingi_environment_idtype STRING
i_query_longtype T_FED_QUERY_LARGE
i_x_watson_logging_opt_outtype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_RESPONSE
raisingzcx_ibmc_service_exception
Query multiple collections. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
federated_query
importingi_environment_idtype STRING
i_query_longtype T_FED_QUERY_LARGE
i_x_watson_logging_opt_outtype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_RESPONSE
raisingzcx_ibmc_service_exception

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/services/discovery?topic=discovery-qu + ery-concepts#query-concepts).
Parameters
i_environment_id The ID of the environment. @@ -280,16 +542,22 @@ If `true`, queries are not stored in the Discovery **Logs** endpoint.
e_response Service return value of type T_QUERY_RESPONSE -
public instance
federated_query_notices
importingi_environment_idtype STRING
i_collection_idstype TT_STRING
i_filtertype STRING optional
i_querytype STRING optional
i_natural_language_querytype STRING optional
i_aggregationtype STRING optional
i_counttype INTEGER optional
i_returntype TT_STRING optional
i_offsettype INTEGER optional
i_sorttype TT_STRING optional
i_highlighttype BOOLEAN default C_BOOLEAN_FALSE
i_deduplicate_fieldtype STRING optional
i_similartype BOOLEAN default C_BOOLEAN_FALSE
i_similar_document_idstype TT_STRING optional
i_similar_fieldstype TT_STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_NOTICES_RESPONSE
raisingzcx_ibmc_service_exception
Query multiple collection system notices. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
federated_query_notices
importingi_environment_idtype STRING
i_collection_idstype TT_STRING
i_filtertype STRING optional
i_querytype STRING optional
i_natural_language_querytype STRING optional
i_aggregationtype STRING optional
i_counttype INTEGER optional
i_returntype TT_STRING optional
i_offsettype INTEGER optional
i_sorttype TT_STRING optional
i_highlighttype BOOLEAN default C_BOOLEAN_FALSE
i_deduplicate_fieldtype STRING optional
i_similartype BOOLEAN default C_BOOLEAN_FALSE
i_similar_document_idstype TT_STRING optional
i_similar_fieldstype TT_STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_NOTICES_RESPONSE
raisingzcx_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/services/discovery?topic=discovery-qu + ery-concepts#query-concepts) for more details on the query language.
Parameters
i_environment_id The ID of the environment.
i_collection_ids A comma-separated list of collection IDs to be queried against.
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. + 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.
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. @@ -340,7 +608,11 @@ comparison.
e_response Service return value of type T_QUERY_NOTICES_RESPONSE -
public instanceget_appname redefinition public instance
get_autocompletion
importingi_environment_idtype STRING
i_collection_idtype STRING
i_prefixtype STRING
i_fieldtype STRING optional
i_counttype INTEGER optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COMPLETIONS
raisingzcx_ibmc_service_exception
Get Autocomplete Suggestions. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_autocompletion
importingi_environment_idtype STRING
i_collection_idtype STRING
i_prefixtype STRING
i_fieldtype STRING optional
i_counttype INTEGER optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COMPLETIONS
raisingzcx_ibmc_service_exception

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.
Parameters
i_environment_id The ID of the environment. @@ -357,7 +629,8 @@ The number of autocompletion suggestions to return.
e_response Service return value of type T_COMPLETIONS -
public instance
get_collection
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
Get collection details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_collection
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception

Get collection details

Parameters
i_environment_id The ID of the environment. @@ -365,7 +638,8 @@ The ID of the collection.
e_response Service return value of type T_COLLECTION -
public instance
get_configuration
importingi_environment_idtype STRING
i_configuration_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CONFIGURATION
raisingzcx_ibmc_service_exception
Get configuration details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_configuration
importingi_environment_idtype STRING
i_configuration_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CONFIGURATION
raisingzcx_ibmc_service_exception

Get configuration details

Parameters
i_environment_id The ID of the environment. @@ -373,7 +647,12 @@ The ID of the configuration.
e_response Service return value of type T_CONFIGURATION -
public instance
get_credentials
importingi_environment_idtype STRING
i_credential_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS
raisingzcx_ibmc_service_exception
View Credentials. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_credentials
importingi_environment_idtype STRING
i_credential_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS
raisingzcx_ibmc_service_exception

View Credentials

+ Returns details about the specified credentials.
+
+ **Note:** Secure credential information such as a password or SSH key is never + returned and must be obtained from the source system.
Parameters
i_environment_id The ID of the environment. @@ -381,7 +660,13 @@ The unique identifier for a set of source credentials.
e_response Service return value of type T_CREDENTIALS -
public instance
get_document_status
importingi_environment_idtype STRING
i_collection_idtype STRING
i_document_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_STATUS
raisingzcx_ibmc_service_exception
Get document details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_document_status
importingi_environment_idtype STRING
i_collection_idtype STRING
i_document_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_STATUS
raisingzcx_ibmc_service_exception

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.
Parameters
i_environment_id The ID of the environment. @@ -391,13 +676,16 @@ The ID of the document.
e_response Service return value of type T_DOCUMENT_STATUS -
public instance
get_environment
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENVIRONMENT
raisingzcx_ibmc_service_exception
Get environment info. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_environment
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENVIRONMENT
raisingzcx_ibmc_service_exception

Get environment info

Parameters
i_environment_id The ID of the environment.
e_response Service return value of type T_ENVIRONMENT -
public instance
get_gateway
importingi_environment_idtype STRING
i_gateway_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY
raisingzcx_ibmc_service_exception
List Gateway Details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_gateway
importingi_environment_idtype STRING
i_gateway_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY
raisingzcx_ibmc_service_exception

List Gateway Details

+ List information about the specified gateway.
Parameters
i_environment_id The ID of the environment. @@ -405,7 +693,12 @@ The requested gateway ID.
e_response Service return value of type T_GATEWAY -
public instance
get_metrics_event_rate
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_ibmc_service_exception
Percentage of queries with an associated event. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_metrics_event_rate
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_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.
Parameters
i_start_time Metric is computed from data recorded after this timestamp; must be in @@ -417,7 +710,10 @@ The type of result to consider when calculating the metric.
e_response Service return value of type T_METRIC_RESPONSE -
public instance
get_metrics_query
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_ibmc_service_exception
Number of queries over time. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_metrics_query
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_ibmc_service_exception

Number of queries over time

+ Total number of queries using the **natural_language_query** parameter over a + specific time window.
Parameters
i_start_time Metric is computed from data recorded after this timestamp; must be in @@ -429,7 +725,12 @@ The type of result to consider when calculating the metric.
e_response Service return value of type T_METRIC_RESPONSE -
public instance
get_metrics_query_event
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_ibmc_service_exception
Number of queries with an event over time. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_metrics_query_event
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_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.
Parameters
i_start_time Metric is computed from data recorded after this timestamp; must be in @@ -441,7 +742,10 @@ The type of result to consider when calculating the metric.
e_response Service return value of type T_METRIC_RESPONSE -
public instance
get_metrics_query_no_results
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_ibmc_service_exception
Number of queries with no search results over time. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_metrics_query_no_results
importingi_start_timetype DATETIME optional
i_end_timetype DATETIME optional
i_result_typetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_RESPONSE
raisingzcx_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.
Parameters
i_start_time Metric is computed from data recorded after this timestamp; must be in @@ -453,14 +757,21 @@ The type of result to consider when calculating the metric.
e_response Service return value of type T_METRIC_RESPONSE -
public instance
get_metrics_query_token_event
importingi_counttype INTEGER optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_TOKEN_RESPONSE
raisingzcx_ibmc_service_exception
Most frequent query tokens with an event. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_metrics_query_token_event
importingi_counttype INTEGER optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_METRIC_TOKEN_RESPONSE
raisingzcx_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.
Parameters
i_count Number of results to return. The maximum for the **count** and **offset** values together in any one query is **10000**.
e_response Service return value of type T_METRIC_TOKEN_RESPONSE -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_stopword_list_status
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception
Get stopword list status. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_stopword_list_status
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception

Get stopword list status

+ Returns the current status of the stopword list for the specified collection.
Parameters
i_environment_id The ID of the environment. @@ -468,7 +779,10 @@ The ID of the collection.
e_response Service return value of type T_TOKEN_DICT_STATUS_RESPONSE -
public instance
get_tokenization_dict_status
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception
Get tokenization dictionary status. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_tokenization_dict_status
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TOKEN_DICT_STATUS_RESPONSE
raisingzcx_ibmc_service_exception

Get tokenization dictionary status

+ Returns the current status of the tokenization dictionary for the specified + collection.
Parameters
i_environment_id The ID of the environment. @@ -476,7 +790,10 @@ The ID of the collection.
e_response Service return value of type T_TOKEN_DICT_STATUS_RESPONSE -
public instance
get_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_QUERY
raisingzcx_ibmc_service_exception
Get details about a query. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_QUERY
raisingzcx_ibmc_service_exception

Get details about a query

+ Gets details for a specific training data query, including the query string and + all examples.
Parameters
i_environment_id The ID of the environment. @@ -486,7 +803,9 @@ The ID of the query used for training.
e_response Service return value of type T_TRAINING_QUERY -
public instance
get_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_example_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE
raisingzcx_ibmc_service_exception
Get details for training data example. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_example_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE
raisingzcx_ibmc_service_exception

Get details for training data example

+ Gets the details for this training example.
Parameters
i_environment_id The ID of the environment. @@ -498,7 +817,9 @@ The ID of the document as it is indexed.
e_response Service return value of type T_TRAINING_EXAMPLE -
public instance
list_collections
importingi_environment_idtype STRING
i_nametype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_COLLECTIONS_RESPONSE
raisingzcx_ibmc_service_exception
List collections. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_collections
importingi_environment_idtype STRING
i_nametype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_COLLECTIONS_RESPONSE
raisingzcx_ibmc_service_exception

List collections

+ Lists existing collections for the service instance.
Parameters
i_environment_id The ID of the environment. @@ -506,7 +827,9 @@ Find collections with the given name.
e_response Service return value of type T_LIST_COLLECTIONS_RESPONSE -
public instance
list_collection_fields
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LST_COLLECTION_FIELDS_RESP
raisingzcx_ibmc_service_exception
List collection fields. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_collection_fields
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LST_COLLECTION_FIELDS_RESP
raisingzcx_ibmc_service_exception

List collection fields

+ Gets a list of the unique fields (and their types) stored in the index.
Parameters
i_environment_id The ID of the environment. @@ -514,7 +837,9 @@ The ID of the collection.
e_response Service return value of type T_LST_COLLECTION_FIELDS_RESP -
public instance
list_configurations
importingi_environment_idtype STRING
i_nametype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_CONFIGURATIONS_RESPONSE
raisingzcx_ibmc_service_exception
List configurations. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_configurations
importingi_environment_idtype STRING
i_nametype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_CONFIGURATIONS_RESPONSE
raisingzcx_ibmc_service_exception

List configurations

+ Lists existing configurations for the service instance.
Parameters
i_environment_id The ID of the environment. @@ -522,19 +847,30 @@ Find configurations with the given name.
e_response Service return value of type T_LIST_CONFIGURATIONS_RESPONSE -
public instance
list_credentials
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS_LIST
raisingzcx_ibmc_service_exception
List credentials. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_credentials
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS_LIST
raisingzcx_ibmc_service_exception

List credentials

+ List all the source credentials that have been created for this service + instance.
+
+ **Note:** All credentials are sent over an encrypted connection and encrypted + at rest.
Parameters
i_environment_id The ID of the environment.
e_response Service return value of type T_CREDENTIALS_LIST -
public instance
list_environments
importingi_nametype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_ENVIRONMENTS_RESPONSE
raisingzcx_ibmc_service_exception
List environments. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_environments
importingi_nametype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_ENVIRONMENTS_RESPONSE
raisingzcx_ibmc_service_exception

List environments

+ List existing environments for the service instance.
Parameters
i_name Show only the environment with the given name.
e_response Service return value of type T_LIST_ENVIRONMENTS_RESPONSE -
public instance
list_expansions
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXPANSIONS
raisingzcx_ibmc_service_exception
Get the expansion list. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_expansions
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_EXPANSIONS
raisingzcx_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.
Parameters
i_environment_id The ID of the environment. @@ -542,7 +878,10 @@ The ID of the collection.
e_response Service return value of type T_EXPANSIONS -
public instance
list_fields
importingi_environment_idtype STRING
i_collection_idstype TT_STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LST_COLLECTION_FIELDS_RESP
raisingzcx_ibmc_service_exception
List fields across collections. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_fields
importingi_environment_idtype STRING
i_collection_idstype TT_STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LST_COLLECTION_FIELDS_RESP
raisingzcx_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.
Parameters
i_environment_id The ID of the environment. @@ -550,13 +889,17 @@ A comma-separated list of collection IDs to be queried against.
e_response Service return value of type T_LST_COLLECTION_FIELDS_RESP -
public instance
list_gateways
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY_LIST
raisingzcx_ibmc_service_exception
List Gateways. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_gateways
importingi_environment_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GATEWAY_LIST
raisingzcx_ibmc_service_exception

List Gateways

+ List the currently configured gateways.
Parameters
i_environment_id The ID of the environment.
e_response Service return value of type T_GATEWAY_LIST -
public instance
list_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_DATA_SET
raisingzcx_ibmc_service_exception
List training data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_training_data
importingi_environment_idtype STRING
i_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_DATA_SET
raisingzcx_ibmc_service_exception

List training data

+ Lists the training data for the specified collection.
Parameters
i_environment_id The ID of the environment. @@ -564,7 +907,9 @@ The ID of the collection.
e_response Service return value of type T_TRAINING_DATA_SET -
public instance
list_training_examples
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE_LIST
raisingzcx_ibmc_service_exception
List examples for a training data query. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_training_examples
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE_LIST
raisingzcx_ibmc_service_exception

List examples for a training data query

+ List all examples for this training data query.
Parameters
i_environment_id The ID of the environment. @@ -574,7 +919,12 @@ The ID of the query used for training.
e_response Service return value of type T_TRAINING_EXAMPLE_LIST -
public instance
query
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_longtype T_COLL_QUERY_LARGE optional
i_x_watson_logging_opt_outtype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_RESPONSE
raisingzcx_ibmc_service_exception
Query a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
query
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_longtype T_COLL_QUERY_LARGE optional
i_x_watson_logging_opt_outtype BOOLEAN default C_BOOLEAN_FALSE
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_RESPONSE
raisingzcx_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/services/discovery?topic=discovery-qu + ery-concepts#query-concepts).
Parameters
i_environment_id The ID of the environment. @@ -586,12 +936,16 @@ If `true`, queries are not stored in the Discovery **Logs** endpoint.
e_response Service return value of type T_QUERY_RESPONSE -
public instance
query_log
importingi_filtertype STRING optional
i_querytype STRING optional
i_counttype INTEGER optional
i_offsettype INTEGER optional
i_sorttype TT_STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LOG_QUERY_RESPONSE
raisingzcx_ibmc_service_exception
Search the query and event log. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
query_log
importingi_filtertype STRING optional
i_querytype STRING optional
i_counttype INTEGER optional
i_offsettype INTEGER optional
i_sorttype TT_STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LOG_QUERY_RESPONSE
raisingzcx_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.
Parameters
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. + 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.
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. @@ -610,16 +964,22 @@ specified.
e_response Service return value of type T_LOG_QUERY_RESPONSE -
public instance
query_notices
importingi_environment_idtype STRING
i_collection_idtype STRING
i_filtertype STRING optional
i_querytype STRING optional
i_natural_language_querytype STRING optional
i_passagestype BOOLEAN optional
i_aggregationtype STRING optional
i_counttype INTEGER optional
i_returntype TT_STRING optional
i_offsettype INTEGER optional
i_sorttype TT_STRING optional
i_highlighttype BOOLEAN default C_BOOLEAN_FALSE
i_passages_fieldstype TT_STRING optional
i_passages_counttype INTEGER optional
i_passages_characterstype INTEGER optional
i_deduplicate_fieldtype STRING optional
i_similartype BOOLEAN default C_BOOLEAN_FALSE
i_similar_document_idstype TT_STRING optional
i_similar_fieldstype TT_STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_NOTICES_RESPONSE
raisingzcx_ibmc_service_exception
Query system notices. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
query_notices
importingi_environment_idtype STRING
i_collection_idtype STRING
i_filtertype STRING optional
i_querytype STRING optional
i_natural_language_querytype STRING optional
i_passagestype BOOLEAN optional
i_aggregationtype STRING optional
i_counttype INTEGER optional
i_returntype TT_STRING optional
i_offsettype INTEGER optional
i_sorttype TT_STRING optional
i_highlighttype BOOLEAN default C_BOOLEAN_FALSE
i_passages_fieldstype TT_STRING optional
i_passages_counttype INTEGER optional
i_passages_characterstype INTEGER optional
i_deduplicate_fieldtype STRING optional
i_similartype BOOLEAN default C_BOOLEAN_FALSE
i_similar_document_idstype TT_STRING optional
i_similar_fieldstype TT_STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_QUERY_NOTICES_RESPONSE
raisingzcx_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/services/discovery?topic=discovery-qu + ery-concepts#query-concepts) for more details on the query language.
Parameters
i_environment_id The ID of the environment.
i_collection_id The ID of the collection.
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. + 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.
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. @@ -680,7 +1040,8 @@ comparison.
e_response Service return value of type T_QUERY_NOTICES_RESPONSE -
public instance
update_collection
importingi_environment_idtype STRING
i_collection_idtype STRING
i_bodytype T_UPDATE_COLLECTION_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
Update a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_collection
importingi_environment_idtype STRING
i_collection_idtype STRING
i_bodytype T_UPDATE_COLLECTION_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception

Update a collection

Parameters
i_environment_id The ID of the environment. @@ -690,7 +1051,17 @@ Input an object that allows you to update a collection.
e_response Service return value of type T_COLLECTION -
public instance
update_configuration
importingi_environment_idtype STRING
i_configuration_idtype STRING
i_configurationtype T_CONFIGURATION
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CONFIGURATION
raisingzcx_ibmc_service_exception
Update a configuration. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_configuration
importingi_environment_idtype STRING
i_configuration_idtype STRING
i_configurationtype T_CONFIGURATION
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CONFIGURATION
raisingzcx_ibmc_service_exception

Update a configuration

+ Replaces an existing configuration.
+ * Completely replaces the original configuration.
+ * The **configuration_id**, **updated**, and **created** fields are accepted + in the request, but they are ignored, and an error is not generated. It is also + acceptable for users to submit an updated configuration with none of the three + properties.
+ * Documents are processed with a snapshot of the configuration as it was at + the time the document was submitted to be ingested. This means that already + submitted documents will not see any updates made to the configuration.
Parameters
i_environment_id The ID of the environment. @@ -715,7 +1086,12 @@ the configuration.
e_response Service return value of type T_CONFIGURATION -
public instance
update_credentials
importingi_environment_idtype STRING
i_credential_idtype STRING
i_credentials_parametertype T_CREDENTIALS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS
raisingzcx_ibmc_service_exception
Update credentials. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_credentials
importingi_environment_idtype STRING
i_credential_idtype STRING
i_credentials_parametertype T_CREDENTIALS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CREDENTIALS
raisingzcx_ibmc_service_exception

Update credentials

+ Updates an existing set of source credentials.
+
+ **Note:** All credentials are sent over an encrypted connection and encrypted at + rest.
Parameters
i_environment_id The ID of the environment. @@ -725,7 +1101,13 @@ An object that defines an individual set of source credentials.
e_response Service return value of type T_CREDENTIALS -
public instance
update_document
importingi_environment_idtype STRING
i_collection_idtype STRING
i_document_idtype STRING
i_filetype FILE optional
i_filenametype STRING optional
i_file_content_typetype STRING optional
i_metadatatype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_ACCEPTED
raisingzcx_ibmc_service_exception
Update a document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_document
importingi_environment_idtype STRING
i_collection_idtype STRING
i_document_idtype STRING
i_filetype FILE optional
i_filenametype STRING optional
i_file_content_typetype STRING optional
i_metadatatype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_ACCEPTED
raisingzcx_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.
+
+ **Note:** When uploading a new document with this method it automatically + replaces any document stored with the same **document_id** if it exists.
Parameters
i_environment_id The ID of the environment. @@ -745,20 +1127,26 @@
i_metadata The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example: ``` {
- "Creator": "Johnny Appleseed",
- "Subject": "Apples"
+ "Creator": "Johnny Appleseed",
+ "Subject": "Apples"
} ```.
e_response Service return value of type T_DOCUMENT_ACCEPTED -
public instance
update_environment
importingi_environment_idtype STRING
i_bodytype T_UPDATE_ENVIRONMENT_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENVIRONMENT
raisingzcx_ibmc_service_exception
Update an environment. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_environment
importingi_environment_idtype STRING
i_bodytype T_UPDATE_ENVIRONMENT_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ENVIRONMENT
raisingzcx_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.
Parameters
i_environment_id The ID of the environment.
i_body - An object that defines the environment's name and, optionally, description. + An object that defines the environment's name and, optionally, description. +
e_response Service return value of type T_ENVIRONMENT -
public instance
update_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_example_idtype STRING
i_bodytype T_TRAINING_EXAMPLE_PATCH
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE
raisingzcx_ibmc_service_exception
Change label or cross reference for example. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_training_example
importingi_environment_idtype STRING
i_collection_idtype STRING
i_query_idtype STRING
i_example_idtype STRING
i_bodytype T_TRAINING_EXAMPLE_PATCH
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EXAMPLE
raisingzcx_ibmc_service_exception

Change label or cross reference for example

+ Changes the label or cross reference query for this training data example.
Parameters
i_environment_id The ID of the environment. @@ -772,4 +1160,5 @@ The body of the example that is to be added to the specified query.
e_response Service return value of type T_TRAINING_EXAMPLE -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_lang_translator_v3.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_lang_translator_v3.html index 18f1016..89838b8 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_lang_translator_v3.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_lang_translator_v3.html @@ -1,12 +1,41 @@ -Class ZCL_IBMC_LANG_TRANSLATOR_V3

Class ZCL_IBMC_LANG_TRANSLATOR_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Language Translator

+Class ZCL_IBMC_LANG_TRANSLATOR_V3

Class ZCL_IBMC_LANG_TRANSLATOR_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Language Translator

IBM Watson™ Language Translator translates text from one language to another. The service offers multiple IBM provided translation models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, - communicate with your customers in their own language, and more.

Types

Visibility and LevelNameDocumentation
publict_base_model_id type STRING Model ID of the base model that was used to customize the model. If the model is - not a custom model, this will be absent or an empty string.
publict_delete_model_result (structured type) No documentation available.
publict_document_id type STRING System generated ID identifying a document being translated using one specific - translation model.
publict_document_list (structured type) No documentation available.
publict_document_status (structured type) Document information, including translation status.
publict_error_response (structured type) No documentation available.
publict_identifiable_language (structured type) No documentation available.
publict_identifiable_languages (structured type) No documentation available.
publict_identified_language (structured type) No documentation available.
publict_identified_languages (structured type) No documentation available.
publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_model_id type STRING A globally unique string that identifies the underlying model that is used for - translation.
publict_source type STRING Translation source language code.
publict_target type STRING Translation target language code.
publict_translate_request (structured type) No documentation available.
publict_translation (structured type) No documentation available.
publict_translation_model (structured type) Response payload for models.
publict_translation_models (structured type) The response type for listing existing translation models.
publict_translation_result (structured type) No documentation available.
publict_translation_status type STRING The status of the translation job associated with a submitted document.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
create_model
importingi_base_model_idtype STRING
i_forced_glossarytype FILE optional
i_parallel_corpustype FILE optional
i_nametype STRING optional
i_forced_glossary_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_parallel_corpus_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_MODEL
raisingzcx_ibmc_service_exception
 Create model. + communicate with your customers in their own language, and more.

Types

Visibility and LevelNameDocumentation
publict_base_model_id type STRING

+ Model ID of the base model that was used to customize the

+ model. If the model is not a custom model, this will be absent or an empty + string.
publict_delete_model_result (structured type) No documentation available.
publict_document_id type STRING

+ System generated ID identifying a document being translated

+ using one specific translation model.
publict_document_list (structured type) No documentation available.
publict_document_status (structured type)

+ Document information, including translation status.

publict_error_response (structured type) No documentation available.
publict_identifiable_language (structured type) No documentation available.
publict_identifiable_languages (structured type) No documentation available.
publict_identified_language (structured type) No documentation available.
publict_identified_languages (structured type) No documentation available.
publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_model_id type STRING

+ A globally unique string that identifies the underlying

+ model that is used for translation.
publict_source type STRING

+ Translation source language code.

publict_target type STRING

+ Translation target language code.

publict_translate_request (structured type) No documentation available.
publict_translation (structured type) No documentation available.
publict_translation_model (structured type)

+ Response payload for models.

publict_translation_models (structured type)

+ The response type for listing existing translation models.

publict_translation_result (structured type) No documentation available.
publict_translation_status type STRING

+ The status of the translation job associated with a

+ submitted document.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
create_model
importingi_base_model_idtype STRING
i_forced_glossarytype FILE optional
i_parallel_corpustype FILE optional
i_nametype STRING optional
i_forced_glossary_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_parallel_corpus_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_MODEL
raisingzcx_ibmc_service_exception

Create model

+ Uploads Translation Memory eXchange (TMX) files to customize a translation + model.
+
+ You can either customize a model with a forced glossary or with a corpus that + contains parallel sentences. To create a model that is customized with a + parallel corpus <b>and</b> a forced glossary, proceed in two steps: + customize with a parallel corpus first and then customize the resulting model + with a glossary. Depending on the type of customization and the size of the + uploaded corpora, training can range from minutes for a glossary to several + hours for a large parallel corpus. You can upload a single forced glossary file + and this file must be less than <b>10 MB</b>. You can upload + multiple parallel corpora tmx files. The cumulative file size of all uploaded + files is limited to <b>250 MB</b>. To successfully train with a + parallel corpus you must have at least <b>5,000 parallel + sentences</b> in your corpus.
+
+ You can have a <b>maximum of 10 custom models per language pair</b>. +
Parameters
i_base_model_id The model ID of the model to use as the base for customization. To see available @@ -30,29 +59,41 @@ length is 32 characters.
e_response Service return value of type T_TRANSLATION_MODEL -
public instance
delete_document
importingi_document_idtype STRING
raisingzcx_ibmc_service_exception
 Delete document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_document
importingi_document_idtype STRING
raisingzcx_ibmc_service_exception

Delete document

+ Deletes a document
Parameters
i_document_id Document ID of the document to delete. -
public instance
delete_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_MODEL_RESULT
raisingzcx_ibmc_service_exception
 Delete model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_MODEL_RESULT
raisingzcx_ibmc_service_exception

Delete model

+ Deletes a custom translation model.
Parameters
i_model_id Model ID of the model to delete.
e_response Service return value of type T_DELETE_MODEL_RESULT -
public instanceget_appname redefinition public instance
get_document_status
importingi_document_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_STATUS
raisingzcx_ibmc_service_exception
Get document status. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_document_status
importingi_document_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_STATUS
raisingzcx_ibmc_service_exception

Get document status

+ Gets the translation status of a document
Parameters
i_document_id The document ID of the document.
e_response Service return value of type T_DOCUMENT_STATUS -
public instance
get_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_MODEL
raisingzcx_ibmc_service_exception
Get model details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_MODEL
raisingzcx_ibmc_service_exception

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 will have a status of `available`.
Parameters
i_model_id Model ID of the model to get.
e_response Service return value of type T_TRANSLATION_MODEL -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_translated_document
importingi_document_idtype STRING
i_accepttype STRING optional
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception
Get translated document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_translated_document
importingi_document_idtype STRING
i_accepttype STRING optional
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception

Get translated document

+ Gets the translated document associated with the given document ID
Parameters
i_document_id The document ID of the document that was submitted for translation. @@ -69,45 +110,60 @@ application/vnd.oasis.opendocument.text, application/pdf, application/rtf, text/html, text/json, text/plain, text/richtext, text/rtf, or text/xml. A character encoding can be specified by including a `charset` parameter. For - example, 'text/html;charset=utf-8'. + example, 'text/html;charset=utf-8'.
e_response Service return value of type FILE -
public instance
identify
importingi_texttype STRING
i_contenttypetype STRING default 'text/plain'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IDENTIFIED_LANGUAGES
raisingzcx_ibmc_service_exception
Identify language. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
identify
importingi_texttype STRING
i_contenttypetype STRING default 'text/plain'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IDENTIFIED_LANGUAGES
raisingzcx_ibmc_service_exception

Identify language

+ Identifies the language of the input text.
Parameters
i_text Input text in UTF-8 format.
e_response Service return value of type T_IDENTIFIED_LANGUAGES -
public instance
list_documents
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_LIST
raisingzcx_ibmc_service_exception
List documents. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_documents
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_LIST
raisingzcx_ibmc_service_exception

List documents

+ Lists documents that have been submitted for translation
Parameters
e_response Service return value of type T_DOCUMENT_LIST -
public instance
list_identifiable_languages
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_IDENTIFIABLE_LANGUAGES
raisingzcx_ibmc_service_exception
List identifiable languages. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_identifiable_languages
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_IDENTIFIABLE_LANGUAGES
raisingzcx_ibmc_service_exception

List identifiable languages

+ Lists the languages that the service can identify. Returns the language code + (for example, `en` for English or `es` for Spanish) and name of each language.
Parameters
e_response Service return value of type T_IDENTIFIABLE_LANGUAGES -
public instance
list_models
importingi_sourcetype STRING optional
i_targettype STRING optional
i_defaulttype BOOLEAN optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_MODELS
raisingzcx_ibmc_service_exception
List models. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_models
importingi_sourcetype STRING optional
i_targettype STRING optional
i_defaulttype BOOLEAN optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_MODELS
raisingzcx_ibmc_service_exception

List models

+ Lists available translation models.
Parameters
i_source Specify a language code to filter results by source language.
i_target Specify a language code to filter results by target language.
i_default - If the default parameter isn't specified, the service will return all models - (default and non-default) for each language pair. To return only default + If the default parameter isn't specified, the service will return all + models (default and non-default) for each language pair. To return only default models, set this to `true`. To return only non-default models, set this to `false`. There is exactly one default model per language pair, the IBM provided base model.
e_response Service return value of type T_TRANSLATION_MODELS -
public instance
translate
importingi_requesttype T_TRANSLATE_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_RESULT
raisingzcx_ibmc_service_exception
Translate. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
translate
importingi_requesttype T_TRANSLATE_REQUEST
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION_RESULT
raisingzcx_ibmc_service_exception

Translate

+ Translates the input text from the source language to the target language.
Parameters
i_request The translate request containing the text, and either a model ID or source and target language pair.
e_response Service return value of type T_TRANSLATION_RESULT -
public instance
translate_document
importingi_filetype FILE
i_filenametype STRING
i_file_content_typetype STRING optional
i_model_idtype STRING optional
i_sourcetype STRING optional
i_targettype STRING optional
i_document_idtype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_STATUS
raisingzcx_ibmc_service_exception
Translate document. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
translate_document
importingi_filetype FILE
i_filenametype STRING
i_file_content_typetype STRING optional
i_model_idtype STRING optional
i_sourcetype STRING optional
i_targettype STRING optional
i_document_idtype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DOCUMENT_STATUS
raisingzcx_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 + document ID.
Parameters
i_file The contents of the source file to translate.
@@ -133,4 +189,5 @@ enter the `document_id` of the document.
e_response Service return value of type T_DOCUMENT_STATUS -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_class_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_class_v1.html index eaab147..0c66769 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_class_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_class_v1.html @@ -1,8 +1,20 @@ -Class ZCL_IBMC_NAT_LANG_CLASS_V1

Class ZCL_IBMC_NAT_LANG_CLASS_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Natural Language Classifier

+Class ZCL_IBMC_NAT_LANG_CLASS_V1

Class ZCL_IBMC_NAT_LANG_CLASS_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Natural 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.

Types

Visibility and LevelNameDocumentation
publict_classification (structured type) Response from the classifier for a phrase.
publict_classification_collection (structured type) Response from the classifier for multiple phrases.
publict_classified_class (structured type) Class and confidence.
publict_classifier (structured type) A classifier for natural language phrases.
publict_classifier_list (structured type) List of available classifiers.
publict_classify_collection_input (structured type) Request payload to classify.
publict_classify_input (structured type) Request payload to classify.
publict_collection_item (structured type) Response from the classifier for a phrase in a collection.
publict_empty type JSONOBJECT No documentation available.
publict_error_cloud (structured type) Response payload for Cloud errors.
publict_error_response (structured type) Response payload for HTTP errors.
publict_inline_object (structured type) No documentation available.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
classify
importingi_classifier_idtype STRING
i_bodytype T_CLASSIFY_INPUT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFICATION
raisingzcx_ibmc_service_exception
 Classify a phrase. + the service can apply those classes to new inputs.

Types

Visibility and LevelNameDocumentation
publict_classification (structured type)

+ Response from the classifier for a phrase.

publict_classification_collection (structured type)

+ Response from the classifier for multiple phrases.

publict_classified_class (structured type)

+ Class and confidence.

publict_classifier (structured type)

+ A classifier for natural language phrases.

publict_classifier_list (structured type)

+ List of available classifiers.

publict_classify_collection_input (structured type)

+ Request payload to classify.

publict_classify_input (structured type)

+ Request payload to classify.

publict_collection_item (structured type)

+ Response from the classifier for a phrase in a collection.

publict_empty type JSONOBJECT No documentation available.
publict_error_cloud (structured type)

+ Response payload for Cloud errors.

publict_error_response (structured type)

+ Response payload for HTTP errors.

publict_inline_object (structured type) No documentation available.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
classify
importingi_classifier_idtype STRING
i_bodytype T_CLASSIFY_INPUT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFICATION
raisingzcx_ibmc_service_exception

Classify a phrase

+ Returns label information for the input. The status must be `Available` before + you can use the classifier to classify text.
Parameters
i_classifier_id Classifier ID to use. @@ -10,7 +22,12 @@ Phrase to classify.
e_response Service return value of type T_CLASSIFICATION -
public instance
classify_collection
importingi_classifier_idtype STRING
i_bodytype T_CLASSIFY_COLLECTION_INPUT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFICATION_COLLECTION
raisingzcx_ibmc_service_exception
 Classify multiple phrases. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
classify_collection
importingi_classifier_idtype STRING
i_bodytype T_CLASSIFY_COLLECTION_INPUT
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFICATION_COLLECTION
raisingzcx_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.
+
+ Note that classifying Japanese texts is a beta feature.
Parameters
i_classifier_id Classifier ID to use. @@ -18,7 +35,10 @@ Phrase to classify. You can submit up to 30 text phrases in a request.
e_response Service return value of type T_CLASSIFICATION_COLLECTION -
public instance
create_classifier
importingi_training_metadatatype FILE
i_training_datatype FILE
i_training_metadata_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_training_data_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception
 Create classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_classifier
importingi_training_metadatatype FILE
i_training_datatype FILE
i_training_metadata_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_training_data_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception

Create classifier

+ Sends data to create and train a classifier and returns information about the + new classifier.
Parameters
i_training_metadata Metadata in JSON format. The metadata identifies the language of the data, and @@ -35,18 +55,24 @@ al-language-classifier-using-your-data).
e_response Service return value of type T_CLASSIFIER -
public instance
delete_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete classifier

Parameters
i_classifier_id Classifier ID to delete. -
public instanceget_appname redefinition public instance
get_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception
Get information about a classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception

Get information about a classifier

+ Returns status and other information about a classifier.
Parameters
i_classifier_id Classifier ID to query.
e_response Service return value of type T_CLASSIFIER -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_classifiers
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER_LIST
raisingzcx_ibmc_service_exception
List classifiers. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_classifiers
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER_LIST
raisingzcx_ibmc_service_exception

List classifiers

+ Returns an empty array if no classifiers are available.
Parameters
e_response Service return value of type T_CLASSIFIER_LIST -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_undrstnd_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_undrstnd_v1.html index 2fb60dd..79f493f 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_undrstnd_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_nat_lang_undrstnd_v1.html @@ -1,4 +1,4 @@ -Class ZCL_IBMC_NAT_LANG_UNDRSTND_V1

Class ZCL_IBMC_NAT_LANG_UNDRSTND_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Natural Language Understanding

+Class ZCL_IBMC_NAT_LANG_UNDRSTND_V1

Class ZCL_IBMC_NAT_LANG_UNDRSTND_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Natural Language Understanding

Analyze various features of text content at scale. Provide text, raw HTML, or a public URL and IBM Watson Natural Language Understanding will give you results for the features you request. The service cleans HTML content before analysis @@ -8,66 +8,142 @@ You can create [custom models](https://cloud.ibm.com/docs/services/natural-language-understanding?topi c=natural-language-understanding-customizing) with Watson Knowledge Studio to - detect custom entities and relations in Natural Language Understanding.

Types

Visibility and LevelNameDocumentation
publict_analysis_results (structured type) Results of the analysis, organized by feature.
publict_analysis_results_metadata (structured type) Webpage metadata, such as the author and the title of the page.
publict_analysis_results_usage (structured type) API usage information for the request.
publict_author (structured type) The author of the analyzed content.
publict_categories_options (structured type) Returns a five-level taxonomy of the content. The top three categories are - returned.
+ detect custom entities and relations in Natural Language Understanding.

Types

Visibility and LevelNameDocumentation
publict_analysis_results (structured type)

+ Results of the analysis, organized by feature.

publict_analysis_results_metadata (structured type)

+ Webpage metadata, such as the author and the title of the

+ page.
publict_analysis_results_usage (structured type)

+ API usage information for the request.

publict_author (structured type)

+ The author of the analyzed content.

publict_categories_options (structured type)

+ Returns a five-level taxonomy of the content. The top three

+ categories are returned.
+
+ Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, + Portuguese, Spanish.
publict_categories_relevant_text (structured type)

+ Relevant text that contributed to the categorization.

publict_categories_result (structured type)

+ A categorization of the analyzed text.

publict_concepts_options (structured type)

+ 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.
+
+ Supported languages: English, French, German, Italian, Japanese, Korean, + Portuguese, Spanish.
publict_concepts_result (structured type)

+ The general concepts referenced or alluded to in the

+ analyzed text.
publict_ctgrs_result_explanation (structured type)

+ Information that helps to explain what contributed to the

+ categories result.
publict_dbpedia_resource type STRING

+ Link to the corresponding DBpedia resource.

publict_delete_model_results (structured type)

+ Delete model results.

publict_disambiguation_result (structured type)

+ Disambiguation information for the entity.

publict_document_emotion_results (structured type)

+ Emotion results for the document as a whole.

publict_document_sentiment_results (structured type) No documentation available.
publict_emotion_options (structured type)

+ Detects anger, disgust, fear, joy, or sadness that is

+ conveyed in the content or by the context around target phrases specified in + the targets parameter. You can analyze emotion for detected entities with + `entities.emotion` and for keywords with `keywords.emotion`.
+
+ Supported languages: English.
publict_emotion_result (structured type)

+ The detected anger, disgust, fear, joy, or sadness that is

+ conveyed by the content. Emotion information can be returned for detected + entities, keywords, or user-specified target phrases found in the text.
publict_emotion_scores (structured type) No documentation available.
publict_entities_options (structured type)

+ Identifies people, cities, organizations, and other entities

+ in the content. See [Entity types and + subtypes](https://cloud.ibm.com/docs/services/natural-language-understanding?to + pic=natural-language-understanding-entity-types).
+
+ Supported languages: English, French, German, Italian, Japanese, Korean, + Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported + only through custom models.
publict_entities_result (structured type)

+ The important people, places, geopolitical entities and

+ other types of entities in your content.
publict_entity_mention (structured type) No documentation available.
publict_error_response (structured type) No documentation available.
publict_features (structured type)

+ Analysis features and options.

publict_features_results (structured type)

+ Analysis results for each requested feature.

publict_features_results_metadata (structured type)

+ Webpage metadata, such as the author and the title of the

+ page.
publict_feature_sentiment_results (structured type) No documentation available.
publict_feed (structured type)

+ RSS or ATOM feed found on the webpage.

publict_keywords_options (structured type)

+ Returns important keywords in the content.


+
+ Supported languages: English, French, German, Italian, Japanese, Korean, + Portuguese, Russian, Spanish, Swedish.
publict_keywords_result (structured type)

+ The important keywords in the content, organized by

+ relevance.
publict_list_models_results (structured type)

+ Custom models that are available for entities and relations.

publict_metadata_options type JSONOBJECT

+ Returns information from the document, including author

+ name, title, RSS/ATOM feeds, prominent page image, and publication date. + Supports URL and HTML input types only.
publict_metadata_result (structured type)

+ The authors, publication date, title, prominent page image,

+ and RSS/ATOM feeds of the webpage. Supports URL and HTML input types.
publict_model (structured type) No documentation available.
publict_model_file_and_metadata (structured type)

+ Metadata associated with this custom model.

publict_model_metadata (structured type)

+ Metadata associated with this custom model.

publict_parameters (structured type)

+ An object containing request parameters.

publict_relations_options (structured type)

+ Recognizes when two entities are related and identifies the

+ type of relation. For example, an `awardedTo` relation might connect the + entities "Nobel Prize" and "Albert Einstein". See [Relation + types](https://cloud.ibm.com/docs/services/natural-language-understanding?topic + =natural-language-understanding-relations).
+
+ Supported languages: Arabic, English, German, Japanese, Korean, Spanish. + Chinese, Dutch, French, Italian, and Portuguese custom models are also + supported.
publict_relations_result (structured type)

+ The relations between entities found in the content.

publict_relation_argument (structured type) No documentation available.
publict_relation_entity (structured type)

+ An entity that corresponds with an argument in a relation.

publict_semantic_roles_action (structured type) No documentation available.
publict_semantic_roles_entity (structured type) No documentation available.
publict_semantic_roles_keyword (structured type) No documentation available.
publict_semantic_roles_object (structured type) No documentation available.
publict_semantic_roles_options (structured type)

+ Parses sentences into subject, action, and object form.


+
+ Supported languages: English, German, Japanese, Korean, Spanish.
publict_semantic_roles_result (structured type)

+ The object containing the actions and the objects the

+ actions act upon.
publict_semantic_roles_result_action (structured type)

+ The extracted action from the sentence.

publict_semantic_roles_result_object (structured type)

+ The extracted object from the sentence.

publict_semantic_roles_subject (structured type) No documentation available.
publict_semantic_roles_verb (structured type) No documentation available.
publict_sentence_result (structured type) No documentation available.
publict_sentiment_options (structured type)

+ Analyzes the general sentiment of your content or the

+ sentiment toward specific target phrases. You can analyze sentiment for + detected entities with `entities.sentiment` and for keywords with + `keywords.sentiment`.
+
+ Supported languages: Arabic, English, French, German, Italian, Japanese, + Korean, Portuguese, Russian, Spanish.
publict_sentiment_result (structured type)

+ The sentiment of the content.

publict_smntc_roles_result_subject (structured type)

+ The extracted subject from the sentence.

publict_syntax_options (structured type)

+ Returns tokens and sentences from the input text.

publict_syntax_options_tokens (structured type)

+ Tokenization options.

publict_syntax_result (structured type)

+ Tokens and sentences returned from syntax analysis.

publict_targeted_emotion_results (structured type)

+ Emotion results for a specified target.

publict_targeted_sentiment_results (structured type) No documentation available.
publict_token_result (structured type) No documentation available.
publict_usage (structured type)

+ Usage information.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
analyze
importingi_parameterstype T_PARAMETERS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ANALYSIS_RESULTS
raisingzcx_ibmc_service_exception

Analyze text

+ Analyzes text, HTML, or a public webpage for the following features:
+ - Categories
+ - Concepts
+ - Emotion
+ - Entities
+ - Keywords
+ - Metadata
+ - Relations
+ - Semantic roles
+ - Sentiment
+ - Syntax (Experimental).

- Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, - Portuguese, Spanish.
publict_categories_relevant_text (structured type) Relevant text that contributed to the categorization.
publict_categories_result (structured type) A categorization of the analyzed text.
publict_concepts_options (structured type) 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.
-
- Supported languages: English, French, German, Italian, Japanese, Korean, - Portuguese, Spanish.
publict_concepts_result (structured type) The general concepts referenced or alluded to in the analyzed text.
publict_ctgrs_result_explanation (structured type) Information that helps to explain what contributed to the categories result.
publict_dbpedia_resource type STRING Link to the corresponding DBpedia resource.
publict_delete_model_results (structured type) Delete model results.
publict_disambiguation_result (structured type) Disambiguation information for the entity.
publict_document_emotion_results (structured type) Emotion results for the document as a whole.
publict_document_sentiment_results (structured type) No documentation available.
publict_emotion_options (structured type) Detects anger, disgust, fear, joy, or sadness that is conveyed in the content or - by the context around target phrases specified in the targets parameter. You - can analyze emotion for detected entities with `entities.emotion` and for - keywords with `keywords.emotion`.
-
- Supported languages: English.
publict_emotion_result (structured type) The detected anger, disgust, fear, joy, or sadness that is conveyed by the - content. Emotion information can be returned for detected entities, keywords, - or user-specified target phrases found in the text.
publict_emotion_scores (structured type) No documentation available.
publict_entities_options (structured type) Identifies people, cities, organizations, and other entities in the content. See - [Entity types and - subtypes](https://cloud.ibm.com/docs/services/natural-language-understanding?to - pic=natural-language-understanding-entity-types).
-
- Supported languages: English, French, German, Italian, Japanese, Korean, - Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported - only through custom models.
publict_entities_result (structured type) The important people, places, geopolitical entities and other types of entities - in your content.
publict_entity_mention (structured type) No documentation available.
publict_error_response (structured type) No documentation available.
publict_features (structured type) Analysis features and options.
publict_features_results (structured type) Analysis results for each requested feature.
publict_features_results_metadata (structured type) Webpage metadata, such as the author and the title of the page.
publict_feature_sentiment_results (structured type) No documentation available.
publict_feed (structured type) RSS or ATOM feed found on the webpage.
publict_keywords_options (structured type) Returns important keywords in the content.
-
- Supported languages: English, French, German, Italian, Japanese, Korean, - Portuguese, Russian, Spanish, Swedish.
publict_keywords_result (structured type) The important keywords in the content, organized by relevance.
publict_list_models_results (structured type) Custom models that are available for entities and relations.
publict_metadata_options type JSONOBJECT Returns information from the document, including author name, title, RSS/ATOM - feeds, prominent page image, and publication date. Supports URL and HTML input - types only.
publict_metadata_result (structured type) The authors, publication date, title, prominent page image, and RSS/ATOM feeds - of the webpage. Supports URL and HTML input types.
publict_model (structured type) No documentation available.
publict_model_file_and_metadata (structured type) Metadata associated with this custom model.
publict_model_metadata (structured type) Metadata associated with this custom model.
publict_parameters (structured type) An object containing request parameters.
publict_relations_options (structured type) Recognizes when two entities are related and identifies the type of relation. - For example, an `awardedTo` relation might connect the entities "Nobel Prize" - and "Albert Einstein". See [Relation - types](https://cloud.ibm.com/docs/services/natural-language-understanding?topic - =natural-language-understanding-relations).
-
- Supported languages: Arabic, English, German, Japanese, Korean, Spanish. - Chinese, Dutch, French, Italian, and Portuguese custom models are also - supported.
publict_relations_result (structured type) The relations between entities found in the content.
publict_relation_argument (structured type) No documentation available.
publict_relation_entity (structured type) An entity that corresponds with an argument in a relation.
publict_semantic_roles_action (structured type) No documentation available.
publict_semantic_roles_entity (structured type) No documentation available.
publict_semantic_roles_keyword (structured type) No documentation available.
publict_semantic_roles_object (structured type) No documentation available.
publict_semantic_roles_options (structured type) Parses sentences into subject, action, and object form.
-
- Supported languages: English, German, Japanese, Korean, Spanish.
publict_semantic_roles_result (structured type) The object containing the actions and the objects the actions act upon.
publict_semantic_roles_result_action (structured type) The extracted action from the sentence.
publict_semantic_roles_result_object (structured type) The extracted object from the sentence.
publict_semantic_roles_subject (structured type) No documentation available.
publict_semantic_roles_verb (structured type) No documentation available.
publict_sentence_result (structured type) No documentation available.
publict_sentiment_options (structured type) Analyzes the general sentiment of your content or the sentiment toward specific - target phrases. You can analyze sentiment for detected entities with - `entities.sentiment` and for keywords with `keywords.sentiment`.
-
- Supported languages: Arabic, English, French, German, Italian, Japanese, - Korean, Portuguese, Russian, Spanish.
publict_sentiment_result (structured type) The sentiment of the content.
publict_smntc_roles_result_subject (structured type) The extracted subject from the sentence.
publict_syntax_options (structured type) Returns tokens and sentences from the input text.
publict_syntax_options_tokens (structured type) Tokenization options.
publict_syntax_result (structured type) Tokens and sentences returned from syntax analysis.
publict_targeted_emotion_results (structured type) Emotion results for a specified target.
publict_targeted_sentiment_results (structured type) No documentation available.
publict_token_result (structured type) No documentation available.
publict_usage (structured type) Usage information.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
analyze
importingi_parameterstype T_PARAMETERS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ANALYSIS_RESULTS
raisingzcx_ibmc_service_exception
 Analyze text. + If a language for the input text is not specified with the `language` parameter, + the service [automatically detects the + language](https://cloud.ibm.com/docs/services/natural-language-understanding?to + pic=natural-language-understanding-detectable-languages).
Parameters
i_parameters An object containing request parameters. The `features` object and one of the `text`, `html`, or `url` attributes are required.
e_response Service return value of type T_ANALYSIS_RESULTS -
public instance
delete_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_MODEL_RESULTS
raisingzcx_ibmc_service_exception
 Delete model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_DELETE_MODEL_RESULTS
raisingzcx_ibmc_service_exception

Delete model

+ Deletes a custom model
Parameters
i_model_id Model ID of the model to delete.
e_response Service return value of type T_DELETE_MODEL_RESULTS -
public instanceget_appname redefinition 
public instanceget_request_prop redefinition 
public instanceget_sdk_version_date redefinition 
public instance
list_models
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_MODELS_RESULTS
raisingzcx_ibmc_service_exception
 List models. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_models
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_LIST_MODELS_RESULTS
raisingzcx_ibmc_service_exception

List models

+ Lists Watson Knowledge Studio [custom entities and relations + models](https://cloud.ibm.com/docs/services/natural-language-understanding?topi + c=natural-language-understanding-customizing) that are deployed to your Natural + Language Understanding service.
Parameters
e_response Service return value of type T_LIST_MODELS_RESULTS -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_personal_insights_v3.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_personal_insights_v3.html index cc54ea7..7eb8ca8 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_personal_insights_v3.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_personal_insights_v3.html @@ -1,10 +1,10 @@ -Class ZCL_IBMC_PERSONAL_INSIGHTS_V3

Class ZCL_IBMC_PERSONAL_INSIGHTS_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Personality Insights

+Class ZCL_IBMC_PERSONAL_INSIGHTS_V3

Class ZCL_IBMC_PERSONAL_INSIGHTS_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Personality Insights

The IBM Watson™ Personality Insights service enables applications to derive insights from social media, enterprise data, or other digital - communications. The service uses linguistic analytics to infer individuals' - intrinsic personality characteristics, including Big Five, Needs, and Values, - from digital communications such as email, text messages, tweets, and forum - posts.
+ communications. The service uses linguistic analytics to infer + individuals' intrinsic personality characteristics, including Big Five, + Needs, and Values, from digital communications such as email, text messages, + tweets, and forum posts.

The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The @@ -12,24 +12,83 @@ and, for JSON content that is timestamped, can report temporal behavior.
* For information about the meaning of the models that the service uses to describe personality characteristics, see [Personality - models](https://cloud.ibm.com/docs/services/personality-insights?topic=personal - ity-insights-models#models).
+ models](https://cloud.ibm.com/docs/personality-insights?topic=personality-insig + hts-models#models).
* For information about the meaning of the consumption preferences, see [Consumption - preferences](https://cloud.ibm.com/docs/services/personality-insights?topic=per - sonality-insights-preferences#preferences).
+ preferences](https://cloud.ibm.com/docs/personality-insights?topic=personality- + insights-preferences#preferences).

**Note:** Request logging is disabled for the Personality Insights service. Regardless of whether you set the `X-Watson-Learning-Opt-Out` request header, - the service does not log or retain data from requests and responses.

Types

Visibility and LevelNameDocumentation
publict_behavior (structured type) The temporal behavior for the input content.
publict_cnsmptn_preferences_category (structured type) The consumption preferences that the service inferred from the input content.
publict_consumption_preferences (structured type) A consumption preference that the service inferred from the input content.
publict_content (structured type) The full input content that the service is to analyze.
publict_content_item (structured type) An input content item that the service is to analyze.
publict_csv_file type STRING A CSV file that contains the results of the personality profile that the service - generated for the input content.
publict_error_model (structured type) The error response from a failed request.
publict_profile (structured type) The personality profile that the service generated for the input content.
publict_trait (structured type) The characteristics that the service inferred from the input content.
publict_warning (structured type) A warning message that is associated with the input content.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instanceget_appname redefinition 
public instanceget_request_prop redefinition 
public instanceget_sdk_version_date redefinition 
public instance
profile
importingi_contenttype T_CONTENT
i_content_typetype STRING default 'text/plain'
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_raw_scorestype BOOLEAN default C_BOOLEAN_FALSE
i_csv_headerstype BOOLEAN default C_BOOLEAN_FALSE
i_consumption_preferencestype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_PROFILE
raisingzcx_ibmc_service_exception
 Get profile. + the service does not log or retain data from requests and responses.

Types

Visibility and LevelNameDocumentation
publict_behavior (structured type)

+ The temporal behavior for the input content.

publict_cnsmptn_preferences_category (structured type)

+ The consumption preferences that the service inferred from

+ the input content.
publict_consumption_preferences (structured type)

+ A consumption preference that the service inferred from the

+ input content.
publict_content (structured type)

+ The full input content that the service is to analyze.

publict_content_item (structured type)

+ An input content item that the service is to analyze.

publict_csv_file type STRING

+ A CSV file that contains the results of the personality

+ profile that the service generated for the input content.
publict_error_model (structured type)

+ The error response from a failed request.

publict_profile (structured type)

+ The personality profile that the service generated for the

+ input content.
publict_trait (structured type)

+ The characteristics that the service inferred from the input

+ content.
publict_warning (structured type)

+ A warning message that is associated with the input content.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instanceget_appname redefinition 
public instanceget_request_prop redefinition 
public instanceget_sdk_version_date redefinition 
public instance
profile
importingi_contenttype T_CONTENT
i_content_typetype STRING default 'text/plain'
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_raw_scorestype BOOLEAN default C_BOOLEAN_FALSE
i_csv_headerstype BOOLEAN default C_BOOLEAN_FALSE
i_consumption_preferencestype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_PROFILE
raisingzcx_ibmc_service_exception

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.
+
+ **See also:**
+ * [Requesting a + profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-input#input)
+ * [Providing sufficient + input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + ts-input#sufficient)
+
+ ### Content types
+
+ You can provide input content as plain text (`text/plain`), HTML (`text/html`), + or JSON (`application/json`) by specifying the **Content-Type** parameter. The + default is `text/plain`.
+ * Per the JSON specification, the default character encoding for JSON content is + effectively always UTF-8.
+ * Per the HTTP specification, the default encoding for plain text and HTML is + ISO-8859-1 (effectively, the ASCII character set).
+
+ When specifying a content type of plain text or HTML, include the `charset` + parameter to indicate the character encoding of the input text; for example, + `Content-Type: text/plain;charset=utf-8`.
+
+ **See also:** [Specifying request and response + formats](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-input#formats)
+
+ ### Accept types
+
+ You must request a response as JSON (`application/json`) or comma-separated + values (`text/csv`) by specifying the **Accept** parameter. CSV output includes + a fixed number of columns. Set the **csv_headers** parameter to `true` to + request optional column headers for CSV output.
+
+ **See also:**
+ * [Understanding a JSON + profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-output#output)
+ * [Understanding a CSV + profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-outputCSV#outputCSV)
Parameters
i_content A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see [Providing sufficient - input](https://cloud.ibm.com/docs/services/personality-insights?topic=personali - ty-insights-input#sufficient). For JSON input, provide an object of type - `Content`. + input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + ts-input#sufficient). For JSON input, provide an object of type `Content`.
i_content_type The type of the input. For more information, see **Content types** in the method description. @@ -65,16 +124,60 @@ default, no consumption preferences are returned.
e_response Service return value of type T_PROFILE -
Class-based Exceptions
zcx_ibmc_service_exception - Exception being raised in case of an error. -
public instance
profile_as_csv
importingi_contenttype T_CONTENT
i_content_typetype STRING default 'text/plain'
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_raw_scorestype BOOLEAN default C_BOOLEAN_FALSE
i_csv_headerstype BOOLEAN default C_BOOLEAN_FALSE
i_consumption_preferencestype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'text/csv'
exportinge_responsetype STRING
raisingzcx_ibmc_service_exception
 Get profile as csv. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
profile_as_csv
importingi_contenttype T_CONTENT
i_content_typetype STRING default 'text/plain'
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_raw_scorestype BOOLEAN default C_BOOLEAN_FALSE
i_csv_headerstype BOOLEAN default C_BOOLEAN_FALSE
i_consumption_preferencestype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'text/csv'
exportinge_responsetype STRING
raisingzcx_ibmc_service_exception

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.
+
+ **See also:**
+ * [Requesting a + profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-input#input)
+ * [Providing sufficient + input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + ts-input#sufficient)
+
+ ### Content types
+
+ You can provide input content as plain text (`text/plain`), HTML (`text/html`), + or JSON (`application/json`) by specifying the **Content-Type** parameter. The + default is `text/plain`.
+ * Per the JSON specification, the default character encoding for JSON content is + effectively always UTF-8.
+ * Per the HTTP specification, the default encoding for plain text and HTML is + ISO-8859-1 (effectively, the ASCII character set).
+
+ When specifying a content type of plain text or HTML, include the `charset` + parameter to indicate the character encoding of the input text; for example, + `Content-Type: text/plain;charset=utf-8`.
+
+ **See also:** [Specifying request and response + formats](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-input#formats)
+
+ ### Accept types
+
+ You must request a response as JSON (`application/json`) or comma-separated + values (`text/csv`) by specifying the **Accept** parameter. CSV output includes + a fixed number of columns. Set the **csv_headers** parameter to `true` to + request optional column headers for CSV output.
+
+ **See also:**
+ * [Understanding a JSON + profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-output#output)
+ * [Understanding a CSV + profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + ghts-outputCSV#outputCSV)
Parameters
i_content A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see [Providing sufficient - input](https://cloud.ibm.com/docs/services/personality-insights?topic=personali - ty-insights-input#sufficient). For JSON input, provide an object of type - `Content`. + input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + ts-input#sufficient). For JSON input, provide an object of type `Content`.
i_content_type The type of the input. For more information, see **Content types** in the method description. @@ -111,4 +214,4 @@
e_response Service return value of type STRING
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service.html index 3cdd1d6..5fd606f 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service.html @@ -1,4 +1,4 @@ -Class ZCL_IBMC_SERVICE

Class ZCL_IBMC_SERVICE

public inheriting from ZCL_IBMC_SERVICE_ARCH create public

Documentation

ABAP SDK for IBM Watson - Service Class

Types

Visibility and LevelNameDocumentation
publicbinary type XSTRING 
publicboolean type ZIF_IBMC_SERVICE_ARCH~BOOLEAN 
publicchar type ZIF_IBMC_SERVICE_ARCH~CHAR 
publicdata_reference type ref to DATA 
publicdate type STRING 
publicdatetime (typing) 
publicdouble type F 
publicfieldname (typing) 
publicfile type XSTRING 
publicfloat type F 
publicinteger type I 
publicjsonobject type ref to DATA 
publiclong type INT8 
publicmap type ref to DATA 
publicnumber type F 
publicshort type INT2 
publictime type STRING 
publicts_file_with_metadata (structured type) 
publicts_form_part type ZIF_IBMC_SERVICE_ARCH~TS_FORM_PART 
publicts_map_file (structured type) 
publictt_boolean TYPE standard table of ZIF_IBMC_SERVICE_ARCH~BOOLEAN with non-unique default key 
publictt_char TYPE standard table of ZIF_IBMC_SERVICE_ARCH~CHAR with non-unique default key 
publictt_double TYPE standard table of DOUBLE with non-unique default key 
publictt_file TYPE standard table of FILE with non-unique default key 
publictt_file_with_metadata TYPE standard table of TS_FILE_WITH_METADATA with non-unique default key 
publictt_float TYPE standard table of FLOAT with non-unique default key 
publictt_form_part type ZIF_IBMC_SERVICE_ARCH~TT_FORM_PART 
publictt_integer TYPE standard table of INTEGER with non-unique default key 
publictt_long TYPE standard table of LONG with non-unique default key 
publictt_map_file TYPE standard table of TS_MAP_FILE with non-unique default key 
publictt_number TYPE standard table of NUMBER with non-unique default key 
publictt_short TYPE standard table of SHORT with non-unique default key 
publictt_string type ZIF_IBMC_SERVICE_ARCH~TT_STRING 

Constants

Visibility and LevelNameDocumentation
public staticc_blank type STRING value '&#§§#&__%$X' 
public staticc_boolean_false type BOOLEAN value SPACE 
public staticc_boolean_true type BOOLEAN value 'X' 
public staticc_datatype (structured type)  
public staticc_default type STRING value 'DEFAULT' 
public staticc_f_zero type F value '-2147481.648' 
public staticc_i8_zero type INT8 value -9223372036854775608 
public staticc_i_zero type I value -2147481648 
public staticc_msgid type SY-MSGID value 'ZIBMC' 
public staticc_subrc_unknown type SY-SUBRC value 999999 
public staticc_tribool_false type BOOLEAN value '-' 

Attributes

Visibility and LevelNameDocumentation
public instancep_debug_mode type CHAR value SPACE 
public instancep_request_prop_default type TS_REQUEST_PROP  
public instancep_version type STRING  

Methods

Visibility and LevelNameDocumentation
public static
abap_to_json
importingi_nametype STRING optional
i_valuetype ANY
i_dictionarytype ANY optional
i_required_fieldstype ANY optional
i_lower_casetype BOOLEAN default C_BOOLEAN_TRUE
returningvalue(e_json)type STRING
 Extracts a JSON string from an ABAP structure. +Class ZCL_IBMC_SERVICE

Class ZCL_IBMC_SERVICE

public inheriting from ZCL_IBMC_SERVICE_ARCH create public

Documentation

ABAP SDK for IBM Watson - Service Class

Types

Visibility and LevelNameDocumentation
publicbinary type XSTRING 
publicboolean type ZIF_IBMC_SERVICE_ARCH~BOOLEAN 
publicchar type ZIF_IBMC_SERVICE_ARCH~CHAR 
publicdata_reference type ref to DATA 
publicdate type STRING 
publicdatetime (typing)DateTime type, format 2018-10-23T15:18:18.914xxxZ
publicdouble type F 
publicfieldname (typing) 
publicfile type XSTRING 
publicfloat type F 
publicinteger type I 
publicjsonobject type ref to DATA 
publiclong type INT8 
publicmap type ref to DATA 
publicnumber type F 
publicshort type INT2 
publictime type STRING 
publicts_file_with_metadata (structured type) 
publicts_form_part type ZIF_IBMC_SERVICE_ARCH~TS_FORM_PART 
publicts_map_file (structured type) 
publictt_boolean TYPE standard table of ZIF_IBMC_SERVICE_ARCH~BOOLEAN with non-unique default key 
publictt_char TYPE standard table of ZIF_IBMC_SERVICE_ARCH~CHAR with non-unique default key 
publictt_double TYPE standard table of DOUBLE with non-unique default key 
publictt_file TYPE standard table of FILE with non-unique default key 
publictt_file_with_metadata TYPE standard table of TS_FILE_WITH_METADATA with non-unique default key 
publictt_float TYPE standard table of FLOAT with non-unique default key 
publictt_form_part type ZIF_IBMC_SERVICE_ARCH~TT_FORM_PART 
publictt_integer TYPE standard table of INTEGER with non-unique default key 
publictt_long TYPE standard table of LONG with non-unique default key 
publictt_map_file TYPE standard table of TS_MAP_FILE with non-unique default key 
publictt_number TYPE standard table of NUMBER with non-unique default key 
publictt_short TYPE standard table of SHORT with non-unique default key 
publictt_string type ZIF_IBMC_SERVICE_ARCH~TT_STRING 

Constants

Visibility and LevelNameDocumentation
public staticc_blank type STRING value '&#§§#&__%$X' 
public staticc_boolean_false type BOOLEAN value SPACE 
public staticc_boolean_true type BOOLEAN value 'X' 
public staticc_datatype (structured type)  
public staticc_default type STRING value 'DEFAULT' 
public staticc_f_zero type F value '-2147481.648' 
public staticc_i8_zero type INT8 value -9223372036854775608 
public staticc_i_zero type I value -2147481648 
public staticc_msgid type SY-MSGID value 'ZIBMC' 
public staticc_subrc_unknown type SY-SUBRC value 999999 
public staticc_tribool_false type BOOLEAN value '-' 

Attributes

Visibility and LevelNameDocumentation
public instancep_debug_mode type CHAR value SPACE 
public instancep_request_prop_default type TS_REQUEST_PROP  
public instancep_version type STRING  

Methods

Visibility and LevelNameDocumentation
public static
abap_to_json
importingi_nametype STRING optional
i_valuetype ANY
i_dictionarytype ANY optional
i_required_fieldstype ANY optional
i_lower_casetype BOOLEAN default C_BOOLEAN_TRUE
returningvalue(e_json)type STRING

Extracts a JSON string from an ABAP structure.

Parameters
i_name Name of component to be extracted.
i_value ABAP structure to be converted to JSON string. @@ -9,40 +9,41 @@ Otherwise it is omitted in JSON string.
i_lower_case If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case.
e_json JSON string. -
public static
add_header_parameter
importingi_parametertype STRING
i_valuetype STRING
i_is_booleantype BOOLEAN default C_BOOLEAN_FALSE
changingc_headerstype ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP-HEADERS
 Method for internal use. -
public static
add_query_parameter
importingi_parametertype STRING
i_valuetype STRING
i_is_booleantype BOOLEAN default C_BOOLEAN_FALSE
changingc_urltype TS_URL
 Method for internal use. -
public static
get_components
importingi_structuretype ANY
exportingvalue(e_components)type ZIF_IBMC_SERVICE_ARCH~TT_STRING
 Returns component names of a given structure +
public static
add_header_parameter
importingi_parametertype STRING
i_valuetype STRING
i_is_booleantype BOOLEAN default C_BOOLEAN_FALSE
changingc_headerstype ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP-HEADERS

Method for internal use.

+
public static
add_query_parameter
importingi_parametertype STRING
i_valuetype STRING
i_is_booleantype BOOLEAN default C_BOOLEAN_FALSE
changingc_urltype TS_URL

Method for internal use.

+
public static
get_components
importingi_structuretype ANY
exportingvalue(e_components)type ZIF_IBMC_SERVICE_ARCH~TT_STRING

Returns component names of a given structure.

Parameters
i_structure Structure with components.
e_components Internal table of component names. -
public static
get_datatype
importingi_fieldtype ANY
returningvalue(e_datatype)type ZIF_IBMC_SERVICE_ARCH~CHAR
 Returns data type of a given parameter +
public static
get_datatype
importingi_fieldtype ANY
returningvalue(e_datatype)type ZIF_IBMC_SERVICE_ARCH~CHAR

Returns data type of a given parameter.

Parameters
i_field Field of type that is supposed to be determined.
e_datatype Technical type (= base type) of I_FIELD. -
public static
get_field_type
importingi_fieldtype ANY
exportinge_technical_typetype ZIF_IBMC_SERVICE_ARCH~CHAR
e_relative_typetype STRING
e_lengthtype I
Returns field type and length of a given parameter +public static
get_field_type
importingi_fieldtype ANY
exportinge_technical_typetype ZIF_IBMC_SERVICE_ARCH~CHAR
e_relative_typetype STRING
e_lengthtype I

Returns field type and length of a given parameter.

Parameters
i_field Field of type that is supposed to be determined.
e_technical_type Technical type (= base type) of I_FIELD.
e_relative_type Relative type (= data type) of I_FIELD.
e_length Length of type of I_FIELD. -
public static
get_file_extension
importingvalue(i_mime_type)type STRING
returningvalue(e_extension)type STRING
Returns the file extension for a mime type, e.g. 'text/plain' -> 'txt' +public static
get_file_extension
importingvalue(i_mime_type)type STRING
returningvalue(e_extension)type STRING

Returns the file extension for a mime type

, + e.g. 'text/plain' -> 'txt'
Parameters
i_mime_type MIME type.
e_extension File extension (without leading dot). -
public static
get_full_url
importingi_urltype TS_URL
returningvalue(e_url)type STRING
Method for internal use. -public static
move_data_reference_to_abap
importingi_data_referencetype DATA_REFERENCE
exportingvalue(e_abap)type ANY
raisingzcx_ibmc_service_exception
Moves a referenced data structure to an ABAP structure +public static
get_full_url
importingi_urltype TS_URL
returningvalue(e_url)type STRING

Method for internal use.

+public static
move_data_reference_to_abap
importingi_data_referencetype DATA_REFERENCE
exportingvalue(e_abap)type ANY
raisingzcx_ibmc_service_exception

Moves a referenced data structure to an ABAP structure.

Parameters
i_data_reference Reference to data object.
e_abap ABAP structure to be filled.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public static
normalize_url
changingc_urltype TS_URL
Method for internal use. -public static
parse_json
importingi_jsontype STRING
i_dictionarytype ANY optional
changingvalue(c_abap)type ANY
zcx_ibmc_service_exception
Parses a JSON string into an ABAP structure +public static
normalize_url
changingc_urltype TS_URL

Method for internal use.

+public static
parse_json
importingi_jsontype STRING
i_dictionarytype ANY optional
changingvalue(c_abap)type ANY
zcx_ibmc_service_exception

Parses a JSON string into an ABAP structure.

Parameters
i_json JSON string.
i_dictionary Dictionary for mapping of identifier names.
c_abap ABAP structure to be filled
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public static
raise_exception
importingi_msgnotype SY-MSGNO optional
i_msgv1type STRING optional
i_msgv2type STRING optional
i_msgv3type STRING optional
i_msgv4type STRING optional
i_texttype STRING optional
i_subrctype SY-SUBRC default C_SUBRC_UNKNOWN
i_previoustype ref to CX_ROOT optional
i_http_statustype TS_HTTP_STATUS optional
raisingzcx_ibmc_service_exception
Raises an exception +public static
raise_exception
importingi_msgnotype SY-MSGNO optional
i_msgv1type STRING optional
i_msgv2type STRING optional
i_msgv3type STRING optional
i_msgv4type STRING optional
i_texttype STRING optional
i_subrctype SY-SUBRC default C_SUBRC_UNKNOWN
i_previoustype ref to CX_ROOT optional
i_http_statustype TS_HTTP_STATUS optional
raisingzcx_ibmc_service_exception

Raises an exception.

Parameters
i_msgno Message number.
i_msgv1 Substitution for 1st placeholder in message. @@ -54,11 +55,17 @@
i_previous Exception that has been captured before.
i_http_status HTTP status code if exception is triggered by HTTP error
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised. -
public static
unescape_unicode
importingi_intype STRING
returningvalue(e_out)type STRING
Unescape unicode codepoints to characters in a string, e.g. '\u0041 b \u0063' -> 'A b c' +public static
unescape_unicode
importingi_intype STRING
returningvalue(e_out)type STRING

Unescape unicode codepoints to characters in a string

, + e.g. '\u0041 b \u0063' -> 'A b c'
Parameters
i_in String with unicode codepoints.
e_out Unescaped string. -
public instance
check_http_response
importingi_responsetype TO_REST_RESPONSE optional
i_urltype TS_URL optional
raisingzcx_ibmc_service_exception
Throws an exception, if HTTP response indicates an errorpublic instance
constructor
importingi_urltype STRING optional
i_hosttype STRING optional
i_proxy_hosttype STRING optional
i_proxy_porttype STRING optional
i_usernametype STRING optional
i_passwordtype STRING optional
i_apikeytype STRING optional
i_access_tokentype TS_ACCESS_TOKEN optional
i_ssl_idtype ZIF_IBMC_SERVICE_ARCH~TY_SSL_ID optional
i_debug_modetype CHAR default SPACE
Class constructor. +public instance
check_http_response
importingi_responsetype TO_REST_RESPONSE optional
i_urltype TS_URL optional
raisingzcx_ibmc_service_exception

Throws an exception, if HTTP response indicates an error.

+ +
Parameters
i_response HTTP response to be checked. +
i_url URL that the request has been sent to. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
constructor
importingi_urltype STRING optional
i_hosttype STRING optional
i_proxy_hosttype STRING optional
i_proxy_porttype STRING optional
i_usernametype STRING optional
i_passwordtype STRING optional
i_apikeytype STRING optional
i_access_tokentype TS_ACCESS_TOKEN optional
i_ssl_idtype ZIF_IBMC_SERVICE_ARCH~TY_SSL_ID optional
i_debug_modetype CHAR default SPACE

Class constructor.

Parameters
i_url URL of the service.
i_host Host of the service. I_URL and I_HOST can be used synonymously. @@ -70,40 +77,39 @@
i_access_token Access token to authenticate on service.
i_ssl_id ID of PSE, not applicable on SAP Cloud Platform.
i_debug_mode not used. -
public instance
get_access_token
importingi_request_proptype TS_REQUEST_PROP optional
returningvalue(e_access_token)type TS_ACCESS_TOKEN
raisingzcx_ibmc_service_exception
Method for internal use. -public instance
get_appname
returningvalue(e_appname)type STRING
Returns the service name. +public instance
get_access_token
importingi_request_proptype TS_REQUEST_PROP optional
returningvalue(e_access_token)type TS_ACCESS_TOKEN
raisingzcx_ibmc_service_exception

Method for internal use.

+public instance
get_appname
returningvalue(e_appname)type STRING

Returns the service name.

Parameters
e_appname Name of the service. -
public instance
get_request_prop
importingi_auth_methodtype STRING default C_DEFAULT
returningvalue(e_request_prop)type TS_REQUEST_PROP
Method for internal use. -public instance
get_rest_client
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_client)type TS_CLIENT
raisingzcx_ibmc_service_exception
Method for internal use. -public instance
http_delete
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception
Sends a HTTP DELETE request. +public instance
get_request_prop
importingi_auth_methodtype STRING default C_DEFAULT
returningvalue(e_request_prop)type TS_REQUEST_PROP

Method for internal use.

+public instance
get_rest_client
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_client)type TS_CLIENT
raisingzcx_ibmc_service_exception

Method for internal use.

+public instance
http_delete
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception

Sends a HTTP DELETE request.

Parameters
i_request_prop Request properties.
e_response Response returned by service.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public instance
http_get
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception
Sends a HTTP GET request. +public instance
http_get
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception

Sends a HTTP GET request.

Parameters
i_request_prop Request properties.
e_response Response returned by service.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public instance
http_post
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception
Sends a HTTP POST request. +public instance
http_post
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception

Sends a HTTP POST request.

Parameters
i_request_prop Request properties.
e_response Response returned by service.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public instance
http_post_multipart
importingi_request_proptype TS_REQUEST_PROP
it_form_parttype TT_FORM_PART
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception
Sends a HTTP POST request with multipart body. +public instance
http_post_multipart
importingi_request_proptype TS_REQUEST_PROP
it_form_parttype TT_FORM_PART
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception

Sends a HTTP POST request with multipart body.

Parameters
i_request_prop Request properties.
it_form_part Internal table of form parts in request body.
e_response Response returned by service.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public instance
http_put
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception
Sends a HTTP PUT request. +public instance
http_put
importingi_request_proptype TS_REQUEST_PROP
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception

Sends a HTTP PUT request.

Parameters
i_request_prop Request properties.
e_response Response returned by service.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public instance
set_access_token
importingi_access_tokentype TS_ACCESS_TOKEN
raisingzcx_ibmc_service_exception
Sets an access token explicitly. +public instance
set_access_token
importingi_access_tokentype TS_ACCESS_TOKEN

Sets an access token explicitly.

Parameters
i_access_token Access token. -
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
\ No newline at end of file + \ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_arch.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_arch.html index 4cdbf96..69ffed0 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_arch.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_arch.html @@ -1 +1,81 @@ -Class ZCL_IBMC_SERVICE_ARCH

Class ZCL_IBMC_SERVICE_ARCH

public create public

Documentation

IBM Watson SDK Platform-specifics

Interfaces

zif_ibmc_service_arch

Types

Visibility and LevelNameDocumentation
publicto_form_part type ref to IF_HTTP_ENTITY 
publicto_http_client type ref to IF_HTTP_CLIENTHTTP Client Control Block
publicto_http_entity type ref to IF_HTTP_ENTITY 
publicto_rest_client type ref to CL_REST_HTTP_CLIENTREST HTTP Client
publicto_rest_entity type ref to IF_REST_ENTITY 
publicto_rest_request type ref to IF_REST_ENTITY 
publicto_rest_response type ref to IF_REST_ENTITY 
publicts_access_token type ZIF_IBMC_SERVICE_ARCH~TS_ACCESS_TOKEN 
publicts_client (structured type) 
publicts_header type ZIF_IBMC_SERVICE_ARCH~TS_HEADER 
publicts_http_status type ZIF_IBMC_SERVICE_ARCH~TS_HTTP_STATUS 
publicts_request_prop type ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP 
publicts_url type ZIF_IBMC_SERVICE_ARCH~TS_URL 
publictt_header type ZIF_IBMC_SERVICE_ARCH~TT_HEADER 

Methods

Visibility and LevelNameDocumentation
public static
base64_decode
importingi_base64type STRING
returningvalue(e_binary)type XSTRING
raisingzcx_ibmc_service_exception
Decodes base64 encoded data to binary
Class-based Exceptions
zcx_ibmc_service_exceptionIBM Cloud Service Exception
public static
convert_string_to_utf8
importingi_stringtype STRING
returningvalue(e_utf8)type XSTRING
raisingzcx_ibmc_service_exception
Converts STRING data to UTF8 encoded XSTRING
Class-based Exceptions
zcx_ibmc_service_exceptionIBM Cloud Service Exception
public static
create_client_by_url
importingi_urltype STRING
i_request_proptype TS_REQUEST_PROP
exportinge_clienttype TS_CLIENT
raisingzcx_ibmc_service_exception
Returns a HTTP/REST client based on an URL
Class-based Exceptions
zcx_ibmc_service_exceptionIBM Cloud Service Exception
public static
execute
importingi_clienttype TS_CLIENT
i_methodtype ZIF_IBMC_SERVICE_ARCH~CHAR default ZIF_IBMC_SERVICE_ARCH~C_METHOD_GET
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception
Executes a HTTP request (GET, POST or DELETE)
Class-based Exceptions
zcx_ibmc_service_exceptionIBM Cloud Service Exception
public static
get_default_proxy
importingi_urltype TS_URL optional
exportinge_proxy_hosttype STRING
e_proxy_porttype STRING
Returns the default proxy host and port
public static
get_http_status
importingi_rest_responsetype TO_REST_RESPONSE
returningvalue(e_status)type TS_HTTP_STATUS
Returns the status of a http response
public static
get_progname
returningvalue(e_progname)type STRING
Returns the ABAP program name
public static
get_response_binary
importingi_responsetype TO_REST_RESPONSE
returningvalue(e_data)type XSTRING
Reads string data from response
public static
get_response_string
importingi_responsetype TO_REST_RESPONSE
returningvalue(e_data)type STRING
Reads string data from response
public static
get_rest_request
importingi_clienttype TS_CLIENT
returningvalue(e_rest_request)type TO_REST_REQUEST
Returns a request object from a HTTP client object
public static
get_timezone
returningvalue(e_timezone)type ZIF_IBMC_SERVICE_ARCH~TY_TIMEZONE
Returns the user's time zone
public static
set_authentication_basic
importingi_clienttype TS_CLIENT
i_usernametype STRING
i_passwordtype STRING
Sets request header for basic authentication
public static
set_request_body_cdata
importingi_clienttype TS_CLIENT
i_datatype STRING
Sets the body of a HTTP request object
public static
set_request_body_xdata
importingi_clienttype TS_CLIENT
i_datatype XSTRING
Sets the body of a HTTP request object
public static
set_request_header
importingi_clienttype TS_CLIENT
i_nametype STRING
i_valuetype STRING
Sets a HTTP header
public static
set_request_uri
importingi_clienttype TS_CLIENT
i_uritype STRING
Sets the URI for a HTTP request
public instance
add_form_part
importingi_clienttype TS_CLIENT
it_form_parttype ZIF_IBMC_SERVICE_ARCH=>TT_FORM_PART
raisingzcx_ibmc_service_exception
 
\ No newline at end of file +Class ZCL_IBMC_SERVICE_ARCH

Class ZCL_IBMC_SERVICE_ARCH

public create public

Documentation

IBM Watson SDK Platform-specifics

Interfaces

zif_ibmc_service_arch

Types

Visibility and LevelNameDocumentation
publicto_form_part type ref to IF_HTTP_ENTITY 
publicto_http_client type ref to IF_HTTP_CLIENTHTTP Client Control Block
publicto_http_entity type ref to IF_HTTP_ENTITY 
publicto_rest_client type ref to CL_REST_HTTP_CLIENTREST HTTP Client
publicto_rest_entity type ref to IF_REST_ENTITY 
publicto_rest_request type ref to IF_REST_ENTITY 
publicto_rest_response type ref to IF_REST_ENTITY 
publicts_access_token type ZIF_IBMC_SERVICE_ARCH~TS_ACCESS_TOKEN 
publicts_client (structured type) 
publicts_header type ZIF_IBMC_SERVICE_ARCH~TS_HEADER 
publicts_http_status type ZIF_IBMC_SERVICE_ARCH~TS_HTTP_STATUS 
publicts_request_prop type ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP 
publicts_url type ZIF_IBMC_SERVICE_ARCH~TS_URL 
publictt_header type ZIF_IBMC_SERVICE_ARCH~TT_HEADER 

Methods

Visibility and LevelNameDocumentation
public static
base64_decode
importingi_base64type STRING
returningvalue(e_binary)type XSTRING
raisingzcx_ibmc_service_exception

Decodes base64 encoded data to binary.

+ +
Parameters
i_base64 Base64-encoded binary +
e_binary Binary data +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public static
convert_string_to_utf8
importingi_stringtype STRING
returningvalue(e_utf8)type XSTRING
raisingzcx_ibmc_service_exception

Converts STRING data to UTF8 encoded XSTRING.

+ +
Parameters
i_string STRING data +
e_utf8 UTF8-encoded data +
Class-based Exceptions
zcx_ibmc_service_exceptionIBM Cloud Service Exception
public static
create_client_by_url
importingi_urltype STRING
i_request_proptype TS_REQUEST_PROP
exportinge_clienttype TS_CLIENT
raisingzcx_ibmc_service_exception

Returns a HTTP/REST client based on an URL.

+ +
Parameters
i_url URL +
i_request_prop Request parameters +
e_client HTTP/REST client +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public static
execute
importingi_clienttype TS_CLIENT
i_methodtype ZIF_IBMC_SERVICE_ARCH~CHAR default ZIF_IBMC_SERVICE_ARCH~C_METHOD_GET
returningvalue(e_response)type TO_REST_RESPONSE
raisingzcx_ibmc_service_exception

Executes a HTTP request.

+ +
Parameters
i_client HTTP/REST client +
i_method HTTP method (GET,POST,PUT,DELETE) +
e_response Response of the request +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public static
get_default_proxy
importingi_urltype TS_URL optional
exportinge_proxy_hosttype STRING
e_proxy_porttype STRING

Returns the default proxy host and port.

+ +
Parameters
i_url target URL +
e_proxy_host Proxy host +
e_proxy_port Proxy port +
public static
get_http_status
importingi_rest_responsetype TO_REST_RESPONSE
returningvalue(e_status)type TS_HTTP_STATUS

Returns the status of a REST response.

+ +
Parameters
i_rest_response HTTP/REST response +
e_status HTTP status +
public static
get_progname
returningvalue(e_progname)type STRING

Returns an ABAP module identifier.

+ +
Parameters
e_progname ABAP module identifier +
public static
get_response_binary
importingi_responsetype TO_REST_RESPONSE
returningvalue(e_data)type XSTRING

Reads binary data from a HTTP response.

+ +
Parameters
i_response HTTP response +
e_data Binary data +
public static
get_response_header
importingi_responsetype TO_REST_RESPONSE
i_header_fieldtype STRING
returningvalue(e_value)type STRING

Returns a HTTP response header.

+ +
Parameters
i_response HTTP/REST response +
i_header_field Header field name +
e_value Header field value +
public static
get_response_string
importingi_responsetype TO_REST_RESPONSE
returningvalue(e_data)type STRING

Reads character data from a HTTP response.

+ +
Parameters
i_response HTTP response +
e_data Character data +
public static
get_rest_request
importingi_clienttype TS_CLIENT
returningvalue(e_rest_request)type TO_REST_REQUEST

Returns a request object from a HTTP client object.

+ +
Parameters
i_client HTTP/REST client +
e_rest_request REST request object +
public static
get_timezone
returningvalue(e_timezone)type ZIF_IBMC_SERVICE_ARCH~TY_TIMEZONE

Returns the user's time zone.

+ +
Parameters
e_timezone user's time zone +
public static
set_authentication_basic
importingi_clienttype TS_CLIENT
i_usernametype STRING
i_passwordtype STRING

Sets request header for basic authentication.

+ +
Parameters
i_client HTTP/REST client +
i_username User name +
i_password Password +
public static
set_request_body_cdata
importingi_clienttype TS_CLIENT
i_datatype STRING

Set character data for the body of a HTTP request.

+ +
Parameters
i_client HTTP/REST client +
i_data Character data +
public static
set_request_body_xdata
importingi_clienttype TS_CLIENT
i_datatype XSTRING

Set binary data for the body of a HTTP request.

+ +
Parameters
i_client HTTP/REST client +
i_data Binary data +
public static
set_request_header
importingi_clienttype TS_CLIENT
i_nametype STRING
i_valuetype STRING

Sets a HTTP header.

+ +
Parameters
i_client HTTP/REST client +
i_name Header field name +
i_value Header field value +
public static
set_request_uri
importingi_clienttype TS_CLIENT
i_uritype STRING

Sets the URI for a HTTP request.

+ +
Parameters
i_client HTTP/REST client +
i_uri URI +
public instance
add_form_part
importingi_clienttype TS_CLIENT
it_form_parttype ZIF_IBMC_SERVICE_ARCH=>TT_FORM_PART
raisingzcx_ibmc_service_exception

Generates a multi-part request body.

+ +
Parameters
i_client HTTP/REST client +
it_form_part Table of form parts +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_ext.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_ext.html index 9d9a0b3..a5381ab 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_ext.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_service_ext.html @@ -1,4 +1,4 @@ -Class ZCL_IBMC_SERVICE_EXT

Class ZCL_IBMC_SERVICE_EXT

public inheriting from ZCL_IBMC_SERVICE create public

Documentation

Extended REST API service class

Types

Visibility and LevelNameDocumentation
publicts_oauth_prop (structured type) 
publicty_image_class type STRING 
publicty_image_format (typing) 
publicty_instance_id (typing) 
publicty_servicename (typing) 

Constants

Visibility and LevelNameDocumentation
public staticc_field_none type FIELDNAME value '###'Field Name
public staticc_format_all type TY_IMAGE_FORMAT value '*'Image encoding (jpg, png, ...)
public staticc_format_gif type TY_IMAGE_FORMAT value 'gif'Image encoding (jpg, png, ...)
public staticc_format_jpg type TY_IMAGE_FORMAT value 'jpg'Image encoding (jpg, png, ...)
public staticc_format_png type TY_IMAGE_FORMAT value 'png'Image encoding (jpg, png, ...)
public staticc_format_tif type TY_IMAGE_FORMAT value 'tif'Image encoding (jpg, png, ...)
public staticc_format_unknown type TY_IMAGE_FORMAT value '###'Image encoding (jpg, png, ...)
public staticc_format_zip type TY_IMAGE_FORMAT value 'zip'Image encoding (jpg, png, ...)
public staticc_iam_token_host type STRING value 'iam.cloud.ibm.com' 
public staticc_iam_token_path type STRING value '/identity/token' 
public staticc_token_generation_always type CHAR value 'A' 
public staticc_token_generation_auto type CHAR value SPACE 
public staticc_token_generation_never type CHAR value 'N' 

Attributes

Visibility and LevelNameDocumentation
public instancep_instance_id type TY_INSTANCE_ID  
public instancep_servicename type TY_SERVICENAME  

Methods

Visibility and LevelNameDocumentation
public static
get_instance
importingi_instance_idtype TY_INSTANCE_ID optional
i_urltype STRING optional
i_hosttype STRING optional
i_usernametype STRING optional
i_passwordtype STRING optional
i_proxy_hosttype STRING optional
i_proxy_servicetype STRING optional
i_apikeytype STRING optional
i_auth_methodtype STRING default C_DEFAULT
i_oauth_proptype TS_OAUTH_PROP optional
i_token_generationtype CHAR default C_TOKEN_GENERATION_AUTO
i_request_headerstype STRING optional
i_versiontype STRING optional
exportingvalue(eo_instance)type ANY
 Factory method to instantiate a service specific wrapper class. +Class ZCL_IBMC_SERVICE_EXT

Class ZCL_IBMC_SERVICE_EXT

public inheriting from ZCL_IBMC_SERVICE create public

Documentation

Extended REST API service class

Types

Visibility and LevelNameDocumentation
publicts_oauth_prop (structured type) 
publicty_image_class type STRING 
publicty_image_format (typing) 
publicty_instance_id (typing) 
publicty_servicename (typing) 

Constants

Visibility and LevelNameDocumentation
public staticc_field_none type FIELDNAME value '###'Field Name
public staticc_format_all type TY_IMAGE_FORMAT value '*'Image encoding (jpg, png, ...)
public staticc_format_gif type TY_IMAGE_FORMAT value 'gif'Image encoding (jpg, png, ...)
public staticc_format_jpg type TY_IMAGE_FORMAT value 'jpg'Image encoding (jpg, png, ...)
public staticc_format_png type TY_IMAGE_FORMAT value 'png'Image encoding (jpg, png, ...)
public staticc_format_tif type TY_IMAGE_FORMAT value 'tif'Image encoding (jpg, png, ...)
public staticc_format_unknown type TY_IMAGE_FORMAT value '###'Image encoding (jpg, png, ...)
public staticc_format_zip type TY_IMAGE_FORMAT value 'zip'Image encoding (jpg, png, ...)
public staticc_iam_token_host type STRING value 'iam.cloud.ibm.com' 
public staticc_iam_token_path type STRING value '/identity/token' 
public staticc_icp4d_token_path type STRING value '/v1/preauth/validateAuth' 
public staticc_token_generation_always type CHAR value 'A' 
public staticc_token_generation_auto type CHAR value SPACE 
public staticc_token_generation_never type CHAR value 'N' 

Attributes

Visibility and LevelNameDocumentation
public instancep_instance_id type TY_INSTANCE_ID  
public instancep_servicename type TY_SERVICENAME  

Methods

Visibility and LevelNameDocumentation
public static
get_instance
importingi_instance_idtype TY_INSTANCE_ID optional
i_urltype STRING optional
i_hosttype STRING optional
i_usernametype STRING optional
i_passwordtype STRING optional
i_proxy_hosttype STRING optional
i_proxy_porttype STRING optional
i_apikeytype STRING optional
i_auth_methodtype STRING default C_DEFAULT
i_oauth_proptype TS_OAUTH_PROP optional
i_access_tokentype TS_ACCESS_TOKEN optional
i_token_generationtype CHAR default C_TOKEN_GENERATION_AUTO
i_request_headerstype STRING optional
i_versiontype STRING optional
exportingvalue(eo_instance)type ANY

Factory method to instantiate a service specific wrapper class.

Parameters
i_instance_id Value of field INSTANCE_UID in table ZIBMC_CONFIG. @@ -8,15 +8,17 @@
i_username User password to authenticate on service.
i_password User password to authenticate on service.
i_proxy_host Proxy server, not applicable on SAP Cloud Platform. +
i_proxy_port Proxy server port, not applicable on SAP Cloud Platform.
i_apikey API key password to authenticate on service.
i_auth_method Authentication method. Possible values are "IAM", "ICP4D", "basicAuth", "NONE". +
i_oauth_prop Credentials to generate token for OAuth authentication.
i_token_generation Method for access token refresh:
C_TOKEN_GENERATION_NEVER - Access token is not refreshed. C_TOKEN_GENERATION_ALWAYS - Access to token is refreshed for each service call. C_TOKEN_GENERATION_AUTO - Access to token is refreshed just before it expires.
i_request_headers List of headers sent with every request, format 'Header1=Value1;Header2=Value2'.
i_version Value of query parameter VERSION. -
eo_instanceExtended REST API service class
public static
get_zipdata
importingit_examplestype ANY TABLE
iv_field_classtype FIELDNAME default C_FIELD_NONE
iv_field_filenametype FIELDNAME optional
iv_field_imagetype FIELDNAME optional
iv_image_formattype TY_IMAGE_FORMAT optional
iv_image_nametype STRING optional
exportinget_zipdatatype TT_MAP_FILE
raisingzcx_ibmc_service_exception
 Compresses multiple images from an internal table to a one or more xstrings in ZIP format. +
public static
get_zipdata
importingit_examplestype ANY TABLE
iv_field_classtype FIELDNAME default C_FIELD_NONE
iv_field_filenametype FIELDNAME optional
iv_field_imagetype FIELDNAME optional
iv_image_formattype TY_IMAGE_FORMAT optional
iv_image_nametype STRING optional
exportinget_zipdatatype TT_MAP_FILE
raisingzcx_ibmc_service_exception

Compresses multiple images from an internal table

to a one or more xstrings in ZIP format.
Parameters
it_examples Internal table of images.
iv_field_class @@ -29,13 +31,15 @@
iv_image_name Name of the image.
et_zipdata Internal table containing a compressed ZIP xstring for each image class.
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. -
public instanceget_access_token redefinition 
public instance
get_bearer_token
returningvalue(e_bearer_token)type STRING
 Sends a HTTP PUT request. +
public instanceget_access_token redefinition public instance
get_bearer_token
returningvalue(e_bearer_token)type STRING

Returns the bearer token, if available.

- public instance
get_config_value
importingi_defaulttype ZIBMC_CONFIG-VALUE optional
i_paramtype ZIBMC_CONFIG-PARAM
returningvalue(e_value)type ZIBMC_CONFIG-VALUE
raisingzcx_ibmc_service_exception
Retrieves a value of a configuration parameter from table ZIBMC_CONFIG. +
Parameters
e_bearer_token Access token. +
public instance
get_config_value
importingi_defaulttype ZIBMC_CONFIG-VALUE optional
i_paramtype ZIBMC_CONFIG-PARAM
returningvalue(e_value)type ZIBMC_CONFIG-VALUE
raisingzcx_ibmc_service_exception

Retrieves a value of a configuration parameter

from table ZIBMC_CONFIG. -
Parameters
i_defaultCase-sensitive string value
i_param Configuration parameter name. -
e_valueCase-sensitive string value
Class-based Exceptions
zcx_ibmc_service_exceptionIBM Cloud Service Exception
public instanceget_request_prop redefinition public instance
get_sdk_version_date
returningvalue(e_sdk_version_date)type STRING
Returns the SDK built date. +
Parameters
i_default Default value, if configuration parameter is not found. +
i_param Configuration parameter name. +
public instanceget_request_prop redefinition public instance
get_sdk_version_date
returningvalue(e_sdk_version_date)type STRING

Returns the SDK built date.

Parameters
e_sdk_version_date Built data in format YYYYMMDD. -
public instanceset_access_token redefinition public instance
set_bearer_token
importingi_bearer_tokentype STRING
Method for internal use. -
\ No newline at end of file +public instance
set_bearer_token
importingi_bearer_tokentype STRING

Method for internal use.

+ \ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_speech_to_text_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_speech_to_text_v1.html index cd9b8d6..9b1b71a 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_speech_to_text_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_speech_to_text_v1.html @@ -1,5 +1,5 @@ -Class ZCL_IBMC_SPEECH_TO_TEXT_V1

Class ZCL_IBMC_SPEECH_TO_TEXT_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Speech to Text

- The IBM® Speech to Text service provides APIs that use IBM's +Class ZCL_IBMC_SPEECH_TO_TEXT_V1

Class ZCL_IBMC_SPEECH_TO_TEXT_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Speech to Text

+ The IBM® Speech to Text service provides APIs that use IBM's speech-recognition capabilities to produce transcripts of spoken audio. The service can transcribe speech from various languages and audio formats. In addition to basic transcription, the service can produce detailed information @@ -22,16 +22,180 @@
Language model customization is generally available for production use with most supported languages. Acoustic model customization is beta functionality that is - available for all supported languages.

Types

Visibility and LevelNameDocumentation
publict_acoustic_model (structured type) Information about an existing custom acoustic model.
publict_acoustic_models (structured type) Information about existing custom acoustic models.
publict_audio_details (structured type) Information about an audio resource from a custom acoustic model.
publict_audio_listing (structured type) Information about an audio resource from a custom acoustic model.
publict_audio_metrics (structured type) If audio metrics are requested, information about the signal characteristics of - the input audio.
publict_audio_metrics_details (structured type) Detailed information about the signal characteristics of the input audio.
publict_audio_metrics_histogram_bin (structured type) A bin with defined boundaries that indicates the number of values in a range of - signal characteristics for a histogram. The first and last bins of a histogram - are the boundary bins. They cover the intervals between negative infinity and - the first boundary, and between the last boundary and positive infinity, - respectively.
publict_audio_resource (structured type) Information about an audio resource from a custom acoustic model.
publict_audio_resources (structured type) Information about the audio resources from a custom acoustic model.
publict_corpora (structured type) Information about the corpora from a custom language model.
publict_corpus (structured type) Information about a corpus from a custom language model.
publict_create_acoustic_model (structured type) Information about the new custom acoustic model.
publict_create_language_model (structured type) Information about the new custom language model.
publict_custom_word (structured type) Information about a word that is to be added to a custom language model.
publict_custom_words (structured type) Information about the words that are to be added to a custom language model.
publict_empty_response_body type JSONOBJECT The empty response from a request.
publict_error_model (structured type) The error response from a failed request.
publict_grammar (structured type) Information about a grammar from a custom language model.
publict_grammars (structured type) Information about the grammars from a custom language model.
publict_inline_object (structured type) No documentation available.
publict_keyword_result (structured type) Information about a match for a keyword from speech recognition results.
publict_language_model (structured type) Information about an existing custom language model.
publict_language_models (structured type) Information about existing custom language models.
publict_processed_audio (structured type) Detailed timing information about the service's processing of the input audio.
publict_processing_metrics (structured type) 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.
publict_recognition_job (structured type) Information about a current asynchronous speech recognition job.
publict_recognition_jobs (structured type) Information about current asynchronous speech recognition jobs.
publict_register_status (structured type) Information about a request to register a callback for asynchronous speech - recognition.
publict_spch_recognition_alternative (structured type) An alternative transcript from speech recognition results.
publict_speaker_labels_result (structured type) Information about the speakers from speech recognition results.
publict_speech_model (structured type) Information about an available language model.
publict_speech_models (structured type) Information about the available language models.
publict_speech_recognition_result (structured type) Component results for a speech recognition request.
publict_speech_recognition_results (structured type) The complete results for a speech recognition request.
publict_supported_features (structured type) Additional service features that are supported with the model.
publict_training_response (structured type) The response from training of a custom language or custom acoustic model.
publict_training_warning (structured type) A warning from training of a custom language or custom acoustic model.
publict_word (structured type) Information about a word from a custom language model.
publict_words (structured type) Information about the words from a custom language model.
publict_word_alternative_result (structured type) An alternative hypothesis for a word from speech recognition results.
publict_word_alternative_results (structured type) Information about alternative hypotheses for words from speech recognition - results.
publict_word_error (structured type) An error associated with a word from a custom language model.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
add_audio
importingi_customization_idtype STRING
i_audio_nametype STRING
i_audio_resourcetype FILE
i_content_typetype STRING default 'application/zip'
i_contained_content_typetype STRING optional
i_allow_overwritetype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Add an audio resource. + available for all supported languages.

Types

Visibility and LevelNameDocumentation
publict_acoustic_model (structured type)

+ Information about an existing custom acoustic model.

publict_acoustic_models (structured type)

+ Information about existing custom acoustic models.

publict_audio_details (structured type)

+ Information about an audio resource from a custom acoustic

+ model.
publict_audio_listing (structured type)

+ Information about an audio resource from a custom acoustic

+ model.
publict_audio_metrics (structured type)

+ If audio metrics are requested, information about the signal

+ characteristics of the input audio.
publict_audio_metrics_details (structured type)

+ Detailed information about the signal characteristics of the

+ input audio.
publict_audio_metrics_histogram_bin (structured type)

+ A bin with defined boundaries that indicates the number of

+ values in a range of signal characteristics for a histogram. The first and last + bins of a histogram are the boundary bins. They cover the intervals between + negative infinity and the first boundary, and between the last boundary and + positive infinity, respectively.
publict_audio_resource (structured type)

+ Information about an audio resource from a custom acoustic

+ model.
publict_audio_resources (structured type)

+ Information about the audio resources from a custom acoustic

+ model.
publict_corpora (structured type)

+ Information about the corpora from a custom language model.

publict_corpus (structured type)

+ Information about a corpus from a custom language model.

publict_create_acoustic_model (structured type)

+ Information about the new custom acoustic model.

publict_create_language_model (structured type)

+ Information about the new custom language model.

publict_custom_word (structured type)

+ Information about a word that is to be added to a custom

+ language model.
publict_custom_words (structured type)

+ Information about the words that are to be added to a custom

+ language model.
publict_empty_response_body type JSONOBJECT

+ The empty response from a request.

publict_error_model (structured type)

+ The error response from a failed request.

publict_grammar (structured type)

+ Information about a grammar from a custom language model.

publict_grammars (structured type)

+ Information about the grammars from a custom language model.

publict_inline_object (structured type) No documentation available.
publict_keyword_result (structured type)

+ Information about a match for a keyword from speech

+ recognition results.
publict_language_model (structured type)

+ Information about an existing custom language model.

publict_language_models (structured type)

+ Information about existing custom language models.

publict_processed_audio (structured type)

+ Detailed timing information about the service's

+ processing of the input audio.
publict_processing_metrics (structured type)

+ 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.
publict_recognition_job (structured type)

+ Information about a current asynchronous speech recognition

+ job.
publict_recognition_jobs (structured type)

+ Information about current asynchronous speech recognition

+ jobs.
publict_register_status (structured type)

+ Information about a request to register a callback for

+ asynchronous speech recognition.
publict_spch_recognition_alternative (structured type)

+ An alternative transcript from speech recognition results.

publict_speaker_labels_result (structured type)

+ Information about the speakers from speech recognition

+ results.
publict_speech_model (structured type)

+ Information about an available language model.

publict_speech_models (structured type)

+ Information about the available language models.

publict_speech_recognition_result (structured type)

+ Component results for a speech recognition request.

publict_speech_recognition_results (structured type)

+ The complete results for a speech recognition request.

publict_supported_features (structured type)

+ Additional service features that are supported with the

+ model.
publict_training_response (structured type)

+ The response from training of a custom language or custom

+ acoustic model.
publict_training_warning (structured type)

+ A warning from training of a custom language or custom

+ acoustic model.
publict_word (structured type)

+ Information about a word from a custom language model.

publict_words (structured type)

+ Information about the words from a custom language model.

publict_word_alternative_result (structured type)

+ An alternative hypothesis for a word from speech recognition

+ results.
publict_word_alternative_results (structured type)

+ Information about alternative hypotheses for words from

+ speech recognition results.
publict_word_error (structured type)

+ An error associated with a word from a custom language

+ model.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
add_audio
importingi_customization_idtype STRING
i_audio_nametype STRING
i_audio_resourcetype FILE
i_content_typetype STRING default 'application/zip'
i_contained_content_typetype STRING optional
i_allow_overwritetype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Add an audio resource

+ Adds an audio resource to a custom acoustic model. Add audio content that + reflects the acoustic characteristics of the audio that you plan to transcribe. + You must use credentials for the instance of the service that owns a model to + add an audio resource to it. Adding audio data does not affect the custom + acoustic model until you train the model for the new data by using the **Train + a custom acoustic model** method.
+
+ You can add individual audio files or an archive file that contains multiple + audio files. Adding multiple audio files via a single archive file is + significantly more efficient than adding each file individually. You can add + audio resources in any format that the service supports for speech recognition. +
+
+ You can use this method to add any number of audio resources to a custom model + by calling the method once for each audio or archive file. You can add multiple + different audio resources at the same time. You must add a minimum of 10 + minutes and a maximum of 200 hours of audio that includes speech, not just + silence, to a custom acoustic model before you can train it. No audio resource, + audio- or archive-type, can be larger than 100 MB. To add an audio resource + that has the same name as an existing audio resource, set the `allow_overwrite` + parameter to `true`; otherwise, the request fails.
+
+ The method is asynchronous. It can take several seconds to complete depending on + the duration of the audio and, in the case of an archive file, the total number + of audio files being processed. The service returns a 201 response code if the + audio is valid. It then asynchronously analyzes the contents of the audio file + or files and automatically extracts information about the audio such as its + length, sampling rate, and encoding. You cannot submit requests to train or + upgrade the model until the service's analysis of all audio resources for + current requests completes.
+
+ To determine the status of the service's analysis of the audio, use the + **Get an audio resource** method to poll the status of the audio. The method + accepts the customization ID of the custom model and the name of the audio + resource, and it returns the status of the resource. Use a loop to check the + status of the audio every few seconds until it becomes `ok`.
+
+ **See also:** [Add audio to the custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic# + addAudio).
+
+ ### Content types for audio-type resources
+
+ You can add an individual audio file in any format that the service supports + for speech recognition. For an audio-type resource, use the `Content-Type` + parameter to specify the audio format (MIME type) of the audio file, including + specifying the sampling rate, channels, and endianness where indicated.
+ * `audio/alaw` (Specify the sampling rate (`rate`) of the audio.)
+ * `audio/basic` (Use only with narrowband models.)
+ * `audio/flac`
+ * `audio/g729` (Use only with narrowband models.)
+ * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of + channels (`channels`) and endianness (`endianness`) of the audio.)
+ * `audio/mp3`
+ * `audio/mpeg`
+ * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.)
+ * `audio/ogg` (The service automatically detects the codec of the input + audio.)
+ * `audio/ogg;codecs=opus`
+ * `audio/ogg;codecs=vorbis`
+ * `audio/wav` (Provide audio with a maximum of nine channels.)
+ * `audio/webm` (The service automatically detects the codec of the input + audio.)
+ * `audio/webm;codecs=opus`
+ * `audio/webm;codecs=vorbis`
+
+ The sampling rate of an audio file must match the sampling rate of the base + model for the custom model: for broadband models, at least 16 kHz; for + narrowband models, at least 8 kHz. If the sampling rate of the audio is higher + than the minimum required rate, the service down-samples the audio to the + appropriate rate. If the sampling rate of the audio is lower than the minimum + required rate, the service labels the audio file as `invalid`.
+
+ **See also:** [Audio + formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-f + ormats#audio-formats).
+
+ ### Content types for archive-type resources
+
+ You can add an archive file (**.zip** or **.tar.gz** file) that contains audio + files in any format that the service supports for speech recognition. For an + archive-type resource, use the `Content-Type` parameter to specify the media + type of the archive file:
+ * `application/zip` for a **.zip** file
+ * `application/gzip` for a **.tar.gz** file.
+
+ When you add an archive-type resource, the `Contained-Content-Type` header is + optional depending on the format of the files that you are adding:
+ * For audio files of type `audio/alaw`, `audio/basic`, `audio/l16`, or + `audio/mulaw`, you must use the `Contained-Content-Type` header to specify the + format of the contained audio files. Include the `rate`, `channels`, and + `endianness` parameters where necessary. In this case, all audio files + contained in the archive file must have the same audio format.
+ * For audio files of all other types, you can omit the `Contained-Content-Type` + header. In this case, the audio files contained in the archive file can have + any of the formats not listed in the previous bullet. The audio files do not + need to have the same format.
+
+ Do not use the `Contained-Content-Type` header when adding an audio-type + resource.
+
+ ### Naming restrictions for embedded audio files
+
+ The name of an audio file that is contained in an archive-type resource can + include a maximum of 128 characters. This includes the file extension and all + elements of the name (for example, slashes).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -65,26 +229,77 @@ description.
i_contained_content_type **For an archive-type resource,** specify the format of the audio files that are - ** contained in the archive file if they are of type `audio/alaw`, `audio/basic`, - ** `audio/l16`, or `audio/mulaw`. Include the `rate`, `channels`, and `endianness` - ** parameters where necessary. In this case, all audio files that are contained in - ** the archive file must be of the indicated type.
- **
- **For all other audio formats, you can omit the header. In this case, the audio - ** files can be of multiple types as long as they are not of the types listed in - ** the previous paragraph.
- **
- **The parameter accepts all of the audio formats that are supported for use with - ** speech recognition. For more information, see **Content types for audio-type - ** resources** in the method description.
- **
- ****For an audio-type resource,** omit the header. + contained in the archive file if they are of type `audio/alaw`, `audio/basic`, + `audio/l16`, or `audio/mulaw`. Include the `rate`, `channels`, and `endianness` + parameters where necessary. In this case, all audio files that are contained in + the archive file must be of the indicated type.
+
+ For all other audio formats, you can omit the header. In this case, the audio + files can be of multiple types as long as they are not of the types listed in + the previous paragraph.
+
+ The parameter accepts all of the audio formats that are supported for use with + speech recognition. For more information, see **Content types for audio-type + resources** in the method description.
+
+ **For an audio-type resource,** omit the header.
i_allow_overwrite If `true`, the specified audio resource overwrites an existing audio resource with the same name. If `false`, the request fails if an audio resource with the same name already exists. The parameter has no effect if an audio resource with the same name does not already exist. -
public instance
add_corpus
importingi_customization_idtype STRING
i_corpus_nametype STRING
i_corpus_filetype FILE
i_allow_overwritetype BOOLEAN default C_BOOLEAN_FALSE
i_corpus_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Add a corpus. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_corpus
importingi_customization_idtype STRING
i_corpus_nametype STRING
i_corpus_filetype FILE
i_allow_overwritetype BOOLEAN default C_BOOLEAN_FALSE
i_corpus_file_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Add a corpus

+ Adds a single corpus text file of new training data to a custom language model. + Use multiple requests to submit multiple corpus text files. You must use + credentials for the instance of the service that owns a model to add a corpus + to it. Adding a corpus does not affect the custom language model until you + train the model for the new data by using the **Train a custom language model** + method.
+
+ Submit a plain text file that contains sample sentences from the domain of + interest to enable the service to extract words in context. The more sentences + you add that represent the context in which speakers use words from the domain, + the better the service's recognition accuracy.
+
+ The call returns an HTTP 201 response code if the corpus is valid. The service + then asynchronously processes the contents of the corpus and automatically + extracts new words that it finds. This can take on the order of a minute or two + to complete depending on the total number of words and the number of new words + in the corpus, as well as the current load on the service. You cannot submit + requests to add additional resources to the custom model or to train the model + until the service's analysis of the corpus for the current request + completes. Use the **List a corpus** method to check the status of the + analysis.
+
+ The service auto-populates the model's words resource with words from the + corpus that are not found in its base vocabulary. These are referred to as + out-of-vocabulary (OOV) words. You can use the **List custom words** method to + examine the words resource. You can use other words method to eliminate typos + and modify how words are pronounced as needed.
+
+ To add a corpus file that has the same name as an existing corpus, set the + `allow_overwrite` parameter to `true`; otherwise, the request fails. + Overwriting an existing corpus causes the service to process the corpus text + file and extract OOV words anew. Before doing so, it removes any OOV words + associated with the existing corpus from the model's words resource unless + they were also added by another corpus or grammar, or they have been modified + in some way with the **Add custom words** or **Add a custom word** method. +
+
+ The service limits the overall amount of data that you can add to a custom model + to a maximum of 10 million total words from all sources combined. Also, you can + add no more than 90 thousand custom (OOV) words to a model. This includes words + that the service extracts from corpora and grammars, and words that you add + directly.
+
+ **See also:**
+ * [Working with + corpora](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpora + Words#workingCorpora)
+ * [Add a corpus to the custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + reate#addCorpus)
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -114,8 +329,8 @@ Make sure that you know the character encoding of the file. You must use that encoding when working with the words in the custom language model. For more information, see [Character - encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-corporaWords#charEncoding).
+ encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + aWords#charEncoding).

With the `curl` command, use the `--data-binary` option to upload the file for the request. @@ -124,7 +339,52 @@ name. If `false`, the request fails if a corpus with the same name already exists. The parameter has no effect if a corpus with the same name does not already exist. -
public instance
add_grammar
importingi_customization_idtype STRING
i_grammar_nametype STRING
i_grammar_filetype STRING
i_content_typetype STRING default 'application/srgs'
i_allow_overwritetype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Add a grammar. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_grammar
importingi_customization_idtype STRING
i_grammar_nametype STRING
i_grammar_filetype STRING
i_content_typetype STRING default 'application/srgs'
i_allow_overwritetype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Add a grammar

+ Adds a single grammar file to a custom language model. Submit a plain text file + in UTF-8 format that defines the grammar. Use multiple requests to submit + multiple grammar files. You must use credentials for the instance of the + service that owns a model to add a grammar to it. Adding a grammar does not + affect the custom language model until you train the model for the new data by + using the **Train a custom language model** method.
+
+ The call returns an HTTP 201 response code if the grammar is valid. The service + then asynchronously processes the contents of the grammar and automatically + extracts new words that it finds. This can take a few seconds to complete + depending on the size and complexity of the grammar, as well as the current + load on the service. You cannot submit requests to add additional resources to + the custom model or to train the model until the service's analysis of the + grammar for the current request completes. Use the **Get a grammar** method to + check the status of the analysis.
+
+ The service populates the model's words resource with any word that is + recognized by the grammar that is not found in the model's base + vocabulary. These are referred to as out-of-vocabulary (OOV) words. You can use + the **List custom words** method to examine the words resource and use other + words-related methods to eliminate typos and modify how words are pronounced as + needed.
+
+ To add a grammar that has the same name as an existing grammar, set the + `allow_overwrite` parameter to `true`; otherwise, the request fails. + Overwriting an existing grammar causes the service to process the grammar file + and extract OOV words anew. Before doing so, it removes any OOV words + associated with the existing grammar from the model's words resource + unless they were also added by another resource or they have been modified in + some way with the **Add custom words** or **Add a custom word** method.
+
+ The service limits the overall amount of data that you can add to a custom model + to a maximum of 10 million total words from all sources combined. Also, you can + add no more than 90 thousand OOV words to a model. This includes words that the + service extracts from corpora and grammars and words that you add directly. +
+
+ **See also:**
+ * [Understanding + grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-gramma + rUnderstand#grammarUnderstand)
+ * [Add a grammar to the custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-grammarAd + d#addGrammar)
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -166,7 +426,49 @@ name. If `false`, the request fails if a grammar with the same name already exists. The parameter has no effect if a grammar with the same name does not already exist. -
public instance
add_word
importingi_customization_idtype STRING
i_word_nametype STRING
i_custom_wordtype T_CUSTOM_WORD
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Add a custom word. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_word
importingi_customization_idtype STRING
i_word_nametype STRING
i_custom_wordtype T_CUSTOM_WORD
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Add a custom word

+ Adds a custom word 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 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.
+
+ You must use credentials for the instance of the service that owns a model to + add or modify a custom word for the model. Adding or modifying a custom word + does not affect the custom model until you train the model for the new data by + using the **Train a custom language model** method.
+
+ Use the `word_name` parameter to specify the custom word that is to be added or + modified. Use the `CustomWord` object to provide one or both of the optional + `sounds_like` and `display_as` fields for the word.
+ * The `sounds_like` field provides an array of one or more pronunciations for + the word. Use the parameter to specify how the word can be pronounced by users. + Use the parameter for words that are difficult to pronounce, foreign words, + acronyms, and so on. For example, you might specify that the word `IEEE` can + sound like `i triple e`. You can specify a maximum of five sounds-like + pronunciations for a word.
+ * The `display_as` field provides a different way of spelling the word in a + transcript. Use the parameter when you want the word to appear different from + its usual representation or from its spelling in training data. For example, + you might indicate that the word `IBM(trademark)` is to be displayed as + `IBM™`.
+
+ If you add a custom word that already exists in the words resource for the + custom model, the new definition overwrites the existing data for the word. If + the service encounters an error, it does not add the word to the words + resource. Use the **List a custom word** method to review the word that you + add.
+
+ **See also:**
+ * [Working with custom + words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWo + rds#workingWords)
+ * [Add words to the custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + reate#addWords)
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -177,13 +479,74 @@ Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the tokens of compound words. URL-encode the word if it includes non-ASCII characters. For more information, see [Character - encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-corporaWords#charEncoding). + encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + aWords#charEncoding).
i_custom_word A `CustomWord` object that provides information about the specified custom word. Specify an empty object to add a word with no sounds-like or display-as information. -
public instance
add_words
importingi_customization_idtype STRING
i_custom_wordstype T_CUSTOM_WORDS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Add custom words. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_words
importingi_customization_idtype STRING
i_custom_wordstype T_CUSTOM_WORDS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

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.
+
+ You must use credentials for the instance of the service that owns a model to + add or modify custom words for the model. Adding or modifying custom words does + not affect the custom model until you train the model for the new data by using + the **Train a custom language model** method.
+
+ You add custom words by providing a `CustomWords` object, which is an array of + `CustomWord` objects, one per word. You must use the object's `word` + parameter to identify the word that is to be added. You can also provide one or + both of the optional `sounds_like` and `display_as` fields for each word.
+ * The `sounds_like` field provides an array of one or more pronunciations for + the word. Use the parameter to specify how the word can be pronounced by users. + Use the parameter for words that are difficult to pronounce, foreign words, + acronyms, and so on. For example, you might specify that the word `IEEE` can + sound like `i triple e`. You can specify a maximum of five sounds-like + pronunciations for a word.
+ * The `display_as` field provides a different way of spelling the word in a + transcript. Use the parameter when you want the word to appear different from + its usual representation or from its spelling in training data. For example, + you might indicate that the word `IBM(trademark)` is to be displayed as + `IBM™`.
+
+ If you add a custom word that already exists in the words resource for the + custom model, the new definition overwrites the existing data for the word. If + the service encounters an error with the input data, it returns a failure code + and does not add any of the words to the words resource.
+
+ The call returns an HTTP 201 response code if the input data is valid. It then + asynchronously processes the words to add them to the model's words + resource. The time that it takes for the analysis to complete depends on the + number of new words that you add but is generally faster than adding a corpus + or grammar.
+
+ You can monitor the status of the request by using the **List a custom language + model** method to poll the model's status. Use a loop to check the status + every 10 seconds. The method returns a `Customization` object that includes a + `status` field. A status of `ready` means that the words have been added to the + custom model. The service cannot accept requests to add new data or to train + the model until the existing request completes.
+
+ You can use the **List custom words** or **List a custom word** method to review + the words that you add. Words with an invalid `sounds_like` field include an + `error` field that describes the problem. You can use other words-related + methods to correct errors, eliminate typos, and modify how words are pronounced + as needed.
+
+ **See also:**
+ * [Working with custom + words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWo + rds#workingWords)
+ * [Add words to the custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + reate#addWords)
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -192,7 +555,24 @@
i_custom_words A `CustomWords` object that provides information about one or more custom words that are to be added to or updated in the custom language model. -
public instance
check_job
importingi_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_RECOGNITION_JOB
raisingzcx_ibmc_service_exception
Check a job. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
check_job
importingi_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_RECOGNITION_JOB
raisingzcx_ibmc_service_exception

Check a job

+ Returns information about the specified job. The response always includes the + status of the job and its creation and update times. If the status is + `completed`, the response includes the results of the recognition request. You + must use credentials for the instance of the service that owns a job to list + information about it.
+
+ You can use the method to retrieve the results of any job, regardless of whether + it was submitted with a callback URL and the + `recognitions.completed_with_results` event, and you can retrieve the results + multiple times for as long as they remain available. Use the **Check jobs** + method to request information about the most recent jobs associated with the + calling credentials.
+
+ **See also:** [Checking the status and retrieving the results of a + job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#job). +
Parameters
i_id The identifier of the asynchronous job that is to be used for the request. You @@ -200,18 +580,151 @@ owns the job.
e_response Service return value of type T_RECOGNITION_JOB -
public instance
check_jobs
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_RECOGNITION_JOBS
raisingzcx_ibmc_service_exception
Check jobs. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
check_jobs
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_RECOGNITION_JOBS
raisingzcx_ibmc_service_exception

Check jobs

+ Returns the ID and status of the latest 100 outstanding jobs associated with the + credentials with which it is called. The method also returns the creation and + update times of each job, and, if a job was created with a callback URL and a + user token, the user token for the job. To obtain the results for a job whose + status is `completed` or not one of the latest 100 outstanding jobs, use the + **Check a job** method. A job and its results remain available until you delete + them with the **Delete a job** method or until the job's time to live + expires, whichever comes first.
+
+ **See also:** [Checking the status of the latest + jobs](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#jobs + ).
Parameters
e_response Service return value of type T_RECOGNITION_JOBS -
public instance
create_acoustic_model
importingi_create_acoustic_modeltype T_CREATE_ACOUSTIC_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ACOUSTIC_MODEL
raisingzcx_ibmc_service_exception
Create a custom acoustic model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_acoustic_model
importingi_create_acoustic_modeltype T_CREATE_ACOUSTIC_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ACOUSTIC_MODEL
raisingzcx_ibmc_service_exception

Create a custom acoustic model

+ Creates a new custom acoustic model for a specified base model. The custom + acoustic model can be used only with the base model for which it is created. + The model is owned by the instance of the service whose credentials are used to + create it.
+
+ You can create a maximum of 1024 custom acoustic models per owning credentials. + The service returns an error if you attempt to create more than 1024 models. + You do not lose any models, but you cannot create any more until your model + count is below the limit.
+
+ **See also:** [Create a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic# + createModel-acoustic).
Parameters
i_create_acoustic_model A `CreateAcousticModel` object that provides basic information about the new custom acoustic model.
e_response Service return value of type T_ACOUSTIC_MODEL -
public instance
create_job
importingi_audiotype FILE
i_content_typetype STRING default 'application/octet-stream'
i_modeltype STRING default 'en-US_BroadbandModel'
i_callback_urltype STRING optional
i_eventstype STRING optional
i_user_tokentype STRING optional
i_results_ttltype INTEGER optional
i_language_customization_idtype STRING optional
i_acoustic_customization_idtype STRING optional
i_base_model_versiontype STRING optional
i_customization_weighttype DOUBLE optional
i_inactivity_timeouttype INTEGER optional
i_keywordstype TT_STRING optional
i_keywords_thresholdtype FLOAT optional
i_max_alternativestype INTEGER optional
i_word_alternatives_thresholdtype FLOAT optional
i_word_confidencetype BOOLEAN default C_BOOLEAN_FALSE
i_timestampstype BOOLEAN default C_BOOLEAN_FALSE
i_profanity_filtertype BOOLEAN default C_BOOLEAN_TRUE
i_smart_formattingtype BOOLEAN default C_BOOLEAN_FALSE
i_speaker_labelstype BOOLEAN default C_BOOLEAN_FALSE
i_customization_idtype STRING optional
i_grammar_nametype STRING optional
i_redactiontype BOOLEAN default C_BOOLEAN_FALSE
i_processing_metricstype BOOLEAN default C_BOOLEAN_FALSE
i_processing_metrics_intervaltype FLOAT optional
i_audio_metricstype BOOLEAN default C_BOOLEAN_FALSE
i_end_of_phrase_silence_timetype DOUBLE optional
i_splt_trnscrpt_at_phrase_endtype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_RECOGNITION_JOB
raisingzcx_ibmc_service_exception
Create a job. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_job
importingi_audiotype FILE
i_content_typetype STRING default 'application/octet-stream'
i_modeltype STRING default 'en-US_BroadbandModel'
i_callback_urltype STRING optional
i_eventstype STRING optional
i_user_tokentype STRING optional
i_results_ttltype INTEGER optional
i_language_customization_idtype STRING optional
i_acoustic_customization_idtype STRING optional
i_base_model_versiontype STRING optional
i_customization_weighttype DOUBLE optional
i_inactivity_timeouttype INTEGER optional
i_keywordstype TT_STRING optional
i_keywords_thresholdtype FLOAT optional
i_max_alternativestype INTEGER optional
i_word_alternatives_thresholdtype FLOAT optional
i_word_confidencetype BOOLEAN default C_BOOLEAN_FALSE
i_timestampstype BOOLEAN default C_BOOLEAN_FALSE
i_profanity_filtertype BOOLEAN default C_BOOLEAN_TRUE
i_smart_formattingtype BOOLEAN default C_BOOLEAN_FALSE
i_speaker_labelstype BOOLEAN default C_BOOLEAN_FALSE
i_customization_idtype STRING optional
i_grammar_nametype STRING optional
i_redactiontype BOOLEAN default C_BOOLEAN_FALSE
i_processing_metricstype BOOLEAN default C_BOOLEAN_FALSE
i_processing_metrics_intervaltype FLOAT optional
i_audio_metricstype BOOLEAN default C_BOOLEAN_FALSE
i_end_of_phrase_silence_timetype DOUBLE optional
i_splt_trnscrpt_at_phrase_endtype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_RECOGNITION_JOB
raisingzcx_ibmc_service_exception

Create a job

+ Creates a job for a new asynchronous recognition request. The job is owned by + the instance of the service whose credentials are used to create it. How you + learn the status and results of a job depends on the parameters you include + with the job creation request:
+ * By callback notification: Include the `callback_url` parameter to specify a + URL to which the service is to send callback notifications when the status of + the job changes. Optionally, you can also include the `events` and `user_token` + parameters to subscribe to specific events and to specify a string that is to + be included with each notification for the job.
+ * By polling the service: Omit the `callback_url`, `events`, and `user_token` + parameters. You must then use the **Check jobs** or **Check a job** methods to + check the status of the job, using the latter to retrieve the results when the + job is complete.
+
+ The two approaches are not mutually exclusive. You can poll the service for job + status or obtain results from the service manually even if you include a + callback URL. In both cases, you can include the `results_ttl` parameter to + specify how long the results are to remain available after the job is complete. + Using the HTTPS **Check a job** method to retrieve results is more secure than + receiving them via callback notification over HTTP because it provides + confidentiality in addition to authentication and data integrity.
+
+ The method supports the same basic parameters as other HTTP and WebSocket + recognition requests. It also supports the following parameters specific to the + asynchronous interface:
+ * `callback_url`
+ * `events`
+ * `user_token`
+ * `results_ttl`
+
+ You can pass a maximum of 1 GB and a minimum of 100 bytes of audio with a + request. The service automatically detects the endianness of the incoming audio + and, for audio that includes multiple channels, downmixes the audio to + one-channel mono during transcoding. The method returns only final results; to + enable interim results, use the WebSocket API. (With the `curl` command, use + the `--data-binary` option to upload the file for the request.)
+
+ **See also:** [Creating a + job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#creat + e).
+
+ ### Streaming mode
+
+ For requests to transcribe live audio as it becomes available, you must set the + `Transfer-Encoding` header to `chunked` to use streaming mode. In streaming + mode, the service closes the connection (status code 408) if it does not + receive at least 15 seconds of audio (including silence) in any 30-second + period. The service also closes the connection (status code 400) if it detects + no speech for `inactivity_timeout` seconds of streaming audio; use the + `inactivity_timeout` parameter to change the default of 30 seconds.
+
+ **See also:**
+ * [Audio + transmission](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-in + put#transmission)
+ * + [Timeouts](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + #timeouts)
+
+ ### Audio formats (content types)
+
+ The service accepts audio in the following formats (MIME types).
+ * For formats that are labeled **Required**, you must use the `Content-Type` + header with the request to specify the format of the audio.
+ * For all other formats, you can omit the `Content-Type` header or specify + `application/octet-stream` with the header to have the service automatically + detect the format of the audio. (With the `curl` command, you can specify + either `"Content-Type:"` or `"Content-Type: + application/octet-stream"`.)
+
+ Where indicated, the format that you specify must include the sampling rate and + can optionally include the number of channels and the endianness of the + audio.
+ * `audio/alaw` (**Required.** Specify the sampling rate (`rate`) of the + audio.)
+ * `audio/basic` (**Required.** Use only with narrowband models.)
+ * `audio/flac`
+ * `audio/g729` (Use only with narrowband models.)
+ * `audio/l16` (**Required.** Specify the sampling rate (`rate`) and optionally + the number of channels (`channels`) and endianness (`endianness`) of the + audio.)
+ * `audio/mp3`
+ * `audio/mpeg`
+ * `audio/mulaw` (**Required.** Specify the sampling rate (`rate`) of the + audio.)
+ * `audio/ogg` (The service automatically detects the codec of the input + audio.)
+ * `audio/ogg;codecs=opus`
+ * `audio/ogg;codecs=vorbis`
+ * `audio/wav` (Provide audio with a maximum of nine channels.)
+ * `audio/webm` (The service automatically detects the codec of the input + audio.)
+ * `audio/webm;codecs=opus`
+ * `audio/webm;codecs=vorbis`
+
+ The sampling rate of the audio must match the sampling rate of the model for the + recognition request: for broadband models, at least 16 kHz; for narrowband + models, at least 8 kHz. If the sampling rate of the audio is higher than the + minimum required rate, the service down-samples the audio to the appropriate + rate. If the sampling rate of the audio is lower than the minimum required + rate, the request fails.
+
+ **See also:** [Audio + formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-f + ormats#audio-formats).
Parameters
i_audio The audio to transcribe. @@ -221,8 +734,8 @@
i_model The identifier of the model that is to be used for the recognition request. See [Languages and - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -models#models). + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + odels).
i_callback_url A URL to which callback notifications are to be sent. The URL must already be successfully white-listed by using the **Register a callback** method. You can @@ -267,8 +780,8 @@ must match the model specified with the `model` parameter. You must make the request with credentials for the instance of the service that owns the custom model. By default, no custom language model is used. See [Custom - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -input#custom-input).
+ models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + stom-input).

**Note:** Use this parameter instead of the deprecated `customization_id` parameter. @@ -278,8 +791,8 @@ must match the model specified with the `model` parameter. You must make the request with credentials for the instance of the service that owns the custom model. By default, no custom acoustic model is used. See [Custom - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -input#custom-input). + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + stom-input).
i_base_model_version The version of the specified base model that is to be used with the recognition request. Multiple versions of a base model can exist when a model is updated @@ -287,8 +800,8 @@ custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. See [Base model - version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-input#version). + version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#v + ersion).
i_customization_weight If you specify the customization ID (GUID) of a custom language model with the recognition request, the customization weight tells the service how much weight @@ -303,19 +816,19 @@ The default value yields the best performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy of - phrases from the custom model's domain, but it can negatively affect + phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases.

See [Custom - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -input#custom-input). + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + stom-input).
i_inactivity_timeout The time in seconds after which, if only silence (no speech) is detected in streaming audio, the connection is closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user simply walks away. Use `-1` for infinity. See [Inactivity - timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-input#timeouts-inactivity). + timeout](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#t + imeouts-inactivity).
i_keywords An array of keyword strings to spot in the audio. Each keyword string can include one or more string tokens. Keywords are spotted only in the final @@ -323,48 +836,48 @@ specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do not need to spot keywords. See [Keyword - spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-output#keyword_spotting). + spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + #keyword_spotting).
i_keywords_threshold A confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its confidence is greater than or equal to the threshold. Specify a probability between 0.0 and 1.0. If you specify a threshold, you must also specify one or more keywords. The service performs no keyword spotting if you omit either parameter. See [Keyword - spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-output#keyword_spotting). + spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + #keyword_spotting).
i_max_alternatives The maximum number of alternative transcripts that the service is to return. By default, the service returns a single transcript. If you specify a value of `0`, the service uses the default value, `1`. See [Maximum - alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - o-text-output#max_alternatives). + alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + tput#max_alternatives).
i_word_alternatives_threshold A confidence value that is the lower bound for identifying a hypothesis as a - possible word alternative (also known as "Confusion Networks"). An alternative - word is considered if its confidence is greater than or equal to the threshold. - Specify a probability between 0.0 and 1.0. By default, the service computes no - alternative words. See [Word - alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - o-text-output#word_alternatives). + possible word alternative (also known as "Confusion Networks"). An + alternative word is considered if its confidence is greater than or equal to + the threshold. Specify a probability between 0.0 and 1.0. By default, the + service computes no alternative words. See [Word + alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + tput#word_alternatives).
i_word_confidence If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for each word. By default, the service returns no word confidence scores. See [Word - confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - text-output#word_confidence). + confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + ut#word_confidence).
i_timestamps If `true`, the service returns time alignment for each word. By default, no timestamps are returned. See [Word - timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - text-output#word_timestamps). + timestamps](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + ut#word_timestamps).
i_profanity_filter If `true`, the service filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US English transcription only. See [Profanity - filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - ext-output#profanity_filter). + filtering](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + t#profanity_filter).
i_smart_formatting If `true`, the service converts dates, times, series of digits and numbers, phone numbers, currency values, and internet addresses into more readable, @@ -376,8 +889,8 @@ **Note:** Applies to US English, Japanese, and Spanish transcription only.

See [Smart - formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - text-output#smart_formatting). + formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + ut#smart_formatting).
i_speaker_labels If `true`, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, the service returns @@ -392,21 +905,21 @@ to `true`.

See [Speaker - labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -output#speaker_labels). + labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#s + peaker_labels).
i_customization_id **Deprecated.** Use the `language_customization_id` parameter to specify the - ** customization ID (GUID) of a custom language model that is to be used with the - ** recognition request. Do not specify both parameters with a request. + customization ID (GUID) of a custom language model that is to be used with the + recognition request. Do not specify both parameters with a request.
i_grammar_name The name of a grammar that is to be used with the recognition request. If you specify a grammar, you must also use the `language_customization_id` parameter to specify the name of the custom language model for which the grammar is defined. The service recognizes only strings that are recognized by the - specified grammar; it does not recognize other custom words from the model's - words resource. See - [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - ext-input#grammars-input). + specified grammar; it does not recognize other custom words from the + model's words resource. See + [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + #grammars-input).
i_redaction If `true`, the service redacts, or masks, numeric data from final transcripts. The feature redacts any number that has three or more consecutive digits by @@ -423,18 +936,18 @@ **Note:** Applies to US English, Japanese, and Korean transcription only.

See [Numeric - redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - ext-output#redaction). + redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + t#redaction).
i_processing_metrics - If `true`, requests processing metrics about the service's transcription of the - input audio. The service returns processing metrics at the interval specified - by the `processing_metrics_interval` parameter. It also returns processing - metrics for transcription events, for example, for final and interim results. - By default, the service returns no processing metrics.
+ If `true`, requests processing metrics about the service's transcription of + the input audio. The service returns processing metrics at the interval + specified by the `processing_metrics_interval` parameter. It also returns + processing metrics for transcription events, for example, for final and interim + results. By default, the service returns no processing metrics.

See [Processing - metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-metrics#processing_metrics). + metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + #processing_metrics).
i_processing_metrics_interval Specifies the interval in real wall-clock seconds at which the service is to return processing metrics. The parameter is ignored unless the @@ -449,16 +962,16 @@ the service returns processing metrics only for transcription events.

See [Processing - metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-metrics#processing_metrics). + metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + #processing_metrics).
i_audio_metrics If `true`, requests detailed information about the signal characteristics of the input audio. The service returns audio metrics with the final transcription results. By default, the service returns no audio metrics.

See [Audio - metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-metrics#audio_metrics). + metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + #audio_metrics).
i_end_of_phrase_silence_time If `true`, specifies the duration of the pause interval at which the service splits a transcript into multiple final results. If the service detects pauses @@ -476,8 +989,8 @@ Chinese is 0.6 seconds.

See [End of phrase silence - time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-o - utput#silence_time). + time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#sil + ence_time).
i_splt_trnscrpt_at_phrase_end If `true`, directs the service to split the transcript into multiple final results based on semantic features of the input, for example, at the conclusion @@ -488,24 +1001,62 @@ solely on the pause interval.

See [Split transcript at phrase - end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-ou - tput#split_transcript). + end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#spli + t_transcript).
e_response Service return value of type T_RECOGNITION_JOB -
public instance
create_language_model
importingi_create_language_modeltype T_CREATE_LANGUAGE_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LANGUAGE_MODEL
raisingzcx_ibmc_service_exception
Create a custom language model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_language_model
importingi_create_language_modeltype T_CREATE_LANGUAGE_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LANGUAGE_MODEL
raisingzcx_ibmc_service_exception

Create a custom language model

+ Creates a new custom language model for a specified base model. The custom + language model can be used only with the base model for which it is created. + The model is owned by the instance of the service whose credentials are used to + create it.
+
+ You can create a maximum of 1024 custom language models per owning credentials. + The service returns an error if you attempt to create more than 1024 models. + You do not lose any models, but you cannot create any more until your model + count is below the limit.
+
+ **See also:** [Create a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + reate#createModel-language).
Parameters
i_create_language_model A `CreateLanguageModel` object that provides basic information about the new custom language model.
e_response Service return value of type T_LANGUAGE_MODEL -
public instance
delete_acoustic_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete a custom acoustic model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_acoustic_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete a custom acoustic model

+ Deletes an existing custom acoustic model. The custom model cannot be deleted if + another request, such as adding an audio resource to the model, is currently + being processed. You must use credentials for the instance of the service that + owns a model to delete it.
+
+ **See also:** [Deleting a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAco + usticModels#deleteModel-acoustic).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model. -
public instance
delete_audio
importingi_customization_idtype STRING
i_audio_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete an audio resource. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_audio
importingi_customization_idtype STRING
i_audio_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete an audio resource

+ Deletes an existing audio resource from a custom acoustic model. Deleting an + archive-type audio resource removes the entire archive of files. The service + does not allow deletion of individual files from an archive resource.
+
+ Removing an audio resource does not affect the custom model until you train the + model on its updated data by using the **Train a custom acoustic model** + method. You can delete an existing audio resource from a model while a + different resource is being added to the model. You must use credentials for + the instance of the service that owns a model to delete its audio resources. +
+
+ **See also:** [Deleting an audio resource from a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAud + io#deleteAudio).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -513,7 +1064,20 @@ service that owns the custom model.
i_audio_name The name of the audio resource for the custom acoustic model. -
public instance
delete_corpus
importingi_customization_idtype STRING
i_corpus_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete a corpus. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_corpus
importingi_customization_idtype STRING
i_corpus_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Deleting a corpus from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCor + pora#deleteCorpus).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -521,7 +1085,20 @@ service that owns the custom model.
i_corpus_name The name of the corpus for the custom language model. -
public instance
delete_grammar
importingi_customization_idtype STRING
i_grammar_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete a grammar. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_grammar
importingi_customization_idtype STRING
i_grammar_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Deleting a grammar from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGra + mmars#deleteGrammar).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -529,23 +1106,69 @@ service that owns the custom model.
i_grammar_name The name of the grammar for the custom language model. -
public instance
delete_job
importingi_idtype STRING
raisingzcx_ibmc_service_exception
Delete a job. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_job
importingi_idtype STRING
raisingzcx_ibmc_service_exception

Delete a job

+ Deletes the specified job. You cannot delete a job that the service is actively + processing. Once you delete a job, its results are no longer available. The + service automatically deletes a job and its results when the time to live for + the results expires. You must use credentials for the instance of the service + that owns a job to delete it.
+
+ **See also:** [Deleting a + job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#delet + e-async).
Parameters
i_id The identifier of the asynchronous job that is to be used for the request. You must make the request with credentials for the instance of the service that owns the job. -
public instance
delete_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete a custom language model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete a custom language model

+ Deletes an existing custom language model. The custom model cannot be deleted if + another request, such as adding a corpus or grammar to the model, is currently + being processed. You must use credentials for the instance of the service that + owns a model to delete it.
+
+ **See also:** [Deleting a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLan + guageModels#deleteModel-language).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model. -
public instance
delete_user_data
importingi_customer_idtype STRING
raisingzcx_ibmc_service_exception
Delete labeled data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_user_data
importingi_customer_idtype STRING
raisingzcx_ibmc_service_exception

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 + information was added. The method has no effect if no data is associated with + the customer ID. You must issue the request with credentials for the same + instance of the service that was used to associate the customer ID with the + data.
+
+ You associate a customer ID with data by passing the `X-Watson-Metadata` header + with a request that passes the data.
+
+ **See also:** [Information + security](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-inform + ation-security#information-security).
Parameters
i_customer_id The customer ID for which all data is to be deleted. -
public instance
delete_word
importingi_customization_idtype STRING
i_word_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete a custom word. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_word
importingi_customization_idtype STRING
i_word_nametype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete a custom word

+ Deletes a custom word from a custom language model. You can remove any word that + you added to the custom model's words resource via any means. However, if + the word also exists in the service's base vocabulary, the service removes + only the custom pronunciation for the word; the word remains in the base + vocabulary. Removing a custom word 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 + words.
+
+ **See also:** [Deleting a word from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWor + ds#deleteWord).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -555,9 +1178,17 @@ The custom word that is to be deleted from the custom language model. URL-encode the word if it includes non-ASCII characters. For more information, see [Character - encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-corporaWords#charEncoding). -
public instance
get_acoustic_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ACOUSTIC_MODEL
raisingzcx_ibmc_service_exception
Get a custom acoustic model. + encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + aWords#charEncoding). +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_acoustic_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ACOUSTIC_MODEL
raisingzcx_ibmc_service_exception

Get a custom acoustic model

+ Gets information about a specified custom acoustic model. You must use + credentials for the instance of the service that owns a model to list + information about it.
+
+ **See also:** [Listing custom acoustic + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAc + ousticModels#listModels-acoustic).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -565,7 +1196,33 @@ service that owns the custom model.
e_response Service return value of type T_ACOUSTIC_MODEL -
public instanceget_appname redefinition public instance
get_audio
importingi_customization_idtype STRING
i_audio_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_AUDIO_LISTING
raisingzcx_ibmc_service_exception
Get an audio resource. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_audio
importingi_customization_idtype STRING
i_audio_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_AUDIO_LISTING
raisingzcx_ibmc_service_exception

Get an audio resource

+ Gets information about an audio resource from a custom acoustic model. The + method returns an `AudioListing` object whose fields depend on the type of + audio resource that you specify with the method's `audio_name` + parameter:
+ * **For an audio-type resource,** the object's fields match those of an + `AudioResource` object: `duration`, `name`, `details`, and `status`.
+ * **For an archive-type resource,** the object includes a `container` field + whose fields match those of an `AudioResource` object. It also includes an + `audio` field, which contains an array of `AudioResource` objects that provides + information about the audio files that are contained in the archive.
+
+ The information includes the status of the specified audio resource. The status + is important for checking the service's analysis of a resource that you + add to the custom model.
+ * For an audio-type resource, the `status` field is located in the + `AudioListing` object.
+ * For an archive-type resource, the `status` field is located in the + `AudioResource` object that is returned in the `container` field.
+
+ You must use credentials for the instance of the service that owns a model to + list its audio resources.
+
+ **See also:** [Listing audio resources for a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAud + io#listAudio).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -575,7 +1232,16 @@ The name of the audio resource for the custom acoustic model.
e_response Service return value of type T_AUDIO_LISTING -
public instance
get_corpus
importingi_customization_idtype STRING
i_corpus_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CORPUS
raisingzcx_ibmc_service_exception
Get a corpus. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_corpus
importingi_customization_idtype STRING
i_corpus_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CORPUS
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Listing corpora for a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCor + pora#listCorpora).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -585,7 +1251,16 @@ The name of the corpus for the custom language model.
e_response Service return value of type T_CORPUS -
public instance
get_grammar
importingi_customization_idtype STRING
i_grammar_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GRAMMAR
raisingzcx_ibmc_service_exception
Get a grammar. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_grammar
importingi_customization_idtype STRING
i_grammar_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GRAMMAR
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Listing grammars from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGra + mmars#listGrammars).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -595,7 +1270,15 @@ The name of the grammar for the custom language model.
e_response Service return value of type T_GRAMMAR -
public instance
get_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LANGUAGE_MODEL
raisingzcx_ibmc_service_exception
Get a custom language model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LANGUAGE_MODEL
raisingzcx_ibmc_service_exception

Get a custom language model

+ Gets information about a specified custom language model. You must use + credentials for the instance of the service that owns a model to list + information about it.
+
+ **See also:** [Listing custom language + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLa + nguageModels#listModels-language).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -603,14 +1286,30 @@ service that owns the custom model.
e_response Service return value of type T_LANGUAGE_MODEL -
public instance
get_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SPEECH_MODEL
raisingzcx_ibmc_service_exception
Get a model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_model
importingi_model_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SPEECH_MODEL
raisingzcx_ibmc_service_exception

Get a model

+ Gets information for a single specified language model that is available for use + with the service. The information includes the name of the model and its + minimum sampling rate in Hertz, among other things.
+
+ **See also:** [Languages and + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + odels).
Parameters
i_model_id The identifier of the model in the form of its name from the output of the **Get a model** method.
e_response Service return value of type T_SPEECH_MODEL -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_word
importingi_customization_idtype STRING
i_word_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORD
raisingzcx_ibmc_service_exception
Get a custom word. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_word
importingi_customization_idtype STRING
i_word_nametype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORD
raisingzcx_ibmc_service_exception

Get a custom word

+ Gets information about a custom word from a custom language model. You must use + credentials for the instance of the service that owns a model to list + information about its words.
+
+ **See also:** [Listing words from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWor + ds#listWords).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -620,11 +1319,21 @@ The custom word that is to be read from the custom language model. URL-encode the word if it includes non-ASCII characters. For more information, see [Character - encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-corporaWords#charEncoding). + encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + aWords#charEncoding).
e_response Service return value of type T_WORD -
public instance
list_acoustic_models
importingi_languagetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ACOUSTIC_MODELS
raisingzcx_ibmc_service_exception
List custom acoustic models. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_acoustic_models
importingi_languagetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ACOUSTIC_MODELS
raisingzcx_ibmc_service_exception

List custom acoustic models

+ Lists information about all custom acoustic models that are owned by an instance + of the service. Use the `language` parameter to see all custom acoustic models + for the specified language. Omit the parameter to see all custom acoustic + models for all languages. You must use credentials for the instance of the + service that owns a model to list information about it.
+
+ **See also:** [Listing custom acoustic + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAc + ousticModels#listModels-acoustic).
Parameters
i_language The identifier of the language for which custom language or custom acoustic @@ -633,7 +1342,19 @@ credentials.
e_response Service return value of type T_ACOUSTIC_MODELS -
public instance
list_audio
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_AUDIO_RESOURCES
raisingzcx_ibmc_service_exception
List audio resources. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_audio
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_AUDIO_RESOURCES
raisingzcx_ibmc_service_exception

List audio resources

+ Lists information about all audio resources from a custom acoustic model. The + information includes the name of the resource and information about its audio + data, such as its duration. It also includes the status of the audio resource, + which is important for checking the service's analysis of the resource in + response to a request to add it to the custom acoustic model. You must use + credentials for the instance of the service that owns a model to list its audio + resources.
+
+ **See also:** [Listing audio resources for a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAud + io#listAudio).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -641,7 +1362,16 @@ service that owns the custom model.
e_response Service return value of type T_AUDIO_RESOURCES -
public instance
list_corpora
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CORPORA
raisingzcx_ibmc_service_exception
List corpora. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_corpora
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CORPORA
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Listing corpora for a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCor + pora#listCorpora).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -649,7 +1379,16 @@ service that owns the custom model.
e_response Service return value of type T_CORPORA -
public instance
list_grammars
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GRAMMARS
raisingzcx_ibmc_service_exception
List grammars. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_grammars
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_GRAMMARS
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Listing grammars from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGra + mmars#listGrammars).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for @@ -657,7 +1396,17 @@ service that owns the custom model.
e_response Service return value of type T_GRAMMARS -
public instance
list_language_models
importingi_languagetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LANGUAGE_MODELS
raisingzcx_ibmc_service_exception
List custom language models. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_language_models
importingi_languagetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_LANGUAGE_MODELS
raisingzcx_ibmc_service_exception

List custom language models

+ Lists information about all custom language models that are owned by an instance + of the service. Use the `language` parameter to see all custom language models + for the specified language. Omit the parameter to see all custom language + models for all languages. You must use credentials for the instance of the + service that owns a model to list information about it.
+
+ **See also:** [Listing custom language + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLa + nguageModels#listModels-language).
Parameters
i_language The identifier of the language for which custom language or custom acoustic @@ -666,18 +1415,39 @@ credentials.
e_response Service return value of type T_LANGUAGE_MODELS -
public instance
list_models
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_SPEECH_MODELS
raisingzcx_ibmc_service_exception
List models. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_models
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_SPEECH_MODELS
raisingzcx_ibmc_service_exception

List models

+ Lists all language models that are available for use with the service. The + information includes the name of the model and its minimum sampling rate in + Hertz, among other things.
+
+ **See also:** [Languages and + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + odels).
Parameters
e_response Service return value of type T_SPEECH_MODELS -
public instance
list_words
importingi_customization_idtype STRING
i_word_typetype STRING default 'all'
i_sorttype STRING default 'alphabetical'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORDS
raisingzcx_ibmc_service_exception
List custom words. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_words
importingi_customization_idtype STRING
i_word_typetype STRING default 'all'
i_sorttype STRING default 'alphabetical'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORDS
raisingzcx_ibmc_service_exception

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.
+
+ **See also:** [Listing words from a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWor + ds#listWords).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model.
i_word_type - The type of words to be listed from the custom language model's words + The type of words to be listed from the custom language model's words resource:
* `all` (the default) shows all words.
* `user` shows only custom words that were added or modified by the user @@ -695,7 +1465,104 @@ `%2B`.
e_response Service return value of type T_WORDS -
public instance
recognize
importingi_audiotype FILE
i_content_typetype STRING default 'application/octet-stream'
i_modeltype STRING default 'en-US_BroadbandModel'
i_language_customization_idtype STRING optional
i_acoustic_customization_idtype STRING optional
i_base_model_versiontype STRING optional
i_customization_weighttype DOUBLE optional
i_inactivity_timeouttype INTEGER optional
i_keywordstype TT_STRING optional
i_keywords_thresholdtype FLOAT optional
i_max_alternativestype INTEGER optional
i_word_alternatives_thresholdtype FLOAT optional
i_word_confidencetype BOOLEAN default C_BOOLEAN_FALSE
i_timestampstype BOOLEAN default C_BOOLEAN_FALSE
i_profanity_filtertype BOOLEAN default C_BOOLEAN_TRUE
i_smart_formattingtype BOOLEAN default C_BOOLEAN_FALSE
i_speaker_labelstype BOOLEAN default C_BOOLEAN_FALSE
i_customization_idtype STRING optional
i_grammar_nametype STRING optional
i_redactiontype BOOLEAN default C_BOOLEAN_FALSE
i_audio_metricstype BOOLEAN default C_BOOLEAN_FALSE
i_end_of_phrase_silence_timetype DOUBLE optional
i_splt_trnscrpt_at_phrase_endtype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SPEECH_RECOGNITION_RESULTS
raisingzcx_ibmc_service_exception
Recognize audio. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
recognize
importingi_audiotype FILE
i_content_typetype STRING default 'application/octet-stream'
i_modeltype STRING default 'en-US_BroadbandModel'
i_language_customization_idtype STRING optional
i_acoustic_customization_idtype STRING optional
i_base_model_versiontype STRING optional
i_customization_weighttype DOUBLE optional
i_inactivity_timeouttype INTEGER optional
i_keywordstype TT_STRING optional
i_keywords_thresholdtype FLOAT optional
i_max_alternativestype INTEGER optional
i_word_alternatives_thresholdtype FLOAT optional
i_word_confidencetype BOOLEAN default C_BOOLEAN_FALSE
i_timestampstype BOOLEAN default C_BOOLEAN_FALSE
i_profanity_filtertype BOOLEAN default C_BOOLEAN_TRUE
i_smart_formattingtype BOOLEAN default C_BOOLEAN_FALSE
i_speaker_labelstype BOOLEAN default C_BOOLEAN_FALSE
i_customization_idtype STRING optional
i_grammar_nametype STRING optional
i_redactiontype BOOLEAN default C_BOOLEAN_FALSE
i_audio_metricstype BOOLEAN default C_BOOLEAN_FALSE
i_end_of_phrase_silence_timetype DOUBLE optional
i_splt_trnscrpt_at_phrase_endtype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
exportinge_responsetype T_SPEECH_RECOGNITION_RESULTS
raisingzcx_ibmc_service_exception

Recognize audio

+ Sends audio and returns transcription results for a recognition request. You can + pass a maximum of 100 MB and a minimum of 100 bytes of audio with a request. + The service automatically detects the endianness of the incoming audio and, for + audio that includes multiple channels, downmixes the audio to one-channel mono + during transcoding. The method returns only final results; to enable interim + results, use the WebSocket API. (With the `curl` command, use the + `--data-binary` option to upload the file for the request.)
+
+ **See also:** [Making a basic HTTP + request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HT + TP-basic).
+
+ ### Streaming mode
+
+ For requests to transcribe live audio as it becomes available, you must set the + `Transfer-Encoding` header to `chunked` to use streaming mode. In streaming + mode, the service closes the connection (status code 408) if it does not + receive at least 15 seconds of audio (including silence) in any 30-second + period. The service also closes the connection (status code 400) if it detects + no speech for `inactivity_timeout` seconds of streaming audio; use the + `inactivity_timeout` parameter to change the default of 30 seconds.
+
+ **See also:**
+ * [Audio + transmission](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-in + put#transmission)
+ * + [Timeouts](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + #timeouts)
+
+ ### Audio formats (content types)
+
+ The service accepts audio in the following formats (MIME types).
+ * For formats that are labeled **Required**, you must use the `Content-Type` + header with the request to specify the format of the audio.
+ * For all other formats, you can omit the `Content-Type` header or specify + `application/octet-stream` with the header to have the service automatically + detect the format of the audio. (With the `curl` command, you can specify + either `"Content-Type:"` or `"Content-Type: + application/octet-stream"`.)
+
+ Where indicated, the format that you specify must include the sampling rate and + can optionally include the number of channels and the endianness of the + audio.
+ * `audio/alaw` (**Required.** Specify the sampling rate (`rate`) of the + audio.)
+ * `audio/basic` (**Required.** Use only with narrowband models.)
+ * `audio/flac`
+ * `audio/g729` (Use only with narrowband models.)
+ * `audio/l16` (**Required.** Specify the sampling rate (`rate`) and optionally + the number of channels (`channels`) and endianness (`endianness`) of the + audio.)
+ * `audio/mp3`
+ * `audio/mpeg`
+ * `audio/mulaw` (**Required.** Specify the sampling rate (`rate`) of the + audio.)
+ * `audio/ogg` (The service automatically detects the codec of the input + audio.)
+ * `audio/ogg;codecs=opus`
+ * `audio/ogg;codecs=vorbis`
+ * `audio/wav` (Provide audio with a maximum of nine channels.)
+ * `audio/webm` (The service automatically detects the codec of the input + audio.)
+ * `audio/webm;codecs=opus`
+ * `audio/webm;codecs=vorbis`
+
+ The sampling rate of the audio must match the sampling rate of the model for the + recognition request: for broadband models, at least 16 kHz; for narrowband + models, at least 8 kHz. If the sampling rate of the audio is higher than the + minimum required rate, the service down-samples the audio to the appropriate + rate. If the sampling rate of the audio is lower than the minimum required + rate, the request fails.
+
+ **See also:** [Audio + formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-f + ormats#audio-formats).
+
+ ### Multipart speech recognition
+
+ **Note:** The Watson SDKs do not support multipart speech recognition.
+
+ The HTTP `POST` method of the service also supports multipart speech + recognition. With multipart requests, you pass all audio data as multipart form + data. You specify some parameters as request headers and query parameters, but + you pass JSON metadata as form data to control most aspects of the + transcription. You can use multipart recognition to pass multiple audio files + with a single request.
+
+ Use the multipart approach with browsers for which JavaScript is disabled or + when the parameters used with the request are greater than the 8 KB limit + imposed by most HTTP servers and proxies. You can encounter this limit, for + example, if you want to spot a very large number of keywords.
+
+ **See also:** [Making a multipart HTTP + request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HT + TP-multi).
Parameters
i_audio The audio to transcribe. @@ -705,16 +1572,16 @@
i_model The identifier of the model that is to be used for the recognition request. See [Languages and - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -models#models). + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + odels).
i_language_customization_id The customization ID (GUID) of a custom language model that is to be used with the recognition request. The base model of the specified custom language model must match the model specified with the `model` parameter. You must make the request with credentials for the instance of the service that owns the custom model. By default, no custom language model is used. See [Custom - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -input#custom-input).
+ models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + stom-input).

**Note:** Use this parameter instead of the deprecated `customization_id` parameter. @@ -724,8 +1591,8 @@ must match the model specified with the `model` parameter. You must make the request with credentials for the instance of the service that owns the custom model. By default, no custom acoustic model is used. See [Custom - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -input#custom-input). + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + stom-input).
i_base_model_version The version of the specified base model that is to be used with the recognition request. Multiple versions of a base model can exist when a model is updated @@ -733,8 +1600,8 @@ custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. See [Base model - version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-input#version). + version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#v + ersion).
i_customization_weight If you specify the customization ID (GUID) of a custom language model with the recognition request, the customization weight tells the service how much weight @@ -749,19 +1616,19 @@ The default value yields the best performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy of - phrases from the custom model's domain, but it can negatively affect + phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases.

See [Custom - models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -input#custom-input). + models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + stom-input).
i_inactivity_timeout The time in seconds after which, if only silence (no speech) is detected in streaming audio, the connection is closed with a 400 error. The parameter is useful for stopping audio submission from a live microphone when a user simply walks away. Use `-1` for infinity. See [Inactivity - timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-input#timeouts-inactivity). + timeout](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#t + imeouts-inactivity).
i_keywords An array of keyword strings to spot in the audio. Each keyword string can include one or more string tokens. Keywords are spotted only in the final @@ -769,48 +1636,48 @@ specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the parameter or specify an empty array if you do not need to spot keywords. See [Keyword - spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-output#keyword_spotting). + spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + #keyword_spotting).
i_keywords_threshold A confidence value that is the lower bound for spotting a keyword. A word is considered to match a keyword if its confidence is greater than or equal to the threshold. Specify a probability between 0.0 and 1.0. If you specify a threshold, you must also specify one or more keywords. The service performs no keyword spotting if you omit either parameter. See [Keyword - spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - xt-output#keyword_spotting). + spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + #keyword_spotting).
i_max_alternatives The maximum number of alternative transcripts that the service is to return. By default, the service returns a single transcript. If you specify a value of `0`, the service uses the default value, `1`. See [Maximum - alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - o-text-output#max_alternatives). + alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + tput#max_alternatives).
i_word_alternatives_threshold A confidence value that is the lower bound for identifying a hypothesis as a - possible word alternative (also known as "Confusion Networks"). An alternative - word is considered if its confidence is greater than or equal to the threshold. - Specify a probability between 0.0 and 1.0. By default, the service computes no - alternative words. See [Word - alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - o-text-output#word_alternatives). + possible word alternative (also known as "Confusion Networks"). An + alternative word is considered if its confidence is greater than or equal to + the threshold. Specify a probability between 0.0 and 1.0. By default, the + service computes no alternative words. See [Word + alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + tput#word_alternatives).
i_word_confidence If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 for each word. By default, the service returns no word confidence scores. See [Word - confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - text-output#word_confidence). + confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + ut#word_confidence).
i_timestamps If `true`, the service returns time alignment for each word. By default, no timestamps are returned. See [Word - timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - text-output#word_timestamps). + timestamps](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + ut#word_timestamps).
i_profanity_filter If `true`, the service filters profanity from all output except for keyword results by replacing inappropriate words with a series of asterisks. Set the parameter to `false` to return results with no censoring. Applies to US English transcription only. See [Profanity - filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - ext-output#profanity_filter). + filtering](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + t#profanity_filter).
i_smart_formatting If `true`, the service converts dates, times, series of digits and numbers, phone numbers, currency values, and internet addresses into more readable, @@ -822,8 +1689,8 @@ **Note:** Applies to US English, Japanese, and Spanish transcription only.

See [Smart - formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - text-output#smart_formatting). + formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + ut#smart_formatting).
i_speaker_labels If `true`, the response includes labels that identify which words were spoken by which participants in a multi-person exchange. By default, the service returns @@ -838,21 +1705,21 @@ to `true`.

See [Speaker - labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - -output#speaker_labels). + labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#s + peaker_labels).
i_customization_id **Deprecated.** Use the `language_customization_id` parameter to specify the - ** customization ID (GUID) of a custom language model that is to be used with the - ** recognition request. Do not specify both parameters with a request. + customization ID (GUID) of a custom language model that is to be used with the + recognition request. Do not specify both parameters with a request.
i_grammar_name The name of a grammar that is to be used with the recognition request. If you specify a grammar, you must also use the `language_customization_id` parameter to specify the name of the custom language model for which the grammar is defined. The service recognizes only strings that are recognized by the - specified grammar; it does not recognize other custom words from the model's - words resource. See - [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - ext-input#grammars-input). + specified grammar; it does not recognize other custom words from the + model's words resource. See + [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + #grammars-input).
i_redaction If `true`, the service redacts, or masks, numeric data from final transcripts. The feature redacts any number that has three or more consecutive digits by @@ -869,16 +1736,16 @@ **Note:** Applies to US English, Japanese, and Korean transcription only.

See [Numeric - redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - ext-output#redaction). + redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + t#redaction).
i_audio_metrics If `true`, requests detailed information about the signal characteristics of the input audio. The service returns audio metrics with the final transcription results. By default, the service returns no audio metrics.

See [Audio - metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - t-metrics#audio_metrics). + metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + #audio_metrics).
i_end_of_phrase_silence_time If `true`, specifies the duration of the pause interval at which the service splits a transcript into multiple final results. If the service detects pauses @@ -896,8 +1763,8 @@ Chinese is 0.6 seconds.

See [End of phrase silence - time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-o - utput#silence_time). + time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#sil + ence_time).
i_splt_trnscrpt_at_phrase_end If `true`, directs the service to split the transcript into multiple final results based on semantic features of the input, for example, at the conclusion @@ -908,11 +1775,48 @@ solely on the pause interval.

See [Split transcript at phrase - end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-ou - tput#split_transcript). + end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#spli + t_transcript).
e_response Service return value of type T_SPEECH_RECOGNITION_RESULTS -
public instance
register_callback
importingi_callback_urltype STRING
i_user_secrettype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_REGISTER_STATUS
raisingzcx_ibmc_service_exception
Register a callback. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
register_callback
importingi_callback_urltype STRING
i_user_secrettype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_REGISTER_STATUS
raisingzcx_ibmc_service_exception

Register a callback

+ Registers a callback URL with the service for use with subsequent asynchronous + recognition requests. The service attempts to register, or white-list, the + callback URL if it is not already registered by sending a `GET` request to the + callback URL. The service passes a random alphanumeric challenge string via the + `challenge_string` parameter of the request. The request includes an `Accept` + header that specifies `text/plain` as the required response type.
+
+ To be registered successfully, the callback URL must respond to the `GET` + request from the service. The response must send status code 200 and must + include the challenge string in its body. Set the `Content-Type` response + header to `text/plain`. Upon receiving this response, the service responds to + the original registration request with response code 201.
+
+ The service sends only a single `GET` request to the callback URL. If the + service does not receive a reply with a response code of 200 and a body that + echoes the challenge string sent by the service within five seconds, it does + not white-list the URL; it instead sends status code 400 in response to the + **Register a callback** request. If the requested callback URL is already + white-listed, the service responds to the initial registration request with + response code 200.
+
+ If you specify a user secret with the request, the service uses it as a key to + calculate an HMAC-SHA1 signature of the challenge string in its response to the + `POST` request. It sends this signature in the `X-Callback-Signature` header of + its `GET` request to the URL during registration. It also uses the secret to + calculate a signature over the payload of every callback notification that uses + the URL. The signature provides authentication and data integrity for HTTP + communications.
+
+ After you successfully register a callback URL, you can use it with an + indefinite number of recognition requests. You can register a maximum of 20 + callback URLS in a one-hour span of time.
+
+ **See also:** [Registering a callback + URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#regis + ter).
Parameters
i_callback_url An HTTP or HTTPS URL to which callback notifications are to be sent. To be @@ -928,19 +1832,100 @@ notification. If you omit the parameter, the service does not send the header.
e_response Service return value of type T_REGISTER_STATUS -
public instance
reset_acoustic_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Reset a custom acoustic model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
reset_acoustic_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Reset a custom acoustic model

+ Resets a custom acoustic model by removing all audio resources from the model. + Resetting a custom acoustic model initializes the model to its state when it + was first created. Metadata such as the name and language of the model are + preserved, but the model's audio resources are removed and must be + re-created. The service cannot reset a model while it is handling another + request for the model. The service cannot accept subsequent requests for the + model until the existing reset request completes. You must use credentials for + the instance of the service that owns a model to reset it.
+
+ **See also:** [Resetting a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAco + usticModels#resetModel-acoustic).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model. -
public instance
reset_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Reset a custom language model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
reset_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Reset a custom language model

+ Resets a custom language model by removing all corpora, grammars, and words from + the model. Resetting a custom language model initializes the model to its state + when it was first created. Metadata such as the name and language of the model + are preserved, but the model's words resource is removed and must be + re-created. You must use credentials for the instance of the service that owns + a model to reset it.
+
+ **See also:** [Resetting a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLan + guageModels#resetModel-language).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model. -
public instance
train_acoustic_model
importingi_customization_idtype STRING
i_custom_language_model_idtype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_RESPONSE
raisingzcx_ibmc_service_exception
Train a custom acoustic model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
train_acoustic_model
importingi_customization_idtype STRING
i_custom_language_model_idtype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_RESPONSE
raisingzcx_ibmc_service_exception

Train a custom acoustic model

+ Initiates the training of a custom acoustic model with new or changed audio + resources. After adding or deleting audio resources for a custom acoustic + model, use this method to begin the actual training of the model on the latest + audio data. The custom acoustic model does not reflect its changed data until + you train it. You must use credentials for the instance of the service that + owns a model to train it.
+
+ The training method is asynchronous. It can take on the order of minutes or + hours to complete depending on the total amount of audio data on which the + custom acoustic model is being trained and the current load on the service. + Typically, training a custom acoustic model takes approximately two to four + times the length of its audio data. The range of time depends on the model + being trained and the nature of the audio, such as whether the audio is clean + or noisy. The method returns an HTTP 200 response code to indicate that the + training process has begun.
+
+ You can monitor the status of the training by using the **Get a custom acoustic + model** method to poll the model's status. Use a loop to check the status + once a minute. The method returns an `AcousticModel` object that includes + `status` and `progress` fields. A status of `available` indicates that the + custom model is trained and ready to use. The service cannot train a model + while it is handling another request for the model. The service cannot accept + subsequent training requests, or requests to add new audio resources, until the + existing training request completes.
+
+ You can use the optional `custom_language_model_id` parameter to specify the + GUID of a separately created custom language model that is to be used during + training. Train with a custom language model if you have verbatim + transcriptions of the audio files that you have added to the custom model or + you have either corpora (text files) or a list of words that are relevant to + the contents of the audio files. Both of the custom models must be based on the + same version of the same base model for training to succeed.
+
+ **See also:**
+ * [Train the custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic# + trainModel-acoustic)
+ * [Using custom acoustic and custom language models + together](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-useBot + h#useBoth)
+
+ ### Training failures
+
+ Training can fail to start for the following reasons:
+ * The service is currently handling another request for the custom model, such + as another training request or a request to add audio resources to the + model.
+ * The custom model contains less than 10 minutes or more than 200 hours of audio + data.
+ * You passed an incompatible custom language model with the + `custom_language_model_id` query parameter. Both custom models must be based on + the same version of the same base model.
+ * The custom model contains one or more invalid audio resources. You can correct + the invalid audio resources or set the `strict` parameter to `false` to exclude + the invalid resources from the training. The model must contain at least one + valid resource for training to succeed.
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -956,15 +1941,54 @@ own both custom models.
e_response Service return value of type T_TRAINING_RESPONSE -
public instance
train_language_model
importingi_customization_idtype STRING
i_word_type_to_addtype STRING default 'all'
i_customization_weighttype DOUBLE optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_RESPONSE
raisingzcx_ibmc_service_exception
Train a custom language model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
train_language_model
importingi_customization_idtype STRING
i_word_type_to_addtype STRING default 'all'
i_customization_weighttype DOUBLE optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_RESPONSE
raisingzcx_ibmc_service_exception

Train a custom language model

+ Initiates the training of a custom language model with new resources such as + corpora, grammars, and custom words. After adding, modifying, or deleting + resources for a custom language model, use this method to begin the actual + training of the model on the latest data. You can specify whether the custom + language model is to be trained with all words from its words resource or only + with words that were added or modified by the user directly. You must use + credentials for the instance of the service that owns a model to train it. +
+
+ The training method is asynchronous. It can take on the order of minutes to + complete depending on the amount of data on which the service is being trained + and the current load on the service. The method returns an HTTP 200 response + code to indicate that the training process has begun.
+
+ You can monitor the status of the training by using the **Get a custom language + model** method to poll the model's status. Use a loop to check the status + every 10 seconds. The method returns a `LanguageModel` object that includes + `status` and `progress` fields. A status of `available` means that the custom + model is trained and ready to use. The service cannot accept subsequent + training requests or requests to add new resources until the existing request + completes.
+
+ **See also:** [Train the custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + reate#trainModel-language).
+
+ ### Training failures
+
+ Training can fail to start for the following reasons:
+ * The service is currently handling another request for the custom model, such + as another training request or a request to add a corpus or grammar to the + model.
+ * No training data have been added to the custom model.
+ * The custom model contains one or more invalid corpora, grammars, or words (for + example, a custom word has an invalid sounds-like pronunciation). You can + correct the invalid resources or set the `strict` parameter to `false` to + exclude the invalid resources from the training. The model must contain at + least one valid resource for training to succeed.
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model.
i_word_type_to_add - The type of words from the custom language model's words resource on which to - train the model:
+ The type of words from the custom language model's words resource on which + to train the model:
* `all` (the default) trains the model on all new words, regardless of whether they were extracted from corpora or grammars or were added or modified by the user.
@@ -980,7 +2004,7 @@ The default value yields the best performance in general. Assign a higher value if your audio makes frequent use of OOV words from the custom model. Use caution when setting the weight: a higher value can improve the accuracy of - phrases from the custom model's domain, but it can negatively affect + phrases from the custom model's domain, but it can negatively affect performance on non-domain phrases.

The value that you assign is used for all recognition requests that use the @@ -988,11 +2012,50 @@ customization weight for that request.
e_response Service return value of type T_TRAINING_RESPONSE -
public instance
unregister_callback
importingi_callback_urltype STRING
raisingzcx_ibmc_service_exception
Unregister a callback. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
unregister_callback
importingi_callback_urltype STRING
raisingzcx_ibmc_service_exception

Unregister a callback

+ Unregisters a callback URL that was previously white-listed 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.
+
+ **See also:** [Unregistering a callback + URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#unreg + ister).
Parameters
i_callback_url The callback URL that is to be unregistered. -
public instance
upgrade_acoustic_model
importingi_customization_idtype STRING
i_custom_language_model_idtype STRING optional
i_forcetype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Upgrade a custom acoustic model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
upgrade_acoustic_model
importingi_customization_idtype STRING
i_custom_language_model_idtype STRING optional
i_forcetype BOOLEAN default C_BOOLEAN_FALSE
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Upgrade a custom acoustic model

+ Initiates the upgrade of a custom acoustic model to the latest version of its + base language model. The upgrade method is asynchronous. It can take on the + order of minutes or hours to complete depending on the amount of data in the + custom model and the current load on the service; typically, upgrade takes + approximately twice the length of the total audio contained in the custom + model. A custom model must be in the `ready` or `available` state to be + upgraded. You must use credentials for the instance of the service that owns a + model to upgrade it.
+
+ The method returns an HTTP 200 response code to indicate that the upgrade + process has begun successfully. You can monitor the status of the upgrade by + using the **Get a custom acoustic model** method to poll the model's + status. The method returns an `AcousticModel` object that includes `status` and + `progress` fields. Use a loop to check the status once a minute. While it is + being upgraded, the custom model has the status `upgrading`. When the upgrade + is complete, the model resumes the status that it had prior to upgrade. The + service cannot upgrade a model while it is handling another request for the + model. The service cannot accept subsequent requests for the model until the + existing upgrade request completes.
+
+ If the custom acoustic model was trained with a separately created custom + language model, you must use the `custom_language_model_id` parameter to + specify the GUID of that custom language model. The custom language model must + be upgraded before the custom acoustic model can be upgraded. Omit the + parameter if the custom acoustic model was not trained with a custom language + model.
+
+ **See also:** [Upgrading a custom acoustic + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpg + rade#upgradeAcoustic).
Parameters
i_customization_id The customization ID (GUID) of the custom acoustic model that is to be used for @@ -1009,12 +2072,34 @@ the upgrade of a custom acoustic model that is trained with a custom language model, and only if you receive a 400 response code and the message `No input data modified since last training`. See [Upgrading a custom acoustic - model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text- - customUpgrade#upgradeAcoustic). -
public instance
upgrade_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Upgrade a custom language model. + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpg + rade#upgradeAcoustic). +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
upgrade_language_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Upgrade a custom language model

+ Initiates the upgrade of a custom language model to the latest version of its + base language model. The upgrade method is asynchronous. It can take on the + order of minutes to complete depending on the amount of data in the custom + model and the current load on the service. A custom model must be in the + `ready` or `available` state to be upgraded. You must use credentials for the + instance of the service that owns a model to upgrade it.
+
+ The method returns an HTTP 200 response code to indicate that the upgrade + process has begun successfully. You can monitor the status of the upgrade by + using the **Get a custom language model** method to poll the model's + status. The method returns a `LanguageModel` object that includes `status` and + `progress` fields. Use a loop to check the status every 10 seconds. While it is + being upgraded, the custom model has the status `upgrading`. When the upgrade + is complete, the model resumes the status that it had prior to upgrade. The + service cannot accept subsequent requests for the model until the upgrade + completes.
+
+ **See also:** [Upgrading a custom language + model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpg + rade#upgradeLanguage).
Parameters
i_customization_id The customization ID (GUID) of the custom language model that is to be used for the request. You must make the request with credentials for the instance of the service that owns the custom model. -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_text_to_speech_v1.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_text_to_speech_v1.html index 488e67c..de5a6ba 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_text_to_speech_v1.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_text_to_speech_v1.html @@ -1,5 +1,5 @@ -Class ZCL_IBMC_TEXT_TO_SPEECH_V1

Class ZCL_IBMC_TEXT_TO_SPEECH_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Text to Speech

- The IBM® Text to Speech service provides APIs that use IBM's +Class ZCL_IBMC_TEXT_TO_SPEECH_V1

Class ZCL_IBMC_TEXT_TO_SPEECH_V1

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Text to Speech

+ The IBM® Text to Speech service provides APIs that use IBM's speech-synthesis capabilities to synthesize text into natural-sounding speech in a variety of languages, dialects, and voices. The service supports at least one male or female voice, sometimes both, for each language. The audio is @@ -17,14 +17,62 @@ word. A phonetic translation is based on the SSML phoneme format for representing a word. You can specify a phonetic translation in standard International Phonetic Alphabet (IPA) representation or in the proprietary IBM - Symbolic Phonetic Representation (SPR).

Types

Visibility and LevelNameDocumentation
publict_create_voice_model (structured type) Information about the new custom voice model.
publict_empty_response_body type JSONOBJECT The empty response from a request.
publict_error_model (structured type) The error response from a failed request.
publict_pronunciation (structured type) The pronunciation of the specified text.
publict_supported_features (structured type) Additional service features that are supported with the voice.
publict_text (structured type) The text to synthesize. Specify either plain text or a subset of SSML. SSML is - an XML-based markup language that provides text annotation for speech-synthesis - applications. Pass a maximum of 5 KB of input text.
publict_translation (structured type) Information about the translation for the specified text.
publict_update_voice_model (structured type) Information about the updated custom voice model.
publict_voice (structured type) Information about an available voice model.
publict_voices (structured type) Information about all available voice models.
publict_voice_model (structured type) Information about an existing custom voice model.
publict_voice_models (structured type) Information about existing custom voice models.
publict_word (structured type) Information about a word for the custom voice model.
publict_words (structured type) For the **Add custom words** method, one or more words that are to be added or - updated for the custom voice model and the translation for each specified word. + Symbolic Phonetic Representation (SPR).

Types

Visibility and LevelNameDocumentation
publict_create_voice_model (structured type)

+ Information about the new custom voice model.

publict_empty_response_body type JSONOBJECT

+ The empty response from a request.

publict_error_model (structured type)

+ The error response from a failed request.

publict_pronunciation (structured type)

+ The pronunciation of the specified text.

publict_supported_features (structured type)

+ Additional service features that are supported with the

+ voice.
publict_text (structured type)

+ The text to synthesize. Specify either plain text or a

+ subset of SSML. SSML is an XML-based markup language that provides text + annotation for speech-synthesis applications. Pass a maximum of 5 KB of input + text.
publict_translation (structured type)

+ Information about the translation for the specified text.

publict_update_voice_model (structured type)

+ Information about the updated custom voice model.

publict_voice (structured type)

+ Information about an available voice model.

publict_voices (structured type)

+ Information about all available voice models.

publict_voice_model (structured type)

+ Information about an existing custom voice model.

publict_voice_models (structured type)

+ Information about existing custom voice models.

publict_word (structured type)

+ Information about a word for the custom voice model.

publict_words (structured type)

+ For the **Add custom words** method, one or more words that

+ are to be added or updated for the custom voice model and the translation for + each specified word.

+ For the **List custom words** method, the words and their translations from the + custom voice model.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
add_word
importingi_customization_idtype STRING
i_wordtype STRING
i_translationtype T_TRANSLATION
i_contenttypetype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Add a custom word

+ Adds a single word and its translation to the specified custom voice model. + Adding a new translation for a word that already exists in a custom model + overwrites the word's existing translation. A custom model can contain no + more than 20,000 entries. You must use credentials for the instance of the + service that owns a model to add a word to it.

- For the **List custom words** method, the words and their translations from the - custom voice model.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
add_word
importingi_customization_idtype STRING
i_wordtype STRING
i_translationtype T_TRANSLATION
i_contenttypetype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Add a custom word. + You can define sounds-like or phonetic translations for words. A sounds-like + translation consists of one or more words that, when combined, sound like the + word. Phonetic translations are based on the SSML phoneme format for + representing a word. You can specify them in standard International Phonetic + Alphabet (IPA) representation
+
+ <code><phoneme alphabet="ipa" + ph="təmˈɑto"></phoneme></code>
+
+ or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+
+ <code><phoneme alphabet="ibm" + ph="1gAstroEntxrYFXs"></phoneme></code>
+
+ **Note:** This method is currently a beta release.
+
+ **See also:**
+ * [Adding a single word to a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuWordAdd)
+ * [Adding words to a Japanese custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuJapaneseAdd)
+ * [Understanding + customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c + ustomIntro#customIntro)
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request @@ -33,37 +81,128 @@ The word that is to be added or updated for the custom voice model.
i_translation The translation for the word that is to be added or updated. -
public instance
add_words
importingi_customization_idtype STRING
i_custom_wordstype T_WORDS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Add custom words. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_words
importingi_customization_idtype STRING
i_custom_wordstype T_WORDS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Add custom words

+ Adds one or more words and their translations to the specified custom voice + model. Adding a new translation for a word that already exists in a custom + model overwrites the word's existing translation. A custom model can + contain no more than 20,000 entries. You must use credentials for the instance + of the service that owns a model to add words to it.
+
+ You can define sounds-like or phonetic translations for words. A sounds-like + translation consists of one or more words that, when combined, sound like the + word. Phonetic translations are based on the SSML phoneme format for + representing a word. You can specify them in standard International Phonetic + Alphabet (IPA) representation
+
+ <code><phoneme alphabet="ipa" + ph="təmˈɑto"></phoneme></code>
+
+ or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+
+ <code><phoneme alphabet="ibm" + ph="1gAstroEntxrYFXs"></phoneme></code>
+
+ **Note:** This method is currently a beta release.
+
+ **See also:**
+ * [Adding multiple words to a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuWordsAdd)
+ * [Adding words to a Japanese custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuJapaneseAdd)
+ * [Understanding + customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c + ustomIntro#customIntro)
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request with credentials for the instance of the service that owns the custom model.
i_custom_words No documentation available. -
public instance
create_voice_model
importingi_create_voice_modeltype T_CREATE_VOICE_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE_MODEL
raisingzcx_ibmc_service_exception
 Create a custom model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_voice_model
importingi_create_voice_modeltype T_CREATE_VOICE_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE_MODEL
raisingzcx_ibmc_service_exception

Create a custom model

+ Creates a new empty custom voice model. You must specify a name for the new + custom model. You can optionally specify the language and a description for the + new model. The model is owned by the instance of the service whose credentials + are used to create it.
+
+ **Note:** This method is currently a beta release. The service does not support + voice model customization for the Arabic, Chinese, and Dutch languages.
+
+ **See also:** [Creating a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + els#cuModelsCreate).
Parameters
i_create_voice_model A `CreateVoiceModel` object that contains information about the new custom voice model.
e_response Service return value of type T_VOICE_MODEL -
public instance
delete_user_data
importingi_customer_idtype STRING
raisingzcx_ibmc_service_exception
Delete labeled data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_user_data
importingi_customer_idtype STRING
raisingzcx_ibmc_service_exception

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 + information was added. The method has no effect if no data is associated with + the customer ID. You must issue the request with credentials for the same + instance of the service that was used to associate the customer ID with the + data.
+
+ You associate a customer ID with data by passing the `X-Watson-Metadata` header + with a request that passes the data.
+
+ **See also:** [Information + security](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-inform + ation-security#information-security).
Parameters
i_customer_id The customer ID for which all data is to be deleted. -
public instance
delete_voice_model
importingi_customization_idtype STRING
raisingzcx_ibmc_service_exception
Delete a custom model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_voice_model
importingi_customization_idtype STRING
raisingzcx_ibmc_service_exception

Delete a custom model

+ Deletes the specified custom voice model. You must use credentials for the + instance of the service that owns a model to delete it.
+
+ **Note:** This method is currently a beta release.
+
+ **See also:** [Deleting a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + els#cuModelsDelete).
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request with credentials for the instance of the service that owns the custom model. -
public instance
delete_word
importingi_customization_idtype STRING
i_wordtype STRING
raisingzcx_ibmc_service_exception
Delete a custom word. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_word
importingi_customization_idtype STRING
i_wordtype STRING
raisingzcx_ibmc_service_exception

Delete a custom word

+ Deletes a single word from the specified custom voice model. You must use + credentials for the instance of the service that owns a model to delete its + words.
+
+ **Note:** This method is currently a beta release.
+
+ **See also:** [Deleting a word from a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuWordDelete).
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request with credentials for the instance of the service that owns the custom model.
i_word The word that is to be deleted from the custom voice model. -
public instanceget_appname redefinition public instance
get_pronunciation
importingi_texttype STRING
i_voicetype STRING default 'en-US_MichaelVoice'
i_formattype STRING default 'ipa'
i_customization_idtype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_PRONUNCIATION
raisingzcx_ibmc_service_exception
Get pronunciation. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_pronunciation
importingi_texttype STRING
i_voicetype STRING default 'en-US_MichaelVoice'
i_formattype STRING default 'ipa'
i_customization_idtype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_PRONUNCIATION
raisingzcx_ibmc_service_exception

Get pronunciation

+ Gets the phonetic pronunciation for the specified word. You can request the + pronunciation for a specific format. You can also request the pronunciation for + a specific voice to see the default translation for the language of that voice + or for a specific custom voice model to see the translation for that voice + model.
+
+ **Note:** This method is currently a beta release. The method does not support + the Arabic, Chinese, and Dutch languages.
+
+ **See also:** [Querying a word from a + language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-custom + Words#cuWordsQueryLanguage).
Parameters
i_text The word for which the pronunciation is requested. @@ -79,12 +218,22 @@ is to be returned. The language of a specified custom model must match the language of the specified voice. If the word is not defined in the specified custom model, the service returns the default translation for the custom - model's language. You must make the request with credentials for the instance - of the service that owns the custom model. Omit the parameter to see the - translation for the specified voice with no customization. + model's language. You must make the request with credentials for the + instance of the service that owns the custom model. Omit the parameter to see + the translation for the specified voice with no customization.
e_response Service return value of type T_PRONUNCIATION -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_voice
importingi_voicetype STRING
i_customization_idtype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE
raisingzcx_ibmc_service_exception
Get a voice. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_voice
importingi_voicetype STRING
i_customization_idtype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE
raisingzcx_ibmc_service_exception

Get a voice

+ Gets information about the specified voice. The information includes the name, + language, gender, and other details about the voice. Specify a customization ID + to obtain information for a custom voice model that is defined for the language + of the specified voice. To list information about all available voices, use the + **List voices** method.
+
+ **See also:** [Listing a specific + voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#li + stVoice).
Parameters
i_voice The voice for which information is to be returned. @@ -95,14 +244,36 @@ the specified voice with no customization.
e_response Service return value of type T_VOICE -
public instance
get_voice_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE_MODEL
raisingzcx_ibmc_service_exception
Get a custom model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_voice_model
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE_MODEL
raisingzcx_ibmc_service_exception

Get a custom model

+ Gets all information about a specified custom voice model. In addition to + metadata such as the name and description of the voice model, the output + includes the words and their translations as defined in the model. To see just + the metadata for a voice model, use the **List custom models** method.
+
+ **Note:** This method is currently a beta release.
+
+ **See also:** [Querying a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + els#cuModelsQuery).
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request with credentials for the instance of the service that owns the custom model.
e_response Service return value of type T_VOICE_MODEL -
public instance
get_word
importingi_customization_idtype STRING
i_wordtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION
raisingzcx_ibmc_service_exception
Get a custom word. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_word
importingi_customization_idtype STRING
i_wordtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRANSLATION
raisingzcx_ibmc_service_exception

Get a custom word

+ Gets the translation for a single word from the specified custom model. The + output shows the translation as it is defined in the model. You must use + credentials for the instance of the service that owns a model to list its + words.
+
+ **Note:** This method is currently a beta release.
+
+ **See also:** [Querying a single word from a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuWordQueryModel).
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request @@ -111,11 +282,32 @@ The word that is to be queried from the custom voice model.
e_response Service return value of type T_TRANSLATION -
public instance
list_voices
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICES
raisingzcx_ibmc_service_exception
List voices. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_voices
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICES
raisingzcx_ibmc_service_exception

List voices

+ Lists all voices available for use with the service. The information includes + the name, language, gender, and other details about the voice. To see + information about a specific voice, use the **Get a voice** method.
+
+ **See also:** [Listing all available + voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#l + istVoices).
Parameters
e_response Service return value of type T_VOICES -
public instance
list_voice_models
importingi_languagetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE_MODELS
raisingzcx_ibmc_service_exception
List custom models. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_voice_models
importingi_languagetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_VOICE_MODELS
raisingzcx_ibmc_service_exception

List custom models

+ Lists metadata such as the name and description for all custom voice models that + are owned by an instance of the service. Specify a language to list the voice + models for that language only. To see the words in addition to the metadata for + a specific voice 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.
+
+ **Note:** This method is currently a beta release.
+
+ **See also:** [Querying all custom + models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMo + dels#cuModelsQueryAll).
Parameters
i_language The language for which custom voice models that are owned by the requesting @@ -123,14 +315,99 @@ models that are owned by the requester.
e_response Service return value of type T_VOICE_MODELS -
public instance
list_words
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORDS
raisingzcx_ibmc_service_exception
List custom words. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_words
importingi_customization_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_WORDS
raisingzcx_ibmc_service_exception

List custom words

+ Lists all of the words and their translations for the specified custom voice + model. The output shows the translations as they are defined in the model. You + must use credentials for the instance of the service that owns a model to list + its words.
+
+ **Note:** This method is currently a beta release.
+
+ **See also:** [Querying all words from a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuWordsQueryModel).
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request with credentials for the instance of the service that owns the custom model.
e_response Service return value of type T_WORDS -
public instance
synthesize
importingi_texttype T_TEXT
i_accepttype STRING default 'audio/ogg;codecs=opus'
i_voicetype STRING default 'en-US_MichaelVoice'
i_customization_idtype STRING optional
i_contenttypetype STRING default 'application/json'
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception
Synthesize audio. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
synthesize
importingi_texttype T_TEXT
i_accepttype STRING default 'audio/ogg;codecs=opus'
i_voicetype STRING default 'en-US_MichaelVoice'
i_customization_idtype STRING optional
i_contenttypetype STRING default 'application/json'
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception

Synthesize audio

+ Synthesizes text to audio that is spoken in the specified voice. The service + bases its understanding of the language for the input text on the specified + voice. Use a voice that matches the language of the input text.
+
+ The method accepts a maximum of 5 KB of input text in the body of the request, + and 8 KB for the URL and headers. The 5 KB limit includes any SSML tags that + you specify. The service returns the synthesized audio stream as an array of + bytes.
+
+ **See also:** [The HTTP + interface](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-using + HTTP#usingHTTP).
+
+ ### Audio formats (accept types)
+
+ The service can return audio in the following formats (MIME types).
+ * Where indicated, you can optionally specify the sampling rate (`rate`) of the + audio. You must specify a sampling rate for the `audio/l16` and `audio/mulaw` + formats. A specified sampling rate must lie in the range of 8 kHz to 192 kHz. + Some formats restrict the sampling rate to certain values, as noted.
+ * For the `audio/l16` format, you can optionally specify the endianness + (`endianness`) of the audio: `endianness=big-endian` or + `endianness=little-endian`.
+
+ Use the `Accept` header or the `accept` parameter to specify the requested + format of the response audio. If you omit an audio format altogether, the + service returns the audio in Ogg format with the Opus codec + (`audio/ogg;codecs=opus`). The service always returns single-channel + audio.
+ * `audio/basic` - The service returns audio with a sampling rate of 8000 + Hz.
+ * `audio/flac` - You can optionally specify the `rate` of the audio. The default + sampling rate is 22,050 Hz.
+ * `audio/l16` - You must specify the `rate` of the audio. You can optionally + specify the `endianness` of the audio. The default endianness is + `little-endian`.
+ * `audio/mp3` - You can optionally specify the `rate` of the audio. The default + sampling rate is 22,050 Hz.
+ * `audio/mpeg` - You can optionally specify the `rate` of the audio. The default + sampling rate is 22,050 Hz.
+ * `audio/mulaw` - You must specify the `rate` of the audio.
+ * `audio/ogg` - The service returns the audio in the `vorbis` codec. You can + optionally specify the `rate` of the audio. The default sampling rate is 22,050 + Hz.
+ * `audio/ogg;codecs=opus` - You can optionally specify the `rate` of the audio. + Only the following values are valid sampling rates: `48000`, `24000`, `16000`, + `12000`, or `8000`. If you specify a value other than one of these, the service + returns an error. The default sampling rate is 48,000 Hz.
+ * `audio/ogg;codecs=vorbis` - You can optionally specify the `rate` of the + audio. The default sampling rate is 22,050 Hz.
+ * `audio/wav` - You can optionally specify the `rate` of the audio. The default + sampling rate is 22,050 Hz.
+ * `audio/webm` - The service returns the audio in the `opus` codec. The service + returns audio with a sampling rate of 48,000 Hz.
+ * `audio/webm;codecs=opus` - The service returns audio with a sampling rate of + 48,000 Hz.
+ * `audio/webm;codecs=vorbis` - You can optionally specify the `rate` of the + audio. The default sampling rate is 22,050 Hz.
+
+ For more information about specifying an audio format, including additional + details about some of the formats, see [Audio + formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audioFo + rmats#audioFormats).
+
+ ### Warning messages
+
+ If a request includes invalid query parameters, the service returns a + `Warnings` response header that provides messages about the invalid parameters. + The warning includes a descriptive message and a list of invalid argument + strings. For example, a message such as `"Unknown arguments:"` or + `"Unknown url query arguments:"` followed by a list of the form + `"{invalid_arg_1}, {invalid_arg_2}."` The request + succeeds despite the warnings.
Parameters
i_text No documentation available. @@ -149,7 +426,42 @@ to use the specified voice with no customization.
e_response Service return value of type FILE -
public instance
update_voice_model
importingi_customization_idtype STRING
i_update_voice_modeltype T_UPDATE_VOICE_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Update a custom model. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_voice_model
importingi_customization_idtype STRING
i_update_voice_modeltype T_UPDATE_VOICE_MODEL
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Update a custom model

+ Updates information for the specified custom voice model. You can update + metadata such as the name and description of the voice model. You can also + update the words in the model and their translations. Adding a new translation + for a word that already exists in a custom model overwrites the word's + existing translation. A custom model can contain no more than 20,000 entries. + You must use credentials for the instance of the service that owns a model to + update it.
+
+ You can define sounds-like or phonetic translations for words. A sounds-like + translation consists of one or more words that, when combined, sound like the + word. Phonetic translations are based on the SSML phoneme format for + representing a word. You can specify them in standard International Phonetic + Alphabet (IPA) representation
+
+ <code><phoneme alphabet="ipa" + ph="təmˈɑto"></phoneme></code>
+
+ or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+
+ <code><phoneme alphabet="ibm" + ph="1gAstroEntxrYFXs"></phoneme></code>
+
+ **Note:** This method is currently a beta release.
+
+ **See also:**
+ * [Updating a custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + els#cuModelsUpdate)
+ * [Adding words to a Japanese custom + model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + ds#cuJapaneseAdd)
+ * [Understanding + customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c + ustomIntro#customIntro)
Parameters
i_customization_id The customization ID (GUID) of the custom voice model. You must make the request @@ -157,4 +469,5 @@
i_update_voice_model An `UpdateVoiceModel` object that contains information that is to be updated for the custom voice model. -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_tone_analyzer_v3.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_tone_analyzer_v3.html index b6db80a..3084683 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_tone_analyzer_v3.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_tone_analyzer_v3.html @@ -1,35 +1,72 @@ -Class ZCL_IBMC_TONE_ANALYZER_V3

Class ZCL_IBMC_TONE_ANALYZER_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Tone Analyzer

+Class ZCL_IBMC_TONE_ANALYZER_V3

Class ZCL_IBMC_TONE_ANALYZER_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

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.
+ customers' communications and to respond to each customer appropriately, + or to understand and improve their customer conversations.

**Note:** Request logging is disabled for the Tone Analyzer service. Regardless of whether you set the `X-Watson-Learning-Opt-Out` request header, the service - does not log or retain data from requests and responses.

Types

Visibility and LevelNameDocumentation
publict_document_analysis (structured type) The results of the analysis for the full input content.
publict_error_model (structured type) The error response from a failed request.
publict_sentence_analysis (structured type) The results of the analysis for the individual sentences of the input content.
publict_tone_analysis (structured type) The tone analysis results for the input from the general-purpose endpoint.
publict_tone_category (structured type) The category for a tone from the input content.
publict_tone_chat_input (structured type) Input for the customer-engagement endpoint.
publict_tone_chat_score (structured type) The score for an utterance from the input content.
publict_tone_input (structured type) Input for the general-purpose endpoint.
publict_tone_score (structured type) The score for a tone from the input content.
publict_utterance (structured type) An utterance for the input of the general-purpose endpoint.
publict_utterance_analyses (structured type) The results of the analysis for the utterances of the input content.
publict_utterance_analysis (structured type) The results of the analysis for an utterance of the input content.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instanceget_appname redefinition 
public instanceget_request_prop redefinition 
public instanceget_sdk_version_date redefinition 
public instance
tone
importingi_tone_inputtype T_TONE_INPUT
i_content_typetype STRING default 'application/json'
i_sentencestype BOOLEAN default C_BOOLEAN_TRUE
i_tonestype TT_STRING optional
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TONE_ANALYSIS
raisingzcx_ibmc_service_exception
 Analyze general tone. + does not log or retain data from requests and responses.

Types

Visibility and LevelNameDocumentation
publict_document_analysis (structured type)

+ The results of the analysis for the full input content.

publict_error_model (structured type)

+ The error response from a failed request.

publict_sentence_analysis (structured type)

+ The results of the analysis for the individual sentences of

+ the input content.
publict_tone_analysis (structured type)

+ The tone analysis results for the input from the

+ general-purpose endpoint.
publict_tone_category (structured type)

+ The category for a tone from the input content.

publict_tone_chat_input (structured type)

+ Input for the customer-engagement endpoint.

publict_tone_chat_score (structured type)

+ The score for an utterance from the input content.

publict_tone_input (structured type)

+ Input for the general-purpose endpoint.

publict_tone_score (structured type)

+ The score for a tone from the input content.

publict_utterance (structured type)

+ An utterance for the input of the general-purpose endpoint.

publict_utterance_analyses (structured type)

+ The results of the analysis for the utterances of the input

+ content.
publict_utterance_analysis (structured type)

+ The results of the analysis for an utterance of the input

+ content.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instanceget_appname redefinition 
public instanceget_request_prop redefinition 
public instanceget_sdk_version_date redefinition 
public instance
tone
importingi_tone_inputtype T_TONE_INPUT
i_content_typetype STRING default 'application/json'
i_sentencestype BOOLEAN default C_BOOLEAN_TRUE
i_tonestype TT_STRING optional
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TONE_ANALYSIS
raisingzcx_ibmc_service_exception

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.
+
+ You can submit no more than 128 KB of total input content and no more than 1000 + individual sentences in JSON, plain text, or HTML format. The service analyzes + the first 1000 sentences for document-level analysis and only the first 100 + sentences for sentence-level analysis.
+
+ Per the JSON specification, the default character encoding for JSON content is + effectively always UTF-8; per the HTTP specification, the default encoding for + plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When + specifying a content type of plain text or HTML, include the `charset` + parameter to indicate the character encoding of the input text; for example: + `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes + HTML tags and analyzes only the textual content.
+
+ **See also:** [Using the general-purpose + endpoint](https://cloud.ibm.com/docs/tone-analyzer?topic=tone-analyzer-utgpe#ut + gpe).
Parameters
i_tone_input JSON, plain text, or HTML input that contains the content to be analyzed. For JSON input, provide an object of type `ToneInput`.
i_content_type The type of the input. A character encoding can be specified by including a - `charset` parameter. For example, 'text/plain;charset=utf-8'. + `charset` parameter. For example, 'text/plain;charset=utf-8'.
i_sentences Indicates whether the service is to return an analysis of each individual sentence in addition to its analysis of the full document. If `true` (the default), the service returns results for each sentence.
i_tones **`2017-09-21`:** Deprecated. The service continues to accept the parameter for - ** backward-compatibility, but the parameter no longer affects the response.
- **
- ****`2016-05-19`:** A comma-separated list of tones for which the service is to - ** return its analysis of the input; the indicated tones apply both to the full - ** document and to individual sentences of the document. You can specify one or - ** more of the valid values. Omit the parameter to request results for all three - ** tones. + backward-compatibility, but the parameter no longer affects the response.
+
+ **`2016-05-19`:** A comma-separated list of tones for which the service is to + return its analysis of the input; the indicated tones apply both to the full + document and to individual sentences of the document. You can specify one or + more of the valid values. Omit the parameter to request results for all three + tones.
i_content_language The language of the input text for the request: English or French. Regional variants are treated as their parent language; for example, `en-US` is @@ -45,7 +82,24 @@ and **Accept-Language**.
e_response Service return value of type T_TONE_ANALYSIS -
public instance
tone_chat
importingi_utterancestype T_TONE_CHAT_INPUT
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_UTTERANCE_ANALYSES
raisingzcx_ibmc_service_exception
 Analyze customer-engagement tone. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
tone_chat
importingi_utterancestype T_TONE_CHAT_INPUT
i_content_languagetype STRING default 'en'
i_accept_languagetype STRING default 'en'
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_UTTERANCE_ANALYSES
raisingzcx_ibmc_service_exception

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.
+
+ If you submit more than 50 utterances, the service returns a warning for the + overall content and analyzes only the first 50 utterances. If you submit a + single utterance that contains more than 500 characters, the service returns an + error for that utterance and does not analyze the utterance. The request fails + if all utterances have more than 500 characters. Per the JSON specification, + the default character encoding for JSON content is effectively always UTF-8. +
+
+ **See also:** [Using the customer-engagement + endpoint](https://cloud.ibm.com/docs/tone-analyzer?topic=tone-analyzer-utco#utc + o).
Parameters
i_utterances An object that contains the content to be analyzed. @@ -64,4 +118,5 @@ and **Accept-Language**.
e_response Service return value of type T_UTTERANCE_ANALYSES -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_util.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_util.html index 1230f65..984577b 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_util.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_util.html @@ -5,7 +5,8 @@ public static
convert_timestamp_to_datetime
importingi_timestamptype TIMESTAMP
returningvalue(e_datetime)type ZCL_IBMC_SERVICE=>DATETIME
Converts a timestamp to datetime format, i.e. YYYYMMDDHHMMSS -> yyyy-mm-ddThh:mm:ssZ
Parameters
i_timestamp Timestamp. -
e_datetimeUTC Time Stamp in Short Form (YYYYMMDDhhmmss)
public static
convert_timestamp_to_local
importingiv_timestamptype TIMESTAMP
returningvalue(ev_local)type STRING
Converts a timestamp in UTC to a timestamp in local time. + e_datetime Datetime format. +public static
convert_timestamp_to_local
importingiv_timestamptype TIMESTAMP
returningvalue(ev_local)type STRING
Converts a timestamp in UTC to a timestamp in local time.
Parameters
iv_timestamp Timestamp (UTC).
ev_local Timestamp (local time). @@ -19,16 +20,17 @@
Parameters
i_itab Internal table to be converted.
i_dictionary Dictionary to be used for mapping ABAP identifiers to JSON keys.
i_lower_case If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case. +
it_excluded_fields Internal table of table fields in I_ITAB that should not occur in result.
e_json JSON string. -
public static
tableschema_to_itab
importingi_jsontype STRING
i_tableschema_keytype STRING optional
exportinge_itabtype ANY TABLE
 Converts a JSON string in table schema format to an internal table. +
public static
tableschema_to_itab
importingi_jsontype STRING
i_tableschema_keytype STRING optional
exportinge_itabtype ANY TABLE
Converts a JSON string in table schema format to an internal table. E.g.: '{"tableschema_key": {"fields": ["PET", "NUMBER"], "values": [["Cat",5],["Rabbit",2]]}}'
Parameters
i_json JSON string.
i_tableschema_key Key in JSON string that holds the table schema.
e_itab Internal table containing converted data. -
public static
utc_to_timezone
importingi_timestamptype TIMESTAMP
i_timezonetype ZIF_IBMC_SERVICE_ARCH=>TY_TIMEZONE optional
returningvalue(e_timestamp)type TIMESTAMP
Converts a timestamp in UTC to a timestamp in another timezone. +public static
utc_to_timezone
importingi_timestamptype TIMESTAMP
i_timezonetype ZIF_IBMC_SERVICE_ARCH=>TY_TIMEZONE optional
returningvalue(e_timestamp)type TIMESTAMP
Converts a timestamp in UTC to a timestamp in another timezone.
Parameters
i_timestamp Timestamp (UTC).
i_timezone Time zone
e_timestamp Timestamp in give time zone. -
\ No newline at end of file + \ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v3.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v3.html index a7c227a..2842bd3 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v3.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v3.html @@ -1,15 +1,35 @@ -Class ZCL_IBMC_VISUAL_RECOGNITION_V3

Class ZCL_IBMC_VISUAL_RECOGNITION_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Visual Recognition

+Class ZCL_IBMC_VISUAL_RECOGNITION_V3

Class ZCL_IBMC_VISUAL_RECOGNITION_V3

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Visual Recognition

The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes and objects in images that you upload to the service. You can create and train a custom classifier to identify subjects that suit your - needs.

Types

Visibility and LevelNameDocumentation
publict_class (structured type) A category within a classifier.
publict_classified_image (structured type) Results for one image.
publict_classified_images (structured type) Results for all images.
publict_classifier (structured type) Information about a classifier.
publict_classifiers (structured type) A container for the list of classifiers.
publict_classifier_result (structured type) Classifier and score combination.
publict_class_result (structured type) Result of a class within a classifier.
publict_confidence_score type FLOAT 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.
publict_custom_classes_processed type INTEGER Number of custom classes identified in the images.
publict_empty type JSONOBJECT Empty object.
publict_error_html (structured type) Error information.
publict_error_info (structured type) Information about what might have caused a failure, such as an image that is too - large. Not returned when there is no error.
publict_error_response (structured type) Error information.
publict_images_processed type INTEGER Number of images processed for the API call.
publict_image_file type STRING Relative path of the image file if uploaded directly. Not returned when the - image is passed by URL.
publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_inline_object2 (structured type) No documentation available.
publict_resolved_url type STRING Fully resolved URL of the image after redirects are followed. Not returned when - the image is uploaded.
publict_source_url type STRING Source of the image before any redirects. Not returned when the image is - uploaded.
publict_type_hierarchy type STRING Knowledge graph of the property. For example, `/fruit/pome/apple/eating - apple/Granny Smith`. Included only if identified.
publict_warning_info (structured type) Information about something that went wrong.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
classify
importingi_images_filetype FILE optional
i_images_filenametype STRING optional
i_images_file_content_typetype STRING optional
i_urltype STRING optional
i_thresholdtype FLOAT optional
i_ownerstype TT_STRING optional
i_classifier_idstype TT_STRING optional
i_accept_languagetype STRING default 'en'
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIED_IMAGES
raisingzcx_ibmc_service_exception
 Classify images. + needs.

Types

Visibility and LevelNameDocumentation
publict_class (structured type)

+ A category within a classifier.

publict_classified_image (structured type)

+ Results for one image.

publict_classified_images (structured type)

+ Results for all images.

publict_classifier (structured type)

+ Information about a classifier.

publict_classifiers (structured type)

+ A container for the list of classifiers.

publict_classifier_result (structured type)

+ Classifier and score combination.

publict_class_result (structured type)

+ Result of a class within a classifier.

publict_confidence_score type FLOAT

+ 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.
publict_custom_classes_processed type INTEGER

+ Number of custom classes identified in the images.

publict_empty type JSONOBJECT

+ Empty object.

publict_error_html (structured type)

+ Error information.

publict_error_info (structured type)

+ Information about what might have caused a failure, such as

+ an image that is too large. Not returned when there is no error.
publict_error_response (structured type)

+ Error information.

publict_images_processed type INTEGER

+ Number of images processed for the API call.

publict_image_file type STRING

+ Relative path of the image file if uploaded directly. Not

+ returned when the image is passed by URL.
publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_inline_object2 (structured type) No documentation available.
publict_resolved_url type STRING

+ Fully resolved URL of the image after redirects are

+ followed. Not returned when the image is uploaded.
publict_source_url type STRING

+ Source of the image before any redirects. Not returned when

+ the image is uploaded.
publict_type_hierarchy type STRING

+ Knowledge graph of the property. For example,

+ `/fruit/pome/apple/eating apple/Granny Smith`. Included only if identified.
publict_warning_info (structured type)

+ Information about something that went wrong.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
classify
importingi_images_filetype FILE optional
i_images_filenametype STRING optional
i_images_file_content_typetype STRING optional
i_urltype STRING optional
i_thresholdtype FLOAT optional
i_ownerstype TT_STRING optional
i_classifier_idstype TT_STRING optional
i_accept_languagetype STRING default 'en'
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIED_IMAGES
raisingzcx_ibmc_service_exception

Classify images

+ Classify images with built-in or custom classifiers.
Parameters
i_images_file An image file (.gif, .jpg, .png, .tif) or .zip file with images. Maximum image @@ -57,7 +77,23 @@ The desired language of parts of the response. See the response for details.
e_response Service return value of type T_CLASSIFIED_IMAGES -
public instance
create_classifier
importingi_nametype STRING
i_positive_examplestype TT_MAP_FILE
i_negative_examplestype FILE optional
i_negative_examples_filenametype STRING optional
i_positive_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_negative_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception
 Create a classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_classifier
importingi_nametype STRING
i_positive_examplestype TT_MAP_FILE
i_negative_examplestype FILE optional
i_negative_examples_filenametype STRING optional
i_positive_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_negative_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception

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.
+
+ **Tips when creating:**
+
+ - If you set the **X-Watson-Learning-Opt-Out** header parameter to `true` when + you create a classifier, the example training images are not stored. Save your + training images locally. For more information, see [Data + collection](#data-collection).
+
+ - Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image + file names, and classifier and class names). The service assumes UTF-8 encoding + if it encounters non-ASCII characters.
Parameters
i_name The name of the new classifier. Encode special characters in UTF-8. @@ -68,7 +104,7 @@ Specify the parameter name by appending `_positive_examples` to the class name. For example, `goldenretriever_positive_examples` creates the class **goldenretriever**. The string cannot contain the following characters: ``$ * - - { } \ | / ' " ` [ ]``.
+ - { } \ | / ' " ` [ ]``.

Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number of images is 10,000 images or @@ -84,34 +120,73 @@ The filename for negativeExamples.
e_response Service return value of type T_CLASSIFIER -
public instance
delete_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
 Delete a classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete a classifier

Parameters
i_classifier_id The ID of the classifier. -
public instance
delete_user_data
importingi_customer_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete labeled data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_user_data
importingi_customer_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_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.
+
+ You associate a customer ID with data by passing the `X-Watson-Metadata` header + with a request that passes data. For more information about personal data and + customer IDs, see [Information + security](https://cloud.ibm.com/docs/visual-recognition?topic=visual-recognitio + n-information-security).
Parameters
i_customer_id The customer ID for which all data is to be deleted. -
public instanceget_appname redefinition public instance
get_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception
Retrieve classifier details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_classifier
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception

Retrieve classifier details

+ Retrieve information about a custom classifier.
Parameters
i_classifier_id The ID of the classifier.
e_response Service return value of type T_CLASSIFIER -
public instance
get_core_ml_model
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/octet-stream'
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception
Retrieve a Core ML model of a classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_core_ml_model
importingi_classifier_idtype STRING
i_accepttype STRING default 'application/octet-stream'
exportinge_responsetype FILE
raisingzcx_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.
Parameters
i_classifier_id The ID of the classifier.
e_response Service return value of type FILE -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_classifiers
importingi_verbosetype BOOLEAN optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIERS
raisingzcx_ibmc_service_exception
Retrieve a list of classifiers. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
list_classifiers
importingi_verbosetype BOOLEAN optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIERS
raisingzcx_ibmc_service_exception

Retrieve a list of classifiers

Parameters
i_verbose Specify `true` to return details about the classifiers. Omit this parameter to return a brief list of classifiers.
e_response Service return value of type T_CLASSIFIERS -
public instance
update_classifier
importingi_classifier_idtype STRING
i_positive_examplestype TT_MAP_FILE optional
i_negative_examplestype FILE optional
i_negative_examples_filenametype STRING optional
i_positive_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_negative_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_ibmc_service_exception
Update a classifier. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_classifier
importingi_classifier_idtype STRING
i_positive_examplestype TT_MAP_FILE optional
i_negative_examplestype FILE optional
i_negative_examples_filenametype STRING optional
i_positive_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_negative_examples_cttype STRING default ZIF_IBMC_SERVICE_ARCH~C_MEDIATYPE-ALL
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_CLASSIFIER
raisingzcx_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).
+
+ Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image + file names, and classifier and class names). The service assumes UTF-8 encoding + if it encounters non-ASCII characters.
+
+ **Tips about retraining:**
+
+ - You can't update the classifier if the **X-Watson-Learning-Opt-Out** + header parameter was set to `true` when the classifier was created. Training + images are not stored in that case. Instead, create another classifier. For + more information, see [Data collection](#data-collection).
+
+ - Don't make retraining calls on a classifier until the status is ready. + When you submit retraining requests in parallel, the last request overwrites + the previous requests. The `retrained` property shows the last time the + classifier retraining finished.
Parameters
i_classifier_id The ID of the classifier. @@ -123,7 +198,7 @@ Specify the parameter name by appending `_positive_examples` to the class name. For example, `goldenretriever_positive_examples` creates the class `goldenretriever`. The string cannot contain the following characters: ``$ * - - { } \ | / ' " ` [ ]``.
+ { } \ | / ' " ` [ ]``.

Include at least 10 images in .jpg or .png format. The minimum recommended image resolution is 32X32 pixels. The maximum number of images is 10,000 images or @@ -139,4 +214,5 @@ The filename for negativeExamples.
e_response Service return value of type T_CLASSIFIER -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v4.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v4.html index f4eef82..b547fa9 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v4.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcl_ibmc_visual_recognition_v4.html @@ -1,6 +1,44 @@ -Class ZCL_IBMC_VISUAL_RECOGNITION_V4

Class ZCL_IBMC_VISUAL_RECOGNITION_V4

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Visual Recognition v4

+Class ZCL_IBMC_VISUAL_RECOGNITION_V4

Class ZCL_IBMC_VISUAL_RECOGNITION_V4

public inheriting from ZCL_IBMC_SERVICE_EXT create public

Documentation

Visual Recognition v4

Provide images to the IBM Watson™ Visual Recognition service for analysis. - The service detects objects based on a set of images with training data.

Types

Visibility and LevelNameDocumentation
publict_analyze_response (structured type) Results for all images.
publict_base_collection (structured type) Base details about a collection.
publict_base_object (structured type) Details about an object and its location.
publict_base_training_data_objects (structured type) Container for the training data.
publict_collection (structured type) Details about a collection.
publict_collections_list (structured type) A container for the list of collections.
publict_collection_objects (structured type) The objects in a collection that are detected in an image.
publict_detected_objects (structured type) Container for the list of collections that have objects detected in an image.
publict_empty type JSONOBJECT Empty response.
publict_error (structured type) Details about an error.
publict_error_response (structured type) A container for the list of request-level problems.
publict_error_target (structured type) Details about the specific area of the problem.
publict_image (structured type) Details about an image.
publict_image_details (structured type) Details about an image.
publict_image_details_list (structured type) List of information about the images.
publict_image_dimensions (structured type) Height and width of an image.
publict_image_source (structured type) The source type of the image.
publict_image_summary (structured type) Basic information about an image.
publict_image_summary_list (structured type) List of images.
publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_jpeg_image type FILE A file returned in the response.
publict_location (structured type) Defines the location of the bounding box around the object.
publict_object_detail (structured type) Details about an object in the collection.
publict_object_metadata (structured type) Basic information about an object.
publict_object_metadata_list (structured type) List of objects.
publict_object_training_status (structured type) Training status for the objects in the collection.
publict_training_data_object (structured type) Details about the training data.
publict_training_data_objects (structured type) Training data for all objects.
publict_training_event (structured type) Details about the training event.
publict_training_events (structured type) Details about the training events.
publict_training_status (structured type) Training status information for the collection.
publict_update_object_metadata (structured type) Basic information about an updated object.
publict_warning (structured type) Details about a problem.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)  
public staticc_required_fields (structured type)  

Methods

Visibility and LevelNameDocumentation
public instance
add_images
importingi_collection_idtype STRING
i_images_filetype TT_FILE_WITH_METADATA optional
i_image_urltype TT_STRING optional
i_training_datatype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IMAGE_DETAILS_LIST
raisingzcx_ibmc_service_exception
 Add images. + The service detects objects based on a set of images with training data.

Types

Visibility and LevelNameDocumentation
publict_analyze_response (structured type)

+ Results for all images.

publict_base_collection (structured type)

+ Base details about a collection.

publict_base_object (structured type)

+ Details about an object and its location.

publict_base_training_data_objects (structured type)

+ Container for the training data.

publict_collection (structured type)

+ Details about a collection.

publict_collections_list (structured type)

+ A container for the list of collections.

publict_collection_objects (structured type)

+ The objects in a collection that are detected in an image.

publict_detected_objects (structured type)

+ Container for the list of collections that have objects

+ detected in an image.
publict_empty type JSONOBJECT

+ Empty response.

publict_error (structured type)

+ Details about an error.

publict_error_response (structured type)

+ A container for the list of request-level problems.

publict_error_target (structured type)

+ Details about the specific area of the problem.

publict_image (structured type)

+ Details about an image.

publict_image_details (structured type)

+ Details about an image.

publict_image_details_list (structured type)

+ List of information about the images.

publict_image_dimensions (structured type)

+ Height and width of an image.

publict_image_source (structured type)

+ The source type of the image.

publict_image_summary (structured type)

+ Basic information about an image.

publict_image_summary_list (structured type)

+ List of images.

publict_inline_object (structured type) No documentation available.
publict_inline_object1 (structured type) No documentation available.
publict_jpeg_image type FILE

+ A file returned in the response.

publict_location (structured type)

+ Defines the location of the bounding box around the object.

publict_object_detail (structured type)

+ Details about an object in the collection.

publict_object_metadata (structured type)

+ Basic information about an object.

publict_object_metadata_list (structured type)

+ List of objects.

publict_object_training_status (structured type)

+ Training status for the objects in the collection.

publict_training_data_object (structured type)

+ Details about the training data.

publict_training_data_objects (structured type)

+ Training data for all objects.

publict_training_event (structured type)

+ Details about the training event.

publict_training_events (structured type)

+ Details about the training events.

publict_training_status (structured type)

+ Training status information for the collection.

publict_update_object_metadata (structured type)

+ Basic information about an updated object.

publict_warning (structured type)

+ Details about a problem.

Constants

Visibility and LevelNameDocumentation
public staticc_abapname_dictionary (structured type)

Map ABAP identifiers to service identifiers.

public staticc_required_fields (structured type)

List of required fields per type.

Methods

Visibility and LevelNameDocumentation
public instance
add_images
importingi_collection_idtype STRING
i_images_filetype TT_FILE_WITH_METADATA optional
i_image_urltype TT_STRING optional
i_training_datatype STRING optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IMAGE_DETAILS_LIST
raisingzcx_ibmc_service_exception

Add images

+ Add images to a collection by URL, by file, or both.
+
+ 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.
Parameters
i_collection_id The identifier of the collection. @@ -29,7 +67,18 @@ longer than 32 characters.
e_response Service return value of type T_IMAGE_DETAILS_LIST -
public instance
add_image_training_data
importingi_collection_idtype STRING
i_image_idtype STRING
i_training_datatype T_BASE_TRAINING_DATA_OBJECTS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_DATA_OBJECTS
raisingzcx_ibmc_service_exception
 Add training data to an image. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
add_image_training_data
importingi_collection_idtype STRING
i_image_idtype STRING
i_training_datatype T_BASE_TRAINING_DATA_OBJECTS
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_DATA_OBJECTS
raisingzcx_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.
+
+ Elements in the request replace the existing elements.
+
+ - To update the training data, provide both the unchanged and the new or changed + values.
+
+ - To delete the training data, provide an empty value for the training data.
Parameters
i_collection_id The identifier of the collection. @@ -39,7 +88,15 @@ Training data. Elements in the request replace the existing elements.
e_response Service return value of type T_TRAINING_DATA_OBJECTS -
public instance
analyze
importingi_collection_idstype TT_STRING
i_featurestype TT_STRING
i_images_filetype TT_FILE_WITH_METADATA optional
i_image_urltype TT_STRING optional
i_thresholdtype FLOAT optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ANALYZE_RESPONSE
raisingzcx_ibmc_service_exception
 Analyze images. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
analyze
importingi_collection_idstype TT_STRING
i_featurestype TT_STRING
i_images_filetype TT_FILE_WITH_METADATA optional
i_image_urltype TT_STRING optional
i_thresholdtype FLOAT optional
i_contenttypetype STRING default 'multipart/form-data'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_ANALYZE_RESPONSE
raisingzcx_ibmc_service_exception

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.
+
+ 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.
Parameters
i_collection_ids The IDs of the collections to analyze. @@ -65,39 +122,67 @@ The minimum score a feature must have to be returned.
e_response Service return value of type T_ANALYZE_RESPONSE -
public instance
create_collection
importingi_collection_infotype T_BASE_COLLECTION
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
Create a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
create_collection
importingi_collection_infotype T_BASE_COLLECTION
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception

Create a collection

+ Create a collection that can be used to store images.
+
+ To create a collection without specifying a name and description, include an + empty JSON object in the request body.
+
+ Encode the name and description in UTF-8 if they contain non-ASCII characters. + The service assumes UTF-8 encoding if it encounters non-ASCII characters.
Parameters
i_collection_info The new collection.
e_response Service return value of type T_COLLECTION -
public instance
delete_collection
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_collection
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete a collection

+ Delete a collection from the service instance.
Parameters
i_collection_id The identifier of the collection. -
public instance
delete_image
importingi_collection_idtype STRING
i_image_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete an image. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_image
importingi_collection_idtype STRING
i_image_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception

Delete an image

+ Delete one image from a collection.
Parameters
i_collection_id The identifier of the collection.
i_image_id The identifier of the image. -
public instance
delete_object
importingi_collection_idtype STRING
i_objecttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete an object. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_object
importingi_collection_idtype STRING
i_objecttype STRING
i_accepttype STRING default 'application/json'
raisingzcx_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.
Parameters
i_collection_id The identifier of the collection.
i_object The name of the object. -
public instance
delete_user_data
importingi_customer_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_ibmc_service_exception
Delete labeled data. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
delete_user_data
importingi_customer_idtype STRING
i_accepttype STRING default 'application/json'
raisingzcx_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.
+
+ You associate a customer ID with data by passing the `X-Watson-Metadata` header + with a request that passes data. For more information about personal data and + customer IDs, see [Information + security](https://cloud.ibm.com/docs/visual-recognition?topic=visual-recognitio + n-information-security).
Parameters
i_customer_id The customer ID for which all data is to be deleted. -
public instanceget_appname redefinition public instance
get_collection
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
Get collection details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_appname redefinition public instance
get_collection
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception

Get collection details

+ Get details of one collection.
Parameters
i_collection_id The identifier of the collection.
e_response Service return value of type T_COLLECTION -
public instance
get_image_details
importingi_collection_idtype STRING
i_image_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IMAGE_DETAILS
raisingzcx_ibmc_service_exception
Get image details. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_image_details
importingi_collection_idtype STRING
i_image_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IMAGE_DETAILS
raisingzcx_ibmc_service_exception

Get image details

+ Get the details of an image in a collection.
Parameters
i_collection_id The identifier of the collection. @@ -105,7 +190,9 @@ The identifier of the image.
e_response Service return value of type T_IMAGE_DETAILS -
public instance
get_jpeg_image
importingi_collection_idtype STRING
i_image_idtype STRING
i_sizetype STRING default 'full'
i_accepttype STRING default 'image/jpeg'
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception
Get a JPEG file of an image. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_jpeg_image
importingi_collection_idtype STRING
i_image_idtype STRING
i_sizetype STRING default 'full'
i_accepttype STRING default 'image/jpeg'
exportinge_responsetype FILE
raisingzcx_ibmc_service_exception

Get a JPEG file of an image

+ Download a JPEG representation of an image.
Parameters
i_collection_id The identifier of the collection. @@ -117,7 +204,9 @@ For example, an original 800 x 1000 image is resized to 160 x 200 pixels.
e_response Service return value of type FILE -
public instance
get_object_metadata
importingi_collection_idtype STRING
i_objecttype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_OBJECT_METADATA
raisingzcx_ibmc_service_exception
Get object metadata. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
get_object_metadata
importingi_collection_idtype STRING
i_objecttype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_OBJECT_METADATA
raisingzcx_ibmc_service_exception

Get object metadata

+ Get the number of bounding boxes for a single object in a collection.
Parameters
i_collection_id The identifier of the collection. @@ -125,7 +214,10 @@ The name of the object.
e_response Service return value of type T_OBJECT_METADATA -
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_training_usage
importingi_start_timetype STRING optional
i_end_timetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EVENTS
raisingzcx_ibmc_service_exception
Get training usage. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instanceget_request_prop redefinition public instanceget_sdk_version_date redefinition public instance
get_training_usage
importingi_start_timetype STRING optional
i_end_timetype STRING optional
i_accepttype STRING default 'application/json'
exportinge_responsetype T_TRAINING_EVENTS
raisingzcx_ibmc_service_exception

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.
Parameters
i_start_time The earliest day to include training events. Specify dates in YYYY-MM-DD format. @@ -137,29 +229,45 @@ for a single day.
e_response Service return value of type T_TRAINING_EVENTS -
public instance
list_collections
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTIONS_LIST
raisingzcx_ibmc_service_exception
List collections. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_collections
importingi_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTIONS_LIST
raisingzcx_ibmc_service_exception

List collections

+ Retrieves a list of collections for the service instance.
Parameters
e_response Service return value of type T_COLLECTIONS_LIST -
public instance
list_images
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IMAGE_SUMMARY_LIST
raisingzcx_ibmc_service_exception
List images. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_images
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_IMAGE_SUMMARY_LIST
raisingzcx_ibmc_service_exception

List images

+ Retrieves a list of images in a collection.
Parameters
i_collection_id The identifier of the collection.
e_response Service return value of type T_IMAGE_SUMMARY_LIST -
public instance
list_object_metadata
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_OBJECT_METADATA_LIST
raisingzcx_ibmc_service_exception
List object metadata. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
list_object_metadata
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_OBJECT_METADATA_LIST
raisingzcx_ibmc_service_exception

List object metadata

+ Retrieves a list of object names in a collection.
Parameters
i_collection_id The identifier of the collection.
e_response Service return value of type T_OBJECT_METADATA_LIST -
public instance
train
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
Train a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
train
importingi_collection_idtype STRING
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_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.
Parameters
i_collection_id The identifier of the collection.
e_response Service return value of type T_COLLECTION -
public instance
update_collection
importingi_collection_idtype STRING
i_collection_infotype T_BASE_COLLECTION optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception
Update a collection. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_collection
importingi_collection_idtype STRING
i_collection_infotype T_BASE_COLLECTION optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_COLLECTION
raisingzcx_ibmc_service_exception

Update a collection

+ Update the name or description of a collection.
+
+ Encode the name and description in UTF-8 if they contain non-ASCII characters. + The service assumes UTF-8 encoding if it encounters non-ASCII characters.
Parameters
i_collection_id The identifier of the collection. @@ -167,7 +275,10 @@ The updated collection.
e_response Service return value of type T_COLLECTION -
public instance
update_object_metadata
importingi_collection_idtype STRING
i_objecttype STRING
i_updateobjectmetadatatype T_UPDATE_OBJECT_METADATA optional
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_UPDATE_OBJECT_METADATA
raisingzcx_ibmc_service_exception
Update an object name. +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
public instance
update_object_metadata
importingi_collection_idtype STRING
i_objecttype STRING
i_updateobjectmetadatatype T_UPDATE_OBJECT_METADATA
i_contenttypetype STRING default 'application/json'
i_accepttype STRING default 'application/json'
exportinge_responsetype T_UPDATE_OBJECT_METADATA
raisingzcx_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.
Parameters
i_collection_id The identifier of the collection. @@ -177,4 +288,5 @@ No documentation available.
e_response Service return value of type T_UPDATE_OBJECT_METADATA -
\ No newline at end of file +
Class-based Exceptions
zcx_ibmc_service_exception Exception being raised in case of an error. +
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/classes/zcx_ibmc_service_exception.html b/docs/ABAPDoc/abapdoc/zibmc/classes/zcx_ibmc_service_exception.html index 19bc4e8..fa49b9c 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/classes/zcx_ibmc_service_exception.html +++ b/docs/ABAPDoc/abapdoc/zibmc/classes/zcx_ibmc_service_exception.html @@ -1 +1 @@ -Class ZCX_IBMC_SERVICE_EXCEPTION

Class ZCX_IBMC_SERVICE_EXCEPTION

public inheriting from CX_STATIC_CHECK final create public

Documentation

IBM Cloud Service Exception

Interfaces

if_t100_dyn_msg
if_t100_message

Attributes

Visibility and LevelNameDocumentation
public instancep_http_reason type STRING  
public instancep_http_status type STRING  
public instancep_msg_json type STRING  

Methods

Visibility and LevelNameDocumentation
public instance
constructor
importingtextidlike IF_T100_MESSAGE=>T100KEY optional
previouslike PREVIOUS optional
p_msg_jsontype STRING optional
p_http_statustype STRING optional
p_http_reasontype STRING optional
CONSTRUCTOR
public instanceif_message~get_longtext redefinition 
public instanceif_message~get_text redefinition 
\ No newline at end of file +Class ZCX_IBMC_SERVICE_EXCEPTION

Class ZCX_IBMC_SERVICE_EXCEPTION

public inheriting from CX_STATIC_CHECK final create public

Documentation

IBM Cloud Service Exception

Interfaces

if_t100_dyn_msg
if_t100_message

Attributes

Visibility and LevelNameDocumentation
public instancep_http_reason type STRING  
public instancep_http_status type STRING  
public instancep_msg_json type STRING  

Methods

Visibility and LevelNameDocumentation
public instance
constructor
importingtextidlike IF_T100_MESSAGE=>T100KEY optional
previouslike PREVIOUS optional
p_msg_jsontype STRING optional
p_http_statustype STRING optional
p_http_reasontype STRING optional
CONSTRUCTOR
public instanceif_message~get_longtext redefinition 
public instanceif_message~get_text redefinition 
\ No newline at end of file diff --git a/docs/ABAPDoc/abapdoc/zibmc/interfaces/zif_ibmc_service_arch.html b/docs/ABAPDoc/abapdoc/zibmc/interfaces/zif_ibmc_service_arch.html index f6454d4..73704a7 100644 --- a/docs/ABAPDoc/abapdoc/zibmc/interfaces/zif_ibmc_service_arch.html +++ b/docs/ABAPDoc/abapdoc/zibmc/interfaces/zif_ibmc_service_arch.html @@ -1 +1 @@ -Interface ZIF_IBMC_SERVICE_ARCH

Interface ZIF_IBMC_SERVICE_ARCH

public

Documentation

IBM Watson SDK Platform-specifics

Types

Visibility and LevelNameDocumentation
publicboolean (typing) 
publicchar (typing) 
publicts_access_token (structured type) 
publicts_form_part (structured type) 
publicts_header (structured type) 
publicts_http_status (structured type) 
publicts_request_prop (structured type) 
publicts_url (structured type) 
publictt_form_part TYPE standard table of TS_FORM_PART with non-unique default key 
publictt_header TYPE standard table of ts_header with non-unique default key 
publictt_string TYPE standard table of string with non-unique default key 
publicty_ssl_id (typing) 
publicty_timezone (typing) 

Constants

Visibility and LevelNameDocumentation
public staticc_datatype (structured type)  
public staticc_header_accept type STRING value 'Accept' 
public staticc_header_content_disposition type STRING value 'Content-Disposition' 
public staticc_header_content_type type STRING value 'Content-Type' 
public staticc_mediatype (structured type)  
public staticc_method_create type CHAR value 'c' 
public staticc_method_delete type CHAR value 'd' 
public staticc_method_get type CHAR value 'g' 
public staticc_method_post type CHAR value 'p' 
public staticc_method_put type CHAR value 'u' 
\ No newline at end of file +Interface ZIF_IBMC_SERVICE_ARCH

Interface ZIF_IBMC_SERVICE_ARCH

public

Documentation

IBM Watson SDK Platform-specifics

Types

Visibility and LevelNameDocumentation
publicboolean (typing) 
publicchar (typing) 
publicts_access_token (structured type) 
publicts_form_part (structured type) 
publicts_header (structured type) 
publicts_http_status (structured type) 
publicts_request_prop (structured type) 
publicts_url (structured type) 
publictt_form_part TYPE standard table of TS_FORM_PART with non-unique default key 
publictt_header TYPE standard table of ts_header with non-unique default key 
publictt_string TYPE standard table of string with non-unique default key 
publicty_ssl_id (typing) 
publicty_timezone (typing) 

Constants

Visibility and LevelNameDocumentation
public staticc_datatype (structured type)  
public staticc_header_accept type STRING value 'Accept' 
public staticc_header_content_disposition type STRING value 'Content-Disposition' 
public staticc_header_content_type type STRING value 'Content-Type' 
public staticc_mediatype (structured type)  
public staticc_method_create type CHAR value 'c' 
public staticc_method_delete type CHAR value 'd' 
public staticc_method_get type CHAR value 'g' 
public staticc_method_post type CHAR value 'p' 
public staticc_method_put type CHAR value 'u' 
\ No newline at end of file diff --git a/docs/ABAPDoc/htmldesign/stylesheet.css b/docs/ABAPDoc/htmldesign/stylesheet.css index 30680b5..94a261c 100644 --- a/docs/ABAPDoc/htmldesign/stylesheet.css +++ b/docs/ABAPDoc/htmldesign/stylesheet.css @@ -27,4 +27,4 @@ a { color: black; } .exceptions { border: 0px; width: auto; } .exceptions td { border: 0px; padding: 0px; padding-top: 0px; padding-bottom: 0px; padding-left: 0px; padding-right: 5px; } .abapDocComment p { margin-top: 0px; } -.shorttext { margin-top: 0px; } \ No newline at end of file +.shorttext { margin-top: 0px; margin-bottom: 0px; } \ No newline at end of file diff --git a/src/zcl_ibmc_assistant_v1.clas.abap b/src/zcl_ibmc_assistant_v1.clas.abap index 12fa523..3ca7e71 100644 --- a/src/zcl_ibmc_assistant_v1.clas.abap +++ b/src/zcl_ibmc_assistant_v1.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Watson Assistant v1

+"!

Watson Assistant v1

"! The IBM Watson™ Assistant service combines machine learning, natural "! language understanding, and an integrated dialog editor to create conversation "! flows between your apps and your users.
@@ -25,32 +25,33 @@ class ZCL_IBMC_ASSISTANT_V1 DEFINITION public section. types: - "! Workspace settings related to detection of irrelevant input. + "!

+ "! Workspace settings related to detection of irrelevant input.

begin of T_WS_SYSTEM_SETTINGS_OFF_TOPIC, "! Whether enhanced irrelevance detection is enabled for the workspace. ENABLED type BOOLEAN, end of T_WS_SYSTEM_SETTINGS_OFF_TOPIC. types: - "! No documentation available. + "! No documentation available. begin of T_RT_ENTITY_INTERPRETATION, "! The calendar used to represent a recognized date (for example, `Gregorian`). CALENDAR_TYPE type STRING, "! A unique identifier used to associate a recognized 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). + "! 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. + "! 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. + "! 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`). + "! 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 @@ -96,7 +97,7 @@ public section. "! `rational`). SUBTYPE type STRING, "! A recognized term for a time that was mentioned as a part of the day in the - "! user's input (for example, `morning` or `afternoon`). + "! user's input (for example, `morning` or `afternoon`). PART_OF_DAY type STRING, "! A recognized mention of a relative hour, represented numerically as an offset "! from the current hour (for example, `3` for `in three hours` or `-1` for `an @@ -123,7 +124,8 @@ public section. TIMEZONE type STRING, end of T_RT_ENTITY_INTERPRETATION. types: - "! A key/value pair defining an HTTP header and a value. + "!

+ "! A key/value pair defining an HTTP header and a value.

begin of T_WEBHOOK_HEADER, "! The name of an HTTP header (for example, `Authorization`). NAME type STRING, @@ -131,7 +133,7 @@ public section. VALUE type STRING, end of T_WEBHOOK_HEADER. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_NODE_ACTION, "! The name of the action. NAME type STRING, @@ -146,9 +148,11 @@ public section. CREDENTIALS type STRING, end of T_DIALOG_NODE_ACTION. types: - "! Workspace settings related to the disambiguation feature.
- "!
- "! **Note:** This feature is available only to Plus and Premium users. + "!

+ "! Workspace settings related to the disambiguation

+ "! feature.
+ "!
+ "! **Note:** This feature is available only to Plus and Premium users. begin of T_WS_SYSTM_STTNGS_DSMBGTN, "! The text of the introductory prompt that accompanies disambiguation options "! presented to the user. @@ -173,7 +177,8 @@ public section. SUGGESTION_TEXT_POLICY type STRING, end of T_WS_SYSTM_STTNGS_DSMBGTN. types: - "! Options that modify how specified output is handled. + "!

+ "! Options that modify how specified output is handled.

begin of T_DIALOG_NODE_OUTPUT_MODIFIERS, "! Whether values in the output will overwrite output values in an array specified "! by previously executed dialog nodes. If this option is set to `false`, new @@ -181,7 +186,8 @@ public section. OVERWRITE type BOOLEAN, end of T_DIALOG_NODE_OUTPUT_MODIFIERS. types: - "! The next step to execute following this dialog node. + "!

+ "! The next step to execute following this dialog node.

begin of T_DIALOG_NODE_NEXT_STEP, "! What happens after the dialog node completes. The valid values depend on the "! node type:
@@ -212,14 +218,16 @@ public section. SELECTOR type STRING, end of T_DIALOG_NODE_NEXT_STEP. types: - "! An input object that includes the input text. + "!

+ "! An input object that includes the input text.

begin of T_MESSAGE_INPUT, "! The text of the user input. This string cannot contain carriage return, newline, "! or tab characters. TEXT type STRING, end of T_MESSAGE_INPUT. types: - "! A recognized capture group for a pattern-based entity. + "!

+ "! A recognized capture group for a pattern-based entity.

begin of T_CAPTURE_GROUP, "! A recognized capture group for the entity. GROUP type STRING, @@ -228,15 +236,18 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, end of T_CAPTURE_GROUP. types: - "! An object describing the role played by a system entity that is specifies the - "! beginning or end of a range recognized in the user input. This property is - "! included only if the new system entities are enabled for the workspace. + "!

+ "! An object describing the role played by a system entity that

+ "! is specifies the beginning or end of a range recognized in the user input. This + "! property is included only if the new system entities are enabled for the + "! workspace. begin of T_RUNTIME_ENTITY_ROLE, "! The relationship of the entity to the range. TYPE type STRING, end of T_RUNTIME_ENTITY_ROLE. types: - "! A term from the request that was identified as an entity. + "!

+ "! A term from the request that was identified as an entity.

begin of T_RUNTIME_ENTITY, "! An entity detected in the input. ENTITY type STRING, @@ -245,7 +256,7 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, "! The entity value that was recognized in the user input. VALUE type STRING, - "! A decimal percentage that represents Watson's confidence in the recognized + "! A decimal percentage that represents Watson's confidence in the recognized "! entity. CONFIDENCE type NUMBER, "! Any metadata for the entity. @@ -266,16 +277,18 @@ public section. ROLE type T_RUNTIME_ENTITY_ROLE, end of T_RUNTIME_ENTITY. types: - "! An intent identified in the user input. + "!

+ "! An intent identified in the user input.

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. CONFIDENCE type DOUBLE, end of T_RUNTIME_INTENT. types: - "! An object defining the message input to be sent to the Watson Assistant service - "! if the user selects the corresponding option. + "!

+ "! An object defining the message input to be sent to the

+ "! Watson Assistant service if the user selects the corresponding option. begin of T_DIA_ND_OUTPUT_OPT_ELEM_VALUE, "! An input object that includes the input text. INPUT type T_MESSAGE_INPUT, @@ -291,7 +304,7 @@ public section. ENTITIES type STANDARD TABLE OF T_RUNTIME_ENTITY WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OUTPUT_OPT_ELEM_VALUE. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_NODE_OUTPUT_OPT_ELEMENT, "! The user-facing label for the option. LABEL type STRING, @@ -300,14 +313,14 @@ public section. VALUE type T_DIA_ND_OUTPUT_OPT_ELEM_VALUE, end of T_DIA_NODE_OUTPUT_OPT_ELEMENT. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OTPT_TEXT_VALUES_ELEM, "! The text of a response. This string can include newline characters (`\n`), "! Markdown tagging, or other special characters, if supported by the channel. TEXT type STRING, end of T_DIA_ND_OTPT_TEXT_VALUES_ELEM. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_NODE_OUTPUT_GENERIC, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel.
@@ -327,9 +340,9 @@ public section. "! How long to pause, in milliseconds. The valid values are from 0 to 10000. Valid "! only when **response_type**=`pause`. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. Ignored if the - "! channel does not support this event. Valid only when **response_type**=`pause`. - "! + "! Whether to send a "user is typing" event during the pause. Ignored if + "! the channel does not support this event. Valid only when + "! **response_type**=`pause`. TYPING type BOOLEAN, "! The URL of the image. Required when **response_type**=`image`. SOURCE type STRING, @@ -365,10 +378,11 @@ public section. DISCOVERY_VERSION type STRING, end of T_DIALOG_NODE_OUTPUT_GENERIC. types: - "! The output of the dialog node. For more information about how to specify dialog - "! node output, see the - "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-ove - "! rview#dialog-overview-responses). + "!

+ "! The output of the dialog node. For more information about

+ "! how to specify dialog node output, see the + "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-ove + "! rview#dialog-overview-responses). begin of T_DIALOG_NODE_OUTPUT, "! An array of objects describing the output defined for the dialog node. GENERIC type STANDARD TABLE OF T_DIALOG_NODE_OUTPUT_GENERIC WITH NON-UNIQUE DEFAULT KEY, @@ -376,7 +390,7 @@ public section. MODIFIERS type T_DIALOG_NODE_OUTPUT_MODIFIERS, end of T_DIALOG_NODE_OUTPUT. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_NODE, "! The dialog node ID. This string must conform to the following restrictions:
"! - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot @@ -437,7 +451,7 @@ public section. UPDATED type DATETIME, end of T_DIALOG_NODE. types: - "! No documentation available. + "! No documentation available. begin of T_VALUE, "! The text of the entity value. This string must conform to the following "! restrictions:
@@ -466,10 +480,11 @@ public section. UPDATED type DATETIME, end of T_VALUE. types: - "! A webhook that can be used by dialog nodes to make programmatic calls to an - "! external function.
- "!
- "! **Note:** Currently, only a single webhook named `main_webhook` is supported. + "!

+ "! A webhook that can be used by dialog nodes to make

+ "! programmatic calls to an external function.
+ "!
+ "! **Note:** Currently, only a single webhook named `main_webhook` is supported. begin of T_WEBHOOK, "! The URL for the external service or application to which you want to send HTTP "! POST requests. @@ -480,13 +495,16 @@ public section. HEADERS type STANDARD TABLE OF T_WEBHOOK_HEADER WITH NON-UNIQUE DEFAULT KEY, end of T_WEBHOOK. types: - "! Workspace settings related to the behavior of system entities. + "!

+ "! Workspace settings related to the behavior of system

+ "! entities. begin of T_WS_SYSTM_STTNGS_SYSTM_ENTTS, "! Whether the new system entities are enabled for the workspace. ENABLED type BOOLEAN, end of T_WS_SYSTM_STTNGS_SYSTM_ENTTS. types: - "! A mention of a contextual entity. + "!

+ "! A mention of a contextual entity.

begin of T_MENTION, "! The name of the entity. ENTITY type STRING, @@ -495,7 +513,7 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, end of T_MENTION. types: - "! No documentation available. + "! No documentation available. begin of T_EXAMPLE, "! The text of a user input example. This string must conform to the following "! restrictions:
@@ -510,7 +528,7 @@ public section. UPDATED type DATETIME, end of T_EXAMPLE. types: - "! No documentation available. + "! No documentation available. begin of T_INTENT, "! The name of the intent. This string must conform to the following "! restrictions:
@@ -529,14 +547,17 @@ public section. EXAMPLES type STANDARD TABLE OF T_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, end of T_INTENT. types: - "! Workspace settings related to the Watson Assistant user interface. + "!

+ "! Workspace settings related to the Watson Assistant user

+ "! interface. begin of T_WS_SYSTEM_SETTINGS_TOOLING, "! Whether the dialog JSON editor displays text responses within the "! `output.generic` object. STORE_GENERIC_RESPONSES type BOOLEAN, end of T_WS_SYSTEM_SETTINGS_TOOLING. types: - "! Global settings for the workspace. + "!

+ "! Global settings for the workspace.

begin of T_WORKSPACE_SYSTEM_SETTINGS, "! Workspace settings related to the Watson Assistant user interface. TOOLING type T_WS_SYSTEM_SETTINGS_TOOLING, @@ -552,7 +573,7 @@ public section. OFF_TOPIC type T_WS_SYSTEM_SETTINGS_OFF_TOPIC, end of T_WORKSPACE_SYSTEM_SETTINGS. types: - "! No documentation available. + "! No documentation available. begin of T_COUNTEREXAMPLE, "! The text of a user input marked as irrelevant input. This string must conform to "! the following restrictions:
@@ -565,7 +586,7 @@ public section. UPDATED type DATETIME, end of T_COUNTEREXAMPLE. types: - "! No documentation available. + "! No documentation available. begin of T_ENTITY, "! The name of the entity. This string must conform to the following "! restrictions:
@@ -590,7 +611,7 @@ public section. VALUES type STANDARD TABLE OF T_VALUE WITH NON-UNIQUE DEFAULT KEY, end of T_ENTITY. types: - "! No documentation available. + "! No documentation available. begin of T_WORKSPACE, "! The name of the workspace. This string cannot contain carriage return, newline, "! or tab characters. @@ -628,7 +649,7 @@ public section. WEBHOOKS type STANDARD TABLE OF T_WEBHOOK WITH NON-UNIQUE DEFAULT KEY, end of T_WORKSPACE. types: - "! No documentation available. + "! No documentation available. begin of T_SYNONYM, "! The text of the synonym. This string must conform to the following "! restrictions:
@@ -641,7 +662,8 @@ public section. UPDATED type DATETIME, end of T_SYNONYM. types: - "! The pagination data for the returned objects. + "!

+ "! The pagination data for the returned objects.

begin of T_PAGINATION, "! The URL that will return the same page of results. REFRESH_URL type STRING, @@ -657,7 +679,7 @@ public section. NEXT_CURSOR type STRING, end of T_PAGINATION. types: - "! No documentation available. + "! No documentation available. begin of T_SYNONYM_COLLECTION, "! An array of synonyms. SYNONYMS type STANDARD TABLE OF T_SYNONYM WITH NON-UNIQUE DEFAULT KEY, @@ -665,7 +687,7 @@ public section. PAGINATION type T_PAGINATION, end of T_SYNONYM_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_OPTION, "! The title or introductory text to show before the response. TITLE type STRING, @@ -677,7 +699,7 @@ public section. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_OPTION. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OUTPUT_RESP_TYPE_TEXT, "! A list of one or more objects defining text responses. Required when "! **response_type**=`text`. @@ -690,7 +712,7 @@ public section. DELIMITER type STRING, end of T_DIA_ND_OUTPUT_RESP_TYPE_TEXT. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_WORKSPACE, "! The name of the workspace. This string cannot contain carriage return, newline, "! or tab characters. @@ -718,7 +740,7 @@ public section. UPDATED type DATETIME, end of T_BASE_WORKSPACE. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_ENTITY, "! The name of the entity. This string must conform to the following "! restrictions:
@@ -739,29 +761,29 @@ public section. UPDATED type DATETIME, end of T_BASE_ENTITY. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_TEXT, "! The text of the response. TEXT type STRING, end of T_RUNTIME_RESPONSE_TYPE_TEXT. types: - "! No documentation available. + "! No documentation available. begin of T_RT_ENTTY_INTRPRTTN_SYS_TIME, "! A unique identifier used to associate a recognized 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). + "! at 5`, the same **datetime_link** value is returned for both the + "! `@sys-date` and `@sys-time` entities). DATETIME_LINK type STRING, - "! The precision or duration of a time range specified by a recognized `@sys-time` - "! or `@sys-date` entity. + "! The precision or duration of a time range specified by a recognized + "! `@sys-time` or `@sys-date` entity. GRANULARITY type STRING, "! A recognized term for a time that was mentioned as a part of the day in the - "! user's input (for example, `morning` or `afternoon`). + "! user's input (for example, `morning` or `afternoon`). PART_OF_DAY 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`). + "! 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, "! A recognized mention of a relative hour, represented numerically as an offset "! from the current hour (for example, `3` for `in three hours` or `-1` for `an @@ -788,7 +810,7 @@ public section. TIMEZONE type STRING, end of T_RT_ENTTY_INTRPRTTN_SYS_TIME. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_EXAMPLE, "! The text of the user input example. This string must conform to the following "! restrictions:
@@ -803,7 +825,8 @@ public section. UPDATED type DATETIME, end of T_UPDATE_EXAMPLE. types: - "! An object describing a contextual entity mention. + "!

+ "! An object describing a contextual entity mention.

begin of T_ENTITY_MENTION, "! The text of the user input example. TEXT type STRING, @@ -814,7 +837,7 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, end of T_ENTITY_MENTION. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OTPT_RESP_TYP_SRCH_S1, "! The text of the search query. This can be either a natural-language query or a "! query that uses the Discovery query language syntax, depending on the value of @@ -833,7 +856,7 @@ public section. DISCOVERY_VERSION type STRING, end of T_DIA_ND_OTPT_RESP_TYP_SRCH_S1. types: - "! No documentation available. + "! No documentation available. begin of T_EXAMPLE_COLLECTION, "! An array of objects describing the examples defined for the intent. EXAMPLES type STANDARD TABLE OF T_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, @@ -841,7 +864,8 @@ public section. PAGINATION type T_PAGINATION, end of T_EXAMPLE_COLLECTION. types: - "! The pagination data for the returned objects. + "!

+ "! The pagination data for the returned objects.

begin of T_LOG_PAGINATION, "! The URL that will return the next page of results, if any. NEXT_URL type STRING, @@ -851,7 +875,7 @@ public section. NEXT_CURSOR type STRING, end of T_LOG_PAGINATION. types: - "! No documentation available. + "! No documentation available. begin of T_RT_RESP_TYP_CONNECT_TO_AGENT, "! A message to be sent to the human agent who will be taking over the "! conversation. @@ -860,12 +884,12 @@ public section. "! **user_label** property of the relevant node. TOPIC type STRING, "! The 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 + "! **topic** property is populated using the value of the dialog node's "! **user_label** property. DIALOG_NODE type STRING, end of T_RT_RESP_TYP_CONNECT_TO_AGENT. types: - "! No documentation available. + "! No documentation available. begin of T_CREATE_VALUE, "! The text of the entity value. This string must conform to the following "! restrictions:
@@ -894,7 +918,7 @@ public section. UPDATED type DATETIME, end of T_CREATE_VALUE. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_NODE_VISITED_DETAILS, "! A dialog node that was triggered during processing of the input message. DIALOG_NODE type STRING, @@ -904,7 +928,7 @@ public section. CONDITIONS type STRING, end of T_DIALOG_NODE_VISITED_DETAILS. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_SUGGESTION_RESP_GENERIC, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel.
@@ -918,7 +942,7 @@ public section. TEXT type STRING, "! How long to pause, in milliseconds. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. + "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, "! The URL of the image. SOURCE type STRING, @@ -937,14 +961,15 @@ public section. "! **user_label** property of the relevant node. TOPIC type STRING, "! The 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 + "! **topic** property is populated using the value of the dialog node's "! **user_label** property. DIALOG_NODE type STRING, end of T_DIA_SUGGESTION_RESP_GENERIC. types: - "! 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. + "!

+ "! 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. begin of T_DIALOG_SUGGESTION_VALUE, "! An input object that includes the input text. INPUT type T_MESSAGE_INPUT, @@ -954,8 +979,9 @@ public section. ENTITIES type STANDARD TABLE OF T_RUNTIME_ENTITY WITH NON-UNIQUE DEFAULT KEY, end of T_DIALOG_SUGGESTION_VALUE. types: - "! The dialog output that will be returned from the Watson Assistant service if the - "! user selects the corresponding option. + "!

+ "! The dialog output that will be returned from the Watson

+ "! Assistant service if the user selects the corresponding option. begin of T_DIALOG_SUGGESTION_OUTPUT, "! An array of the nodes that were triggered to create the response, in the order "! in which they were visited. This information is useful for debugging and for @@ -972,7 +998,7 @@ public section. GENERIC type STANDARD TABLE OF T_DIA_SUGGESTION_RESP_GENERIC WITH NON-UNIQUE DEFAULT KEY, end of T_DIALOG_SUGGESTION_OUTPUT. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_SUGGESTION, "! The user-facing label for the disambiguation option. This label is taken from "! the **title** or **user_label** property of the corresponding dialog node, @@ -986,15 +1012,15 @@ public section. "! user selects the corresponding option. OUTPUT type T_DIALOG_SUGGESTION_OUTPUT, "! The ID of the dialog node that the **label** property is taken from. The - "! **label** property is populated using the value of the dialog node's + "! **label** property is populated using the value of the dialog node's "! **user_label** property. DIALOG_NODE type STRING, end of T_DIALOG_SUGGESTION. types: - "! No documentation available. + "! No documentation available. T_EMPTY_RESPONSE type JSONOBJECT. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_VALUE, "! The text of the entity value. This string must conform to the following "! restrictions:
@@ -1023,16 +1049,17 @@ public section. UPDATED type DATETIME, end of T_UPDATE_VALUE. types: - "! An alternative value for the recognized entity. + "!

+ "! An alternative value for the recognized entity.

begin of T_RUNTIME_ENTITY_ALTERNATIVE, "! The entity value that was recognized in the user input. VALUE type STRING, - "! A decimal percentage that represents Watson's confidence in the recognized + "! A decimal percentage that represents Watson's confidence in the recognized "! entity. CONFIDENCE type NUMBER, end of T_RUNTIME_ENTITY_ALTERNATIVE. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_INTENT, "! The name of the intent. This string must conform to the following "! restrictions:
@@ -1051,7 +1078,7 @@ public section. EXAMPLES type STANDARD TABLE OF T_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, end of T_UPDATE_INTENT. types: - "! No documentation available. + "! No documentation available. begin of T_VALUE_COLLECTION, "! An array of entity values. VALUES type STANDARD TABLE OF T_VALUE WITH NON-UNIQUE DEFAULT KEY, @@ -1059,7 +1086,8 @@ public section. PAGINATION type T_PAGINATION, end of T_VALUE_COLLECTION. types: - "! Log message details. + "!

+ "! Log message details.

begin of T_LOG_MESSAGE, "! The severity of the log message. LEVEL type STRING, @@ -1067,7 +1095,7 @@ public section. MSG type STRING, end of T_LOG_MESSAGE. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_GENERIC, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel.
@@ -1079,7 +1107,7 @@ public section. TEXT type STRING, "! How long to pause, in milliseconds. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. + "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, "! The URL of the image. SOURCE type STRING, @@ -1098,7 +1126,7 @@ public section. "! **user_label** property of the relevant node. TOPIC type STRING, "! The 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 + "! **topic** property is populated using the value of the dialog node's "! **user_label** property. DIALOG_NODE type STRING, "! An array of objects describing the possible matching dialog nodes from which the @@ -1109,8 +1137,9 @@ public section. SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_GENERIC. types: - "! An output object that includes the response to the user, the dialog nodes that - "! were triggered, and messages from the log. + "!

+ "! An output object that includes the response to the user, the

+ "! dialog nodes that were triggered, and messages from the log. begin of T_OUTPUT_DATA, "! An array of the nodes that were triggered to create the response, in the order "! in which they were visited. This information is useful for debugging and for @@ -1129,7 +1158,8 @@ public section. GENERIC type STANDARD TABLE OF T_RUNTIME_RESPONSE_GENERIC WITH NON-UNIQUE DEFAULT KEY, end of T_OUTPUT_DATA. types: - "! An array of dialog nodes. + "!

+ "! An array of dialog nodes.

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, @@ -1137,10 +1167,12 @@ public section. PAGINATION type T_PAGINATION, end of T_DIALOG_NODE_COLLECTION. types: - "! For internal use only. + "!

+ "! For internal use only.

T_SYSTEM_RESPONSE type MAP. types: - "! Metadata related to the message. + "!

+ "! Metadata related to the message.

begin of T_MESSAGE_CONTEXT_METADATA, "! A label identifying the deployment environment, used for filtering log data. "! This string cannot contain carriage return, newline, or tab characters. @@ -1153,8 +1185,9 @@ public section. USER_ID type STRING, end of T_MESSAGE_CONTEXT_METADATA. types: - "! State information for the conversation. To maintain state, include the context - "! from the previous response. + "!

+ "! State information for the conversation. To maintain state,

+ "! include the context from the previous response. begin of T_CONTEXT, "! The unique identifier of the conversation. CONVERSATION_ID type STRING, @@ -1164,8 +1197,9 @@ public section. METADATA type T_MESSAGE_CONTEXT_METADATA, end of T_CONTEXT. types: - "! The response sent by the workspace, including the output text, detected intents - "! and entities, and context. + "!

+ "! The response sent by the workspace, including the output

+ "! text, detected intents and entities, and context. begin of T_MESSAGE_RESPONSE, "! An input object that includes the input text. INPUT type T_MESSAGE_INPUT, @@ -1187,7 +1221,7 @@ public section. ACTIONS type STANDARD TABLE OF T_DIALOG_NODE_ACTION WITH NON-UNIQUE DEFAULT KEY, end of T_MESSAGE_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_VALUE, "! The text of the entity value. This string must conform to the following "! restrictions:
@@ -1216,7 +1250,7 @@ public section. UPDATED type DATETIME, end of T_BASE_VALUE. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_ENTITY, "! The name of the entity. This string must conform to the following "! restrictions:
@@ -1239,7 +1273,7 @@ public section. VALUES type STANDARD TABLE OF T_CREATE_VALUE WITH NON-UNIQUE DEFAULT KEY, end of T_UPDATE_ENTITY. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_DIALOG_NODE, "! The dialog node ID. This string must conform to the following restrictions:
"! - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot @@ -1300,22 +1334,22 @@ public section. UPDATED type DATETIME, end of T_UPDATE_DIALOG_NODE. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_PAUSE, "! How long to pause, in milliseconds. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. + "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, end of T_RUNTIME_RESPONSE_TYPE_PAUSE. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OTPT_RESP_TYP_CNNCT_1, "! An optional message to be sent to the human agent who will be taking over the "! conversation. Valid only when **reponse_type**=`connect_to_agent`. MESSAGE_TO_HUMAN_AGENT type STRING, end of T_DIA_ND_OTPT_RESP_TYP_CNNCT_1. types: - "! No documentation available. + "! No documentation available. begin of T_ERROR_DETAIL, "! Description of a specific constraint violation. MESSAGE type STRING, @@ -1323,7 +1357,7 @@ public section. PATH type STRING, end of T_ERROR_DETAIL. types: - "! No documentation available. + "! No documentation available. begin of T_CREATE_INTENT, "! The name of the intent. This string must conform to the following "! restrictions:
@@ -1342,7 +1376,7 @@ public section. EXAMPLES type STANDARD TABLE OF T_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, end of T_CREATE_INTENT. types: - "! No documentation available. + "! No documentation available. begin of T_CREATE_ENTITY, "! The name of the entity. This string must conform to the following "! restrictions:
@@ -1367,7 +1401,7 @@ public section. VALUES type STANDARD TABLE OF T_CREATE_VALUE WITH NON-UNIQUE DEFAULT KEY, end of T_CREATE_ENTITY. types: - "! No documentation available. + "! No documentation available. begin of T_CREATE_WORKSPACE, "! The name of the workspace. This string cannot contain carriage return, newline, "! or tab characters. @@ -1406,7 +1440,7 @@ public section. WEBHOOKS type STANDARD TABLE OF T_WEBHOOK WITH NON-UNIQUE DEFAULT KEY, end of T_CREATE_WORKSPACE. types: - "! No documentation available. + "! No documentation available. begin of T_COUNTEREXAMPLE_COLLECTION, "! An array of objects describing the examples marked as irrelevant input. COUNTEREXAMPLES type STANDARD TABLE OF T_COUNTEREXAMPLE WITH NON-UNIQUE DEFAULT KEY, @@ -1414,7 +1448,7 @@ public section. PAGINATION type T_PAGINATION, end of T_COUNTEREXAMPLE_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_EXAMPLE, "! The text of the user input example. This string must conform to the following "! restrictions:
@@ -1429,21 +1463,21 @@ public section. UPDATED type DATETIME, end of T_BASE_EXAMPLE. types: - "! No documentation available. + "! 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`). + "! 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. + "! No documentation available. begin of T_UPDATE_COUNTEREXAMPLE, "! The text of a user input marked as irrelevant input. This string must conform to "! the following restrictions:
@@ -1456,7 +1490,9 @@ public section. UPDATED type DATETIME, end of T_UPDATE_COUNTEREXAMPLE. types: - "! An array of objects describing the entities for the workspace. + "!

+ "! An array of objects describing the entities for the

+ "! workspace. begin of T_ENTITY_COLLECTION, "! An array of objects describing the entities defined for the workspace. ENTITIES type STANDARD TABLE OF T_ENTITY WITH NON-UNIQUE DEFAULT KEY, @@ -1464,7 +1500,7 @@ public section. PAGINATION type T_PAGINATION, end of T_ENTITY_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_INTENT_COLLECTION, "! An array of objects describing the intents defined for the workspace. INTENTS type STANDARD TABLE OF T_INTENT WITH NON-UNIQUE DEFAULT KEY, @@ -1472,18 +1508,18 @@ public section. PAGINATION type T_PAGINATION, end of T_INTENT_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OTPT_RESP_TYPE_PAUSE, "! How long to pause, in milliseconds. The valid values are from 0 to 10000. Valid "! only when **response_type**=`pause`. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. Ignored if the - "! channel does not support this event. Valid only when **response_type**=`pause`. - "! + "! Whether to send a "user is typing" event during the pause. Ignored if + "! the channel does not support this event. Valid only when + "! **response_type**=`pause`. TYPING type BOOLEAN, end of T_DIA_ND_OTPT_RESP_TYPE_PAUSE. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OUTPUT_RESP_TYPE_IMG, "! The URL of the image. Required when **response_type**=`image`. SOURCE type STRING, @@ -1495,7 +1531,7 @@ public section. DESCRIPTION type STRING, end of T_DIA_ND_OUTPUT_RESP_TYPE_IMG. types: - "! No documentation available. + "! No documentation available. begin of T_ERROR_RESPONSE, "! General description of an error. ERROR type STRING, @@ -1505,7 +1541,7 @@ public section. CODE type INTEGER, end of T_ERROR_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_MESSAGE, "! An input object that includes the input text. INPUT type T_MESSAGE_INPUT, @@ -1527,7 +1563,7 @@ public section. ACTIONS type STANDARD TABLE OF T_DIALOG_NODE_ACTION WITH NON-UNIQUE DEFAULT KEY, end of T_BASE_MESSAGE. types: - "! No documentation available. + "! No documentation available. begin of T_RT_RESPONSE_TYPE_SUGGESTION, "! The title or introductory text to show before the response. TITLE type STRING, @@ -1539,7 +1575,7 @@ public section. SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESPONSE_TYPE_SUGGESTION. types: - "! No documentation available. + "! 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, @@ -1547,7 +1583,7 @@ public section. PAGINATION type T_PAGINATION, end of T_ENTITY_MENTION_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_SYNONYM, "! The text of the synonym. This string must conform to the following "! restrictions:
@@ -1560,7 +1596,7 @@ public section. UPDATED type DATETIME, end of T_UPDATE_SYNONYM. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_INTENT, "! The name of the intent. This string must conform to the following "! restrictions:
@@ -1577,26 +1613,26 @@ public section. UPDATED type DATETIME, end of T_BASE_INTENT. types: - "! No documentation available. + "! 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). + "! 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. + "! 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. + "! 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`). + "! 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 @@ -1638,7 +1674,7 @@ public section. SPECIFIC_YEAR type NUMBER, end of T_RT_ENTTY_INTRPRTTN_SYS_DATE. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_ND_OUTPUT_RESP_TYPE_OPT, "! An optional title to show before the response. Valid only when "! **response_type**=`image` or `option`. @@ -1654,7 +1690,7 @@ public section. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, end of T_DIA_ND_OUTPUT_RESP_TYPE_OPT. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_COUNTEREXAMPLE, "! The text of a user input marked as irrelevant input. This string must conform to "! the following restrictions:
@@ -1667,7 +1703,7 @@ public section. UPDATED type DATETIME, end of T_BASE_COUNTEREXAMPLE. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_IMAGE, "! The URL of the image. SOURCE type STRING, @@ -1677,7 +1713,7 @@ public section. DESCRIPTION type STRING, end of T_RUNTIME_RESPONSE_TYPE_IMAGE. types: - "! No documentation available. + "! No documentation available. begin of T_UPDATE_WORKSPACE, "! The name of the workspace. This string cannot contain carriage return, newline, "! or tab characters. @@ -1716,7 +1752,7 @@ public section. WEBHOOKS type STANDARD TABLE OF T_WEBHOOK WITH NON-UNIQUE DEFAULT KEY, end of T_UPDATE_WORKSPACE. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_DIALOG_NODE, "! The dialog node ID. This string must conform to the following restrictions:
"! - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot @@ -1777,7 +1813,9 @@ public section. UPDATED type DATETIME, end of T_BASE_DIALOG_NODE. types: - "! A request sent to the workspace, including the user input and context. + "!

+ "! A request sent to the workspace, including the user input

+ "! and context. begin of T_MESSAGE_REQUEST, "! An input object that includes the input text. INPUT type T_MESSAGE_INPUT, @@ -1802,7 +1840,7 @@ public section. ACTIONS type STANDARD TABLE OF T_DIALOG_NODE_ACTION WITH NON-UNIQUE DEFAULT KEY, end of T_MESSAGE_REQUEST. types: - "! No documentation available. + "! No documentation available. begin of T_LOG, "! A request sent to the workspace, including the user input and context. REQUEST type T_MESSAGE_REQUEST, @@ -1821,8 +1859,9 @@ public section. LANGUAGE type STRING, end of T_LOG. types: - "! An output object that includes the response to the user, the dialog nodes that - "! were triggered, and messages from the log. + "!

+ "! An output object that includes the response to the user, the

+ "! dialog nodes that were triggered, and messages from the log. begin of T_BASE_OUTPUT, "! An array of the nodes that were triggered to create the response, in the order "! in which they were visited. This information is useful for debugging and for @@ -1834,7 +1873,7 @@ public section. NODES_VISITED_DETAILS type STANDARD TABLE OF T_DIALOG_NODE_VISITED_DETAILS WITH NON-UNIQUE DEFAULT KEY, end of T_BASE_OUTPUT. types: - "! No documentation available. + "! 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, @@ -1842,7 +1881,7 @@ public section. PAGINATION type T_LOG_PAGINATION, end of T_LOG_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_AUDIT_PROPERTIES, "! The timestamp for creation of the object. CREATED type DATETIME, @@ -1850,7 +1889,7 @@ public section. UPDATED type DATETIME, end of T_AUDIT_PROPERTIES. types: - "! No documentation available. + "! No documentation available. begin of T_WORKSPACE_COLLECTION, "! An array of objects describing the workspaces associated with the service "! instance. @@ -1859,7 +1898,7 @@ public section. PAGINATION type T_PAGINATION, end of T_WORKSPACE_COLLECTION. types: - "! No documentation available. + "! No documentation available. begin of T_BASE_SYNONYM, "! The text of the synonym. This string must conform to the following "! restrictions:
@@ -1873,6 +1912,7 @@ public section. end of T_BASE_SYNONYM. constants: + "!

List of required fields per type.

begin of C_REQUIRED_FIELDS, T_WS_SYSTEM_SETTINGS_OFF_TOPIC type string value '|', T_RT_ENTITY_INTERPRETATION type string value '|', @@ -1975,6 +2015,7 @@ constants: end of C_REQUIRED_FIELDS . constants: + "!

Map ABAP identifiers to service identifiers.

begin of C_ABAPNAME_DICTIONARY, CREATED type string value 'created', UPDATED type string value 'updated', @@ -2141,12 +2182,22 @@ constants: redefinition . - "! Get response to user input. + "!

Get response to user input

+ "! Send user input to a workspace and receive a response.
+ "!
+ "! **Important:** This method has been superseded by the new v2 runtime API. The v2 + "! API offers significant advantages, including ease of deployment, automatic + "! state management, versioning, and search capabilities. For more information, + "! see the + "! [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-api-overvi + "! ew).
+ "!
+ "! There is no rate limit for this operation. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. "! @parameter I_BODY | - "! The message to be sent. This includes the user's input, along with optional + "! The message to be sent. This includes the user's input, along with optional "! intents, entities, and context from the last response. "! @parameter I_NODES_VISITED_DETAILS | "! Whether to include additional diagnostic information about the dialog nodes that @@ -2167,7 +2218,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List workspaces. + "!

List workspaces

+ "! List the workspaces associated with a Watson Assistant service instance.
+ "!
+ "! This operation is limited to 500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_PAGE_LIMIT | "! The number of records to return in each page of results. @@ -2194,7 +2249,12 @@ constants: !E_RESPONSE type T_WORKSPACE_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create workspace. + "!

Create workspace

+ "! Create a workspace based on component objects. You must provide workspace + "! components defining the content of the new workspace.
+ "!
+ "! This operation is limited to 30 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_BODY | "! The content of the new workspace.
@@ -2219,7 +2279,13 @@ constants: !E_RESPONSE type T_WORKSPACE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get information about a workspace. + "!

Get information about a workspace

+ "! Get information about a workspace, optionally including all workspace + "! content.
+ "!
+ "! With **export**=`false`, this operation is limited to 6000 requests per 5 + "! minutes. With **export**=`true`, the limit is 20 requests per 30 minutes. For + "! more information, see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2250,7 +2316,12 @@ constants: !E_RESPONSE type T_WORKSPACE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update workspace. + "!

Update workspace

+ "! Update an existing workspace with new or modified data. You must provide + "! component objects defining the content of the updated workspace.
+ "!
+ "! This operation is limited to 30 request per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2290,7 +2361,11 @@ constants: !E_RESPONSE type T_WORKSPACE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete workspace. + "!

Delete workspace

+ "! Delete a workspace from the service instance.
+ "!
+ "! This operation is limited to 30 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2303,7 +2378,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List intents. + "!

List intents

+ "! List the intents for a workspace.
+ "!
+ "! With **export**=`false`, this operation is limited to 2000 requests per 30 + "! minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For + "! more information, see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2339,7 +2419,14 @@ constants: !E_RESPONSE type T_INTENT_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create intent. + "!

Create intent

+ "! Create a new intent.
+ "!
+ "! If you want to create multiple intents with a single API call, consider using + "! the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 2000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2363,7 +2450,12 @@ constants: !E_RESPONSE type T_INTENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get intent. + "!

Get intent

+ "! Get information about an intent, optionally including all intent content.
+ "!
+ "! With **export**=`false`, this operation is limited to 6000 requests per 5 + "! minutes. With **export**=`true`, the limit is 400 requests per 30 minutes. For + "! more information, see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2392,7 +2484,15 @@ constants: !E_RESPONSE type T_INTENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update intent. + "!

Update intent

+ "! Update an existing intent with new or modified data. You must provide component + "! objects defining the content of the updated intent.
+ "!
+ "! If you want to update multiple intents with a single API call, consider using + "! the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 2000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2438,7 +2538,11 @@ constants: !E_RESPONSE type T_INTENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete intent. + "!

Delete intent

+ "! Delete an intent from a workspace.
+ "!
+ "! This operation is limited to 2000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2454,7 +2558,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List user input examples. + "!

List user input examples

+ "! List the user input examples for an intent, optionally including contextual + "! entity mentions.
+ "!
+ "! This operation is limited to 2500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2487,7 +2596,14 @@ constants: !E_RESPONSE type T_EXAMPLE_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create user input example. + "!

Create user input example

+ "! Add a new user input example to an intent.
+ "!
+ "! If you want to add multiple exaples with a single API call, consider using the + "! **[Update intent](#update-intent)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2514,7 +2630,11 @@ constants: !E_RESPONSE type T_EXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get user input example. + "!

Get user input example

+ "! Get information about a user input example.
+ "!
+ "! This operation is limited to 6000 requests per 5 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2540,7 +2660,14 @@ constants: !E_RESPONSE type T_EXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update user input example. + "!

Update user input example

+ "! Update the text of a user input example.
+ "!
+ "! If you want to update multiple examples with a single API call, consider using + "! the **[Update intent](#update-intent)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2570,7 +2697,11 @@ constants: !E_RESPONSE type T_EXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete user input example. + "!

Delete user input example

+ "! Delete a user input example from an intent.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2589,7 +2720,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List counterexamples. + "!

List counterexamples

+ "! List the counterexamples for a workspace. Counterexamples are examples that have + "! been marked as irrelevant input.
+ "!
+ "! This operation is limited to 2500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2619,7 +2755,15 @@ constants: !E_RESPONSE type T_COUNTEREXAMPLE_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create counterexample. + "!

Create counterexample

+ "! Add a new counterexample to a workspace. Counterexamples are examples that have + "! been marked as irrelevant input.
+ "!
+ "! If you want to add multiple counterexamples with a single API call, consider + "! using the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2643,7 +2787,12 @@ constants: !E_RESPONSE type T_COUNTEREXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get counterexample. + "!

Get counterexample

+ "! Get information about a counterexample. Counterexamples are examples that have + "! been marked as irrelevant input.
+ "!
+ "! This operation is limited to 6000 requests per 5 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2666,7 +2815,15 @@ constants: !E_RESPONSE type T_COUNTEREXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update counterexample. + "!

Update counterexample

+ "! Update the text of a counterexample. Counterexamples are examples that have been + "! marked as irrelevant input.
+ "!
+ "! If you want to update multiple counterexamples with a single API call, consider + "! using the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2693,7 +2850,12 @@ constants: !E_RESPONSE type T_COUNTEREXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete counterexample. + "!

Delete counterexample

+ "! Delete a counterexample from a workspace. Counterexamples are examples that have + "! been marked as irrelevant input.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2709,7 +2871,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List entities. + "!

List entities

+ "! List the entities for a workspace.
+ "!
+ "! With **export**=`false`, this operation is limited to 1000 requests per 30 + "! minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For + "! more information, see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2745,7 +2912,14 @@ constants: !E_RESPONSE type T_ENTITY_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create entity. + "!

Create entity

+ "! Create a new entity, or enable a system entity.
+ "!
+ "! If you want to create multiple entities with a single API call, consider using + "! the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2769,7 +2943,12 @@ constants: !E_RESPONSE type T_ENTITY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get entity. + "!

Get entity

+ "! Get information about an entity, optionally including all entity content.
+ "!
+ "! With **export**=`false`, this operation is limited to 6000 requests per 5 + "! minutes. With **export**=`true`, the limit is 200 requests per 30 minutes. For + "! more information, see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2798,7 +2977,15 @@ constants: !E_RESPONSE type T_ENTITY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update entity. + "!

Update entity

+ "! Update an existing entity with new or modified data. You must provide component + "! objects defining the content of the updated entity.
+ "!
+ "! If you want to update multiple entities with a single API call, consider using + "! the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2842,7 +3029,11 @@ constants: !E_RESPONSE type T_ENTITY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete entity. + "!

Delete entity

+ "! Delete an entity from a workspace, or disable a system entity.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2858,7 +3049,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List entity mentions. + "!

List entity mentions

+ "! List mentions for a contextual entity. An entity mention is an occurrence of a + "! contextual entity in the context of an intent user input example.
+ "!
+ "! This operation is limited to 200 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2888,7 +3084,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List entity values. + "!

List entity values

+ "! List the values for an entity.
+ "!
+ "! This operation is limited to 2500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2927,7 +3127,14 @@ constants: !E_RESPONSE type T_VALUE_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create entity value. + "!

Create entity value

+ "! Create a new value for an entity.
+ "!
+ "! If you want to create multiple entity values with a single API call, consider + "! using the **[Update entity](#update-entity)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2954,7 +3161,11 @@ constants: !E_RESPONSE type T_VALUE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get entity value. + "!

Get entity value

+ "! Get information about an entity value.
+ "!
+ "! This operation is limited to 6000 requests per 5 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -2986,7 +3197,15 @@ constants: !E_RESPONSE type T_VALUE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update entity value. + "!

Update entity value

+ "! Update an existing entity value with new or modified data. You must provide + "! component objects defining the content of the updated entity value.
+ "!
+ "! If you want to update multiple entity values with a single API call, consider + "! using the **[Update entity](#update-entity)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3035,7 +3254,11 @@ constants: !E_RESPONSE type T_VALUE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete entity value. + "!

Delete entity value

+ "! Delete a value from an entity.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3054,7 +3277,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List entity value synonyms. + "!

List entity value synonyms

+ "! List the synonyms for an entity value.
+ "!
+ "! This operation is limited to 2500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3090,7 +3317,15 @@ constants: !E_RESPONSE type T_SYNONYM_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create entity value synonym. + "!

Create entity value synonym

+ "! Add a new synonym to an entity value.
+ "!
+ "! If you want to create multiple synonyms with a single API call, consider using + "! the **[Update entity](#update-entity)** or **[Update entity + "! value](#update-entity-value)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3120,7 +3355,11 @@ constants: !E_RESPONSE type T_SYNONYM raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get entity value synonym. + "!

Get entity value synonym

+ "! Get information about a synonym of an entity value.
+ "!
+ "! This operation is limited to 6000 requests per 5 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3149,7 +3388,15 @@ constants: !E_RESPONSE type T_SYNONYM raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update entity value synonym. + "!

Update entity value synonym

+ "! Update an existing entity value synonym with new text.
+ "!
+ "! If you want to update multiple synonyms with a single API call, consider using + "! the **[Update entity](#update-entity)** or **[Update entity + "! value](#update-entity-value)** method instead.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3182,7 +3429,11 @@ constants: !E_RESPONSE type T_SYNONYM raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete entity value synonym. + "!

Delete entity value synonym

+ "! Delete a synonym from an entity value.
+ "!
+ "! This operation is limited to 1000 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3204,7 +3455,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List dialog nodes. + "!

List dialog nodes

+ "! List the dialog nodes for a workspace.
+ "!
+ "! This operation is limited to 2500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3234,7 +3489,14 @@ constants: !E_RESPONSE type T_DIALOG_NODE_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create dialog node. + "!

Create dialog node

+ "! Create a new dialog node.
+ "!
+ "! If you want to create multiple dialog nodes with a single API call, consider + "! using the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3258,7 +3520,11 @@ constants: !E_RESPONSE type T_DIALOG_NODE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get dialog node. + "!

Get dialog node

+ "! Get information about a dialog node.
+ "!
+ "! This operation is limited to 6000 requests per 5 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3281,7 +3547,14 @@ constants: !E_RESPONSE type T_DIALOG_NODE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update dialog node. + "!

Update dialog node

+ "! Update an existing dialog node with new or modified data.
+ "!
+ "! If you want to update multiple dialog nodes with a single API call, consider + "! using the **[Update workspace](#update-workspace)** method instead.
+ "!
+ "! This operation is limited to 500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3314,7 +3587,11 @@ constants: !E_RESPONSE type T_DIALOG_NODE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete dialog node. + "!

Delete dialog node

+ "! Delete a dialog node from a workspace.
+ "!
+ "! This operation is limited to 500 requests per 30 minutes. For more information, + "! see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3330,7 +3607,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List log events in a workspace. + "!

List log events in a workspace

+ "! List the events from the log of a specific workspace.
+ "!
+ "! If **cursor** is not specified, this operation is limited to 40 requests per 30 + "! minutes. If **cursor** is specified, the limit is 120 requests per minute. For + "! more information, see **Rate limiting**. "! "! @parameter I_WORKSPACE_ID | "! Unique identifier of the workspace. @@ -3362,7 +3644,12 @@ constants: !E_RESPONSE type T_LOG_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List log events in all workspaces. + "!

List log events in all workspaces

+ "! List the events from the logs of all workspaces in the service instance.
+ "!
+ "! If **cursor** is not specified, this operation is limited to 40 requests per 30 + "! minutes. If **cursor** is specified, the limit is 120 requests per minute. For + "! more information, see **Rate limiting**. "! "! @parameter I_FILTER | "! A cacheable parameter that limits the results to those matching the specified @@ -3394,7 +3681,18 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete labeled data. + "!

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.
+ "!
+ "! You associate a customer ID with data by passing the `X-Watson-Metadata` header + "! with a request that passes data. For more information about personal data and + "! customer IDs, see [Information + "! security](https://cloud.ibm.com/docs/assistant?topic=assistant-information-secu + "! rity#information-security).
+ "!
+ "! This operation is limited to 4 requests per minute. For more information, see + "! **Rate limiting**. "! "! @parameter I_CUSTOMER_ID | "! The customer ID for which all data is to be deleted. @@ -3484,7 +3782,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092810'. + e_sdk_version_date = '20200310173420'. endmethod. diff --git a/src/zcl_ibmc_assistant_v1.clas.xml b/src/zcl_ibmc_assistant_v1.clas.xml index d53c171..afd6515 100644 --- a/src/zcl_ibmc_assistant_v1.clas.xml +++ b/src/zcl_ibmc_assistant_v1.clas.xml @@ -5,12 +5,284 @@ ZCL_IBMC_ASSISTANT_V1 E - IBM Watson Assistant V1 + Watson Assistant v1 1 X X X + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_COUNTEREXAMPLE + E + Create counterexample + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_DIALOG_NODE + E + Create dialog node + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_ENTITY + E + Create entity + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_EXAMPLE + E + Create user input example + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_INTENT + E + Create intent + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_SYNONYM + E + Create entity value synonym + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_VALUE + E + Create entity value + + + ZCL_IBMC_ASSISTANT_V1 + CREATE_WORKSPACE + E + Create workspace + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_COUNTEREXAMPLE + E + Delete counterexample + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_DIALOG_NODE + E + Delete dialog node + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_ENTITY + E + Delete entity + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_EXAMPLE + E + Delete user input example + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_INTENT + E + Delete intent + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_SYNONYM + E + Delete entity value synonym + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_USER_DATA + E + Delete labeled data + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_VALUE + E + Delete entity value + + + ZCL_IBMC_ASSISTANT_V1 + DELETE_WORKSPACE + E + Delete workspace + + + ZCL_IBMC_ASSISTANT_V1 + GET_COUNTEREXAMPLE + E + Get counterexample + + + ZCL_IBMC_ASSISTANT_V1 + GET_DIALOG_NODE + E + Get dialog node + + + ZCL_IBMC_ASSISTANT_V1 + GET_ENTITY + E + Get entity + + + ZCL_IBMC_ASSISTANT_V1 + GET_EXAMPLE + E + Get user input example + + + ZCL_IBMC_ASSISTANT_V1 + GET_INTENT + E + Get intent + + + ZCL_IBMC_ASSISTANT_V1 + GET_SYNONYM + E + Get entity value synonym + + + ZCL_IBMC_ASSISTANT_V1 + GET_VALUE + E + Get entity value + + + ZCL_IBMC_ASSISTANT_V1 + GET_WORKSPACE + E + Get information about a workspace + + + ZCL_IBMC_ASSISTANT_V1 + LIST_ALL_LOGS + E + List log events in all workspaces + + + ZCL_IBMC_ASSISTANT_V1 + LIST_COUNTEREXAMPLES + E + List counterexamples + + + ZCL_IBMC_ASSISTANT_V1 + LIST_DIALOG_NODES + E + List dialog nodes + + + ZCL_IBMC_ASSISTANT_V1 + LIST_ENTITIES + E + List entities + + + ZCL_IBMC_ASSISTANT_V1 + LIST_EXAMPLES + E + List user input examples + + + ZCL_IBMC_ASSISTANT_V1 + LIST_INTENTS + E + List intents + + + ZCL_IBMC_ASSISTANT_V1 + LIST_LOGS + E + List log events in a workspace + + + ZCL_IBMC_ASSISTANT_V1 + LIST_MENTIONS + E + List entity mentions + + + ZCL_IBMC_ASSISTANT_V1 + LIST_SYNONYMS + E + List entity value synonyms + + + ZCL_IBMC_ASSISTANT_V1 + LIST_VALUES + E + List entity values + + + ZCL_IBMC_ASSISTANT_V1 + LIST_WORKSPACES + E + List workspaces + + + ZCL_IBMC_ASSISTANT_V1 + MESSAGE + E + Get response to user input + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_COUNTEREXAMPLE + E + Update counterexample + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_DIALOG_NODE + E + Update dialog node + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_ENTITY + E + Update entity + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_EXAMPLE + E + Update user input example + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_INTENT + E + Update intent + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_SYNONYM + E + Update entity value synonym + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_VALUE + E + Update entity value + + + ZCL_IBMC_ASSISTANT_V1 + UPDATE_WORKSPACE + E + Update workspace + + diff --git a/src/zcl_ibmc_assistant_v2.clas.abap b/src/zcl_ibmc_assistant_v2.clas.abap index 469d2d8..8a7aad3 100644 --- a/src/zcl_ibmc_assistant_v2.clas.abap +++ b/src/zcl_ibmc_assistant_v2.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Watson Assistant v2

+"!

Watson Assistant v2

"! The IBM Watson™ Assistant service combines machine learning, natural "! language understanding, and an integrated dialog editor to create conversation "! flows between your apps and your users.
@@ -25,7 +25,8 @@ class ZCL_IBMC_ASSISTANT_V2 DEFINITION public section. types: - "! Dialog log message details. + "!

+ "! Dialog log message details.

begin of T_DIALOG_LOG_MESSAGE, "! The severity of the log message. LEVEL type STRING, @@ -33,7 +34,7 @@ public section. MESSAGE type STRING, end of T_DIALOG_LOG_MESSAGE. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_NODES_VISITED, "! A dialog node that was triggered during processing of the input message. DIALOG_NODE type STRING, @@ -43,8 +44,9 @@ public section. CONDITIONS type STRING, end of T_DIALOG_NODES_VISITED. types: - "! Additional detailed information about a message response and how it was - "! generated. + "!

+ "! 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. @@ -60,66 +62,68 @@ public section. BRANCH_EXITED_REASON type STRING, end of T_MESSAGE_OUTPUT_DEBUG. types: - "! No documentation available. + "! No documentation available. T_EMPTY_RESPONSE type JSONOBJECT. types: - "! No documentation available. + "! No documentation available. begin of T_SESSION_RESPONSE, "! The session ID. SESSION_ID type STRING, end of T_SESSION_RESPONSE. types: - "! No documentation available. + "! 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`). + "! 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: - "! An alternative value for the recognized entity. + "!

+ "! An alternative value for the recognized entity.

begin of T_RUNTIME_ENTITY_ALTERNATIVE, "! The entity value that was recognized in the user input. VALUE type STRING, - "! A decimal percentage that represents Watson's confidence in the recognized + "! A decimal percentage that represents Watson's confidence in the recognized "! entity. CONFIDENCE type NUMBER, end of T_RUNTIME_ENTITY_ALTERNATIVE. types: - "! An object describing the role played by a system entity that is specifies the - "! beginning or end of a range recognized in the user input. This property is - "! included only if the new system entities are enabled for the skill. + "!

+ "! An object describing the role played by a system entity that

+ "! is specifies the beginning or end of a range recognized in the user input. This + "! property is included only if the new system entities are enabled for the skill. begin of T_RUNTIME_ENTITY_ROLE, "! The relationship of the entity to the range. TYPE type STRING, end of T_RUNTIME_ENTITY_ROLE. types: - "! No documentation available. + "! No documentation available. begin of T_RT_ENTITY_INTERPRETATION, "! The calendar used to represent a recognized date (for example, `Gregorian`). CALENDAR_TYPE type STRING, "! A unique identifier used to associate a recognized 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). + "! 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. + "! 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. + "! 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`). + "! 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 @@ -165,7 +169,7 @@ public section. "! `rational`). SUBTYPE type STRING, "! A recognized term for a time that was mentioned as a part of the day in the - "! user's input (for example, `morning` or `afternoon`). + "! user's input (for example, `morning` or `afternoon`). PART_OF_DAY type STRING, "! A recognized mention of a relative hour, represented numerically as an offset "! from the current hour (for example, `3` for `in three hours` or `-1` for `an @@ -192,7 +196,8 @@ public section. TIMEZONE type STRING, end of T_RT_ENTITY_INTERPRETATION. types: - "! Optional properties that control how the assistant responds. + "!

+ "! Optional properties that control how the assistant responds.

begin of T_MESSAGE_INPUT_OPTIONS, "! Whether to return additional diagnostic information. Set to `true` to return "! additional information under the `output.debug` key. @@ -209,15 +214,16 @@ public section. RETURN_CONTEXT type BOOLEAN, end of T_MESSAGE_INPUT_OPTIONS. types: - "! An intent identified in the user input. + "!

+ "! An intent identified in the user input.

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. CONFIDENCE type DOUBLE, end of T_RUNTIME_INTENT. types: - "! No documentation available. + "! No documentation available. begin of T_CAPTURE_GROUP, "! A recognized capture group for the entity. GROUP type STRING, @@ -226,7 +232,8 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, end of T_CAPTURE_GROUP. types: - "! The entity value that was recognized in the user input. + "!

+ "! The entity value that was recognized in the user input.

begin of T_RUNTIME_ENTITY, "! An entity detected in the input. ENTITY type STRING, @@ -235,7 +242,7 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, "! The term in the input text that was recognized as an entity value. VALUE type STRING, - "! A decimal percentage that represents Watson's confidence in the recognized + "! A decimal percentage that represents Watson's confidence in the recognized "! entity. CONFIDENCE type NUMBER, "! Any metadata for the entity. @@ -252,8 +259,8 @@ public section. INTERPRETATION type T_RT_ENTITY_INTERPRETATION, "! An array of possible alternative values that the user might have intended "! instead of the value returned in the **value** property. This property is - "! returned only for `@sys-time` and `@sys-date` entities when the user's input is - "! ambiguous.
+ "! returned only for `@sys-time` and `@sys-date` entities when the + "! user's input is ambiguous.
"!
"! This property is included only if the new system entities are enabled for the "! skill. @@ -264,7 +271,8 @@ public section. ROLE type T_RUNTIME_ENTITY_ROLE, end of T_RUNTIME_ENTITY. types: - "! An input object that includes the input text. + "!

+ "! An input object that includes the input text.

begin of T_MESSAGE_INPUT, "! The type of user input. Currently, only text input is supported. MESSAGE_TYPE type STRING, @@ -285,14 +293,15 @@ public section. SUGGESTION_ID type STRING, end of T_MESSAGE_INPUT. types: - "! An object defining the message input to be sent to the assistant if the user - "! selects the corresponding option. + "!

+ "! An object defining the message input to be sent to the

+ "! assistant if the user selects the corresponding option. begin of T_DIA_ND_OUTPUT_OPT_ELEM_VALUE, "! An input object that includes the input text. INPUT type T_MESSAGE_INPUT, end of T_DIA_ND_OUTPUT_OPT_ELEM_VALUE. types: - "! No documentation available. + "! No documentation available. begin of T_DIA_NODE_OUTPUT_OPT_ELEMENT, "! The user-facing label for the option. LABEL type STRING, @@ -301,7 +310,7 @@ public section. VALUE type T_DIA_ND_OUTPUT_OPT_ELEM_VALUE, end of T_DIA_NODE_OUTPUT_OPT_ELEMENT. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_OPTION, "! The title or introductory text to show before the response. TITLE type STRING, @@ -313,26 +322,26 @@ public section. OPTIONS type STANDARD TABLE OF T_DIA_NODE_OUTPUT_OPT_ELEMENT WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_OPTION. types: - "! No documentation available. + "! 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). + "! 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. + "! 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. + "! 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`). + "! 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 @@ -374,8 +383,9 @@ public section. SPECIFIC_YEAR type NUMBER, end of T_RT_ENTTY_INTRPRTTN_SYS_DATE. types: - "! An object containing segments of text from search results with query-matching - "! text highlighted using HTML <em> tags. + "!

+ "! 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. @@ -388,14 +398,17 @@ public section. URL type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_SEARCH_RESULT_HIGHLIGHT. types: - "! An object defining the message input to be sent to the assistant if the user - "! selects the corresponding disambiguation option. + "!

+ "! 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. types: - "! An object containing search result metadata from the Discovery service. + "!

+ "! 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 @@ -407,7 +420,7 @@ public section. SCORE type DOUBLE, end of T_SEARCH_RESULT_METADATA. types: - "! No documentation available. + "! No documentation available. begin of T_SEARCH_RESULT, "! The unique identifier of the document in the Discovery service collection.
"!
@@ -430,7 +443,7 @@ public section. HIGHLIGHT type T_SEARCH_RESULT_HIGHLIGHT, end of T_SEARCH_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_SUGGESTION, "! The user-facing label for the disambiguation option. This label is taken from "! the **title** or **user_label** property of the corresponding dialog node, @@ -444,7 +457,7 @@ public section. OUTPUT type MAP, end of T_DIALOG_SUGGESTION. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_GENERIC, "! The type of response returned by the dialog node. The specified response type "! must be supported by the client application or channel.
@@ -456,7 +469,7 @@ public section. TEXT type STRING, "! How long to pause, in milliseconds. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. + "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, "! The URL of the image. SOURCE type STRING, @@ -487,7 +500,7 @@ public section. RESULTS type STANDARD TABLE OF T_SEARCH_RESULT WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_GENERIC. types: - "! No documentation available. + "! No documentation available. begin of T_ERROR_DETAIL, "! Description of a specific constraint violation. MESSAGE type STRING, @@ -495,7 +508,7 @@ public section. PATH type STRING, end of T_ERROR_DETAIL. types: - "! No documentation available. + "! No documentation available. begin of T_ERROR_RESPONSE, "! General description of an error. ERROR type STRING, @@ -505,7 +518,7 @@ public section. CODE type INTEGER, end of T_ERROR_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_IMAGE, "! The URL of the image. SOURCE type STRING, @@ -515,7 +528,7 @@ public section. DESCRIPTION type STRING, end of T_RUNTIME_RESPONSE_TYPE_IMAGE. types: - "! No documentation available. + "! No documentation available. begin of T_DIALOG_NODE_ACTION, "! The name of the action. NAME type STRING, @@ -530,7 +543,9 @@ public section. CREDENTIALS type STRING, end of T_DIALOG_NODE_ACTION. types: - "! Built-in system properties that apply to all skills used by the assistant. + "!

+ "! 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. @@ -568,20 +583,24 @@ public section. REFERENCE_TIME type STRING, end of T_MSSG_CONTEXT_GLOBAL_SYSTEM. types: - "! Information that is shared by all skills used by the Assistant. + "!

+ "! Information that is shared by all skills used by 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, end of T_MESSAGE_CONTEXT_GLOBAL. types: - "! Information specific to particular skills used by the Assistant.
- "!
- "! **Note:** Currently, only a single property named `main skill` is supported. - "! This object contains variables that apply to the dialog skill used by the - "! assistant. + "!

+ "! Information specific to particular skills used by the

+ "! Assistant.
+ "!
+ "! **Note:** Currently, only a single property named `main skill` is supported. + "! This object contains variables that apply to the dialog skill used by the + "! assistant. T_MESSAGE_CONTEXT_SKILLS type MAP. types: - "! No documentation available. + "! No documentation available. begin of T_MESSAGE_CONTEXT, "! Information that is shared by all skills used by the Assistant. GLOBAL type T_MESSAGE_CONTEXT_GLOBAL, @@ -593,7 +612,8 @@ public section. SKILLS type T_MESSAGE_CONTEXT_SKILLS, end of T_MESSAGE_CONTEXT. types: - "! Assistant output to be rendered or processed by the client. + "!

+ "! Assistant output to be rendered or processed by the client.

begin of T_MESSAGE_OUTPUT, "! Output intended for any channel. It is the responsibility of the client "! application to implement the supported response types. @@ -614,7 +634,8 @@ public section. USER_DEFINED type MAP, end of T_MESSAGE_OUTPUT. types: - "! A response from the Watson Assistant service. + "!

+ "! A response from the Watson Assistant service.

begin of T_MESSAGE_RESPONSE, "! Assistant output to be rendered or processed by the client. OUTPUT type T_MESSAGE_OUTPUT, @@ -627,29 +648,29 @@ public section. CONTEXT type T_MESSAGE_CONTEXT, end of T_MESSAGE_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_TEXT, "! The text of the response. TEXT type STRING, end of T_RUNTIME_RESPONSE_TYPE_TEXT. types: - "! No documentation available. + "! No documentation available. begin of T_RT_ENTTY_INTRPRTTN_SYS_TIME, "! A unique identifier used to associate a recognized 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). + "! at 5`, the same **datetime_link** value is returned for both the + "! `@sys-date` and `@sys-time` entities). DATETIME_LINK type STRING, - "! The precision or duration of a time range specified by a recognized `@sys-time` - "! or `@sys-date` entity. + "! The precision or duration of a time range specified by a recognized + "! `@sys-time` or `@sys-date` entity. GRANULARITY type STRING, "! A recognized term for a time that was mentioned as a part of the day in the - "! user's input (for example, `morning` or `afternoon`). + "! user's input (for example, `morning` or `afternoon`). PART_OF_DAY 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`). + "! 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, "! A recognized mention of a relative hour, represented numerically as an offset "! from the current hour (for example, `3` for `in three hours` or `-1` for `an @@ -676,15 +697,15 @@ public section. TIMEZONE type STRING, end of T_RT_ENTTY_INTRPRTTN_SYS_TIME. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_PAUSE, "! How long to pause, in milliseconds. TIME type INTEGER, - "! Whether to send a "user is typing" event during the pause. + "! Whether to send a "user is typing" event during the pause. TYPING type BOOLEAN, end of T_RUNTIME_RESPONSE_TYPE_PAUSE. types: - "! No documentation available. + "! No documentation available. begin of T_RUNTIME_RESPONSE_TYPE_SEARCH, "! The title or introductory text to show before the response. This text is defined "! in the search skill configuration. @@ -693,7 +714,7 @@ public section. RESULTS type STANDARD TABLE OF T_SEARCH_RESULT WITH NON-UNIQUE DEFAULT KEY, end of T_RUNTIME_RESPONSE_TYPE_SEARCH. types: - "! No documentation available. + "! No documentation available. begin of T_RT_RESPONSE_TYPE_SUGGESTION, "! The title or introductory text to show before the response. TITLE type STRING, @@ -705,7 +726,9 @@ public section. SUGGESTIONS type STANDARD TABLE OF T_DIALOG_SUGGESTION WITH NON-UNIQUE DEFAULT KEY, end of T_RT_RESPONSE_TYPE_SUGGESTION. types: - "! Contains information specific to a particular skill used by the Assistant. + "!

+ "! Contains information specific to a particular skill used by

+ "! the Assistant. begin of T_MESSAGE_CONTEXT_SKILL, "! Arbitrary variables that can be read and written by a particular skill. USER_DEFINED type MAP, @@ -713,7 +736,7 @@ public section. SYSTEM type MAP, end of T_MESSAGE_CONTEXT_SKILL. types: - "! No documentation available. + "! No documentation available. begin of T_RT_RESP_TYP_CONNECT_TO_AGENT, "! A message to be sent to the human agent who will be taking over the "! conversation. @@ -723,7 +746,8 @@ public section. TOPIC type STRING, end of T_RT_RESP_TYP_CONNECT_TO_AGENT. types: - "! A request formatted for the Watson Assistant service. + "!

+ "! A 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, @@ -734,6 +758,7 @@ public section. end of T_MESSAGE_REQUEST. constants: + "!

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 '|', @@ -779,6 +804,7 @@ constants: end of C_REQUIRED_FIELDS . constants: + "!

Map ABAP identifiers to service identifiers.

begin of C_ABAPNAME_DICTIONARY, DEBUG type string value 'debug', RESTART type string value 'restart', @@ -891,7 +917,13 @@ constants: redefinition . - "! Create a session. + "!

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 @@ -913,7 +945,11 @@ constants: !E_RESPONSE type T_SESSION_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete session. + "!

Delete session

+ "! Deletes a session explicitly before it times out. (For more information about + "! the session inactivity timeout, 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 @@ -935,7 +971,10 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Send user input to assistant. + "!

Send user input to assistant

+ "! Send user input to an assistant and receive a response.
+ "!
+ "! There is no rate limit for this operation. "! "! @parameter I_ASSISTANT_ID | "! Unique identifier of the assistant. To find the assistant ID in the Watson @@ -948,7 +987,7 @@ constants: "! @parameter I_SESSION_ID | "! Unique identifier of the session. "! @parameter I_REQUEST | - "! The message to be sent. This includes the user's input, along with optional + "! The message to be sent. This includes the user's input, along with optional "! content such as intents and entities. "! @parameter E_RESPONSE | "! Service return value of type T_MESSAGE_RESPONSE @@ -1043,7 +1082,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092813'. + e_sdk_version_date = '20200310173422'. endmethod. diff --git a/src/zcl_ibmc_assistant_v2.clas.xml b/src/zcl_ibmc_assistant_v2.clas.xml index a6bf585..5a269c0 100644 --- a/src/zcl_ibmc_assistant_v2.clas.xml +++ b/src/zcl_ibmc_assistant_v2.clas.xml @@ -5,12 +5,32 @@ ZCL_IBMC_ASSISTANT_V2 E - IBM Watson Assistant V2 + Watson Assistant v2 1 X X X + + + ZCL_IBMC_ASSISTANT_V2 + CREATE_SESSION + E + Create a session + + + ZCL_IBMC_ASSISTANT_V2 + DELETE_SESSION + E + Delete session + + + ZCL_IBMC_ASSISTANT_V2 + MESSAGE + E + Send user input to assistant + + diff --git a/src/zcl_ibmc_compare_comply_v1.clas.abap b/src/zcl_ibmc_compare_comply_v1.clas.abap index 9f9f440..8fe7109 100644 --- a/src/zcl_ibmc_compare_comply_v1.clas.abap +++ b/src/zcl_ibmc_compare_comply_v1.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Compare and Comply

+"!

Compare and Comply

"! IBM Watson™ Compare and Comply analyzes governing documents to provide "! details about critical aspects of the documents.
class ZCL_IBMC_COMPARE_COMPLY_V1 DEFINITION @@ -21,18 +21,20 @@ class ZCL_IBMC_COMPARE_COMPLY_V1 DEFINITION public section. types: - "! The numeric location of the identified element in the document, represented with - "! two integers labeled `begin` and `end`. + "!

+ "! 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. + "! The element's `begin` index. BEGIN type LONG, - "! The element's `end` index. + "! 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. + "!

+ "! 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, @@ -40,7 +42,8 @@ public section. PARTY type STRING, end of T_LABEL. types: - "! Identification of a specific type. + "!

+ "! 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 @@ -48,14 +51,16 @@ public section. LABEL type T_LABEL, end of T_TYPE_LABEL_COMPARISON. types: - "! The locations of each paragraph in the input document. + "!

+ "! 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. + "!

+ "! Document counts.

begin of T_DOC_COUNTS, "! Total number of documents. TOTAL type INTEGER, @@ -67,7 +72,8 @@ public section. FAILED type INTEGER, end of T_DOC_COUNTS. types: - "! Identification of a specific type. + "!

+ "! 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 @@ -77,7 +83,8 @@ public section. PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_TYPE_LABEL. types: - "! Brief information about the input document. + "!

+ "! Brief information about the input document.

begin of T_SHORT_DOC, "! The title of the input document, if identified. TITLE type STRING, @@ -85,7 +92,8 @@ public section. HASH type STRING, end of T_SHORT_DOC. types: - "! Information defining an element's subject matter. + "!

+ "! Information defining an element's subject matter.

begin of T_CATEGORY, "! The category of the associated element. LABEL type STRING, @@ -93,7 +101,9 @@ public section. PROVENANCE_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_CATEGORY. types: - "! The original labeling from the input document, without the submitted feedback. + "!

+ "! 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, @@ -106,8 +116,9 @@ public section. MODIFICATION type STRING, end of T_ORIGINAL_LABELS_OUT. types: - "! The updated labeling from the input document, accounting for the submitted - "! feedback. + "!

+ "! 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, @@ -119,7 +130,8 @@ public section. MODIFICATION type STRING, end of T_UPDATED_LABELS_OUT. types: - "! Pagination details, if required by the length of the output. + "!

+ "! 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, @@ -133,7 +145,8 @@ public section. TOTAL type LONG, end of T_PAGINATION. types: - "! Information returned from the **Add Feedback** method. + "!

+ "! 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`. @@ -159,7 +172,8 @@ public section. PAGINATION type T_PAGINATION, end of T_FEEDBACK_DATA_OUTPUT. types: - "! List of document attributes. + "!

+ "! List of document attributes.

begin of T_ATTRIBUTE, "! The type of attribute. TYPE type STRING, @@ -170,13 +184,16 @@ public section. LOCATION type T_LOCATION, end of T_ATTRIBUTE. types: - "! Information defining an element's subject matter. + "!

+ "! 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. + "!

+ "! 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. @@ -195,8 +212,9 @@ public section. 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. + "!

+ "! 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, @@ -205,12 +223,14 @@ public section. 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. + "!

+ "! 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. + "!

+ "! 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. @@ -220,7 +240,9 @@ public section. END type INTEGER, end of T_ELEMENT_LOCATIONS. types: - "! The leading sentences in a section or subsection of the input document. + "!

+ "! 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, @@ -232,10 +254,11 @@ public section. 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. + "!

+ "! 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, @@ -251,7 +274,8 @@ public section. 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. + "!

+ "! 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. @@ -265,12 +289,13 @@ public section. 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`. + "!

+ "! 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. + "! No documentation available. begin of T_ERROR_RESPONSE, "! The HTTP error status code. CODE type INTEGER, @@ -278,7 +303,8 @@ public section. ERROR type STRING, end of T_ERROR_RESPONSE. types: - "! A contact. + "!

+ "! A contact.

begin of T_CONTACT, "! A string listing the name of the contact. NAME type STRING, @@ -286,7 +312,8 @@ public section. ROLE type STRING, end of T_CONTACT. types: - "! The table's section title, if identified. + "!

+ "! The table's section title, if identified.

begin of T_SECTION_TITLE, "! The text of the section title, if identified. TEXT type STRING, @@ -295,8 +322,9 @@ public section. 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. + "!

+ "! 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, @@ -309,18 +337,19 @@ public section. "! 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. + "! 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. + "! 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. + "! 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. + "! 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. + "!

+ "! 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, @@ -329,9 +358,10 @@ public section. 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. + "!

+ "! 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`. @@ -340,7 +370,9 @@ public section. TEXT type STRING, end of T_TABLE_TITLE. types: - "! Cells that are not table header, column header, or row header cells. + "!

+ "! 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, @@ -350,13 +382,13 @@ public section. "! 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. + "! 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. + "! 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. + "! 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. + "! 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. @@ -382,7 +414,8 @@ public section. 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. + "!

+ "! A key in a key-value pair.

begin of T_KEY, "! The unique ID of the key in the table. CELL_ID type STRING, @@ -393,7 +426,8 @@ public section. TEXT type STRING, end of T_KEY. types: - "! A value in a key-value pair. + "!

+ "! A value in a key-value pair.

begin of T_VALUE, "! The unique ID of the value in the table. CELL_ID type STRING, @@ -404,7 +438,8 @@ public section. TEXT type STRING, end of T_VALUE. types: - "! Key-value pairs detected across cell boundaries. + "!

+ "! Key-value pairs detected across cell boundaries.

begin of T_KEY_VALUE_PAIR, "! A key in a key-value pair. KEY type T_KEY, @@ -412,7 +447,8 @@ public section. 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. + "!

+ "! 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, @@ -422,18 +458,19 @@ public section. "! 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. + "! 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. + "! 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. + "! 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. + "! 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. + "!

+ "! 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, @@ -446,17 +483,18 @@ public section. "! 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. + "! 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. + "! 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. + "! 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. + "! 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. + "!

+ "! 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`. @@ -464,7 +502,7 @@ public section. "! 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. + "! 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 @@ -490,7 +528,8 @@ public section. 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. + "!

+ "! Information about the parsed input document.

begin of T_DOC_INFO, "! The full text of the parsed document in HTML format. HTML type STRING, @@ -501,7 +540,8 @@ public section. HASH type STRING, end of T_DOC_INFO. types: - "! The analysis of the document's tables. + "!

+ "! The analysis of the document's tables.

begin of T_TABLE_RETURN, "! Information about the parsed input document. DOCUMENT type T_DOC_INFO, @@ -514,7 +554,8 @@ public section. 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. + "!

+ "! Information about the document and the submitted feedback.

begin of T_FEEDBACK_RETURN, "! The unique ID of the feedback object. FEEDBACK_ID type STRING, @@ -528,8 +569,9 @@ public section. 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. + "!

+ "! 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, @@ -546,7 +588,8 @@ public section. UNIT type STRING, end of T_INTERPRETATION. types: - "! A monetary amount identified in the input document. + "!

+ "! 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, @@ -565,7 +608,8 @@ public section. LOCATION type T_LOCATION, end of T_CONTRACT_AMTS. types: - "! The contract currencies that are declared in the document. + "!

+ "! 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, @@ -582,7 +626,8 @@ public section. LOCATION type T_LOCATION, end of T_CONTRACT_CURRENCIES. types: - "! The document's payment duration or durations. + "!

+ "! 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, @@ -601,7 +646,8 @@ public section. LOCATION type T_LOCATION, end of T_PAYMENT_TERMS. types: - "! A component part of the document. + "!

+ "! 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`. @@ -617,7 +663,8 @@ public section. ATTRIBUTES type STANDARD TABLE OF T_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, end of T_ELEMENT. types: - "! Termination dates identified in the input document. + "!

+ "! 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, @@ -633,7 +680,8 @@ public section. LOCATION type T_LOCATION, end of T_TERMINATION_DATES. types: - "! The contract type identified in the input document. + "!

+ "! 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, @@ -646,7 +694,8 @@ public section. LOCATION type T_LOCATION, end of T_CONTRACT_TYPES. types: - "! An effective date. + "!

+ "! An effective date.

begin of T_EFFECTIVE_DATES, "! The confidence level in the identification of the effective date. CONFIDENCE_LEVEL type STRING, @@ -662,7 +711,8 @@ public section. LOCATION type T_LOCATION, end of T_EFFECTIVE_DATES. types: - "! A mention of a party. + "!

+ "! A mention of a party.

begin of T_MENTION, "! The name of the party. TEXT type STRING, @@ -671,7 +721,8 @@ public section. LOCATION type T_LOCATION, end of T_MENTION. types: - "! A party's address. + "!

+ "! A party's address.

begin of T_ADDRESS, "! A string listing the address. TEXT type STRING, @@ -680,24 +731,26 @@ public section. LOCATION type T_LOCATION, end of T_ADDRESS. types: - "! A party and its corresponding role, including address and contact information if - "! identified. + "!

+ "! 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. + "! The normalized form of the party's name. PARTY type STRING, - "! A string identifying the party's role. + "! 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. + "! 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. + "! 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. + "!

+ "! Basic information about the input document.

begin of T_DOCUMENT, "! Document title, if detected. TITLE type STRING, @@ -705,13 +758,14 @@ public section. 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. + "! 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. + "!

+ "! 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, @@ -730,7 +784,9 @@ public section. LOCATION type T_LOCATION, end of T_CONTRACT_TERMS. types: - "! The analysis of objects returned by the **Element classification** method. + "!

+ "! 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, @@ -753,7 +809,7 @@ public section. 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. + "! 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, @@ -765,7 +821,9 @@ public section. 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. + "!

+ "! 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, @@ -774,7 +832,8 @@ public section. CATEGORIES type STANDARD TABLE OF T_CATEGORY WITH NON-UNIQUE DEFAULT KEY, end of T_ORIGINAL_LABELS_IN. types: - "! Details of semantically aligned elements. + "!

+ "! 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. @@ -793,7 +852,7 @@ public section. ATTRIBUTES type STANDARD TABLE OF T_ATTRIBUTE WITH NON-UNIQUE DEFAULT KEY, end of T_ELEMENT_PAIR. types: - "! No documentation available. + "! 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, @@ -808,7 +867,8 @@ public section. SIGNIFICANT_ELEMENTS type BOOLEAN, end of T_ALIGNED_ELEMENT. types: - "! The comparison of the two submitted documents. + "!

+ "! 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`. @@ -826,7 +886,8 @@ public section. 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. + "!

+ "! The HTML converted from an input document.

begin of T_HTMLRETURN, "! The number of pages in the input document. NUM_PAGES type STRING, @@ -840,7 +901,8 @@ public section. HTML type STRING, end of T_HTMLRETURN. types: - "! Feedback data for submission. + "!

+ "! 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, @@ -863,11 +925,13 @@ public section. 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. + "!

+ "! 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. + "!

+ "! 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`. @@ -896,32 +960,37 @@ public section. UPDATED type DATETIME, end of T_BATCH_STATUS. types: - "! The results of a successful **List Batches** request. + "!

+ "! 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. + "! 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. + "!

+ "! 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`. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! The status and message of the deletion request.

begin of T_FEEDBACK_DELETED, "! HTTP return code. STATUS type INTEGER, @@ -929,7 +998,8 @@ public section. MESSAGE type STRING, end of T_FEEDBACK_DELETED. types: - "! The feedback to be added to an element in the document. + "!

+ "! 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, @@ -939,19 +1009,19 @@ public section. FEEDBACK_DATA type T_FEEDBACK_DATA_INPUT, end of T_FEEDBACK_INPUT. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT1, "! The document to classify. FILE type FILE, end of T_INLINE_OBJECT1. types: - "! No documentation available. + "! 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. + "! No documentation available. begin of T_INLINE_OBJECT3, "! The first document to compare. FILE_1 type FILE, @@ -959,7 +1029,7 @@ public section. FILE_2 type FILE, end of T_INLINE_OBJECT3. types: - "! No documentation available. + "! 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 @@ -983,29 +1053,34 @@ public section. OUTPUT_BUCKET_NAME type STRING, end of T_INLINE_OBJECT4. types: - "! The results of a successful **Get Feedback** request for a single feedback - "! entry. + "!

+ "! 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. + "! 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. + "!

+ "! 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. + "!

+ "! 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|', @@ -1078,6 +1153,7 @@ constants: 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', @@ -1227,7 +1303,8 @@ constants: redefinition . - "! Convert document to HTML. + "!

Convert document to HTML

+ "! Converts a document to HTML. "! "! @parameter I_FILE | "! The document to convert. @@ -1237,8 +1314,8 @@ constants: "! 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. - "! + "! 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. @@ -1255,7 +1332,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Classify the elements of a document. + "!

Classify the elements of a document

+ "! Analyzes the structural and semantic elements of a document. "! "! @parameter I_FILE | "! The document to classify. @@ -1265,8 +1343,8 @@ constants: "! 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. - "! + "! 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. @@ -1283,7 +1361,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Extract a document's tables. + "!

Extract a document's tables

+ "! Analyzes the tables in a document. "! "! @parameter I_FILE | "! The document on which to run table extraction. @@ -1293,8 +1372,8 @@ constants: "! 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. - "! + "! 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. @@ -1311,7 +1390,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Compare two documents. + "!

Compare two documents

+ "! Compares two input documents. Documents must be in the same format. "! "! @parameter I_FILE_1 | "! The first document to compare. @@ -1329,8 +1409,8 @@ constants: "! 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. - "! + "! 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. @@ -1351,7 +1431,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add feedback. + "!

Add feedback

+ "! Adds feedback in the form of _labels_ from a subject-matter expert (SME) to a + "! governing document.
+ "! **Important:** Feedback is not immediately incorporated into the training model, + "! nor is it guaranteed to be incorporated at a later date. Instead, submitted + "! feedback is used to suggest future updates to the training model. "! "! @parameter I_FEEDBACK_DATA | "! An object that defines the feedback to be submitted. @@ -1368,7 +1453,8 @@ constants: !E_RESPONSE type T_FEEDBACK_RETURN raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List the feedback in a 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 @@ -1454,7 +1540,8 @@ constants: !E_RESPONSE type T_FEEDBACK_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a specified feedback entry. + "!

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. @@ -1462,8 +1549,8 @@ constants: "! 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. - "! + "! 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. @@ -1477,7 +1564,8 @@ constants: !E_RESPONSE type T_GET_FEEDBACK raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a specified feedback entry. + "!

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. @@ -1485,8 +1573,8 @@ constants: "! 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. - "! + "! 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. @@ -1501,7 +1589,16 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Submit a batch-processing request. + "!

Submit a batch-processing request

+ "! Run Compare and Comply methods over a collection of input documents.
+ "!
+ "! **Important:** Batch processing requires the use of the [IBM Cloud Object + "! Storage + "! service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-o + "! bject-storage-about#about-ibm-cloud-object-storage). The use of IBM Cloud Object + "! Storage with Compare and Comply is discussed at [Using batch + "! processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-co + "! mply-batching#before-you-batch). "! "! @parameter I_FUNCTION | "! The Compare and Comply method to run across the submitted input documents. @@ -1529,8 +1626,8 @@ constants: "! 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. - "! + "! 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. @@ -1553,7 +1650,8 @@ constants: !E_RESPONSE type T_BATCH_STATUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List submitted batch-processing jobs. + "!

List submitted batch-processing jobs

+ "! Lists batch-processing jobs submitted by users. "! "! @parameter E_RESPONSE | "! Service return value of type T_BATCHES @@ -1566,7 +1664,8 @@ constants: !E_RESPONSE type T_BATCHES raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get information about a specific batch-processing job. + "!

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. @@ -1582,7 +1681,9 @@ constants: !E_RESPONSE type T_BATCH_STATUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a pending or active batch-processing job. + "!

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. @@ -1592,8 +1693,8 @@ constants: "! 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. - "! + "! 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. @@ -1686,7 +1787,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092814'. + e_sdk_version_date = '20200310173424'. endmethod. diff --git a/src/zcl_ibmc_compare_comply_v1.clas.xml b/src/zcl_ibmc_compare_comply_v1.clas.xml index ad98c9c..a1df9c7 100644 --- a/src/zcl_ibmc_compare_comply_v1.clas.xml +++ b/src/zcl_ibmc_compare_comply_v1.clas.xml @@ -5,12 +5,86 @@ ZCL_IBMC_COMPARE_COMPLY_V1 E - IBM Watson Compare and Comply + Compare and Comply 1 X X X + + + ZCL_IBMC_COMPARE_COMPLY_V1 + ADD_FEEDBACK + E + Add feedback + + + ZCL_IBMC_COMPARE_COMPLY_V1 + CLASSIFY_ELEMENTS + E + Classify the elements of a document + + + ZCL_IBMC_COMPARE_COMPLY_V1 + COMPARE_DOCUMENTS + E + Compare two documents + + + ZCL_IBMC_COMPARE_COMPLY_V1 + CONVERT_TO_HTML + E + Convert document to HTML + + + ZCL_IBMC_COMPARE_COMPLY_V1 + CREATE_BATCH + E + Submit a batch-processing request + + + ZCL_IBMC_COMPARE_COMPLY_V1 + DELETE_FEEDBACK + E + Delete a specified feedback entry + + + ZCL_IBMC_COMPARE_COMPLY_V1 + EXTRACT_TABLES + E + Extract a document's tables + + + ZCL_IBMC_COMPARE_COMPLY_V1 + GET_BATCH + E + Get information about a specific batch-processing job + + + ZCL_IBMC_COMPARE_COMPLY_V1 + GET_FEEDBACK + E + Get a specified feedback entry + + + ZCL_IBMC_COMPARE_COMPLY_V1 + LIST_BATCHES + E + List submitted batch-processing jobs + + + ZCL_IBMC_COMPARE_COMPLY_V1 + LIST_FEEDBACK + E + List the feedback in a document + + + ZCL_IBMC_COMPARE_COMPLY_V1 + UPDATE_BATCH + E + Update a pending or active batch-processing job + + diff --git a/src/zcl_ibmc_discovery_v1.clas.abap b/src/zcl_ibmc_discovery_v1.clas.abap index 5a479bf..dce6b17 100644 --- a/src/zcl_ibmc_discovery_v1.clas.abap +++ b/src/zcl_ibmc_discovery_v1.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Discovery

+"!

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 @@ -24,7 +24,9 @@ class ZCL_IBMC_DISCOVERY_V1 DEFINITION public section. types: - "! An aggregation produced by Discovery to analyze the input provided. + "!

+ "! 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, @@ -36,7 +38,8 @@ public section. AGGREGATIONS type STANDARD TABLE OF DATA_REFERENCE WITH NON-UNIQUE DEFAULT KEY, end of T_QUERY_AGGREGATION. types: - "! Aggregation results for the specified query. + "!

+ "! Aggregation results for the specified query.

begin of T_AGGREGATION_RESULT, "! Key that matched the aggregation type. KEY type STRING, @@ -46,7 +49,8 @@ public section. AGGREGATIONS type STANDARD TABLE OF T_QUERY_AGGREGATION WITH NON-UNIQUE DEFAULT KEY, end of T_AGGREGATION_RESULT. types: - "! Training status details. + "!

+ "! Training status details.

begin of T_TRAINING_STATUS, "! The total number of training examples uploaded to this collection. TOTAL_EXAMPLES type INTEGER, @@ -71,7 +75,8 @@ public section. DATA_UPDATED type DATETIME, end of T_TRAINING_STATUS. types: - "! Object describing the current status of the wordlist. + "!

+ "! 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, @@ -79,20 +84,24 @@ public section. TYPE type STRING, end of T_TOKEN_DICT_STATUS_RESPONSE. types: - "! An object that indicates the Categories enrichment will be applied to the - "! specified field. + "!

+ "! An object that indicates the Categories enrichment will be

+ "! applied to the specified field. T_NLU_ENRICHMENT_CATEGORIES type MAP. types: - "! An object specifying the relations enrichment and related parameters. + "!

+ "! 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`. + "! *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. - "! + "!

+ "! 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, @@ -101,7 +110,9 @@ public section. 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. + "!

+ "! 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, @@ -112,7 +123,9 @@ public section. LIMIT type INTEGER, end of T_NL_ENRICHMENT_SEMANTIC_ROLES. types: - "! An object speficying the Entities enrichment and related parameters. + "!

+ "! 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. @@ -137,7 +150,9 @@ public section. MODEL type STRING, end of T_NLU_ENRICHMENT_ENTITIES. types: - "! An object specifying the emotion detection enrichment and related parameters. + "!

+ "! 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, @@ -146,14 +161,18 @@ public section. 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. + "!

+ "! 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. + "!

+ "! 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. @@ -166,7 +185,9 @@ public section. LIMIT type INTEGER, end of T_NLU_ENRICHMENT_KEYWORDS. types: - "! Object containing Natural Language Understanding features to be used. + "!

+ "! 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, @@ -188,8 +209,9 @@ public section. 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. + "!

+ "! 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, @@ -202,7 +224,8 @@ public section. LANGUAGE type STRING, end of T_NLU_ENRICHMENT_OPTIONS. types: - "! An object defining a single tokenizaion rule. + "!

+ "! An object defining a single tokenizaion rule.

begin of T_TOKEN_DICT_RULE, "! The string to tokenize. TEXT type STRING, @@ -216,8 +239,9 @@ public section. 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. + "!

+ "! 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 @@ -225,13 +249,14 @@ public section. TOKENIZATION_RULES type STANDARD TABLE OF T_TOKEN_DICT_RULE WITH NON-UNIQUE DEFAULT KEY, end of T_TOKEN_DICT. types: - "! No documentation available. + "! 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. + "!

+ "! 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, @@ -260,30 +285,32 @@ public section. "! 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`. + "! 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: - "! Object containing details of the stored credentials.
- "!
- "! Obtain credentials for your source from the administrator of the source. + "!

+ "! Object containing details of the stored credentials.


+ "!
+ "! Obtain credentials for your source from the administrator of the source. begin of T_CREDENTIAL_DETAILS, "! The authentication method for this credentials definition. The "! **credential_type** specified must be supported by the **source_type**. The "! following combinations are possible:
"!
- "! - `"source_type": "box"` - valid `credential_type`s: `oauth2`
- "! - `"source_type": "salesforce"` - valid `credential_type`s: + "! - `"source_type": "box"` - valid `credential_type`s: + "! `oauth2`
+ "! - `"source_type": "salesforce"` - valid `credential_type`s: "! `username_password`
- "! - `"source_type": "sharepoint"` - valid `credential_type`s: `saml` with - "! **source_version** of `online`, or `ntlm_v1` with **source_version** of - "! `2016`
- "! - `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or - "! `basic`
- "! - "source_type": "cloud_object_storage"` - valid `credential_type`s: - "! `aws4_hmac`. + "! - `"source_type": "sharepoint"` - valid `credential_type`s: + "! `saml` with **source_version** of `online`, or `ntlm_v1` with + "! **source_version** of `2016`
+ "! - `"source_type": "web_crawl"` - valid `credential_type`s: + "! `noauth` or `basic`
+ "! - "source_type": "cloud_object_storage"` - valid + "! `credential_type`s: `aws4_hmac`. CREDENTIAL_TYPE type STRING, "! The **client_id** of the source that these credentials connect to. Only valid, "! and required, with a **credential_type** of `oauth2`. @@ -364,7 +391,8 @@ public section. SECRET_ACCESS_KEY type STRING, end of T_CREDENTIAL_DETAILS. types: - "! Object containing credential information. + "!

+ "! Object containing credential information.

begin of T_CREDENTIALS, "! Unique identifier for this set of credentials. CREDENTIAL_ID type STRING, @@ -390,13 +418,15 @@ public section. STATUS type STRING, end of T_CREDENTIALS. types: - "! Object containing array of credential definitions. + "!

+ "! 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. + "!

+ "! Summary of the collection usage in the environment.

begin of T_COLLECTION_USAGE, "! Number of active collections in the environment. AVAILABLE type INTEGER, @@ -404,24 +434,29 @@ public section. MAXIMUM_ALLOWED type INTEGER, end of T_COLLECTION_USAGE. types: - "! Summary of the disk usage statistics for the environment. + "!

+ "! 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. + "! 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. + "! 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. + "!

+ "! Summary of the document usage statistics for the

+ "! environment. begin of T_ENVIRONMENT_DOCUMENTS, "! Number of documents indexed for the environment. INDEXED type INTEGER, - "! Total number of documents allowed in the environment's capacity. + "! 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. + "!

+ "! 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, @@ -431,7 +466,9 @@ public section. COLLECTIONS type T_COLLECTION_USAGE, end of T_INDEX_CAPACITY. types: - "! Information about the Continuous Relevancy Training for this environment. + "!

+ "! 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, @@ -443,7 +480,8 @@ public section. LAST_TRAINED type DATE, end of T_SEARCH_STATUS. types: - "! Details about an environment. + "!

+ "! Details about an environment.

begin of T_ENVIRONMENT, "! Unique identifier for the environment. ENVIRONMENT_ID type STRING, @@ -451,10 +489,11 @@ public section. 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'`. + "! 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'`. + "! `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 @@ -477,13 +516,16 @@ public section. SEARCH_STATUS type T_SEARCH_STATUS, end of T_ENVIRONMENT. types: - "! Response object containing an array of configured environments. + "!

+ "! 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. + "!

+ "! Gatway deletion confirmation.

begin of T_GATEWAY_DELETE, "! The gateway ID of the deleted gateway. GATEWAY_ID type STRING, @@ -491,7 +533,8 @@ public section. STATUS type STRING, end of T_GATEWAY_DELETE. types: - "! Training example details. + "!

+ "! Training example details.

begin of T_TRAINING_EXAMPLE, "! The document ID associated with this training example. DOCUMENT_ID type STRING, @@ -501,7 +544,8 @@ public section. RELEVANCE type INTEGER, end of T_TRAINING_EXAMPLE. types: - "! Training query details. + "!

+ "! Training query details.

begin of T_TRAINING_QUERY, "! The query ID associated with the training query. QUERY_ID type STRING, @@ -514,12 +558,13 @@ public section. EXAMPLES type STANDARD TABLE OF T_TRAINING_EXAMPLE WITH NON-UNIQUE DEFAULT KEY, end of T_TRAINING_QUERY. types: - "! A passage query result. + "!

+ "! 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 + "! The confidence score of the passages's analysis. A higher score indicates "! greater confidence. PASSAGE_SCORE type DOUBLE, "! The content of the extracted passage. @@ -534,7 +579,8 @@ public section. FIELD type STRING, end of T_QUERY_PASSAGES. types: - "! Object containing normalization operations. + "!

+ "! Object containing normalization operations.

begin of T_NORMALIZATION_OPERATION, "! Identifies what type of operation to perform.
"!
@@ -574,7 +620,8 @@ public section. DESTINATION_FIELD type STRING, end of T_NORMALIZATION_OPERATION. types: - "! Font matching configuration. + "!

+ "! 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, @@ -590,7 +637,9 @@ public section. NAME type STRING, end of T_FONT_SETTING. types: - "! Microsoft Word styles to convert into a specified HTML head level. + "!

+ "! 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, @@ -598,8 +647,9 @@ public section. 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. + "!

+ "! 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, @@ -607,19 +657,24 @@ public section. 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. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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, @@ -630,7 +685,8 @@ public section. LIMIT type INTEGER, end of T_SOURCE_OPTIONS_FOLDER. types: - "! Object defining a cloud object store bucket to crawl. + "!

+ "! 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, @@ -639,7 +695,8 @@ public section. LIMIT type INTEGER, end of T_SOURCE_OPTIONS_BUCKETS. types: - "! Object containing the schedule information for the source. + "!

+ "! 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 @@ -659,8 +716,9 @@ public section. FREQUENCY type STRING, end of T_SOURCE_SCHEDULE. types: - "! Object that defines a Salesforce document object type crawl with this - "! configuration. + "!

+ "! 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, @@ -669,8 +727,9 @@ public section. LIMIT type INTEGER, end of T_SOURCE_OPTIONS_OBJECT. types: - "! Object that defines a Microsoft SharePoint site collection to crawl with this - "! configuration. + "!

+ "! 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 @@ -681,7 +740,9 @@ public section. LIMIT type INTEGER, end of T_SOURCE_OPTIONS_SITE_COLL. types: - "! The **options** object defines which items to crawl from the source system. + "!

+ "! 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`. @@ -707,7 +768,8 @@ public section. CRAWL_ALL_BUCKETS type BOOLEAN, end of T_SOURCE_OPTIONS. types: - "! Object containing source parameters for the configuration. + "!

+ "! Object containing source parameters for the configuration.

begin of T_SOURCE, "! The type of source to connect to.
"! - `box` indicates the configuration is to connect an instance of Enterprise @@ -730,13 +792,15 @@ public section. OPTIONS type T_SOURCE_OPTIONS, end of T_SOURCE. types: - "! Object containing an array of XPaths. + "!

+ "! 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. + "!

+ "! 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, @@ -748,12 +812,14 @@ public section. "! detection is recommended. LANGUAGE type STRING, "! *For use with `elements` enrichments only.* The element extraction model to use. - "! * Models available are: `contract`. + "! 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. + "!

+ "! 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, @@ -790,7 +856,8 @@ public section. OPTIONS type T_ENRICHMENT_OPTIONS, end of T_ENRICHMENT. types: - "! A list of Document Segmentation settings. + "!

+ "! A list of Document Segmentation settings.

begin of T_SEGMENT_SETTINGS, "! Enables/disables the Document Segmentation feature. ENABLED type BOOLEAN, @@ -813,14 +880,16 @@ public section. ANNOTATED_FIELDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_SEGMENT_SETTINGS. types: - "! A list of Word conversion settings. + "!

+ "! 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. + "!

+ "! 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, @@ -836,7 +905,8 @@ public section. EXCLUDE_TAG_ATTRIBUTES type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_HTML_SETTINGS. types: - "! Document conversion settings. + "!

+ "! Document conversion settings.

begin of T_CONVERSIONS, "! A list of PDF conversion settings. PDF type T_PDF_SETTINGS, @@ -858,17 +928,18 @@ public section. IMAGE_TEXT_RECOGNITION type BOOLEAN, end of T_CONVERSIONS. types: - "! A custom configuration for the environment. + "!

+ "! 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'. + "! 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'. + "! yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. UPDATED type DATETIME, "! The description of the configuration, if available. DESCRIPTION type STRING, @@ -884,13 +955,15 @@ public section. SOURCE type T_SOURCE, end of T_CONFIGURATION. types: - "! Object containing an array of available configurations. + "!

+ "! 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. + "!

+ "! 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 @@ -906,7 +979,8 @@ public section. NEXT_CRAWL type DATETIME, end of T_SOURCE_STATUS. types: - "! Object returned after credentials are deleted. + "!

+ "! 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, @@ -914,7 +988,8 @@ public section. STATUS type STRING, end of T_DELETE_CREDENTIALS. types: - "! A notice produced for the collection. + "!

+ "! 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 @@ -930,7 +1005,8 @@ public section. "! `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'. + "! 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, @@ -947,7 +1023,8 @@ public section. DESCRIPTION type STRING, end of T_NOTICE. types: - "! Information returned after an uploaded document is accepted. + "!

+ "! Information returned after an uploaded document is accepted.

begin of T_DOCUMENT_ACCEPTED, "! The unique identifier of the ingested document. DOCUMENT_ID type STRING, @@ -959,7 +1036,8 @@ public section. NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, end of T_DOCUMENT_ACCEPTED. types: - "! Object describing a specific gateway. + "!

+ "! Object describing a specific gateway.

begin of T_GATEWAY, "! The gateway ID of the gateway. GATEWAY_ID type STRING, @@ -977,7 +1055,8 @@ public section. TOKEN_ID type STRING, end of T_GATEWAY. types: - "! Aggregation result data for the requested metric. + "!

+ "! 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, @@ -991,7 +1070,9 @@ public section. EVENT_RATE type DOUBLE, end of T_METRIC_AGGREGATION_RESULT. types: - "! An aggregation analyzing log information for queries and events. + "!

+ "! 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`). @@ -1003,13 +1084,15 @@ public section. 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. + "!

+ "! 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. + "!

+ "! 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 @@ -1023,7 +1106,8 @@ public section. CONFIDENCE type DOUBLE, end of T_QUERY_RESULT_METADATA. types: - "! Query result object. + "!

+ "! Query result object.

begin of T_QUERY_NOTICES_RESULT, "! The unique identifier of the document. ID type STRING, @@ -1046,8 +1130,9 @@ public section. 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. + "!

+ "! 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. @@ -1057,15 +1142,17 @@ public section. "! 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. + "! 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`. + "!

+ "! 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, @@ -1073,7 +1160,8 @@ public section. COUNT type INTEGER, end of T_LOG_QUERY_RESP_RESULT_DOCS. types: - "! Object containing field details. + "!

+ "! Object containing field details.

begin of T_FIELD, "! The name of the field. FIELD type STRING, @@ -1081,7 +1169,8 @@ public section. TYPE type STRING, end of T_FIELD. types: - "! Query event data object. + "!

+ "! Query event data object.

begin of T_EVENT_DATA, "! The **environment_id** associated with the query that the event is associated "! with. @@ -1103,7 +1192,8 @@ public section. QUERY_ID type STRING, end of T_EVENT_DATA. types: - "! An object defining the event being created. + "!

+ "! An object defining the event being created.

begin of T_CREATE_EVENT_OBJECT, "! The event type to be created. TYPE type STRING, @@ -1111,17 +1201,18 @@ public section. DATA type T_EVENT_DATA, end of T_CREATE_EVENT_OBJECT. types: - "! No documentation available. + "! 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. + "!

+ "! 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. + "! 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 @@ -1195,13 +1286,15 @@ public section. BIAS type STRING, end of T_QUERY_LARGE. types: - "! Object containing user-defined name. + "!

+ "! 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. + "!

+ "! Object containing collection document count information.

begin of T_DOCUMENT_COUNTS, "! The total number of available documents in the collection. AVAILABLE type LONG, @@ -1214,8 +1307,9 @@ public section. PENDING type LONG, end of T_DOCUMENT_COUNTS. types: - "! Information about custom smart document understanding fields that exist in this - "! collection. + "!

+ "! 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, @@ -1223,7 +1317,9 @@ public section. MAXIMUM_ALLOWED type LONG, end of T_SDU_STATUS_CUSTOM_FIELDS. types: - "! Object containing smart document understanding information for this collection. + "!

+ "! 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 @@ -1250,19 +1346,23 @@ public section. CUSTOM_FIELDS type T_SDU_STATUS_CUSTOM_FIELDS, end of T_SDU_STATUS. types: - "! Object containing information about the crawl status of this collection. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! A collection for storing documents.

begin of T_COLLECTION, "! The unique identifier of the collection. COLLECTION_ID type STRING, @@ -1271,14 +1371,14 @@ public section. "! 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'. + "! 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'. + "! 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. + "! 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). @@ -1295,18 +1395,21 @@ public section. SMART_DOCUMENT_UNDERSTANDING type T_SDU_STATUS, end of T_COLLECTION. types: - "! Array of Microsoft Word styles to convert. + "!

+ "! 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. + "!

+ "! 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`. + "! Models available are: `contract`. MODEL type STRING, end of T_ELEMENTS_ENRICHMENT_OPTIONS. types: - "! Object containing information about a new environment. + "!

+ "! Object containing information about a new environment.

begin of T_CREATE_ENVIRONMENT_REQUEST, "! Name that identifies the environment. NAME type STRING, @@ -1317,7 +1420,8 @@ public section. SIZE type STRING, end of T_CREATE_ENVIRONMENT_REQUEST. types: - "! Object containing specification for a new collection. + "!

+ "! Object containing specification for a new collection.

begin of T_CREATE_COLLECTION_REQUEST, "! The name of the collection to be created. NAME type STRING, @@ -1330,13 +1434,14 @@ public section. LANGUAGE type STRING, end of T_CREATE_COLLECTION_REQUEST. types: - "! No documentation available. + "! 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. + "!

+ "! Query result object.

begin of T_QUERY_RESULT, "! The unique identifier of the document. ID type STRING, @@ -1348,7 +1453,8 @@ public section. RESULT_METADATA type T_QUERY_RESULT_METADATA, end of T_QUERY_RESULT. types: - "! Top hit information for this query. + "!

+ "! Top hit information for this query.

begin of T_TOP_HITS_RESULTS, "! Number of matching results. MATCHING_RESULTS type INTEGER, @@ -1356,7 +1462,8 @@ public section. 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. + "!

+ "! 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, @@ -1365,7 +1472,7 @@ public section. STATUS type STRING, end of T_DELETE_COLLECTION_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_TERM, "! The field where the aggregation is located in the document. FIELD type STRING, @@ -1373,13 +1480,15 @@ public section. COUNT type INTEGER, end of T_TERM. types: - "! An object containing an array of autocompletion suggestions. + "!

+ "! 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. + "!

+ "! 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 @@ -1394,7 +1503,8 @@ public section. DOCUMENT_RETRIEVAL_STRATEGY type STRING, end of T_RETRIEVAL_DETAILS. types: - "! Response object returned when deleting an environment. + "!

+ "! Response object returned when deleting an environment.

begin of T_DELETE_ENVIRONMENT_RESPONSE, "! The unique identifier for the environment. ENVIRONMENT_ID type STRING, @@ -1402,27 +1512,29 @@ public section. STATUS type STRING, end of T_DELETE_ENVIRONMENT_RESPONSE. types: - "! The list of fetched fields.
- "!
- "! The fields are returned using a fully qualified name format, however, the format - "! differs slightly from that used by the query operations.
- "!
- "! * Fields which contain nested JSON objects are assigned a type of - "! "nested".
- "!
- "! * Fields which belong to a nested object are prefixed with `.properties` (for - "! example, `warnings.properties.severity` means that the `warnings` object has a - "! property called `severity`).
- "!
- "! * Fields returned from the News collection are prefixed with - "! `v{N}-fullnews-t3-{YEAR}.mappings` (for example, - "! `v5-fullnews-t3-2016.mappings.text.properties.author`). + "!

+ "! The list of fetched fields.


+ "!
+ "! The fields are returned using a fully qualified name format, however, the format + "! differs slightly from that used by the query operations.
+ "!
+ "! * Fields which contain nested JSON objects are assigned a type of + "! "nested".
+ "!
+ "! * Fields which belong to a nested object are prefixed with `.properties` (for + "! example, `warnings.properties.severity` means that the `warnings` object has a + "! property called `severity`).
+ "!
+ "! * Fields returned from the News collection are prefixed with + "! `v{N}-fullnews-t3-{YEAR}.mappings` (for example, + "! `v5-fullnews-t3-2016.mappings.text.properties.author`). begin of T_LST_COLLECTION_FIELDS_RESP, "! An array containing information about each field in the collections. FIELDS type STANDARD TABLE OF T_FIELD WITH NON-UNIQUE DEFAULT KEY, end of T_LST_COLLECTION_FIELDS_RESP. types: - "! Object containing collection update information. + "!

+ "! Object containing collection update information.

begin of T_UPDATE_COLLECTION_REQUEST, "! The name of the collection. NAME type STRING, @@ -1432,13 +1544,15 @@ public section. CONFIGURATION_ID type STRING, end of T_UPDATE_COLLECTION_REQUEST. types: - "! Object containing gateways array. + "!

+ "! 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. + "!

+ "! 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. @@ -1451,7 +1565,9 @@ public section. EVENT_RATE type DOUBLE, end of T_METRIC_TOKEN_AGGR_RESULT. types: - "! An aggregation analyzing log information for queries and events. + "!

+ "! 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`. @@ -1460,11 +1576,12 @@ public section. 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. + "!

+ "! 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. + "! 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 @@ -1546,7 +1663,8 @@ public section. SPELLING_SUGGESTIONS type BOOLEAN, end of T_COLL_QUERY_LARGE. types: - "! Object containing environment update information. + "!

+ "! Object containing environment update information.

begin of T_UPDATE_ENVIRONMENT_REQUEST, "! Name that identifies the environment. NAME type STRING, @@ -1558,7 +1676,8 @@ public section. SIZE type STRING, end of T_UPDATE_ENVIRONMENT_REQUEST. types: - "! Information returned when a configuration is deleted. + "!

+ "! Information returned when a configuration is deleted.

begin of T_DEL_CONFIGURATION_RESPONSE, "! The unique identifier for the configuration. CONFIGURATION_ID type STRING, @@ -1568,7 +1687,9 @@ public section. 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. + "!

+ "! 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, @@ -1591,7 +1712,7 @@ public section. SUGGESTED_QUERY type STRING, end of T_QUERY_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_TIMESLICE, "! The field where the aggregation is located in the document. FIELD type STRING, @@ -1604,7 +1725,8 @@ public section. ANOMALY type BOOLEAN, end of T_TIMESLICE. types: - "! Training query to add. + "!

+ "! Training query to add.

begin of T_NEW_TRAINING_QUERY, "! The natural text query for the new training query. NATURAL_LANGUAGE_QUERY type STRING, @@ -1615,7 +1737,8 @@ public section. 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. + "!

+ "! Status information about a submitted document.

begin of T_DOCUMENT_STATUS, "! The unique identifier of the document. DOCUMENT_ID type STRING, @@ -1635,11 +1758,12 @@ public section. NOTICES type STANDARD TABLE OF T_NOTICE WITH NON-UNIQUE DEFAULT KEY, end of T_DOCUMENT_STATUS. types: - "! Object that describes a long query. + "!

+ "! 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. + "! 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 @@ -1715,7 +1839,8 @@ public section. COLLECTION_IDS type STRING, end of T_FED_QUERY_LARGE. types: - "! An error response object. + "!

+ "! An error response object.

begin of T_ERROR_RESPONSE, "! The HTTP error status code. CODE type INTEGER, @@ -1723,9 +1848,10 @@ public section. 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. + "!

+ "! 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. @@ -1735,7 +1861,9 @@ public section. 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. + "!

+ "! The query expansion definitions for the specified

+ "! collection. begin of T_EXPANSIONS, "! An array of query expansion definitions.
"!
@@ -1756,7 +1884,8 @@ public section. EXPANSIONS type STANDARD TABLE OF T_EXPANSION WITH NON-UNIQUE DEFAULT KEY, end of T_EXPANSIONS. types: - "! An object defining the event being created. + "!

+ "! An object defining the event being created.

begin of T_CREATE_EVENT_RESPONSE, "! The event type that was created. TYPE type STRING, @@ -1764,23 +1893,28 @@ public section. DATA type T_EVENT_DATA, end of T_CREATE_EVENT_RESPONSE. types: - "! An array of document enrichment settings for the configuration. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! Information returned when a document is deleted.

begin of T_DELETE_DOCUMENT_RESPONSE, "! The unique identifier of the document. DOCUMENT_ID type STRING, @@ -1788,7 +1922,7 @@ public section. STATUS type STRING, end of T_DELETE_DOCUMENT_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_TOP_HITS, "! Number of top hits returned by the aggregation. SIZE type INTEGER, @@ -1796,8 +1930,10 @@ public section. 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. + "!

+ "! 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, @@ -1864,7 +2000,9 @@ public section. RESULT_TYPE type STRING, end of T_LOG_QUERY_RESPONSE_RESULT. types: - "! Object containing results that match the requested **logs** query. + "!

+ "! Object containing results that match the requested **logs**

+ "! query. begin of T_LOG_QUERY_RESPONSE, "! Number of matching results. MATCHING_RESULTS type INTEGER, @@ -1872,12 +2010,14 @@ public section. 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. + "!

+ "! 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. + "!

+ "! Training example to add.

begin of T_TRAINING_EXAMPLE_PATCH, "! The example to add. CROSS_REFERENCE type STRING, @@ -1885,13 +2025,14 @@ public section. RELEVANCE type INTEGER, end of T_TRAINING_EXAMPLE_PATCH. types: - "! Response object containing an array of collection details. + "!

+ "! 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. + "! No documentation available. begin of T_CALCULATION, "! The field where the aggregation is located in the document. FIELD type STRING, @@ -1899,7 +2040,8 @@ public section. VALUE type DOUBLE, end of T_CALCULATION. types: - "! Training information for a specific collection. + "!

+ "! 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, @@ -1909,10 +2051,12 @@ public section. 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. + "!

+ "! 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. + "!

+ "! Object containing notice query results.

begin of T_QUERY_NOTICES_RESPONSE, "! The number of matching results. MATCHING_RESULTS type INTEGER, @@ -1926,15 +2070,16 @@ public section. DUPLICATES_REMOVED type INTEGER, end of T_QUERY_NOTICES_RESPONSE. types: - "! No documentation available. + "! 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 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 '|', @@ -2057,6 +2202,7 @@ constants: 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', @@ -2313,7 +2459,12 @@ constants: redefinition . - "! Create an environment. + "!

Create an environment

+ "! Creates a new environment for private data. An environment must be created + "! before collections can be created.
+ "!
+ "! **Note**: You can create only one environment for private data per service + "! instance. An attempt to create another environment results in an error. "! "! @parameter I_BODY | "! An object that defines an environment name and optional description. The fields @@ -2332,7 +2483,8 @@ constants: !E_RESPONSE type T_ENVIRONMENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List environments. + "!

List environments

+ "! List existing environments for the service instance. "! "! @parameter I_NAME | "! Show only the environment with the given name. @@ -2348,7 +2500,7 @@ constants: !E_RESPONSE type T_LIST_ENVIRONMENTS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get environment info. + "!

Get environment info

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2364,12 +2516,15 @@ constants: !E_RESPONSE type T_ENVIRONMENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update an environment. + "!

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. + "! 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. @@ -2384,7 +2539,7 @@ constants: !E_RESPONSE type T_ENVIRONMENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete environment. + "!

Delete environment

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2400,7 +2555,9 @@ constants: !E_RESPONSE type T_DELETE_ENVIRONMENT_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List fields across collections. + "!

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. @@ -2420,7 +2577,19 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add configuration. + "!

Add configuration

+ "! Creates a new configuration.
+ "!
+ "! If the input configuration contains the **configuration_id**, **created**, or + "! **updated** properties, then they are ignored and overridden by the system, and + "! an error is not returned so that the overridden fields do not need to be + "! removed when copying a configuration.
+ "!
+ "! The configuration can contain unrecognized JSON fields. Any such fields are + "! ignored and do not generate an error. This makes it easier to use newer + "! configuration files with older versions of the API and the service. It also + "! makes it possible for the tooling to add additional metadata and information to + "! the configuration. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2455,7 +2624,8 @@ constants: !E_RESPONSE type T_CONFIGURATION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List configurations. + "!

List configurations

+ "! Lists existing configurations for the service instance. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2474,7 +2644,7 @@ constants: !E_RESPONSE type T_LIST_CONFIGURATIONS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get configuration details. + "!

Get configuration details

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2493,7 +2663,16 @@ constants: !E_RESPONSE type T_CONFIGURATION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a configuration. + "!

Update a configuration

+ "! Replaces an existing configuration.
+ "! * Completely replaces the original configuration.
+ "! * The **configuration_id**, **updated**, and **created** fields are accepted + "! in the request, but they are ignored, and an error is not generated. It is also + "! acceptable for users to submit an updated configuration with none of the three + "! properties.
+ "! * Documents are processed with a snapshot of the configuration as it was at + "! the time the document was submitted to be ingested. This means that already + "! submitted documents will not see any updates made to the configuration. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2531,7 +2710,13 @@ constants: !E_RESPONSE type T_CONFIGURATION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a 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. @@ -2551,7 +2736,7 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a collection. + "!

Create a collection

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2571,7 +2756,8 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List collections. + "!

List collections

+ "! Lists existing collections for the service instance. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2590,7 +2776,7 @@ constants: !E_RESPONSE type T_LIST_COLLECTIONS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get collection details. + "!

Get collection details

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2609,7 +2795,7 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a collection. + "!

Update a collection

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2632,7 +2818,7 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a collection. + "!

Delete a collection

"! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2651,7 +2837,8 @@ constants: !E_RESPONSE type T_DELETE_COLLECTION_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List collection fields. + "!

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. @@ -2671,7 +2858,9 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get the expansion list. + "!

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. @@ -2690,7 +2879,10 @@ constants: !E_RESPONSE type T_EXPANSIONS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create or update expansion list. + "!

Create or update expansion list

+ "! Create or replace the Expansion list for this collection. The maximum number of + "! expanded terms per collection is `500`.
+ "! The current expansion list is replaced with the uploaded content. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2713,7 +2905,9 @@ constants: !E_RESPONSE type T_EXPANSIONS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete the expansion list. + "!

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. @@ -2727,7 +2921,9 @@ constants: !I_COLLECTION_ID type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get tokenization dictionary status. + "!

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. @@ -2746,7 +2942,8 @@ constants: !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create tokenization dictionary. + "!

Create tokenization dictionary

+ "! Upload a custom tokenization dictionary to use with the specified collection. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2769,7 +2966,8 @@ constants: !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete tokenization dictionary. + "!

Delete tokenization dictionary

+ "! Delete the tokenization dictionary from the collection. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2783,7 +2981,8 @@ constants: !I_COLLECTION_ID type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get stopword list status. + "!

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. @@ -2802,7 +3001,8 @@ constants: !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create stopword list. + "!

Create stopword list

+ "! Upload a custom stopword list to use with the specified collection. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2829,7 +3029,9 @@ constants: !E_RESPONSE type T_TOKEN_DICT_STATUS_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a custom stopword list. + "!

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. @@ -2844,7 +3046,36 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add a document. + "!

Add a document

+ "! Add a document to a collection with optional metadata.
+ "!
+ "! * The **version** query parameter is still required.
+ "!
+ "! * Returns immediately after the system has accepted the document for + "! processing.
+ "!
+ "! * The user must provide document content, metadata, or both. If the request is + "! missing both document content and metadata, it is rejected.
+ "!
+ "! * The user can set the **Content-Type** parameter on the **file** part to + "! indicate the media type of the document. If the **Content-Type** parameter is + "! missing or is one of the generic media types (for example, + "! `application/octet-stream`), then the service attempts to automatically detect + "! the document's media type.
+ "!
+ "! * The following field names are reserved and will be filtered out if present + "! after normalization: `id`, `score`, `highlight`, and any field with the prefix + "! of: `_`, `+`, or `-`
+ "!
+ "! * Fields with empty name values after normalization are filtered out before + "! indexing.
+ "!
+ "! * Fields containing the following characters after normalization are filtered + "! out before indexing: `#` and `,`
+ "!
+ "! **Note:** Documents can be added with a specific **document_id** by using the + "! **/v1/environments/{environment_id}/collections/{collection_id&# + "! 125;/documents** method. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2862,8 +3093,8 @@ constants: "! @parameter I_METADATA | "! The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 "! MB are rejected. Example: ``` {
- "! "Creator": "Johnny Appleseed",
- "! "Subject": "Apples"
+ "! "Creator": "Johnny Appleseed",
+ "! "Subject": "Apples"
"! } ```. "! @parameter E_RESPONSE | "! Service return value of type T_DOCUMENT_ACCEPTED @@ -2883,7 +3114,12 @@ constants: !E_RESPONSE type T_DOCUMENT_ACCEPTED raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get document details. + "!

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. @@ -2905,7 +3141,12 @@ constants: !E_RESPONSE type T_DOCUMENT_STATUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a document. + "!

Update a document

+ "! Replace an existing document or add a document with a specified **document_id**. + "! Starts ingesting a document with optional metadata.
+ "!
+ "! **Note:** When uploading a new document with this method it automatically + "! replaces any document stored with the same **document_id** if it exists. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2925,8 +3166,8 @@ constants: "! @parameter I_METADATA | "! The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 "! MB are rejected. Example: ``` {
- "! "Creator": "Johnny Appleseed",
- "! "Subject": "Apples"
+ "! "Creator": "Johnny Appleseed",
+ "! "Subject": "Apples"
"! } ```. "! @parameter E_RESPONSE | "! Service return value of type T_DOCUMENT_ACCEPTED @@ -2947,7 +3188,10 @@ constants: !E_RESPONSE type T_DOCUMENT_ACCEPTED raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a document. + "!

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. @@ -2970,7 +3214,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Query a collection. + "!

Query a collection

+ "! By using this method, you can construct long queries. For details, see the + "! [Discovery + "! documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-qu + "! ery-concepts#query-concepts). "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -2996,16 +3244,21 @@ constants: !E_RESPONSE type T_QUERY_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Query system notices. + "!

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/services/discovery?topic=discovery-qu + "! ery-concepts#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. + "! 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. @@ -3094,7 +3347,11 @@ constants: !E_RESPONSE type T_QUERY_NOTICES_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Query multiple collections. + "!

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/services/discovery?topic=discovery-qu + "! ery-concepts#query-concepts). "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3117,16 +3374,21 @@ constants: !E_RESPONSE type T_QUERY_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Query multiple collection system notices. + "!

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/services/discovery?topic=discovery-qu + "! ery-concepts#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. + "! 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. @@ -3201,7 +3463,10 @@ constants: !E_RESPONSE type T_QUERY_NOTICES_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get Autocomplete Suggestions. + "!

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. @@ -3233,7 +3498,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List training data. + "!

List training data

+ "! Lists the training data for the specified collection. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3252,14 +3518,16 @@ constants: !E_RESPONSE type T_TRAINING_DATA_SET raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add query to training data. + "!

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 + "! 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 @@ -3276,7 +3544,8 @@ constants: !E_RESPONSE type T_TRAINING_QUERY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete all training data. + "!

Delete all training data

+ "! Deletes all training data from a collection. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3290,7 +3559,9 @@ constants: !I_COLLECTION_ID type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get details about a query. + "!

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. @@ -3312,7 +3583,9 @@ constants: !E_RESPONSE type T_TRAINING_QUERY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a training data query. + "!

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. @@ -3329,7 +3602,8 @@ constants: !I_QUERY_ID type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List examples for a training data query. + "!

List examples for a training data query

+ "! List all examples for this training data query. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3351,7 +3625,8 @@ constants: !E_RESPONSE type T_TRAINING_EXAMPLE_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add example to training data query. + "!

Add example to training data query

+ "! Adds a example to this training data query. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3377,7 +3652,8 @@ constants: !E_RESPONSE type T_TRAINING_EXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete example for training data query. + "!

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. @@ -3397,7 +3673,8 @@ constants: !I_EXAMPLE_ID type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Change label or cross reference for example. + "!

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. @@ -3426,7 +3703,8 @@ constants: !E_RESPONSE type T_TRAINING_EXAMPLE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get details for training data example. + "!

Get details for training data example

+ "! Gets the details for this training example. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3452,7 +3730,15 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete labeled data. + "!

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.
+ "!
+ "! You associate a customer ID with data by passing the **X-Watson-Metadata** + "! header with a request that passes data. For more information about personal + "! data and customer IDs, see [Information + "! security](https://cloud.ibm.com/docs/services/discovery?topic=discovery-informa + "! tion-security#information-security). "! "! @parameter I_CUSTOMER_ID | "! The customer ID for which all data is to be deleted. @@ -3464,7 +3750,10 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create event. + "!

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. @@ -3481,12 +3770,15 @@ constants: !E_RESPONSE type T_CREATE_EVENT_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Search the query and event log. + "!

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. + "! 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. @@ -3519,7 +3811,9 @@ constants: !E_RESPONSE type T_LOG_QUERY_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Number of queries over time. + "!

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 @@ -3543,7 +3837,11 @@ constants: !E_RESPONSE type T_METRIC_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Number of queries with an event over time. + "!

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 @@ -3567,7 +3865,9 @@ constants: !E_RESPONSE type T_METRIC_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Number of queries with no search results over time. + "!

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 @@ -3591,7 +3891,11 @@ constants: !E_RESPONSE type T_METRIC_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Percentage of queries with an associated event. + "!

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 @@ -3615,7 +3919,11 @@ constants: !E_RESPONSE type T_METRIC_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Most frequent query tokens with an event. + "!

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 @@ -3633,7 +3941,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List credentials. + "!

List credentials

+ "! List all the source credentials that have been created for this service + "! instance.
+ "!
+ "! **Note:** All credentials are sent over an encrypted connection and encrypted + "! at rest. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3649,7 +3962,13 @@ constants: !E_RESPONSE type T_CREDENTIALS_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create credentials. + "!

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.
+ "!
+ "! **Note:** All credentials are sent over an encrypted connection and encrypted at + "! rest. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3669,7 +3988,11 @@ constants: !E_RESPONSE type T_CREDENTIALS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! View Credentials. + "!

View Credentials

+ "! Returns details about the specified credentials.
+ "!
+ "! **Note:** Secure credential information such as a password or SSH key is never + "! returned and must be obtained from the source system. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3688,7 +4011,11 @@ constants: !E_RESPONSE type T_CREDENTIALS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update credentials. + "!

Update credentials

+ "! Updates an existing set of source credentials.
+ "!
+ "! **Note:** All credentials are sent over an encrypted connection and encrypted at + "! rest. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3711,7 +4038,8 @@ constants: !E_RESPONSE type T_CREDENTIALS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete credentials. + "!

Delete credentials

+ "! Deletes a set of stored credentials from your Discovery instance. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3731,7 +4059,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List Gateways. + "!

List Gateways

+ "! List the currently configured gateways. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3747,7 +4076,8 @@ constants: !E_RESPONSE type T_GATEWAY_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create Gateway. + "!

Create Gateway

+ "! Create a gateway configuration to use with a remotely installed gateway. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3767,7 +4097,8 @@ constants: !E_RESPONSE type T_GATEWAY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List Gateway Details. + "!

List Gateway Details

+ "! List information about the specified gateway. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3786,7 +4117,8 @@ constants: !E_RESPONSE type T_GATEWAY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete Gateway. + "!

Delete Gateway

+ "! Delete the specified gateway configuration. "! "! @parameter I_ENVIRONMENT_ID | "! The ID of the environment. @@ -3883,7 +4215,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092816'. + e_sdk_version_date = '20200310173426'. endmethod. diff --git a/src/zcl_ibmc_discovery_v1.clas.xml b/src/zcl_ibmc_discovery_v1.clas.xml index 9387c1e..fe06a48 100644 --- a/src/zcl_ibmc_discovery_v1.clas.xml +++ b/src/zcl_ibmc_discovery_v1.clas.xml @@ -5,12 +5,386 @@ ZCL_IBMC_DISCOVERY_V1 E - Watson Discovery V1 + Discovery 1 X X X + + + ZCL_IBMC_DISCOVERY_V1 + ADD_DOCUMENT + E + Add a document + + + ZCL_IBMC_DISCOVERY_V1 + ADD_TRAINING_DATA + E + Add query to training data + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_COLLECTION + E + Create a collection + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_CONFIGURATION + E + Add configuration + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_CREDENTIALS + E + Create credentials + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_ENVIRONMENT + E + Create an environment + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_EVENT + E + Create event + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_EXPANSIONS + E + Create or update expansion list + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_GATEWAY + E + Create Gateway + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_STOPWORD_LIST + E + Create stopword list + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_TOKENIZATION_DICTIONARY + E + Create tokenization dictionary + + + ZCL_IBMC_DISCOVERY_V1 + CREATE_TRAINING_EXAMPLE + E + Add example to training data query + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_ALL_TRAINING_DATA + E + Delete all training data + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_COLLECTION + E + Delete a collection + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_CONFIGURATION + E + Delete a configuration + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_CREDENTIALS + E + Delete credentials + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_DOCUMENT + E + Delete a document + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_ENVIRONMENT + E + Delete environment + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_EXPANSIONS + E + Delete the expansion list + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_GATEWAY + E + Delete Gateway + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_STOPWORD_LIST + E + Delete a custom stopword list + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_TOKENIZATION_DICTIONARY + E + Delete tokenization dictionary + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_TRAINING_DATA + E + Delete a training data query + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_TRAINING_EXAMPLE + E + Delete example for training data query + + + ZCL_IBMC_DISCOVERY_V1 + DELETE_USER_DATA + E + Delete labeled data + + + ZCL_IBMC_DISCOVERY_V1 + FEDERATED_QUERY + E + Query multiple collections + + + ZCL_IBMC_DISCOVERY_V1 + FEDERATED_QUERY_NOTICES + E + Query multiple collection system notices + + + ZCL_IBMC_DISCOVERY_V1 + GET_AUTOCOMPLETION + E + Get Autocomplete Suggestions + + + ZCL_IBMC_DISCOVERY_V1 + GET_COLLECTION + E + Get collection details + + + ZCL_IBMC_DISCOVERY_V1 + GET_CONFIGURATION + E + Get configuration details + + + ZCL_IBMC_DISCOVERY_V1 + GET_CREDENTIALS + E + View Credentials + + + ZCL_IBMC_DISCOVERY_V1 + GET_DOCUMENT_STATUS + E + Get document details + + + ZCL_IBMC_DISCOVERY_V1 + GET_ENVIRONMENT + E + Get environment info + + + ZCL_IBMC_DISCOVERY_V1 + GET_GATEWAY + E + List Gateway Details + + + ZCL_IBMC_DISCOVERY_V1 + GET_METRICS_EVENT_RATE + E + Percentage of queries with an associated event + + + ZCL_IBMC_DISCOVERY_V1 + GET_METRICS_QUERY + E + Number of queries over time + + + ZCL_IBMC_DISCOVERY_V1 + GET_METRICS_QUERY_EVENT + E + Number of queries with an event over time + + + ZCL_IBMC_DISCOVERY_V1 + GET_METRICS_QUERY_NO_RESULTS + E + Number of queries with no search results over time + + + ZCL_IBMC_DISCOVERY_V1 + GET_METRICS_QUERY_TOKEN_EVENT + E + Most frequent query tokens with an event + + + ZCL_IBMC_DISCOVERY_V1 + GET_STOPWORD_LIST_STATUS + E + Get stopword list status + + + ZCL_IBMC_DISCOVERY_V1 + GET_TOKENIZATION_DICT_STATUS + E + Get tokenization dictionary status + + + ZCL_IBMC_DISCOVERY_V1 + GET_TRAINING_DATA + E + Get details about a query + + + ZCL_IBMC_DISCOVERY_V1 + GET_TRAINING_EXAMPLE + E + Get details for training data example + + + ZCL_IBMC_DISCOVERY_V1 + LIST_COLLECTIONS + E + List collections + + + ZCL_IBMC_DISCOVERY_V1 + LIST_COLLECTION_FIELDS + E + List collection fields + + + ZCL_IBMC_DISCOVERY_V1 + LIST_CONFIGURATIONS + E + List configurations + + + ZCL_IBMC_DISCOVERY_V1 + LIST_CREDENTIALS + E + List credentials + + + ZCL_IBMC_DISCOVERY_V1 + LIST_ENVIRONMENTS + E + List environments + + + ZCL_IBMC_DISCOVERY_V1 + LIST_EXPANSIONS + E + Get the expansion list + + + ZCL_IBMC_DISCOVERY_V1 + LIST_FIELDS + E + List fields across collections + + + ZCL_IBMC_DISCOVERY_V1 + LIST_GATEWAYS + E + List Gateways + + + ZCL_IBMC_DISCOVERY_V1 + LIST_TRAINING_DATA + E + List training data + + + ZCL_IBMC_DISCOVERY_V1 + LIST_TRAINING_EXAMPLES + E + List examples for a training data query + + + ZCL_IBMC_DISCOVERY_V1 + QUERY + E + Query a collection + + + ZCL_IBMC_DISCOVERY_V1 + QUERY_LOG + E + Search the query and event log + + + ZCL_IBMC_DISCOVERY_V1 + QUERY_NOTICES + E + Query system notices + + + ZCL_IBMC_DISCOVERY_V1 + UPDATE_COLLECTION + E + Update a collection + + + ZCL_IBMC_DISCOVERY_V1 + UPDATE_CONFIGURATION + E + Update a configuration + + + ZCL_IBMC_DISCOVERY_V1 + UPDATE_CREDENTIALS + E + Update credentials + + + ZCL_IBMC_DISCOVERY_V1 + UPDATE_DOCUMENT + E + Update a document + + + ZCL_IBMC_DISCOVERY_V1 + UPDATE_ENVIRONMENT + E + Update an environment + + + ZCL_IBMC_DISCOVERY_V1 + UPDATE_TRAINING_EXAMPLE + E + Change label or cross reference for example + + diff --git a/src/zcl_ibmc_lang_translator_v3.clas.abap b/src/zcl_ibmc_lang_translator_v3.clas.abap index 08e1991..d7a4341 100644 --- a/src/zcl_ibmc_lang_translator_v3.clas.abap +++ b/src/zcl_ibmc_lang_translator_v3.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Language Translator

+"!

Language Translator

"! IBM Watson™ Language Translator translates text from one language to "! another. The service offers multiple IBM provided translation models that you "! can customize based on your unique terminology and language. Use Language @@ -24,11 +24,12 @@ class ZCL_IBMC_LANG_TRANSLATOR_V3 DEFINITION public section. types: - "! A globally unique string that identifies the underlying model that is used for - "! translation. + "!

+ "! A globally unique string that identifies the underlying

+ "! model that is used for translation. T_MODEL_ID type String. types: - "! No documentation available. + "! No documentation available. begin of T_IDENTIFIABLE_LANGUAGE, "! The language code for an identifiable language. LANGUAGE type STRING, @@ -36,19 +37,19 @@ public section. NAME type STRING, end of T_IDENTIFIABLE_LANGUAGE. types: - "! No documentation available. + "! No documentation available. begin of T_IDENTIFIABLE_LANGUAGES, "! A list of all languages that the service can identify. LANGUAGES type STANDARD TABLE OF T_IDENTIFIABLE_LANGUAGE WITH NON-UNIQUE DEFAULT KEY, end of T_IDENTIFIABLE_LANGUAGES. types: - "! No documentation available. + "! No documentation available. begin of T_TRANSLATION, "! Translation output in UTF-8. TRANSLATION type STRING, end of T_TRANSLATION. types: - "! No documentation available. + "! No documentation available. begin of T_TRANSLATION_RESULT, "! An estimate of the number of words in the input text. WORD_COUNT type INTEGER, @@ -58,7 +59,7 @@ public section. TRANSLATIONS type STANDARD TABLE OF T_TRANSLATION WITH NON-UNIQUE DEFAULT KEY, end of T_TRANSLATION_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_IDENTIFIED_LANGUAGE, "! The language code for an identified language. LANGUAGE type STRING, @@ -66,25 +67,29 @@ public section. CONFIDENCE type DOUBLE, end of T_IDENTIFIED_LANGUAGE. types: - "! No documentation available. + "! No documentation available. begin of T_IDENTIFIED_LANGUAGES, "! A ranking of identified languages with confidence scores. LANGUAGES type STANDARD TABLE OF T_IDENTIFIED_LANGUAGE WITH NON-UNIQUE DEFAULT KEY, end of T_IDENTIFIED_LANGUAGES. types: - "! Translation target language code. + "!

+ "! Translation target language code.

T_TARGET type String. types: - "! The status of the translation job associated with a submitted document. + "!

+ "! The status of the translation job associated with a

+ "! submitted document. T_TRANSLATION_STATUS type String. types: - "! Document information, including translation status. + "!

+ "! Document information, including translation status.

begin of T_DOCUMENT_STATUS, "! System generated ID identifying a document being translated using one specific "! translation model. DOCUMENT_ID type STRING, "! filename from the submission (if it was missing in the multipart-form, - "! 'noname.<ext matching content type>' is used. + "! 'noname.<ext matching content type>' is used. FILENAME type STRING, "! The status of the translation job associated with a submitted document. STATUS type STRING, @@ -110,7 +115,7 @@ public section. CHARACTER_COUNT type INTEGER, end of T_DOCUMENT_STATUS. types: - "! No documentation available. + "! No documentation available. begin of T_ERROR_RESPONSE, "! The http error code. CODE type INTEGER, @@ -118,10 +123,11 @@ public section. ERROR type STRING, end of T_ERROR_RESPONSE. types: - "! Translation source language code. + "!

+ "! Translation source language code.

T_SOURCE type String. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT1, "! The model to use for translation. `model_id` or both `source` and `target` are "! required. @@ -143,7 +149,7 @@ public section. FILE type FILE, end of T_INLINE_OBJECT1. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT, "! A TMX file with your customizations. The customizations in the file completely "! overwrite the domain translaton data, including high frequency or high @@ -158,7 +164,8 @@ public section. PARALLEL_CORPUS type FILE, end of T_INLINE_OBJECT. types: - "! Response payload for models. + "!

+ "! Response payload for models.

begin of T_TRANSLATION_MODEL, "! A globally unique string that identifies the underlying model that is used for "! translation. @@ -188,21 +195,25 @@ public section. STATUS type STRING, end of T_TRANSLATION_MODEL. types: - "! The response type for listing existing translation models. + "!

+ "! The response type for listing existing translation models.

begin of T_TRANSLATION_MODELS, "! An array of available models. MODELS type STANDARD TABLE OF T_TRANSLATION_MODEL WITH NON-UNIQUE DEFAULT KEY, end of T_TRANSLATION_MODELS. types: - "! Model ID of the base model that was used to customize the model. If the model is - "! not a custom model, this will be absent or an empty string. + "!

+ "! Model ID of the base model that was used to customize the

+ "! model. If the model is not a custom model, this will be absent or an empty + "! string. T_BASE_MODEL_ID type String. types: - "! System generated ID identifying a document being translated using one specific - "! translation model. + "!

+ "! System generated ID identifying a document being translated

+ "! using one specific translation model. T_DOCUMENT_ID type String. types: - "! No documentation available. + "! No documentation available. begin of T_TRANSLATE_REQUEST, "! Input text in UTF-8 encoding. Multiple entries will result in multiple "! translations in the response. @@ -216,19 +227,20 @@ public section. TARGET type STRING, end of T_TRANSLATE_REQUEST. types: - "! No documentation available. + "! No documentation available. begin of T_DELETE_MODEL_RESULT, - "! "OK" indicates that the model was successfully deleted. + "! "OK" indicates that the model was successfully deleted. STATUS type STRING, end of T_DELETE_MODEL_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_DOCUMENT_LIST, "! An array of all previously submitted documents. DOCUMENTS type STANDARD TABLE OF T_DOCUMENT_STATUS WITH NON-UNIQUE DEFAULT KEY, end of T_DOCUMENT_LIST. constants: + "!

List of required fields per type.

begin of C_REQUIRED_FIELDS, T_IDENTIFIABLE_LANGUAGE type string value '|LANGUAGE|NAME|', T_IDENTIFIABLE_LANGUAGES type string value '|LANGUAGES|', @@ -249,6 +261,7 @@ constants: end of C_REQUIRED_FIELDS . constants: + "!

Map ABAP identifiers to service identifiers.

begin of C_ABAPNAME_DICTIONARY, DOCUMENTS type string value 'documents', DOCUMENT_ID type string value 'document_id', @@ -290,7 +303,8 @@ constants: redefinition . - "! Translate. + "!

Translate

+ "! Translates the input text from the source language to the target language. "! "! @parameter I_REQUEST | "! The translate request containing the text, and either a model ID or source and @@ -309,7 +323,9 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List identifiable languages. + "!

List identifiable languages

+ "! Lists the languages that the service can identify. Returns the language code + "! (for example, `en` for English or `es` for Spanish) and name of each language. "! "! @parameter E_RESPONSE | "! Service return value of type T_IDENTIFIABLE_LANGUAGES @@ -322,7 +338,8 @@ constants: !E_RESPONSE type T_IDENTIFIABLE_LANGUAGES raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Identify language. + "!

Identify language

+ "! Identifies the language of the input text. "! "! @parameter I_TEXT | "! Input text in UTF-8 format. @@ -340,15 +357,16 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List models. + "!

List models

+ "! Lists available translation models. "! "! @parameter I_SOURCE | "! Specify a language code to filter results by source language. "! @parameter I_TARGET | "! Specify a language code to filter results by target language. "! @parameter I_DEFAULT | - "! If the default parameter isn't specified, the service will return all models - "! (default and non-default) for each language pair. To return only default + "! If the default parameter isn't specified, the service will return all + "! models (default and non-default) for each language pair. To return only default "! models, set this to `true`. To return only non-default models, set this to "! `false`. There is exactly one default model per language pair, the IBM provided "! base model. @@ -366,7 +384,25 @@ constants: !E_RESPONSE type T_TRANSLATION_MODELS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create model. + "!

Create model

+ "! Uploads Translation Memory eXchange (TMX) files to customize a translation + "! model.
+ "!
+ "! You can either customize a model with a forced glossary or with a corpus that + "! contains parallel sentences. To create a model that is customized with a + "! parallel corpus <b>and</b> a forced glossary, proceed in two steps: + "! customize with a parallel corpus first and then customize the resulting model + "! with a glossary. Depending on the type of customization and the size of the + "! uploaded corpora, training can range from minutes for a glossary to several + "! hours for a large parallel corpus. You can upload a single forced glossary file + "! and this file must be less than <b>10 MB</b>. You can upload + "! multiple parallel corpora tmx files. The cumulative file size of all uploaded + "! files is limited to <b>250 MB</b>. To successfully train with a + "! parallel corpus you must have at least <b>5,000 parallel + "! sentences</b> in your corpus.
+ "!
+ "! You can have a <b>maximum of 10 custom models per language pair</b>. + "! "! "! @parameter I_BASE_MODEL_ID | "! The model ID of the model to use as the base for customization. To see available @@ -406,7 +442,8 @@ constants: !E_RESPONSE type T_TRANSLATION_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete model. + "!

Delete model

+ "! Deletes a custom translation model. "! "! @parameter I_MODEL_ID | "! Model ID of the model to delete. @@ -422,7 +459,10 @@ constants: !E_RESPONSE type T_DELETE_MODEL_RESULT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get model details. + "!

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 will have a status of `available`. "! "! @parameter I_MODEL_ID | "! Model ID of the model to get. @@ -439,7 +479,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List documents. + "!

List documents

+ "! Lists documents that have been submitted for translation "! "! @parameter E_RESPONSE | "! Service return value of type T_DOCUMENT_LIST @@ -452,7 +493,10 @@ constants: !E_RESPONSE type T_DOCUMENT_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Translate document. + "!

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 + "! document ID. "! "! @parameter I_FILE | "! The contents of the source file to translate.
@@ -495,7 +539,8 @@ constants: !E_RESPONSE type T_DOCUMENT_STATUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get document status. + "!

Get document status

+ "! Gets the translation status of a document "! "! @parameter I_DOCUMENT_ID | "! The document ID of the document. @@ -511,7 +556,8 @@ constants: !E_RESPONSE type T_DOCUMENT_STATUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete document. + "!

Delete document

+ "! Deletes a document "! "! @parameter I_DOCUMENT_ID | "! Document ID of the document to delete. @@ -522,7 +568,8 @@ constants: !I_DOCUMENT_ID type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get translated document. + "!

Get translated document

+ "! Gets the translated document associated with the given document ID "! "! @parameter I_DOCUMENT_ID | "! The document ID of the document that was submitted for translation. @@ -539,7 +586,7 @@ constants: "! application/vnd.oasis.opendocument.text, application/pdf, application/rtf, "! text/html, text/json, text/plain, text/richtext, text/rtf, or text/xml. A "! character encoding can be specified by including a `charset` parameter. For - "! example, 'text/html;charset=utf-8'. + "! example, 'text/html;charset=utf-8'. "! @parameter E_RESPONSE | "! Service return value of type FILE "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. @@ -625,7 +672,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092819'. + e_sdk_version_date = '20200310173429'. endmethod. diff --git a/src/zcl_ibmc_lang_translator_v3.clas.xml b/src/zcl_ibmc_lang_translator_v3.clas.xml index 6f47e3f..a2c90ab 100644 --- a/src/zcl_ibmc_lang_translator_v3.clas.xml +++ b/src/zcl_ibmc_lang_translator_v3.clas.xml @@ -5,12 +5,86 @@ ZCL_IBMC_LANG_TRANSLATOR_V3 E - IBM Watson Language Translator + Language Translator 1 X X X + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + CREATE_MODEL + E + Create model + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + DELETE_DOCUMENT + E + Delete document + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + DELETE_MODEL + E + Delete model + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + GET_DOCUMENT_STATUS + E + Get document status + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + GET_MODEL + E + Get model details + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + GET_TRANSLATED_DOCUMENT + E + Get translated document + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + IDENTIFY + E + Identify language + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + LIST_DOCUMENTS + E + List documents + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + LIST_IDENTIFIABLE_LANGUAGES + E + List identifiable languages + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + LIST_MODELS + E + List models + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + TRANSLATE + E + Translate + + + ZCL_IBMC_LANG_TRANSLATOR_V3 + TRANSLATE_DOCUMENT + E + Translate document + + diff --git a/src/zcl_ibmc_nat_lang_class_v1.clas.abap b/src/zcl_ibmc_nat_lang_class_v1.clas.abap index b1cc5d2..c82d25b 100644 --- a/src/zcl_ibmc_nat_lang_class_v1.clas.abap +++ b/src/zcl_ibmc_nat_lang_class_v1.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Natural Language Classifier

+"!

Natural 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 @@ -23,7 +23,8 @@ class ZCL_IBMC_NAT_LANG_CLASS_V1 DEFINITION public section. types: - "! Response payload for HTTP errors. + "!

+ "! Response payload for HTTP errors.

begin of T_ERROR_RESPONSE, "! HTTP status code. CODE type INTEGER, @@ -33,13 +34,14 @@ public section. DESCRIPTION type STRING, end of T_ERROR_RESPONSE. types: - "! Request payload to classify. + "!

+ "! 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. + "! 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 @@ -56,7 +58,8 @@ public section. TRAINING_DATA type FILE, end of T_INLINE_OBJECT. types: - "! Class and confidence. + "!

+ "! 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. @@ -65,7 +68,8 @@ public section. CLASS_NAME type STRING, end of T_CLASSIFIED_CLASS. types: - "! Response from the classifier for a phrase in a collection. + "!

+ "! 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, @@ -76,7 +80,8 @@ public section. 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. + "!

+ "! A classifier for natural language phrases.

begin of T_CLASSIFIER, "! User-supplied name for the classifier. NAME type STRING, @@ -94,14 +99,16 @@ public section. LANGUAGE type STRING, end of T_CLASSIFIER. types: - "! List of available classifiers. + "!

+ "! 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. + "!

+ "! Response from the classifier for a phrase.

begin of T_CLASSIFICATION, "! Unique identifier for this classifier. CLASSIFIER_ID type STRING, @@ -116,13 +123,15 @@ public section. CLASSES type STANDARD TABLE OF T_CLASSIFIED_CLASS WITH NON-UNIQUE DEFAULT KEY, end of T_CLASSIFICATION. types: - "! Request payload to classify. + "!

+ "! 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. + "!

+ "! Response payload for Cloud errors.

begin of T_ERROR_CLOUD, "! HTTP status code. CODE type INTEGER, @@ -130,10 +139,11 @@ public section. ERROR type STRING, end of T_ERROR_CLOUD. types: - "! No documentation available. + "! No documentation available. T_EMPTY type JSONOBJECT. types: - "! Response from the classifier for multiple phrases. + "!

+ "! Response from the classifier for multiple phrases.

begin of T_CLASSIFICATION_COLLECTION, "! Unique identifier for this classifier. CLASSIFIER_ID type STRING, @@ -144,6 +154,7 @@ public section. 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|', @@ -160,6 +171,7 @@ constants: 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', @@ -192,7 +204,9 @@ constants: redefinition . - "! Classify a phrase. + "!

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. @@ -212,7 +226,11 @@ constants: !E_RESPONSE type T_CLASSIFICATION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Classify multiple phrases. + "!

Classify multiple phrases

+ "! Returns label information for multiple phrases. The status must be `Available` + "! before you can use the classifier to classify text.
+ "!
+ "! Note that classifying Japanese texts is a beta feature. "! "! @parameter I_CLASSIFIER_ID | "! Classifier ID to use. @@ -233,7 +251,9 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create classifier. + "!

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 @@ -264,7 +284,8 @@ constants: !E_RESPONSE type T_CLASSIFIER raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List classifiers. + "!

List classifiers

+ "! Returns an empty array if no classifiers are available. "! "! @parameter E_RESPONSE | "! Service return value of type T_CLASSIFIER_LIST @@ -277,7 +298,8 @@ constants: !E_RESPONSE type T_CLASSIFIER_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get information about a classifier. + "!

Get information about a classifier

+ "! Returns status and other information about a classifier. "! "! @parameter I_CLASSIFIER_ID | "! Classifier ID to query. @@ -293,7 +315,7 @@ constants: !E_RESPONSE type T_CLASSIFIER raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete classifier. + "!

Delete classifier

"! "! @parameter I_CLASSIFIER_ID | "! Classifier ID to delete. @@ -378,7 +400,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092820'. + e_sdk_version_date = '20200310173431'. endmethod. diff --git a/src/zcl_ibmc_nat_lang_class_v1.clas.xml b/src/zcl_ibmc_nat_lang_class_v1.clas.xml index 16dc6d9..3103c7b 100644 --- a/src/zcl_ibmc_nat_lang_class_v1.clas.xml +++ b/src/zcl_ibmc_nat_lang_class_v1.clas.xml @@ -5,12 +5,50 @@ ZCL_IBMC_NAT_LANG_CLASS_V1 E - IBM Watson Natural Language Classifier + Natural Language Classifier 1 X X X + + + ZCL_IBMC_NAT_LANG_CLASS_V1 + CLASSIFY + E + Classify a phrase + + + ZCL_IBMC_NAT_LANG_CLASS_V1 + CLASSIFY_COLLECTION + E + Classify multiple phrases + + + ZCL_IBMC_NAT_LANG_CLASS_V1 + CREATE_CLASSIFIER + E + Create classifier + + + ZCL_IBMC_NAT_LANG_CLASS_V1 + DELETE_CLASSIFIER + E + Delete classifier + + + ZCL_IBMC_NAT_LANG_CLASS_V1 + GET_CLASSIFIER + E + Get information about a classifier + + + ZCL_IBMC_NAT_LANG_CLASS_V1 + LIST_CLASSIFIERS + E + List classifiers + + diff --git a/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.abap b/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.abap index ff67b55..b089a27 100644 --- a/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.abap +++ b/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Natural Language Understanding

+"!

Natural Language Understanding

"! Analyze various features of text content at scale. Provide text, raw HTML, or a "! public URL and IBM Watson Natural Language Understanding will give you results "! for the features you request. The service cleans HTML content before analysis @@ -29,7 +29,7 @@ class ZCL_IBMC_NAT_LANG_UNDRSTND_V1 DEFINITION public section. types: - "! No documentation available. + "! No documentation available. begin of T_SEMANTIC_ROLES_ENTITY, "! Entity type. TYPE type STRING, @@ -37,13 +37,14 @@ public section. TEXT type STRING, end of T_SEMANTIC_ROLES_ENTITY. types: - "! No documentation available. + "! No documentation available. begin of T_SEMANTIC_ROLES_KEYWORD, "! The keyword text. TEXT type STRING, end of T_SEMANTIC_ROLES_KEYWORD. types: - "! The extracted subject from the sentence. + "!

+ "! The extracted subject from the sentence.

begin of T_SMNTC_ROLES_RESULT_SUBJECT, "! Text that corresponds to the subject role. TEXT type STRING, @@ -53,7 +54,8 @@ public section. KEYWORDS type STANDARD TABLE OF T_SEMANTIC_ROLES_KEYWORD WITH NON-UNIQUE DEFAULT KEY, end of T_SMNTC_ROLES_RESULT_SUBJECT. types: - "! The extracted object from the sentence. + "!

+ "! The extracted object from the sentence.

begin of T_SEMANTIC_ROLES_RESULT_OBJECT, "! Object text. TEXT type STRING, @@ -61,7 +63,7 @@ public section. KEYWORDS type STANDARD TABLE OF T_SEMANTIC_ROLES_KEYWORD WITH NON-UNIQUE DEFAULT KEY, end of T_SEMANTIC_ROLES_RESULT_OBJECT. types: - "! No documentation available. + "! No documentation available. begin of T_SEMANTIC_ROLES_VERB, "! The keyword text. TEXT type STRING, @@ -69,7 +71,8 @@ public section. TENSE type STRING, end of T_SEMANTIC_ROLES_VERB. types: - "! The extracted action from the sentence. + "!

+ "! The extracted action from the sentence.

begin of T_SEMANTIC_ROLES_RESULT_ACTION, "! Analyzed text that corresponds to the action. TEXT type STRING, @@ -79,7 +82,9 @@ public section. VERB type T_SEMANTIC_ROLES_VERB, end of T_SEMANTIC_ROLES_RESULT_ACTION. types: - "! The object containing the actions and the objects the actions act upon. + "!

+ "! The object containing the actions and the objects the

+ "! actions act upon. begin of T_SEMANTIC_ROLES_RESULT, "! Sentence from the source that contains the subject, action, and object. SENTENCE type STRING, @@ -91,9 +96,10 @@ public section. OBJECT type T_SEMANTIC_ROLES_RESULT_OBJECT, end of T_SEMANTIC_ROLES_RESULT. types: - "! Parses sentences into subject, action, and object form.
- "!
- "! Supported languages: English, German, Japanese, Korean, Spanish. + "!

+ "! Parses sentences into subject, action, and object form.


+ "!
+ "! Supported languages: English, German, Japanese, Korean, Spanish. begin of T_SEMANTIC_ROLES_OPTIONS, "! Maximum number of semantic_roles results to return. LIMIT type INTEGER, @@ -103,7 +109,8 @@ public section. ENTITIES type BOOLEAN, end of T_SEMANTIC_ROLES_OPTIONS. types: - "! Metadata associated with this custom model. + "!

+ "! Metadata associated with this custom model.

begin of T_MODEL_METADATA, "! An optional name for the model. NAME type STRING, @@ -122,7 +129,8 @@ public section. VERSION_DESCRIPTION type STRING, end of T_MODEL_METADATA. types: - "! An entity that corresponds with an argument in a relation. + "!

+ "! An entity that corresponds with an argument in a relation.

begin of T_RELATION_ENTITY, "! Text that corresponds to the entity. TEXT type STRING, @@ -130,7 +138,7 @@ public section. TYPE type STRING, end of T_RELATION_ENTITY. types: - "! No documentation available. + "! No documentation available. begin of T_RELATION_ARGUMENT, "! An array of extracted entities. ENTITIES type STANDARD TABLE OF T_RELATION_ENTITY WITH NON-UNIQUE DEFAULT KEY, @@ -141,7 +149,8 @@ public section. TEXT type STRING, end of T_RELATION_ARGUMENT. types: - "! The relations between entities found in the content. + "!

+ "! The relations between entities found in the content.

begin of T_RELATIONS_RESULT, "! Confidence score for the relation. Higher values indicate greater confidence. SCORE type DOUBLE, @@ -153,7 +162,7 @@ public section. ARGUMENTS type STANDARD TABLE OF T_RELATION_ARGUMENT WITH NON-UNIQUE DEFAULT KEY, end of T_RELATIONS_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_MODEL, "! When the status is `available`, the model is ready to use. STATUS type STRING, @@ -175,13 +184,13 @@ public section. CREATED type DATETIME, end of T_MODEL. types: - "! No documentation available. + "! No documentation available. begin of T_FEATURE_SENTIMENT_RESULTS, "! Sentiment score from -1 (negative) to 1 (positive). SCORE type DOUBLE, end of T_FEATURE_SENTIMENT_RESULTS. types: - "! No documentation available. + "! No documentation available. begin of T_EMOTION_SCORES, "! Anger score from 0 to 1. A higher score means that the text is more likely to "! convey anger. @@ -200,19 +209,23 @@ public section. SADNESS type DOUBLE, end of T_EMOTION_SCORES. types: - "! The author of the analyzed content. + "!

+ "! The author of the analyzed content.

begin of T_AUTHOR, "! Name of the author. NAME type STRING, end of T_AUTHOR. types: - "! RSS or ATOM feed found on the webpage. + "!

+ "! RSS or ATOM feed found on the webpage.

begin of T_FEED, "! URL of the RSS or ATOM feed. LINK type STRING, end of T_FEED. types: - "! Webpage metadata, such as the author and the title of the page. + "!

+ "! Webpage metadata, such as the author and the title of the

+ "! page. begin of T_FEATURES_RESULTS_METADATA, "! The authors of the document. AUTHORS type STANDARD TABLE OF T_AUTHOR WITH NON-UNIQUE DEFAULT KEY, @@ -226,7 +239,7 @@ public section. FEEDS type STANDARD TABLE OF T_FEED WITH NON-UNIQUE DEFAULT KEY, end of T_FEATURES_RESULTS_METADATA. types: - "! No documentation available. + "! No documentation available. begin of T_ENTITY_MENTION, "! Entity mention text. TEXT type STRING, @@ -240,7 +253,8 @@ public section. CONFIDENCE type DOUBLE, end of T_ENTITY_MENTION. types: - "! Disambiguation information for the entity. + "!

+ "! Disambiguation information for the entity.

begin of T_DISAMBIGUATION_RESULT, "! Common entity name. NAME type STRING, @@ -250,8 +264,9 @@ public section. SUBTYPE type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_DISAMBIGUATION_RESULT. types: - "! The important people, places, geopolitical entities and other types of entities - "! in your content. + "!

+ "! The important people, places, geopolitical entities and

+ "! other types of entities in your content. begin of T_ENTITIES_RESULT, "! Entity type. TYPE type STRING, @@ -276,7 +291,8 @@ public section. DISAMBIGUATION type T_DISAMBIGUATION_RESULT, end of T_ENTITIES_RESULT. types: - "! Emotion results for a specified target. + "!

+ "! Emotion results for a specified target.

begin of T_TARGETED_EMOTION_RESULTS, "! Targeted text. TEXT type STRING, @@ -284,7 +300,9 @@ public section. EMOTION type T_EMOTION_SCORES, end of T_TARGETED_EMOTION_RESULTS. types: - "! The important keywords in the content, organized by relevance. + "!

+ "! The important keywords in the content, organized by

+ "! relevance. begin of T_KEYWORDS_RESULT, "! Number of times the keyword appears in the analyzed text. COUNT type INTEGER, @@ -299,7 +317,7 @@ public section. SENTIMENT type T_FEATURE_SENTIMENT_RESULTS, end of T_KEYWORDS_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_TARGETED_SENTIMENT_RESULTS, "! Targeted text. TEXT type STRING, @@ -307,19 +325,21 @@ public section. SCORE type DOUBLE, end of T_TARGETED_SENTIMENT_RESULTS. types: - "! Relevant text that contributed to the categorization. + "!

+ "! Relevant text that contributed to the categorization.

begin of T_CATEGORIES_RELEVANT_TEXT, "! Text from the analyzed source that supports the categorization. TEXT type STRING, end of T_CATEGORIES_RELEVANT_TEXT. types: - "! Emotion results for the document as a whole. + "!

+ "! Emotion results for the document as a whole.

begin of T_DOCUMENT_EMOTION_RESULTS, "! Emotion results for the document as a whole. EMOTION type T_EMOTION_SCORES, end of T_DOCUMENT_EMOTION_RESULTS. types: - "! No documentation available. + "! No documentation available. begin of T_DOCUMENT_SENTIMENT_RESULTS, "! Indicates whether the sentiment is positive, neutral, or negative. LABEL type STRING, @@ -327,7 +347,8 @@ public section. SCORE type DOUBLE, end of T_DOCUMENT_SENTIMENT_RESULTS. types: - "! The sentiment of the content. + "!

+ "! The sentiment of the content.

begin of T_SENTIMENT_RESULT, "! The document level sentiment. DOCUMENT type T_DOCUMENT_SENTIMENT_RESULTS, @@ -335,7 +356,7 @@ public section. TARGETS type STANDARD TABLE OF T_TARGETED_SENTIMENT_RESULTS WITH NON-UNIQUE DEFAULT KEY, end of T_SENTIMENT_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_TOKEN_RESULT, "! The token as it appears in the analyzed text. TEXT type STRING, @@ -349,7 +370,7 @@ public section. LEMMA type STRING, end of T_TOKEN_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_SENTENCE_RESULT, "! The sentence. TEXT type STRING, @@ -358,7 +379,8 @@ public section. LOCATION type STANDARD TABLE OF INTEGER WITH NON-UNIQUE DEFAULT KEY, end of T_SENTENCE_RESULT. types: - "! Tokens and sentences returned from syntax analysis. + "!

+ "! Tokens and sentences returned from syntax analysis.

begin of T_SYNTAX_RESULT, "! No documentation available. TOKENS type STANDARD TABLE OF T_TOKEN_RESULT WITH NON-UNIQUE DEFAULT KEY, @@ -366,7 +388,9 @@ public section. SENTENCES type STANDARD TABLE OF T_SENTENCE_RESULT WITH NON-UNIQUE DEFAULT KEY, end of T_SYNTAX_RESULT. types: - "! The general concepts referenced or alluded to in the analyzed text. + "!

+ "! The general concepts referenced or alluded to in the

+ "! analyzed text. begin of T_CONCEPTS_RESULT, "! Name of the concept. TEXT type STRING, @@ -376,7 +400,9 @@ public section. DBPEDIA_RESOURCE type STRING, end of T_CONCEPTS_RESULT. types: - "! Information that helps to explain what contributed to the categories result. + "!

+ "! Information that helps to explain what contributed to the

+ "! categories result. begin of T_CTGRS_RESULT_EXPLANATION, "! An array of relevant text from the source that contributed to the "! categorization. The sorted array begins with the phrase that contributed most @@ -385,7 +411,8 @@ public section. RELEVANT_TEXT type STANDARD TABLE OF T_CATEGORIES_RELEVANT_TEXT WITH NON-UNIQUE DEFAULT KEY, end of T_CTGRS_RESULT_EXPLANATION. types: - "! A categorization of the analyzed text. + "!

+ "! A categorization of the analyzed text.

begin of T_CATEGORIES_RESULT, "! The path to the category through the 5-level taxonomy hierarchy. For the "! complete list of categories, see the [Categories @@ -400,9 +427,10 @@ public section. EXPLANATION type T_CTGRS_RESULT_EXPLANATION, end of T_CATEGORIES_RESULT. types: - "! The detected anger, disgust, fear, joy, or sadness that is conveyed by the - "! content. Emotion information can be returned for detected entities, keywords, - "! or user-specified target phrases found in the text. + "!

+ "! The detected anger, disgust, fear, joy, or sadness that is

+ "! conveyed by the content. Emotion information can be returned for detected + "! entities, keywords, or user-specified target phrases found in the text. begin of T_EMOTION_RESULT, "! Emotion results for the document as a whole. DOCUMENT type T_DOCUMENT_EMOTION_RESULTS, @@ -410,7 +438,8 @@ public section. TARGETS type STANDARD TABLE OF T_TARGETED_EMOTION_RESULTS WITH NON-UNIQUE DEFAULT KEY, end of T_EMOTION_RESULT. types: - "! Analysis results for each requested feature. + "!

+ "! Analysis results for each requested feature.

begin of T_FEATURES_RESULTS, "! The general concepts referenced or alluded to in the analyzed text. CONCEPTS type STANDARD TABLE OF T_CONCEPTS_RESULT WITH NON-UNIQUE DEFAULT KEY, @@ -434,8 +463,9 @@ public section. SYNTAX type T_SYNTAX_RESULT, end of T_FEATURES_RESULTS. types: - "! The authors, publication date, title, prominent page image, and RSS/ATOM feeds - "! of the webpage. Supports URL and HTML input types. + "!

+ "! The authors, publication date, title, prominent page image,

+ "! and RSS/ATOM feeds of the webpage. Supports URL and HTML input types. begin of T_METADATA_RESULT, "! The authors of the document. AUTHORS type STANDARD TABLE OF T_AUTHOR WITH NON-UNIQUE DEFAULT KEY, @@ -449,7 +479,7 @@ public section. FEEDS type STANDARD TABLE OF T_FEED WITH NON-UNIQUE DEFAULT KEY, end of T_METADATA_RESULT. types: - "! No documentation available. + "! No documentation available. begin of T_ERROR_RESPONSE, "! The HTTP error status code. CODE type INTEGER, @@ -457,12 +487,13 @@ public section. ERROR type STRING, end of T_ERROR_RESPONSE. types: - "! Detects anger, disgust, fear, joy, or sadness that is conveyed in the content or - "! by the context around target phrases specified in the targets parameter. You - "! can analyze emotion for detected entities with `entities.emotion` and for - "! keywords with `keywords.emotion`.
- "!
- "! Supported languages: English. + "!

+ "! Detects anger, disgust, fear, joy, or sadness that is

+ "! conveyed in the content or by the context around target phrases specified in + "! the targets parameter. You can analyze emotion for detected entities with + "! `entities.emotion` and for keywords with `keywords.emotion`.
+ "!
+ "! Supported languages: English. begin of T_EMOTION_OPTIONS, "! Set this to `false` to hide document-level emotion results. DOCUMENT type BOOLEAN, @@ -471,7 +502,8 @@ public section. TARGETS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_EMOTION_OPTIONS. types: - "! Usage information. + "!

+ "! Usage information.

begin of T_USAGE, "! Number of features used in the API call. FEATURES type INTEGER, @@ -481,12 +513,14 @@ public section. TEXT_UNITS type INTEGER, end of T_USAGE. types: - "! Analyzes the general sentiment of your content or the sentiment toward specific - "! target phrases. You can analyze sentiment for detected entities with - "! `entities.sentiment` and for keywords with `keywords.sentiment`.
- "!
- "! Supported languages: Arabic, English, French, German, Italian, Japanese, - "! Korean, Portuguese, Russian, Spanish. + "!

+ "! Analyzes the general sentiment of your content or the

+ "! sentiment toward specific target phrases. You can analyze sentiment for + "! detected entities with `entities.sentiment` and for keywords with + "! `keywords.sentiment`.
+ "!
+ "! Supported languages: Arabic, English, French, German, Italian, Japanese, + "! Korean, Portuguese, Russian, Spanish. begin of T_SENTIMENT_OPTIONS, "! Set this to `false` to hide document-level sentiment results. DOCUMENT type BOOLEAN, @@ -495,7 +529,7 @@ public section. TARGETS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_SENTIMENT_OPTIONS. types: - "! No documentation available. + "! No documentation available. begin of T_SEMANTIC_ROLES_ACTION, "! Analyzed text that corresponds to the action. TEXT type STRING, @@ -505,7 +539,8 @@ public section. VERB type T_SEMANTIC_ROLES_VERB, end of T_SEMANTIC_ROLES_ACTION. types: - "! Tokenization options. + "!

+ "! Tokenization options.

begin of T_SYNTAX_OPTIONS_TOKENS, "! Set this to `true` to return the lemma for each token. LEMMA type BOOLEAN, @@ -513,10 +548,11 @@ public section. PART_OF_SPEECH type BOOLEAN, end of T_SYNTAX_OPTIONS_TOKENS. types: - "! Returns important keywords in the content.
- "!
- "! Supported languages: English, French, German, Italian, Japanese, Korean, - "! Portuguese, Russian, Spanish, Swedish. + "!

+ "! Returns important keywords in the content.


+ "!
+ "! Supported languages: English, French, German, Italian, Japanese, Korean, + "! Portuguese, Russian, Spanish, Swedish. begin of T_KEYWORDS_OPTIONS, "! Maximum number of keywords to return. LIMIT type INTEGER, @@ -526,15 +562,16 @@ public section. EMOTION type BOOLEAN, end of T_KEYWORDS_OPTIONS. types: - "! Recognizes when two entities are related and identifies the type of relation. - "! For example, an `awardedTo` relation might connect the entities "Nobel Prize" - "! and "Albert Einstein". See [Relation - "! types](https://cloud.ibm.com/docs/services/natural-language-understanding?topic - "! =natural-language-understanding-relations).
- "!
- "! Supported languages: Arabic, English, German, Japanese, Korean, Spanish. - "! Chinese, Dutch, French, Italian, and Portuguese custom models are also - "! supported. + "!

+ "! Recognizes when two entities are related and identifies the

+ "! type of relation. For example, an `awardedTo` relation might connect the + "! entities "Nobel Prize" and "Albert Einstein". See [Relation + "! types](https://cloud.ibm.com/docs/services/natural-language-understanding?topic + "! =natural-language-understanding-relations).
+ "!
+ "! Supported languages: Arabic, English, German, Japanese, Korean, Spanish. + "! Chinese, Dutch, French, Italian, and Portuguese custom models are also + "! supported. begin of T_RELATIONS_OPTIONS, "! Enter a [custom "! model](https://cloud.ibm.com/docs/services/natural-language-understanding?topic @@ -542,14 +579,15 @@ public section. MODEL type STRING, end of T_RELATIONS_OPTIONS. types: - "! Identifies people, cities, organizations, and other entities in the content. See - "! [Entity types and - "! subtypes](https://cloud.ibm.com/docs/services/natural-language-understanding?to - "! pic=natural-language-understanding-entity-types).
- "!
- "! Supported languages: English, French, German, Italian, Japanese, Korean, - "! Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported - "! only through custom models. + "!

+ "! Identifies people, cities, organizations, and other entities

+ "! in the content. See [Entity types and + "! subtypes](https://cloud.ibm.com/docs/services/natural-language-understanding?to + "! pic=natural-language-understanding-entity-types).
+ "!
+ "! Supported languages: English, French, German, Italian, Japanese, Korean, + "! Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported + "! only through custom models. begin of T_ENTITIES_OPTIONS, "! Maximum number of entities to return. LIMIT type INTEGER, @@ -566,23 +604,26 @@ public section. EMOTION type BOOLEAN, end of T_ENTITIES_OPTIONS. types: - "! 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.
- "!
- "! Supported languages: English, French, German, Italian, Japanese, Korean, - "! Portuguese, Spanish. + "!

+ "! 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.
+ "!
+ "! Supported languages: English, French, German, Italian, Japanese, Korean, + "! Portuguese, Spanish. begin of T_CONCEPTS_OPTIONS, "! Maximum number of concepts to return. LIMIT type INTEGER, end of T_CONCEPTS_OPTIONS. types: - "! Returns information from the document, including author name, title, RSS/ATOM - "! feeds, prominent page image, and publication date. Supports URL and HTML input - "! types only. + "!

+ "! Returns information from the document, including author

+ "! name, title, RSS/ATOM feeds, prominent page image, and publication date. + "! Supports URL and HTML input types only. T_METADATA_OPTIONS type JSONOBJECT. types: - "! Returns tokens and sentences from the input text. + "!

+ "! Returns tokens and sentences from the input text.

begin of T_SYNTAX_OPTIONS, "! Tokenization options. TOKENS type T_SYNTAX_OPTIONS_TOKENS, @@ -590,11 +631,12 @@ public section. SENTENCES type BOOLEAN, end of T_SYNTAX_OPTIONS. types: - "! Returns a five-level taxonomy of the content. The top three categories are - "! returned.
- "!
- "! Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, - "! Portuguese, Spanish. + "!

+ "! Returns a five-level taxonomy of the content. The top three

+ "! categories are returned.
+ "!
+ "! Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, + "! Portuguese, Spanish. begin of T_CATEGORIES_OPTIONS, "! Set this to `true` to return explanations for each categorization. **This is "! available only for English categories.**. @@ -614,11 +656,12 @@ public section. MODEL type STRING, end of T_CATEGORIES_OPTIONS. types: - "! Analysis features and options. + "!

+ "! Analysis features and options.

begin of T_FEATURES, "! 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.
+ "! deep learning might return the concept, "Artificial Intelligence" + "! although the term is not mentioned.
"!
"! Supported languages: English, French, German, Italian, Japanese, Korean, "! Portuguese, Spanish. @@ -649,8 +692,8 @@ public section. "! types only. METADATA type T_METADATA_OPTIONS, "! Recognizes when two entities are related and identifies the type of relation. - "! For example, an `awardedTo` relation might connect the entities "Nobel Prize" - "! and "Albert Einstein". See [Relation + "! For example, an `awardedTo` relation might connect the entities "Nobel + "! Prize" and "Albert Einstein". See [Relation "! types](https://cloud.ibm.com/docs/services/natural-language-understanding?topic "! =natural-language-understanding-relations).
"!
@@ -679,7 +722,9 @@ public section. SYNTAX type T_SYNTAX_OPTIONS, end of T_FEATURES. types: - "! Webpage metadata, such as the author and the title of the page. + "!

+ "! Webpage metadata, such as the author and the title of the

+ "! page. begin of T_ANALYSIS_RESULTS_METADATA, "! The authors of the document. AUTHORS type STANDARD TABLE OF T_AUTHOR WITH NON-UNIQUE DEFAULT KEY, @@ -693,7 +738,8 @@ public section. FEEDS type STANDARD TABLE OF T_FEED WITH NON-UNIQUE DEFAULT KEY, end of T_ANALYSIS_RESULTS_METADATA. types: - "! API usage information for the request. + "!

+ "! API usage information for the request.

begin of T_ANALYSIS_RESULTS_USAGE, "! Number of features used in the API call. FEATURES type INTEGER, @@ -703,7 +749,8 @@ public section. TEXT_UNITS type INTEGER, end of T_ANALYSIS_RESULTS_USAGE. types: - "! Results of the analysis, organized by feature. + "!

+ "! Results of the analysis, organized by feature.

begin of T_ANALYSIS_RESULTS, "! Language used to analyze the text. LANGUAGE type STRING, @@ -735,7 +782,7 @@ public section. SYNTAX type T_SYNTAX_RESULT, end of T_ANALYSIS_RESULTS. types: - "! No documentation available. + "! No documentation available. begin of T_SEMANTIC_ROLES_SUBJECT, "! Text that corresponds to the subject role. TEXT type STRING, @@ -745,13 +792,14 @@ public section. KEYWORDS type STANDARD TABLE OF T_SEMANTIC_ROLES_KEYWORD WITH NON-UNIQUE DEFAULT KEY, end of T_SEMANTIC_ROLES_SUBJECT. types: - "! Custom models that are available for entities and relations. + "!

+ "! Custom models that are available for entities and relations.

begin of T_LIST_MODELS_RESULTS, "! An array of available models. MODELS type STANDARD TABLE OF T_MODEL WITH NON-UNIQUE DEFAULT KEY, end of T_LIST_MODELS_RESULTS. types: - "! No documentation available. + "! No documentation available. begin of T_SEMANTIC_ROLES_OBJECT, "! Object text. TEXT type STRING, @@ -759,7 +807,8 @@ public section. KEYWORDS type STANDARD TABLE OF T_SEMANTIC_ROLES_KEYWORD WITH NON-UNIQUE DEFAULT KEY, end of T_SEMANTIC_ROLES_OBJECT. types: - "! An object containing request parameters. + "!

+ "! An object containing request parameters.

begin of T_PARAMETERS, "! The plain text to analyze. One of the `text`, `html`, or `url` parameters is "! required. @@ -798,10 +847,12 @@ public section. LIMIT_TEXT_CHARACTERS type INTEGER, end of T_PARAMETERS. types: - "! Link to the corresponding DBpedia resource. + "!

+ "! Link to the corresponding DBpedia resource.

T_DBPEDIA_RESOURCE type String. types: - "! Metadata associated with this custom model. + "!

+ "! Metadata associated with this custom model.

begin of T_MODEL_FILE_AND_METADATA, "! An optional name for the model. NAME type STRING, @@ -822,13 +873,15 @@ public section. FILE type FILE, end of T_MODEL_FILE_AND_METADATA. types: - "! Delete model results. + "!

+ "! Delete model results.

begin of T_DELETE_MODEL_RESULTS, "! model_id of the deleted model. DELETED type STRING, end of T_DELETE_MODEL_RESULTS. constants: + "!

List of required fields per type.

begin of C_REQUIRED_FIELDS, T_SEMANTIC_ROLES_ENTITY type string value '|', T_SEMANTIC_ROLES_KEYWORD type string value '|', @@ -893,6 +946,7 @@ constants: end of C_REQUIRED_FIELDS . constants: + "!

Map ABAP identifiers to service identifiers.

begin of C_ABAPNAME_DICTIONARY, TEXT type string value 'text', HTML type string value 'html', @@ -987,7 +1041,23 @@ constants: redefinition . - "! Analyze text. + "!

Analyze text

+ "! Analyzes text, HTML, or a public webpage for the following features:
+ "! - Categories
+ "! - Concepts
+ "! - Emotion
+ "! - Entities
+ "! - Keywords
+ "! - Metadata
+ "! - Relations
+ "! - Semantic roles
+ "! - Sentiment
+ "! - Syntax (Experimental).
+ "!
+ "! If a language for the input text is not specified with the `language` parameter, + "! the service [automatically detects the + "! language](https://cloud.ibm.com/docs/services/natural-language-understanding?to + "! pic=natural-language-understanding-detectable-languages). "! "! @parameter I_PARAMETERS | "! An object containing request parameters. The `features` object and one of the @@ -1006,7 +1076,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List models. + "!

List models

+ "! Lists Watson Knowledge Studio [custom entities and relations + "! models](https://cloud.ibm.com/docs/services/natural-language-understanding?topi + "! c=natural-language-understanding-customizing) that are deployed to your Natural + "! Language Understanding service. "! "! @parameter E_RESPONSE | "! Service return value of type T_LIST_MODELS_RESULTS @@ -1019,7 +1093,8 @@ constants: !E_RESPONSE type T_LIST_MODELS_RESULTS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete model. + "!

Delete model

+ "! Deletes a custom model "! "! @parameter I_MODEL_ID | "! Model ID of the model to delete. @@ -1113,7 +1188,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092822'. + e_sdk_version_date = '20200310173433'. endmethod. diff --git a/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.xml b/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.xml index 97d7dfc..4d7633f 100644 --- a/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.xml +++ b/src/zcl_ibmc_nat_lang_undrstnd_v1.clas.xml @@ -5,12 +5,32 @@ ZCL_IBMC_NAT_LANG_UNDRSTND_V1 E - IBM Watson Natural Language Understanding + Natural Language Understanding 1 X X X + + + ZCL_IBMC_NAT_LANG_UNDRSTND_V1 + ANALYZE + E + Analyze text + + + ZCL_IBMC_NAT_LANG_UNDRSTND_V1 + DELETE_MODEL + E + Delete model + + + ZCL_IBMC_NAT_LANG_UNDRSTND_V1 + LIST_MODELS + E + List models + + diff --git a/src/zcl_ibmc_personal_insights_v3.clas.abap b/src/zcl_ibmc_personal_insights_v3.clas.abap index c892aae..afb3a45 100644 --- a/src/zcl_ibmc_personal_insights_v3.clas.abap +++ b/src/zcl_ibmc_personal_insights_v3.clas.abap @@ -11,13 +11,13 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Personality Insights

+"!

Personality Insights

"! The IBM Watson™ Personality Insights service enables applications to "! derive insights from social media, enterprise data, or other digital -"! communications. The service uses linguistic analytics to infer individuals' -"! intrinsic personality characteristics, including Big Five, Needs, and Values, -"! from digital communications such as email, text messages, tweets, and forum -"! posts.
+"! communications. The service uses linguistic analytics to infer +"! individuals' intrinsic personality characteristics, including Big Five, +"! Needs, and Values, from digital communications such as email, text messages, +"! tweets, and forum posts.
"!
"! The service can automatically infer, from potentially noisy social media, "! portraits of individuals that reflect their personality characteristics. The @@ -25,12 +25,12 @@ "! and, for JSON content that is timestamped, can report temporal behavior.
"! * For information about the meaning of the models that the service uses to "! describe personality characteristics, see [Personality -"! models](https://cloud.ibm.com/docs/services/personality-insights?topic=personal -"! ity-insights-models#models).
+"! models](https://cloud.ibm.com/docs/personality-insights?topic=personality-insig +"! hts-models#models).
"! * For information about the meaning of the consumption preferences, see "! [Consumption -"! preferences](https://cloud.ibm.com/docs/services/personality-insights?topic=per -"! sonality-insights-preferences#preferences).
+"! preferences](https://cloud.ibm.com/docs/personality-insights?topic=personality- +"! insights-preferences#preferences).
"!
"! **Note:** Request logging is disabled for the Personality Insights service. "! Regardless of whether you set the `X-Watson-Learning-Opt-Out` request header, @@ -42,7 +42,9 @@ class ZCL_IBMC_PERSONAL_INSIGHTS_V3 DEFINITION public section. types: - "! The characteristics that the service inferred from the input content. + "!

+ "! 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
@@ -72,18 +74,19 @@ public section. "! comparison of the results against a different sampling population and with a "! custom normalization approach. RAW_SCORE type DOUBLE, - "! **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input - "! ** language. The field is always `true` for all characteristics of English, - "! ** Spanish, and Japanese input. The field is `false` for the subset of - "! ** characteristics of Arabic and Korean input for which the service's models are - "! ** unable to generate meaningful results. **`2016-10-19`**: Not returned. + "! **`2017-10-13`**: Indicates whether the characteristic is meaningful for the + "! input language. The field is always `true` for all characteristics of English, + "! Spanish, and Japanese input. The field is `false` for the subset of + "! characteristics of Arabic and Korean input for which the service's models + "! are unable to generate meaningful results. **`2016-10-19`**: Not returned. SIGNIFICANT type BOOLEAN, "! For `personality` (Big Five) dimensions, more detailed results for the facets of "! each dimension as inferred from the input text. CHILDREN type STANDARD TABLE OF DATA_REFERENCE WITH NON-UNIQUE DEFAULT KEY, end of T_TRAIT. types: - "! The temporal behavior for the input content. + "!

+ "! 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}`. @@ -98,7 +101,9 @@ public section. PERCENTAGE type DOUBLE, end of T_BEHAVIOR. types: - "! A consumption preference that the service inferred from the input content. + "!

+ "! 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 @@ -117,29 +122,32 @@ public section. SCORE type DOUBLE, end of T_CONSUMPTION_PREFERENCES. types: - "! A warning message that is associated with the input content. + "!

+ "! 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`:
- "! * `WORD_COUNT_MESSAGE`: "There were {number} words in the input. We - "! need a minimum of 600, preferably 1,200 or more, to compute statistically - "! significant estimates."
- "! * `JSON_AS_TEXT`: "Request input was processed as text/plain as indicated, - "! however detected a JSON input. Did you mean application/json?"
- "! * `CONTENT_TRUNCATED`: "For maximum accuracy while also optimizing processing - "! time, only the first 250KB of input text (excluding markup) was analyzed. - "! Accuracy levels off at approximately 3,000 words so this did not affect the - "! accuracy of the profile."
- "! * `PARTIAL_TEXT_USED`, "The text provided to compute the profile was trimmed for - "! performance reasons. This action does not affect the accuracy of the output, as - "! not all of the input text was required." Applies only when Arabic input text - "! exceeds a threshold at which additional words do not contribute to the accuracy - "! of the profile. + "! * `WORD_COUNT_MESSAGE`: "There were {number} words in the input. + "! We need a minimum of 600, preferably 1,200 or more, to compute statistically + "! significant estimates."
+ "! * `JSON_AS_TEXT`: "Request input was processed as text/plain as indicated, + "! however detected a JSON input. Did you mean application/json?"
+ "! * `CONTENT_TRUNCATED`: "For maximum accuracy while also optimizing + "! processing time, only the first 250KB of input text (excluding markup) was + "! analyzed. Accuracy levels off at approximately 3,000 words so this did not + "! affect the accuracy of the profile."
+ "! * `PARTIAL_TEXT_USED`, "The text provided to compute the profile was + "! trimmed for performance reasons. This action does not affect the accuracy of + "! the output, as not all of the input text was required." Applies only when + "! Arabic input text exceeds a threshold at which additional words do not + "! contribute to the accuracy of the profile. MESSAGE type STRING, end of T_WARNING. types: - "! The consumption preferences that the service inferred from the input content. + "!

+ "! 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 @@ -152,7 +160,9 @@ public section. 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. + "!

+ "! 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, @@ -185,7 +195,8 @@ public section. 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. + "!

+ "! 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. @@ -223,11 +234,13 @@ public section. 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. + "!

+ "! 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. + "!

+ "! The error response from a failed request.

begin of T_ERROR_MODEL, "! The HTTP status code. CODE type INTEGER, @@ -240,7 +253,8 @@ public section. HELP type STRING, end of T_ERROR_MODEL. types: - "! The full input content that the service is to analyze. + "!

+ "! 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. "! @@ -248,6 +262,7 @@ public section. 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|', @@ -262,6 +277,7 @@ constants: 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', @@ -312,14 +328,59 @@ constants: redefinition . - "! Get profile. + "!

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.
+ "!
+ "! **See also:**
+ "! * [Requesting a + "! profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-input#input)
+ "! * [Providing sufficient + "! input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + "! ts-input#sufficient)
+ "!
+ "! ### Content types
+ "!
+ "! You can provide input content as plain text (`text/plain`), HTML (`text/html`), + "! or JSON (`application/json`) by specifying the **Content-Type** parameter. The + "! default is `text/plain`.
+ "! * Per the JSON specification, the default character encoding for JSON content is + "! effectively always UTF-8.
+ "! * Per the HTTP specification, the default encoding for plain text and HTML is + "! ISO-8859-1 (effectively, the ASCII character set).
+ "!
+ "! When specifying a content type of plain text or HTML, include the `charset` + "! parameter to indicate the character encoding of the input text; for example, + "! `Content-Type: text/plain;charset=utf-8`.
+ "!
+ "! **See also:** [Specifying request and response + "! formats](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-input#formats)
+ "!
+ "! ### Accept types
+ "!
+ "! You must request a response as JSON (`application/json`) or comma-separated + "! values (`text/csv`) by specifying the **Accept** parameter. CSV output includes + "! a fixed number of columns. Set the **csv_headers** parameter to `true` to + "! request optional column headers for CSV output.
+ "!
+ "! **See also:**
+ "! * [Understanding a JSON + "! profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-output#output)
+ "! * [Understanding a CSV + "! profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-outputCSV#outputCSV) "! "! @parameter I_CONTENT | "! A maximum of 20 MB of content to analyze, though the service requires much less "! text; for more information, see [Providing sufficient - "! input](https://cloud.ibm.com/docs/services/personality-insights?topic=personali - "! ty-insights-input#sufficient). For JSON input, provide an object of type - "! `Content`. + "! input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + "! ts-input#sufficient). For JSON input, provide an object of type `Content`. "! @parameter I_CONTENT_TYPE | "! The type of the input. For more information, see **Content types** in the method "! description. @@ -371,14 +432,59 @@ constants: !E_RESPONSE type T_PROFILE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get profile as csv. + "!

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.
+ "!
+ "! **See also:**
+ "! * [Requesting a + "! profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-input#input)
+ "! * [Providing sufficient + "! input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + "! ts-input#sufficient)
+ "!
+ "! ### Content types
+ "!
+ "! You can provide input content as plain text (`text/plain`), HTML (`text/html`), + "! or JSON (`application/json`) by specifying the **Content-Type** parameter. The + "! default is `text/plain`.
+ "! * Per the JSON specification, the default character encoding for JSON content is + "! effectively always UTF-8.
+ "! * Per the HTTP specification, the default encoding for plain text and HTML is + "! ISO-8859-1 (effectively, the ASCII character set).
+ "!
+ "! When specifying a content type of plain text or HTML, include the `charset` + "! parameter to indicate the character encoding of the input text; for example, + "! `Content-Type: text/plain;charset=utf-8`.
+ "!
+ "! **See also:** [Specifying request and response + "! formats](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-input#formats)
+ "!
+ "! ### Accept types
+ "!
+ "! You must request a response as JSON (`application/json`) or comma-separated + "! values (`text/csv`) by specifying the **Accept** parameter. CSV output includes + "! a fixed number of columns. Set the **csv_headers** parameter to `true` to + "! request optional column headers for CSV output.
+ "!
+ "! **See also:**
+ "! * [Understanding a JSON + "! profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-output#output)
+ "! * [Understanding a CSV + "! profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insi + "! ghts-outputCSV#outputCSV) "! "! @parameter I_CONTENT | "! A maximum of 20 MB of content to analyze, though the service requires much less "! text; for more information, see [Providing sufficient - "! input](https://cloud.ibm.com/docs/services/personality-insights?topic=personali - "! ty-insights-input#sufficient). For JSON input, provide an object of type - "! `Content`. + "! input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insigh + "! ts-input#sufficient). For JSON input, provide an object of type `Content`. "! @parameter I_CONTENT_TYPE | "! The type of the input. For more information, see **Content types** in the method "! description. @@ -503,7 +609,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092823'. + e_sdk_version_date = '20200310173434'. endmethod. diff --git a/src/zcl_ibmc_personal_insights_v3.clas.xml b/src/zcl_ibmc_personal_insights_v3.clas.xml index 7368b46..1f792b4 100644 --- a/src/zcl_ibmc_personal_insights_v3.clas.xml +++ b/src/zcl_ibmc_personal_insights_v3.clas.xml @@ -5,12 +5,26 @@ ZCL_IBMC_PERSONAL_INSIGHTS_V3 E - Watson Personal Insights + Personality Insights 1 X X X + + + ZCL_IBMC_PERSONAL_INSIGHTS_V3 + PROFILE + E + Get profile + + + ZCL_IBMC_PERSONAL_INSIGHTS_V3 + PROFILE_AS_CSV + E + Get profile as csv + + diff --git a/src/zcl_ibmc_service.clas.abap b/src/zcl_ibmc_service.clas.abap index 0767c32..3a869d6 100644 --- a/src/zcl_ibmc_service.clas.abap +++ b/src/zcl_ibmc_service.clas.abap @@ -36,7 +36,7 @@ public section. types JSONOBJECT type ref to DATA . types MAP type ref to DATA . types: - "! DateTime type, format 2018-10-23T15:18:18.914xxxZ + "!

DateTime type, format 2018-10-23T15:18:18.914xxxZ

DATETIME(27) type c . types TT_STRING type ZIF_IBMC_SERVICE_ARCH~TT_STRING . types: @@ -94,7 +94,7 @@ public section. data P_DEBUG_MODE type CHAR value SPACE ##NO_TEXT. data P_VERSION type STRING . - "! Raises an exception + "!

Raises an exception.

"! "! @parameter I_MSGNO | Message number. "! @parameter I_MSGV1 | Substitution for 1st placeholder in message. @@ -120,7 +120,7 @@ public section. !I_HTTP_STATUS type TS_HTTP_STATUS optional raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Returns field type and length of a given parameter + "!

Returns field type and length of a given parameter.

"! "! @parameter I_FIELD | Field of type that is supposed to be determined. "! @parameter E_TECHNICAL_TYPE | Technical type (= base type) of I_FIELD. @@ -134,7 +134,7 @@ public section. !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 + "!

Returns component names of a given structure.

"! "! @parameter I_STRUCTURE | Structure with components. "! @parameter E_COMPONENTS | Internal table of component names. @@ -144,7 +144,7 @@ public section. !I_STRUCTURE type ANY exporting value(E_COMPONENTS) type ZIF_IBMC_SERVICE_ARCH~TT_STRING . - "! Parses a JSON string into an ABAP structure + "!

Parses a JSON string into an ABAP structure.

"! "! @parameter I_JSON | JSON string. "! @parameter I_DICTIONARY | Dictionary for mapping of identifier names. @@ -159,14 +159,14 @@ public section. value(C_ABAP) type ANY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Method for internal use. + "!

Method for internal use.

"! methods GET_REQUEST_PROP importing !I_AUTH_METHOD type STRING default C_DEFAULT returning value(E_REQUEST_PROP) type TS_REQUEST_PROP . - "! Returns data type of a given parameter + "!

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. @@ -176,7 +176,8 @@ public section. !I_FIELD type ANY returning 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' + "!

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. @@ -186,7 +187,8 @@ public section. !I_IN type STRING returning value(E_OUT) type STRING . - "! Returns the file extension for a mime type, e.g. 'text/plain' -> 'txt' + "!

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). @@ -196,7 +198,7 @@ public section. value(I_MIME_TYPE) type STRING returning value(E_EXTENSION) type STRING . - "! Moves a referenced data structure to an ABAP structure + "!

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. @@ -209,7 +211,7 @@ public section. value(E_ABAP) type ANY raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Method for internal use. + "!

Method for internal use.

"! class-methods ADD_QUERY_PARAMETER importing @@ -218,7 +220,7 @@ public section. !I_IS_BOOLEAN type BOOLEAN default C_BOOLEAN_FALSE changing !C_URL type TS_URL . - "! Method for internal use. + "!

Method for internal use.

"! class-methods ADD_HEADER_PARAMETER importing @@ -227,26 +229,26 @@ public section. !I_IS_BOOLEAN type BOOLEAN default C_BOOLEAN_FALSE changing !C_HEADERS type ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP-HEADERS . - "! Method for internal use. + "!

Method for internal use.

"! class-methods GET_FULL_URL importing !I_URL type TS_URL returning value(E_URL) type STRING . - "! Returns the service name. + "!

Returns the service name.

"! "! @parameter E_APPNAME | Name of the service. "! methods GET_APPNAME returning value(E_APPNAME) type STRING . - "! Method for internal use. + "!

Method for internal use.

"! class-methods NORMALIZE_URL changing !C_URL type TS_URL . - "! Extracts a JSON string from an ABAP structure. + "!

Extracts a JSON string from an ABAP structure.

"! "! @parameter I_NAME | Name of component to be extracted. "! @parameter I_VALUE | ABAP structure to be converted to JSON string. @@ -257,7 +259,6 @@ public section. "! Otherwise it is omitted in JSON string. "! @parameter I_LOWER_CASE | If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case. "! @parameter E_JSON | JSON string. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! class-methods ABAP_TO_JSON importing @@ -268,13 +269,19 @@ public section. !I_LOWER_CASE type BOOLEAN default C_BOOLEAN_TRUE returning 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 importing !I_RESPONSE type TO_REST_RESPONSE optional !I_URL type TS_URL optional raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Class constructor. + "!

Class constructor.

"! "! @parameter I_URL | URL of the service. "! @parameter I_HOST | Host of the service. I_URL and I_HOST can be used synonymously. @@ -299,7 +306,7 @@ public section. !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. + "!

Method for internal use.

"! methods GET_REST_CLIENT importing @@ -308,7 +315,7 @@ public section. value(E_CLIENT) type TS_CLIENT raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Method for internal use. + "!

Method for internal use.

"! methods GET_ACCESS_TOKEN importing @@ -317,7 +324,7 @@ public section. value(E_ACCESS_TOKEN) type TS_ACCESS_TOKEN raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Sends a HTTP DELETE request. + "!

Sends a HTTP DELETE request.

"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. @@ -330,17 +337,14 @@ public section. value(E_RESPONSE) type TO_REST_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Sets an access token explicitly. + "!

Sets an access token explicitly.

"! "! @parameter I_ACCESS_TOKEN | Access token. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! methods SET_ACCESS_TOKEN importing - !I_ACCESS_TOKEN type TS_ACCESS_TOKEN - raising - ZCX_IBMC_SERVICE_EXCEPTION . - "! Sends a HTTP GET request. + !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. @@ -353,7 +357,7 @@ public section. value(E_RESPONSE) type TO_REST_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Sends a HTTP POST request. + "!

Sends a HTTP POST request.

"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. @@ -366,7 +370,7 @@ public section. value(E_RESPONSE) type TO_REST_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Sends a HTTP POST request with multipart body. + "!

Sends a HTTP POST request with multipart body.

"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter IT_FORM_PART | Internal table of form parts in request body. @@ -381,7 +385,7 @@ public section. value(E_RESPONSE) type TO_REST_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Sends a HTTP PUT request. + "!

Sends a HTTP PUT request.

"! "! @parameter I_REQUEST_PROP | Request properties. "! @parameter E_RESPONSE | Response returned by service. @@ -396,14 +400,17 @@ public section. ZCX_IBMC_SERVICE_EXCEPTION . protected section. + "!

Method for internal use.

methods ADJUST_REQUEST_PROP changing !C_REQUEST_PROP type TS_REQUEST_PROP . + "!

Method for internal use.

class-methods MERGE_STRUCTURE importing !I_ALTERNATIVE type ANY changing !C_BASE type ANY . + "!

Method for internal use.

methods SET_URI_AND_AUTHORIZATION importing !I_CLIENT type TS_CLIENT @@ -1424,6 +1431,12 @@ CLASS ZCL_IBMC_SERVICE IMPLEMENTATION. method set_access_token. p_request_prop_default-access_token = i_access_token. + if p_request_prop_default-access_token-token_type is initial. + p_request_prop_default-access_token-token_type = 'Bearer'. + endif. + if p_request_prop_default-access_token-expires_ts = 0. + p_request_prop_default-access_token-expires_ts = '99991231235959' ##LITERAL. " avoid token being refreshed by sdk + endif. endmethod. diff --git a/src/zcl_ibmc_service.clas.xml b/src/zcl_ibmc_service.clas.xml index ededc14..a7409e5 100644 --- a/src/zcl_ibmc_service.clas.xml +++ b/src/zcl_ibmc_service.clas.xml @@ -16,151 +16,175 @@ ZCL_IBMC_SERVICE ABAP_TO_JSON E - Generates a JSON string from any ABAP structure + Extracts a JSON string from an ABAP structure. ZCL_IBMC_SERVICE ADD_HEADER_PARAMETER E - Adds a HTTP header parameter + Method for internal use. ZCL_IBMC_SERVICE ADD_QUERY_PARAMETER E - Adds a REST query parameter + Method for internal use. + + + ZCL_IBMC_SERVICE + ADJUST_REQUEST_PROP + E + Method for internal use. ZCL_IBMC_SERVICE CHECK_HTTP_RESPONSE E - Throws an exception, if HTTP response indicates an error + Throws an exception, if HTTP response indicates an error. ZCL_IBMC_SERVICE CONSTRUCTOR E - Class constructor + Class constructor. + + + ZCL_IBMC_SERVICE + DATETIME + E + DateTime type, format 2018-10-23T15:18:18.914xxxZ ZCL_IBMC_SERVICE GET_ACCESS_TOKEN E - Reads or generates an authorization token + Method for internal use. ZCL_IBMC_SERVICE GET_APPNAME E - Returns the API or service name, resp. + Returns the service name. ZCL_IBMC_SERVICE GET_COMPONENTS E - Returns the component names of a given structure + Returns component names of a given structure. ZCL_IBMC_SERVICE GET_DATATYPE E - Returns data type of a variable + Returns data type of a given parameter. ZCL_IBMC_SERVICE GET_FIELD_TYPE E - Returns the absolute type of a field + Returns field type and length of a given parameter. ZCL_IBMC_SERVICE GET_FILE_EXTENSION E - Returns file extension for given mime type + Returns the file extension for a mime type ZCL_IBMC_SERVICE GET_FULL_URL E - Returns complete URL string + Method for internal use. ZCL_IBMC_SERVICE GET_REQUEST_PROP E - Returns default request properties + Method for internal use. ZCL_IBMC_SERVICE GET_REST_CLIENT E - Creates a REST client instance + Method for internal use. ZCL_IBMC_SERVICE HTTP_DELETE E - Performs a http DELETE request + Sends a HTTP DELETE request. ZCL_IBMC_SERVICE HTTP_GET E - Performs a http GET request + Sends a HTTP GET request. ZCL_IBMC_SERVICE HTTP_POST E - Performs a http POST request + Sends a HTTP POST request. ZCL_IBMC_SERVICE HTTP_POST_MULTIPART E - Performs a HTTP POST request with multipart body + Sends a HTTP POST request with multipart body. ZCL_IBMC_SERVICE HTTP_PUT E - Performs a http PUT request + Sends a HTTP PUT request. + + + ZCL_IBMC_SERVICE + MERGE_STRUCTURE + E + Method for internal use. ZCL_IBMC_SERVICE MOVE_DATA_REFERENCE_TO_ABAP E - Moves type DATA_REFERENCE to ABAP structure + Moves a referenced data structure to an ABAP structure. ZCL_IBMC_SERVICE NORMALIZE_URL E - Normalize URL in structure of type TS_URL + Method for internal use. ZCL_IBMC_SERVICE PARSE_JSON E - Parses a JSON string into an ABAP structure + Parses a JSON string into an ABAP structure. ZCL_IBMC_SERVICE RAISE_EXCEPTION E - Throws an exception of type ZCX_IBMC_SERVICE_EXCEPTION + Raises an exception. ZCL_IBMC_SERVICE SET_ACCESS_TOKEN E - Sets an authorization token explicitly + Sets an access token explicitly. + + + ZCL_IBMC_SERVICE + SET_URI_AND_AUTHORIZATION + E + Method for internal use. ZCL_IBMC_SERVICE UNESCAPE_UNICODE E - Unescapes unicode codepoints + Unescape unicode codepoints to characters in a string diff --git a/src/zcl_ibmc_service_arch.clas.abap b/src/zcl_ibmc_service_arch.clas.abap index 23f7342..f43c8f7 100644 --- a/src/zcl_ibmc_service_arch.clas.abap +++ b/src/zcl_ibmc_service_arch.clas.abap @@ -11,125 +11,229 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -class ZCL_IBMC_SERVICE_ARCH definition +class zcl_ibmc_service_arch definition public create public . -public section. + public section. - interfaces ZIF_IBMC_SERVICE_ARCH . + interfaces zif_ibmc_service_arch . - types TO_HTTP_CLIENT type ref to IF_HTTP_CLIENT . - types TO_REST_CLIENT type ref to CL_REST_HTTP_CLIENT . - types TO_HTTP_ENTITY type ref to IF_HTTP_ENTITY . - types TO_REST_ENTITY type ref to IF_REST_ENTITY . - types TO_REST_REQUEST type ref to IF_REST_ENTITY . - types TO_REST_RESPONSE type ref to IF_REST_ENTITY . - types TO_FORM_PART type ref to IF_HTTP_ENTITY . - types: - begin of ts_client, + types to_http_client type ref to if_http_client . + types to_rest_client type ref to cl_rest_http_client . + types to_http_entity type ref to if_http_entity . + types to_rest_entity type ref to if_rest_entity . + types to_rest_request type ref to if_rest_entity . + types to_rest_response type ref to if_rest_entity . + types to_form_part type ref to if_http_entity . + types: + begin of ts_client, http type to_http_client, rest type to_rest_client, end of ts_client . - types TS_HTTP_STATUS type ZIF_IBMC_SERVICE_ARCH~TS_HTTP_STATUS . - types TS_HEADER type ZIF_IBMC_SERVICE_ARCH~TS_HEADER . - types TT_HEADER type ZIF_IBMC_SERVICE_ARCH~TT_HEADER . - types TS_URL type ZIF_IBMC_SERVICE_ARCH~TS_URL . - types TS_ACCESS_TOKEN type ZIF_IBMC_SERVICE_ARCH~TS_ACCESS_TOKEN . - types TS_REQUEST_PROP type ZIF_IBMC_SERVICE_ARCH~TS_REQUEST_PROP . - - class-methods GET_TIMEZONE - returning - value(E_TIMEZONE) type ZIF_IBMC_SERVICE_ARCH~TY_TIMEZONE . - class-methods GET_PROGNAME - returning - value(E_PROGNAME) type STRING . - class-methods BASE64_DECODE - importing - !I_BASE64 type STRING - returning - value(E_BINARY) type XSTRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . - class-methods CREATE_CLIENT_BY_URL - importing - !I_URL type STRING - !I_REQUEST_PROP type TS_REQUEST_PROP - exporting - !E_CLIENT type TS_CLIENT - raising - ZCX_IBMC_SERVICE_EXCEPTION . - methods ADD_FORM_PART - importing - !I_CLIENT type TS_CLIENT - !IT_FORM_PART type ZIF_IBMC_SERVICE_ARCH=>TT_FORM_PART - raising - ZCX_IBMC_SERVICE_EXCEPTION . - class-methods GET_DEFAULT_PROXY - importing - !I_URL type TS_URL optional - exporting - !E_PROXY_HOST type STRING - !E_PROXY_PORT type STRING . - class-methods SET_AUTHENTICATION_BASIC - importing - !I_CLIENT type TS_CLIENT - !I_USERNAME type STRING - !I_PASSWORD type STRING . - class-methods SET_REQUEST_HEADER - importing - !I_CLIENT type TS_CLIENT - !I_NAME type STRING - !I_VALUE type STRING . - class-methods SET_REQUEST_URI - importing - !I_CLIENT type TS_CLIENT - !I_URI type STRING . - class-methods EXECUTE - importing - !I_CLIENT type TS_CLIENT - !I_METHOD type ZIF_IBMC_SERVICE_ARCH~CHAR default ZIF_IBMC_SERVICE_ARCH~C_METHOD_GET - returning - value(E_RESPONSE) type TO_REST_RESPONSE - raising - ZCX_IBMC_SERVICE_EXCEPTION . - class-methods GET_RESPONSE_STRING - importing - !I_RESPONSE type TO_REST_RESPONSE - returning - value(E_DATA) type STRING . - class-methods SET_REQUEST_BODY_CDATA - importing - !I_CLIENT type TS_CLIENT - !I_DATA type STRING . - class-methods SET_REQUEST_BODY_XDATA - importing - !I_CLIENT type TS_CLIENT - !I_DATA type XSTRING . - class-methods GET_RESPONSE_BINARY - importing - !I_RESPONSE type TO_REST_RESPONSE - returning - value(E_DATA) type XSTRING . - class-methods GET_REST_REQUEST - importing - !I_CLIENT type TS_CLIENT - returning - value(E_REST_REQUEST) type TO_REST_REQUEST . - class-methods GET_HTTP_STATUS - importing - !I_REST_RESPONSE type TO_REST_RESPONSE - returning - value(E_STATUS) type TS_HTTP_STATUS . - class-methods CONVERT_STRING_TO_UTF8 - importing - !I_STRING type STRING - returning - value(E_UTF8) type XSTRING - raising - ZCX_IBMC_SERVICE_EXCEPTION . -protected section. -private section. + types ts_http_status type zif_ibmc_service_arch~ts_http_status . + types ts_header type zif_ibmc_service_arch~ts_header . + types tt_header type zif_ibmc_service_arch~tt_header . + types ts_url type zif_ibmc_service_arch~ts_url . + types ts_access_token type zif_ibmc_service_arch~ts_access_token . + types ts_request_prop type zif_ibmc_service_arch~ts_request_prop . + + "!

Returns a HTTP response header.

+ "! + "! @parameter I_RESPONSE | HTTP/REST response + "! @parameter I_HEADER_FIELD | Header field name + "! @parameter E_VALUE | Header field value + "! + class-methods get_response_header + importing + !i_response type to_rest_response + !i_header_field type string + returning + value(e_value) type string . + "!

Returns the user's time zone.

+ "! + "! @parameter E_TIMEZONE | user's time zone + "! + class-methods get_timezone + returning + value(e_timezone) type zif_ibmc_service_arch~ty_timezone . + "!

Returns an ABAP module identifier.

+ "! + "! @parameter E_PROGNAME | ABAP module identifier + "! + class-methods get_progname + returning + value(e_progname) type string . + "!

Decodes base64 encoded data to binary.

+ "! + "! @parameter I_BASE64 | Base64-encoded binary + "! @parameter E_BINARY | Binary data + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + class-methods base64_decode + importing + !i_base64 type string + returning + value(e_binary) type xstring + raising + zcx_ibmc_service_exception . + "!

Returns a HTTP/REST client based on an URL.

+ "! + "! @parameter I_URL | URL + "! @parameter I_REQUEST_PROP | Request parameters + "! @parameter E_CLIENT | HTTP/REST client + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + class-methods create_client_by_url + importing + !i_url type string + !i_request_prop type ts_request_prop + exporting + !e_client type ts_client + raising + zcx_ibmc_service_exception . + "!

Generates a multi-part request body.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter IT_FORM_PART | Table of form parts + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + methods add_form_part + importing + !i_client type ts_client + !it_form_part type zif_ibmc_service_arch=>tt_form_part + raising + zcx_ibmc_service_exception . + "!

Returns the default proxy host and port.

+ "! + "! @parameter I_URL | target URL + "! @parameter E_PROXY_HOST | Proxy host + "! @parameter E_PROXY_PORT | Proxy port + "! + class-methods get_default_proxy + importing + !i_url type ts_url optional + exporting + !e_proxy_host type string + !e_proxy_port type string . + "!

Sets request header for basic authentication.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter I_USERNAME | User name + "! @parameter I_PASSWORD | Password + "! + class-methods set_authentication_basic + importing + !i_client type ts_client + !i_username type string + !i_password type string . + "!

Sets a HTTP header.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter I_NAME | Header field name + "! @parameter I_VALUE | Header field value + "! + class-methods set_request_header + importing + !i_client type ts_client + !i_name type string + !i_value type string . + "!

Sets the URI for a HTTP request.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter I_URI | URI + "! + class-methods set_request_uri + importing + !i_client type ts_client + !i_uri type string . + "!

Executes a HTTP request.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter I_METHOD | HTTP method (GET,POST,PUT,DELETE) + "! @parameter E_RESPONSE | Response of the request + "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. + "! + class-methods execute + importing + !i_client type ts_client + !i_method type zif_ibmc_service_arch~char default zif_ibmc_service_arch~c_method_get + returning + value(e_response) type to_rest_response + raising + zcx_ibmc_service_exception . + "!

Reads character data from a HTTP response.

+ "! + "! @parameter I_RESPONSE | HTTP response + "! @parameter E_DATA | Character data + "! + class-methods get_response_string + importing + !i_response type to_rest_response + returning + value(e_data) type string . + "!

Set character data for the body of a HTTP request.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter I_DATA | Character data + "! + class-methods set_request_body_cdata + importing + !i_client type ts_client + !i_data type string . + "!

Set binary data for the body of a HTTP request.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter I_DATA | Binary data + "! + class-methods set_request_body_xdata + importing + !i_client type ts_client + !i_data type xstring . + "!

Reads binary data from a HTTP response.

+ "! + "! @parameter I_RESPONSE | HTTP response + "! @parameter E_DATA | Binary data + "! + class-methods get_response_binary + importing + !i_response type to_rest_response + returning + value(e_data) type xstring . + "!

Returns a request object from a HTTP client object.

+ "! + "! @parameter I_CLIENT | HTTP/REST client + "! @parameter E_REST_REQUEST | REST request object + "! + class-methods get_rest_request + importing + !i_client type ts_client + returning + value(e_rest_request) type to_rest_request . + "!

Returns the status of a REST response.

+ "! + "! @parameter I_REST_RESPONSE | HTTP/REST response + "! @parameter E_STATUS | HTTP status + "! + class-methods get_http_status + importing + !i_rest_response type to_rest_response + returning + value(e_status) type ts_http_status . + "!

Converts STRING data to UTF8 encoded XSTRING.

+ "! + "! @parameter I_STRING | STRING data + "! @parameter E_UTF8 | UTF8-encoded data + "! + class-methods convert_string_to_utf8 + importing + !i_string type string + returning + value(e_utf8) type xstring + raising + zcx_ibmc_service_exception . + protected section. + private section. ENDCLASS. @@ -361,6 +465,13 @@ CLASS ZCL_IBMC_SERVICE_ARCH IMPLEMENTATION. endmethod. + method get_response_header. + + e_value = i_response->get_header_field( iv_name = i_header_field ). + + endmethod. + + method get_response_string. e_data = i_response->get_string_data( ). diff --git a/src/zcl_ibmc_service_arch.clas.xml b/src/zcl_ibmc_service_arch.clas.xml index 348dddf..570e35b 100644 --- a/src/zcl_ibmc_service_arch.clas.xml +++ b/src/zcl_ibmc_service_arch.clas.xml @@ -12,101 +12,113 @@ X + + ZCL_IBMC_SERVICE_ARCH + ADD_FORM_PART + E + Generates a multi-part request body. + ZCL_IBMC_SERVICE_ARCH BASE64_DECODE E - Decodes base64 encoded data to binary + Decodes base64 encoded data to binary. ZCL_IBMC_SERVICE_ARCH CONVERT_STRING_TO_UTF8 E - Converts STRING data to UTF8 encoded XSTRING + Converts STRING data to UTF8 encoded XSTRING. ZCL_IBMC_SERVICE_ARCH CREATE_CLIENT_BY_URL E - Returns a HTTP/REST client based on an URL + Returns a HTTP/REST client based on an URL. ZCL_IBMC_SERVICE_ARCH EXECUTE E - Executes a HTTP request (GET, POST or DELETE) + Executes a HTTP request. ZCL_IBMC_SERVICE_ARCH GET_DEFAULT_PROXY E - Returns the default proxy host and port + Returns the default proxy host and port. ZCL_IBMC_SERVICE_ARCH GET_HTTP_STATUS E - Returns the status of a http response + Returns the status of a REST response. ZCL_IBMC_SERVICE_ARCH GET_PROGNAME E - Returns the ABAP program name + Returns an ABAP module identifier. ZCL_IBMC_SERVICE_ARCH GET_RESPONSE_BINARY E - Reads string data from response + Reads binary data from a HTTP response. + + + ZCL_IBMC_SERVICE_ARCH + GET_RESPONSE_HEADER + E + Returns a HTTP response header. ZCL_IBMC_SERVICE_ARCH GET_RESPONSE_STRING E - Reads string data from response + Reads character data from a HTTP response. ZCL_IBMC_SERVICE_ARCH GET_REST_REQUEST E - Returns a request object from a HTTP client object + Returns a request object from a HTTP client object. ZCL_IBMC_SERVICE_ARCH GET_TIMEZONE E - Returns the user's time zone + Returns the user's time zone. ZCL_IBMC_SERVICE_ARCH SET_AUTHENTICATION_BASIC E - Sets request header for basic authentication + Sets request header for basic authentication. ZCL_IBMC_SERVICE_ARCH SET_REQUEST_BODY_CDATA E - Sets the body of a HTTP request object + Set character data for the body of a HTTP request. ZCL_IBMC_SERVICE_ARCH SET_REQUEST_BODY_XDATA E - Sets the body of a HTTP request object + Set binary data for the body of a HTTP request. ZCL_IBMC_SERVICE_ARCH SET_REQUEST_HEADER E - Sets a HTTP header + Sets a HTTP header. ZCL_IBMC_SERVICE_ARCH SET_REQUEST_URI E - Sets the URI for a HTTP request + Sets the URI for a HTTP request. ZCL_IBMC_SERVICE_ARCH diff --git a/src/zcl_ibmc_service_ext.clas.abap b/src/zcl_ibmc_service_ext.clas.abap index da380b1..f576911 100644 --- a/src/zcl_ibmc_service_ext.clas.abap +++ b/src/zcl_ibmc_service_ext.clas.abap @@ -46,33 +46,32 @@ public section. constants C_TOKEN_GENERATION_AUTO type CHAR value SPACE ##NO_TEXT. constants C_IAM_TOKEN_HOST type STRING value 'iam.cloud.ibm.com' ##NO_TEXT. constants C_IAM_TOKEN_PATH type STRING value '/identity/token' ##NO_TEXT. + constants C_ICP4D_TOKEN_PATH type STRING value '/v1/preauth/validateAuth' ##NO_TEXT. data P_INSTANCE_ID type TY_INSTANCE_ID . data P_SERVICENAME type TY_SERVICENAME . - "! Sends a HTTP PUT request. + "!

Returns the bearer token, if available.

"! - "! @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. + "! @parameter E_BEARER_TOKEN | Access token. "! methods GET_BEARER_TOKEN returning value(E_BEARER_TOKEN) type STRING . - "! Returns the SDK built date. + "!

Returns the SDK built date.

"! "! @parameter E_SDK_VERSION_DATE | Built data in format YYYYMMDD. "! methods GET_SDK_VERSION_DATE returning value(E_SDK_VERSION_DATE) type STRING . - "! Method for internal use. + "!

Method for internal use.

"! methods SET_BEARER_TOKEN importing !I_BEARER_TOKEN type STRING . - "! Retrieves a value of a configuration parameter from table ZIBMC_CONFIG. + "!

Retrieves a value of a configuration parameter

from table ZIBMC_CONFIG. "! - "! @parameter I_DEFUALT | Default value, if configuration parameter is not found. + "! @parameter I_DEFAULT | Default value, if configuration parameter is not found. "! @parameter I_PARAM | Configuration parameter name. "! methods GET_CONFIG_VALUE @@ -83,7 +82,7 @@ public section. value(E_VALUE) type ZIBMC_CONFIG-VALUE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Factory method to instantiate a service specific wrapper class. + "!

Factory method to instantiate a service specific wrapper class.

"! "! @parameter I_INSTANCE_ID | "! Value of field INSTANCE_UID in table ZIBMC_CONFIG. @@ -96,7 +95,7 @@ public section. "! @parameter I_PROXY_PORT | Proxy server port, not applicable on SAP Cloud Platform. "! @parameter I_APIKEY | API key password to authenticate on service. "! @parameter I_AUTH_METHOD | Authentication method. Possible values are "IAM", "ICP4D", "basicAuth", "NONE". - "! @parameter I_I_OAUTH_PROP | Credentials to generate token for OAuth authentication. + "! @parameter I_OAUTH_PROP | Credentials to generate token for OAuth authentication. "! @parameter I_TOKEN_GENERATION | Method for access token refresh:
"! C_TOKEN_GENERATION_NEVER - Access token is not refreshed. "! C_TOKEN_GENERATION_ALWAYS - Access to token is refreshed for each service call. @@ -112,16 +111,17 @@ public section. !I_USERNAME type STRING optional !I_PASSWORD type STRING optional !I_PROXY_HOST type STRING optional - !I_PROXY_SERVICE type STRING optional + !I_PROXY_PORT type STRING optional !I_APIKEY type STRING optional !I_AUTH_METHOD type STRING default C_DEFAULT !I_OAUTH_PROP type TS_OAUTH_PROP optional + !I_ACCESS_TOKEN type TS_ACCESS_TOKEN optional !I_TOKEN_GENERATION type CHAR default C_TOKEN_GENERATION_AUTO !I_REQUEST_HEADERS type STRING optional !I_VERSION type STRING optional exporting value(EO_INSTANCE) type ANY . - "! Compresses multiple images from an internal table to a one or more xstrings in ZIP format. + "!

Compresses multiple images from an internal table

to a one or more xstrings in ZIP format. "! "! @parameter IT_EXAMPLES | Internal table of images. "! @parameter IV_FIELD_CLASS | @@ -152,16 +152,13 @@ public section. redefinition . methods GET_REQUEST_PROP redefinition . - methods SET_ACCESS_TOKEN - redefinition . protected section. private section. data P_OAUTH_PROP type TS_OAUTH_PROP . data P_TOKEN_GENERATION type CHAR . - data P_TOKEN_SAVED type ZIBMC_TOKEN . - "! Method for internal use. + "!

Method for internal use.

"! class-methods ADD_CONFIG_PROP importing @@ -169,7 +166,7 @@ private section. !I_INSTANCE_ID type TY_INSTANCE_ID optional changing !C_REQUEST_PROP type ANY . - "! Method for internal use. + "!

Method for internal use.

"! class-methods ADD_IMAGE_TO_ZIP importing @@ -181,7 +178,7 @@ private section. !IV_FIELD_FILENAME type FIELDNAME optional raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Method for internal use. + "!

Method for internal use.

"! class-methods GET_FIELD_DATA importing @@ -343,8 +340,10 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. token type string, end of ls_token_classic. - if not p_token_saved is initial. - ls_token = p_token_saved. + if not i_request_prop-access_token-access_token is initial. + ls_token-access_token = p_request_prop_default-access_token-access_token. + ls_token-token_type = p_request_prop_default-access_token-token_type. + ls_token-expires_ts = p_request_prop_default-access_token-expires_ts. else. select single * @@ -428,6 +427,7 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. ls_token_request_prop-username = p_oauth_prop-username. ls_token_request_prop-password = p_oauth_prop-password. ls_token_request_prop-apikey = p_oauth_prop-apikey. + ls_token_request_prop-url = p_oauth_prop-url. ls_token_request_prop-auth_basic = c_boolean_true. " execute HTTP GET request @@ -436,13 +436,39 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. " receive response json lv_json = get_response_string( lo_response ). - " call json parser - parse_json( - exporting - i_json = lv_json - changing - c_abap = ls_token_classic ). - ls_token-expires_in = 3600. + if i_request_prop-auth_name eq 'ICP4D' ##NO_TEXT. + + " parse expected response: + " { "username": "joe", "role": "User", "uid": "1003", + " "accessToken": "eyJhbGc…1AjT_w", + " "messageCode": "success", "message": "success" } + data: + begin of ls_access_token_icp4d, + accesstoken type string, + end of ls_access_token_icp4d. + parse_json( + exporting + i_json = lv_json + changing + c_abap = ls_access_token_icp4d ). + + ls_token-access_token = ls_access_token_icp4d-accesstoken. + ls_token-expires_in = 12 * 3600. + + else. + + " call json parser + parse_json( + exporting + i_json = lv_json + changing + c_abap = ls_token_classic ). + + ls_token-access_token = ls_token_classic-token. + ls_token-expires_in = 3600. + + endif. + ls_token-token_type = 'Bearer' ##NO_TEXT. endif. @@ -465,8 +491,6 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. commit work. endif. - p_token_saved = ls_token. - endif. " fill returning parameter @@ -692,6 +716,8 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. exporting i_url = i_url i_host = i_host + i_proxy_host = i_proxy_host + i_proxy_port = i_proxy_port i_username = i_username i_password = i_password i_apikey = i_apikey. @@ -766,14 +792,22 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. normalize_url( changing c_url = lo_instance->p_oauth_prop-url ). - if ls_request_prop-auth_name eq 'IAM' ##NO_TEXT. + if ls_request_prop-auth_name eq 'IAM' or ls_request_prop-auth_name eq 'ICP4D' ##NO_TEXT. if lo_instance->p_oauth_prop-url-host is initial. lo_instance->p_oauth_prop-url-protocol = 'https' ##NO_TEXT. - lo_instance->p_oauth_prop-url-host = c_iam_token_host. + if ls_request_prop-auth_name eq 'IAM'. + lo_instance->p_oauth_prop-url-host = c_iam_token_host. + else. + lo_instance->p_oauth_prop-url-host = lo_instance->p_request_prop_default-url-host. + endif. endif. if lo_instance->p_oauth_prop-url-path_base is initial and lo_instance->p_oauth_prop-url-path is initial. " Set path_base (not path), otherwise the default service path_base would be added, which is not correct - lo_instance->p_oauth_prop-url-path_base = c_iam_token_path. + if ls_request_prop-auth_name eq 'IAM'. + lo_instance->p_oauth_prop-url-path_base = c_iam_token_path. + else. + lo_instance->p_oauth_prop-url-path_base = c_icp4d_token_path. + endif. endif. if lo_instance->p_oauth_prop-password is initial and lo_instance->p_oauth_prop-apikey is initial. lo_instance->p_oauth_prop-username = lo_instance->p_request_prop_default-username. @@ -782,7 +816,12 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. endif. endif. - lo_instance->p_token_generation = i_token_generation. + if not i_access_token-access_token is initial. + lo_instance->p_token_generation = c_token_generation_never. + lo_instance->set_access_token( i_access_token = i_access_token ). + else. + lo_instance->p_token_generation = i_token_generation. + endif. lo_instance->p_version = i_version. @@ -995,18 +1034,6 @@ CLASS ZCL_IBMC_SERVICE_EXT IMPLEMENTATION. endmethod. - method set_access_token. - - super->set_access_token( i_access_token = i_access_token ). - - clear p_token_saved. - p_token_saved-access_token = i_access_token-access_token. - p_token_saved-token_type = i_access_token-token_type. - p_token_saved-expires_ts = '99991231235959' ##LITERAL. " avoid token being refreshed by sdk - - endmethod. - - method set_bearer_token. data: diff --git a/src/zcl_ibmc_service_ext.clas.xml b/src/zcl_ibmc_service_ext.clas.xml index b4efd87..ef1d076 100644 --- a/src/zcl_ibmc_service_ext.clas.xml +++ b/src/zcl_ibmc_service_ext.clas.xml @@ -12,11 +12,17 @@ X + + ZCL_IBMC_SERVICE_EXT + ADD_CONFIG_PROP + E + Method for internal use. + ZCL_IBMC_SERVICE_EXT ADD_IMAGE_TO_ZIP E - Adds an image to zip data + Method for internal use. ZCL_IBMC_SERVICE_EXT @@ -70,49 +76,43 @@ ZCL_IBMC_SERVICE_EXT GET_BEARER_TOKEN E - Returns the bearer token, if available + Returns the bearer token, if available. ZCL_IBMC_SERVICE_EXT GET_CONFIG_VALUE E - Reads an individual value form table ZIBMC_CONFIG + Retrieves a value of a configuration parameter ZCL_IBMC_SERVICE_EXT GET_FIELD_DATA E - Determines fields containing image name and image data + Method for internal use. ZCL_IBMC_SERVICE_EXT GET_INSTANCE E - Creates an IBM Cloud service class instance + Factory method to instantiate a service specific wrapper cla ZCL_IBMC_SERVICE_EXT GET_SDK_VERSION_DATE E - returns the build date of the method + Returns the SDK built date. ZCL_IBMC_SERVICE_EXT GET_ZIPDATA E - Creates or Updates a classifier - - - ZCL_IBMC_SERVICE_EXT - P_TOKEN_SAVED - E - IAM tokens + Compresses multiple images from an internal table ZCL_IBMC_SERVICE_EXT SET_BEARER_TOKEN E - Sets the bearer token + Method for internal use. diff --git a/src/zcl_ibmc_speech_to_text_v1.clas.abap b/src/zcl_ibmc_speech_to_text_v1.clas.abap index e95d39a..bfc0e9e 100644 --- a/src/zcl_ibmc_speech_to_text_v1.clas.abap +++ b/src/zcl_ibmc_speech_to_text_v1.clas.abap @@ -11,8 +11,8 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Speech to Text

-"! The IBM® Speech to Text service provides APIs that use IBM's +"!

Speech to Text

+"! The IBM® Speech to Text service provides APIs that use IBM's "! speech-recognition capabilities to produce transcripts of spoken audio. The "! service can transcribe speech from various languages and audio formats. In "! addition to basic transcription, the service can produce detailed information @@ -43,20 +43,24 @@ class ZCL_IBMC_SPEECH_TO_TEXT_V1 DEFINITION public section. types: - "! A warning from training of a custom language or custom acoustic model. + "!

+ "! A warning from training of a custom language or custom

+ "! acoustic model. begin of T_TRAINING_WARNING, "! An identifier for the type of invalid resources listed in the `description` "! field. CODE type STRING, "! A warning message that lists the invalid resources that are excluded from the - "! custom model's training. The message has the following format: `Analysis of the - "! following {resource_type} has not completed successfully: + "! custom model's training. The message has the following format: `Analysis + "! of the following {resource_type} has not completed successfully: "! [{resource_names}]. They will be excluded from custom "! {model_type} model training.`. MESSAGE type STRING, end of T_TRAINING_WARNING. types: - "! The response from training of a custom language or custom acoustic model. + "!

+ "! The response from training of a custom language or custom

+ "! acoustic model. begin of T_TRAINING_RESPONSE, "! An array of `TrainingWarning` objects that lists any invalid resources contained "! in the custom model. For custom language models, invalid resources are grouped @@ -65,7 +69,9 @@ public section. WARNINGS type STANDARD TABLE OF T_TRAINING_WARNING WITH NON-UNIQUE DEFAULT KEY, end of T_TRAINING_RESPONSE. types: - "! An alternative hypothesis for a word from speech recognition results. + "!

+ "! An alternative hypothesis for a word from speech recognition

+ "! results. begin of T_WORD_ALTERNATIVE_RESULT, "! A confidence score for the word alternative hypothesis in the range of 0.0 to "! 1.0. @@ -74,8 +80,9 @@ public section. WORD type STRING, end of T_WORD_ALTERNATIVE_RESULT. types: - "! Information about alternative hypotheses for words from speech recognition - "! results. + "!

+ "! Information about alternative hypotheses for words from

+ "! speech recognition results. begin of T_WORD_ALTERNATIVE_RESULTS, "! The start time in seconds of the word from the input audio that corresponds to "! the word alternatives. @@ -87,11 +94,12 @@ public section. ALTERNATIVES type STANDARD TABLE OF T_WORD_ALTERNATIVE_RESULT WITH NON-UNIQUE DEFAULT KEY, end of T_WORD_ALTERNATIVE_RESULTS. types: - "! A bin with defined boundaries that indicates the number of values in a range of - "! signal characteristics for a histogram. The first and last bins of a histogram - "! are the boundary bins. They cover the intervals between negative infinity and - "! the first boundary, and between the last boundary and positive infinity, - "! respectively. + "!

+ "! A bin with defined boundaries that indicates the number of

+ "! values in a range of signal characteristics for a histogram. The first and last + "! bins of a histogram are the boundary bins. They cover the intervals between + "! negative infinity and the first boundary, and between the last boundary and + "! positive infinity, respectively. begin of T_AUDIO_METRICS_HISTOGRAM_BIN, "! The lower boundary of the bin in the histogram. BEGIN type FLOAT, @@ -101,7 +109,9 @@ public section. COUNT type INTEGER, end of T_AUDIO_METRICS_HISTOGRAM_BIN. types: - "! Information about the speakers from speech recognition results. + "!

+ "! Information about the speakers from speech recognition

+ "! results. begin of T_SPEAKER_LABELS_RESULT, "! The start time of a word from the transcript. The value matches the start time "! of a word from the `timestamps` array. @@ -115,8 +125,8 @@ public section. "! the service processes the audio. They are not guaranteed to be sequential, "! contiguous, or ordered. SPEAKER type INTEGER, - "! A score that indicates the service's confidence in its identification of the - "! speaker in the range of 0.0 to 1.0. + "! A score that indicates the service's confidence in its identification of + "! the speaker in the range of 0.0 to 1.0. CONFIDENCE type FLOAT, "! An indication of whether the service might further change word and speaker-label "! results. A value of `true` means that the service guarantees not to send any @@ -125,28 +135,32 @@ public section. FINAL type BOOLEAN, end of T_SPEAKER_LABELS_RESULT. types: - "! An alternative transcript from speech recognition results. + "!

+ "! An alternative transcript from speech recognition results.

begin of T_SPCH_RECOGNITION_ALTERNATIVE, "! A transcription of the audio. TRANSCRIPT type STRING, - "! A score that indicates the service's confidence in the transcript in the range - "! of 0.0 to 1.0. A confidence score is returned only for the best alternative and - "! only with results marked as final. + "! A score that indicates the service's confidence in the transcript in the + "! range of 0.0 to 1.0. A confidence score is returned only for the best + "! alternative and only with results marked as final. CONFIDENCE type DOUBLE, "! Time alignments for each word from the transcript as a list of lists. Each inner "! list consists of three elements: the word followed by its start and end time in - "! seconds, for example: `[["hello",0.0,1.2],["world",1.2,2.5]]`. Timestamps are + "! seconds, for example: + "! `[["hello",0.0,1.2],["world",1.2,2.5]]`. Timestamps are "! returned only for the best alternative. TIMESTAMPS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, "! A confidence score for each word of the transcript as a list of lists. Each "! inner list consists of two elements: the word and its confidence score in the - "! range of 0.0 to 1.0, for example: `[["hello",0.95],["world",0.866]]`. - "! Confidence scores are returned only for the best alternative and only with - "! results marked as final. + "! range of 0.0 to 1.0, for example: + "! `[["hello",0.95],["world",0.866]]`. Confidence scores are + "! returned only for the best alternative and only with results marked as final. WORD_CONFIDENCE type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_SPCH_RECOGNITION_ALTERNATIVE. types: - "! Detailed timing information about the service's processing of the input audio. + "!

+ "! Detailed timing information about the service's

+ "! processing of the input audio. begin of T_PROCESSED_AUDIO, "! The seconds of audio that the service has received as of this response. The "! value of the field is greater than the values of the `transcription` and @@ -174,11 +188,13 @@ public section. SPEAKER_LABELS type FLOAT, end of T_PROCESSED_AUDIO. types: - "! 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. + "!

+ "! 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. begin of T_PROCESSING_METRICS, - "! Detailed timing information about the service's processing of the input audio. + "! Detailed timing information about the service's processing of the input + "! audio. PROCESSED_AUDIO type T_PROCESSED_AUDIO, "! The amount of real time in seconds that has passed since the service received "! the first byte of input audio. Values in this field are generally multiples of @@ -202,7 +218,9 @@ public section. PERIODIC type BOOLEAN, end of T_PROCESSING_METRICS. types: - "! Detailed information about the signal characteristics of the input audio. + "!

+ "! Detailed information about the signal characteristics of the

+ "! input audio. begin of T_AUDIO_METRICS_DETAILS, "! If `true`, indicates the end of the audio stream, meaning that transcription is "! complete. Currently, the field is always `true`. The service returns metrics @@ -251,8 +269,9 @@ public section. NON_SPEECH_LEVEL type STANDARD TABLE OF T_AUDIO_METRICS_HISTOGRAM_BIN WITH NON-UNIQUE DEFAULT KEY, end of T_AUDIO_METRICS_DETAILS. types: - "! If audio metrics are requested, information about the signal characteristics of - "! the input audio. + "!

+ "! If audio metrics are requested, information about the signal

+ "! characteristics of the input audio. begin of T_AUDIO_METRICS, "! The interval in seconds (typically 0.1 seconds) at which the service calculated "! the audio metrics. In other words, how often the service calculated the @@ -263,7 +282,8 @@ public section. ACCUMULATED type T_AUDIO_METRICS_DETAILS, end of T_AUDIO_METRICS. types: - "! Component results for a speech recognition request. + "!

+ "! 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 @@ -296,7 +316,8 @@ public section. END_OF_UTTERANCE type STRING, end of T_SPEECH_RECOGNITION_RESULT. types: - "! The complete results for a speech recognition request. + "!

+ "! The complete results for a speech recognition request.

begin of T_SPEECH_RECOGNITION_RESULTS, "! An array of `SpeechRecognitionResult` objects that can include interim and final "! results (interim results are returned only if supported by the method). Final @@ -315,31 +336,33 @@ public section. "! requested for methods that support them, it is possible for a "! `SpeechRecognitionResults` object to include only the `speaker_labels` field. SPEAKER_LABELS type STANDARD TABLE OF T_SPEAKER_LABELS_RESULT WITH NON-UNIQUE DEFAULT KEY, - "! 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. + "! 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. PROCESSING_METRICS type T_PROCESSING_METRICS, "! If audio metrics are requested, information about the signal characteristics of "! the input audio. AUDIO_METRICS type T_AUDIO_METRICS, "! An array of warning messages associated with the request:
"! * Warnings for invalid parameters or fields can include a descriptive message - "! and a list of invalid argument strings, for example, `"Unknown arguments:"` or - "! `"Unknown url query arguments:"` followed by a list of the form - "! `"{invalid_arg_1}, {invalid_arg_2}."`
+ "! and a list of invalid argument strings, for example, `"Unknown + "! arguments:"` or `"Unknown url query arguments:"` followed by a + "! list of the form `"{invalid_arg_1}, + "! {invalid_arg_2}."`
"! * The following warning is returned if the request passes a custom model that is "! based on an older version of a base model for which an updated version is - "! available: `"Using previous version of base model, because your custom model - "! has been built with it. Please note that this version will be supported only - "! for a limited time. Consider updating your custom model to the new base model. - "! If you do not do that you will be automatically switched to base model when you - "! used the non-updated custom model."`
+ "! available: `"Using previous version of base model, because your custom + "! model has been built with it. Please note that this version will be supported + "! only for a limited time. Consider updating your custom model to the new base + "! model. If you do not do that you will be automatically switched to base model + "! when you used the non-updated custom model."`
"!
"! In both cases, the request succeeds despite the warnings. WARNINGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_SPEECH_RECOGNITION_RESULTS. types: - "! Information about a grammar from a custom language model. + "!

+ "! Information about a grammar from a custom language model.

begin of T_GRAMMAR, "! The name of the grammar. NAME type STRING, @@ -355,19 +378,23 @@ public section. "! The `error` field describes the failure. STATUS type STRING, "! If the status of the grammar is `undetermined`, the following message: `Analysis - "! of grammar '{grammar_name}' failed. Please try fixing the error or - "! adding the grammar again by setting the 'allow_overwrite' flag to 'true'.`. + "! of grammar '{grammar_name}' failed. Please try fixing the + "! error or adding the grammar again by setting the 'allow_overwrite' + "! flag to 'true'.`. ERROR type STRING, end of T_GRAMMAR. types: - "! Information about the grammars from a custom language model. + "!

+ "! Information about the grammars from a custom language model.

begin of T_GRAMMARS, "! An array of `Grammar` objects that provides information about the grammars for "! the custom model. The array is empty if the custom model has no grammars. GRAMMARS type STANDARD TABLE OF T_GRAMMAR WITH NON-UNIQUE DEFAULT KEY, end of T_GRAMMARS. types: - "! Information about a current asynchronous speech recognition job. + "!

+ "! Information about a current asynchronous speech recognition

+ "! job. begin of T_RECOGNITION_JOB, "! The ID of the asynchronous job. ID type STRING, @@ -404,20 +431,25 @@ public section. RESULTS type STANDARD TABLE OF T_SPEECH_RECOGNITION_RESULTS WITH NON-UNIQUE DEFAULT KEY, "! An array of warning messages about invalid parameters included with the request. "! Each warning includes a descriptive message and a list of invalid argument - "! strings, for example, `"unexpected query parameter 'user_token', query - "! parameter 'callback_url' was not specified"`. The request succeeds despite the - "! warnings. This field can be returned only by the **Create a job** method. + "! strings, for example, `"unexpected query parameter 'user_token', + "! query parameter 'callback_url' was not specified"`. The request + "! succeeds despite the warnings. This field can be returned only by the **Create + "! a job** method. WARNINGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_RECOGNITION_JOB. types: - "! Information about current asynchronous speech recognition jobs. + "!

+ "! Information about current asynchronous speech recognition

+ "! jobs. begin of T_RECOGNITION_JOBS, "! An array of `RecognitionJob` objects that provides the status for each of the - "! user's current jobs. The array is empty if the user has no current jobs. + "! user's current jobs. The array is empty if the user has no current jobs. RECOGNITIONS type STANDARD TABLE OF T_RECOGNITION_JOB WITH NON-UNIQUE DEFAULT KEY, end of T_RECOGNITION_JOBS. types: - "! Information about an audio resource from a custom acoustic model. + "!

+ "! Information about an audio resource from a custom acoustic

+ "! model. begin of T_AUDIO_DETAILS, "! The type of the audio resource:
"! * `audio` for an individual audio file
@@ -428,20 +460,21 @@ public section. "! JPEG file). TYPE type STRING, "! **For an audio-type resource,** the codec in which the audio is encoded. Omitted - "! ** for an archive-type resource. + "! for an archive-type resource. CODEC type STRING, "! **For an audio-type resource,** the sampling rate of the audio in Hertz (samples - "! ** per second). Omitted for an archive-type resource. + "! per second). Omitted for an archive-type resource. FREQUENCY type INTEGER, "! **For an archive-type resource,** the format of the compressed archive:
- "! *** `zip` for a **.zip** file
- "! *** `gzip` for a **.tar.gz** file
- "! **
- "! **Omitted for an audio-type resource. + "! * `zip` for a **.zip** file
+ "! * `gzip` for a **.tar.gz** file
+ "!
+ "! Omitted for an audio-type resource. COMPRESSION type STRING, end of T_AUDIO_DETAILS. types: - "! The error response from a failed request. + "!

+ "! The error response from a failed request.

begin of T_ERROR_MODEL, "! Description of the problem. ERROR type STRING, @@ -453,15 +486,17 @@ public section. WARNINGS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_ERROR_MODEL. types: - "! Information about an audio resource from a custom acoustic model. + "!

+ "! Information about an audio resource from a custom acoustic

+ "! model. begin of T_AUDIO_RESOURCE, "! The total seconds of audio in the audio resource. DURATION type INTEGER, "! **For an archive-type resource,** the user-specified name of the resource.
- "! **
- "! ****For an audio-type resource,** the user-specified name of the resource or the - "! ** name of the audio file that the user added for the resource. The value depends - "! ** on the method that is called. + "!
+ "! **For an audio-type resource,** the user-specified name of the resource or the + "! name of the audio file that the user added for the resource. The value depends + "! on the method that is called. NAME type STRING, "! An `AudioDetails` object that provides detailed information about the audio "! resource. The object is empty until the service finishes processing the audio. @@ -479,55 +514,61 @@ public section. STATUS type STRING, end of T_AUDIO_RESOURCE. types: - "! Information about an audio resource from a custom acoustic model. + "!

+ "! Information about an audio resource from a custom acoustic

+ "! model. begin of T_AUDIO_LISTING, "! **For an audio-type resource,** the total seconds of audio in the resource. - "! ** Omitted for an archive-type resource. + "! Omitted for an archive-type resource. DURATION type INTEGER, "! **For an audio-type resource,** the user-specified name of the resource. Omitted - "! ** for an archive-type resource. + "! for an archive-type resource. NAME type STRING, "! **For an audio-type resource,** an `AudioDetails` object that provides detailed - "! ** information about the resource. The object is empty until the service finishes - "! ** processing the audio. Omitted for an archive-type resource. + "! information about the resource. The object is empty until the service finishes + "! processing the audio. Omitted for an archive-type resource. DETAILS type T_AUDIO_DETAILS, "! **For an audio-type resource,** the status of the resource:
- "! *** `ok`: The service successfully analyzed the audio data. The data can be used - "! ** to train the custom model.
- "! *** `being_processed`: The service is still analyzing the audio data. The service - "! ** cannot accept requests to add new audio resources or to train the custom model - "! ** until its analysis is complete.
- "! *** `invalid`: The audio data is not valid for training the custom model (possibly - "! ** because it has the wrong format or sampling rate, or because it is corrupted). - "! **
- "! **
- "! **Omitted for an archive-type resource. + "! * `ok`: The service successfully analyzed the audio data. The data can be used + "! to train the custom model.
+ "! * `being_processed`: The service is still analyzing the audio data. The service + "! cannot accept requests to add new audio resources or to train the custom model + "! until its analysis is complete.
+ "! * `invalid`: The audio data is not valid for training the custom model (possibly + "! because it has the wrong format or sampling rate, or because it is corrupted). + "!
+ "!
+ "! Omitted for an archive-type resource. STATUS type STRING, - "! **For an archive-type resource,** an object of type `AudioResource` that provides - "! ** information about the resource. Omitted for an audio-type resource. + "! **For an archive-type resource,** an object of type `AudioResource` that + "! provides information about the resource. Omitted for an audio-type resource. CONTAINER type T_AUDIO_RESOURCE, "! **For an archive-type resource,** an array of `AudioResource` objects that - "! ** provides information about the audio-type resources that are contained in the - "! ** resource. Omitted for an audio-type resource. + "! provides information about the audio-type resources that are contained in the + "! resource. Omitted for an audio-type resource. AUDIO type STANDARD TABLE OF T_AUDIO_RESOURCE WITH NON-UNIQUE DEFAULT KEY, end of T_AUDIO_LISTING. types: - "! An error associated with a word from a custom language model. + "!

+ "! An error associated with a word from a custom language

+ "! model. begin of T_WORD_ERROR, "! A key-value pair that describes an error associated with the definition of a - "! word in the words resource. The pair has the format `"element": "message"`, - "! where `element` is the aspect of the definition that caused the problem and - "! `message` describes the problem. The following example describes a problem with - "! one of the word's sounds-like definitions: `"{sounds_like_string}": - "! "Numbers are not allowed in sounds-like. You can try for example - "! '{suggested_string}'."`. + "! word in the words resource. The pair has the format `"element": + "! "message"`, where `element` is the aspect of the definition that + "! caused the problem and `message` describes the problem. The following example + "! describes a problem with one of the word's sounds-like definitions: + "! `"{sounds_like_string}": "Numbers are not allowed in + "! sounds-like. You can try for example + "! '{suggested_string}'."`. ELEMENT type STRING, end of T_WORD_ERROR. types: - "! Information about a word from a custom language model. + "!

+ "! Information about a word from a custom language model.

begin of T_WORD, - "! A word from the custom model's words resource. The spelling of the word is used - "! to train the model. + "! A word from the custom model's words resource. The spelling of the word is + "! used to train the model. WORD type STRING, "! An array of pronunciations for the word. The array can include the sounds-like "! pronunciation automatically generated by the service if none is provided for @@ -545,26 +586,29 @@ public section. "! later modified, the count reflects only the number of times it is found in "! corpora. COUNT type INTEGER, - "! An array of sources that describes how the word was added to the custom model's - "! words resource. For OOV words added from a corpus, includes the name of the - "! corpus; if the word was added by multiple corpora, the names of all corpora are - "! listed. If the word was modified or added by the user directly, the field - "! includes the string `user`. + "! An array of sources that describes how the word was added to the custom + "! model's words resource. For OOV words added from a corpus, includes the + "! name of the corpus; if the word was added by multiple corpora, the names of all + "! corpora are listed. If the word was modified or added by the user directly, the + "! field includes the string `user`. SOURCE type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, "! If the service discovered one or more problems that you need to correct for the - "! word's definition, an array that describes each of the errors. + "! word's definition, an array that describes each of the errors. ERROR type STANDARD TABLE OF T_WORD_ERROR WITH NON-UNIQUE DEFAULT KEY, end of T_WORD. types: - "! Information about the words from a custom language model. + "!

+ "! Information about the words from a custom language model.

begin of T_WORDS, "! An array of `Word` objects that provides information about each word in the - "! custom model's words resource. The array is empty if the custom model has no - "! words. + "! custom model's words resource. The array is empty if the custom model has + "! no words. WORDS type STANDARD TABLE OF T_WORD WITH NON-UNIQUE DEFAULT KEY, end of T_WORDS. types: - "! Information about a word that is to be added to a custom language model. + "!

+ "! Information about a word that is to be added to a custom

+ "! language model. begin of T_CUSTOM_WORD, "! For the **Add custom words** method, you must specify the custom word that is to "! be added to or updated in the custom model. Do not include spaces in the word. @@ -576,10 +620,10 @@ public section. "! An array of sounds-like pronunciations for the custom word. Specify how words "! that are difficult to pronounce, foreign words, acronyms, and so on can be "! pronounced by users.
- "! * For a word that is not in the service's base vocabulary, omit the parameter to - "! have the service automatically generate a sounds-like pronunciation for the - "! word.
- "! * For a word that is in the service's base vocabulary, use the parameter to + "! * For a word that is not in the service's base vocabulary, omit the + "! parameter to have the service automatically generate a sounds-like + "! pronunciation for the word.
+ "! * For a word that is in the service's base vocabulary, use the parameter to "! specify additional pronunciations for the word. You cannot override the default "! pronunciation of a word; pronunciations you add augment the pronunciation from "! the base vocabulary.
@@ -593,7 +637,9 @@ public section. DISPLAY_AS type STRING, end of T_CUSTOM_WORD. types: - "! Information about the audio resources from a custom acoustic model. + "!

+ "! Information about the audio resources from a custom acoustic

+ "! model. begin of T_AUDIO_RESOURCES, "! The total minutes of accumulated audio summed over all of the valid audio "! resources for the custom acoustic model. You can use this value to determine @@ -605,7 +651,8 @@ public section. AUDIO type STANDARD TABLE OF T_AUDIO_RESOURCE WITH NON-UNIQUE DEFAULT KEY, end of T_AUDIO_RESOURCES. types: - "! Information about a corpus from a custom language model. + "!

+ "! Information about a corpus from a custom language model.

begin of T_CORPUS, "! The name of the corpus. NAME type STRING, @@ -624,19 +671,21 @@ public section. "! The `error` field describes the failure. STATUS type STRING, "! If the status of the corpus is `undetermined`, the following message: `Analysis - "! of corpus 'name' failed. Please try adding the corpus again by setting the - "! 'allow_overwrite' flag to 'true'`. + "! of corpus 'name' failed. Please try adding the corpus again by + "! setting the 'allow_overwrite' flag to 'true'`. ERROR type STRING, end of T_CORPUS. types: - "! Information about the corpora from a custom language model. + "!

+ "! Information about the corpora from a custom language model.

begin of T_CORPORA, "! An array of `Corpus` objects that provides information about the corpora for the "! custom model. The array is empty if the custom model has no corpora. CORPORA type STANDARD TABLE OF T_CORPUS WITH NON-UNIQUE DEFAULT KEY, end of T_CORPORA. types: - "! Information about an existing custom language model. + "!

+ "! 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 @@ -689,10 +738,10 @@ public section. "! * `upgrading`: The model is currently being upgraded.
"! * `failed`: Training of the model failed. STATUS type STRING, - "! A percentage that indicates the progress of the custom language model's current - "! training. A value of `100` means that the model is fully trained. **Note:** The - "! `progress` field does not currently reflect the progress of the training. The - "! field changes from `0` to `100` when training is complete. + "! A percentage that indicates the progress of the custom language model's + "! current training. A value of `100` means that the model is fully trained. + "! **Note:** The `progress` field does not currently reflect the progress of the + "! training. The field changes from `0` to `100` when training is complete. PROGRESS type INTEGER, "! If an error occurred while adding a grammar file to the custom language model, a "! message that describes an `Internal Server Error` and includes the string @@ -700,12 +749,13 @@ public section. "! error, but the grammar cannot be used with the model. ERROR type STRING, "! If the request included unknown parameters, the following message: `Unexpected - "! query parameter(s) ['parameters'] detected`, where `parameters` is a list that - "! includes a quoted string for each unknown parameter. + "! query parameter(s) ['parameters'] detected`, where `parameters` is a + "! list that includes a quoted string for each unknown parameter. WARNINGS type STRING, end of T_LANGUAGE_MODEL. types: - "! Information about existing custom language models. + "!

+ "! Information about existing custom language models.

begin of T_LANGUAGE_MODELS, "! An array of `LanguageModel` objects that provides information about each "! available custom language model. The array is empty if the requesting @@ -714,7 +764,8 @@ public section. CUSTOMIZATIONS type STANDARD TABLE OF T_LANGUAGE_MODEL WITH NON-UNIQUE DEFAULT KEY, end of T_LANGUAGE_MODELS. types: - "! Information about an existing custom acoustic model. + "!

+ "! 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 @@ -756,18 +807,19 @@ public section. "! * `upgrading`: The model is currently being upgraded.
"! * `failed`: Training of the model failed. STATUS type STRING, - "! A percentage that indicates the progress of the custom acoustic model's current - "! training. A value of `100` means that the model is fully trained. **Note:** The - "! `progress` field does not currently reflect the progress of the training. The - "! field changes from `0` to `100` when training is complete. + "! A percentage that indicates the progress of the custom acoustic model's + "! current training. A value of `100` means that the model is fully trained. + "! **Note:** The `progress` field does not currently reflect the progress of the + "! training. The field changes from `0` to `100` when training is complete. PROGRESS type INTEGER, "! If the request included unknown parameters, the following message: `Unexpected - "! query parameter(s) ['parameters'] detected`, where `parameters` is a list that - "! includes a quoted string for each unknown parameter. + "! query parameter(s) ['parameters'] detected`, where `parameters` is a + "! list that includes a quoted string for each unknown parameter. WARNINGS type STRING, end of T_ACOUSTIC_MODEL. types: - "! Information about existing custom acoustic models. + "!

+ "! Information about existing custom acoustic models.

begin of T_ACOUSTIC_MODELS, "! An array of `AcousticModel` objects that provides information about each "! available custom acoustic model. The array is empty if the requesting @@ -776,7 +828,7 @@ public section. CUSTOMIZATIONS type STANDARD TABLE OF T_ACOUSTIC_MODEL WITH NON-UNIQUE DEFAULT KEY, end of T_ACOUSTIC_MODELS. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT, "! A plain text file that contains the training data for the corpus. Encode the "! file in UTF-8 if it contains non-ASCII characters; the service assumes UTF-8 @@ -785,15 +837,17 @@ public section. "! Make sure that you know the character encoding of the file. You must use that "! encoding when working with the words in the custom language model. For more "! information, see [Character - "! encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-corporaWords#charEncoding).
+ "! encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + "! aWords#charEncoding).
"!
"! With the `curl` command, use the `--data-binary` option to upload the file for "! the request. CORPUS_FILE type FILE, end of T_INLINE_OBJECT. types: - "! Additional service features that are supported with the model. + "!

+ "! Additional service features that 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. @@ -803,7 +857,8 @@ public section. SPEAKER_LABELS type BOOLEAN, end of T_SUPPORTED_FEATURES. types: - "! Information about the new custom 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 @@ -817,8 +872,8 @@ public section. "! To determine whether a base model supports language model customization, use the "! **Get a model** method and check that the attribute `custom_language_model` is "! set to `true`. You can also refer to [Language support for - "! customization](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech- - "! to-text-customization#languageSupport). + "! customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-c + "! ustomization#languageSupport). BASE_MODEL_NAME type STRING, "! The dialect of the specified language that is to be used with the custom "! language model. For most languages, the dialect matches the language of the @@ -846,7 +901,8 @@ public section. DESCRIPTION type STRING, end of T_CREATE_LANGUAGE_MODEL. types: - "! Information about an available language model. + "!

+ "! Information about an available language model.

begin of T_SPEECH_MODEL, "! The name of the model for use as an identifier in calls to the service (for "! example, `en-US_BroadbandModel`). @@ -864,14 +920,16 @@ public section. DESCRIPTION type STRING, end of T_SPEECH_MODEL. types: - "! Information about the available language models. + "!

+ "! Information about the available language models.

begin of T_SPEECH_MODELS, "! An array of `SpeechModel` objects that provides information about each available "! model. MODELS type STANDARD TABLE OF T_SPEECH_MODEL WITH NON-UNIQUE DEFAULT KEY, end of T_SPEECH_MODELS. types: - "! Information about the new custom acoustic model. + "!

+ "! 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 @@ -885,22 +943,26 @@ public section. "!
"! To determine whether a base model supports acoustic model customization, refer "! to [Language support for - "! customization](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech- - "! to-text-customization#languageSupport). + "! customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-c + "! ustomization#languageSupport). BASE_MODEL_NAME type STRING, "! A description of the new custom acoustic model. Use a localized description that "! matches the language of the custom model. DESCRIPTION type STRING, end of T_CREATE_ACOUSTIC_MODEL. types: - "! Information about the words that are to be added to a custom language model. + "!

+ "! Information about the words that are to be added to a custom

+ "! language model. begin of T_CUSTOM_WORDS, "! An array of `CustomWord` objects that provides information about each custom "! word that is to be added to or updated in the custom language model. WORDS type STANDARD TABLE OF T_CUSTOM_WORD WITH NON-UNIQUE DEFAULT KEY, end of T_CUSTOM_WORDS. types: - "! Information about a match for a keyword from speech recognition results. + "!

+ "! Information about a match for a keyword from speech

+ "! recognition results. begin of T_KEYWORD_RESULT, "! A specified keyword normalized to the spoken phrase that matched in the audio "! input. @@ -913,11 +975,13 @@ public section. CONFIDENCE type DOUBLE, end of T_KEYWORD_RESULT. types: - "! The empty response from a request. + "!

+ "! The empty response from a request.

T_EMPTY_RESPONSE_BODY type JSONOBJECT. types: - "! Information about a request to register a callback for asynchronous speech - "! recognition. + "!

+ "! Information about a request to register a callback for

+ "! asynchronous speech recognition. begin of T_REGISTER_STATUS, "! The current status of the job:
"! * `created`: The service successfully white-listed the callback URL as a result @@ -929,6 +993,7 @@ public section. end of T_REGISTER_STATUS. constants: + "!

List of required fields per type.

begin of C_REQUIRED_FIELDS, T_TRAINING_WARNING type string value '|CODE|MESSAGE|', T_TRAINING_RESPONSE type string value '|', @@ -975,6 +1040,7 @@ constants: end of C_REQUIRED_FIELDS . constants: + "!

Map ABAP identifiers to service identifiers.

begin of C_ABAPNAME_DICTIONARY, RECOGNITIONS type string value 'recognitions', ID type string value 'id', @@ -1080,7 +1146,14 @@ constants: redefinition . - "! List models. + "!

List models

+ "! Lists all language models that are available for use with the service. The + "! information includes the name of the model and its minimum sampling rate in + "! Hertz, among other things.
+ "!
+ "! **See also:** [Languages and + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + "! odels). "! "! @parameter E_RESPONSE | "! Service return value of type T_SPEECH_MODELS @@ -1093,7 +1166,14 @@ constants: !E_RESPONSE type T_SPEECH_MODELS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a model. + "!

Get a model

+ "! Gets information for a single specified language model that is available for use + "! with the service. The information includes the name of the model and its + "! minimum sampling rate in Hertz, among other things.
+ "!
+ "! **See also:** [Languages and + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + "! odels). "! "! @parameter I_MODEL_ID | "! The identifier of the model in the form of its name from the output of the **Get @@ -1111,7 +1191,103 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Recognize audio. + "!

Recognize audio

+ "! Sends audio and returns transcription results for a recognition request. You can + "! pass a maximum of 100 MB and a minimum of 100 bytes of audio with a request. + "! The service automatically detects the endianness of the incoming audio and, for + "! audio that includes multiple channels, downmixes the audio to one-channel mono + "! during transcoding. The method returns only final results; to enable interim + "! results, use the WebSocket API. (With the `curl` command, use the + "! `--data-binary` option to upload the file for the request.)
+ "!
+ "! **See also:** [Making a basic HTTP + "! request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HT + "! TP-basic).
+ "!
+ "! ### Streaming mode
+ "!
+ "! For requests to transcribe live audio as it becomes available, you must set the + "! `Transfer-Encoding` header to `chunked` to use streaming mode. In streaming + "! mode, the service closes the connection (status code 408) if it does not + "! receive at least 15 seconds of audio (including silence) in any 30-second + "! period. The service also closes the connection (status code 400) if it detects + "! no speech for `inactivity_timeout` seconds of streaming audio; use the + "! `inactivity_timeout` parameter to change the default of 30 seconds.
+ "!
+ "! **See also:**
+ "! * [Audio + "! transmission](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-in + "! put#transmission)
+ "! * + "! [Timeouts](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + "! #timeouts)
+ "!
+ "! ### Audio formats (content types)
+ "!
+ "! The service accepts audio in the following formats (MIME types).
+ "! * For formats that are labeled **Required**, you must use the `Content-Type` + "! header with the request to specify the format of the audio.
+ "! * For all other formats, you can omit the `Content-Type` header or specify + "! `application/octet-stream` with the header to have the service automatically + "! detect the format of the audio. (With the `curl` command, you can specify + "! either `"Content-Type:"` or `"Content-Type: + "! application/octet-stream"`.)
+ "!
+ "! Where indicated, the format that you specify must include the sampling rate and + "! can optionally include the number of channels and the endianness of the + "! audio.
+ "! * `audio/alaw` (**Required.** Specify the sampling rate (`rate`) of the + "! audio.)
+ "! * `audio/basic` (**Required.** Use only with narrowband models.)
+ "! * `audio/flac`
+ "! * `audio/g729` (Use only with narrowband models.)
+ "! * `audio/l16` (**Required.** Specify the sampling rate (`rate`) and optionally + "! the number of channels (`channels`) and endianness (`endianness`) of the + "! audio.)
+ "! * `audio/mp3`
+ "! * `audio/mpeg`
+ "! * `audio/mulaw` (**Required.** Specify the sampling rate (`rate`) of the + "! audio.)
+ "! * `audio/ogg` (The service automatically detects the codec of the input + "! audio.)
+ "! * `audio/ogg;codecs=opus`
+ "! * `audio/ogg;codecs=vorbis`
+ "! * `audio/wav` (Provide audio with a maximum of nine channels.)
+ "! * `audio/webm` (The service automatically detects the codec of the input + "! audio.)
+ "! * `audio/webm;codecs=opus`
+ "! * `audio/webm;codecs=vorbis`
+ "!
+ "! The sampling rate of the audio must match the sampling rate of the model for the + "! recognition request: for broadband models, at least 16 kHz; for narrowband + "! models, at least 8 kHz. If the sampling rate of the audio is higher than the + "! minimum required rate, the service down-samples the audio to the appropriate + "! rate. If the sampling rate of the audio is lower than the minimum required + "! rate, the request fails.
+ "!
+ "! **See also:** [Audio + "! formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-f + "! ormats#audio-formats).
+ "!
+ "! ### Multipart speech recognition
+ "!
+ "! **Note:** The Watson SDKs do not support multipart speech recognition.
+ "!
+ "! The HTTP `POST` method of the service also supports multipart speech + "! recognition. With multipart requests, you pass all audio data as multipart form + "! data. You specify some parameters as request headers and query parameters, but + "! you pass JSON metadata as form data to control most aspects of the + "! transcription. You can use multipart recognition to pass multiple audio files + "! with a single request.
+ "!
+ "! Use the multipart approach with browsers for which JavaScript is disabled or + "! when the parameters used with the request are greater than the 8 KB limit + "! imposed by most HTTP servers and proxies. You can encounter this limit, for + "! example, if you want to spot a very large number of keywords.
+ "!
+ "! **See also:** [Making a multipart HTTP + "! request](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-http#HT + "! TP-multi). "! "! @parameter I_AUDIO | "! The audio to transcribe. @@ -1121,16 +1297,16 @@ constants: "! @parameter I_MODEL | "! The identifier of the model that is to be used for the recognition request. See "! [Languages and - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -models#models). + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + "! odels). "! @parameter I_LANGUAGE_CUSTOMIZATION_ID | "! The customization ID (GUID) of a custom language model that is to be used with "! the recognition request. The base model of the specified custom language model "! must match the model specified with the `model` parameter. You must make the "! request with credentials for the instance of the service that owns the custom "! model. By default, no custom language model is used. See [Custom - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -input#custom-input).
+ "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + "! stom-input).
"!
"! **Note:** Use this parameter instead of the deprecated `customization_id` "! parameter. @@ -1140,8 +1316,8 @@ constants: "! must match the model specified with the `model` parameter. You must make the "! request with credentials for the instance of the service that owns the custom "! model. By default, no custom acoustic model is used. See [Custom - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -input#custom-input). + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + "! stom-input). "! @parameter I_BASE_MODEL_VERSION | "! The version of the specified base model that is to be used with the recognition "! request. Multiple versions of a base model can exist when a model is updated @@ -1149,8 +1325,8 @@ constants: "! custom models that have been upgraded for a new base model. The default value "! depends on whether the parameter is used with or without a custom model. See "! [Base model - "! version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-input#version). + "! version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#v + "! ersion). "! @parameter I_CUSTOMIZATION_WEIGHT | "! If you specify the customization ID (GUID) of a custom language model with the "! recognition request, the customization weight tells the service how much weight @@ -1165,19 +1341,19 @@ constants: "! The default value yields the best performance in general. Assign a higher value "! if your audio makes frequent use of OOV words from the custom model. Use "! caution when setting the weight: a higher value can improve the accuracy of - "! phrases from the custom model's domain, but it can negatively affect + "! phrases from the custom model's domain, but it can negatively affect "! performance on non-domain phrases.
"!
"! See [Custom - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -input#custom-input). + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + "! stom-input). "! @parameter I_INACTIVITY_TIMEOUT | "! The time in seconds after which, if only silence (no speech) is detected in "! streaming audio, the connection is closed with a 400 error. The parameter is "! useful for stopping audio submission from a live microphone when a user simply "! walks away. Use `-1` for infinity. See [Inactivity - "! timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-input#timeouts-inactivity). + "! timeout](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#t + "! imeouts-inactivity). "! @parameter I_KEYWORDS | "! An array of keyword strings to spot in the audio. Each keyword string can "! include one or more string tokens. Keywords are spotted only in the final @@ -1185,48 +1361,48 @@ constants: "! specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the "! parameter or specify an empty array if you do not need to spot keywords. See "! [Keyword - "! spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-output#keyword_spotting). + "! spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + "! #keyword_spotting). "! @parameter I_KEYWORDS_THRESHOLD | "! A confidence value that is the lower bound for spotting a keyword. A word is "! considered to match a keyword if its confidence is greater than or equal to the "! threshold. Specify a probability between 0.0 and 1.0. If you specify a "! threshold, you must also specify one or more keywords. The service performs no "! keyword spotting if you omit either parameter. See [Keyword - "! spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-output#keyword_spotting). + "! spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + "! #keyword_spotting). "! @parameter I_MAX_ALTERNATIVES | "! The maximum number of alternative transcripts that the service is to return. By "! default, the service returns a single transcript. If you specify a value of "! `0`, the service uses the default value, `1`. See [Maximum - "! alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - "! o-text-output#max_alternatives). + "! alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + "! tput#max_alternatives). "! @parameter I_WORD_ALTERNATIVES_THRESHOLD | "! A confidence value that is the lower bound for identifying a hypothesis as a - "! possible word alternative (also known as "Confusion Networks"). An alternative - "! word is considered if its confidence is greater than or equal to the threshold. - "! Specify a probability between 0.0 and 1.0. By default, the service computes no - "! alternative words. See [Word - "! alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - "! o-text-output#word_alternatives). + "! possible word alternative (also known as "Confusion Networks"). An + "! alternative word is considered if its confidence is greater than or equal to + "! the threshold. Specify a probability between 0.0 and 1.0. By default, the + "! service computes no alternative words. See [Word + "! alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + "! tput#word_alternatives). "! @parameter I_WORD_CONFIDENCE | "! If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 "! for each word. By default, the service returns no word confidence scores. See "! [Word - "! confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - "! text-output#word_confidence). + "! confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + "! ut#word_confidence). "! @parameter I_TIMESTAMPS | "! If `true`, the service returns time alignment for each word. By default, no "! timestamps are returned. See [Word - "! timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - "! text-output#word_timestamps). + "! timestamps](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + "! ut#word_timestamps). "! @parameter I_PROFANITY_FILTER | "! If `true`, the service filters profanity from all output except for keyword "! results by replacing inappropriate words with a series of asterisks. Set the "! parameter to `false` to return results with no censoring. Applies to US English "! transcription only. See [Profanity - "! filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - "! ext-output#profanity_filter). + "! filtering](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + "! t#profanity_filter). "! @parameter I_SMART_FORMATTING | "! If `true`, the service converts dates, times, series of digits and numbers, "! phone numbers, currency values, and internet addresses into more readable, @@ -1238,8 +1414,8 @@ constants: "! **Note:** Applies to US English, Japanese, and Spanish transcription only.
"!
"! See [Smart - "! formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - "! text-output#smart_formatting). + "! formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + "! ut#smart_formatting). "! @parameter I_SPEAKER_LABELS | "! If `true`, the response includes labels that identify which words were spoken by "! which participants in a multi-person exchange. By default, the service returns @@ -1254,21 +1430,21 @@ constants: "! to `true`.
"!
"! See [Speaker - "! labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -output#speaker_labels). + "! labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#s + "! peaker_labels). "! @parameter I_CUSTOMIZATION_ID | "! **Deprecated.** Use the `language_customization_id` parameter to specify the - "! ** customization ID (GUID) of a custom language model that is to be used with the - "! ** recognition request. Do not specify both parameters with a request. + "! customization ID (GUID) of a custom language model that is to be used with the + "! recognition request. Do not specify both parameters with a request. "! @parameter I_GRAMMAR_NAME | "! The name of a grammar that is to be used with the recognition request. If you "! specify a grammar, you must also use the `language_customization_id` parameter "! to specify the name of the custom language model for which the grammar is "! defined. The service recognizes only strings that are recognized by the - "! specified grammar; it does not recognize other custom words from the model's - "! words resource. See - "! [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - "! ext-input#grammars-input). + "! specified grammar; it does not recognize other custom words from the + "! model's words resource. See + "! [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + "! #grammars-input). "! @parameter I_REDACTION | "! If `true`, the service redacts, or masks, numeric data from final transcripts. "! The feature redacts any number that has three or more consecutive digits by @@ -1285,16 +1461,16 @@ constants: "! **Note:** Applies to US English, Japanese, and Korean transcription only.
"!
"! See [Numeric - "! redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - "! ext-output#redaction). + "! redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + "! t#redaction). "! @parameter I_AUDIO_METRICS | "! If `true`, requests detailed information about the signal characteristics of the "! input audio. The service returns audio metrics with the final transcription "! results. By default, the service returns no audio metrics.
"!
"! See [Audio - "! metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-metrics#audio_metrics). + "! metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + "! #audio_metrics). "! @parameter I_END_OF_PHRASE_SILENCE_TIME | "! If `true`, specifies the duration of the pause interval at which the service "! splits a transcript into multiple final results. If the service detects pauses @@ -1312,8 +1488,8 @@ constants: "! Chinese is 0.6 seconds.
"!
"! See [End of phrase silence - "! time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-o - "! utput#silence_time). + "! time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#sil + "! ence_time). "! @parameter I_SPLT_TRNSCRPT_AT_PHRASE_END | "! If `true`, directs the service to split the transcript into multiple final "! results based on semantic features of the input, for example, at the conclusion @@ -1324,8 +1500,8 @@ constants: "! solely on the pause interval.
"!
"! See [Split transcript at phrase - "! end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-ou - "! tput#split_transcript). + "! end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#spli + "! t_transcript). "! @parameter E_RESPONSE | "! Service return value of type T_SPEECH_RECOGNITION_RESULTS "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. @@ -1361,7 +1537,43 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Register a callback. + "!

Register a callback

+ "! Registers a callback URL with the service for use with subsequent asynchronous + "! recognition requests. The service attempts to register, or white-list, the + "! callback URL if it is not already registered by sending a `GET` request to the + "! callback URL. The service passes a random alphanumeric challenge string via the + "! `challenge_string` parameter of the request. The request includes an `Accept` + "! header that specifies `text/plain` as the required response type.
+ "!
+ "! To be registered successfully, the callback URL must respond to the `GET` + "! request from the service. The response must send status code 200 and must + "! include the challenge string in its body. Set the `Content-Type` response + "! header to `text/plain`. Upon receiving this response, the service responds to + "! the original registration request with response code 201.
+ "!
+ "! The service sends only a single `GET` request to the callback URL. If the + "! service does not receive a reply with a response code of 200 and a body that + "! echoes the challenge string sent by the service within five seconds, it does + "! not white-list the URL; it instead sends status code 400 in response to the + "! **Register a callback** request. If the requested callback URL is already + "! white-listed, the service responds to the initial registration request with + "! response code 200.
+ "!
+ "! If you specify a user secret with the request, the service uses it as a key to + "! calculate an HMAC-SHA1 signature of the challenge string in its response to the + "! `POST` request. It sends this signature in the `X-Callback-Signature` header of + "! its `GET` request to the URL during registration. It also uses the secret to + "! calculate a signature over the payload of every callback notification that uses + "! the URL. The signature provides authentication and data integrity for HTTP + "! communications.
+ "!
+ "! After you successfully register a callback URL, you can use it with an + "! indefinite number of recognition requests. You can register a maximum of 20 + "! callback URLS in a one-hour span of time.
+ "!
+ "! **See also:** [Registering a callback + "! URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#regis + "! ter). "! "! @parameter I_CALLBACK_URL | "! An HTTP or HTTPS URL to which callback notifications are to be sent. To be @@ -1388,7 +1600,14 @@ constants: !E_RESPONSE type T_REGISTER_STATUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Unregister a callback. + "!

Unregister a callback

+ "! Unregisters a callback URL that was previously white-listed 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.
+ "!
+ "! **See also:** [Unregistering a callback + "! URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#unreg + "! ister). "! "! @parameter I_CALLBACK_URL | "! The callback URL that is to be unregistered. @@ -1399,7 +1618,112 @@ constants: !I_CALLBACK_URL type STRING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a job. + "!

Create a job

+ "! Creates a job for a new asynchronous recognition request. The job is owned by + "! the instance of the service whose credentials are used to create it. How you + "! learn the status and results of a job depends on the parameters you include + "! with the job creation request:
+ "! * By callback notification: Include the `callback_url` parameter to specify a + "! URL to which the service is to send callback notifications when the status of + "! the job changes. Optionally, you can also include the `events` and `user_token` + "! parameters to subscribe to specific events and to specify a string that is to + "! be included with each notification for the job.
+ "! * By polling the service: Omit the `callback_url`, `events`, and `user_token` + "! parameters. You must then use the **Check jobs** or **Check a job** methods to + "! check the status of the job, using the latter to retrieve the results when the + "! job is complete.
+ "!
+ "! The two approaches are not mutually exclusive. You can poll the service for job + "! status or obtain results from the service manually even if you include a + "! callback URL. In both cases, you can include the `results_ttl` parameter to + "! specify how long the results are to remain available after the job is complete. + "! Using the HTTPS **Check a job** method to retrieve results is more secure than + "! receiving them via callback notification over HTTP because it provides + "! confidentiality in addition to authentication and data integrity.
+ "!
+ "! The method supports the same basic parameters as other HTTP and WebSocket + "! recognition requests. It also supports the following parameters specific to the + "! asynchronous interface:
+ "! * `callback_url`
+ "! * `events`
+ "! * `user_token`
+ "! * `results_ttl`
+ "!
+ "! You can pass a maximum of 1 GB and a minimum of 100 bytes of audio with a + "! request. The service automatically detects the endianness of the incoming audio + "! and, for audio that includes multiple channels, downmixes the audio to + "! one-channel mono during transcoding. The method returns only final results; to + "! enable interim results, use the WebSocket API. (With the `curl` command, use + "! the `--data-binary` option to upload the file for the request.)
+ "!
+ "! **See also:** [Creating a + "! job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#creat + "! e).
+ "!
+ "! ### Streaming mode
+ "!
+ "! For requests to transcribe live audio as it becomes available, you must set the + "! `Transfer-Encoding` header to `chunked` to use streaming mode. In streaming + "! mode, the service closes the connection (status code 408) if it does not + "! receive at least 15 seconds of audio (including silence) in any 30-second + "! period. The service also closes the connection (status code 400) if it detects + "! no speech for `inactivity_timeout` seconds of streaming audio; use the + "! `inactivity_timeout` parameter to change the default of 30 seconds.
+ "!
+ "! **See also:**
+ "! * [Audio + "! transmission](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-in + "! put#transmission)
+ "! * + "! [Timeouts](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + "! #timeouts)
+ "!
+ "! ### Audio formats (content types)
+ "!
+ "! The service accepts audio in the following formats (MIME types).
+ "! * For formats that are labeled **Required**, you must use the `Content-Type` + "! header with the request to specify the format of the audio.
+ "! * For all other formats, you can omit the `Content-Type` header or specify + "! `application/octet-stream` with the header to have the service automatically + "! detect the format of the audio. (With the `curl` command, you can specify + "! either `"Content-Type:"` or `"Content-Type: + "! application/octet-stream"`.)
+ "!
+ "! Where indicated, the format that you specify must include the sampling rate and + "! can optionally include the number of channels and the endianness of the + "! audio.
+ "! * `audio/alaw` (**Required.** Specify the sampling rate (`rate`) of the + "! audio.)
+ "! * `audio/basic` (**Required.** Use only with narrowband models.)
+ "! * `audio/flac`
+ "! * `audio/g729` (Use only with narrowband models.)
+ "! * `audio/l16` (**Required.** Specify the sampling rate (`rate`) and optionally + "! the number of channels (`channels`) and endianness (`endianness`) of the + "! audio.)
+ "! * `audio/mp3`
+ "! * `audio/mpeg`
+ "! * `audio/mulaw` (**Required.** Specify the sampling rate (`rate`) of the + "! audio.)
+ "! * `audio/ogg` (The service automatically detects the codec of the input + "! audio.)
+ "! * `audio/ogg;codecs=opus`
+ "! * `audio/ogg;codecs=vorbis`
+ "! * `audio/wav` (Provide audio with a maximum of nine channels.)
+ "! * `audio/webm` (The service automatically detects the codec of the input + "! audio.)
+ "! * `audio/webm;codecs=opus`
+ "! * `audio/webm;codecs=vorbis`
+ "!
+ "! The sampling rate of the audio must match the sampling rate of the model for the + "! recognition request: for broadband models, at least 16 kHz; for narrowband + "! models, at least 8 kHz. If the sampling rate of the audio is higher than the + "! minimum required rate, the service down-samples the audio to the appropriate + "! rate. If the sampling rate of the audio is lower than the minimum required + "! rate, the request fails.
+ "!
+ "! **See also:** [Audio + "! formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-f + "! ormats#audio-formats). "! "! @parameter I_AUDIO | "! The audio to transcribe. @@ -1409,8 +1733,8 @@ constants: "! @parameter I_MODEL | "! The identifier of the model that is to be used for the recognition request. See "! [Languages and - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -models#models). + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models#m + "! odels). "! @parameter I_CALLBACK_URL | "! A URL to which callback notifications are to be sent. The URL must already be "! successfully white-listed by using the **Register a callback** method. You can @@ -1455,8 +1779,8 @@ constants: "! must match the model specified with the `model` parameter. You must make the "! request with credentials for the instance of the service that owns the custom "! model. By default, no custom language model is used. See [Custom - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -input#custom-input).
+ "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + "! stom-input).
"!
"! **Note:** Use this parameter instead of the deprecated `customization_id` "! parameter. @@ -1466,8 +1790,8 @@ constants: "! must match the model specified with the `model` parameter. You must make the "! request with credentials for the instance of the service that owns the custom "! model. By default, no custom acoustic model is used. See [Custom - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -input#custom-input). + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + "! stom-input). "! @parameter I_BASE_MODEL_VERSION | "! The version of the specified base model that is to be used with the recognition "! request. Multiple versions of a base model can exist when a model is updated @@ -1475,8 +1799,8 @@ constants: "! custom models that have been upgraded for a new base model. The default value "! depends on whether the parameter is used with or without a custom model. See "! [Base model - "! version](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-input#version). + "! version](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#v + "! ersion). "! @parameter I_CUSTOMIZATION_WEIGHT | "! If you specify the customization ID (GUID) of a custom language model with the "! recognition request, the customization weight tells the service how much weight @@ -1491,19 +1815,19 @@ constants: "! The default value yields the best performance in general. Assign a higher value "! if your audio makes frequent use of OOV words from the custom model. Use "! caution when setting the weight: a higher value can improve the accuracy of - "! phrases from the custom model's domain, but it can negatively affect + "! phrases from the custom model's domain, but it can negatively affect "! performance on non-domain phrases.
"!
"! See [Custom - "! models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -input#custom-input). + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#cu + "! stom-input). "! @parameter I_INACTIVITY_TIMEOUT | "! The time in seconds after which, if only silence (no speech) is detected in "! streaming audio, the connection is closed with a 400 error. The parameter is "! useful for stopping audio submission from a live microphone when a user simply "! walks away. Use `-1` for infinity. See [Inactivity - "! timeout](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-input#timeouts-inactivity). + "! timeout](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input#t + "! imeouts-inactivity). "! @parameter I_KEYWORDS | "! An array of keyword strings to spot in the audio. Each keyword string can "! include one or more string tokens. Keywords are spotted only in the final @@ -1511,48 +1835,48 @@ constants: "! specify a keywords threshold. You can spot a maximum of 1000 keywords. Omit the "! parameter or specify an empty array if you do not need to spot keywords. See "! [Keyword - "! spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-output#keyword_spotting). + "! spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + "! #keyword_spotting). "! @parameter I_KEYWORDS_THRESHOLD | "! A confidence value that is the lower bound for spotting a keyword. A word is "! considered to match a keyword if its confidence is greater than or equal to the "! threshold. Specify a probability between 0.0 and 1.0. If you specify a "! threshold, you must also specify one or more keywords. The service performs no "! keyword spotting if you omit either parameter. See [Keyword - "! spotting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-output#keyword_spotting). + "! spotting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output + "! #keyword_spotting). "! @parameter I_MAX_ALTERNATIVES | "! The maximum number of alternative transcripts that the service is to return. By "! default, the service returns a single transcript. If you specify a value of "! `0`, the service uses the default value, `1`. See [Maximum - "! alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - "! o-text-output#max_alternatives). + "! alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + "! tput#max_alternatives). "! @parameter I_WORD_ALTERNATIVES_THRESHOLD | "! A confidence value that is the lower bound for identifying a hypothesis as a - "! possible word alternative (also known as "Confusion Networks"). An alternative - "! word is considered if its confidence is greater than or equal to the threshold. - "! Specify a probability between 0.0 and 1.0. By default, the service computes no - "! alternative words. See [Word - "! alternatives](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-t - "! o-text-output#word_alternatives). + "! possible word alternative (also known as "Confusion Networks"). An + "! alternative word is considered if its confidence is greater than or equal to + "! the threshold. Specify a probability between 0.0 and 1.0. By default, the + "! service computes no alternative words. See [Word + "! alternatives](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-ou + "! tput#word_alternatives). "! @parameter I_WORD_CONFIDENCE | "! If `true`, the service returns a confidence measure in the range of 0.0 to 1.0 "! for each word. By default, the service returns no word confidence scores. See "! [Word - "! confidence](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - "! text-output#word_confidence). + "! confidence](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + "! ut#word_confidence). "! @parameter I_TIMESTAMPS | "! If `true`, the service returns time alignment for each word. By default, no "! timestamps are returned. See [Word - "! timestamps](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - "! text-output#word_timestamps). + "! timestamps](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + "! ut#word_timestamps). "! @parameter I_PROFANITY_FILTER | "! If `true`, the service filters profanity from all output except for keyword "! results by replacing inappropriate words with a series of asterisks. Set the "! parameter to `false` to return results with no censoring. Applies to US English "! transcription only. See [Profanity - "! filtering](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - "! ext-output#profanity_filter). + "! filtering](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + "! t#profanity_filter). "! @parameter I_SMART_FORMATTING | "! If `true`, the service converts dates, times, series of digits and numbers, "! phone numbers, currency values, and internet addresses into more readable, @@ -1564,8 +1888,8 @@ constants: "! **Note:** Applies to US English, Japanese, and Spanish transcription only.
"!
"! See [Smart - "! formatting](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to- - "! text-output#smart_formatting). + "! formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outp + "! ut#smart_formatting). "! @parameter I_SPEAKER_LABELS | "! If `true`, the response includes labels that identify which words were spoken by "! which participants in a multi-person exchange. By default, the service returns @@ -1580,21 +1904,21 @@ constants: "! to `true`.
"!
"! See [Speaker - "! labels](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text - "! -output#speaker_labels). + "! labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#s + "! peaker_labels). "! @parameter I_CUSTOMIZATION_ID | "! **Deprecated.** Use the `language_customization_id` parameter to specify the - "! ** customization ID (GUID) of a custom language model that is to be used with the - "! ** recognition request. Do not specify both parameters with a request. + "! customization ID (GUID) of a custom language model that is to be used with the + "! recognition request. Do not specify both parameters with a request. "! @parameter I_GRAMMAR_NAME | "! The name of a grammar that is to be used with the recognition request. If you "! specify a grammar, you must also use the `language_customization_id` parameter "! to specify the name of the custom language model for which the grammar is "! defined. The service recognizes only strings that are recognized by the - "! specified grammar; it does not recognize other custom words from the model's - "! words resource. See - "! [Grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - "! ext-input#grammars-input). + "! specified grammar; it does not recognize other custom words from the + "! model's words resource. See + "! [Grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-input + "! #grammars-input). "! @parameter I_REDACTION | "! If `true`, the service redacts, or masks, numeric data from final transcripts. "! The feature redacts any number that has three or more consecutive digits by @@ -1611,18 +1935,18 @@ constants: "! **Note:** Applies to US English, Japanese, and Korean transcription only.
"!
"! See [Numeric - "! redaction](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-t - "! ext-output#redaction). + "! redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-outpu + "! t#redaction). "! @parameter I_PROCESSING_METRICS | - "! If `true`, requests processing metrics about the service's transcription of the - "! input audio. The service returns processing metrics at the interval specified - "! by the `processing_metrics_interval` parameter. It also returns processing - "! metrics for transcription events, for example, for final and interim results. - "! By default, the service returns no processing metrics.
+ "! If `true`, requests processing metrics about the service's transcription of + "! the input audio. The service returns processing metrics at the interval + "! specified by the `processing_metrics_interval` parameter. It also returns + "! processing metrics for transcription events, for example, for final and interim + "! results. By default, the service returns no processing metrics.
"!
"! See [Processing - "! metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-metrics#processing_metrics). + "! metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + "! #processing_metrics). "! @parameter I_PROCESSING_METRICS_INTERVAL | "! Specifies the interval in real wall-clock seconds at which the service is to "! return processing metrics. The parameter is ignored unless the @@ -1637,16 +1961,16 @@ constants: "! the service returns processing metrics only for transcription events.
"!
"! See [Processing - "! metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-metrics#processing_metrics). + "! metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + "! #processing_metrics). "! @parameter I_AUDIO_METRICS | "! If `true`, requests detailed information about the signal characteristics of the "! input audio. The service returns audio metrics with the final transcription "! results. By default, the service returns no audio metrics.
"!
"! See [Audio - "! metrics](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-tex - "! t-metrics#audio_metrics). + "! metrics](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-metrics + "! #audio_metrics). "! @parameter I_END_OF_PHRASE_SILENCE_TIME | "! If `true`, specifies the duration of the pause interval at which the service "! splits a transcript into multiple final results. If the service detects pauses @@ -1664,8 +1988,8 @@ constants: "! Chinese is 0.6 seconds.
"!
"! See [End of phrase silence - "! time](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-o - "! utput#silence_time). + "! time](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#sil + "! ence_time). "! @parameter I_SPLT_TRNSCRPT_AT_PHRASE_END | "! If `true`, directs the service to split the transcript into multiple final "! results based on semantic features of the input, for example, at the conclusion @@ -1676,8 +2000,8 @@ constants: "! solely on the pause interval.
"!
"! See [Split transcript at phrase - "! end](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-ou - "! tput#split_transcript). + "! end](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-output#spli + "! t_transcript). "! @parameter E_RESPONSE | "! Service return value of type T_RECOGNITION_JOB "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. @@ -1718,7 +2042,19 @@ constants: !E_RESPONSE type T_RECOGNITION_JOB raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Check jobs. + "!

Check jobs

+ "! Returns the ID and status of the latest 100 outstanding jobs associated with the + "! credentials with which it is called. The method also returns the creation and + "! update times of each job, and, if a job was created with a callback URL and a + "! user token, the user token for the job. To obtain the results for a job whose + "! status is `completed` or not one of the latest 100 outstanding jobs, use the + "! **Check a job** method. A job and its results remain available until you delete + "! them with the **Delete a job** method or until the job's time to live + "! expires, whichever comes first.
+ "!
+ "! **See also:** [Checking the status of the latest + "! jobs](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#jobs + "! ). "! "! @parameter E_RESPONSE | "! Service return value of type T_RECOGNITION_JOBS @@ -1731,7 +2067,23 @@ constants: !E_RESPONSE type T_RECOGNITION_JOBS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Check a job. + "!

Check a job

+ "! Returns information about the specified job. The response always includes the + "! status of the job and its creation and update times. If the status is + "! `completed`, the response includes the results of the recognition request. You + "! must use credentials for the instance of the service that owns a job to list + "! information about it.
+ "!
+ "! You can use the method to retrieve the results of any job, regardless of whether + "! it was submitted with a callback URL and the + "! `recognitions.completed_with_results` event, and you can retrieve the results + "! multiple times for as long as they remain available. Use the **Check jobs** + "! method to request information about the most recent jobs associated with the + "! calling credentials.
+ "!
+ "! **See also:** [Checking the status and retrieving the results of a + "! job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#job). + "! "! "! @parameter I_ID | "! The identifier of the asynchronous job that is to be used for the request. You @@ -1749,7 +2101,16 @@ constants: !E_RESPONSE type T_RECOGNITION_JOB raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a job. + "!

Delete a job

+ "! Deletes the specified job. You cannot delete a job that the service is actively + "! processing. Once you delete a job, its results are no longer available. The + "! service automatically deletes a job and its results when the time to live for + "! the results expires. You must use credentials for the instance of the service + "! that owns a job to delete it.
+ "!
+ "! **See also:** [Deleting a + "! job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#delet + "! e-async). "! "! @parameter I_ID | "! The identifier of the asynchronous job that is to be used for the request. You @@ -1763,7 +2124,20 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a custom language model. + "!

Create a custom language model

+ "! Creates a new custom language model for a specified base model. The custom + "! language model can be used only with the base model for which it is created. + "! The model is owned by the instance of the service whose credentials are used to + "! create it.
+ "!
+ "! You can create a maximum of 1024 custom language models per owning credentials. + "! The service returns an error if you attempt to create more than 1024 models. + "! You do not lose any models, but you cannot create any more until your model + "! count is below the limit.
+ "!
+ "! **See also:** [Create a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + "! reate#createModel-language). "! "! @parameter I_CREATE_LANGUAGE_MODEL | "! A `CreateLanguageModel` object that provides basic information about the new @@ -1781,7 +2155,16 @@ constants: !E_RESPONSE type T_LANGUAGE_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List custom language models. + "!

List custom language models

+ "! Lists information about all custom language models that are owned by an instance + "! of the service. Use the `language` parameter to see all custom language models + "! for the specified language. Omit the parameter to see all custom language + "! models for all languages. You must use credentials for the instance of the + "! service that owns a model to list information about it.
+ "!
+ "! **See also:** [Listing custom language + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLa + "! nguageModels#listModels-language). "! "! @parameter I_LANGUAGE | "! The identifier of the language for which custom language or custom acoustic @@ -1800,7 +2183,14 @@ constants: !E_RESPONSE type T_LANGUAGE_MODELS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a custom language model. + "!

Get a custom language model

+ "! Gets information about a specified custom language model. You must use + "! credentials for the instance of the service that owns a model to list + "! information about it.
+ "!
+ "! **See also:** [Listing custom language + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLa + "! nguageModels#listModels-language). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1818,7 +2208,15 @@ constants: !E_RESPONSE type T_LANGUAGE_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a custom language model. + "!

Delete a custom language model

+ "! Deletes an existing custom language model. The custom model cannot be deleted if + "! another request, such as adding a corpus or grammar to the model, is currently + "! being processed. You must use credentials for the instance of the service that + "! owns a model to delete it.
+ "!
+ "! **See also:** [Deleting a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLan + "! guageModels#deleteModel-language). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1832,15 +2230,53 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Train a custom language model. + "!

Train a custom language model

+ "! Initiates the training of a custom language model with new resources such as + "! corpora, grammars, and custom words. After adding, modifying, or deleting + "! resources for a custom language model, use this method to begin the actual + "! training of the model on the latest data. You can specify whether the custom + "! language model is to be trained with all words from its words resource or only + "! with words that were added or modified by the user directly. You must use + "! credentials for the instance of the service that owns a model to train it. + "!
+ "!
+ "! The training method is asynchronous. It can take on the order of minutes to + "! complete depending on the amount of data on which the service is being trained + "! and the current load on the service. The method returns an HTTP 200 response + "! code to indicate that the training process has begun.
+ "!
+ "! You can monitor the status of the training by using the **Get a custom language + "! model** method to poll the model's status. Use a loop to check the status + "! every 10 seconds. The method returns a `LanguageModel` object that includes + "! `status` and `progress` fields. A status of `available` means that the custom + "! model is trained and ready to use. The service cannot accept subsequent + "! training requests or requests to add new resources until the existing request + "! completes.
+ "!
+ "! **See also:** [Train the custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + "! reate#trainModel-language).
+ "!
+ "! ### Training failures
+ "!
+ "! Training can fail to start for the following reasons:
+ "! * The service is currently handling another request for the custom model, such + "! as another training request or a request to add a corpus or grammar to the + "! model.
+ "! * No training data have been added to the custom model.
+ "! * The custom model contains one or more invalid corpora, grammars, or words (for + "! example, a custom word has an invalid sounds-like pronunciation). You can + "! correct the invalid resources or set the `strict` parameter to `false` to + "! exclude the invalid resources from the training. The model must contain at + "! least one valid resource for training to succeed. "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for "! the request. You must make the request with credentials for the instance of the "! service that owns the custom model. "! @parameter I_WORD_TYPE_TO_ADD | - "! The type of words from the custom language model's words resource on which to - "! train the model:
+ "! The type of words from the custom language model's words resource on which + "! to train the model:
"! * `all` (the default) trains the model on all new words, regardless of whether "! they were extracted from corpora or grammars or were added or modified by the "! user.
@@ -1856,7 +2292,7 @@ constants: "! The default value yields the best performance in general. Assign a higher value "! if your audio makes frequent use of OOV words from the custom model. Use "! caution when setting the weight: a higher value can improve the accuracy of - "! phrases from the custom model's domain, but it can negatively affect + "! phrases from the custom model's domain, but it can negatively affect "! performance on non-domain phrases.
"!
"! The value that you assign is used for all recognition requests that use the @@ -1876,7 +2312,17 @@ constants: !E_RESPONSE type T_TRAINING_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Reset a custom language model. + "!

Reset a custom language model

+ "! Resets a custom language model by removing all corpora, grammars, and words from + "! the model. Resetting a custom language model initializes the model to its state + "! when it was first created. Metadata such as the name and language of the model + "! are preserved, but the model's words resource is removed and must be + "! re-created. You must use credentials for the instance of the service that owns + "! a model to reset it.
+ "!
+ "! **See also:** [Resetting a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageLan + "! guageModels#resetModel-language). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1890,7 +2336,27 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Upgrade a custom language model. + "!

Upgrade a custom language model

+ "! Initiates the upgrade of a custom language model to the latest version of its + "! base language model. The upgrade method is asynchronous. It can take on the + "! order of minutes to complete depending on the amount of data in the custom + "! model and the current load on the service. A custom model must be in the + "! `ready` or `available` state to be upgraded. You must use credentials for the + "! instance of the service that owns a model to upgrade it.
+ "!
+ "! The method returns an HTTP 200 response code to indicate that the upgrade + "! process has begun successfully. You can monitor the status of the upgrade by + "! using the **Get a custom language model** method to poll the model's + "! status. The method returns a `LanguageModel` object that includes `status` and + "! `progress` fields. Use a loop to check the status every 10 seconds. While it is + "! being upgraded, the custom model has the status `upgrading`. When the upgrade + "! is complete, the model resumes the status that it had prior to upgrade. The + "! service cannot accept subsequent requests for the model until the upgrade + "! completes.
+ "!
+ "! **See also:** [Upgrading a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpg + "! rade#upgradeLanguage). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1905,7 +2371,15 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List corpora. + "!

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.
+ "!
+ "! **See also:** [Listing corpora for a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCor + "! pora#listCorpora). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1923,7 +2397,57 @@ constants: !E_RESPONSE type T_CORPORA raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add a corpus. + "!

Add a corpus

+ "! Adds a single corpus text file of new training data to a custom language model. + "! Use multiple requests to submit multiple corpus text files. You must use + "! credentials for the instance of the service that owns a model to add a corpus + "! to it. Adding a corpus does not affect the custom language model until you + "! train the model for the new data by using the **Train a custom language model** + "! method.
+ "!
+ "! Submit a plain text file that contains sample sentences from the domain of + "! interest to enable the service to extract words in context. The more sentences + "! you add that represent the context in which speakers use words from the domain, + "! the better the service's recognition accuracy.
+ "!
+ "! The call returns an HTTP 201 response code if the corpus is valid. The service + "! then asynchronously processes the contents of the corpus and automatically + "! extracts new words that it finds. This can take on the order of a minute or two + "! to complete depending on the total number of words and the number of new words + "! in the corpus, as well as the current load on the service. You cannot submit + "! requests to add additional resources to the custom model or to train the model + "! until the service's analysis of the corpus for the current request + "! completes. Use the **List a corpus** method to check the status of the + "! analysis.
+ "!
+ "! The service auto-populates the model's words resource with words from the + "! corpus that are not found in its base vocabulary. These are referred to as + "! out-of-vocabulary (OOV) words. You can use the **List custom words** method to + "! examine the words resource. You can use other words method to eliminate typos + "! and modify how words are pronounced as needed.
+ "!
+ "! To add a corpus file that has the same name as an existing corpus, set the + "! `allow_overwrite` parameter to `true`; otherwise, the request fails. + "! Overwriting an existing corpus causes the service to process the corpus text + "! file and extract OOV words anew. Before doing so, it removes any OOV words + "! associated with the existing corpus from the model's words resource unless + "! they were also added by another corpus or grammar, or they have been modified + "! in some way with the **Add custom words** or **Add a custom word** method. + "!
+ "!
+ "! The service limits the overall amount of data that you can add to a custom model + "! to a maximum of 10 million total words from all sources combined. Also, you can + "! add no more than 90 thousand custom (OOV) words to a model. This includes words + "! that the service extracts from corpora and grammars, and words that you add + "! directly.
+ "!
+ "! **See also:**
+ "! * [Working with + "! corpora](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpora + "! Words#workingCorpora)
+ "! * [Add a corpus to the custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + "! reate#addCorpus) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1953,8 +2477,8 @@ constants: "! Make sure that you know the character encoding of the file. You must use that "! encoding when working with the words in the custom language model. For more "! information, see [Character - "! encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-corporaWords#charEncoding).
+ "! encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + "! aWords#charEncoding).
"!
"! With the `curl` command, use the `--data-binary` option to upload the file for "! the request. @@ -1976,7 +2500,15 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a corpus. + "!

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.
+ "!
+ "! **See also:** [Listing corpora for a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCor + "! pora#listCorpora). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -1997,7 +2529,19 @@ constants: !E_RESPONSE type T_CORPUS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a corpus. + "!

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.
+ "!
+ "! **See also:** [Deleting a corpus from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCor + "! pora#deleteCorpus). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2015,14 +2559,26 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List custom words. + "!

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.
+ "!
+ "! **See also:** [Listing words from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWor + "! ds#listWords). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for "! the request. You must make the request with credentials for the instance of the "! service that owns the custom model. "! @parameter I_WORD_TYPE | - "! The type of words to be listed from the custom language model's words + "! The type of words to be listed from the custom language model's words "! resource:
"! * `all` (the default) shows all words.
"! * `user` shows only custom words that were added or modified by the user @@ -2052,7 +2608,67 @@ constants: !E_RESPONSE type T_WORDS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add custom 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.
+ "!
+ "! You must use credentials for the instance of the service that owns a model to + "! add or modify custom words for the model. Adding or modifying custom words does + "! not affect the custom model until you train the model for the new data by using + "! the **Train a custom language model** method.
+ "!
+ "! You add custom words by providing a `CustomWords` object, which is an array of + "! `CustomWord` objects, one per word. You must use the object's `word` + "! parameter to identify the word that is to be added. You can also provide one or + "! both of the optional `sounds_like` and `display_as` fields for each word.
+ "! * The `sounds_like` field provides an array of one or more pronunciations for + "! the word. Use the parameter to specify how the word can be pronounced by users. + "! Use the parameter for words that are difficult to pronounce, foreign words, + "! acronyms, and so on. For example, you might specify that the word `IEEE` can + "! sound like `i triple e`. You can specify a maximum of five sounds-like + "! pronunciations for a word.
+ "! * The `display_as` field provides a different way of spelling the word in a + "! transcript. Use the parameter when you want the word to appear different from + "! its usual representation or from its spelling in training data. For example, + "! you might indicate that the word `IBM(trademark)` is to be displayed as + "! `IBM™`.
+ "!
+ "! If you add a custom word that already exists in the words resource for the + "! custom model, the new definition overwrites the existing data for the word. If + "! the service encounters an error with the input data, it returns a failure code + "! and does not add any of the words to the words resource.
+ "!
+ "! The call returns an HTTP 201 response code if the input data is valid. It then + "! asynchronously processes the words to add them to the model's words + "! resource. The time that it takes for the analysis to complete depends on the + "! number of new words that you add but is generally faster than adding a corpus + "! or grammar.
+ "!
+ "! You can monitor the status of the request by using the **List a custom language + "! model** method to poll the model's status. Use a loop to check the status + "! every 10 seconds. The method returns a `Customization` object that includes a + "! `status` field. A status of `ready` means that the words have been added to the + "! custom model. The service cannot accept requests to add new data or to train + "! the model until the existing request completes.
+ "!
+ "! You can use the **List custom words** or **List a custom word** method to review + "! the words that you add. Words with an invalid `sounds_like` field include an + "! `error` field that describes the problem. You can use other words-related + "! methods to correct errors, eliminate typos, and modify how words are pronounced + "! as needed.
+ "!
+ "! **See also:**
+ "! * [Working with custom + "! words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWo + "! rds#workingWords)
+ "! * [Add words to the custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + "! reate#addWords) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2071,7 +2687,48 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add a custom word. + "!

Add a custom word

+ "! Adds a custom word 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 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.
+ "!
+ "! You must use credentials for the instance of the service that owns a model to + "! add or modify a custom word for the model. Adding or modifying a custom word + "! does not affect the custom model until you train the model for the new data by + "! using the **Train a custom language model** method.
+ "!
+ "! Use the `word_name` parameter to specify the custom word that is to be added or + "! modified. Use the `CustomWord` object to provide one or both of the optional + "! `sounds_like` and `display_as` fields for the word.
+ "! * The `sounds_like` field provides an array of one or more pronunciations for + "! the word. Use the parameter to specify how the word can be pronounced by users. + "! Use the parameter for words that are difficult to pronounce, foreign words, + "! acronyms, and so on. For example, you might specify that the word `IEEE` can + "! sound like `i triple e`. You can specify a maximum of five sounds-like + "! pronunciations for a word.
+ "! * The `display_as` field provides a different way of spelling the word in a + "! transcript. Use the parameter when you want the word to appear different from + "! its usual representation or from its spelling in training data. For example, + "! you might indicate that the word `IBM(trademark)` is to be displayed as + "! `IBM™`.
+ "!
+ "! If you add a custom word that already exists in the words resource for the + "! custom model, the new definition overwrites the existing data for the word. If + "! the service encounters an error, it does not add the word to the words + "! resource. Use the **List a custom word** method to review the word that you + "! add.
+ "!
+ "! **See also:**
+ "! * [Working with custom + "! words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWo + "! rds#workingWords)
+ "! * [Add words to the custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageC + "! reate#addWords) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2082,8 +2739,8 @@ constants: "! Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to "! connect the tokens of compound words. URL-encode the word if it includes "! non-ASCII characters. For more information, see [Character - "! encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-corporaWords#charEncoding). + "! encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + "! aWords#charEncoding). "! @parameter I_CUSTOM_WORD | "! A `CustomWord` object that provides information about the specified custom word. "! Specify an empty object to add a word with no sounds-like or display-as @@ -2099,7 +2756,14 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a custom word. + "!

Get a custom word

+ "! Gets information about a custom word from a custom language model. You must use + "! credentials for the instance of the service that owns a model to list + "! information about its words.
+ "!
+ "! **See also:** [Listing words from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWor + "! ds#listWords). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2109,8 +2773,8 @@ constants: "! The custom word that is to be read from the custom language model. URL-encode "! the word if it includes non-ASCII characters. For more information, see "! [Character - "! encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-corporaWords#charEncoding). + "! encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + "! aWords#charEncoding). "! @parameter E_RESPONSE | "! Service return value of type T_WORD "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. @@ -2124,7 +2788,19 @@ constants: !E_RESPONSE type T_WORD raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a custom word. + "!

Delete a custom word

+ "! Deletes a custom word from a custom language model. You can remove any word that + "! you added to the custom model's words resource via any means. However, if + "! the word also exists in the service's base vocabulary, the service removes + "! only the custom pronunciation for the word; the word remains in the base + "! vocabulary. Removing a custom word 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 + "! words.
+ "!
+ "! **See also:** [Deleting a word from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWor + "! ds#deleteWord). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2134,8 +2810,8 @@ constants: "! The custom word that is to be deleted from the custom language model. URL-encode "! the word if it includes non-ASCII characters. For more information, see "! [Character - "! encoding](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-te - "! xt-corporaWords#charEncoding). + "! encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corpor + "! aWords#charEncoding). "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! methods DELETE_WORD @@ -2146,7 +2822,15 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List grammars. + "!

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.
+ "!
+ "! **See also:** [Listing grammars from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGra + "! mmars#listGrammars). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2164,7 +2848,51 @@ constants: !E_RESPONSE type T_GRAMMARS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add a grammar. + "!

Add a grammar

+ "! Adds a single grammar file to a custom language model. Submit a plain text file + "! in UTF-8 format that defines the grammar. Use multiple requests to submit + "! multiple grammar files. You must use credentials for the instance of the + "! service that owns a model to add a grammar to it. Adding a grammar does not + "! affect the custom language model until you train the model for the new data by + "! using the **Train a custom language model** method.
+ "!
+ "! The call returns an HTTP 201 response code if the grammar is valid. The service + "! then asynchronously processes the contents of the grammar and automatically + "! extracts new words that it finds. This can take a few seconds to complete + "! depending on the size and complexity of the grammar, as well as the current + "! load on the service. You cannot submit requests to add additional resources to + "! the custom model or to train the model until the service's analysis of the + "! grammar for the current request completes. Use the **Get a grammar** method to + "! check the status of the analysis.
+ "!
+ "! The service populates the model's words resource with any word that is + "! recognized by the grammar that is not found in the model's base + "! vocabulary. These are referred to as out-of-vocabulary (OOV) words. You can use + "! the **List custom words** method to examine the words resource and use other + "! words-related methods to eliminate typos and modify how words are pronounced as + "! needed.
+ "!
+ "! To add a grammar that has the same name as an existing grammar, set the + "! `allow_overwrite` parameter to `true`; otherwise, the request fails. + "! Overwriting an existing grammar causes the service to process the grammar file + "! and extract OOV words anew. Before doing so, it removes any OOV words + "! associated with the existing grammar from the model's words resource + "! unless they were also added by another resource or they have been modified in + "! some way with the **Add custom words** or **Add a custom word** method.
+ "!
+ "! The service limits the overall amount of data that you can add to a custom model + "! to a maximum of 10 million total words from all sources combined. Also, you can + "! add no more than 90 thousand OOV words to a model. This includes words that the + "! service extracts from corpora and grammars and words that you add directly. + "!
+ "!
+ "! **See also:**
+ "! * [Understanding + "! grammars](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-gramma + "! rUnderstand#grammarUnderstand)
+ "! * [Add a grammar to the custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-grammarAd + "! d#addGrammar) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2218,7 +2946,15 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a grammar. + "!

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.
+ "!
+ "! **See also:** [Listing grammars from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGra + "! mmars#listGrammars). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2239,7 +2975,19 @@ constants: !E_RESPONSE type T_GRAMMAR raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a grammar. + "!

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.
+ "!
+ "! **See also:** [Deleting a grammar from a custom language + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGra + "! mmars#deleteGrammar). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom language model that is to be used for @@ -2257,7 +3005,20 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a custom acoustic model. + "!

Create a custom acoustic model

+ "! Creates a new custom acoustic model for a specified base model. The custom + "! acoustic model can be used only with the base model for which it is created. + "! The model is owned by the instance of the service whose credentials are used to + "! create it.
+ "!
+ "! You can create a maximum of 1024 custom acoustic models per owning credentials. + "! The service returns an error if you attempt to create more than 1024 models. + "! You do not lose any models, but you cannot create any more until your model + "! count is below the limit.
+ "!
+ "! **See also:** [Create a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic# + "! createModel-acoustic). "! "! @parameter I_CREATE_ACOUSTIC_MODEL | "! A `CreateAcousticModel` object that provides basic information about the new @@ -2275,7 +3036,16 @@ constants: !E_RESPONSE type T_ACOUSTIC_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List custom acoustic models. + "!

List custom acoustic models

+ "! Lists information about all custom acoustic models that are owned by an instance + "! of the service. Use the `language` parameter to see all custom acoustic models + "! for the specified language. Omit the parameter to see all custom acoustic + "! models for all languages. You must use credentials for the instance of the + "! service that owns a model to list information about it.
+ "!
+ "! **See also:** [Listing custom acoustic + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAc + "! ousticModels#listModels-acoustic). "! "! @parameter I_LANGUAGE | "! The identifier of the language for which custom language or custom acoustic @@ -2294,7 +3064,14 @@ constants: !E_RESPONSE type T_ACOUSTIC_MODELS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a custom acoustic model. + "!

Get a custom acoustic model

+ "! Gets information about a specified custom acoustic model. You must use + "! credentials for the instance of the service that owns a model to list + "! information about it.
+ "!
+ "! **See also:** [Listing custom acoustic + "! models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAc + "! ousticModels#listModels-acoustic). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2312,7 +3089,15 @@ constants: !E_RESPONSE type T_ACOUSTIC_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a custom acoustic model. + "!

Delete a custom acoustic model

+ "! Deletes an existing custom acoustic model. The custom model cannot be deleted if + "! another request, such as adding an audio resource to the model, is currently + "! being processed. You must use credentials for the instance of the service that + "! owns a model to delete it.
+ "!
+ "! **See also:** [Deleting a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAco + "! usticModels#deleteModel-acoustic). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2326,7 +3111,63 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Train a custom acoustic model. + "!

Train a custom acoustic model

+ "! Initiates the training of a custom acoustic model with new or changed audio + "! resources. After adding or deleting audio resources for a custom acoustic + "! model, use this method to begin the actual training of the model on the latest + "! audio data. The custom acoustic model does not reflect its changed data until + "! you train it. You must use credentials for the instance of the service that + "! owns a model to train it.
+ "!
+ "! The training method is asynchronous. It can take on the order of minutes or + "! hours to complete depending on the total amount of audio data on which the + "! custom acoustic model is being trained and the current load on the service. + "! Typically, training a custom acoustic model takes approximately two to four + "! times the length of its audio data. The range of time depends on the model + "! being trained and the nature of the audio, such as whether the audio is clean + "! or noisy. The method returns an HTTP 200 response code to indicate that the + "! training process has begun.
+ "!
+ "! You can monitor the status of the training by using the **Get a custom acoustic + "! model** method to poll the model's status. Use a loop to check the status + "! once a minute. The method returns an `AcousticModel` object that includes + "! `status` and `progress` fields. A status of `available` indicates that the + "! custom model is trained and ready to use. The service cannot train a model + "! while it is handling another request for the model. The service cannot accept + "! subsequent training requests, or requests to add new audio resources, until the + "! existing training request completes.
+ "!
+ "! You can use the optional `custom_language_model_id` parameter to specify the + "! GUID of a separately created custom language model that is to be used during + "! training. Train with a custom language model if you have verbatim + "! transcriptions of the audio files that you have added to the custom model or + "! you have either corpora (text files) or a list of words that are relevant to + "! the contents of the audio files. Both of the custom models must be based on the + "! same version of the same base model for training to succeed.
+ "!
+ "! **See also:**
+ "! * [Train the custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic# + "! trainModel-acoustic)
+ "! * [Using custom acoustic and custom language models + "! together](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-useBot + "! h#useBoth)
+ "!
+ "! ### Training failures
+ "!
+ "! Training can fail to start for the following reasons:
+ "! * The service is currently handling another request for the custom model, such + "! as another training request or a request to add audio resources to the + "! model.
+ "! * The custom model contains less than 10 minutes or more than 200 hours of audio + "! data.
+ "! * You passed an incompatible custom language model with the + "! `custom_language_model_id` query parameter. Both custom models must be based on + "! the same version of the same base model.
+ "! * The custom model contains one or more invalid audio resources. You can correct + "! the invalid audio resources or set the `strict` parameter to `false` to exclude + "! the invalid resources from the training. The model must contain at least one + "! valid resource for training to succeed. "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2353,7 +3194,19 @@ constants: !E_RESPONSE type T_TRAINING_RESPONSE raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Reset a custom acoustic model. + "!

Reset a custom acoustic model

+ "! Resets a custom acoustic model by removing all audio resources from the model. + "! Resetting a custom acoustic model initializes the model to its state when it + "! was first created. Metadata such as the name and language of the model are + "! preserved, but the model's audio resources are removed and must be + "! re-created. The service cannot reset a model while it is handling another + "! request for the model. The service cannot accept subsequent requests for the + "! model until the existing reset request completes. You must use credentials for + "! the instance of the service that owns a model to reset it.
+ "!
+ "! **See also:** [Resetting a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAco + "! usticModels#resetModel-acoustic). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2367,7 +3220,37 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Upgrade a custom acoustic model. + "!

Upgrade a custom acoustic model

+ "! Initiates the upgrade of a custom acoustic model to the latest version of its + "! base language model. The upgrade method is asynchronous. It can take on the + "! order of minutes or hours to complete depending on the amount of data in the + "! custom model and the current load on the service; typically, upgrade takes + "! approximately twice the length of the total audio contained in the custom + "! model. A custom model must be in the `ready` or `available` state to be + "! upgraded. You must use credentials for the instance of the service that owns a + "! model to upgrade it.
+ "!
+ "! The method returns an HTTP 200 response code to indicate that the upgrade + "! process has begun successfully. You can monitor the status of the upgrade by + "! using the **Get a custom acoustic model** method to poll the model's + "! status. The method returns an `AcousticModel` object that includes `status` and + "! `progress` fields. Use a loop to check the status once a minute. While it is + "! being upgraded, the custom model has the status `upgrading`. When the upgrade + "! is complete, the model resumes the status that it had prior to upgrade. The + "! service cannot upgrade a model while it is handling another request for the + "! model. The service cannot accept subsequent requests for the model until the + "! existing upgrade request completes.
+ "!
+ "! If the custom acoustic model was trained with a separately created custom + "! language model, you must use the `custom_language_model_id` parameter to + "! specify the GUID of that custom language model. The custom language model must + "! be upgraded before the custom acoustic model can be upgraded. Omit the + "! parameter if the custom acoustic model was not trained with a custom language + "! model.
+ "!
+ "! **See also:** [Upgrading a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpg + "! rade#upgradeAcoustic). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2384,8 +3267,8 @@ constants: "! the upgrade of a custom acoustic model that is trained with a custom language "! model, and only if you receive a 400 response code and the message `No input "! data modified since last training`. See [Upgrading a custom acoustic - "! model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text- - "! customUpgrade#upgradeAcoustic). + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customUpg + "! rade#upgradeAcoustic). "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! methods UPGRADE_ACOUSTIC_MODEL @@ -2397,7 +3280,18 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List audio resources. + "!

List audio resources

+ "! Lists information about all audio resources from a custom acoustic model. The + "! information includes the name of the resource and information about its audio + "! data, such as its duration. It also includes the status of the audio resource, + "! which is important for checking the service's analysis of the resource in + "! response to a request to add it to the custom acoustic model. You must use + "! credentials for the instance of the service that owns a model to list its audio + "! resources.
+ "!
+ "! **See also:** [Listing audio resources for a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAud + "! io#listAudio). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2415,7 +3309,113 @@ constants: !E_RESPONSE type T_AUDIO_RESOURCES raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add an audio resource. + "!

Add an audio resource

+ "! Adds an audio resource to a custom acoustic model. Add audio content that + "! reflects the acoustic characteristics of the audio that you plan to transcribe. + "! You must use credentials for the instance of the service that owns a model to + "! add an audio resource to it. Adding audio data does not affect the custom + "! acoustic model until you train the model for the new data by using the **Train + "! a custom acoustic model** method.
+ "!
+ "! You can add individual audio files or an archive file that contains multiple + "! audio files. Adding multiple audio files via a single archive file is + "! significantly more efficient than adding each file individually. You can add + "! audio resources in any format that the service supports for speech recognition. + "!
+ "!
+ "! You can use this method to add any number of audio resources to a custom model + "! by calling the method once for each audio or archive file. You can add multiple + "! different audio resources at the same time. You must add a minimum of 10 + "! minutes and a maximum of 200 hours of audio that includes speech, not just + "! silence, to a custom acoustic model before you can train it. No audio resource, + "! audio- or archive-type, can be larger than 100 MB. To add an audio resource + "! that has the same name as an existing audio resource, set the `allow_overwrite` + "! parameter to `true`; otherwise, the request fails.
+ "!
+ "! The method is asynchronous. It can take several seconds to complete depending on + "! the duration of the audio and, in the case of an archive file, the total number + "! of audio files being processed. The service returns a 201 response code if the + "! audio is valid. It then asynchronously analyzes the contents of the audio file + "! or files and automatically extracts information about the audio such as its + "! length, sampling rate, and encoding. You cannot submit requests to train or + "! upgrade the model until the service's analysis of all audio resources for + "! current requests completes.
+ "!
+ "! To determine the status of the service's analysis of the audio, use the + "! **Get an audio resource** method to poll the status of the audio. The method + "! accepts the customization ID of the custom model and the name of the audio + "! resource, and it returns the status of the resource. Use a loop to check the + "! status of the audio every few seconds until it becomes `ok`.
+ "!
+ "! **See also:** [Add audio to the custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic# + "! addAudio).
+ "!
+ "! ### Content types for audio-type resources
+ "!
+ "! You can add an individual audio file in any format that the service supports + "! for speech recognition. For an audio-type resource, use the `Content-Type` + "! parameter to specify the audio format (MIME type) of the audio file, including + "! specifying the sampling rate, channels, and endianness where indicated.
+ "! * `audio/alaw` (Specify the sampling rate (`rate`) of the audio.)
+ "! * `audio/basic` (Use only with narrowband models.)
+ "! * `audio/flac`
+ "! * `audio/g729` (Use only with narrowband models.)
+ "! * `audio/l16` (Specify the sampling rate (`rate`) and optionally the number of + "! channels (`channels`) and endianness (`endianness`) of the audio.)
+ "! * `audio/mp3`
+ "! * `audio/mpeg`
+ "! * `audio/mulaw` (Specify the sampling rate (`rate`) of the audio.)
+ "! * `audio/ogg` (The service automatically detects the codec of the input + "! audio.)
+ "! * `audio/ogg;codecs=opus`
+ "! * `audio/ogg;codecs=vorbis`
+ "! * `audio/wav` (Provide audio with a maximum of nine channels.)
+ "! * `audio/webm` (The service automatically detects the codec of the input + "! audio.)
+ "! * `audio/webm;codecs=opus`
+ "! * `audio/webm;codecs=vorbis`
+ "!
+ "! The sampling rate of an audio file must match the sampling rate of the base + "! model for the custom model: for broadband models, at least 16 kHz; for + "! narrowband models, at least 8 kHz. If the sampling rate of the audio is higher + "! than the minimum required rate, the service down-samples the audio to the + "! appropriate rate. If the sampling rate of the audio is lower than the minimum + "! required rate, the service labels the audio file as `invalid`.
+ "!
+ "! **See also:** [Audio + "! formats](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-audio-f + "! ormats#audio-formats).
+ "!
+ "! ### Content types for archive-type resources
+ "!
+ "! You can add an archive file (**.zip** or **.tar.gz** file) that contains audio + "! files in any format that the service supports for speech recognition. For an + "! archive-type resource, use the `Content-Type` parameter to specify the media + "! type of the archive file:
+ "! * `application/zip` for a **.zip** file
+ "! * `application/gzip` for a **.tar.gz** file.
+ "!
+ "! When you add an archive-type resource, the `Contained-Content-Type` header is + "! optional depending on the format of the files that you are adding:
+ "! * For audio files of type `audio/alaw`, `audio/basic`, `audio/l16`, or + "! `audio/mulaw`, you must use the `Contained-Content-Type` header to specify the + "! format of the contained audio files. Include the `rate`, `channels`, and + "! `endianness` parameters where necessary. In this case, all audio files + "! contained in the archive file must have the same audio format.
+ "! * For audio files of all other types, you can omit the `Contained-Content-Type` + "! header. In this case, the audio files contained in the archive file can have + "! any of the formats not listed in the previous bullet. The audio files do not + "! need to have the same format.
+ "!
+ "! Do not use the `Contained-Content-Type` header when adding an audio-type + "! resource.
+ "!
+ "! ### Naming restrictions for embedded audio files
+ "!
+ "! The name of an audio file that is contained in an archive-type resource can + "! include a maximum of 128 characters. This includes the file extension and all + "! elements of the name (for example, slashes). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2449,20 +3449,20 @@ constants: "! description. "! @parameter I_CONTAINED_CONTENT_TYPE | "! **For an archive-type resource,** specify the format of the audio files that are - "! ** contained in the archive file if they are of type `audio/alaw`, `audio/basic`, - "! ** `audio/l16`, or `audio/mulaw`. Include the `rate`, `channels`, and `endianness` - "! ** parameters where necessary. In this case, all audio files that are contained in - "! ** the archive file must be of the indicated type.
- "! **
- "! **For all other audio formats, you can omit the header. In this case, the audio - "! ** files can be of multiple types as long as they are not of the types listed in - "! ** the previous paragraph.
- "! **
- "! **The parameter accepts all of the audio formats that are supported for use with - "! ** speech recognition. For more information, see **Content types for audio-type - "! ** resources** in the method description.
- "! **
- "! ****For an audio-type resource,** omit the header. + "! contained in the archive file if they are of type `audio/alaw`, `audio/basic`, + "! `audio/l16`, or `audio/mulaw`. Include the `rate`, `channels`, and `endianness` + "! parameters where necessary. In this case, all audio files that are contained in + "! the archive file must be of the indicated type.
+ "!
+ "! For all other audio formats, you can omit the header. In this case, the audio + "! files can be of multiple types as long as they are not of the types listed in + "! the previous paragraph.
+ "!
+ "! The parameter accepts all of the audio formats that are supported for use with + "! speech recognition. For more information, see **Content types for audio-type + "! resources** in the method description.
+ "!
+ "! **For an audio-type resource,** omit the header. "! @parameter I_ALLOW_OVERWRITE | "! If `true`, the specified audio resource overwrites an existing audio resource "! with the same name. If `false`, the request fails if an audio resource with the @@ -2481,7 +3481,32 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get an audio resource. + "!

Get an audio resource

+ "! Gets information about an audio resource from a custom acoustic model. The + "! method returns an `AudioListing` object whose fields depend on the type of + "! audio resource that you specify with the method's `audio_name` + "! parameter:
+ "! * **For an audio-type resource,** the object's fields match those of an + "! `AudioResource` object: `duration`, `name`, `details`, and `status`.
+ "! * **For an archive-type resource,** the object includes a `container` field + "! whose fields match those of an `AudioResource` object. It also includes an + "! `audio` field, which contains an array of `AudioResource` objects that provides + "! information about the audio files that are contained in the archive.
+ "!
+ "! The information includes the status of the specified audio resource. The status + "! is important for checking the service's analysis of a resource that you + "! add to the custom model.
+ "! * For an audio-type resource, the `status` field is located in the + "! `AudioListing` object.
+ "! * For an archive-type resource, the `status` field is located in the + "! `AudioResource` object that is returned in the `container` field.
+ "!
+ "! You must use credentials for the instance of the service that owns a model to + "! list its audio resources.
+ "!
+ "! **See also:** [Listing audio resources for a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAud + "! io#listAudio). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2502,7 +3527,21 @@ constants: !E_RESPONSE type T_AUDIO_LISTING raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete an audio resource. + "!

Delete an audio resource

+ "! Deletes an existing audio resource from a custom acoustic model. Deleting an + "! archive-type audio resource removes the entire archive of files. The service + "! does not allow deletion of individual files from an archive resource.
+ "!
+ "! Removing an audio resource does not affect the custom model until you train the + "! model on its updated data by using the **Train a custom acoustic model** + "! method. You can delete an existing audio resource from a model while a + "! different resource is being added to the model. You must use credentials for + "! the instance of the service that owns a model to delete its audio resources. + "!
+ "!
+ "! **See also:** [Deleting an audio resource from a custom acoustic + "! model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAud + "! io#deleteAudio). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom acoustic model that is to be used for @@ -2520,7 +3559,20 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete labeled data. + "!

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 + "! information was added. The method has no effect if no data is associated with + "! the customer ID. You must issue the request with credentials for the same + "! instance of the service that was used to associate the customer ID with the + "! data.
+ "!
+ "! You associate a customer ID with data by passing the `X-Watson-Metadata` header + "! with a request that passes the data.
+ "!
+ "! **See also:** [Information + "! security](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-inform + "! ation-security#information-security). "! "! @parameter I_CUSTOMER_ID | "! The customer ID for which all data is to be deleted. @@ -2609,7 +3661,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092825'. + e_sdk_version_date = '20200310173436'. endmethod. diff --git a/src/zcl_ibmc_speech_to_text_v1.clas.xml b/src/zcl_ibmc_speech_to_text_v1.clas.xml index 090dd66..d36673e 100644 --- a/src/zcl_ibmc_speech_to_text_v1.clas.xml +++ b/src/zcl_ibmc_speech_to_text_v1.clas.xml @@ -5,12 +5,260 @@ ZCL_IBMC_SPEECH_TO_TEXT_V1 E - IBM Watson Speech to Text + Speech to Text 1 X X X + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + ADD_AUDIO + E + Add an audio resource + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + ADD_CORPUS + E + Add a corpus + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + ADD_GRAMMAR + E + Add a grammar + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + ADD_WORD + E + Add a custom word + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + ADD_WORDS + E + Add custom words + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + CHECK_JOB + E + Check a job + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + CHECK_JOBS + E + Check jobs + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + CREATE_ACOUSTIC_MODEL + E + Create a custom acoustic model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + CREATE_JOB + E + Create a job + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + CREATE_LANGUAGE_MODEL + E + Create a custom language model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_ACOUSTIC_MODEL + E + Delete a custom acoustic model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_AUDIO + E + Delete an audio resource + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_CORPUS + E + Delete a corpus + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_GRAMMAR + E + Delete a grammar + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_JOB + E + Delete a job + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_LANGUAGE_MODEL + E + Delete a custom language model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_USER_DATA + E + Delete labeled data + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + DELETE_WORD + E + Delete a custom word + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_ACOUSTIC_MODEL + E + Get a custom acoustic model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_AUDIO + E + Get an audio resource + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_CORPUS + E + Get a corpus + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_GRAMMAR + E + Get a grammar + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_LANGUAGE_MODEL + E + Get a custom language model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_MODEL + E + Get a model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + GET_WORD + E + Get a custom word + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_ACOUSTIC_MODELS + E + List custom acoustic models + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_AUDIO + E + List audio resources + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_CORPORA + E + List corpora + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_GRAMMARS + E + List grammars + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_LANGUAGE_MODELS + E + List custom language models + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_MODELS + E + List models + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + LIST_WORDS + E + List custom words + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + RECOGNIZE + E + Recognize audio + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + REGISTER_CALLBACK + E + Register a callback + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + RESET_ACOUSTIC_MODEL + E + Reset a custom acoustic model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + RESET_LANGUAGE_MODEL + E + Reset a custom language model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + TRAIN_ACOUSTIC_MODEL + E + Train a custom acoustic model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + TRAIN_LANGUAGE_MODEL + E + Train a custom language model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + UNREGISTER_CALLBACK + E + Unregister a callback + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + UPGRADE_ACOUSTIC_MODEL + E + Upgrade a custom acoustic model + + + ZCL_IBMC_SPEECH_TO_TEXT_V1 + UPGRADE_LANGUAGE_MODEL + E + Upgrade a custom language model + + diff --git a/src/zcl_ibmc_text_to_speech_v1.clas.abap b/src/zcl_ibmc_text_to_speech_v1.clas.abap index 480a6b3..6787440 100644 --- a/src/zcl_ibmc_text_to_speech_v1.clas.abap +++ b/src/zcl_ibmc_text_to_speech_v1.clas.abap @@ -11,8 +11,8 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Text to Speech

-"! The IBM® Text to Speech service provides APIs that use IBM's +"!

Text to Speech

+"! The IBM® Text to Speech service provides APIs that use IBM's "! speech-synthesis capabilities to synthesize text into natural-sounding speech "! in a variety of languages, dialects, and voices. The service supports at least "! one male or female voice, sometimes both, for each language. The audio is @@ -38,7 +38,8 @@ class ZCL_IBMC_TEXT_TO_SPEECH_V1 DEFINITION public section. types: - "! Information about a word for the custom voice model. + "!

+ "! Information about a word for the custom voice model.

begin of T_WORD, "! The word for the custom voice model. WORD type STRING, @@ -47,17 +48,18 @@ public section. "! as an IPA or IBM SPR translation. A sounds-like translation consists of one or "! more words that, when combined, sound like the word. TRANSLATION type STRING, - "! **Japanese only.** The part of speech for the word. The service uses the value to - "! ** produce the correct intonation for the word. You can create only a single - "! ** entry, with or without a single part of speech, for any word; you cannot create - "! ** multiple entries with different parts of speech for the same word. For more - "! ** information, see [Working with Japanese - "! ** entries](https://cloud.ibm.com/docs/services/text-to-speech?topic=text-to-speec - "! **h-rules#jaNotes). + "! **Japanese only.** The part of speech for the word. The service uses the value + "! to produce the correct intonation for the word. You can create only a single + "! entry, with or without a single part of speech, for any word; you cannot create + "! multiple entries with different parts of speech for the same word. For more + "! information, see [Working with Japanese + "! entries](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-rules#j + "! aNotes). PART_OF_SPEECH type STRING, end of T_WORD. types: - "! Information about an existing custom voice model. + "!

+ "! Information about an existing custom voice model.

begin of T_VOICE_MODEL, "! The customization ID (GUID) of the custom voice model. The **Create a custom "! model** method returns only this field. It does not not return the other fields @@ -89,7 +91,9 @@ public section. WORDS type STANDARD TABLE OF T_WORD WITH NON-UNIQUE DEFAULT KEY, end of T_VOICE_MODEL. types: - "! Additional service features that are supported with the voice. + "!

+ "! Additional service features that are supported with the

+ "! voice. begin of T_SUPPORTED_FEATURES, "! If `true`, the voice can be customized; if `false`, the voice cannot be "! customized. (Same as `customizable`.). @@ -100,7 +104,8 @@ public section. VOICE_TRANSFORMATION type BOOLEAN, end of T_SUPPORTED_FEATURES. types: - "! Information about an available voice model. + "!

+ "! Information about an available voice model.

begin of T_VOICE, "! The URI of the voice. URL type STRING, @@ -124,7 +129,8 @@ public section. CUSTOMIZATION type T_VOICE_MODEL, end of T_VOICE. types: - "! Information about the new custom voice model. + "!

+ "! Information about the new custom voice model.

begin of T_CREATE_VOICE_MODEL, "! The name of the new custom voice model. NAME type STRING, @@ -136,7 +142,8 @@ public section. DESCRIPTION type STRING, end of T_CREATE_VOICE_MODEL. types: - "! The error response from a failed request. + "!

+ "! The error response from a failed request.

begin of T_ERROR_MODEL, "! Description of the problem. ERROR type STRING, @@ -146,16 +153,17 @@ public section. CODE_DESCRIPTION type STRING, 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 voice model and the translation for each specified word. + "!

+ "! For the **Add custom words** method, one or more words that

+ "! are to be added or updated for the custom voice model and the translation for + "! each specified word.
"!
- "!
- "! For the **List custom words** method, the words and their translations from the - "! custom voice model. + "! For the **List custom words** method, the words and their translations from the + "! custom voice model. begin of T_WORDS, "! The **Add custom words** method accepts an array of `Word` objects. Each object "! provides a word that is to be added or updated for the custom voice model and - "! the word's translation.
+ "! the word's translation.
"!
"! The **List custom words** method returns an array of `Word` objects. Each object "! shows a word and its translation from the custom voice model. The words are @@ -164,7 +172,8 @@ public section. WORDS type STANDARD TABLE OF T_WORD WITH NON-UNIQUE DEFAULT KEY, end of T_WORDS. types: - "! Information about the updated custom voice model. + "!

+ "! Information about the updated custom voice model.

begin of T_UPDATE_VOICE_MODEL, "! A new name for the custom voice model. NAME type STRING, @@ -176,16 +185,19 @@ public section. WORDS type STANDARD TABLE OF T_WORD WITH NON-UNIQUE DEFAULT KEY, end of T_UPDATE_VOICE_MODEL. types: - "! Information about all available voice models. + "!

+ "! Information about all available voice models.

begin of T_VOICES, "! A list of available voices. VOICES type STANDARD TABLE OF T_VOICE WITH NON-UNIQUE DEFAULT KEY, end of T_VOICES. types: - "! The empty response from a request. + "!

+ "! The empty response from a request.

T_EMPTY_RESPONSE_BODY type JSONOBJECT. types: - "! Information about existing custom voice models. + "!

+ "! Information about existing custom voice models.

begin of T_VOICE_MODELS, "! An array of `VoiceModel` objects that provides information about each available "! custom voice model. The array is empty if the requesting credentials own no @@ -194,15 +206,18 @@ public section. CUSTOMIZATIONS type STANDARD TABLE OF T_VOICE_MODEL WITH NON-UNIQUE DEFAULT KEY, end of T_VOICE_MODELS. types: - "! The text to synthesize. Specify either plain text or a subset of SSML. SSML is - "! an XML-based markup language that provides text annotation for speech-synthesis - "! applications. Pass a maximum of 5 KB of input text. + "!

+ "! The text to synthesize. Specify either plain text or a

+ "! subset of SSML. SSML is an XML-based markup language that provides text + "! annotation for speech-synthesis applications. Pass a maximum of 5 KB of input + "! text. begin of T_TEXT, "! The text to synthesize. TEXT type STRING, end of T_TEXT. types: - "! The pronunciation of the specified text. + "!

+ "! The pronunciation of the specified text.

begin of T_PRONUNCIATION, "! The pronunciation of the specified text in the requested voice and format. If a "! custom voice model is specified, the pronunciation also reflects that custom @@ -210,24 +225,26 @@ public section. PRONUNCIATION type STRING, end of T_PRONUNCIATION. types: - "! Information about the translation for the specified text. + "!

+ "! Information about the translation for the specified text.

begin of T_TRANSLATION, "! The phonetic or sounds-like translation for the word. A phonetic translation is "! based on the SSML format for representing the phonetic string of a word either "! as an IPA translation or as an IBM SPR translation. A sounds-like is one or "! more words that, when combined, sound like the word. TRANSLATION type STRING, - "! **Japanese only.** The part of speech for the word. The service uses the value to - "! ** produce the correct intonation for the word. You can create only a single - "! ** entry, with or without a single part of speech, for any word; you cannot create - "! ** multiple entries with different parts of speech for the same word. For more - "! ** information, see [Working with Japanese - "! ** entries](https://cloud.ibm.com/docs/services/text-to-speech?topic=text-to-speec - "! **h-rules#jaNotes). + "! **Japanese only.** The part of speech for the word. The service uses the value + "! to produce the correct intonation for the word. You can create only a single + "! entry, with or without a single part of speech, for any word; you cannot create + "! multiple entries with different parts of speech for the same word. For more + "! information, see [Working with Japanese + "! entries](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-rules#j + "! aNotes). PART_OF_SPEECH type STRING, end of T_TRANSLATION. constants: + "!

List of required fields per type.

begin of C_REQUIRED_FIELDS, T_WORD type string value '|WORD|TRANSLATION|', T_VOICE_MODEL type string value '|CUSTOMIZATION_ID|', @@ -246,6 +263,7 @@ constants: end of C_REQUIRED_FIELDS . constants: + "!

Map ABAP identifiers to service identifiers.

begin of C_ABAPNAME_DICTIONARY, VOICES type string value 'voices', URL type string value 'url', @@ -283,7 +301,14 @@ constants: redefinition . - "! List voices. + "!

List voices

+ "! Lists all voices available for use with the service. The information includes + "! the name, language, gender, and other details about the voice. To see + "! information about a specific voice, use the **Get a voice** method.
+ "!
+ "! **See also:** [Listing all available + "! voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#l + "! istVoices). "! "! @parameter E_RESPONSE | "! Service return value of type T_VOICES @@ -296,7 +321,16 @@ constants: !E_RESPONSE type T_VOICES raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a voice. + "!

Get a voice

+ "! Gets information about the specified voice. The information includes the name, + "! language, gender, and other details about the voice. Specify a customization ID + "! to obtain information for a custom voice model that is defined for the language + "! of the specified voice. To list information about all available voices, use the + "! **List voices** method.
+ "!
+ "! **See also:** [Listing a specific + "! voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#li + "! stVoice). "! "! @parameter I_VOICE | "! The voice for which information is to be returned. @@ -319,7 +353,80 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Synthesize audio. + "!

Synthesize audio

+ "! Synthesizes text to audio that is spoken in the specified voice. The service + "! bases its understanding of the language for the input text on the specified + "! voice. Use a voice that matches the language of the input text.
+ "!
+ "! The method accepts a maximum of 5 KB of input text in the body of the request, + "! and 8 KB for the URL and headers. The 5 KB limit includes any SSML tags that + "! you specify. The service returns the synthesized audio stream as an array of + "! bytes.
+ "!
+ "! **See also:** [The HTTP + "! interface](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-using + "! HTTP#usingHTTP).
+ "!
+ "! ### Audio formats (accept types)
+ "!
+ "! The service can return audio in the following formats (MIME types).
+ "! * Where indicated, you can optionally specify the sampling rate (`rate`) of the + "! audio. You must specify a sampling rate for the `audio/l16` and `audio/mulaw` + "! formats. A specified sampling rate must lie in the range of 8 kHz to 192 kHz. + "! Some formats restrict the sampling rate to certain values, as noted.
+ "! * For the `audio/l16` format, you can optionally specify the endianness + "! (`endianness`) of the audio: `endianness=big-endian` or + "! `endianness=little-endian`.
+ "!
+ "! Use the `Accept` header or the `accept` parameter to specify the requested + "! format of the response audio. If you omit an audio format altogether, the + "! service returns the audio in Ogg format with the Opus codec + "! (`audio/ogg;codecs=opus`). The service always returns single-channel + "! audio.
+ "! * `audio/basic` - The service returns audio with a sampling rate of 8000 + "! Hz.
+ "! * `audio/flac` - You can optionally specify the `rate` of the audio. The default + "! sampling rate is 22,050 Hz.
+ "! * `audio/l16` - You must specify the `rate` of the audio. You can optionally + "! specify the `endianness` of the audio. The default endianness is + "! `little-endian`.
+ "! * `audio/mp3` - You can optionally specify the `rate` of the audio. The default + "! sampling rate is 22,050 Hz.
+ "! * `audio/mpeg` - You can optionally specify the `rate` of the audio. The default + "! sampling rate is 22,050 Hz.
+ "! * `audio/mulaw` - You must specify the `rate` of the audio.
+ "! * `audio/ogg` - The service returns the audio in the `vorbis` codec. You can + "! optionally specify the `rate` of the audio. The default sampling rate is 22,050 + "! Hz.
+ "! * `audio/ogg;codecs=opus` - You can optionally specify the `rate` of the audio. + "! Only the following values are valid sampling rates: `48000`, `24000`, `16000`, + "! `12000`, or `8000`. If you specify a value other than one of these, the service + "! returns an error. The default sampling rate is 48,000 Hz.
+ "! * `audio/ogg;codecs=vorbis` - You can optionally specify the `rate` of the + "! audio. The default sampling rate is 22,050 Hz.
+ "! * `audio/wav` - You can optionally specify the `rate` of the audio. The default + "! sampling rate is 22,050 Hz.
+ "! * `audio/webm` - The service returns the audio in the `opus` codec. The service + "! returns audio with a sampling rate of 48,000 Hz.
+ "! * `audio/webm;codecs=opus` - The service returns audio with a sampling rate of + "! 48,000 Hz.
+ "! * `audio/webm;codecs=vorbis` - You can optionally specify the `rate` of the + "! audio. The default sampling rate is 22,050 Hz.
+ "!
+ "! For more information about specifying an audio format, including additional + "! details about some of the formats, see [Audio + "! formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audioFo + "! rmats#audioFormats).
+ "!
+ "! ### Warning messages
+ "!
+ "! If a request includes invalid query parameters, the service returns a + "! `Warnings` response header that provides messages about the invalid parameters. + "! The warning includes a descriptive message and a list of invalid argument + "! strings. For example, a message such as `"Unknown arguments:"` or + "! `"Unknown url query arguments:"` followed by a list of the form + "! `"{invalid_arg_1}, {invalid_arg_2}."` The request + "! succeeds despite the warnings. "! "! @parameter I_TEXT | "! No documentation available. @@ -352,7 +459,19 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get pronunciation. + "!

Get pronunciation

+ "! Gets the phonetic pronunciation for the specified word. You can request the + "! pronunciation for a specific format. You can also request the pronunciation for + "! a specific voice to see the default translation for the language of that voice + "! or for a specific custom voice model to see the translation for that voice + "! model.
+ "!
+ "! **Note:** This method is currently a beta release. The method does not support + "! the Arabic, Chinese, and Dutch languages.
+ "!
+ "! **See also:** [Querying a word from a + "! language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-custom + "! Words#cuWordsQueryLanguage). "! "! @parameter I_TEXT | "! The word for which the pronunciation is requested. @@ -368,9 +487,9 @@ constants: "! is to be returned. The language of a specified custom model must match the "! language of the specified voice. If the word is not defined in the specified "! custom model, the service returns the default translation for the custom - "! model's language. You must make the request with credentials for the instance - "! of the service that owns the custom model. Omit the parameter to see the - "! translation for the specified voice with no customization. + "! model's language. You must make the request with credentials for the + "! instance of the service that owns the custom model. Omit the parameter to see + "! the translation for the specified voice with no customization. "! @parameter E_RESPONSE | "! Service return value of type T_PRONUNCIATION "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. @@ -387,7 +506,18 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a custom model. + "!

Create a custom model

+ "! Creates a new empty custom voice model. You must specify a name for the new + "! custom model. You can optionally specify the language and a description for the + "! new model. The model is owned by the instance of the service whose credentials + "! are used to create it.
+ "!
+ "! **Note:** This method is currently a beta release. The service does not support + "! voice model customization for the Arabic, Chinese, and Dutch languages.
+ "!
+ "! **See also:** [Creating a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + "! els#cuModelsCreate). "! "! @parameter I_CREATE_VOICE_MODEL | "! A `CreateVoiceModel` object that contains information about the new custom voice @@ -405,7 +535,19 @@ constants: !E_RESPONSE type T_VOICE_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List custom models. + "!

List custom models

+ "! Lists metadata such as the name and description for all custom voice models that + "! are owned by an instance of the service. Specify a language to list the voice + "! models for that language only. To see the words in addition to the metadata for + "! a specific voice 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.
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:** [Querying all custom + "! models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMo + "! dels#cuModelsQueryAll). "! "! @parameter I_LANGUAGE | "! The language for which custom voice models that are owned by the requesting @@ -423,7 +565,41 @@ constants: !E_RESPONSE type T_VOICE_MODELS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a custom model. + "!

Update a custom model

+ "! Updates information for the specified custom voice model. You can update + "! metadata such as the name and description of the voice model. You can also + "! update the words in the model and their translations. Adding a new translation + "! for a word that already exists in a custom model overwrites the word's + "! existing translation. A custom model can contain no more than 20,000 entries. + "! You must use credentials for the instance of the service that owns a model to + "! update it.
+ "!
+ "! You can define sounds-like or phonetic translations for words. A sounds-like + "! translation consists of one or more words that, when combined, sound like the + "! word. Phonetic translations are based on the SSML phoneme format for + "! representing a word. You can specify them in standard International Phonetic + "! Alphabet (IPA) representation
+ "!
+ "! <code><phoneme alphabet="ipa" + "! ph="təmˈɑto"></phoneme></code>
+ "!
+ "! or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+ "!
+ "! <code><phoneme alphabet="ibm" + "! ph="1gAstroEntxrYFXs"></phoneme></code>
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:**
+ "! * [Updating a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + "! els#cuModelsUpdate)
+ "! * [Adding words to a Japanese custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuJapaneseAdd)
+ "! * [Understanding + "! customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c + "! ustomIntro#customIntro) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -441,7 +617,17 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a custom model. + "!

Get a custom model

+ "! Gets all information about a specified custom voice model. In addition to + "! metadata such as the name and description of the voice model, the output + "! includes the words and their translations as defined in the model. To see just + "! the metadata for a voice model, use the **List custom models** method.
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:** [Querying a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + "! els#cuModelsQuery). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -458,7 +644,15 @@ constants: !E_RESPONSE type T_VOICE_MODEL raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a custom model. + "!

Delete a custom model

+ "! Deletes the specified custom voice model. You must use credentials for the + "! instance of the service that owns a model to delete it.
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:** [Deleting a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customMod + "! els#cuModelsDelete). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -471,7 +665,39 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add custom words. + "!

Add custom words

+ "! Adds one or more words and their translations to the specified custom voice + "! model. Adding a new translation for a word that already exists in a custom + "! model overwrites the word's existing translation. A custom model can + "! contain no more than 20,000 entries. You must use credentials for the instance + "! of the service that owns a model to add words to it.
+ "!
+ "! You can define sounds-like or phonetic translations for words. A sounds-like + "! translation consists of one or more words that, when combined, sound like the + "! word. Phonetic translations are based on the SSML phoneme format for + "! representing a word. You can specify them in standard International Phonetic + "! Alphabet (IPA) representation
+ "!
+ "! <code><phoneme alphabet="ipa" + "! ph="təmˈɑto"></phoneme></code>
+ "!
+ "! or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+ "!
+ "! <code><phoneme alphabet="ibm" + "! ph="1gAstroEntxrYFXs"></phoneme></code>
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:**
+ "! * [Adding multiple words to a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuWordsAdd)
+ "! * [Adding words to a Japanese custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuJapaneseAdd)
+ "! * [Understanding + "! customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c + "! ustomIntro#customIntro) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -488,7 +714,17 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List custom words. + "!

List custom words

+ "! Lists all of the words and their translations for the specified custom voice + "! model. The output shows the translations as they are defined in the model. You + "! must use credentials for the instance of the service that owns a model to list + "! its words.
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:** [Querying all words from a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuWordsQueryModel). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -505,7 +741,39 @@ constants: !E_RESPONSE type T_WORDS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add a custom word. + "!

Add a custom word

+ "! Adds a single word and its translation to the specified custom voice model. + "! Adding a new translation for a word that already exists in a custom model + "! overwrites the word's existing translation. A custom model can contain no + "! more than 20,000 entries. You must use credentials for the instance of the + "! service that owns a model to add a word to it.
+ "!
+ "! You can define sounds-like or phonetic translations for words. A sounds-like + "! translation consists of one or more words that, when combined, sound like the + "! word. Phonetic translations are based on the SSML phoneme format for + "! representing a word. You can specify them in standard International Phonetic + "! Alphabet (IPA) representation
+ "!
+ "! <code><phoneme alphabet="ipa" + "! ph="təmˈɑto"></phoneme></code>
+ "!
+ "! or in the proprietary IBM Symbolic Phonetic Representation (SPR)
+ "!
+ "! <code><phoneme alphabet="ibm" + "! ph="1gAstroEntxrYFXs"></phoneme></code>
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:**
+ "! * [Adding a single word to a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuWordAdd)
+ "! * [Adding words to a Japanese custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuJapaneseAdd)
+ "! * [Understanding + "! customization](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-c + "! ustomIntro#customIntro) "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -524,7 +792,17 @@ constants: !I_contenttype type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a custom word. + "!

Get a custom word

+ "! Gets the translation for a single word from the specified custom model. The + "! output shows the translation as it is defined in the model. You must use + "! credentials for the instance of the service that owns a model to list its + "! words.
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:** [Querying a single word from a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuWordQueryModel). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -544,7 +822,16 @@ constants: !E_RESPONSE type T_TRANSLATION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a custom word. + "!

Delete a custom word

+ "! Deletes a single word from the specified custom voice model. You must use + "! credentials for the instance of the service that owns a model to delete its + "! words.
+ "!
+ "! **Note:** This method is currently a beta release.
+ "!
+ "! **See also:** [Deleting a word from a custom + "! model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWor + "! ds#cuWordDelete). "! "! @parameter I_CUSTOMIZATION_ID | "! The customization ID (GUID) of the custom voice model. You must make the request @@ -560,7 +847,20 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete labeled data. + "!

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 + "! information was added. The method has no effect if no data is associated with + "! the customer ID. You must issue the request with credentials for the same + "! instance of the service that was used to associate the customer ID with the + "! data.
+ "!
+ "! You associate a customer ID with data by passing the `X-Watson-Metadata` header + "! with a request that passes the data.
+ "!
+ "! **See also:** [Information + "! security](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-inform + "! ation-security#information-security). "! "! @parameter I_CUSTOMER_ID | "! The customer ID for which all data is to be deleted. @@ -649,7 +949,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092827'. + e_sdk_version_date = '20200310173439'. endmethod. diff --git a/src/zcl_ibmc_text_to_speech_v1.clas.xml b/src/zcl_ibmc_text_to_speech_v1.clas.xml index 7136ceb..c2a5247 100644 --- a/src/zcl_ibmc_text_to_speech_v1.clas.xml +++ b/src/zcl_ibmc_text_to_speech_v1.clas.xml @@ -5,12 +5,104 @@ ZCL_IBMC_TEXT_TO_SPEECH_V1 E - IBM Watson Text to Speech + Text to Speech 1 X X X + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + ADD_WORD + E + Add a custom word + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + ADD_WORDS + E + Add custom words + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + CREATE_VOICE_MODEL + E + Create a custom model + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + DELETE_USER_DATA + E + Delete labeled data + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + DELETE_VOICE_MODEL + E + Delete a custom model + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + DELETE_WORD + E + Delete a custom word + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + GET_PRONUNCIATION + E + Get pronunciation + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + GET_VOICE + E + Get a voice + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + GET_VOICE_MODEL + E + Get a custom model + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + GET_WORD + E + Get a custom word + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + LIST_VOICES + E + List voices + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + LIST_VOICE_MODELS + E + List custom models + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + LIST_WORDS + E + List custom words + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + SYNTHESIZE + E + Synthesize audio + + + ZCL_IBMC_TEXT_TO_SPEECH_V1 + UPDATE_VOICE_MODEL + E + Update a custom model + + diff --git a/src/zcl_ibmc_tone_analyzer_v3.clas.abap b/src/zcl_ibmc_tone_analyzer_v3.clas.abap index 3f92578..9c69d36 100644 --- a/src/zcl_ibmc_tone_analyzer_v3.clas.abap +++ b/src/zcl_ibmc_tone_analyzer_v3.clas.abap @@ -11,14 +11,14 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Tone Analyzer

+"!

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.
+"! customers' communications and to respond to each customer appropriately, +"! or to understand and improve their customer conversations.
"!
"! **Note:** Request logging is disabled for the Tone Analyzer service. Regardless "! of whether you set the `X-Watson-Learning-Opt-Out` request header, the service @@ -30,7 +30,8 @@ class ZCL_IBMC_TONE_ANALYZER_V3 DEFINITION public section. types: - "! The score for a tone from the input content. + "!

+ "! The score for a tone from the input content.

begin of T_TONE_SCORE, "! The score for the tone.
"! * **`2017-09-21`:** The score that is returned lies in the range of 0.5 to 1. A @@ -58,7 +59,8 @@ public section. TONE_NAME type STRING, end of T_TONE_SCORE. types: - "! The category for a tone from the input content. + "!

+ "! 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. @@ -71,13 +73,15 @@ public section. CATEGORY_NAME type STRING, end of T_TONE_CATEGORY. types: - "! Input for the general-purpose endpoint. + "!

+ "! 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. + "!

+ "! 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. @@ -89,7 +93,8 @@ public section. TONE_NAME type STRING, end of T_TONE_CHAT_SCORE. types: - "! An utterance for the input of the general-purpose endpoint. + "!

+ "! 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. @@ -99,39 +104,44 @@ public section. USER type STRING, end of T_UTTERANCE. types: - "! Input for the customer-engagement endpoint. + "!

+ "! 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. + "!

+ "! 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. + "! **`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. + "! 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. + "! 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. + "! **`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. + "!

+ "! 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. @@ -144,23 +154,26 @@ public section. "! 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. + "! 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. + "!

+ "! 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. + "! 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. + "!

+ "! The error response from a failed request.

begin of T_ERROR_MODEL, "! The HTTP status code. CODE type INTEGER, @@ -173,26 +186,29 @@ public section. HELP type STRING, end of T_ERROR_MODEL. types: - "! The results of the analysis for the full input content. + "!

+ "! 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. + "! **`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. + "! 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. + "! 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. + "!

+ "! 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, @@ -204,6 +220,7 @@ public section. 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|', @@ -221,6 +238,7 @@ constants: 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', @@ -259,27 +277,48 @@ constants: redefinition . - "! Analyze general tone. + "!

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.
+ "!
+ "! You can submit no more than 128 KB of total input content and no more than 1000 + "! individual sentences in JSON, plain text, or HTML format. The service analyzes + "! the first 1000 sentences for document-level analysis and only the first 100 + "! sentences for sentence-level analysis.
+ "!
+ "! Per the JSON specification, the default character encoding for JSON content is + "! effectively always UTF-8; per the HTTP specification, the default encoding for + "! plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When + "! specifying a content type of plain text or HTML, include the `charset` + "! parameter to indicate the character encoding of the input text; for example: + "! `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes + "! HTML tags and analyzes only the textual content.
+ "!
+ "! **See also:** [Using the general-purpose + "! endpoint](https://cloud.ibm.com/docs/tone-analyzer?topic=tone-analyzer-utgpe#ut + "! gpe). "! "! @parameter I_TONE_INPUT | "! JSON, plain text, or HTML input that contains the content to be analyzed. For "! JSON input, provide an object of type `ToneInput`. "! @parameter I_CONTENT_TYPE | "! The type of the input. A character encoding can be specified by including a - "! `charset` parameter. For example, 'text/plain;charset=utf-8'. + "! `charset` parameter. For example, 'text/plain;charset=utf-8'. "! @parameter I_SENTENCES | "! Indicates whether the service is to return an analysis of each individual "! sentence in addition to its analysis of the full document. If `true` (the "! default), the service returns results for each sentence. "! @parameter I_TONES | "! **`2017-09-21`:** Deprecated. The service continues to accept the parameter for - "! ** backward-compatibility, but the parameter no longer affects the response.
- "! **
- "! ****`2016-05-19`:** A comma-separated list of tones for which the service is to - "! ** return its analysis of the input; the indicated tones apply both to the full - "! ** document and to individual sentences of the document. You can specify one or - "! ** more of the valid values. Omit the parameter to request results for all three - "! ** tones. + "! backward-compatibility, but the parameter no longer affects the response.
+ "!
+ "! **`2016-05-19`:** A comma-separated list of tones for which the service is to + "! return its analysis of the input; the indicated tones apply both to the full + "! document and to individual sentences of the document. You can specify one or + "! more of the valid values. Omit the parameter to request results for all three + "! tones. "! @parameter I_CONTENT_LANGUAGE | "! The language of the input text for the request: English or French. Regional "! variants are treated as their parent language; for example, `en-US` is @@ -310,7 +349,23 @@ constants: !E_RESPONSE type T_TONE_ANALYSIS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Analyze customer-engagement tone. + "!

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.
+ "!
+ "! If you submit more than 50 utterances, the service returns a warning for the + "! overall content and analyzes only the first 50 utterances. If you submit a + "! single utterance that contains more than 500 characters, the service returns an + "! error for that utterance and does not analyze the utterance. The request fails + "! if all utterances have more than 500 characters. Per the JSON specification, + "! the default character encoding for JSON content is effectively always UTF-8. + "!
+ "!
+ "! **See also:** [Using the customer-engagement + "! endpoint](https://cloud.ibm.com/docs/tone-analyzer?topic=tone-analyzer-utco#utc + "! o). "! "! @parameter I_UTTERANCES | "! An object that contains the content to be analyzed. @@ -415,7 +470,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092828'. + e_sdk_version_date = '20200310173440'. endmethod. diff --git a/src/zcl_ibmc_tone_analyzer_v3.clas.xml b/src/zcl_ibmc_tone_analyzer_v3.clas.xml index 741e3e6..44e3d6d 100644 --- a/src/zcl_ibmc_tone_analyzer_v3.clas.xml +++ b/src/zcl_ibmc_tone_analyzer_v3.clas.xml @@ -5,12 +5,26 @@ ZCL_IBMC_TONE_ANALYZER_V3 E - IBM Watson Tone Analyzer + Tone Analyzer 1 X X X + + + ZCL_IBMC_TONE_ANALYZER_V3 + TONE + E + Analyze general tone + + + ZCL_IBMC_TONE_ANALYZER_V3 + TONE_CHAT + E + Analyze customer-engagement tone + + diff --git a/src/zcl_ibmc_util.clas.abap b/src/zcl_ibmc_util.clas.abap index 6f492b2..980cd02 100644 --- a/src/zcl_ibmc_util.clas.abap +++ b/src/zcl_ibmc_util.clas.abap @@ -25,9 +25,8 @@ public section. "! @parameter I_ITAB | Internal table to be converted. "! @parameter I_DICTIONARY | Dictionary to be used for mapping ABAP identifiers to JSON keys. "! @parameter I_LOWER_CASE | If set to C_BOOLEAN_TRUE all keys in JSON string will be lower case. - "! @parameter I_EXCLUDE_FIELDS | Internal table of table fields in I_ITAB that should not occur in result. + "! @parameter IT_EXCLUDED_FIELDS | Internal table of table fields in I_ITAB that should not occur in result. "! @parameter E_JSON | JSON string. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! class-methods ITAB_TO_TABLESCHEMA importing @@ -43,7 +42,6 @@ public section. "! @parameter I_JSON | JSON string. "! @parameter I_TABLESCHEMA_KEY | Key in JSON string that holds the table schema. "! @parameter E_ITAB | Internal table containing converted data. - "! @raising ZCX_IBMC_SERVICE_EXCEPTION | Exception being raised in case of an error. "! class-methods TABLESCHEMA_TO_ITAB importing @@ -96,7 +94,7 @@ public section. "! Converts a timestamp to datetime format, i.e. YYYYMMDDHHMMSS -> yyyy-mm-ddThh:mm:ssZ "! "! @parameter I_TIMESTAMP | Timestamp. - "! @parameter E_DATATIMEP | Datetime format. + "! @parameter E_DATETIME | Datetime format. "! class-methods CONVERT_TIMESTAMP_TO_DATETIME importing diff --git a/src/zcl_ibmc_visual_recognition_v3.clas.abap b/src/zcl_ibmc_visual_recognition_v3.clas.abap index e755104..6f87ee6 100644 --- a/src/zcl_ibmc_visual_recognition_v3.clas.abap +++ b/src/zcl_ibmc_visual_recognition_v3.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Visual Recognition

+"!

Visual Recognition

"! The IBM Watson™ Visual Recognition service uses deep learning algorithms "! to identify scenes and objects in images that you upload to the service. You "! can create and train a custom classifier to identify subjects that suit your @@ -23,10 +23,12 @@ class ZCL_IBMC_VISUAL_RECOGNITION_V3 DEFINITION public section. types: - "! Number of images processed for the API call. + "!

+ "! Number of images processed for the API call.

T_IMAGES_PROCESSED type Integer. types: - "! Result of a class within a classifier. + "!

+ "! Result of a class within a classifier.

begin of T_CLASS_RESULT, "! Name of the class.
"!
@@ -45,7 +47,8 @@ public section. TYPE_HIERARCHY type STRING, end of T_CLASS_RESULT. types: - "! Classifier and score combination. + "!

+ "! Classifier and score combination.

begin of T_CLASSIFIER_RESULT, "! Name of the classifier. NAME type STRING, @@ -55,8 +58,9 @@ public section. 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. + "!

+ "! 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, @@ -66,7 +70,8 @@ public section. ERROR_ID type STRING, end of T_ERROR_INFO. types: - "! Results for one image. + "!

+ "! Results for one image.

begin of T_CLASSIFIED_IMAGE, "! Source of the image before any redirects. Not returned when the image is "! uploaded. @@ -84,7 +89,8 @@ public section. 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. + "!

+ "! Information about something that went wrong.

begin of T_WARNING_INFO, "! Codified warning string, such as `limit_reached`. WARNING_ID type STRING, @@ -92,7 +98,8 @@ public section. DESCRIPTION type STRING, end of T_WARNING_INFO. types: - "! Results for all images. + "!

+ "! Results for all images.

begin of T_CLASSIFIED_IMAGES, "! Number of custom classes identified in the images. CUSTOM_CLASSES type INTEGER, @@ -107,28 +114,32 @@ public section. 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. + "!

+ "! 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. + "!

+ "! A category within a classifier.

begin of T_CLASS, "! The name of the class. CLASS type STRING, end of T_CLASS. types: - "! Empty object. + "!

+ "! Empty object.

T_EMPTY type JSONOBJECT. types: - "! Error information. + "!

+ "! Error information.

begin of T_ERROR_RESPONSE, "! HTTP error code. CODE type INTEGER, - "! Human-readable error string, like 'Invalid image file'. + "! Human-readable error string, like 'Invalid image file'. ERROR type STRING, end of T_ERROR_RESPONSE. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT1, "! The name of the new classifier. Encode special characters in UTF-8. NAME type STRING, @@ -138,7 +149,7 @@ public section. "! Specify the parameter name by appending `_positive_examples` to the class name. "! For example, `goldenretriever_positive_examples` creates the class "! **goldenretriever**. The string cannot contain the following characters: ``$ * - "! - { } \ | / ' " ` [ ]``.
+ "! - { } \ | / ' " ` [ ]``.
"!
"! Include at least 10 images in .jpg or .png format. The minimum recommended image "! resolution is 32X32 pixels. The maximum number of images is 10,000 images or @@ -153,7 +164,7 @@ public section. NEGATIVE_EXAMPLES type FILE, end of T_INLINE_OBJECT1. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT, "! 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 @@ -195,7 +206,7 @@ public section. CLASSIFIER_IDS type STANDARD TABLE OF STRING WITH NON-UNIQUE DEFAULT KEY, end of T_INLINE_OBJECT. types: - "! No documentation available. + "! No documentation available. begin of T_INLINE_OBJECT2, "! A .zip file of images that depict the visual subject of a class in the "! classifier. The positive examples create or update classes in the classifier. @@ -204,7 +215,7 @@ public section. "! Specify the parameter name by appending `_positive_examples` to the class name. "! For example, `goldenretriever_positive_examples` creates the class "! `goldenretriever`. The string cannot contain the following characters: ``$ * - - "! { } \ | / ' " ` [ ]``.
+ "! { } \ | / ' " ` [ ]``.
"!
"! Include at least 10 images in .jpg or .png format. The minimum recommended image "! resolution is 32X32 pixels. The maximum number of images is 10,000 images or @@ -219,7 +230,8 @@ public section. NEGATIVE_EXAMPLES type FILE, end of T_INLINE_OBJECT2. types: - "! Information about a classifier. + "!

+ "! Information about a classifier.

begin of T_CLASSIFIER, "! ID of a classifier identified in the image. CLASSIFIER_ID type STRING, @@ -250,39 +262,47 @@ public section. UPDATED type DATETIME, end of T_CLASSIFIER. types: - "! Number of custom classes identified in the images. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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. + "!

+ "! 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|', @@ -302,6 +322,7 @@ constants: 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', @@ -349,7 +370,8 @@ constants: redefinition . - "! Classify images. + "!

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 @@ -416,7 +438,22 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a classifier. + "!

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.
+ "!
+ "! **Tips when creating:**
+ "!
+ "! - If you set the **X-Watson-Learning-Opt-Out** header parameter to `true` when + "! you create a classifier, the example training images are not stored. Save your + "! training images locally. For more information, see [Data + "! collection](#data-collection).
+ "!
+ "! - Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image + "! file names, and classifier and class names). The service assumes UTF-8 encoding + "! if it encounters non-ASCII characters. "! "! @parameter I_NAME | "! The name of the new classifier. Encode special characters in UTF-8. @@ -427,7 +464,7 @@ constants: "! Specify the parameter name by appending `_positive_examples` to the class name. "! For example, `goldenretriever_positive_examples` creates the class "! **goldenretriever**. The string cannot contain the following characters: ``$ * - "! - { } \ | / ' " ` [ ]``.
+ "! - { } \ | / ' " ` [ ]``.
"!
"! Include at least 10 images in .jpg or .png format. The minimum recommended image "! resolution is 32X32 pixels. The maximum number of images is 10,000 images or @@ -459,7 +496,7 @@ constants: !E_RESPONSE type T_CLASSIFIER raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Retrieve a list of classifiers. + "!

Retrieve a list of classifiers

"! "! @parameter I_VERBOSE | "! Specify `true` to return details about the classifiers. Omit this parameter to @@ -476,7 +513,8 @@ constants: !E_RESPONSE type T_CLASSIFIERS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Retrieve classifier details. + "!

Retrieve classifier details

+ "! Retrieve information about a custom classifier. "! "! @parameter I_CLASSIFIER_ID | "! The ID of the classifier. @@ -492,7 +530,28 @@ constants: !E_RESPONSE type T_CLASSIFIER raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a classifier. + "!

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).
+ "!
+ "! Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image + "! file names, and classifier and class names). The service assumes UTF-8 encoding + "! if it encounters non-ASCII characters.
+ "!
+ "! **Tips about retraining:**
+ "!
+ "! - You can't update the classifier if the **X-Watson-Learning-Opt-Out** + "! header parameter was set to `true` when the classifier was created. Training + "! images are not stored in that case. Instead, create another classifier. For + "! more information, see [Data collection](#data-collection).
+ "!
+ "! - Don't make retraining calls on a classifier until the status is ready. + "! When you submit retraining requests in parallel, the last request overwrites + "! the previous requests. The `retrained` property shows the last time the + "! classifier retraining finished. "! "! @parameter I_CLASSIFIER_ID | "! The ID of the classifier. @@ -504,7 +563,7 @@ constants: "! Specify the parameter name by appending `_positive_examples` to the class name. "! For example, `goldenretriever_positive_examples` creates the class "! `goldenretriever`. The string cannot contain the following characters: ``$ * - - "! { } \ | / ' " ` [ ]``.
+ "! { } \ | / ' " ` [ ]``.
"!
"! Include at least 10 images in .jpg or .png format. The minimum recommended image "! resolution is 32X32 pixels. The maximum number of images is 10,000 images or @@ -536,7 +595,7 @@ constants: !E_RESPONSE type T_CLASSIFIER raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a classifier. + "!

Delete a classifier

"! "! @parameter I_CLASSIFIER_ID | "! The ID of the classifier. @@ -549,7 +608,10 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Retrieve a Core ML model of a classifier. + "!

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. @@ -566,7 +628,15 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete labeled data. + "!

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.
+ "!
+ "! You associate a customer ID with data by passing the `X-Watson-Metadata` header + "! with a request that passes data. For more information about personal data and + "! customer IDs, see [Information + "! security](https://cloud.ibm.com/docs/visual-recognition?topic=visual-recognitio + "! n-information-security). "! "! @parameter I_CUSTOMER_ID | "! The customer ID for which all data is to be deleted. @@ -647,7 +717,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092829'. + e_sdk_version_date = '20200310173442'. endmethod. diff --git a/src/zcl_ibmc_visual_recognition_v3.clas.xml b/src/zcl_ibmc_visual_recognition_v3.clas.xml index 1fc323c..068e9b3 100644 --- a/src/zcl_ibmc_visual_recognition_v3.clas.xml +++ b/src/zcl_ibmc_visual_recognition_v3.clas.xml @@ -5,12 +5,62 @@ ZCL_IBMC_VISUAL_RECOGNITION_V3 E - IBM Watson Visual Recognition V3 + Visual Recognition 1 X X X + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + CLASSIFY + E + Classify images + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + CREATE_CLASSIFIER + E + Create a classifier + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + DELETE_CLASSIFIER + E + Delete a classifier + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + DELETE_USER_DATA + E + Delete labeled data + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + GET_CLASSIFIER + E + Retrieve classifier details + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + GET_CORE_ML_MODEL + E + Retrieve a Core ML model of a classifier + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + LIST_CLASSIFIERS + E + Retrieve a list of classifiers + + + ZCL_IBMC_VISUAL_RECOGNITION_V3 + UPDATE_CLASSIFIER + E + Update a classifier + + diff --git a/src/zcl_ibmc_visual_recognition_v4.clas.abap b/src/zcl_ibmc_visual_recognition_v4.clas.abap index 5d4cfec..6145972 100644 --- a/src/zcl_ibmc_visual_recognition_v4.clas.abap +++ b/src/zcl_ibmc_visual_recognition_v4.clas.abap @@ -11,7 +11,7 @@ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. -"!

Visual Recognition v4

+"!

Visual Recognition v4

"! Provide images to the IBM Watson™ Visual Recognition service for analysis. "! The service detects objects based on a set of images with training data.
class ZCL_IBMC_VISUAL_RECOGNITION_V4 DEFINITION @@ -21,7 +21,8 @@ class ZCL_IBMC_VISUAL_RECOGNITION_V4 DEFINITION public section. types: - "! Defines the location of the bounding box around the object. + "!

+ "! 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, @@ -33,7 +34,8 @@ public section. HEIGHT type INTEGER, end of T_LOCATION. types: - "! Training status for the objects in the collection. + "!

+ "! 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, @@ -49,13 +51,15 @@ public section. DESCRIPTION type STRING, end of T_OBJECT_TRAINING_STATUS. types: - "! Training status information for the collection. + "!

+ "! 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. + "!

+ "! Basic information about an object.

begin of T_OBJECT_METADATA, "! The name of the object. OBJECT type STRING, @@ -63,7 +67,8 @@ public section. COUNT type INTEGER, end of T_OBJECT_METADATA. types: - "! The source type of the image. + "!

+ "! The source type of the image.

begin of T_IMAGE_SOURCE, "! The source type of the image. TYPE type STRING, @@ -81,7 +86,8 @@ public section. RESOLVED_URL type STRING, end of T_IMAGE_SOURCE. types: - "! Details about the training data. + "!

+ "! Details about the training data.

begin of T_TRAINING_DATA_OBJECT, "! The name of the object. OBJECT type STRING, @@ -89,13 +95,15 @@ public section. LOCATION type T_LOCATION, end of T_TRAINING_DATA_OBJECT. types: - "! Training data for all objects. + "!

+ "! 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: - "! Details about a collection. + "!

+ "! Details about a collection.

begin of T_COLLECTION, "! The identifier of the collection. COLLECTION_ID type STRING, @@ -115,7 +123,8 @@ public section. TRAINING_STATUS type T_TRAINING_STATUS, end of T_COLLECTION. types: - "! Height and width of an image. + "!

+ "! Height and width of an image.

begin of T_IMAGE_DIMENSIONS, "! Height in pixels of the image. HEIGHT type INTEGER, @@ -123,7 +132,8 @@ public section. WIDTH type INTEGER, end of T_IMAGE_DIMENSIONS. types: - "! Details about the specific area of the problem. + "!

+ "! 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, @@ -131,7 +141,8 @@ public section. NAME type STRING, end of T_ERROR_TARGET. types: - "! Details about an error. + "!

+ "! Details about an error.

begin of T_ERROR, "! Identifier of the problem. CODE type STRING, @@ -143,7 +154,8 @@ public section. TARGET type T_ERROR_TARGET, end of T_ERROR. types: - "! A container for the list of request-level problems. + "!

+ "! 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, @@ -151,7 +163,8 @@ public section. TRACE type STRING, end of T_ERROR_RESPONSE. types: - "! Details about an object and its location. + "!

+ "! 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-`. @@ -160,7 +173,7 @@ public section. LOCATION type T_LOCATION, end of T_BASE_OBJECT. types: - "! No documentation available. + "! 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, @@ -186,7 +199,8 @@ public section. THRESHOLD type FLOAT, end of T_INLINE_OBJECT. types: - "! Details about an object in the collection. + "!

+ "! Details about an object in the collection.

begin of T_OBJECT_DETAIL, "! The label for the object. OBJECT type STRING, @@ -197,7 +211,8 @@ public section. SCORE type FLOAT, end of T_OBJECT_DETAIL. types: - "! The objects in a collection that are detected in an image. + "!

+ "! 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, @@ -205,22 +220,27 @@ public section. 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. + "!

+ "! 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. + "!

+ "! A file returned in the response.

T_JPEG_IMAGE type FILE. types: - "! A container for the list of collections. + "!

+ "! 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. + "!

+ "! Details about the training event.

begin of T_TRAINING_EVENT, "! Trained object type. Only `objects` is currently supported. TYPE type STRING, @@ -235,7 +255,8 @@ public section. IMAGE_COUNT type INTEGER, end of T_TRAINING_EVENT. types: - "! Details about the training events. + "!

+ "! 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 @@ -254,7 +275,8 @@ public section. EVENTS type STANDARD TABLE OF T_TRAINING_EVENT WITH NON-UNIQUE DEFAULT KEY, end of T_TRAINING_EVENTS. types: - "! Details about an image. + "!

+ "! Details about an image.

begin of T_IMAGE_DETAILS, "! The identifier of the image. IMAGE_ID type STRING, @@ -273,7 +295,8 @@ public section. TRAINING_DATA type T_TRAINING_DATA_OBJECTS, end of T_IMAGE_DETAILS. types: - "! Details about a problem. + "!

+ "! Details about a problem.

begin of T_WARNING, "! Identifier of the problem. CODE type STRING, @@ -283,7 +306,8 @@ public section. MORE_INFO type STRING, end of T_WARNING. types: - "! List of information about the images. + "!

+ "! 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, @@ -294,10 +318,12 @@ public section. TRACE type STRING, end of T_IMAGE_DETAILS_LIST. types: - "! Empty response. + "!

+ "! Empty response.

T_EMPTY type JSONOBJECT. types: - "! Basic information about an image. + "!

+ "! Basic information about an image.

begin of T_IMAGE_SUMMARY, "! The identifier of the image. IMAGE_ID type STRING, @@ -306,13 +332,14 @@ public section. UPDATED type DATETIME, end of T_IMAGE_SUMMARY. types: - "! Container for the training data. + "!

+ "! 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. + "! No documentation available. begin of T_INLINE_OBJECT1, "! An array of image files (.jpg or .png) or .zip files with images.
"! - Include a maximum of 20 images in a request.
@@ -339,13 +366,15 @@ public section. TRAINING_DATA type STRING, end of T_INLINE_OBJECT1. types: - "! List of 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. + "!

+ "! Details about an image.

begin of T_IMAGE, "! The source type of the image. SOURCE type T_IMAGE_SOURCE, @@ -357,7 +386,8 @@ public section. ERRORS type STANDARD TABLE OF T_ERROR WITH NON-UNIQUE DEFAULT KEY, end of T_IMAGE. types: - "! Results for all images. + "!

+ "! Results for all images.

begin of T_ANALYZE_RESPONSE, "! Analyzed images. IMAGES type STANDARD TABLE OF T_IMAGE WITH NON-UNIQUE DEFAULT KEY, @@ -368,7 +398,8 @@ public section. TRACE type STRING, end of T_ANALYZE_RESPONSE. types: - "! Base details about a collection. + "!

+ "! Base details about a collection.

begin of T_BASE_COLLECTION, "! The identifier of the collection. COLLECTION_ID type STRING, @@ -389,7 +420,8 @@ public section. TRAINING_STATUS type T_TRAINING_STATUS, end of T_BASE_COLLECTION. types: - "! Basic information about an updated object. + "!

+ "! 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 @@ -399,7 +431,8 @@ public section. COUNT type INTEGER, end of T_UPDATE_OBJECT_METADATA. types: - "! List of objects. + "!

+ "! List of objects.

begin of T_OBJECT_METADATA_LIST, "! Number of unique named objects in the collection. OBJECT_COUNT type INTEGER, @@ -408,6 +441,7 @@ public section. 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|DESCRIPTION|', @@ -439,12 +473,13 @@ constants: 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 '|', + T_UPDATE_OBJECT_METADATA type string value '|OBJECT|COUNT|', 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', @@ -511,7 +546,14 @@ constants: redefinition . - "! Analyze images. + "!

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.
+ "!
+ "! 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. "! "! @parameter I_COLLECTION_IDS | "! The IDs of the collections to analyze. @@ -553,7 +595,14 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Create a collection. + "!

Create a collection

+ "! Create a collection that can be used to store images.
+ "!
+ "! To create a collection without specifying a name and description, include an + "! empty JSON object in the request body.
+ "!
+ "! Encode the name and description in UTF-8 if they contain non-ASCII characters. + "! The service assumes UTF-8 encoding if it encounters non-ASCII characters. "! "! @parameter I_COLLECTION_INFO | "! The new collection. @@ -570,7 +619,8 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List collections. + "!

List collections

+ "! Retrieves a list of collections for the service instance. "! "! @parameter E_RESPONSE | "! Service return value of type T_COLLECTIONS_LIST @@ -583,7 +633,8 @@ constants: !E_RESPONSE type T_COLLECTIONS_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get collection details. + "!

Get collection details

+ "! Get details of one collection. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -599,7 +650,11 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update a collection. + "!

Update a collection

+ "! Update the name or description of a collection.
+ "!
+ "! Encode the name and description in UTF-8 if they contain non-ASCII characters. + "! The service assumes UTF-8 encoding if it encounters non-ASCII characters. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -619,7 +674,8 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete a collection. + "!

Delete a collection

+ "! Delete a collection from the service instance. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -632,7 +688,12 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add images. + "!

Add images

+ "! Add images to a collection by URL, by file, or both.
+ "!
+ "! 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. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -675,7 +736,8 @@ constants: !E_RESPONSE type T_IMAGE_DETAILS_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List images. + "!

List images

+ "! Retrieves a list of images in a collection. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -691,7 +753,8 @@ constants: !E_RESPONSE type T_IMAGE_SUMMARY_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get image details. + "!

Get image details

+ "! Get the details of an image in a collection. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -710,7 +773,8 @@ constants: !E_RESPONSE type T_IMAGE_DETAILS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete an image. + "!

Delete an image

+ "! Delete one image from a collection. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -725,7 +789,8 @@ constants: !I_accept type string default 'application/json' raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get a JPEG file of an image. + "!

Get a JPEG file of an image

+ "! Download a JPEG representation of an image. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -750,7 +815,8 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! List object metadata. + "!

List object metadata

+ "! Retrieves a list of object names in a collection. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -766,7 +832,9 @@ constants: !E_RESPONSE type T_OBJECT_METADATA_LIST raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Update an object name. + "!

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. @@ -782,14 +850,15 @@ constants: importing !I_COLLECTION_ID type STRING !I_OBJECT type STRING - !I_UPDATEOBJECTMETADATA type T_UPDATE_OBJECT_METADATA optional + !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 object metadata

+ "! Get the number of bounding boxes for a single object in a collection. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -808,7 +877,9 @@ constants: !E_RESPONSE type T_OBJECT_METADATA raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete an object. + "!

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. @@ -824,7 +895,11 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Train a collection. + "!

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. @@ -840,7 +915,17 @@ constants: !E_RESPONSE type T_COLLECTION raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Add training data to an image. + "!

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.
+ "!
+ "! Elements in the request replace the existing elements.
+ "!
+ "! - To update the training data, provide both the unchanged and the new or changed + "! values.
+ "!
+ "! - To delete the training data, provide an empty value for the training data. "! "! @parameter I_COLLECTION_ID | "! The identifier of the collection. @@ -863,7 +948,9 @@ constants: !E_RESPONSE type T_TRAINING_DATA_OBJECTS raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Get training usage. + "!

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. @@ -887,7 +974,15 @@ constants: raising ZCX_IBMC_SERVICE_EXCEPTION . - "! Delete labeled data. + "!

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.
+ "!
+ "! You associate a customer ID with data by passing the `X-Watson-Metadata` header + "! with a request that passes data. For more information about personal data and + "! customer IDs, see [Information + "! security](https://cloud.ibm.com/docs/visual-recognition?topic=visual-recognitio + "! n-information-security). "! "! @parameter I_CUSTOMER_ID | "! The customer ID for which all data is to be deleted. @@ -968,7 +1063,7 @@ endmethod. * +-------------------------------------------------------------------------------------- method get_sdk_version_date. - e_sdk_version_date = '20200210092831'. + e_sdk_version_date = '20200310173444'. endmethod. @@ -1785,7 +1880,7 @@ endmethod. * +-------------------------------------------------------------------------------------------------+ * | [--->] I_COLLECTION_ID TYPE STRING * | [--->] I_OBJECT TYPE STRING -* | [--->] I_UPDATEOBJECTMETADATA TYPE T_UPDATE_OBJECT_METADATA(optional) +* | [--->] I_UPDATEOBJECTMETADATA TYPE T_UPDATE_OBJECT_METADATA * | [--->] I_contenttype TYPE string (default ='application/json') * | [--->] I_accept TYPE string (default ='application/json') * | [<---] E_RESPONSE TYPE T_UPDATE_OBJECT_METADATA @@ -1824,7 +1919,6 @@ method UPDATE_OBJECT_METADATA. field-symbols: type any. lv_separator = ''. - if not i_UPDATEOBJECTMETADATA is initial. lv_datatype = get_datatype( i_UPDATEOBJECTMETADATA ). if lv_datatype eq ZIF_IBMC_SERVICE_ARCH~c_datatype-struct or @@ -1842,7 +1936,6 @@ method UPDATE_OBJECT_METADATA. lv_bodyparam = . concatenate lv_body lv_bodyparam into lv_body. endif. - endif. if ls_request_prop-header_content_type cp '*json*' and lv_body(1) ne '{'. lv_body = `{` && lv_body && `}`. endif. diff --git a/src/zcl_ibmc_visual_recognition_v4.clas.xml b/src/zcl_ibmc_visual_recognition_v4.clas.xml index 690b950..185d0a4 100644 --- a/src/zcl_ibmc_visual_recognition_v4.clas.xml +++ b/src/zcl_ibmc_visual_recognition_v4.clas.xml @@ -5,12 +5,128 @@ ZCL_IBMC_VISUAL_RECOGNITION_V4 E - IBM Watson Visual Recognition V4 + Visual Recognition v4 1 X X X + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + ADD_IMAGES + E + Add images + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + ADD_IMAGE_TRAINING_DATA + E + Add training data to an image + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + ANALYZE + E + Analyze images + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + CREATE_COLLECTION + E + Create a collection + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + DELETE_COLLECTION + E + Delete a collection + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + DELETE_IMAGE + E + Delete an image + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + DELETE_OBJECT + E + Delete an object + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + DELETE_USER_DATA + E + Delete labeled data + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + GET_COLLECTION + E + Get collection details + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + GET_IMAGE_DETAILS + E + Get image details + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + GET_JPEG_IMAGE + E + Get a JPEG file of an image + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + GET_OBJECT_METADATA + E + Get object metadata + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + GET_TRAINING_USAGE + E + Get training usage + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + LIST_COLLECTIONS + E + List collections + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + LIST_IMAGES + E + List images + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + LIST_OBJECT_METADATA + E + List object metadata + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + TRAIN + E + Train a collection + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + UPDATE_COLLECTION + E + Update a collection + + + ZCL_IBMC_VISUAL_RECOGNITION_V4 + UPDATE_OBJECT_METADATA + E + Update an object name + + diff --git a/src/zibmc_token.tabl.xml b/src/zibmc_token.tabl.xml index f651218..614528a 100644 --- a/src/zibmc_token.tabl.xml +++ b/src/zibmc_token.tabl.xml @@ -17,7 +17,8 @@ A 4 APPL2 - N + P + X diff --git a/src/zif_ibmc_service_arch.intf.abap b/src/zif_ibmc_service_arch.intf.abap index 7acc531..2891730 100644 --- a/src/zif_ibmc_service_arch.intf.abap +++ b/src/zif_ibmc_service_arch.intf.abap @@ -44,6 +44,7 @@ interface ZIF_IBMC_SERVICE_ARCH begin of ts_access_token, access_token type string, token_type(32) type c, + expires_ts type timestamp, end of ts_access_token . types: ty_timezone(6) type c .