Class KnowledgeBase (4.39.0)

public final class KnowledgeBase extends GeneratedMessageV3 implements KnowledgeBaseOrBuilder

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.

Protobuf type google.cloud.dialogflow.v2.KnowledgeBase

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KnowledgeBase getDefaultInstance()
Returns
Type Description
KnowledgeBase

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static KnowledgeBase.Builder newBuilder()
Returns
Type Description
KnowledgeBase.Builder

newBuilder(KnowledgeBase prototype)

public static KnowledgeBase.Builder newBuilder(KnowledgeBase prototype)
Parameter
Name Description
prototype KnowledgeBase
Returns
Type Description
KnowledgeBase.Builder

parseDelimitedFrom(InputStream input)

public static KnowledgeBase parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KnowledgeBase parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KnowledgeBase parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KnowledgeBase parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KnowledgeBase parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KnowledgeBase parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeBase
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KnowledgeBase> parser()
Returns
Type Description
Parser<KnowledgeBase>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public KnowledgeBase getDefaultInstanceForType()
Returns
Type Description
KnowledgeBase

getDisplayName()

public String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getLanguageCode()

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

string language_code = 4;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

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.

string language_code = 4;

Returns
Type Description
ByteString

The bytes for languageCode.

getName()

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<KnowledgeBase> getParserForType()
Returns
Type Description
Parser<KnowledgeBase>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public KnowledgeBase.Builder newBuilderForType()
Returns
Type Description
KnowledgeBase.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KnowledgeBase.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KnowledgeBase.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KnowledgeBase.Builder toBuilder()
Returns
Type Description
KnowledgeBase.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException