Table of Contents

Class Document

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

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

public class Document
Inheritance
Document
Inherited Members
Extension Methods

Properties

CreateTime

Output only. The Timestamp of when the Document was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

[JsonPropertyName("createTime")]
public Timestamp? CreateTime { get; set; }

Property Value

Timestamp

CustomMetadata

Optional. User provided custom metadata stored as key-value pairs used for querying. A Document can have a maximum of 20 CustomMetadata.

[JsonPropertyName("customMetadata")]
public List<CustomMetadata>? CustomMetadata { get; set; }

Property Value

List<CustomMetadata>

DisplayName

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"

[JsonPropertyName("displayName")]
public string? DisplayName { get; set; }

Property Value

string

Name

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 DisplayName along with a 12 character random suffix. Example: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

[JsonPropertyName("name")]
public string? Name { get; set; }

Property Value

string

UpdateTime

Output only. The Timestamp of when the Document was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

[JsonPropertyName("updateTime")]
public Timestamp? UpdateTime { get; set; }

Property Value

Timestamp

See Also