Update documentation

This commit is contained in:
Sebastian Thiel
2022-03-08 15:36:16 +08:00
parent b84384c010
commit a20241b241
10471 changed files with 1934132 additions and 64947 deletions

View File

@@ -5,7 +5,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Set Agent - Dialogflow v2.0.4+20210329</title>
<title>Set Agent - Dialogflow v3.0.0+20220228</title>
@@ -34,7 +34,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Dialogflow v2.0.4+20210329</a>
<a href=".." class="icon icon-home"> Dialogflow v3.0.0+20220228</a>
</div>
@@ -94,6 +94,26 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-create">Agent Environments Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-delete">Agent Environments Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-get">Agent Environments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-get-history">Agent Environments Get History</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-intents-list">Agent Environments Intents List</a>
@@ -104,6 +124,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-patch">Agent Environments Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-environments-users-sessions-contexts-create">Agent Environments Users Sessions Contexts Create</a>
@@ -354,6 +379,31 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-versions-create">Agent Versions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-versions-delete">Agent Versions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-versions-get">Agent Versions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-versions-list">Agent Versions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_agent-versions-patch">Agent Versions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_answer-records-list">Answer Records List</a>
@@ -364,6 +414,66 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-datasets-get">Conversation Datasets Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-datasets-import-conversation-data">Conversation Datasets Import Conversation Data</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-datasets-list">Conversation Datasets List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-create">Conversation Models Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-delete">Conversation Models Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-deploy">Conversation Models Deploy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-evaluations-get">Conversation Models Evaluations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-evaluations-list">Conversation Models Evaluations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-get">Conversation Models Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-list">Conversation Models List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-models-undeploy">Conversation Models Undeploy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-profiles-clear-suggestion-feature-config">Conversation Profiles Clear Suggestion Feature Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-profiles-create">Conversation Profiles Create</a>
@@ -389,6 +499,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversation-profiles-set-suggestion-feature-config">Conversation Profiles Set Suggestion Feature Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversations-complete">Conversations Complete</a>
@@ -449,6 +564,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_conversations-participants-suggestions-suggest-smart-replies">Conversations Participants Suggestions Suggest Smart Replies</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_delete-agent">Delete Agent</a>
@@ -479,11 +599,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_knowledge-bases-documents-export">Knowledge Bases Documents Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_knowledge-bases-documents-get">Knowledge Bases Documents Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_knowledge-bases-documents-import">Knowledge Bases Documents Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_knowledge-bases-documents-list">Knowledge Bases Documents List</a>
@@ -564,11 +694,41 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-create">Locations Agent Environments Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-delete">Locations Agent Environments Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-get">Locations Agent Environments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-get-history">Locations Agent Environments Get History</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-intents-list">Locations Agent Environments Intents List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-list">Locations Agent Environments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-patch">Locations Agent Environments Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-environments-users-sessions-contexts-create">Locations Agent Environments Users Sessions Contexts Create</a>
@@ -764,6 +924,31 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-versions-create">Locations Agent Versions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-versions-delete">Locations Agent Versions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-versions-get">Locations Agent Versions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-versions-list">Locations Agent Versions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-agent-versions-patch">Locations Agent Versions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-answer-records-list">Locations Answer Records List</a>
@@ -774,6 +959,81 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-datasets-create">Locations Conversation Datasets Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-datasets-delete">Locations Conversation Datasets Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-datasets-get">Locations Conversation Datasets Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-datasets-import-conversation-data">Locations Conversation Datasets Import Conversation Data</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-datasets-list">Locations Conversation Datasets List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-create">Locations Conversation Models Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-delete">Locations Conversation Models Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-deploy">Locations Conversation Models Deploy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-evaluations-create">Locations Conversation Models Evaluations Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-evaluations-get">Locations Conversation Models Evaluations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-evaluations-list">Locations Conversation Models Evaluations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-get">Locations Conversation Models Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-list">Locations Conversation Models List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-models-undeploy">Locations Conversation Models Undeploy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-profiles-clear-suggestion-feature-config">Locations Conversation Profiles Clear Suggestion Feature Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-profiles-create">Locations Conversation Profiles Create</a>
@@ -799,6 +1059,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversation-profiles-set-suggestion-feature-config">Locations Conversation Profiles Set Suggestion Feature Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversations-complete">Locations Conversations Complete</a>
@@ -859,11 +1124,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-conversations-participants-suggestions-suggest-smart-replies">Locations Conversations Participants Suggestions Suggest Smart Replies</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-delete-agent">Locations Delete Agent</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get-agent">Locations Get Agent</a>
@@ -889,11 +1164,21 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-knowledge-bases-documents-export">Locations Knowledge Bases Documents Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-knowledge-bases-documents-get">Locations Knowledge Bases Documents Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-knowledge-bases-documents-import">Locations Knowledge Bases Documents Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-knowledge-bases-documents-list">Locations Knowledge Bases Documents List</a>
@@ -924,6 +1209,11 @@
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
@@ -1024,7 +1314,7 @@
</div>
<div role="main">
<div class="section">
<p>Creates/updates the specified agent.</p>
<p>Creates/updates the specified agent. Note: You should always train an agent prior to sending it queries. See the <a href="https://cloud.google.com/dialogflow/es/docs/training">training documentation</a>.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
@@ -1062,27 +1352,27 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
<ul>
<li><code>-r . api-version=sanctus</code><ul>
<li><code>-r . api-version=et</code><ul>
<li>Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.</li>
</ul>
</li>
<li><code>avatar-uri=gubergren</code><ul>
<li><code>avatar-uri=consetetur</code><ul>
<li>Optional. The URI of the agent&#39;s avatar. Avatars are used throughout the Dialogflow console and in the self-hosted <a href="https://cloud.google.com/dialogflow/docs/integrations/web-demo">Web Demo</a> integration.</li>
</ul>
</li>
<li><code>classification-threshold=0.9651168853874482</code><ul>
<li><code>classification-threshold=0.745954247420243</code><ul>
<li>Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.</li>
</ul>
</li>
<li><code>default-language-code=lorem</code><ul>
<li><code>default-language-code=sadipscing</code><ul>
<li>Required. The default language of the agent as a language tag. See <a href="https://cloud.google.com/dialogflow/docs/reference/language">Language Support</a> for a list of the currently supported language codes. This field cannot be set by the <code>Update</code> method.</li>
</ul>
</li>
<li><code>description=dolor</code><ul>
<li><code>description=stet</code><ul>
<li>Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.</li>
</ul>
</li>
<li><code>display-name=sanctus</code><ul>
<li><code>display-name=et</code><ul>
<li>Required. The name of this agent.</li>
</ul>
</li>
@@ -1090,24 +1380,24 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<li>Optional. Determines whether this agent should log conversation queries.</li>
</ul>
</li>
<li><code>match-mode=amet</code><ul>
<li><code>match-mode=labore</code><ul>
<li>Optional. Determines how intents are detected from user queries.</li>
</ul>
</li>
<li><code>parent=magna</code><ul>
<li><code>parent=stet</code><ul>
<li>Required. The project of this agent. Format: <code>projects/</code>.</li>
</ul>
</li>
<li><code>supported-language-codes=accusam</code><ul>
<li><code>supported-language-codes=dolor</code><ul>
<li>Optional. The list of all languages supported by this agent (except for the <code>default_language_code</code>).</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>tier=lorem</code><ul>
<li><code>tier=sadipscing</code><ul>
<li>Optional. The agent tier. If not specified, TIER_STANDARD is assumed.</li>
</ul>
</li>
<li><code>time-zone=tempor</code><ul>
<li><code>time-zone=duo</code><ul>
<li>Required. The time zone of this agent from the <a href="https://www.iana.org/time-zones">time zone database</a>, e.g., America/New_York, Europe/Paris.</li>
</ul>
</li>