Class DocumentBlock

constructor

• new DocumentBlock(data: DocumentBlockData): DocumentBlock

  Parameters

  • data: DocumentBlockData

  Returns DocumentBlock

Readonlytype

Readonlyname

Readonlyformat

Readonlysource

Optional Readonlycitations

Optional Readonlycontext

toJSON

• toJSON(): {
      document: {
          name: string;
          format: DocumentFormat;
          source: | { bytes: string }
          | { text: string }
          | { content: { text: string }[] }
          | { s3Location: { uri: string; bucketOwner?: string } };
          citations?: { enabled: boolean };
          context?: string;
      };
  }

  Serializes the DocumentBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify(). Uint8Array bytes are encoded as base64 string.

  Returns {
      document: {
          name: string;
          format: DocumentFormat;
          source:
              | { bytes: string }
              | { text: string }
              | { content: { text: string }[] }
              | { s3Location: { uri: string; bucketOwner?: string } };
          citations?: { enabled: boolean };
          context?: string;
      };
  }

StaticfromJSON

• fromJSON(
      data: {
          document: {
              name: string;
              format: DocumentFormat;
              source:
                  | { bytes: string
                  | Uint8Array<ArrayBufferLike> }
                  | { text: string }
                  | { content: { text: string }[] }
                  | { s3Location: { uri: string; bucketOwner?: string } };
              citations?: { enabled: boolean };
              context?: string;
          };
      },
  ): DocumentBlock

  Creates a DocumentBlock instance from its wrapped data format. Base64-encoded bytes are decoded back to Uint8Array.

  Parameters

  • data: {
        document: {
            name: string;
            format: DocumentFormat;
            source:
                | { bytes: string
                | Uint8Array<ArrayBufferLike> }
                | { text: string }
                | { content: { text: string }[] }
                | { s3Location: { uri: string; bucketOwner?: string } };
            citations?: { enabled: boolean };
            context?: string;
        };
    }

    Wrapped DocumentBlockData to deserialize (accepts both string and Uint8Array for bytes)

  Returns DocumentBlock

  DocumentBlock instance