Interface Document

A Document is a collection of Chunks.

interface Document {
    createTime?: string;
    customMetadata?: CustomMetadata[];
    displayName?: string;
    mimeType?: string;
    name?: string;
    sizeBytes?: string;
    state?: DocumentState;
    updateTime?: string;
}

Properties

createTime? customMetadata? displayName? mimeType? name? sizeBytes? state? updateTime?

Properties

OptionalcreateTime

createTime?: string

Output only. The Timestamp of when the Document was created.

OptionalcustomMetadata

customMetadata?: CustomMetadata[]

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

OptionaldisplayName

displayName?: string

The human-readable display name for the Document.

OptionalmimeType

mimeType?: string

The MIME type of the Document.

Optionalname

name?: string

The resource name of the Document. Example: fileSearchStores/file-search-store-foo/documents/documents-bar

OptionalsizeBytes

sizeBytes?: string

The size of the Document in bytes.

Optionalstate

state?: DocumentState

The current state of the Document.

OptionalupdateTime

updateTime?: string

Output only. The Timestamp of when the Document was last updated.

Settings

On This Page

Properties