class Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document

A knowledge document to be used by a KnowledgeBase. For more information, see the [knowledge base guide](cloud.google.com/dialogflow/docs/how/ knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.

Attributes

content[RW]

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. Corresponds to the JSON property `content` @return [String]

content_uri[RW]

The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs:///`. 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. Corresponds to the JSON property `contentUri` @return [String]

display_name[RW]

Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails. Corresponds to the JSON property `displayName` @return [String]

enable_auto_reload[RW]

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'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. Corresponds to the JSON property `enableAutoReload` @return [Boolean]

enable_auto_reload?[RW]

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'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. Corresponds to the JSON property `enableAutoReload` @return [Boolean]

knowledge_types[RW]

Required. The knowledge type of document content. Corresponds to the JSON property `knowledgeTypes` @return [Array<String>]

latest_reload_status[RW]

The status of a reload attempt. Corresponds to the JSON property `latestReloadStatus` @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DocumentReloadStatus]

metadata[RW]

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a `key` or a ` value` of the metadata is 1024 bytes. Corresponds to the JSON property `metadata` @return [Hash<String,String>]

mime_type[RW]

Required. The MIME type of this document. Corresponds to the JSON property `mimeType` @return [String]

name[RW]

Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`. Corresponds to the JSON property `name` @return [String]

raw_content[RW]

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Corresponds to the JSON property `rawContent` NOTE: Values are automatically base64 encoded/decoded in the client library. @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dialogflow_v2beta1/classes.rb, line 9011
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dialogflow_v2beta1/classes.rb, line 9016
def update!(**args)
  @content = args[:content] if args.key?(:content)
  @content_uri = args[:content_uri] if args.key?(:content_uri)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_auto_reload = args[:enable_auto_reload] if args.key?(:enable_auto_reload)
  @knowledge_types = args[:knowledge_types] if args.key?(:knowledge_types)
  @latest_reload_status = args[:latest_reload_status] if args.key?(:latest_reload_status)
  @metadata = args[:metadata] if args.key?(:metadata)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @name = args[:name] if args.key?(:name)
  @raw_content = args[:raw_content] if args.key?(:raw_content)
end