<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.knowledgeBases.html">knowledgeBases</a> . <a href="dialogflow_v2beta1.projects.agent.knowledgeBases.documents.html">documents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new document.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified document.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified document.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all documents of the knowledge base.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified document.</p>
<p class="toc_element">
  <code><a href="#reload">reload(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reloads the specified document from its specified source, content_uri or</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.

Args:
  parent: string, Required. The knoweldge base to create a document for.
Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A knowledge document to be used by a KnowledgeBase.
      # 
      # For more information, see the [knowledge base
      # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
      # 
      # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
      # only use `projects.knowledgeBases.documents`.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the document. The name must be 1024 bytes or
        # less; otherwise, the creation request fails.
    &quot;enableAutoReload&quot;: True or False, # 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&#x27;t try
        # to automatically reload the document.
        # 
        # Currently you can only enable automatic reload for documents sourced from
        # a public url, see `source` field for the source types.
        # 
        # Reload status can be tracked in `latest_reload_status`. 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 `ReloadDocument` and clear the
        # errors.
    &quot;latestReloadStatus&quot;: { # The status of a reload attempt. # Output only. The time and status of the latest reload.
        # This reload may have been triggered automatically or manually
        # and may not have succeeded.
      &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
          # different programming environments, including REST APIs and RPC APIs. It is
          # used by [gRPC](https://github.com/grpc). Each `Status` message contains
          # three pieces of data: error code, error message, and error details.
          #
          # You can find out more about this error model and how to work with it in the
          # [API Design Guide](https://cloud.google.com/apis/design/errors).
        &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
        &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
            # message types for APIs to use.
          {
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
          },
        ],
        &quot;message&quot;: &quot;A String&quot;, # 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.
      },
      &quot;time&quot;: &quot;A String&quot;, # Output only. The time of a reload attempt.
          # This reload may have been triggered automatically or manually and may
          # not have succeeded.
    },
    &quot;content&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
        # EXTRACTIVE_QA and FAQ knowledge types.
        # Note: This field is in the process of being deprecated, please use
        # raw_content instead.
    &quot;knowledgeTypes&quot;: [ # Required. The knowledge type of document content.
      &quot;A String&quot;,
    ],
    &quot;contentUri&quot;: &quot;A String&quot;, # The URI where the file content is located.
        # 
        # For documents stored in Google Cloud Storage, these URIs must have
        # the form `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
        # 
        # 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 `gs://` format URI described above.
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The MIME type of this document.
    &quot;name&quot;: &quot;A String&quot;, # Optional. The document resource name.
        # The name must be empty when creating a document.
        # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
        # ID&gt;/documents/&lt;Document ID&gt;`.
    &quot;rawContent&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
        # EXTRACTIVE_QA and FAQ knowledge types.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
    },
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.

Args:
  name: string, Required. The name of the document to delete.
Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
ID&gt;/documents/&lt;Document ID&gt;`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
    },
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.

Args:
  name: string, Required. The name of the document to retrieve.
Format `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
ID&gt;/documents/&lt;Document ID&gt;`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A knowledge document to be used by a KnowledgeBase.
        #
        # For more information, see the [knowledge base
        # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
        #
        # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
        # only use `projects.knowledgeBases.documents`.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the document. The name must be 1024 bytes or
          # less; otherwise, the creation request fails.
      &quot;enableAutoReload&quot;: True or False, # 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&#x27;t try
          # to automatically reload the document.
          #
          # Currently you can only enable automatic reload for documents sourced from
          # a public url, see `source` field for the source types.
          #
          # Reload status can be tracked in `latest_reload_status`. 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 `ReloadDocument` and clear the
          # errors.
      &quot;latestReloadStatus&quot;: { # The status of a reload attempt. # Output only. The time and status of the latest reload.
          # This reload may have been triggered automatically or manually
          # and may not have succeeded.
        &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # 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.
        },
        &quot;time&quot;: &quot;A String&quot;, # Output only. The time of a reload attempt.
            # This reload may have been triggered automatically or manually and may
            # not have succeeded.
      },
      &quot;content&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
          # EXTRACTIVE_QA and FAQ knowledge types.
          # Note: This field is in the process of being deprecated, please use
          # raw_content instead.
      &quot;knowledgeTypes&quot;: [ # Required. The knowledge type of document content.
        &quot;A String&quot;,
      ],
      &quot;contentUri&quot;: &quot;A String&quot;, # The URI where the file content is located.
          #
          # For documents stored in Google Cloud Storage, these URIs must have
          # the form `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
          #
          # 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 `gs://` format URI described above.
      &quot;mimeType&quot;: &quot;A String&quot;, # Required. The MIME type of this document.
      &quot;name&quot;: &quot;A String&quot;, # Optional. The document resource name.
          # The name must be empty when creating a document.
          # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
          # ID&gt;/documents/&lt;Document ID&gt;`.
      &quot;rawContent&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
          # EXTRACTIVE_QA and FAQ knowledge types.
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
  <pre>Returns the list of all documents of the knowledge base.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.

