{"__v":7,"_id":"5845a4a99f6fbb1b004307ee","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":"55a04a395730f40d001104d2","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":["585d757290faf919009fc1a7","585d788def54e30f00e45387","585d78c5dfa3982f00b938ac","58629e46fb01101b00d5349e","5869aff16dab552500c677dc","5869b0085291203700655854","5877b72b511a4e2500f91d43"],"next":{"pages":[],"description":""},"createdAt":"2015-07-30T07:31:19.896Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"* [Agents Overview](#agents-overview)\n* [Agent Settings](#agent-settings)\n * [General](#section-general) \n * [ML Settings](#section-ml-settings)\n    + [Match Mode](#section-match-mode)\n    + [ML Classification Threshold](#section-ml-classification-threshold)\n* [Export and Import](#export-and-import)\n * [Export](#section-export) \n * [Restore](#section-restore)\n * [Import](#section-import)\n* [Export and import to integrate with some known apps](#export-and-import-to-integrate-with-some-known-app)\n * [Alexa](#section-alexa)\n * [Cortana](#section-cortana)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Agents Overview\"\n}\n[/block]\nAgents can be described as NLU (Natural Language Understanding) modules for applications. Their purpose is to transform natural user language into actionable data. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/OwOSbicR5m1LIKRGZI9g_agents_processing.gif\",\n        \"agents_processing.gif\",\n        \"823\",\n        \"371\",\n        \"#a36f4d\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\nThis transformation occurs when a user input matches one of the intents or domains.\n\n<a href=\"https://docs.api.ai/docs/concept-intents\" target=\"_blank\">Intents</a> are developer-defined components of agents, whereas <a href=\"https://docs.api.ai/docs/domains\" target=\"_blank\">domains</a> are pre-defined knowledge packages that can be enabled or disabled in each particular agent. \n\nAgents can be designed to manage a conversation flow in a specific way. This can be done with the help of <a href=\"https://docs.api.ai/docs/concept-contexts\" target=\"_blank\">contexts</a>, <a href=\"https://docs.api.ai/docs/concept-intents#intents-priority\" target=\"_blank\">intent priorities</a>, <a href=\"https://docs.api.ai/docs/dialogs\" target=\"_blank\">slot filling</a>, <a href=\"https://docs.api.ai/docs/concept-intents#response\" target=\"_blank\">responses</a>, and fulfillment in the form of <a href=\"https://docs.api.ai/docs/webhook\" target=\"_blank\">webhook</a>.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Agents are platform agnostic. You only have to design an agent once, and then you can integrate it with a variety of platforms using our <a href=\\\"https://docs.api.ai/docs/sdks\\\" target=\\\"_blank\\\">SDKs</a> and <a href=\\\"https://docs.api.ai/docs/integrations\\\" target=\\\"_blank\\\">Integrations</a>, or download files compatible with your <a href=\\\"https://docs.api.ai/docs/alexa-integration\\\" target=\\\"_blank\\\">Alexa</a> or <a href=\\\"https://docs.api.ai/docs/cortana-integration\\\" target=\\\"_blank\\\">Cortana</a> apps.\"\n}\n[/block]\n**Related topics:**\n\n* <a href=\"https://docs.api.ai/docs/get-started\" target=\"_blank\">How to create an agent</a>\n* <a href=\"https://docs.api.ai/docs/authentication\" target=\"_blank\">Authentication guidelines</a>\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Agent Settings\"\n}\n[/block]\nTo access your agent settings, click the gear button <i class=\"fa fa-cog\"></i> in the API.AI developer console. \n\n## General\n[block:html]\n{\n  \"html\": \"<style>\\n\\n   .cell {\\n     \\tpadding: 1em;\\n    \\n   }\\n  .cell-left {\\n    margin-left: 6px;\\n  }\\n</style>\\n\\n <div class=\\\"row\\\">\\n    <div class=\\\"col-md-3 col-sm-4 col-xs-12 cell cell-left\\\">Language</div>\\n    <div class=\\\"col-md-8 col-sm-6 col-xs-12 cell\\\">See the <a href=\\\"https://docs.api.ai/docs/languages\\\" target=\\\"_blank\\\">list of currently available languages</a>. Note that once the agent is created, you cannot modify its language.</div>   \\n  </div>\\n  <div class=\\\"row\\\">\\n    <div class=\\\"col-md-3 col-sm-4 col-xs-12 cell cell-left\\\">Public / Private</div>\\n    <div class=\\\"col-md-8 col-sm-6 col-xs-12 cell\\\">Public agents may be visible to other API.AI users.</div>   \\n  </div>\\n  <div class=\\\"row\\\">\\n    <div class=\\\"col-md-3 col-sm-4 col-xs-12 cell cell-left\\\">Avatar and Description</div>\\n    <div class=\\\"col-md-8 col-sm-6 col-xs-12 cell\\\">Optional settings. You might want to modify them if you decide to share your <a href=\\\"https://docs.api.ai/docs/agent-demo-page\\\" target=\\\"_blank\\\">agent demo page</a> publicly.</div>   \\n  </div>\\n  <div class=\\\"row\\\">\\n    <div class=\\\"col-md-3 col-sm-4 col-xs-12 cell cell-left\\\">Default Time Zone</div>\\n    <div class=\\\"col-md-8 col-sm-6 col-xs-12 cell\\\">Time zone indicated in your agent settings will be used if no time zone is sent in the API <a href=\\\"https://docs.api.ai/docs/query#query-parameters-and-json-fields\\\" target=\\\"_blank\\\">query requests</a>.</div>   \\n  </div>\\n  <div class=\\\"row\\\">\\n    <div class=\\\"col-md-3 col-sm-4 col-xs-12 cell cell-left\\\">API keys</div>\\n    <div class=\\\"col-md-8 col-sm-6 col-xs-12 cell\\\">Client access token and Developer access token required for sending HTTP requests to the agent. Read more in <a href=\\\"https://docs.api.ai/docs/authentication\\\" target=\\\"_blank\\\">Authentication</a>.</div>   \\n  </div>\"\n}\n[/block]\n## ML Settings\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This feature is currently available for agents in English, German, Spanish, French, Italian, Russian, and Simplified Chinese.\"\n}\n[/block]\n### Match Mode\n\nThis setting defines what algorithms should be used for machine learning classification. It applies to all the intents in which Machine learning is enabled.\n\n* **Hybrid** match mode fits best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.\n* **ML only** match mode can be used for agents with a large number of examples in intents, especially the ones using `:::at:::sys.any`.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fd8849b-ML_match_mode.png\",\n        \"ML_match_mode.png\",\n        2074,\n        692,\n        \"#2a7473\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n### ML Classification Threshold\n\nYou can define a threshold value in the range from 0 to 1 for the parameter `\"score\"` returned in <a href=\"https://docs.api.ai/docs/query#response\" target=\"_blank\">JSON responses to queries</a>. If the returned value is less than the threshold value, then a <a href=\"https://docs.api.ai/docs/concept-intents#fallback-intent\" target=\"_blank\">fallback intent</a> will be triggered or, if there is no fallback intents defined, no intent will be triggered.\n\nNote that fallback intents return `\"score\": 1` and when no intent is triggered, `\"score\": 0` is returned.\n\nTo modify this setting, go to your agent settings > ML Settings > ML Classification Threshold and type in a new threshold value. Click 'Save' and then 'Train' to retrain your agent ML model. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/752c027-ML-threshold.png\",\n        \"ML-threshold.png\",\n        2106,\n        1078,\n        \"#f9f9f9\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Export and Import\"\n}\n[/block]\n##Export\n\nYou can export your entire agent as a ZIP file which will contain some agent settings and all of the intents and entities from your agent in JSON format. To do this, go to your agent settings, select 'Export and Import' from the horizontal menu, and click on the corresponding button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/rk1E4fPzRJOvekWCi10s_agent_export3.png\",\n        \"agent_export3.png\",\n        \"2085\",\n        \"692\",\n        \"#2a9ae2\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\nThe exported `agent.json` file contains the following fields:\n[block:html]\n{\n  \"html\": \"<table>\\n<tr>\\n  <th colspan=\\\"2\\\">Name</th>\\n  <th>Type</th> \\n  <th>Description</th>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">language</td> \\n  <td>String</td>\\n  <td>Agent's <a href=\\\"https://docs.api.ai/docs/languages\\\" target=\\\"_blank\\\">language</a>.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">description</td> \\n  <td>String</td>\\n  <td>Optional agent description for the <a href=\\\"https://docs.api.ai/docs/agent-demo-page\\\" target=\\\"_blank\\\">Agent demo page</a>.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">enabledDomainFeatures</td> \\n  <td>Array</td>\\n  <td>Array of strings corresponding to the enabled <a href=\\\"https://docs.api.ai/docs/domains\\\" target=\\\"_blank\\\">domains</a> and <a href=\\\"https://docs.api.ai/docs/domains#fulfillment\\\" target=\\\"_blank\\\">domain fulfillment</a>.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">defaultTimezone</td> \\n  <td>String</td>\\n  <td>Corresponds to the default time zone set in the agent settings.</td>\\n</tr>\\n<tr>\\n<tr>\\n  <td colspan=\\\"2\\\">isPrivate</td> \\n  <td>Boolean</td>\\n  <td><code>true</code> if the 'Private' option is selected in the agent settings, <code>false</code> if the 'Public' option is selected.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">webhook</td>\\n  <td>Object</td>\\n  <td></td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>url</td>\\n  <td>String</td>\\n  <td>Public URL to the web service connected to the agent via <a href=\\\"https://docs.api.ai/docs/webhook\\\" target=\\\"_blank\\\">webhook</a>.</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>headers</td>\\n  <td>Object</td>\\n  <td>Optional headers.</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>available</td>\\n  <td>Boolean</td>\\n  <td><code>true</code> if webhook is enabled in the agent, <code>false</code> otherwise.</td>\\n</tr>\\n<tr>\\n  <td></td>\\n  <td>useForDomains</td>\\n  <td>Boolean</td>\\n  <td><code>true</code> if the 'Enable webhook for all Domains' option is chosen in the webhook settings, <code>false</code> if the 'Disable webhook for all Domains' option is chosen.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">customClassifierMode</td>\\n  <td>String</td>\\n  <td>Corresponds to the <a href=\\\"https://docs.api.ai/docs/machine-learning-settings#match-mode\\\" target=\\\"_blank\\\">Match mode</a> from the ML Settings.</td>\\n</tr>\\n<tr>\\n  <td colspan=\\\"2\\\">mlMinConfidence</td> \\n  <td>Number</td>\\n  <td>Corresponds to the <a href=\\\"https://docs.api.ai/docs/machine-learning-settings#ml-classification-threshold\\\" target=\\\"_blank\\\">ML Classification Threshold</a>.</td>\\n</tr>\\n</table>\"\n}\n[/block]\n##Restore\n\nYou can replace the current agent version with a new one. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"All the intents and entities in the older version will be **deleted**.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/efXWIJeERvqXaAA4KPw6_agent_restore.png\",\n        \"agent_restore.png\",\n        \"2085\",\n        \"692\",\n        \"#2a9ae2\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\n##Import\n\nYou can upload new intents and entities without deleting the current ones.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"\",\n  \"body\": \"Uploaded intents and entities will **replace** existing intents and entities with the same name.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/qFRPpLkVRA6Ahucu2Mxt_agent-import.png\",\n        \"agent-import.png\",\n        \"2085\",\n        \"692\",\n        \"#2a9ae2\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"When you perform **Restore** or **Import** to a newly created agent, make sure to configure correct settings (language, integration and fulfillment settings etc) in the agent being created.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Export and import to integrate with some known apps\"\n}\n[/block]\n##Alexa\n\nTo export <a href=\"https://docs.api.ai/docs/alexa-integration\" target=\"_blank\">Alexa compatible files</a>, go to Integrations from the left side menu and select Amazon Alexa integration. Then, click on the ‘Export for Alexa’ button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/j6IPFYlpSZKBGfrCgFeK_Alexa-export-settings.png\",\n        \"Alexa-export-settings.png\",\n        \"2062\",\n        \"1375\",\n        \"#289bde\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\n##Cortana\n\nIf you created a <a href=\"https://docs.api.ai/docs/cortana-integration\" target=\"_blank\">Cortana compatible agent</a>, use ‘Export for Cortana’ button to export Cortana compatible VCD files. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/WhvoKZh2ToO4ume61nEk_export-for-cortana.png\",\n        \"export-for-cortana.png\",\n        \"2073\",\n        \"789\",\n        \"#2a9ae2\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\nTo import a Cortana compatible agent, it should be exported as a regular agent. After creating a new agent, go to 'Integrations' from the left side menu and enable Microsoft Cortana integration. Then, in the agent settings, click the ‘Import from zip’ button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7ekWtVaQRu0LQMLgna9K_import-for-Cortana-enable-integration.png\",\n        \"import-for-Cortana-enable-integration.png\",\n        \"2098\",\n        \"1386\",\n        \"#299bdf\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"concept-agents","type":"basic","title":"Agents"}
* [Agents Overview](#agents-overview) * [Agent Settings](#agent-settings) * [General](#section-general) * [ML Settings](#section-ml-settings) + [Match Mode](#section-match-mode) + [ML Classification Threshold](#section-ml-classification-threshold) * [Export and Import](#export-and-import) * [Export](#section-export) * [Restore](#section-restore) * [Import](#section-import) * [Export and import to integrate with some known apps](#export-and-import-to-integrate-with-some-known-app) * [Alexa](#section-alexa) * [Cortana](#section-cortana) [block:api-header] { "type": "basic", "title": "Agents Overview" } [/block] Agents can be described as NLU (Natural Language Understanding) modules for applications. Their purpose is to transform natural user language into actionable data. [block:image] { "images": [ { "image": [ "https://files.readme.io/OwOSbicR5m1LIKRGZI9g_agents_processing.gif", "agents_processing.gif", "823", "371", "#a36f4d", "" ], "sizing": "80" } ] } [/block] This transformation occurs when a user input matches one of the intents or domains. <a href="https://docs.api.ai/docs/concept-intents" target="_blank">Intents</a> are developer-defined components of agents, whereas <a href="https://docs.api.ai/docs/domains" target="_blank">domains</a> are pre-defined knowledge packages that can be enabled or disabled in each particular agent. Agents can be designed to manage a conversation flow in a specific way. This can be done with the help of <a href="https://docs.api.ai/docs/concept-contexts" target="_blank">contexts</a>, <a href="https://docs.api.ai/docs/concept-intents#intents-priority" target="_blank">intent priorities</a>, <a href="https://docs.api.ai/docs/dialogs" target="_blank">slot filling</a>, <a href="https://docs.api.ai/docs/concept-intents#response" target="_blank">responses</a>, and fulfillment in the form of <a href="https://docs.api.ai/docs/webhook" target="_blank">webhook</a>. [block:callout] { "type": "info", "body": "Agents are platform agnostic. You only have to design an agent once, and then you can integrate it with a variety of platforms using our <a href=\"https://docs.api.ai/docs/sdks\" target=\"_blank\">SDKs</a> and <a href=\"https://docs.api.ai/docs/integrations\" target=\"_blank\">Integrations</a>, or download files compatible with your <a href=\"https://docs.api.ai/docs/alexa-integration\" target=\"_blank\">Alexa</a> or <a href=\"https://docs.api.ai/docs/cortana-integration\" target=\"_blank\">Cortana</a> apps." } [/block] **Related topics:** * <a href="https://docs.api.ai/docs/get-started" target="_blank">How to create an agent</a> * <a href="https://docs.api.ai/docs/authentication" target="_blank">Authentication guidelines</a> [block:api-header] { "type": "basic", "title": "Agent Settings" } [/block] To access your agent settings, click the gear button <i class="fa fa-cog"></i> in the API.AI developer console. ## General [block:html] { "html": "<style>\n\n .cell {\n \tpadding: 1em;\n \n }\n .cell-left {\n margin-left: 6px;\n }\n</style>\n\n <div class=\"row\">\n <div class=\"col-md-3 col-sm-4 col-xs-12 cell cell-left\">Language</div>\n <div class=\"col-md-8 col-sm-6 col-xs-12 cell\">See the <a href=\"https://docs.api.ai/docs/languages\" target=\"_blank\">list of currently available languages</a>. Note that once the agent is created, you cannot modify its language.</div> \n </div>\n <div class=\"row\">\n <div class=\"col-md-3 col-sm-4 col-xs-12 cell cell-left\">Public / Private</div>\n <div class=\"col-md-8 col-sm-6 col-xs-12 cell\">Public agents may be visible to other API.AI users.</div> \n </div>\n <div class=\"row\">\n <div class=\"col-md-3 col-sm-4 col-xs-12 cell cell-left\">Avatar and Description</div>\n <div class=\"col-md-8 col-sm-6 col-xs-12 cell\">Optional settings. You might want to modify them if you decide to share your <a href=\"https://docs.api.ai/docs/agent-demo-page\" target=\"_blank\">agent demo page</a> publicly.</div> \n </div>\n <div class=\"row\">\n <div class=\"col-md-3 col-sm-4 col-xs-12 cell cell-left\">Default Time Zone</div>\n <div class=\"col-md-8 col-sm-6 col-xs-12 cell\">Time zone indicated in your agent settings will be used if no time zone is sent in the API <a href=\"https://docs.api.ai/docs/query#query-parameters-and-json-fields\" target=\"_blank\">query requests</a>.</div> \n </div>\n <div class=\"row\">\n <div class=\"col-md-3 col-sm-4 col-xs-12 cell cell-left\">API keys</div>\n <div class=\"col-md-8 col-sm-6 col-xs-12 cell\">Client access token and Developer access token required for sending HTTP requests to the agent. Read more in <a href=\"https://docs.api.ai/docs/authentication\" target=\"_blank\">Authentication</a>.</div> \n </div>" } [/block] ## ML Settings [block:callout] { "type": "info", "body": "This feature is currently available for agents in English, German, Spanish, French, Italian, Russian, and Simplified Chinese." } [/block] ### Match Mode This setting defines what algorithms should be used for machine learning classification. It applies to all the intents in which Machine learning is enabled. * **Hybrid** match mode fits best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities. * **ML only** match mode can be used for agents with a large number of examples in intents, especially the ones using `@sys.any`. [block:image] { "images": [ { "image": [ "https://files.readme.io/fd8849b-ML_match_mode.png", "ML_match_mode.png", 2074, 692, "#2a7473" ], "sizing": "full" } ] } [/block] ### ML Classification Threshold You can define a threshold value in the range from 0 to 1 for the parameter `"score"` returned in <a href="https://docs.api.ai/docs/query#response" target="_blank">JSON responses to queries</a>. If the returned value is less than the threshold value, then a <a href="https://docs.api.ai/docs/concept-intents#fallback-intent" target="_blank">fallback intent</a> will be triggered or, if there is no fallback intents defined, no intent will be triggered. Note that fallback intents return `"score": 1` and when no intent is triggered, `"score": 0` is returned. To modify this setting, go to your agent settings > ML Settings > ML Classification Threshold and type in a new threshold value. Click 'Save' and then 'Train' to retrain your agent ML model. [block:image] { "images": [ { "image": [ "https://files.readme.io/752c027-ML-threshold.png", "ML-threshold.png", 2106, 1078, "#f9f9f9" ], "sizing": "full" } ] } [/block] [block:api-header] { "type": "basic", "title": "Export and Import" } [/block] ##Export You can export your entire agent as a ZIP file which will contain some agent settings and all of the intents and entities from your agent in JSON format. To do this, go to your agent settings, select 'Export and Import' from the horizontal menu, and click on the corresponding button. [block:image] { "images": [ { "image": [ "https://files.readme.io/rk1E4fPzRJOvekWCi10s_agent_export3.png", "agent_export3.png", "2085", "692", "#2a9ae2", "" ], "sizing": "80" } ] } [/block] The exported `agent.json` file contains the following fields: [block:html] { "html": "<table>\n<tr>\n <th colspan=\"2\">Name</th>\n <th>Type</th> \n <th>Description</th>\n</tr>\n<tr>\n <td colspan=\"2\">language</td> \n <td>String</td>\n <td>Agent's <a href=\"https://docs.api.ai/docs/languages\" target=\"_blank\">language</a>.</td>\n</tr>\n<tr>\n <td colspan=\"2\">description</td> \n <td>String</td>\n <td>Optional agent description for the <a href=\"https://docs.api.ai/docs/agent-demo-page\" target=\"_blank\">Agent demo page</a>.</td>\n</tr>\n<tr>\n <td colspan=\"2\">enabledDomainFeatures</td> \n <td>Array</td>\n <td>Array of strings corresponding to the enabled <a href=\"https://docs.api.ai/docs/domains\" target=\"_blank\">domains</a> and <a href=\"https://docs.api.ai/docs/domains#fulfillment\" target=\"_blank\">domain fulfillment</a>.</td>\n</tr>\n<tr>\n <td colspan=\"2\">defaultTimezone</td> \n <td>String</td>\n <td>Corresponds to the default time zone set in the agent settings.</td>\n</tr>\n<tr>\n<tr>\n <td colspan=\"2\">isPrivate</td> \n <td>Boolean</td>\n <td><code>true</code> if the 'Private' option is selected in the agent settings, <code>false</code> if the 'Public' option is selected.</td>\n</tr>\n<tr>\n <td colspan=\"2\">webhook</td>\n <td>Object</td>\n <td></td>\n</tr>\n<tr>\n <td></td>\n <td>url</td>\n <td>String</td>\n <td>Public URL to the web service connected to the agent via <a href=\"https://docs.api.ai/docs/webhook\" target=\"_blank\">webhook</a>.</td>\n</tr>\n<tr>\n <td></td>\n <td>headers</td>\n <td>Object</td>\n <td>Optional headers.</td>\n</tr>\n<tr>\n <td></td>\n <td>available</td>\n <td>Boolean</td>\n <td><code>true</code> if webhook is enabled in the agent, <code>false</code> otherwise.</td>\n</tr>\n<tr>\n <td></td>\n <td>useForDomains</td>\n <td>Boolean</td>\n <td><code>true</code> if the 'Enable webhook for all Domains' option is chosen in the webhook settings, <code>false</code> if the 'Disable webhook for all Domains' option is chosen.</td>\n</tr>\n<tr>\n <td colspan=\"2\">customClassifierMode</td>\n <td>String</td>\n <td>Corresponds to the <a href=\"https://docs.api.ai/docs/machine-learning-settings#match-mode\" target=\"_blank\">Match mode</a> from the ML Settings.</td>\n</tr>\n<tr>\n <td colspan=\"2\">mlMinConfidence</td> \n <td>Number</td>\n <td>Corresponds to the <a href=\"https://docs.api.ai/docs/machine-learning-settings#ml-classification-threshold\" target=\"_blank\">ML Classification Threshold</a>.</td>\n</tr>\n</table>" } [/block] ##Restore You can replace the current agent version with a new one. [block:callout] { "type": "warning", "body": "All the intents and entities in the older version will be **deleted**." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/efXWIJeERvqXaAA4KPw6_agent_restore.png", "agent_restore.png", "2085", "692", "#2a9ae2", "" ], "sizing": "80" } ] } [/block] ##Import You can upload new intents and entities without deleting the current ones. [block:callout] { "type": "warning", "title": "", "body": "Uploaded intents and entities will **replace** existing intents and entities with the same name." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/qFRPpLkVRA6Ahucu2Mxt_agent-import.png", "agent-import.png", "2085", "692", "#2a9ae2", "" ], "sizing": "80" } ] } [/block] [block:callout] { "type": "warning", "body": "When you perform **Restore** or **Import** to a newly created agent, make sure to configure correct settings (language, integration and fulfillment settings etc) in the agent being created." } [/block] [block:api-header] { "type": "basic", "title": "Export and import to integrate with some known apps" } [/block] ##Alexa To export <a href="https://docs.api.ai/docs/alexa-integration" target="_blank">Alexa compatible files</a>, go to Integrations from the left side menu and select Amazon Alexa integration. Then, click on the ‘Export for Alexa’ button. [block:image] { "images": [ { "image": [ "https://files.readme.io/j6IPFYlpSZKBGfrCgFeK_Alexa-export-settings.png", "Alexa-export-settings.png", "2062", "1375", "#289bde", "" ], "sizing": "80" } ] } [/block] ##Cortana If you created a <a href="https://docs.api.ai/docs/cortana-integration" target="_blank">Cortana compatible agent</a>, use ‘Export for Cortana’ button to export Cortana compatible VCD files. [block:image] { "images": [ { "image": [ "https://files.readme.io/WhvoKZh2ToO4ume61nEk_export-for-cortana.png", "export-for-cortana.png", "2073", "789", "#2a9ae2", "" ], "sizing": "80" } ] } [/block] To import a Cortana compatible agent, it should be exported as a regular agent. After creating a new agent, go to 'Integrations' from the left side menu and enable Microsoft Cortana integration. Then, in the agent settings, click the ‘Import from zip’ button. [block:image] { "images": [ { "image": [ "https://files.readme.io/7ekWtVaQRu0LQMLgna9K_import-for-Cortana-enable-integration.png", "import-for-Cortana-enable-integration.png", "2098", "1386", "#299bdf", "" ], "sizing": "80" } ] } [/block]