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

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".

OptionalmimeType

mimeType?: string

Output only. The mime type of the Document.

Optionalname

name?: string

Immutable. Identifier. The Document resource name. The ID (name excluding the "fileSearchStores/*/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: fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c

OptionalsizeBytes

sizeBytes?: string

Output only. The size of raw bytes ingested into the Document.

Optionalstate

state?: DocumentState

Output only. Current state of the Document.

OptionalupdateTime

updateTime?: string

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

Settings

On This Page

Properties