{"__v":0,"_id":"58d90edca176ae2500e14e65","category":{"version":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","_id":"5845a4a89f6fbb1b004307b9","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-30T06:25:25.645Z","from_sync":false,"order":1,"slug":"key-concepts","title":"Key Concepts"},"parentDoc":null,"project":"54d3007669578e0d002730c9","user":"55bf6cdcad601c2b00762d13","version":{"__v":1,"_id":"5845a4a89f6fbb1b004307b7","project":"54d3007669578e0d002730c9","createdAt":"2016-12-05T17:32:24.708Z","releaseDate":"2016-12-05T17:32:24.708Z","categories":["5845a4a89f6fbb1b004307b8","5845a4a89f6fbb1b004307b9","5845a4a89f6fbb1b004307ba","5845a4a89f6fbb1b004307bb","5845a4a89f6fbb1b004307bc","5845a4a89f6fbb1b004307bd","5845a4a89f6fbb1b004307be","5845a4a89f6fbb1b004307bf","5845a4a89f6fbb1b004307c0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"25.0.0","version":"25"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-27T13:08:44.045Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":14,"body":"- [Overview](#overview)\n- [How to Import Prebuilt Agents](#how-to-import-prebuilt-agents)\n- [Prebuilt Agents’ Structure](#prebuilt-agents-structure)\n * [How to Customize Prebuilt Agents](#how-to-customize-prebuilt-agents)\n * [Customize Topics Coverage and Classification Model](#section-customize-topics-coverage-and-classification-model)\n * [Customize Agent’s Responses](#section-customize-agent-s-responses)\n       + [Defining Responses in Intents](#section-defining-responses-in-intents)\n       + [Defining Responses in Your Fulfillment Service](#section-defining-responses-in-your-fulfillment-service)\n[block:api-header]\n{\n  \"title\": \"Overview\"\n}\n[/block]\n**Prebuilt agents** are a collection of <a href=\"https://docs.api.ai/docs/concept-agents\" target=\"_blank\">agents</a> developed by the API.AI team. In the developer console, you can download agents to your account that fit your use case and use them as a base for building a conversational interface for your app, bot, or device.\n\nCurrently, prebuilt agents are available in English, Spanish, French, Japanese, Italian, Portuguese, Brazilian Portuguese, German, Russian, Chinese (Simplified), Chinese (Cantonese), and Chinese (Traditional).\n[block:api-header]\n{\n  \"title\": \"How to Import Prebuilt Agents\"\n}\n[/block]\nIn the developer console, click <a href=\"https://console.api.ai/api-client/#/agent//prebuiltAgents\" target=\"_blank\">‘Prebuilt Agents’</a> in the left hand menu. You can search the agents by keywords related to your desired use case. Click on the card of a specific agent for more information and examples. To import a specific agent to your account, click the ‘IMPORT’ button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/278ebbf-PrebuiltAgentsPanel.jpg\",\n        \"PrebuiltAgentsPanel.jpg\",\n        2054,\n        1381,\n        \"#faf3fa\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Prebuilt Agents Structure\"\n}\n[/block]\nPrebuilt agents are ready to use for user input classification, that is, for transforming user inputs in natural language into <a href=\"https://docs.api.ai/docs/key-concepts#apiai-nlu-and-dialog-management\" target=\"_blank\">actionable data</a>. \n\nAgent <a href=\"https://docs.api.ai/docs/concept-intents#response\" target=\"_blank\">responses</a> are not provided since they either may depend on particular use cases or may need to be retrieved from external sources (from a web service connected to your agent via a webhook or from external APIs or databases connected to your web service). For example, for providing weather forecast for the users, you need to retrieve it from a 3rd party Weather API). Read more about [customizing agent responses](#section-customize-agent-s-responses).\n[block:api-header]\n{\n  \"title\": \"How to Customize Prebuilt Agents\"\n}\n[/block]\nPrebuilt agents are fully customizable, as you’ll have access to edit everything.\n\n## Customize Topics Coverage and Classification Model\n\nPrebuilt agents cover the most popular user inputs. You may want to cover additional topics related to the same area or, on the contrary, cover less user questions. For these purposes, you can add or delete <a href=\"https://docs.api.ai/docs/concept-intents\" target=\"_blank\">intents</a> and <a href=\"https://docs.api.ai/docs/concept-entities\" target=\"_blank\">entities</a>. \n\nYou can copy or move intents and entities between agents, as well as delete intents and entities in bulk mode. For more information, read the respective sections about batch operations with <a href=\"https://docs.api.ai/docs/concept-intents#batch-operations-with-intents\" target=\"_blank\">intents</a> and <a href=\"https://docs.api.ai/docs/concept-entities#batch-operations-with-entities\" target=\"_blank\">entities</a>.\n\n## Customize Agent’s Responses\n\n### Defining Responses in Intents\n\nFor simple use cases, you can define agent <a href=\"https://docs.api.ai/docs/concept-intents#response\" target=\"_blank\">responses</a> directly in intents. If you use our one-click integrations with some messaging platforms (currently, <a href=\"https://docs.api.ai/docs/facebook-integration\" target=\"_blank\">Facebook Messanger</a>, <a href=\"https://docs.api.ai/docs/kik-integration\" target=\"_blank\">Kik</a>, <a href=\"https://docs.api.ai/docs/slack-integration\" target=\"_blank\">Slack</a>, <a href=\"https://docs.api.ai/docs/telegram-integration\" target=\"_blank\">Telegram</a>, and <a href=\"https://docs.api.ai/docs/skype-integration\" target=\"_blank\">Skype</a>), you can define responses not only as text, but as <a href=\"https://docs.api.ai/docs/rich-messages\" target=\"_blank\">Rich Messages</a> as well.\n\n### Defining Responses in Your Fulfillment Service\n\nYou can consider creating your web service and connecting it to your agent via <a href=\"https://docs.api.ai/docs/webhook\" target=\"_blank\">webhook</a>. In your web service, you can define responses based on the actionable data received from your agent, perform operations, and retrieve information from external sources (databases or 3rd-party APIs).\n\nIf you already have your backend service, you may prefer sending <a href=\"https://docs.api.ai/docs/query\" target=\"_blank\">query</a> requests to your agent and defining responses in your business logic. See the <a href=\"https://docs.api.ai/docs/sdks\" target=\"_blank\">list of our SDKs</a> designed for sending query requests and getting responses in different platforms/languages.","excerpt":"","slug":"prebuilt-agents","type":"basic","title":"Prebuilt Agents"}
- [Overview](#overview) - [How to Import Prebuilt Agents](#how-to-import-prebuilt-agents) - [Prebuilt Agents’ Structure](#prebuilt-agents-structure) * [How to Customize Prebuilt Agents](#how-to-customize-prebuilt-agents) * [Customize Topics Coverage and Classification Model](#section-customize-topics-coverage-and-classification-model) * [Customize Agent’s Responses](#section-customize-agent-s-responses) + [Defining Responses in Intents](#section-defining-responses-in-intents) + [Defining Responses in Your Fulfillment Service](#section-defining-responses-in-your-fulfillment-service) [block:api-header] { "title": "Overview" } [/block] **Prebuilt agents** are a collection of <a href="https://docs.api.ai/docs/concept-agents" target="_blank">agents</a> developed by the API.AI team. In the developer console, you can download agents to your account that fit your use case and use them as a base for building a conversational interface for your app, bot, or device. Currently, prebuilt agents are available in English, Spanish, French, Japanese, Italian, Portuguese, Brazilian Portuguese, German, Russian, Chinese (Simplified), Chinese (Cantonese), and Chinese (Traditional). [block:api-header] { "title": "How to Import Prebuilt Agents" } [/block] In the developer console, click <a href="https://console.api.ai/api-client/#/agent//prebuiltAgents" target="_blank">‘Prebuilt Agents’</a> in the left hand menu. You can search the agents by keywords related to your desired use case. Click on the card of a specific agent for more information and examples. To import a specific agent to your account, click the ‘IMPORT’ button. [block:image] { "images": [ { "image": [ "https://files.readme.io/278ebbf-PrebuiltAgentsPanel.jpg", "PrebuiltAgentsPanel.jpg", 2054, 1381, "#faf3fa" ] } ] } [/block] [block:api-header] { "title": "Prebuilt Agents Structure" } [/block] Prebuilt agents are ready to use for user input classification, that is, for transforming user inputs in natural language into <a href="https://docs.api.ai/docs/key-concepts#apiai-nlu-and-dialog-management" target="_blank">actionable data</a>. Agent <a href="https://docs.api.ai/docs/concept-intents#response" target="_blank">responses</a> are not provided since they either may depend on particular use cases or may need to be retrieved from external sources (from a web service connected to your agent via a webhook or from external APIs or databases connected to your web service). For example, for providing weather forecast for the users, you need to retrieve it from a 3rd party Weather API). Read more about [customizing agent responses](#section-customize-agent-s-responses). [block:api-header] { "title": "How to Customize Prebuilt Agents" } [/block] Prebuilt agents are fully customizable, as you’ll have access to edit everything. ## Customize Topics Coverage and Classification Model Prebuilt agents cover the most popular user inputs. You may want to cover additional topics related to the same area or, on the contrary, cover less user questions. For these purposes, you can add or delete <a href="https://docs.api.ai/docs/concept-intents" target="_blank">intents</a> and <a href="https://docs.api.ai/docs/concept-entities" target="_blank">entities</a>. You can copy or move intents and entities between agents, as well as delete intents and entities in bulk mode. For more information, read the respective sections about batch operations with <a href="https://docs.api.ai/docs/concept-intents#batch-operations-with-intents" target="_blank">intents</a> and <a href="https://docs.api.ai/docs/concept-entities#batch-operations-with-entities" target="_blank">entities</a>. ## Customize Agent’s Responses ### Defining Responses in Intents For simple use cases, you can define agent <a href="https://docs.api.ai/docs/concept-intents#response" target="_blank">responses</a> directly in intents. If you use our one-click integrations with some messaging platforms (currently, <a href="https://docs.api.ai/docs/facebook-integration" target="_blank">Facebook Messanger</a>, <a href="https://docs.api.ai/docs/kik-integration" target="_blank">Kik</a>, <a href="https://docs.api.ai/docs/slack-integration" target="_blank">Slack</a>, <a href="https://docs.api.ai/docs/telegram-integration" target="_blank">Telegram</a>, and <a href="https://docs.api.ai/docs/skype-integration" target="_blank">Skype</a>), you can define responses not only as text, but as <a href="https://docs.api.ai/docs/rich-messages" target="_blank">Rich Messages</a> as well. ### Defining Responses in Your Fulfillment Service You can consider creating your web service and connecting it to your agent via <a href="https://docs.api.ai/docs/webhook" target="_blank">webhook</a>. In your web service, you can define responses based on the actionable data received from your agent, perform operations, and retrieve information from external sources (databases or 3rd-party APIs). If you already have your backend service, you may prefer sending <a href="https://docs.api.ai/docs/query" target="_blank">query</a> requests to your agent and defining responses in your business logic. See the <a href="https://docs.api.ai/docs/sdks" target="_blank">list of our SDKs</a> designed for sending query requests and getting responses in different platforms/languages.