Class Document (4.36.0)

public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder

A knowledge document to be used by a KnowledgeBase.

For more information, see the knowledge base guide.

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Protobuf type google.cloud.dialogflow.v2.Document

Implements

DocumentOrBuilder

Static Fields

CONTENT_URI_FIELD_NUMBER

public static final int CONTENT_URI_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_AUTO_RELOAD_FIELD_NUMBER

public static final int ENABLE_AUTO_RELOAD_FIELD_NUMBER
Field Value
Type Description
int

KNOWLEDGE_TYPES_FIELD_NUMBER

public static final int KNOWLEDGE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

LATEST_RELOAD_STATUS_FIELD_NUMBER

public static final int LATEST_RELOAD_STATUS_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RAW_CONTENT_FIELD_NUMBER

public static final int RAW_CONTENT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document getDefaultInstance()
Returns
Type Description
Document

getDescriptor()

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

newBuilder()

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

newBuilder(Document prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getContentUri()

public String getContentUri()

The URI where the file content is located.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.

string content_uri = 5;

Returns
Type Description
String

The contentUri.

getContentUriBytes()

public ByteString getContentUriBytes()

The URI where the file content is located.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.

string content_uri = 5;

Returns
Type Description
ByteString

The bytes for contentUri.

getDefaultInstanceForType()

public Document getDefaultInstanceForType()
Returns
Type Description
Document

getDisplayName()

public String getDisplayName()

Required. The display name of the document. 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 document. 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.

getEnableAutoReload()

public boolean getEnableAutoReload()

Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document.

Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types.

Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged.

If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.

bool enable_auto_reload = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableAutoReload.

getKnowledgeTypes(int index)

public Document.KnowledgeType getKnowledgeTypes(int index)

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
Document.KnowledgeType

The knowledgeTypes at the given index.

getKnowledgeTypesCount()

public int getKnowledgeTypesCount()

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of knowledgeTypes.

getKnowledgeTypesList()

public List<Document.KnowledgeType> getKnowledgeTypesList()

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<KnowledgeType>

A list containing the knowledgeTypes.

getKnowledgeTypesValue(int index)

public int getKnowledgeTypesValue(int index)

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of knowledgeTypes at the given index.

getKnowledgeTypesValueList()

public List<Integer> getKnowledgeTypesValueList()

Required. The knowledge type of document content.

repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for knowledgeTypes.

getLatestReloadStatus()

public Document.ReloadStatus getLatestReloadStatus()

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

.google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Document.ReloadStatus

The latestReloadStatus.

getLatestReloadStatusOrBuilder()

public Document.ReloadStatusOrBuilder getLatestReloadStatusOrBuilder()

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

.google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Document.ReloadStatusOrBuilder

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public int getMetadataCount()

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMimeType()

public String getMimeType()

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Required. The MIME type of this document.

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for mimeType.

getName()

public String getName()

Optional. The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The document resource name. The name must be empty when creating a document. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRawContent()

public ByteString getRawContent()

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

bytes raw_content = 9;

Returns
Type Description
ByteString

The rawContent.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public Document.SourceCase getSourceCase()
Returns
Type Description
Document.SourceCase

getState()

public Document.State getState()

Output only. The current state of the document.

.google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Document.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the document.

.google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasContentUri()

public boolean hasContentUri()

The URI where the file content is located.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.

string content_uri = 5;

Returns
Type Description
boolean

Whether the contentUri field is set.

hasLatestReloadStatus()

public boolean hasLatestReloadStatus()

Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

.google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the latestReloadStatus field is set.

hasRawContent()

public boolean hasRawContent()

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

bytes raw_content = 9;

Returns
Type Description
boolean

Whether the rawContent field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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