Class ZCL_IBMC_ASSISTANT

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 Level	Name	Documentation
public	t_agent_availability_message (structured type)	No documentation available.
public	t_audit_properties (structured type)	No documentation available.
public	t_base_counterexample (structured type)	No documentation available.
public	t_base_dialog_node (structured type)	No documentation available.
public	t_base_entity (structured type)	No documentation available.
public	t_base_example (structured type)	No documentation available.
public	t_base_intent (structured type)	No documentation available.
public	t_base_message (structured type)	No documentation available.
public	t_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.
public	t_base_synonym (structured type)	No documentation available.
public	t_base_value (structured type)	No documentation available.
public	t_base_workspace (structured type)	No documentation available.
public	t_bulk_classify_input (structured type)	No documentation available.
public	t_bulk_classify_output (structured type)	No documentation available.
public	t_bulk_classify_response (structured type)	No documentation available.
public	t_bulk_classify_utterance (structured type)	The user input utterance to classify.
public	t_capture_group (structured type)	A recognized capture group for a pattern-based entity.
public	t_channel_transfer_info (structured type)	Information used by an integration to transfer the conversation to a different channel.
public	t_channel_transfer_target (structured type)	An object specifying target channels available for the transfer. Each property of this object represents an available transfer target. Currently, the only supported property is chat, representing the web chat integration.
public	t_channel_transfer_target_chat (structured type)	Information for transferring to the web chat integration.
public	t_context (structured type)	State information for the conversation. To maintain state, include the context from the previous response.
public	t_counterexample (structured type)	No documentation available.
public	t_counterexample_collection (structured type)	No documentation available.
public	t_create_entity (structured type)	No documentation available.
public	t_create_intent (structured type)	No documentation available.
public	t_create_value (structured type)	No documentation available.
public	t_create_workspace (structured type)	No documentation available.
public	t_dialog_node (structured type)	No documentation available.
public	t_dialog_node_action (structured type)	No documentation available.
public	t_dialog_node_collection (structured type)	An array of dialog nodes.
public	t_dialog_node_context (structured type)	The context for the dialog node.
public	t_dialog_node_next_step (structured type)	The next step to execute following this dialog node.
public	t_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).
public	t_dialog_node_output_generic type jsonobject	No documentation available.
public	t_dialog_node_output_modifiers (structured type)	Options that modify how specified output is handled.
public	t_dialog_node_visited_details (structured type)	No documentation available.
public	t_dialog_suggestion (structured type)	No documentation available.
public	t_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. Note: These properties must be included in the request body of the next message sent to the assistant. Do not modify or remove any of the included properties.
public	t_dia_nd_otpt_cnnct_t_agnt_tr1 (structured type)	Routing or other contextual information to be used by target service desk systems.
public	t_dia_nd_otpt_gnrc_dia_nd_ot10 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_ot11 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp1 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp2 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp3 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp4 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp5 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp6 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp7 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp8 (structured type)	No documentation available.
public	t_dia_nd_otpt_gnrc_dia_nd_otp9 (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_type_audio (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_type_iframe (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_type_pause (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_type_video (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_typ_chnnl_1 (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_typ_cnnct_1 (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_typ_srch_s1 (structured type)	No documentation available.
public	t_dia_nd_otpt_resp_typ_usr_df1 (structured type)	No documentation available.
public	t_dia_nd_otpt_text_values_elem (structured type)	No documentation available.
public	t_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.
public	t_dia_nd_output_resp_type_img (structured type)	No documentation available.
public	t_dia_nd_output_resp_type_opt (structured type)	No documentation available.
public	t_dia_nd_output_resp_type_text (structured type)	No documentation available.
public	t_dia_node_output_opt_element (structured type)	No documentation available.
public	t_empty_response type jsonobject	No documentation available.
public	t_entity (structured type)	No documentation available.
public	t_entity_collection (structured type)	An array of objects describing the entities for the workspace.
public	t_entity_mention (structured type)	An object describing a contextual entity mention.
public	t_entity_mention_collection (structured type)	No documentation available.
public	t_error_detail (structured type)	No documentation available.
public	t_error_response (structured type)	No documentation available.
public	t_example (structured type)	No documentation available.
public	t_example_collection (structured type)	No documentation available.
public	t_intent (structured type)	No documentation available.
public	t_intent_collection (structured type)	No documentation available.
public	t_log (structured type)	No documentation available.
public	t_log_collection (structured type)	No documentation available.
public	t_log_message (structured type)	Log message details.
public	t_log_message_source (structured type)	An object that identifies the dialog element that generated the error message.
public	t_log_pagination (structured type)	The pagination data for the returned objects. For more information about using pagination, see [Pagination](#pagination).
public	t_mention (structured type)	A mention of a contextual entity.
public	t_message_context_metadata (structured type)	Metadata related to the message.
public	t_message_input (structured type)	An input object that includes the input text.
public	t_message_request (structured type)	A request sent to the workspace, including the user input and context.
public	t_message_response (structured type)	The response sent by the workspace, including the output text, detected intents and entities, and context.
public	t_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.
public	t_pagination (structured type)	The pagination data for the returned objects. For more information about using pagination, see [Pagination](#pagination).
public	t_response_generic_channel (structured type)	No documentation available.
public	t_rt_entity_interpretation (structured type)	No documentation available.
public	t_rt_entty_intrprttn_sys_date (structured type)	No documentation available.
public	t_rt_entty_intrprttn_sys_num (structured type)	No documentation available.
public	t_rt_entty_intrprttn_sys_time (structured type)	No documentation available.
public	t_rt_response_type_suggestion (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_ad (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_ch1 (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_cn1 (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_if1 (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_img (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_opt (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_ps (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_sg1 (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_txt (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_us1 (structured type)	No documentation available.
public	t_rt_resp_gnrc_rt_resp_typ_vd (structured type)	No documentation available.
public	t_rt_resp_type_channel_trans (structured type)	No documentation available.
public	t_rt_resp_type_user_defined (structured type)	No documentation available.
public	t_rt_resp_typ_connect_to_agent (structured type)	No documentation available.
public	t_runtime_entity (structured type)	A term from the request that was identified as an entity.
public	t_runtime_entity_alternative (structured type)	An alternative value for the recognized entity.
public	t_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.
public	t_runtime_intent (structured type)	An intent identified in the user input.
public	t_runtime_response_generic type jsonobject	No documentation available.
public	t_runtime_response_type_audio (structured type)	No documentation available.
public	t_runtime_response_type_iframe (structured type)	No documentation available.
public	t_runtime_response_type_image (structured type)	No documentation available.
public	t_runtime_response_type_option (structured type)	No documentation available.
public	t_runtime_response_type_pause (structured type)	No documentation available.
public	t_runtime_response_type_text (structured type)	No documentation available.
public	t_runtime_response_type_video (structured type)	No documentation available.
public	t_status_error (structured type)	An object describing an error that occurred during processing of an asynchronous operation.
public	t_synonym (structured type)	No documentation available.
public	t_synonym_collection (structured type)	No documentation available.
public	t_system_response type jsonobject	For internal use only.
public	t_update_counterexample (structured type)	No documentation available.
public	t_update_dialog_node (structured type)	No documentation available.
public	t_update_entity (structured type)	No documentation available.
public	t_update_example (structured type)	No documentation available.
public	t_update_intent (structured type)	No documentation available.
public	t_update_synonym (structured type)	No documentation available.
public	t_update_value (structured type)	No documentation available.
public	t_update_workspace (structured type)	No documentation available.
public	t_value (structured type)	No documentation available.
public	t_value_collection (structured type)	No documentation available.
public	t_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.
public	t_webhook_header (structured type)	A key/value pair defining an HTTP header and a value.
public	t_workspace (structured type)	No documentation available.
public	t_workspace_collection (structured type)	No documentation available.
public	t_workspace_counts (structured type)	An object containing properties that indicate how many intents, entities, and dialog nodes are defined in the workspace. This property is included only in responses from the Export workspace asynchronously method, and only when the verbose query parameter is set to `true`.
public	t_workspace_reference (structured type)	No documentation available.
public	t_workspace_system_settings (structured type)	Global settings for the workspace.
public	t_ws_system_settings_nlp (structured type)	Workspace settings related to the version of the training algorithms currently used by the skill.
public	t_ws_system_settings_off_topic (structured type)	Workspace settings related to detection of irrelevant input.
public	t_ws_system_settings_tooling (structured type)	Workspace settings related to the Watson Assistant user interface.
public	t_ws_systm_settings_auto_learn type jsonobject	For internal use only.
public	t_ws_systm_sttngs_dsmbgtn (structured type)	Workspace settings related to the disambiguation feature.
public	t_ws_systm_sttngs_systm_entts (structured type)	Workspace settings related to the behavior of system entities.

Constants

Visibility and Level	Name	Documentation
public static	c_abapname_dictionary (structured type)	Map ABAP identifiers to service identifiers.
public static	c_required_fields (structured type)	List of required fields per type.

Methods

Visibility and Level

Name

Documentation

public instance

bulk_classify
importing	i_workspace_id	type string
	i_request	type t_bulk_classify_input optional
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_bulk_classify_response
raising	zcx_ibmc_service_exception

Identify intents and entities in multiple user utterances

Send multiple user inputs to a workspace in a single request and receive information about the intents and entities recognized in each input. This method is useful for testing and comparing the performance of different workspaces.

This method is available only with Enterprise with Data Isolation plans.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_request	An input object that includes the text to classify.
e_response	Service return value of type T_BULK_CLASSIFY_RESPONSE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_counterexample
importing	i_workspace_id	type string
	i_body	type t_counterexample
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_counterexample
raising	zcx_ibmc_service_exception

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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_body	The content of the new counterexample.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_COUNTEREXAMPLE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_dialog_node
importing	i_workspace_id	type string
	i_body	type t_dialog_node
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_dialog_node
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_body	A CreateDialogNode object defining the content of the new dialog node.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_DIALOG_NODE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_entity
importing	i_workspace_id	type string
	i_body	type t_create_entity
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_entity
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_body	The content of the new entity.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_ENTITY

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_example
importing	i_workspace_id	type string
	i_intent	type string
	i_body	type t_example
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_example
raising	zcx_ibmc_service_exception

Create user input example

Add a new user input example to an intent.

If you want to add multiple examples with a single API call, consider using the **[Update intent](#update-intent)** method instead.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_body	The content of the new user input example.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_EXAMPLE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_intent
importing	i_workspace_id	type string
	i_body	type t_create_intent
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_intent
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_body	The content of the new intent.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_INTENT

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_synonym
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_body	type t_synonym
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_synonym
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_body	The new synonym.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_SYNONYM

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_value
importing	i_workspace_id	type string
	i_entity	type string
	i_body	type t_create_value
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_value
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_body	The new entity value.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_VALUE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_workspace
importing	i_body	type t_create_workspace optional
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace
raising	zcx_ibmc_service_exception

Create workspace

Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace.

**Note:** The new workspace data cannot be larger than 1.5 MB. For larger requests, use the **Create workspace asynchronously** method.

Parameters

i_body	No documentation available.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_WORKSPACE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

create_workspace_async
importing	i_body	type t_create_workspace optional
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace
raising	zcx_ibmc_service_exception

Create workspace asynchronously

Create a workspace asynchronously based on component objects. You must provide workspace components defining the content of the new workspace.

A successful call to this method only initiates asynchronous creation of the workspace. The new workspace is not available until processing completes. To check the status of the asynchronous operation, use the **Get information about a workspace** method.

Parameters

i_body	No documentation available.
e_response	Service return value of type T_WORKSPACE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_counterexample
importing	i_workspace_id	type string
	i_text	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete counterexample

Delete a counterexample from a workspace. Counterexamples are examples that have been marked as irrelevant input.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_text	The text of a user input counterexample (for example, `What are you wearing?`).

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_dialog_node
importing	i_workspace_id	type string
	i_dialog_node	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete dialog node

Delete a dialog node from a workspace.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_dialog_node	The dialog node ID (for example, `node_1_1479323581900`).

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_entity
importing	i_workspace_id	type string
	i_entity	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete entity

Delete an entity from a workspace, or disable a system entity.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_example
importing	i_workspace_id	type string
	i_intent	type string
	i_text	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete user input example

Delete a user input example from an intent.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_text	The text of the user input example.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_intent
importing	i_workspace_id	type string
	i_intent	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete intent

Delete an intent from a workspace.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_synonym
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_synonym	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete entity value synonym

Delete a synonym from an entity value.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_synonym	The text of the synonym.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_user_data
importing	i_customer_id	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete labeled data

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.

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

**Note:** This operation is intended only for deleting data associated with a single specific customer, not for deleting data associated with multiple customers or for any other purpose. For more information, see [Labeling and deleting data in Watson Assistant](https://cloud.ibm.com/docs/assistant?topic=assistant-information-sec urity#information-security-gdpr-wa).

Parameters

i_customer_id

The customer ID for which all data is to be deleted.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_value
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete entity value

Delete a value from an entity.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

delete_workspace
importing	i_workspace_id	type string
	i_accept	type string default 'application/json'
raising	zcx_ibmc_service_exception

Delete workspace

Delete a workspace from the service instance.

Parameters

i_workspace_id

Unique identifier of the workspace.

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

export_workspace_async
importing	i_workspace_id	type string
	i_include_audit	type boolean default c_boolean_false
	i_sort	type string optional
	i_verbose	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace
raising	zcx_ibmc_service_exception

Export workspace asynchronously

Export the entire workspace asynchronously, including all workspace content.

A successful call to this method only initiates an asynchronous export. The exported JSON data is not available until processing completes. After the initial request is submitted, you can continue to poll by calling the same request again and checking the value of the **status** property. When processing has completed, the request returns the exported JSON data. Remember that the usual rate limits apply.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
i_sort	Indicates how the returned workspace data will be sorted. Specify `sort=stable` to sort all workspace objects by unique identifier, in ascending alphabetical order.
i_verbose	Whether the response should include the `counts` property, which indicates how many of each component (such as intents and entities) the workspace contains.
e_response	Service return value of type T_WORKSPACE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_appname redefinition

public instance

get_counterexample
importing	i_workspace_id	type string
	i_text	type string
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_counterexample
raising	zcx_ibmc_service_exception

Get counterexample

Get information about a counterexample. Counterexamples are examples that have been marked as irrelevant input.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_text	The text of a user input counterexample (for example, `What are you wearing?`).
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_COUNTEREXAMPLE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_dialog_node
importing	i_workspace_id	type string
	i_dialog_node	type string
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_dialog_node
raising	zcx_ibmc_service_exception

Get dialog node

Get information about a dialog node.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_dialog_node	The dialog node ID (for example, `node_1_1479323581900`).
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_DIALOG_NODE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_entity
importing	i_workspace_id	type string
	i_entity	type string
	i_export	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_entity
raising	zcx_ibmc_service_exception

Get entity

Get information about an entity, optionally including all entity content.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_ENTITY

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_example
importing	i_workspace_id	type string
	i_intent	type string
	i_text	type string
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_example
raising	zcx_ibmc_service_exception

Get user input example

Get information about a user input example.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_text	The text of the user input example.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_EXAMPLE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_intent
importing	i_workspace_id	type string
	i_intent	type string
	i_export	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_intent
raising	zcx_ibmc_service_exception

Get intent

Get information about an intent, optionally including all intent content.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_INTENT

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_request_prop redefinition

public instance

get_sdk_version_date redefinition

public instance

get_synonym
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_synonym	type string
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_synonym
raising	zcx_ibmc_service_exception

Get entity value synonym

Get information about a synonym of an entity value.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_synonym	The text of the synonym.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_SYNONYM

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_value
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_export	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_value
raising	zcx_ibmc_service_exception

Get entity value

Get information about an entity value.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_VALUE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

get_workspace
importing	i_workspace_id	type string
	i_export	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_sort	type string optional
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace
raising	zcx_ibmc_service_exception

Get information about a workspace

Get information about a workspace, optionally including all workspace content.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
i_sort	Indicates how the returned workspace data will be sorted. This parameter is valid only if export=`true`. Specify `sort=stable` to sort all workspace objects by unique identifier, in ascending alphabetical order.
e_response	Service return value of type T_WORKSPACE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_all_logs
importing	i_filter	type string
	i_sort	type string optional
	i_page_limit	type integer default 100
	i_cursor	type string optional
	i_accept	type string default 'application/json'
exporting	e_response	type t_log_collection
raising	zcx_ibmc_service_exception

List log events in all workspaces

List the events from the logs of all workspaces in the service instance.

**Note:** If you use the **cursor** parameter to retrieve results one page at a time, subsequent requests must be no more than 5 minutes apart. Any returned value for the **cursor** parameter becomes invalid after 5 minutes. For more information about using pagination, see [Pagination](#pagination).

Parameters

i_filter	A cacheable parameter that limits the results to those matching the specified filter. You must specify a filter query that includes a value for `language`, as well as a value for `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. These required filters must be specified using the exact match (`::`) operator. For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-ref erence#filter-reference).
i_sort	How to sort the returned log events. You can sort by request_timestamp. To reverse the sort order, prefix the parameter value with a minus sign (`-`).
i_page_limit	The number of records to return in each page of results.
i_cursor	A token identifying the page of results to retrieve.
e_response	Service return value of type T_LOG_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_counterexamples
importing	i_workspace_id	type string
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_counterexample_collection
raising	zcx_ibmc_service_exception

List counterexamples

List the counterexamples for a workspace. Counterexamples are examples that have been marked as irrelevant input.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned counterexamples will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_COUNTEREXAMPLE_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_dialog_nodes
importing	i_workspace_id	type string
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_dialog_node_collection
raising	zcx_ibmc_service_exception

List dialog nodes

List the dialog nodes for a workspace.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned dialog nodes will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_DIALOG_NODE_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_entities
importing	i_workspace_id	type string
	i_export	type boolean default c_boolean_false
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_entity_collection
raising	zcx_ibmc_service_exception

List entities

List the entities for a workspace.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned entities will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_ENTITY_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_examples
importing	i_workspace_id	type string
	i_intent	type string
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_example_collection
raising	zcx_ibmc_service_exception

List user input examples

List the user input examples for an intent, optionally including contextual entity mentions.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned examples will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_EXAMPLE_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_intents
importing	i_workspace_id	type string
	i_export	type boolean default c_boolean_false
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_intent_collection
raising	zcx_ibmc_service_exception

List intents

List the intents for a workspace.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned intents will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_INTENT_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_logs
importing	i_workspace_id	type string
	i_sort	type string optional
	i_filter	type string optional
	i_page_limit	type integer default 100
	i_cursor	type string optional
	i_accept	type string default 'application/json'
exporting	e_response	type t_log_collection
raising	zcx_ibmc_service_exception

List log events in a workspace

List the events from the log of a specific workspace.

This method requires Manager access.

**Note:** If you use the **cursor** parameter to retrieve results one page at a time, subsequent requests must be no more than 5 minutes apart. Any returned value for the **cursor** parameter becomes invalid after 5 minutes. For more information about using pagination, see [Pagination](#pagination).

Parameters

i_workspace_id	Unique identifier of the workspace.
i_sort	How to sort the returned log events. You can sort by request_timestamp. To reverse the sort order, prefix the parameter value with a minus sign (`-`).
i_filter	A cacheable parameter that limits the results to those matching the specified filter. For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-ref erence#filter-reference).
i_page_limit	The number of records to return in each page of results.
i_cursor	A token identifying the page of results to retrieve.
e_response	Service return value of type T_LOG_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_mentions
importing	i_workspace_id	type string
	i_entity	type string
	i_export	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_entity_mention_collection
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_ENTITY_MENTION_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_synonyms
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_synonym_collection
raising	zcx_ibmc_service_exception

List entity value synonyms

List the synonyms for an entity value.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned entity value synonyms will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_SYNONYM_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_values
importing	i_workspace_id	type string
	i_entity	type string
	i_export	type boolean default c_boolean_false
	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_value_collection
raising	zcx_ibmc_service_exception

List entity values

List the values for an entity.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_export	Whether to include all element content in the returned data. If export=`false`, the returned data includes only information about the element itself. If export=`true`, all content, including subelements, is included.
i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned entity values will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_VALUE_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

list_workspaces
importing	i_page_limit	type integer default 100
	i_include_count	type boolean default c_boolean_false
	i_sort	type string optional
	i_cursor	type string optional
	i_include_audit	type boolean default c_boolean_false
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace_collection
raising	zcx_ibmc_service_exception

List workspaces

List the workspaces associated with a Watson Assistant service instance.

Parameters

i_page_limit	The number of records to return in each page of results.
i_include_count	Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
i_sort	The attribute by which returned workspaces will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
i_cursor	A token identifying the page of results to retrieve.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_WORKSPACE_COLLECTION

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

message
importing	i_workspace_id	type string
	i_body	type t_message_request optional
	i_nodes_visited_details	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_message_response
raising	zcx_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).

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

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_counterexample
importing	i_workspace_id	type string
	i_text	type string
	i_body	type t_update_counterexample
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_counterexample
raising	zcx_ibmc_service_exception

Update counterexample

Update the text of a counterexample. Counterexamples are examples that have been marked as irrelevant input.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_text	The text of a user input counterexample (for example, `What are you wearing?`).
i_body	The text of the counterexample.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_COUNTEREXAMPLE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_dialog_node
importing	i_workspace_id	type string
	i_dialog_node	type string
	i_body	type t_update_dialog_node
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_dialog_node
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_dialog_node	The dialog node ID (for example, `node_1_1479323581900`).
i_body	The updated content of the dialog node. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are also included in the new data.) For example, if you update the actions for a dialog node, the previously existing actions are discarded and replaced with the new actions specified in the update.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_DIALOG_NODE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_entity
importing	i_workspace_id	type string
	i_entity	type string
	i_body	type t_update_entity
	i_append	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_entity
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_body	The updated content of the entity. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are also included in the new data.) For example, if you update the values for an entity, the previously existing values are discarded and replaced with the new values specified in the update.
i_append	Whether the new data is to be appended to the existing data in the entity. If append=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the entity includes values and append=`false`, all existing values for the entity are discarded and replaced with the new values. If append=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_ENTITY

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_example
importing	i_workspace_id	type string
	i_intent	type string
	i_text	type string
	i_body	type t_update_example
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_example
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_text	The text of the user input example.
i_body	The new text of the user input example.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_EXAMPLE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_intent
importing	i_workspace_id	type string
	i_intent	type string
	i_body	type t_update_intent
	i_append	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_intent
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_intent	The intent name.
i_body	The updated content of the intent. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are also included in the new data.) For example, if you update the user input examples for an intent, the previously existing examples are discarded and replaced with the new examples specified in the update.
i_append	Whether the new data is to be appended to the existing data in the object. If append=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the intent includes examples and append=`false`, all existing examples for the intent are discarded and replaced with the new examples. If append=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_INTENT

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_synonym
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_synonym	type string
	i_body	type t_update_synonym
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_synonym
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_synonym	The text of the synonym.
i_body	The updated entity value synonym.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_SYNONYM

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_value
importing	i_workspace_id	type string
	i_entity	type string
	i_value	type string
	i_body	type t_update_value
	i_append	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_value
raising	zcx_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.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_entity	The name of the entity.
i_value	The text of the entity value.
i_body	The updated content of the entity value. Any elements included in the new data will completely replace the equivalent existing elements, including all subelements. (Previously existing subelements are not retained unless they are also included in the new data.) For example, if you update the synonyms for an entity value, the previously existing synonyms are discarded and replaced with the new synonyms specified in the update.
i_append	Whether the new data is to be appended to the existing data in the entity value. If append=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the entity value includes synonyms and append=`false`, all existing synonyms for the entity value are discarded and replaced with the new synonyms. If append=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_VALUE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_workspace
importing	i_workspace_id	type string
	i_body	type t_update_workspace optional
	i_append	type boolean default c_boolean_false
	i_include_audit	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace
raising	zcx_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.

**Note:** The new workspace data cannot be larger than 1.5 MB. For larger requests, use the **Update workspace asynchronously** method.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_body	Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider importing components such as intents and entities using separate operations.
i_append	Whether the new data is to be appended to the existing data in the object. If append=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for a workspace includes entities and append=`false`, all existing entities in the workspace are discarded and replaced with the new entities. If append=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.
i_include_audit	Whether to include the audit properties (`created` and `updated` timestamps) in the response.
e_response	Service return value of type T_WORKSPACE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.

public instance

update_workspace_async
importing	i_workspace_id	type string
	i_body	type t_update_workspace optional
	i_append	type boolean default c_boolean_false
	i_contenttype	type string default 'application/json'
	i_accept	type string default 'application/json'
exporting	e_response	type t_workspace
raising	zcx_ibmc_service_exception

Update workspace asynchronously

Update an existing workspace asynchronously with new or modified data. You must provide component objects defining the content of the updated workspace.

A successful call to this method only initiates an asynchronous update of the workspace. The updated workspace is not available until processing completes. To check the status of the asynchronous operation, use the **Get information about a workspace** method.

Parameters

i_workspace_id	Unique identifier of the workspace.
i_body	Valid data defining the new and updated workspace content. The maximum size for this data is 50MB. If you need to import a larger amount of workspace data, consider importing components such as intents and entities using separate operations.
i_append	Whether the new data is to be appended to the existing data in the object. If append=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for a workspace includes entities and append=`false`, all existing entities in the workspace are discarded and replaced with the new entities. If append=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.
e_response	Service return value of type T_WORKSPACE

Class-based Exceptions

zcx_ibmc_service_exception

Exception being raised in case of an error.