vania-janet/multiturn-rag-retrieval-data huggingface dataset:
FAQs for Delivery Pipeline 

Get answers to frequently asked questions about using Delivery Pipeline.



 How do I pass artifacts between pipeline jobs? 

When a stage runs, the stage's input is passed to each of the jobs in the stage. Each job is given a clean container to run in. As a result, jobs within a stage cannot pass artifacts to each other. To pass artifacts between jobs, separate the jobs into two stages, and use the output from the job in the first stage as input to the second stage.

For more information about pipeline jobs, see [Jobs](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-deliverypipeline_aboutdeliverypipeline_jobs).





 Is there a maximum time limit that my pipeline jobs can run? 

The lengths of Classic pipeline jobs and Tekton pipeline runs are determined by the private worker that the pipeline run occurs on. On IBM Managed workers, this value is 6 hours. On self-managed [Delivery Pipeline Private Workers](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-install-private-workers), the default length of time for a pipeline run is 24 hours.





 How secure are the pipeline secure properties? 

Pipeline secure properties are encrypted by using AES-128, and decrypted immediately before they are passed to your pipeline script. These properties are also masked by using asterisks in the properties user interface and in your pipeline log files. Before data is written to the log file for your pipeline job, it is scanned for exact matches to all of the values in the pipeline secure properties. If a match is found, it is masked by using asterisks. Be careful when you are working with secure properties and log files since only exact matches are masked.





 How do I find information about the environment variables that are used in pipeline jobs? 

For information about the environment properties and resources that are available by default in pipeline environments, see [Environment properties and resources](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-deliverypipeline_environmentdeliverypipeline_environment).
The extension inspector shows detailed information about what data is being sent to and returned from an external API. For details, see [Debugging failures](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-call-extensionextension-debug).

New expression choice for setting a session variable
: Previously, to use an expression to set or modify a variable value, you needed to pick an existing variable or create a new one and select the expression option. Now you can use a new Expression choice to write an expression directly without first picking a variable. For details, see [Storing a value in a session variable](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-manage-infostore-session-variable).

Using the Cloud Object Storage importer to migrate chat logs
: You can use the Cloud Object Storage importer service to migrate your chat logs from one installation of Watson Assistant to another.For more information, see [Using the Cloud Object Storage importer to migrate chat logs](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-cos-importer).





 2 May 2023 

IBM Watson® Assistant Cartridge for IBM Cloud Pak® for Data Version 4.6.5 is available
: Watson Assistant for IBM Cloud Pak® for Data 4.6.5 is compatible with IBM Cloud Pak® for Data Version 4.6. See the [support matrix](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-installinstall-support-matrix) for more details. This release of Watson Assistant for IBM Cloud Pak® for Data includes various fixes and features.

Algorithm version 01-Jun-2022 uses enhanced intent detection by default
: The algorithm version Latest (01-Jun-2022) now uses enhanced intent detection by default. Before this change, some skills that did not include a specific algorithm version selection inadvertently used Previous (01-Jan-2022). You can notice small changes in intent detection behavior when changes are made to an assistant that previously didn't have enhanced intent detection enabled.
* UI
* CLI
* API
* Terraform







 Creating a VPN gateway 

You can create an IBM Cloud VPN for VPC to securely connect your VPC to another private network, such as an on-premises network or another VPC.



 Planning considerations 

Review the following considerations before creating a VPN gateway:



* The VPN gateway is created in the zone that is associated with the subnet that you select. Because the VPN gateway can connect to virtual server instances in this zone only, instances in other zones can't use this VPN gateway to communicate with the other network. For zone fault tolerance, deploy one VPN gateway per zone.
* Make sure that there's enough space in the subnet for the gateway. To ensure VPN management and fail-over functions are able to function properly, create the VPN gateway in a subnet without any other VPC resources to guarantee that there are enough available private IPs for the gateway. A VPN gateway needs four private IP addresses to accommodate high availability and rolling upgrades. Since up to five private IPs in a subnet are reserved, the minimum subnet size that can be used to host a VPN gateway is 16 IPs (prefix /28 or netmask 255.255.255.240).
* If you plan to set a default route (0.0.0.0/0) in a VPC routing table to let egress traffic from your VPC resources pass through a VPN gateway, and you plan to use a route-based VPN, create your VPN gateway in a subnet different from the one associated with the routing table. Otherwise, this default route causes a routing conflict for the VPN gateway and brings the VPN connection down.
* By default, PFS (Perfect Forward Secrecy) is disabled for IBM Cloud VPN for VPC. Some vendors require PFS enablement for Phase 2. Check your vendor instruction and use custom policies if PFS is required.
* IBM Cloud VPN for VPC supports only one route-based VPN per zone per VPC.







 Creating a VPN gateway in the UI 

