Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2KnowledgeBase

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

Overview

A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the knowledge base guide. Note: The projects.agent.knowledgeBases resource is deprecated; only use projects.knowledgeBases.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2KnowledgeBase

Returns a new instance of GoogleCloudDialogflowV2KnowledgeBase.



10237
10238
10239
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 10237

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

Instance Attribute Details

#display_nameString

Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails. Corresponds to the JSON property displayName

Returns:

  • (String)


10222
10223
10224
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 10222

def display_name
  @display_name
end

#language_codeString

Language which represents the KnowledgeBase. When the KnowledgeBase is created/ updated, expect this to be present for non en-us languages. When unspecified, the default language code en-us applies. Corresponds to the JSON property languageCode

Returns:

  • (String)


10229
10230
10231
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 10229

def language_code
  @language_code
end

#nameString

The knowledge base resource name. The name must be empty when creating a knowledge base. Format: projects//locations//knowledgeBases/. Corresponds to the JSON property name

Returns:

  • (String)


10235
10236
10237
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 10235

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10242
10243
10244
10245
10246
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 10242

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @language_code = args[:language_code] if args.key?(:language_code)
  @name = args[:name] if args.key?(:name)
end