OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

319
google_dialogflow2_cli/projects_agent-knowledge-bases-documents-patch/index.html
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Agent Knowledge Bases Documents Patch - Dialogflow v2.0.4+20210329</title>
<title>Agent Knowledge Bases Documents Patch - 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>
@@ -378,6 +403,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>
@@ -388,6 +438,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>
@@ -413,6 +523,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>
@@ -473,6 +588,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>
@@ -503,11 +623,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>
@@ -588,11 +718,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>
@@ -788,6 +948,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>
@@ -798,6 +983,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>
@@ -823,6 +1083,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>
@@ -883,11 +1148,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>
@@ -913,11 +1188,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>
@@ -948,6 +1233,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>Updates the specified document. Operation </p>
<p>Updates the specified document. This method is a <a href="https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation">long-running operation</a>. The returned <code>Operation</code> type has the following method-specific fields: - <code>metadata</code>: KnowledgeOperationMetadata - <code>response</code>: Document</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>
@@ -1058,12 +1348,13 @@ In the latter case it is advised to set the field-cursor to the data-structure's
mime-type: string
name: string
raw-content: string
state: string
</code></pre>
<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 . content-uri=sadipscing</code><ul>
<li><code>-r . content-uri=dolores</code><ul>
<li>The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form <code>gs:///</code>. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the <code>gs://</code> format URI described above.</li>
</ul>
</li>
@@ -1075,46 +1366,50 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<li>Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don&#39;t try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see <code>source</code> field for the source types. Reload status can be tracked in <code>latest_reload_status</code>. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling <code>ReloadDocument</code> and clear the errors.</li>
</ul>
</li>
<li><code>knowledge-types=amet</code><ul>
<li><code>knowledge-types=sea</code><ul>
<li>Required. The knowledge type of document content.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>latest-reload-status.status code=44</code><ul>
<li><code>latest-reload-status.status code=42</code><ul>
<li>The status code, which should be an enum value of google.rpc.Code.</li>
</ul>
</li>
<li>
<p><code>message=et</code></p>
<p><code>message=lorem</code></p>
<ul>
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
</ul>
</li>
<li>
<p><code>.. time=sea</code></p>
<p><code>.. time=et</code></p>
<ul>
<li>The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.</li>
</ul>
</li>
<li>
<p><code>.. metadata=key=consetetur</code></p>
<p><code>.. metadata=key=at</code></p>
<ul>
<li>Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document&#39;s title, an external URL distinct from the document&#39;s content_uri, etc. The max size of a <code>key</code> or a <code>value</code> of the metadata is 1024 bytes.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>mime-type=consetetur</code><ul>
<li><code>mime-type=dolor</code><ul>
<li>Required. The MIME type of this document.</li>
</ul>
</li>
<li><code>name=stet</code><ul>
<li><code>name=et</code><ul>
<li>Optional. The document resource name. The name must be empty when creating a document. Format: <code>projects//locations//knowledgeBases//documents/</code>.</li>
</ul>
</li>
<li><code>raw-content=est</code><ul>
<li><code>raw-content=sit</code><ul>
<li>The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.</li>
</ul>
</li>
<li><code>state=erat</code><ul>
<li>Output only. The current state of the document.</li>
</ul>
</li>
</ul>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>