Class Document

constructor

• new Document(
      data: {
          content: (
              | { media?: undefined; text: string }
              | { media: { contentType?: string; url: string }; text?: undefined }
          )[];
          metadata?: Record<string, any>;
      },
  ): Document

• Parameters

  • data: {
        content: (
            | { media?: undefined; text: string }
            | { media: { contentType?: string; url: string }; text?: undefined }
        )[];
        metadata?: Record<string, any>;
    }

  Returns Document

content

Optionalmetadata

media

• get media(): null | { contentType?: string; url: string }

• Returns the first media part detected in the document. Useful for extracting (for example) an image.

  Returns null | { contentType?: string; url: string }

  The first detected media part in the document.

text

• get text(): string

• Concatenates all text parts present in the document with no delimiter.

  Returns string

  A string of all concatenated text parts.

toJSON

• toJSON(): {
      content: (
          | { media?: undefined; text: string }
          | { media: { contentType?: string; url: string }; text?: undefined }
      )[];
      metadata?: Record<string, any>;
  }

• Returns {
      content: (
          | { media?: undefined; text: string }
          | { media: { contentType?: string; url: string }; text?: undefined }
      )[];
      metadata?: Record<string, any>;
  }

StaticfromText

• fromText(text: string, metadata?: Record<string, any>): Document

• Parameters

  • text: string
  • Optionalmetadata: Record<string, any>

  Returns Document