Skip to content

DocumentBlockDict

Dictionary Type

DocumentBlockDict

Bases: TypedDict

Dictionary form of DocumentBlock.

Attributes

citations instance-attribute

Configuration settings that control how citations should be generated for this specific document.

context instance-attribute
context: str | None

Contextual information about how the document should be processed or interpreted by the model when generating citations.

format instance-attribute
format: str | None

The format of a document, or its extension.

name instance-attribute
name: Required[str]

A name for the document. The name can only contain the following characters:

  • Alphanumeric characters

  • Whitespace characters (no more than one in a row)

  • Hyphens

  • Parentheses

  • Square brackets

Note

This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

source instance-attribute

Contains the content of the document.