Struct DocumentBlock

#[non_exhaustive]
pub struct DocumentBlock {
    pub format: DocumentFormat,
    pub name: String,
    pub source: Option<DocumentSource>,
    pub context: Option<String>,
    pub citations: Option<CitationsConfig>,
}

A document to include in a message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: DocumentFormat

The format of a document, or its extension.

name: String

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

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: Option<DocumentSource>

Contains the content of the document.

context: Option<String>

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

citations: Option<CitationsConfig>

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

Implementations

impl DocumentBlock

pub fn format(&self) -> &DocumentFormat

The format of a document, or its extension.

pub fn name(&self) -> &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

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.

pub fn source(&self) -> Option<&DocumentSource>

Contains the content of the document.

pub fn context(&self) -> Option<&str>

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

pub fn citations(&self) -> Option<&CitationsConfig>

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

impl DocumentBlock

pub fn builder() -> DocumentBlockBuilder

Creates a new builder-style object to manufacture DocumentBlock.

Trait Implementations

impl Clone for DocumentBlock

fn clone(&self) -> DocumentBlock

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentBlock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentBlock

fn eq(&self, other: &DocumentBlock) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentBlock