class-wpcom-rest-api-v2-endpoint-ai.php — Jetpack – WP Security, Backup, Speed, & Growth 14.3.1

jetpack / _inc / lib / core-api / wpcom-endpoints / class-wpcom-rest-api-v2-endpoint-ai.php

jetpack / _inc / lib / core-api / wpcom-endpoints Last commit date

class-wpcom-rest-api-v2-endpoint-ai.php

306 lines

1	<?php
2	/**
3	* REST API endpoint for the Jetpack AI blocks.
4	*
5	* @package automattic/jetpack
6	* @since 11.8
7	*/
8
9	use Automattic\Jetpack\Connection\Client;
10
11	/**
12	* Class WPCOM_REST_API_V2_Endpoint_AI
13	*/
14	class WPCOM_REST_API_V2_Endpoint_AI extends WP_REST_Controller {
15	/**
16	* Namespace prefix.
17	*
18	* @var string
19	*/
20	public $namespace = 'wpcom/v2';
21
22	/**
23	* Endpoint base route.
24	*
25	* @var string
26	*/
27	public $rest_base = 'jetpack-ai';
28
29	/**
30	* WPCOM_REST_API_V2_Endpoint_AI constructor.
31	*/
32	public function __construct() {
33	$this->is_wpcom = true;
34	$this->wpcom_is_wpcom_only_endpoint = true;
35
36	if ( ! class_exists( 'Jetpack_AI_Helper' ) ) {
37	require_once JETPACK__PLUGIN_DIR . '_inc/lib/class-jetpack-ai-helper.php';
38	}
39
40	// Register routes that don't require Jetpack AI to be enabled.
41	add_action( 'rest_api_init', array( $this, 'register_basic_routes' ) );
42
43	if ( Jetpack_AI_Helper::is_ai_chat_enabled() ) {
44	add_action( 'rest_api_init', array( $this, 'register_ai_chat_routes' ) );
45	}
46
47	if ( ! \Jetpack_AI_Helper::is_enabled() ) {
48	return;
49	}
50
51	// Register routes that require Jetpack AI to be enabled.
52	add_action( 'rest_api_init', array( $this, 'register_routes' ) );
53	}
54
55	/**
56	* Register routes.
57	*/
58	public function register_routes() {
59	register_rest_route(
60	$this->namespace,
61	$this->rest_base . '/completions',
62	array(
63	array(
64	'methods' => WP_REST_Server::CREATABLE,
65	'callback' => array( $this, 'request_gpt_completion' ),
66	'permission_callback' => array( 'Jetpack_AI_Helper', 'get_status_permission_check' ),
67	),
68	'args' => array(
69	'content' => array(
70	'type' => 'string',
71	'required' => true,
72	'sanitize_callback' => 'sanitize_textarea_field',
73	),
74	'post_id' => array(
75	'required' => false,
76	'type' => 'integer',
77	),
78	'skip_cache' => array(
79	'required' => false,
80	'type' => 'boolean',
81	'description' => 'Whether to skip the cache and make a new request',
82	),
83	),
84	)
85	);
86
87	register_rest_route(
88	$this->namespace,
89	$this->rest_base . '/images/generations',
90	array(
91	array(
92	'methods' => WP_REST_Server::CREATABLE,
93	'callback' => array( $this, 'request_dalle_generation' ),
94	'permission_callback' => array( 'Jetpack_AI_Helper', 'get_status_permission_check' ),
95	),
96	'args' => array(
97	'prompt' => array(
98	'type' => 'string',
99	'required' => true,
100	'sanitize_callback' => 'sanitize_textarea_field',
101	),
102	'post_id' => array(
103	'required' => false,
104	'type' => 'integer',
105	),
106	),
107	)
108	);
109	}
110
111	/**
112	* Register routes for the AI Chat block.
113	* Relies on a site connection and Jetpack Search.
114	*/
115	public function register_ai_chat_routes() {
116	register_rest_route(
117	$this->namespace,
118	'/jetpack-search/ai/search',
119	array(
120	array(
121	'methods' => WP_REST_Server::READABLE,
122	'callback' => array( $this, 'request_chat_with_site' ),
123	'permission_callback' => '__return_true',
124	),
125	'args' => array(
126	'query' => array(
127	'description' => 'Your question to the site',
128	'required' => true,
129	'sanitize_callback' => 'sanitize_text_field',
130	),
131	'answer_prompt' => array(
132	'description' => 'Answer prompt override',
133	'required' => false,
134	'sanitize_callback' => 'sanitize_text_field',
135	),
136	),
137	)
138	);
139
140	register_rest_route(
141	$this->namespace,
142	'/jetpack-search/ai/rank',
143	array(
144	array(
145	'methods' => WP_REST_Server::CREATABLE,
146	'callback' => array( $this, 'rank_response' ),
147	'permission_callback' => '__return_true',
148	),
149	'args' => array(
150	'cache_key' => array(
151	'description' => 'Cache key of your response',
152	'required' => true,
153	'sanitize_callback' => 'sanitize_text_field',
154	),
155	'comment' => array(
156	'description' => 'Optional feedback',
157	'required' => false,
158	'sanitize_callback' => 'sanitize_text_field',
159	),
160	'rank' => array(
161	'description' => 'How do you rank this response',
162	'required' => false,
163	'sanitize_callback' => 'sanitize_text_field',
164	),
165	),
166	)
167	);
168	}
169
170	/**
171	* Register routes that don't require Jetpack AI to be enabled.
172	*/
173	public function register_basic_routes() {
174	register_rest_route(
175	$this->namespace,
176	$this->rest_base . '/ai-assistant-feature',
177	array(
178	array(
179	'methods' => WP_REST_Server::READABLE,
180	'callback' => array( $this, 'request_get_ai_assistance_feature' ),
181	'permission_callback' => array( 'Jetpack_AI_Helper', 'get_status_permission_check' ),
182	),
183	)
184	);
185	}
186
187	/**
188	* Get a response from chatting with the site.
189	* Uses Jetpack Search.
190	*
191	* @param WP_REST_Request $request The request.
192	* @return mixed
193	*/
194	public function request_chat_with_site( $request ) {
195	$question = $request->get_param( 'query' );
196	$blog_id = \Jetpack_Options::get_option( 'id' );
197	$response = Client::wpcom_json_api_request_as_blog(
198	sprintf( '/sites/%d/jetpack-search/ai/search', $blog_id ) . '?force=wpcom',
199	2,
200	array(
201	'method' => 'GET',
202	'headers' => array( 'content-type' => 'application/json' ),
203	'timeout' => MINUTE_IN_SECONDS,
204	),
205	array(
206	'query' => $question,
207	/**
208	* Filter for an answer prompt override.
209	* Example: "Talk like a cowboy."
210	*
211	* @param string $prompt_override The prompt override string.
212	*
213	* @since 12.6
214	*/
215	'answer_prompt' => apply_filters( 'jetpack_ai_chat_answer_prompt', false ),
216	),
217	'wpcom'
218	);
219
220	if ( is_wp_error( $response ) ) {
221	return $response;
222	}
223
224	$data = json_decode( wp_remote_retrieve_body( $response ) );
225
226	if ( empty( $data->cache_key ) ) {
227	return new WP_Error( 'invalid_ask_response', __( 'Invalid response from the server.', 'jetpack' ), 400 );
228	}
229
230	return $data;
231	}
232
233	/**
234	* Rank a response from chatting with the site.
235	*
236	* @param WP_REST_Request $request The request.
237	* @return mixed
238	*/
239	public function rank_response( $request ) {
240	$rank = $request->get_param( 'rank' );
241	$comment = $request->get_param( 'comment' );
242	$cache_key = $request->get_param( 'cache_key' );
243
244	if ( strpos( $cache_key, 'jp-search-ai-' ) !== 0 ) {
245	return new WP_Error( 'invalid_cache_key', __( 'Invalid cached context for the answer feedback.', 'jetpack' ), 400 );
246	}
247
248	$blog_id = \Jetpack_Options::get_option( 'id' );
249	$response = Client::wpcom_json_api_request_as_blog(
250	sprintf( '/sites/%d/jetpack-search/ai/rank', $blog_id ) . '?force=wpcom',
251	2,
252	array(
253	'method' => 'GET',
254	'headers' => array( 'content-type' => 'application/json' ),
255	'timeout' => 30,
256	),
257	array(
258	'rank' => $rank,
259	'comment' => $comment,
260	'cache_key' => $cache_key,
261	),
262	'wpcom'
263	);
264
265	if ( is_wp_error( $response ) ) {
266	return $response;
267	}
268
269	$data = json_decode( wp_remote_retrieve_body( $response ) );
270
271	if ( 'ok' !== $data ) {
272	return new WP_Error( 'invalid_feedback_response', __( 'Invalid response from the server.', 'jetpack' ), 400 );
273	}
274
275	return $data;
276	}
277
278	/**
279	* Get completions for a given text.
280	*
281	* @param WP_REST_Request $request The request.
282	*/
283	public function request_gpt_completion( $request ) {
284	return Jetpack_AI_Helper::get_gpt_completion( $request['content'], $request['post_id'], $request['skip_cache'] );
285	}
286
287	/**
288	* Get image generations for a given prompt.
289	*
290	* @param WP_REST_Request $request The request.
291	*/
292	public function request_dalle_generation( $request ) {
293	return Jetpack_AI_Helper::get_dalle_generation( $request['prompt'], $request['post_id'] );
294	}
295
296	/**
297	* Collect and provide relevat data about the AI feature,
298	* such as the number of requests made.
299	*/
300	public function request_get_ai_assistance_feature() {
301	return Jetpack_AI_Helper::get_ai_assistance_feature();
302	}
303	}
304
305	wpcom_rest_api_v2_load_plugin( 'WPCOM_REST_API_V2_Endpoint_AI' );
306