Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class 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.
For more information, see the knowledge base
guide.
Note: The projects.agent.knowledgeBases resource is deprecated;
only use projects.knowledgeBases.
Generated from protobuf message google.cloud.dialogflow.v2.KnowledgeBase
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The knowledge base resource name. The name must be empty when creating a knowledge base. Format: |
↳ display_name |
string
Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails. |
↳ language_code |
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. |
getName
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>.
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
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>.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCode
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.
Generated from protobuf field string language_code = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
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.
Generated from protobuf field string language_code = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |