Struct KnowledgeSearchRequest 

pub struct KnowledgeSearchRequest {
    pub body: KnowledgeSearchBody,
}

Request for semantic retrieval across one or more knowledge bases.

Fields

body: KnowledgeSearchBody

JSON body sent to the retrieval endpoint.

Implementations

impl KnowledgeSearchRequest

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

Create a search request targeting one knowledge base.

pub fn with_knowledge_ids(self, knowledge_ids: Vec<String>) -> Self

Replace the knowledge-base selection.

pub fn with_document_ids(self, document_ids: Vec<String>) -> Self

Restrict retrieval to selected documents.

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Set a caller-generated request identifier.

pub fn with_top_k(self, top_k: u32) -> Self

Set the requested maximum number of final matches.

pub fn with_top_n(self, top_n: u32) -> Self

Set the number of candidates recalled before reranking.

pub fn with_recall_method(self, method: KnowledgeRecallMethod) -> Self

Select the retrieval strategy.

pub fn with_recall_ratio(self, ratio: u8) -> Self

Set the vector-search weight for mixed retrieval.

pub fn with_reranking(self, enabled: bool, model: KnowledgeRerankModel) -> Self

Configure reranking and its model.

pub fn with_score_threshold(self, threshold: f64) -> Self

Set the minimum relevance score sent as fractional_threshold.

pub async fn send_via( &self, client: &ZaiClient, ) -> ZaiResult<KnowledgeSearchResponse>

Validate and send the search request.