1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// src/api/responses.rs
//! This module defines the `Responses` API client, which provides methods
//! for interacting with the `OpenAI` Responses API.
//!
//! For more details, refer to the [`OpenAI` Responses API documentation](https://platform.openai.com/docs/api-reference/responses).
/// Define a private namespace for all its items.
mod private
{
// Use crate root for base access
use crate::
{
client ::Client,
error ::Result,
environment ::{ OpenaiEnvironment, EnvironmentInterface },
};
use crate::components::responses::
{
CreateResponseRequest,
ResponseObject,
ResponseItemList,
ResponseStreamEvent,
};
use crate::components::common::ListQuery;
// External crates
use tokio::sync::mpsc;
/// The client for the `OpenAI` Responses API.
#[ derive( Debug, Clone ) ]
pub struct Responses< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
client : &'client Client< E >,
}
impl< 'client, E > Responses< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
/// Creates a new `Responses` client.
///
/// # Arguments
/// - `client`: The core `OpenAI` `Client` to use for requests.
#[ inline ]
pub(crate) fn new( client : &'client Client< E > ) -> Self
{
Self { client }
}
/// Creates a model response.
///
/// # Arguments
/// - `request`: The request body for creating a response.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn create( &self, request : CreateResponseRequest ) -> Result< ResponseObject >
{
self.client.post( "responses", &request ).await
}
/// Retrieves a response.
///
/// # Arguments
/// - `response_id`: The ID of the response to retrieve.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn retrieve( &self, response_id : &str ) -> Result< ResponseObject >
{
let path = format!( "responses/{response_id}" );
self.client.get( &path ).await
}
/// Lists input items for a response.
///
/// # Arguments
/// - `response_id`: The ID of the response.
/// - `query`: Optional query parameters for listing input items.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn list_input_items( &self, response_id : &str, query : Option< ListQuery > ) -> Result< ResponseItemList >
{
let path = format!( "responses/{response_id}/input_items" );
if let Some( q ) = query
{
self.client.get_with_query( &path, &q ).await
}
else
{
self.client.get( &path ).await
}
}
/// Creates a model response and streams the response.
///
/// # Arguments
/// - `request`: The request body for creating a response.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn create_stream( &self, request : CreateResponseRequest ) -> Result< mpsc::Receiver< Result< ResponseStreamEvent > > >
{
self.client.post_stream( "responses", &request ).await
}
/// Deletes a response.
///
/// # Arguments
/// - `response_id`: The ID of the response to delete.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn delete( &self, response_id : &str ) -> Result< serde_json::Value >
{
let path = format!( "responses/{response_id}" );
self.client.delete( &path ).await
}
/// Updates a response.
///
/// **⚠️ DEPRECATED**: `OpenAI` API no longer supports PATCH operations on responses.
/// This method will return HTTP 405 Method Not Allowed.
///
/// # Arguments
/// - `response_id`: The ID of the response to update.
/// - `update`: The update request body.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ deprecated( since = "0.2.0", note = "OpenAI API no longer supports response updates" ) ]
#[ inline ]
pub async fn update( &self, response_id : &str, update : serde_json::Value ) -> Result< ResponseObject >
{
let path = format!( "responses/{response_id}" );
self.client.patch( &path, &update ).await
}
/// Cancels an in-progress response.
///
/// # Arguments
/// - `response_id`: The ID of the response to cancel.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn cancel( &self, response_id : &str ) -> Result< ResponseObject >
{
let path = format!( "responses/{response_id}/cancel" );
self.client.post_no_body( &path ).await
}
}
} // end mod private
crate ::mod_interface!
{
// Expose all structs defined in this module
exposed use
{
Responses,
};
}