Struct GenerationConfigurationBuilder

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

A builder for GenerationConfiguration.

Implementations

impl GenerationConfigurationBuilder

pub fn prompt_template(self, input: PromptTemplate) -> Self

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

pub fn set_prompt_template(self, input: Option<PromptTemplate>) -> Self

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

pub fn get_prompt_template(&self) -> &Option<PromptTemplate>

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

pub fn guardrail_configuration(self, input: GuardrailConfiguration) -> Self

The configuration details for the guardrail.

pub fn set_guardrail_configuration( self, input: Option<GuardrailConfiguration>, ) -> Self

The configuration details for the guardrail.

pub fn get_guardrail_configuration(&self) -> &Option<GuardrailConfiguration>

The configuration details for the guardrail.

pub fn inference_config(self, input: InferenceConfig) -> Self

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

pub fn set_inference_config(self, input: Option<InferenceConfig>) -> Self

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

pub fn get_inference_config(&self) -> &Option<InferenceConfig>

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

pub fn additional_model_request_fields( self, k: impl Into<String>, v: Document, ) -> Self

Adds a key-value pair to additional_model_request_fields.

To override the contents of this collection use set_additional_model_request_fields.

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

pub fn set_additional_model_request_fields( self, input: Option<HashMap<String, Document>>, ) -> Self

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

pub fn get_additional_model_request_fields( &self, ) -> &Option<HashMap<String, Document>>

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

pub fn performance_config(self, input: PerformanceConfiguration) -> Self

The latency configuration for the model.

pub fn set_performance_config( self, input: Option<PerformanceConfiguration>, ) -> Self

The latency configuration for the model.

pub fn get_performance_config(&self) -> &Option<PerformanceConfiguration>

The latency configuration for the model.

pub fn build(self) -> GenerationConfiguration

Consumes the builder and constructs a GenerationConfiguration.

Trait Implementations

impl Clone for GenerationConfigurationBuilder

fn clone(&self) -> GenerationConfigurationBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for GenerationConfigurationBuilder

fn default() -> GenerationConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for GenerationConfigurationBuilder

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

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

const 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 GenerationConfigurationBuilder