Struct PromptTemplate 

pub struct PromptTemplate {
    pub query_prefix: String,
    pub doc_prefix: String,
}

Prompt template applied before tokenization, used for instruction-tuned / prompt-tuned embedders.

Common patterns in the ecosystem:

• E5: query: {text} vs passage: {text}
• BGE (often): no prompt, or query: ... / passage: ... depending on checkpoint
• Instruct models: sometimes use longer task prompts; we keep this as plain prefixing for now because it composes with both local and remote backends.

Fields

query_prefix: String

doc_prefix: String

Implementations

impl PromptTemplate

pub fn apply(&self, mode: EmbedMode, text: &str) -> String

pub fn from_iksh_env() -> Self

👎Deprecated since 0.2.0:

use from_embedd_env() or from_env_any()

Load prompt prefixes from the legacy iksh env vars (compat).

pub fn from_embedd_env() -> Self

Load prompt prefixes from EMBEDD_QUERY_PREFIX / EMBEDD_DOC_PREFIX.

Falls back to defaults when unset.

pub fn from_env_any() -> Self

Prefer EMBEDD_* prompt env vars, else fall back to IKSH_*, else defaults.

This is useful for examples/benchmarks that want a single “prompt surface” without accidentally drifting existing iksh behavior.

Trait Implementations

impl Clone for PromptTemplate

fn clone(&self) -> PromptTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptTemplate

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

Formats the value using the given formatter.

impl Default for PromptTemplate

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PromptTemplate

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

impl StructuralPartialEq for PromptTemplate