Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::KnowledgeBase.
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.
Note: The projects.agent.knowledgeBases resource is deprecated;
only use projects.knowledgeBases.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#display_name
defdisplay_name()->::String
Returns
(::String) — Required. The display name of the knowledge base. The name must be 1024
bytes or less; otherwise, the creation request fails.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — Required. The display name of the knowledge base. The name must be 1024
bytes or less; otherwise, the creation request fails.
Returns
(::String) — Required. The display name of the knowledge base. The name must be 1024
bytes or less; otherwise, the creation request fails.
#language_code
deflanguage_code()->::String
Returns
(::String) — 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.
#language_code=
deflanguage_code=(value)->::String
Parameter
value (::String) — 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.
Returns
(::String) — 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.
#name
defname()->::String
Returns
(::String) — The knowledge base resource name.
The name must be empty when creating a knowledge base.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>.
#name=
defname=(value)->::String
Parameter
value (::String) — The knowledge base resource name.
The name must be empty when creating a knowledge base.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>.
Returns
(::String) — The knowledge base resource name.
The name must be empty when creating a knowledge base.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::KnowledgeBase (v1.10.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.1 (latest)](/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.10.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.10.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.9.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.9.1/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.8.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.8.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.7.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.7.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.6.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.6.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.5.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.5.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.4.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.4.1/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.3.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.3.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.2.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.2.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.1.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.1.1/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [1.0.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.0.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.34.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.34.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.33.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.33.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.32.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.32.2/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.31.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.31.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.30.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.30.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.29.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.29.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.28.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.28.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.27.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.27.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.26.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.26.2/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.25.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.25.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.24.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.24.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.23.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.23.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.22.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.22.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.21.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.21.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.20.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.20.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.19.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.19.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.18.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.18.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.17.1](/ruby/docs/reference/google-cloud-dialogflow-v2/0.17.1/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.16.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.16.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.15.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.15.2/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.14.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.14.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.13.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.13.0/Google-Cloud-Dialogflow-V2-KnowledgeBase)\n- [0.12.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.12.0/Google-Cloud-Dialogflow-V2-KnowledgeBase) \nReference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::KnowledgeBase.\n\nA knowledge base represents a collection of knowledge documents that you\nprovide to Dialogflow. Your knowledge documents contain information that may\nbe useful during conversations with end-users. Some Dialogflow features use\nknowledge bases when looking for a response to an end-user input.\n\n\nFor more information, see the [knowledge base\nguide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).\n\n\u003cbr /\u003e\n\nNote: The `projects.agent.knowledgeBases` resource is deprecated;\nonly use `projects.knowledgeBases`. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails. \n**Returns**\n\n- (::String) --- Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.\n\n### #language_code\n\n def language_code() -\u003e ::String\n\n**Returns**\n\n- (::String) --- 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.\n\n### #language_code=\n\n def language_code=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- 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. \n**Returns**\n\n- (::String) --- 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.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/\u003cProject ID\u003e/locations/\u003cLocation\nID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`. \n**Returns**\n\n- (::String) --- The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/knowledgeBases/\u003cKnowledge Base ID\u003e`."]]