Args:
  parent: string, Required. The knowledge base to list all documents for.
Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base ID&gt;`. (required)
  pageToken: string, The next_page_token value returned from a previous list request.
  pageSize: integer, The maximum number of items to return in a single page. By
default 10 and at most 100.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for Documents.ListDocuments.
    &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
        # more results in the list.
    &quot;documents&quot;: [ # The list of documents.
      { # A knowledge document to be used by a KnowledgeBase.
            #
            # For more information, see the [knowledge base
            # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
            #
            # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
            # only use `projects.knowledgeBases.documents`.
          &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the document. The name must be 1024 bytes or
              # less; otherwise, the creation request fails.
          &quot;enableAutoReload&quot;: True or False, # 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&#x27;t try
              # to automatically reload the document.
              #
              # Currently you can only enable automatic reload for documents sourced from
              # a public url, see `source` field for the source types.
              #
              # Reload status can be tracked in `latest_reload_status`. 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 `ReloadDocument` and clear the
              # errors.
          &quot;latestReloadStatus&quot;: { # The status of a reload attempt. # Output only. The time and status of the latest reload.
              # This reload may have been triggered automatically or manually
              # and may not have succeeded.
            &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
                # different programming environments, including REST APIs and RPC APIs. It is
                # used by [gRPC](https://github.com/grpc). Each `Status` message contains
                # three pieces of data: error code, error message, and error details.
                #
                # You can find out more about this error model and how to work with it in the
                # [API Design Guide](https://cloud.google.com/apis/design/errors).
              &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
              &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
                  # message types for APIs to use.
                {
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
                },
              ],
              &quot;message&quot;: &quot;A String&quot;, # 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.
            },
            &quot;time&quot;: &quot;A String&quot;, # Output only. The time of a reload attempt.
                # This reload may have been triggered automatically or manually and may
                # not have succeeded.
          },
          &quot;content&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
              # EXTRACTIVE_QA and FAQ knowledge types.
              # Note: This field is in the process of being deprecated, please use
              # raw_content instead.
          &quot;knowledgeTypes&quot;: [ # Required. The knowledge type of document content.
            &quot;A String&quot;,
          ],
          &quot;contentUri&quot;: &quot;A String&quot;, # The URI where the file content is located.
              #
              # For documents stored in Google Cloud Storage, these URIs must have
              # the form `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
              #
              # 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 `gs://` format URI described above.
          &quot;mimeType&quot;: &quot;A String&quot;, # Required. The MIME type of this document.
          &quot;name&quot;: &quot;A String&quot;, # Optional. The document resource name.
              # The name must be empty when creating a document.
              # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
              # ID&gt;/documents/&lt;Document ID&gt;`.
          &quot;rawContent&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
              # EXTRACTIVE_QA and FAQ knowledge types.
        },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call &#x27;execute()&#x27; on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the specified document.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.

