-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #693 from tommydebisi/tommy
- Loading branch information
Showing
1 changed file
with
223 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,223 @@ | ||
| --- | ||
| title: "Comprehensive Guide to start with IBM watxsonx Assistant" | ||
| description: "Beginner's guide to use watsonx assistant" | ||
| image: "https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/bf604bba-9ee0-4676-0e24-fc93b31a9900/full" | ||
| authorUsername: "EmmanuelIriarte" | ||
| --- | ||
|
|
||
| # Comprehensive Guide to Start with IBM watsonx Assistant | ||
|
|
||
| **IBM watsonx Assistant** is a next-generation conversational AI solution that empowers individuals and organizations to build generative AI assistants effortlessly. These assistants deliver seamless self-service experiences to customers across various devices or channels, boost employee productivity, and scale efficiently across a business. | ||
|
|
||
| In this guide, you will learn how to use watsonx Assistant to build and deploy an intelligent conversational AI assistant solution that simplifies tasks, improves business efficiency, and amplifies productivity. | ||
|
|
||
| ## **Step 1: Setting Up Your IBM Cloud Account** | ||
|
|
||
| To ensure a smooth onboarding process, begin by setting up your IBM Cloud account following these steps: | ||
|
|
||
| 1. **Access Your IBM Cloud Account**: | ||
|
|
||
| - Check the email you used for hackathon registration for an invitation from the IBM Cloud team. | ||
| - If you can’t find the email, search for “IBM Cloud” in your inbox or check your junk/spam folders. | ||
| - Click the **Join Now** button in the email. | ||
|
|
||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/262f8e76-0847-4132-e682-316ed2169000/full" alt="Join IBM cloud" caption="Join IBM cloud" /> | ||
|
|
||
| 2. **Create or Log Into Your Account**: | ||
|
|
||
| - If it’s your first time setting up an IBM Cloud account: | ||
|
|
||
| - Enter a new password, complete your personal information, accept the terms, and click **Continue**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/39ef98ff-9ca3-468b-d483-b9fed517b000/full" alt="First time account set up" caption="First time account set up" /> | ||
|
|
||
| - Acknowledge the creation of your IBMid and click **Join Account**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/c0ec774a-bdca-4058-d460-0d551022ec00/full" alt="Join account" caption="First time joining account" /> | ||
|
|
||
| - For existing IBM Cloud accounts: | ||
| - Simply read and accept the terms and click **Join Account**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/725517d5-7210-4a73-27a8-212821075e00/full" alt="Join account" caption="Existing user joining account" /> | ||
|
|
||
| 3. **Complete Authentication**: | ||
| - Click **Continue** to finish the authentication and gain access to the IBM Cloud dashboard. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/4b9a86bd-5e8f-4ee6-61ec-4cfc5536e000/full" alt="Gaining Access to dashboard" caption="Continue to gain access to dashboard" /> | ||
|
|
||
| **Note**: If you have an existing account, you might be directed to your current dashboard. Ensure you switch to the designated **WatsonX Challenge** or **Watsonx Ecosystem Challenge** account. | ||
|
|
||
| ## **Step 2: Getting Started with IBM watsonx Assistant** | ||
|
|
||
| Now that your IBM Cloud account is set up, follow the steps below to create your first assistant and get started with building your AI solution. | ||
|
|
||
| 1. **Accessing the Service:** | ||
|
|
||
| - Navigate to the Resource list on your IBM Cloud dashboard. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/c33ff406-9dfc-4507-1e0d-1291f9043100/full" alt="Resource list" caption="The Resource list" /> | ||
|
|
||
| - Expand the AI/Machine Learning section and select the pre-configured watsonx-Challenge WA service. | ||
| - Click Launch watsonx Assistant. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/f01fa4e4-9305-48a1-4956-b391f944ae00/full" alt="Launch watsonx Assistant" caption="Launching the watsonx Assistant." /> | ||
|
|
||
| 2. **Creating Your First Assistant:** | ||
|
|
||
| - Enter a name and optional description. | ||
| - Set the language to **English** and click **Next**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/b12dbfd6-7b4d-4815-4fea-d4e6a02a8a00/full" alt="Create first Assistant" caption="Creating your first Assistant" /> | ||
|
|
||
| - Personalize your assistant with display settings such as colors and avatars. | ||
| - Review your setup and click **Create**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/8433a230-f664-47db-403f-1540dc1f7b00/full" alt="Preview Assistant" caption="Preview your Assistant" /> | ||
|
|
||
| - An Assistant will be created, and you will be taken to its home page. Now you are ready to begin building your first assistant. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/c93c37b7-e844-46c5-23f3-a10d2fe35f00/full" alt="First Assistant homepage" caption="First Assistant homepage" /> | ||
|
|
||
| ## **Step 3: Planning Your Assistant** | ||
|
|
||
| With your initial setup complete, it’s time to think strategically. Planning your assistant will help you build a solution that aligns with your goals and user needs.To better understand how to effectively plan your assistant, refer to [this guide](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-plan-assistant). | ||
|
|
||
| Proper planning is essential to ensure that your assistant is well-structured and meets its intended goals. Here’s how to start: Before building your assistant, plan out: | ||
|
|
||
| - **Initial Channel Selection**: Decide which platform or channel your assistant will operate on. | ||
| - **Domain Expertise**: Choose the primary focus (e.g., customer support, HR). | ||
| - **Tone and Language**: Set the communication style. | ||
| - **Content Source Integration**: Identify relevant content sources. | ||
| - **Handoff Strategy**: Plan how interactions will transfer to human agents if needed. | ||
|
|
||
| ## **Step 4: Building Actions and Steps** | ||
|
|
||
| Once you have a plan in place, it’s time to start constructing your assistant by creating actions and steps. These form the foundation of your assistant’s interactions. | ||
|
|
||
| Creating actions and steps is critical to constructing a robust conversation flow. Follow these guidelines to build effectively: | ||
|
|
||
| - **What is an Action?**: A task or problem the assistant helps resolve, like paying a bill or tracking orders. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/9c4508ee-e5bb-4064-9bc1-439f972e1700/full" alt="Action diagram" caption="Action diagram" /> | ||
| - **What is a Step?**: An interaction between the assistant and user, including clarification questions, final responses, and agent handoffs. | ||
|
|
||
| ### **Example Exercise:** | ||
|
|
||
| ### **Building a Billing Use Case** | ||
|
|
||
| 1. **Create Your First Action**: | ||
|
|
||
| - On your assistant's home page, select **Actions** from the left navigation panel. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/99589763-9722-4c0e-ae05-a98a20892b00/full" alt="Select Actions" caption="Select Actions on Assistant Homepage" /> | ||
|
|
||
| - Click the **Create action +** button and choose **Start from scratch**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/f838437a-3776-4439-62cf-a7ab587f6000/full" alt="Create Action" caption="Create your first action" /> | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/58a4f40d-e94a-4b60-f525-2434a51c7300/full" alt="Start from scratch" caption="Start from scratch" /> | ||
|
|
||
| - Train the assistant by entering example phrases such as **“I want to pay my cable bill please”** and save them to help the assistant recognize related topics. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/445abea2-8440-43db-bf87-c07937e7ab00/full" alt="Train assistant" caption="Training assistant" /> | ||
|
|
||
| 2. **Add the First Conversation Step**: | ||
|
|
||
| - Use the pre-created blank step to add a clarification question in the _Assistant says_ text box, like “What type of account are we talking here?”. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/db1e02f1-0aa3-472f-ca1d-50dda9042a00/full" alt="First conversation step" caption="First conversation step" /> | ||
|
|
||
| - Define customer response options (e.g., Cable, Internet, Phone) and apply the changes. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/2727c2bb-e1c0-4b4d-3403-a63ac1afa600/full" alt="Define customer response" caption="Define customer response" /> | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/a75e4bdc-e2ef-467e-9151-c3bddf078400/full" alt="Apply changes" caption="Apply changes" /> | ||
|
|
||
| 3. **Add Conditional Steps**: | ||
|
|
||
| - Create a new step asking for the account number only if the selected option is “Cable”. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/464cd397-43aa-4e3d-6543-ed58eb752600/full" alt="New Step" caption="Create new step" /> | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/36f27870-a306-4f55-fefb-602ba1efac00/full" alt="Configure response" caption="Configure response" /> | ||
|
|
||
| - Set conditions so that this step only appears when Step 1's answer is **“Cable”**. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/15a3d66b-4be4-4fbf-5029-d409adee1700/full" alt="Set conditions" caption="Set conditions" /> | ||
|
|
||
| 4. **Agent Handoff Step**: | ||
|
|
||
| - Add a step saying, **“Let me get you to an agent who can help you pay your cable bill!”** and set it to connect to an agent under specific conditions (e.g., when Step 1 is “Cable”). | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/16c9413f-05d9-4cd3-2789-ed95f44d2700/full" alt="Add agent handoff step" caption="Add agent handoff step" /> | ||
|
|
||
| - Configure the message to the agent to include: “This user wants to pay their cable bill. Account number is `$[variable from Step 2]`”. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/2de92d94-adc7-467d-3d5c-84b6c6422b00/full" alt="Configure agent message" caption="Configuring agent message" /> | ||
|
|
||
| 5. **Handling Internet and Phone Bill Requests**: | ||
|
|
||
| - Create a step with text like, “To pay your bill, you can head to our online portal.” | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/d71bc609-e442-4227-eaef-7578c79b7400/full" alt="Inserting a variable" caption="Inserting a variable" /> | ||
|
|
||
| - Insert a variable for from Step 1 and link to your billing portal. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/e0dc0001-acc4-4030-6ec5-effd467e0f00/full" alt="Adding a link" caption="Adding a link" /> | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/113d59ae-6725-438a-ac4d-b08fc7db7900/full" alt="Insert link" caption="Enter the link to be added" /> | ||
|
|
||
| - Apply conditions to ensure this step triggers when the answer is “Internet” or “Phone”. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/3fc7749c-69e3-48bf-f89b-abf411031000/full" alt="Apply conditions" caption="Applying conditions" /> | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/ad35cfdb-a895-4e83-66cc-99f16fb72900/full" alt="Change from All to Any" caption="Change from All to Any" /> | ||
|
|
||
| - Finally, under And then section, select **Continue** to next step drop down and select End the action option. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/28f59ebd-ce1b-4894-4b0f-60fdffd36600/full" alt="End the action" caption="End the action" /> | ||
|
|
||
| 6. **Testing the Flow**: | ||
|
|
||
| - Preview the conversation flow by using the **Preview** button and simulate different scenarios (e.g., paying a cable bill, selecting Internet). | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/1f654353-ccbd-476b-59bf-ba156d9db400/full" alt="Preview the conversation" caption="Previewing the conversation" /> | ||
|
|
||
| - Add more training examples if the assistant does not recognize initial phrases effectively. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/361051c2-77aa-49e1-363d-af46a7f3e200/full" alt="Add more training examples" caption="Adding more training examples" /> | ||
|
|
||
| ## **Step 5: Visualizing and Reviewing Your Assistant** | ||
|
|
||
| After building your actions, reviewing and visualizing them is crucial. This helps ensure your workflow is logical and meets your project requirements. For more comprehensive details on building and refining your assistant, refer to [this documentation](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-build-actions-overview). | ||
|
|
||
| A visual representation of your assistant’s actions helps in refining and communicating its logic. Here’s how to navigate this feature: | ||
|
|
||
| - Toggle between **Edit** and **Visualization** tabs to see action flows as a flowchart. | ||
| - Use this visualization for better understanding and presentation. | ||
| <Img src="https://imagedelivery.net/K11gkZF3xaVyYzFESMdWIQ/14c60acc-3583-4c7c-06e7-6573204d8c00/full" alt="Visualizing action flow" caption="Visualizing the action flow" /> | ||
|
|
||
| ## **Step 6: Previewing and Customizing** | ||
|
|
||
| Before final deployment, previewing your assistant will help identify areas for improvement and ensure that it aligns with your brand. Customize as needed to perfect the user experience. | ||
|
|
||
| Previewing your assistant allows you to test its functionality and make necessary adjustments. Customize it to align with your brand using these steps: | ||
|
|
||
| - **Preview Your Assistant**: | ||
| - Test functionalities on the **Preview** page. | ||
| - Use options like **Copy [link](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-preview-share#preview-share-link) to share** or **Change [background](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-preview-share#preview-change-background)** to simulate different user experiences. | ||
| - Customize the web chat to align with your brand.For more information on configuring web chat, refer to [this resource](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-web-chat-config). | ||
|
|
||
| ## **Step 7: Publishing and Deploying** | ||
|
|
||
| With your assistant ready and tested, the next step is to publish and deploy it. This ensures your assistant is accessible to your users in the desired channels. | ||
|
|
||
| Once your assistant is built, publishing and deploying it ensures it reaches your target audience. Follow these procedures to manage deployment: | ||
|
|
||
| - **Publishing**: | ||
| - Maintain version control to manage content updates and rollbacks. For more information on publishing, refer to [this guide](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-publish). | ||
| - **Deployment Options**: | ||
| - Deploy on [websites](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-web-chat-overview), mobile apps, or integrate with [phone](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-deploy-phone) systems and [other channels](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-deploy-integration-add). | ||
|
|
||
| ## **Step 8: Analyzing Your Assistant** | ||
|
|
||
| After deployment, continuous analysis is key to maintaining and improving your assistant. This section will guide you on how to effectively monitor and optimize its performance. | ||
|
|
||
| To continuously improve your assistant, analyzing its interactions is vital. Use these insights to enhance user satisfaction and performance: Use the **Analyze** page to track interactions, understand user needs, and identify areas for improvement. For more details on analyzing your assistant, refer to [this resource](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-analytics-overview). | ||
|
|
||
| ## **Conclusion** | ||
|
|
||
| In this comprehensive guide, you have learned how to set up your IBM Cloud account, create your first **watsonx Assistant**, plan and build effective actions and steps, visualize and review your work, and finally, publish, deploy, and analyze your assistant. By following these steps, you can build a robust and responsive assistant tailored to your needs. Remember, continual refinement and analysis will help you maintain a high-quality user experience. | ||
|
|
||
| With these insights, you are now well-equipped to harness the full potential of **IBM watsonx Assistant** and create impactful AI solutions. Good luck with your development journey\! | ||
|
|
||
| ## **Additional Resources** | ||
|
|
||
| To expand your understanding and capabilities with watsonx Assistant, explore these additional resources and tools. | ||
|
|
||
| For further learning and deeper customization, explore these additional resources to boost your assistant’s capabilities: | ||
|
|
||
| - [Building actions from templates](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-actions-templates) | ||
| - [Starting the conversation](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-start-conversation) | ||
| - [Understanding your users’ questions or requests](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-understand-questions) | ||
| - [Boost words](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-boost-words) | ||
| - [Adding assistant responses](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-respond) | ||
| - [Collecting information from your customers](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-collect-info) | ||
| - [Using variables to manage conversation information](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-manage-info) | ||
| - [Adding conditions to an action](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-action-conditions) | ||
| - [Adding conditions to a step](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-step-conditions) | ||
| - [Choosing what to do at the end of a step](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-step-what-next) | ||
| - [Calling a custom extension](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-call-extension) | ||
| - [Saving your actions](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-save-actions) | ||
| - [Reviewing and debugging actions](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-review) | ||
| - [Global settings for actions](https://cloud.ibm.com/docs/watson-assistant?topic=watson-assistant-actions-global-settings) |