To create a VPN gateway using the UI:



1.
In addition to the [data source requirements](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-sourcespublic-requirements) for all managed deployments, your SharePoint On Prem data source must meet the following requirements:



* You can connect to a SharePoint 2013, 2016, or 2019 on-premises data source.
* The user ID must have SiteCollection Administrator permission and be able to access all of the sites and lists that they want to crawl.
* The crawler supports Windows New Technology LAN Manager (NTLM) v1 authentication only. It does not support NTLM v2 or Security Assertion Markup Language (SAML) authentication.







 What you need before you begin 

You must have the following information ready. If you don't know it, ask your SharePoint administrator to provide the information or consult the [Microsoft SharePoint developer documentation](https://docs.microsoft.com/en-us/sharepoint/dev/):

Username
: The username to use to connect to the SharePoint On Prem web application that you want to crawl. For example, siteadmin01.

Password
: The password to connect to the SharePoint On Prem web application that you want to crawl. This value is never returned and is only used when credentials are created or modified.

Web Application URL
: The SharePoint web application URL. For example, https://sharepointwebapp.com:8443. If you do not enter a port number, the default value of 80 is used for an HTTP URL and 443 for HTTPS.

Domain
: The domain name of the SharePoint On Prem account. For example, sharepoint.mycointernal.





 Prerequisite step 

Before you can connect to a SharePoint On Prem data source, you must install and configure IBM® Secure Gateway for IBM Cloud®.

For more information, see [Installing IBM Secure Gateway for on-premises data](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-sourcesgatewaypublic).





 Connecting to the data source
If you want to change the configuration of the search result card later, open the search integration again, and make edits. You do not need to save changes as you make them; they are automatically applied. When you are happy with the search results, click Save to finish configuring the search integration.

If you decide you want to connect to a different Discovery service instance or project, open the search integration and click *Edit Discovery Settings. You can choose either a new project from the same instance, or a new instance and project.





 Troubleshooting 

Review this information for help with common tasks.



* Creating a web crawl data collection: Things to know when you create a web crawl data source:



* To increase the number of documents that are available to the data collection, click add a URL group where you can list the URLs for pages that you want to crawl but that are not linked to from the initial seed URL.
* To decrease the number of documents that are available to the data collection, specify a subdomain of the base URL. Or, in the web crawl settings, limit the number of hops that Watson can make from the original page. You can specify subdomains to explicitly exclude from the crawl also.
* If no documents are listed after a few minutes and a page refresh, then make sure that the content you want to ingest is available from the URL's page source. Some web page content is dynamically generated and therefore cannot be crawled.



* Configuring search results for uploaded documents: If you are using a collection of uploaded documents and cannot get the correct search results or the results are not concise enough, consider using Smart Document Understanding when you create the data collection.

You can annotate documents based on text formatting. For example, you can teach Discovery that any text in 28-point bold font is a document title. If you apply this information to the collection when you ingest it, you can later use the title field as the source for the title section of your search result.

You can also use Smart Document Understanding to split up large documents into segments that are easier to search.
With the addition of the word decomposition function, the models now treat all compound word variants as equivalent. This update means you no longer need to add examples of every variant of the compound words to your training data.





 19 January 2021 

The Phone and SMS with Twilio integrations are now generally available!
: For more information, see:



