Struct Prompt 

pub struct Prompt {
    pub id: String,
    pub variables: Option<HashMap<String, String>>,
}

Reference to a prompt template with variables

Allows you to use pre-defined prompt templates stored in the OpenAI platform, optionally with variable substitution.

API Reference

Corresponds to the prompt parameter in the OpenAI Responses API: https://platform.openai.com/docs/api-reference/responses/create

Examples

use openai_tools::responses::request::Prompt;
use std::collections::HashMap;

// Simple prompt reference
let prompt = Prompt::new("prompt-abc123");

// Prompt with variables
let mut vars = HashMap::new();
vars.insert("name".to_string(), "Alice".to_string());
let prompt = Prompt::with_variables("prompt-abc123", vars);

Fields

id: String

The ID of the prompt template

variables: Option<HashMap<String, String>>

Optional variables to substitute in the template

Implementations

impl Prompt

pub fn new<S: AsRef<str>>(id: S) -> Self

Creates a new Prompt reference without variables

Arguments

• id - The ID of the prompt template

Returns

A new Prompt instance

pub fn with_variables<S: AsRef<str>>( id: S, variables: HashMap<String, String>, ) -> Self

Creates a new Prompt reference with variables

Arguments

• id - The ID of the prompt template
• variables - Variables to substitute in the template

Returns

A new Prompt instance with variables

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl Serialize for Prompt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.