REST Resource: projects.knowledgeBases

Resource: 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.

JSON representation
{
  "name": string,
  "displayName": string,
  "languageCode": string
}
Fields
name

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>.

displayName

string

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

languageCode

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.

Methods

create

Creates a knowledge base.

delete

Deletes the specified knowledge base.

get

Retrieves the specified knowledge base.

list

Returns the list of all knowledge bases of the specified agent.

patch

Updates the specified knowledge base.