Struct ExternalSourcesGenerationConfiguration

#[non_exhaustive]
pub struct ExternalSourcesGenerationConfiguration {
    pub prompt_template: Option<PromptTemplate>,
    pub guardrail_configuration: Option<GuardrailConfiguration>,
    pub inference_config: Option<InferenceConfig>,
    pub additional_model_request_fields: Option<HashMap<String, Document>>,
    pub performance_config: Option<PerformanceConfiguration>,
}

Contains the generation configuration of the external source wrapper object.

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.

prompt_template: Option<PromptTemplate>

Contain the textPromptTemplate string for the external source wrapper object.

guardrail_configuration: Option<GuardrailConfiguration>

The configuration details for the guardrail.

inference_config: Option<InferenceConfig>

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

additional_model_request_fields: Option<HashMap<String, Document>>

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

performance_config: Option<PerformanceConfiguration>

The latency configuration for the model.

Implementations

impl ExternalSourcesGenerationConfiguration

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

Contain the textPromptTemplate string for the external source wrapper object.

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

The configuration details for the guardrail.

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

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

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

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

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

The latency configuration for the model.

impl ExternalSourcesGenerationConfiguration

pub fn builder() -> ExternalSourcesGenerationConfigurationBuilder

Creates a new builder-style object to manufacture ExternalSourcesGenerationConfiguration.

Trait Implementations

impl Clone for ExternalSourcesGenerationConfiguration

fn clone(&self) -> ExternalSourcesGenerationConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalSourcesGenerationConfiguration

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

Formats the value using the given formatter.

impl PartialEq for ExternalSourcesGenerationConfiguration

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