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

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Document

Returns a new instance of GoogleCloudDialogflowV2beta1Document.



2802
2803
2804
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2802

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) 


2758
2759
2760
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2758

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://<bucket-name>/<object-name>. 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) 


2769
2770
2771
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2769

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) 


2775
2776
2777
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2775

def display_name
  @display_name
end

#knowledge_types ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2780
2781
2782
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2780

def knowledge_types
  @knowledge_types
end

#mime_type ⇒ String

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

Returns:

  • (String) 


2785
2786
2787
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2785

def mime_type
  @mime_type
end

#name ⇒ String

The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>. Corresponds to the JSON property name

Returns:

  • (String) 


2793
2794
2795
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2793

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) 


2800
2801
2802
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2800

def raw_content
  @raw_content
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2807
2808
2809
2810
2811
2812
2813
2814
2815
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2807

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