* [Integrating with phone](https://cloud.ibm.com/docs/assistant?topic=assistant-deploy-phone)
* [Integrating with SMS with Twilio](https://cloud.ibm.com/docs/assistant?topic=assistant-deploy-sms)



Preview link change
: When you create a preview link, you can now test your skill from a chat window that is embedded in the page. You can also copy the URL that is provided, and open it in a web browser to see an IBM-branded web page with the web chat embedded in it. You can share the URL to the public IBM web page with others to get help with testing or for demoing purposes. For more information, see [Testing your assistant](https://cloud.ibm.com/docs/assistant?topic=assistant-deploy-web-link).

Import and export UI changes
: The label on buttons for importing skills changed from Import to Upload, and the label on buttons for exporting skills changed from Export to Download.

Coverage metric change
: The coverage metric now looks for nodes that were processed with a node condition that includes the anything_else special condition instead of nodes that are named Anything else. For more information, see [Starting and ending the dialog](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-start).





 15 January 2021 

Use new webhooks to process messages!
: A set of new webhooks is available as a beta feature. You can use the webhooks to perform preprocessing tasks on incoming messages and postprocessing tasks on the corresponding responses. You can use the new log webhook to log each message with an external service.
Using channels is particularly useful in conjunction with the channel_transfer response type. Because the message output is processed both by the channel initiating the transfer and by the target channel, you can use channels to define responses that will only be displayed by one or the other. (For more information, and an example, see [Channel transfer](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-responses-jsondialog-responses-json-channel-transfer).)

To specify the integrations for which a response is intended, include the optional channels array as part of the response object. All response types support the channels array. This array contains one or more objects using the following syntax:

{
"channel": "<channel_name>"
}

The value of <channel_name> can be any of the following strings:



* chat: Web chat
* voice_telephony: Phone
* text_messaging: SMS with Twilio
* slack: Slack
* facebook: Facebook Messenger
* intercom: Intercom
* whatsapp: WhatsApp



The following example shows dialog node output that contains two responses: one intended for the web chat integration and one intended for the Slack and Facebook integrations.

{
"output": {
"generic": [
{
"response_type": "text",
"channels":
{
"channel": "chat"
}
],
"text" : "This output is intended for the <strong>web chat</strong>."
},
{
"response_type": "text",
"channels":
{
"channel": "slack"
},
{
"channel": "facebook"
}
],
"text" : "This output is intended for either Slack or Facebook."
}
]
}
}
Show more

If the channels array is present, it must contain at least one channel object. Any integration that is not listed ignores the response.
Installing the Client 



 Docker 

Docker is a third-party platform that provides a container approach to installing applications quickly and easily with little or no configuration necessary. The Secure Gateway service provides a Docker image to be used after the Docker utility is installed on your workstation. To install Docker see the Docker install web site and follow the instructions for your system.



 Installing and Updating the Client 

Installing and updating the Secure Gateway Client Docker image both use the same command:

docker pull ibmcom/secure-gateway-client





 Starting an interactive client session 

To run the Docker container for IBM Secure Gateway, issue the following command:

docker run -it ibmcom/secure-gateway-client <gateway ID> -t <security token>

Normally it takes two parameters, your Secure Gateway gateway ID and the gateway's security token, both of which are available via the Secure Gateway Dashboard.





 Exposing port for client UI 

To run the Docker container with [client UI](https://cloud.ibm.com/docs/services/SecureGateway?topic=SecureGateway-client-interactingclient-ui), start docker with -p or -P option to expose port 9003, for example:

docker run -it -p 127.0.0.1:9003:9003 ibmcom/secure-gateway-client <gateway ID> -t <security token>

For more information about -p or -P option, see [docker document](https://docs.docker.com/engine/reference/run/expose-incoming-ports)





 Supported Docker Commands 

The Secure Gateway Client only supports the pull and run commands for manipulating the container.

Return to [Getting Started - Adding a Client](https://cloud.ibm.com/docs/services/SecureGateway?topic=SecureGateway-add-client).







 Mac OS X 



 Requirements for running on Mac OS X 

The following pre-requisites are required prior to running the client on Mac OS X.



1. Install Xcode development tools, it is required by some of the node modules on this platform.







 Mac OS X Installation Procedure
However, the user is responsible for provisioning a remote Event Streams instance and managing the replication.

We suggest a tool like Kafka MirrorMaker to replicate data between clusters. For information about how to run MirrorMaker, see [Event Streams kafka-mirrormaker repository](https://github.com/ibm-messaging/event-streams-samples/tree/master/kafka-mirrormaker).

The user is also responsible for the backup of message payload data. Although this data is replicated across multiple Kafka brokers within a cluster, which protects against the majority of failures, this replication does not cover a location-wide failure.

Topic names are backed up by Event Streams, although it is recommended good practice for users to back up topic names and the configuration data for those topics.

If you have configured your Event Streams instance in a Multi-Zone Region, a regional disaster is very unlikely. However, we recommend that users do plan for such circumstances. If a user's instance is no longer available because of a disaster (and a remote DR instance is not already set up), the user should consider configuring a new instance in a new region and restoring their topics and data from backup if available. Applications can then be pointed at the new instance.



Secure Gateway



* What layer of the OSI model does the Secure Gateway service represent?

The Secure Gateway service represents layer 4 of the OSI model.
* What version of TLS does the Secure Gateway service support?

The Secure Gateway service supports TLS version 1.2.
* Why would I disable my gateway or destination?

You might want to disable a destination or gateway for one of the following reasons:



* You create a destination, but you have not set up the security. In this case, you might disable the destination until its security is set up.
* You do not want the service to be available to users because you are making some updates to the service. In this case, you might temporarily disable the necessary gateways and wait for the service to be updated.
* You have set up all your gateways and destinations on the front end, but your backend is still building.
I am making you a reservation for $guests on $date at $time.

![Shows what each slot and the response look like in the tool when filled in as specified.](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/slots-simple-node.png)
7. Click ![Close](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/close.png) to close the node edit view.







 Step 4: Test the dialog 



1. Select the ![Ask Watson](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/ask_watson.png) icon to open the chat pane.
2. Type i want to make a reservation.

The assistant recognizes the #reservation intent, and it responds with the prompt for the first slot, What day would you like to come in?.
3. Type Friday.

The assistant recognizes the value, and uses it to fill the $date context variable for the first slot. It then shows the prompt for the next slot, What time do you want the reservation to be made for?
4. Type 5pm.

The assistant recognizes the value, and uses it to fill the $time context variable for the second slot. It then shows the prompt for the next slot, How many people will be dining?
5. Type 6.

The assistant recognizes the value, and uses it to fill the $guests context variable for the third slot. Now that all of the slots are filled, it shows the node response, OK. I am making you a reservation for 6 on 2017-12-29 at 17:00:00.
Azure DevOps https://azure.com/<your_user_name>/<repo_name>/src/<branch_name>/<folder_name> <br>https://visualstudio.com/<your_user_name>/<repo_name>/src/<branch_name>/<folder_name> 





 How many workspaces do I need? 

To find out how many workspaces you need in IBM Cloud Schematics, look at the microservices that build your app and the environments that you need to develop, test, and publish your microservice.

As a rule of thumb, consider creating separate workspaces for each of your microservices and the environment that you use. For example, if you have a product app that consists of a search, payment, and review microservice component, consider creating a separate workspace for each microservice component and development, staging, and production environment. With separate workspaces for each microservice component and environment, you can develop, deploy, and manage the Terraform configuration files and associated IBM Cloud resources without affecting the resources of other microservices.

Review the following image to see the number of workspaces in IBM Cloud Schematics for an app that consists of three microservices.

Zoom

![Workspace structure for IBM Cloud Schematics](https://cloud.ibm.com/docs-content/v1/content/ba89e173287b28d1453d2a327d8a1f74ae2f1662/schematics/images/workspace-structure.png)

Figure 1. workspace structure for IBM Cloud Schematics

Do not use one workspace to manage an entire staging or production environment. When you deploy all your IBM Cloud resources into a single workspace, it can become difficult for various teams to coordinate updates and manage access for these resources.





 How do I structure my Git repository to map my workspaces?
For more information, see [About](https://cloud.ibm.com/docs/Db2onCloud?topic=Db2onCloud-about).
* How do I generate credentials for my instance?



1. Log into [IBM Cloud](https://cloud.ibm.com).
2. Open your [Resource list](https://cloud.ibm.com/resources).
3. Under Services or Cloud Foundry services, locate your Db2 on Cloud instance and click on the service name.



* Services - This list includes all instances that were created under a resource group or that were migrated into a resource group.
* Cloud Foundry services - This list includes all instances that were created under a Cloud Foundry organization and space, and were not migrated into a resource group.



4. Select the Service credentials tab > New credentials+ > Add in order to generate your service admin credentials.
5. Expand View credentials, which displays your service connectivity information including your admin credentials (username and password).
6. The admin credentials can be used to connect to both Db2 and the web console.



* Now that I've generated credentials, how do I access my Db2 on Cloud instance?

You can access your Db2 on Cloud instance through several methods, including a dedicated web console and a REST API. For more information, see [Interfaces](https://cloud.ibm.com/docs/Db2onCloud?topic=Db2onCloud-interfaces).
* What's managed for me with Db2 on Cloud?

IBM handles all of the software upgrades, operating system updates, and hardware maintenance for your Db2 on Cloud instance. IBM also preconfigures Db2 parameters for optimal performance across transactional workloads, and takes care of encryption and regular backups of your data.

The service includes 24x7 health monitoring of the database and infrastructure. In the event of a hardware or software failure, the service is automatically restarted. Because Db2 on Cloud is a fully-managed SaaS offering, you do not get SSH access or root access to the underlying server hardware, and cannot install additional software.