Document class final

A Document is a collection of Chunks. A Corpus can have a maximum of 10,000 Documents.

Inheritance
  • Object
  • ProtoMessage
  • Document

Constructors

Document({String name = '', String displayName = '', List<CustomMetadata> customMetadata = const [], Timestamp? updateTime, Timestamp? createTime})
Document.fromJson(Map<String, dynamic> json)
factory

Properties

createTime → Timestamp?
Output only. The Timestamp of when the Document was created.
final
customMetadata List<CustomMetadata>
Optional. User provided custom metadata stored as key-value pairs used for querying. A Document can have a maximum of 20 CustomMetadata.
final
displayName String
Optional. The human-readable display name for the Document. The display name must be no more than 512 characters in length, including spaces. Example: "Semantic Retriever Documentation"
final
hashCode int
The hash code for this object.
no setterinherited
name String
Immutable. Identifier. The Document resource name. The ID (name excluding the "corpora/*/documents/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be derived from display_name along with a 12 character random suffix. Example: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
final
qualifiedName String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
updateTime → Timestamp?
Output only. The Timestamp of when the Document was last updated.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Object
override
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String