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



2289
2290
2291
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2289

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

Instance Attribute Details

#contentString

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)


2245
2246
2247
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2245

def content
  @content
end

#content_uriString

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)


2256
2257
2258
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2256

def content_uri
  @content_uri
end

#display_nameString

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)


2262
2263
2264
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2262

def display_name
  @display_name
end

#knowledge_typesArray<String>

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

Returns:

  • (Array<String>)


2267
2268
2269
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2267

def knowledge_types
  @knowledge_types
end

#mime_typeString

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

Returns:

  • (String)


2272
2273
2274
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2272

def mime_type
  @mime_type
end

#nameString

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)


2280
2281
2282
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2280

def name
  @name
end

#raw_contentString

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)


2287
2288
2289
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2287

def raw_content
  @raw_content
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2294

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