Class RankedDocument

Document represents document content along with its metadata that can be embedded, indexed or retrieved. Each document can contain multiple parts (for example text and an image)

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

content metadata

Accessors

media text

Methods

score toJSON fromText

Constructors

constructor

  • new RankedDocument(
        data: {
            content: (
                | { media?: undefined; text: string }
                | { media: { contentType?: string; url: string }; text?: undefined }
            )[];
            metadata: { score: number } & { [k: string]: unknown };
        },
    ): RankedDocument

  • Parameters

    • data: {
          content: (
              | { media?: undefined; text: string }
              | { media: { contentType?: string; url: string }; text?: undefined }
          )[];
          metadata: { score: number } & { [k: string]: unknown };
      }

    Returns RankedDocument

Properties

content

content: (
    | { media?: undefined; text: string }
    | { media: { contentType?: string; url: string }; text?: undefined }
)[]

metadata

metadata: { score: number } & Record<string, any>

Accessors

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.

Methods

score

  • score(): number

  • Returns the score of the document.

    Returns number

    The score of the document.

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods