Struct RetrieveInput 

#[non_exhaustive]
pub struct RetrieveInput {
    pub knowledge_base_id: Option<String>,
    pub retrieval_query: Option<KnowledgeBaseQuery>,
    pub retrieval_configuration: Option<KnowledgeBaseRetrievalConfiguration>,
    pub guardrail_configuration: Option<GuardrailConfiguration>,
    pub next_token: Option<String>,
}

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.

knowledge_base_id: Option<String>

The unique identifier of the knowledge base to query.

retrieval_query: Option<KnowledgeBaseQuery>

Contains the query to send the knowledge base.

retrieval_configuration: Option<KnowledgeBaseRetrievalConfiguration>

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

guardrail_configuration: Option<GuardrailConfiguration>

Guardrail settings.

next_token: Option<String>

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Implementations

impl RetrieveInput

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

The unique identifier of the knowledge base to query.

pub fn retrieval_query(&self) -> Option<&KnowledgeBaseQuery>

Contains the query to send the knowledge base.

pub fn retrieval_configuration( &self, ) -> Option<&KnowledgeBaseRetrievalConfiguration>

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

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

Guardrail settings.

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

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

impl RetrieveInput

pub fn builder() -> RetrieveInputBuilder

Creates a new builder-style object to manufacture RetrieveInput.

Trait Implementations

impl Clone for RetrieveInput

fn clone(&self) -> RetrieveInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveInput

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

Formats the value using the given formatter.

impl PartialEq for RetrieveInput

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