Skip to main content

openai_interface/responses/
delete.rs

1//! Delete a stored response via `DELETE /responses/{response_id}`.
2//!
3//! Only responses created with `store: true` can be deleted. Provider
4//! support varies: Qwen supports this endpoint, while DeepSeek's Responses
5//! API is stateless and stores nothing.
6
7use url::Url;
8
9use crate::{
10    errors::OapiError,
11    rest::delete::{Delete, DeleteNoStream},
12};
13
14/// Deletes a previously stored response by its ID.
15#[derive(Debug, Clone)]
16pub struct DeleteRequest<'a> {
17    /// The ID of the response to delete, e.g. `resp_...`.
18    pub response_id: &'a str,
19}
20
21impl Delete for DeleteRequest<'_> {
22    /// Builds the URL for the request.
23    ///
24    /// `base_url` should be like <https://api.openai.com/v1>
25    fn build_url(&self, base_url: &str) -> Result<String, OapiError> {
26        let mut url = Url::parse(base_url.trim_end_matches('/')).map_err(OapiError::UrlError)?;
27        url.path_segments_mut()
28            .map_err(|_| OapiError::UrlCannotBeBase(base_url.to_string()))?
29            .push("responses")
30            .push(self.response_id);
31        Ok(url.to_string())
32    }
33}
34
35impl DeleteNoStream for DeleteRequest<'_> {
36    type Response = ResponseDeleted;
37}
38
39/// The response of a response deletion.
40///
41/// OpenAI returns `{"id": ..., "deleted": true, "object":
42/// "response.deleted"}`, while Qwen only returns `{"id": ..., "deleted":
43/// true}`, so `object` is optional.
44#[derive(Debug, Clone, serde::Deserialize)]
45pub struct ResponseDeleted {
46    /// The ID of the response that was deleted.
47    pub id: String,
48    /// Whether the response was deleted successfully.
49    pub deleted: bool,
50    /// The object type (`response.deleted`), if the provider sends it.
51    #[serde(default)]
52    pub object: Option<String>,
53}
54
55crate::impl_from_str!(ResponseDeleted);