Args:
  name: string, Optional. The document resource name.
The name must be empty when creating a document.
Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
ID&gt;/documents/&lt;Document ID&gt;`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A knowledge document to be used by a KnowledgeBase.
      # 
      # For more information, see the [knowledge base
      # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
      # 
      # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
      # only use `projects.knowledgeBases.documents`.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the document. The name must be 1024 bytes or
        # less; otherwise, the creation request fails.
    &quot;enableAutoReload&quot;: True or False, # 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&#x27;t try
        # to automatically reload the document.
        # 
        # Currently you can only enable automatic reload for documents sourced from
        # a public url, see `source` field for the source types.
        # 
        # Reload status can be tracked in `latest_reload_status`. 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 `ReloadDocument` and clear the
        # errors.
    &quot;latestReloadStatus&quot;: { # The status of a reload attempt. # Output only. The time and status of the latest reload.
        # This reload may have been triggered automatically or manually
        # and may not have succeeded.
      &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for # Output only. The status of a reload attempt or the initial load.
          # different programming environments, including REST APIs and RPC APIs. It is
          # used by [gRPC](https://github.com/grpc). Each `Status` message contains
          # three pieces of data: error code, error message, and error details.
          #
          # You can find out more about this error model and how to work with it in the
          # [API Design Guide](https://cloud.google.com/apis/design/errors).
        &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
        &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
            # message types for APIs to use.
          {
            &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
          },
        ],
        &quot;message&quot;: &quot;A String&quot;, # 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.
      },
      &quot;time&quot;: &quot;A String&quot;, # Output only. The time of a reload attempt.
          # This reload may have been triggered automatically or manually and may
          # not have succeeded.
    },
    &quot;content&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
        # EXTRACTIVE_QA and FAQ knowledge types.
        # Note: This field is in the process of being deprecated, please use
        # raw_content instead.
    &quot;knowledgeTypes&quot;: [ # Required. The knowledge type of document content.
      &quot;A String&quot;,
    ],
    &quot;contentUri&quot;: &quot;A String&quot;, # The URI where the file content is located.
        # 
        # For documents stored in Google Cloud Storage, these URIs must have
        # the form `gs://&lt;bucket-name&gt;/&lt;object-name&gt;`.
        # 
        # 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 `gs://` format URI described above.
    &quot;mimeType&quot;: &quot;A String&quot;, # Required. The MIME type of this document.
    &quot;name&quot;: &quot;A String&quot;, # Optional. The document resource name.
        # The name must be empty when creating a document.
        # Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
        # ID&gt;/documents/&lt;Document ID&gt;`.
    &quot;rawContent&quot;: &quot;A String&quot;, # The raw content of the document. This field is only permitted for
        # EXTRACTIVE_QA and FAQ knowledge types.
  }

  updateMask: string, Optional. Not specified means `update all`.
Currently, only `display_name` can be updated, an InvalidArgument will be
returned for attempting to update other fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
    },
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

<div class="method">
    <code class="details" id="reload">reload(name, body=None, x__xgafv=None)</code>
  <pre>Reloads the specified document from its specified source, content_uri or
content. The previously loaded content of the document will be deleted.
Note: Even when the content of the document has not changed, there still
may be side effects because of internal implementation changes.

Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
only use `projects.knowledgeBases.documents`.

Args:
  name: string, Required. The name of the document to reload.
Format: `projects/&lt;Project ID&gt;/knowledgeBases/&lt;Knowledge Base
ID&gt;/documents/&lt;Document ID&gt;` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for Documents.ReloadDocument.
    &quot;gcsSource&quot;: { # Google Cloud Storage location for single input. # The path for a Cloud Storage source file for reloading document content.
        # If not provided, the Document&#x27;s existing source will be reloaded.
      &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URIs for the inputs. A URI is of the
          # form:
          #   gs://bucket/object-prefix-or-name
          # Whether a prefix or name is used depends on the use case.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
    },
    &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
  }</pre>
</div>

</body></html>