Package com.google.genai.types

Class Document

java.lang.Object
com.google.genai.JsonSerializable
com.google.genai.types.Document
public abstract class Document extends JsonSerializable
A Document is a collection of Chunks.

  • Constructor Details

    • Document

      public Document()

  • Method Details

    • name

      public abstract Optional<String> name()
      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`

    • displayName

      public abstract Optional<String> 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".

    • state

      public abstract Optional<DocumentState> state()
      Output only. Current state of the `Document`.

    • sizeBytes

      public abstract Optional<Long> sizeBytes()
      Output only. The size of raw bytes ingested into the Document.

    • mimeType

      public abstract Optional<String> mimeType()
      Output only. The mime type of the Document.

    • createTime

      public abstract Optional<Instant> createTime()
      Output only. The Timestamp of when the `Document` was created.

    • customMetadata

      public abstract Optional<List<CustomMetadata>> customMetadata()
      Optional. User provided custom metadata stored as key-value pairs used for querying. A `Document` can have a maximum of 20 `CustomMetadata`.

    • updateTime

      public abstract Optional<Instant> updateTime()
      Output only. The Timestamp of when the `Document` was last updated.

    • builder

      public static Document.Builder builder()
      Instantiates a builder for Document.

    • toBuilder

      public abstract Document.Builder toBuilder()
      Creates a builder with the same values as this instance.

    • fromJson

      public static Document fromJson(String jsonString)
      Deserializes a JSON string to a Document object.