Class KnowledgeBase (4.43.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
TypeDescription
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static KnowledgeBase getDefaultInstance()
Returns
TypeDescription
KnowledgeBase

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static KnowledgeBase.Builder newBuilder()
Returns
TypeDescription
KnowledgeBase.Builder

newBuilder(KnowledgeBase prototype)

public static KnowledgeBase.Builder newBuilder(KnowledgeBase prototype)
Parameter
NameDescription
prototypeKnowledgeBase
Returns
TypeDescription
KnowledgeBase.Builder

parseDelimitedFrom(InputStream input)

public static KnowledgeBase parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static KnowledgeBase parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KnowledgeBase parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KnowledgeBase parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static KnowledgeBase parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static KnowledgeBase parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeBase parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeBase
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<KnowledgeBase> parser()
Returns
TypeDescription
Parser<KnowledgeBase>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public KnowledgeBase getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<KnowledgeBase> getParserForType()
Returns
TypeDescription
Parser<KnowledgeBase>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public KnowledgeBase.Builder newBuilderForType()
Returns
TypeDescription
KnowledgeBase.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KnowledgeBase.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
KnowledgeBase.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public KnowledgeBase.Builder toBuilder()
Returns
TypeDescription
KnowledgeBase.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException