Struct Retrieval 

pub struct Retrieval {
    pub knowledge_id: String,
    pub prompt_template: Option<String>,
}

Knowledge-base retrieval tool configuration.

Attaches a Zhipu AI knowledge base to a chat completion so the model can retrieve relevant passages from it before answering. Create the knowledge base (and obtain its knowledge_id) in the BigModel console, then pass the id here via the Retrieval tool.

See the official guide: https://docs.bigmodel.cn/cn/guide/tools/knowledge/retrieval.

Wire form

Serializes as {"knowledge_id":"…","prompt_template":"…"} (the prompt_template field is omitted when not set).

Usage

use zai_rs::model::tools::{Retrieval, Tools};

let tool = Tools::Retrieval {
    retrieval: Retrieval::new("kb_1234567890"),
};
// Or attach a custom prompt template:
let tool = Tools::Retrieval {
    retrieval: Retrieval::new("kb_1234567890")
        .with_prompt_template("仅依据知识库回答：{knowledge}"),
};

Fields

knowledge_id: String

Knowledge-base id (required). Obtain it from the BigModel console after creating and populating a knowledge base.

prompt_template: Option<String>

Optional prompt template applied when the model consumes retrieved knowledge. Serialized as prompt_template; omitted when None.

Implementations

impl Retrieval

pub fn new(knowledge_id: impl Into<String>) -> Self

Create a retrieval tool bound to knowledge_id.

pub fn with_prompt_template(self, prompt_template: impl Into<String>) -> Self

Attach a custom prompt template to the retrieval tool.

Trait Implementations

impl Clone for Retrieval

fn clone(&self) -> Retrieval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Retrieval

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

Formats the value using the given formatter.

impl Serialize for Retrieval

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for Retrieval

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Retrieval

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>