Struct MessageBuilder 

#[non_exhaustive]
pub struct MessageBuilder { /* private fields */ }

A builder for Message.

Implementations

impl MessageBuilder

pub fn role(self, input: ConversationRole) -> Self

The role that the message plays in the message.

This field is required.

pub fn set_role(self, input: Option<ConversationRole>) -> Self

The role that the message plays in the message.

pub fn get_role(&self) -> &Option<ConversationRole>

The role that the message plays in the message.

pub fn content(self, input: ContentBlock) -> Self

Appends an item to content.

To override the contents of this collection use set_content.

The message content. Note the following restrictions:

• You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.

• You can include up to five documents. Each document's size must be no more than 4.5 MB.

• If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.

• You can only include images and documents if the role is user.

pub fn set_content(self, input: Option<Vec<ContentBlock>>) -> Self

The message content. Note the following restrictions:

• You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.

• You can include up to five documents. Each document's size must be no more than 4.5 MB.

• If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.

• You can only include images and documents if the role is user.

pub fn get_content(&self) -> &Option<Vec<ContentBlock>>

The message content. Note the following restrictions:

• You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.

• You can include up to five documents. Each document's size must be no more than 4.5 MB.

• If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.

• You can only include images and documents if the role is user.

pub fn build(self) -> Result<Message, BuildError>

Consumes the builder and constructs a Message. This method will fail if any of the following fields are not set:

• role
• content

Trait Implementations

impl Clone for MessageBuilder

fn clone(&self) -> MessageBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageBuilder

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

Formats the value using the given formatter.

impl Default for MessageBuilder

fn default() -> MessageBuilder

Returns the “default value” for a type.

impl PartialEq for MessageBuilder

fn eq(&self, other: &MessageBuilder) -> 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 MessageBuilder