Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

A knowledge document to be used by a KnowledgeBase. For more information, see the knowledge base guide. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Document

Returns a new instance of GoogleCloudDialogflowV2beta1Document.



12916
12917
12918
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12916

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#content ⇒ String

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

Returns:

  • (String) 


12841
12842
12843
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12841

def content
  @content
end

#content_uri ⇒ String

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

Returns:

  • (String) 


12851
12852
12853
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12851

def content_uri
  @content_uri
end

#display_name ⇒ String

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

Returns:

  • (String) 


12857
12858
12859
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12857

def display_name
  @display_name
end

#enable_auto_reload ⇒ Boolean Also known as: enable_auto_reload?

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. PERMISSION_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

Returns:

  • (Boolean) 


12872
12873
12874
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12872

def enable_auto_reload
  @enable_auto_reload
end

#knowledge_types ⇒ Array<String>

Required. The knowledge type of document content. Corresponds to the JSON property knowledgeTypes

Returns:

  • (Array<String>) 


12878
12879
12880
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12878

def knowledge_types
  @knowledge_types
end

#latest_reload_status ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DocumentReloadStatus

The status of a reload attempt. Corresponds to the JSON property latestReloadStatus

Returns:



12883
12884
12885
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12883

def latest_reload_status
  @latest_reload_status
end

#metadata ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


12891
12892
12893
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12891

def metadata
  @metadata
end

#mime_type ⇒ String

Required. The MIME type of this document. Corresponds to the JSON property mimeType

Returns:

  • (String) 


12896
12897
12898
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12896

def mime_type
  @mime_type
end

#name ⇒ String

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

Returns:

  • (String) 


12902
12903
12904
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12902

def name
  @name
end

#raw_content ⇒ String

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.

Returns:

  • (String) 


12909
12910
12911
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12909

def raw_content
  @raw_content
end

#state ⇒ String

Output only. The current state of the document. Corresponds to the JSON property state

Returns:

  • (String) 


12914
12915
12916
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12914

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 12921

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)
  @state = args[:state] if args.key?(:state)
end