← All changes | includes/ai-copilot/client.php +143 -23 0.9.8 → 1.1.10 View file →

		@@ -1,7 +1,7 @@
1	1	<?php
2	2	/**
3		- * Desktop Mode — AI Copilot: WordPress AI Client adapter.
	3	+ * OpenStation — AI Copilot: WordPress AI Client adapter.
4	4	*
5	5	* Thin wrappers around `wp_ai_client_prompt()` that the agentic search loop
6	6	* and the comment-scoring job use to generate. Credentials are injected by
7	7	* Core from the configured Connector — nothing here ever handles an API key.
		@@ -11,17 +11,19 @@
11	11	* dispatches ability calls through `wp_get_ability()->execute()`.
12	12	*
13	13	* All SDK classes referenced here ship with WordPress 7.0+. The `use`
14	14	* statements are compile-time aliases only; every call site is reached solely
15		- * through {@see desktop_mode_ai_is_available()}, so this file is inert (and
	15	+ * through {@see openstation_ai_is_available()}, so this file is inert (and
16	16	* never resolves the classes) on older WordPress.
17	17	*
18		- * @package WPDesktopMode
	18	+ * @package OpenStation
19	19	*/
20	20
21	21	use WordPress\AiClient\Messages\DTO\Message;
22	22	use WordPress\AiClient\Messages\DTO\MessagePart;
23	23	use WordPress\AiClient\Messages\DTO\UserMessage;
	24	+use WordPress\AiClient\Providers\Models\Contracts\ModelInterface;
	25	+use WordPress\AiClient\Providers\Models\DTO\ModelConfig;
24	26	use WordPress\AiClient\Tools\DTO\FunctionCall;
25	27	use WordPress\AiClient\Tools\DTO\FunctionDeclaration;
26	28	use WordPress\AiClient\Tools\DTO\FunctionResponse;
27	29
		@@ -35,9 +37,9 @@
35	37	*
36	38	* @param array $tool_defs List of tool definitions.
37	39	* @return FunctionDeclaration[]
38	40	*/
39		-function desktop_mode_ai_build_function_declarations( array $tool_defs ) {
	41	+function openstation_ai_build_function_declarations( array $tool_defs ) {
40	42	$declarations = array();
41	43	foreach ( $tool_defs as $def ) {
42	44	if ( ! is_array( $def ) ) {
43	45	continue;
		@@ -59,9 +61,9 @@
59	61	*
60	62	* @param string $text
61	63	* @return UserMessage
62	64	*/
63		-function desktop_mode_ai_user_text_message( $text ) {
	65	+function openstation_ai_user_text_message( $text ) {
64	66	return new UserMessage( array( new MessagePart( (string) $text ) ) );
65	67	}
66	68
67	69	/**
		@@ -69,9 +71,9 @@
69	71	*
70	72	* @param array $tool_outputs List of `{ call_id, name, response }` entries.
71	73	* @return UserMessage
72	74	*/
73		-function desktop_mode_ai_tool_result_message( array $tool_outputs ) {
	75	+function openstation_ai_tool_result_message( array $tool_outputs ) {
74	76	$parts = array();
75	77	foreach ( $tool_outputs as $output ) {
76	78	$parts[] = new MessagePart(
77	79	new FunctionResponse(
		@@ -100,9 +102,9 @@
100	102	*
101	103	* @param Message $message Assistant message as returned by the AI Client.
102	104	* @return Message Message safe to append to the conversation history.
103	105	*/
104		-function desktop_mode_ai_strip_thought_parts( Message $message ) {
	106	+function openstation_ai_strip_thought_parts( Message $message ) {
105	107	$kept = array();
106	108	$stripped = false;
107	109	foreach ( $message->getParts() as $part ) {
108	110	if ( $part->getChannel()->isThought() ) {
		@@ -119,8 +121,108 @@
119	121	return new Message( $message->getRole(), $kept );
120	122	}
121	123
122	124	/**
	125	+ * Builds the error for a final turn that produced no answer text.
	126	+ *
	127	+ * Observed live with the Anthropic provider under agent runs: a hard task
	128	+ * spends the entire `max_tokens` budget inside a thinking block
	129	+ * (`stop_reason: "max_tokens"`, a single text-less thought part), so the
	130	+ * turn carries neither function calls nor extractable text. Callers that
	131	+ * can meaningfully degrade instead (the command follow-up turn) match on
	132	+ * this code and keep their own fallback.
	133	+ *
	134	+ * @param string $detail Underlying extraction failure, preserved for logs.
	135	+ * @return WP_Error
	136	+ */
	137	+function openstation_ai_empty_answer_error( $detail ) {
	138	+ return new WP_Error(
	139	+ 'openstation_ai_empty_answer',
	140	+ __( 'The AI provider returned no answer text.', 'desktop-mode' ),
	141	+ array(
	142	+ 'status' => 502,
	143	+ 'detail' => (string) $detail,
	144	+ )
	145	+ );
	146	+}
	147	+
	148	+/**
	149	+ * Applies the site's model config to a prompt builder.
	150	+ *
	151	+ * @param mixed $builder WP_AI_Client_Prompt_Builder.
	152	+ * @param array $context Partial filter context; missing keys are defaulted.
	153	+ * @return mixed
	154	+ */
	155	+function openstation_ai_apply_model_config( $builder, array $context ) {
	156	+ $context = array_merge(
	157	+ array(
	158	+ 'user_id' => 0,
	159	+ 'request_id' => '',
	160	+ 'source' => '',
	161	+ 'has_tools' => false,
	162	+ 'has_schema' => false,
	163	+ ),
	164	+ $context
	165	+ );
	166	+
	167	+ /**
	168	+ * Filters the model config for one AI turn.
	169	+ *
	170	+ * Defaults to empty. Recipe: `docs/examples/ai-model-config.md`.
	171	+ *
	172	+ * @param array $config { model?: string|ModelInterface, max_tokens?: int, temperature?: float, custom_options?: array<string, mixed> }.
	173	+ * @param array $context { user_id, request_id, source, has_tools, has_schema }.
	174	+ */
	175	+ $config = apply_filters( 'openstation_ai_model_config', array(), $context );
	176	+ if ( ! is_array( $config ) ) {
	177	+ return $builder;
	178	+ }
	179	+
	180	+ $model_config = new ModelConfig();
	181	+
	182	+ if ( isset( $config['max_tokens'] ) && is_numeric( $config['max_tokens'] ) && (int) $config['max_tokens'] > 0 ) {
	183	+ $model_config->setMaxTokens( (int) $config['max_tokens'] );
	184	+ }
	185	+
	186	+ // Unlike max_tokens, 0.0 is a legitimate temperature (deterministic). The
	187	+ // 2.0 ceiling is the range the SDK's own schema declares.
	188	+ if ( isset( $config['temperature'] ) && is_numeric( $config['temperature'] )
	189	+ && (float) $config['temperature'] >= 0.0 && (float) $config['temperature'] <= 2.0 ) {
	190	+ $model_config->setTemperature( (float) $config['temperature'] );
	191	+ }
	192	+
	193	+ $custom_options = array();
	194	+ if ( isset( $config['custom_options'] ) && is_array( $config['custom_options'] ) ) {
	195	+ foreach ( $config['custom_options'] as $key => $value ) {
	196	+ // A list would reach the provider as parameters named `0`, `1`, ….
	197	+ if ( is_string( $key ) && '' !== $key ) {
	198	+ $custom_options[ $key ] = $value;
	199	+ }
	200	+ }
	201	+ }
	202	+
	203	+ if ( ! empty( $custom_options ) ) {
	204	+ $model_config->setCustomOptions( $custom_options );
	205	+ }
	206	+
	207	+ $builder = $builder->using_model_config( $model_config );
	208	+
	209	+ // After the config: `using_model()` merges the model's own defaults under
	210	+ // whatever the builder already carries, so ours has to land first.
	211	+ $model = isset( $config['model'] ) ? $config['model'] : null;
	212	+ if ( $model instanceof ModelInterface ) {
	213	+ $builder = $builder->using_model( $model );
	214	+ } elseif ( is_string( $model ) && '' !== trim( $model ) ) {
	215	+ // `using_model()` needs a ModelInterface, so a bare model id goes
	216	+ // through `using_model_preference()`, which throws on anything that
	217	+ // isn't a non-empty string.
	218	+ $builder = $builder->using_model_preference( trim( $model ) );
	219	+ }
	220	+
	221	+ return $builder;
	222	+}
	223	+
	224	+/**
123	225	* Runs one generation turn through the AI Client.
124	226	*
125	227	* Rebuilds the prompt from the full ordered message list each turn (the
126	228	* builder's `with_history()` prepends, so it can't append turns in a loop),
		@@ -126,21 +228,20 @@
126	228	* builder's `with_history()` prepends, so it can't append turns in a loop),
127	229	* advertises the tools as function declarations, and constrains the final
128	230	* answer to `$answer_schema` when given. Returns the assistant turn normalized
129	231	* to the shape the loop consumes; `message` has thought-channel parts stripped
130		- * ({@see desktop_mode_ai_strip_thought_parts()}) so it is safe to replay.
	232	+ * ({@see openstation_ai_strip_thought_parts()}) so it is safe to replay.
131	233	*
132		- * @param int $user_id Requesting user id. Currently unused — the
133		- * provider comes from Connectors and no
134		- * per-user preference is applied; retained for
135		- * signature stability and future attribution.
	234	+ * @param int $user_id Requesting user id.
136	235	* @param array $messages Ordered conversation as SDK Message objects.
137	236	* @param array $tool_defs Tool definitions to advertise.
138	237	* @param array|null $answer_schema JSON Schema for the final answer, or null.
139	238	* @param string $instructions System instruction.
	239	+ * @param array $context Optional. `{ source?: string, request_id?: string }`
	240	+ * for the model-config filter.
140	241	* @return array{ text: ?string, function_calls: array, message: mixed, usage: ?array, model: ?array }|WP_Error
141	242	*/
142		-function desktop_mode_ai_client_generate( $user_id, array $messages, array $tool_defs, $answer_schema, $instructions ) {
	243	+function openstation_ai_client_generate( $user_id, array $messages, array $tool_defs, $answer_schema, $instructions, array $context = array() ) {
143	244	$builder = wp_ai_client_prompt( $messages );
144	245
145	246	if ( is_string( $instructions ) && '' !== $instructions ) {
146	247	$builder = $builder->using_system_instruction( $instructions );
		@@ -145,12 +246,12 @@
145	246	if ( is_string( $instructions ) && '' !== $instructions ) {
146	247	$builder = $builder->using_system_instruction( $instructions );
147	248	}
148	249
149		- // Provider + model selection is delegated entirely to the Core AI Client
150		- // (Connector-backed); Desktop Mode pins neither.
	250	+ // Provider + model selection is delegated to the Core AI Client
	251	+ // (Connector-backed) unless the model-config filter says otherwise.
151	252
152		- $declarations = desktop_mode_ai_build_function_declarations( $tool_defs );
	253	+ $declarations = openstation_ai_build_function_declarations( $tool_defs );
153	254	if ( ! empty( $declarations ) ) {
154	255	$builder = $builder->using_function_declarations( ...$declarations );
155	256	}
156	257
		@@ -157,11 +258,23 @@
157	258	if ( is_array( $answer_schema ) ) {
158	259	// Strict structured output: providers reject an object subschema that
159	260	// doesn't set `additionalProperties: false`, and one such node 400s the
160	261	// whole turn. Normalize here so no schema author has to know that.
161		- $builder = $builder->as_json_response( desktop_mode_ai_normalize_response_schema( $answer_schema ) );
	262	+ $builder = $builder->as_json_response( openstation_ai_normalize_response_schema( $answer_schema ) );
162	263	}
163	264
	265	+ $builder = openstation_ai_apply_model_config(
	266	+ $builder,
	267	+ array_merge(
	268	+ $context,
	269	+ array(
	270	+ 'user_id' => (int) $user_id,
	271	+ 'has_tools' => ! empty( $declarations ),
	272	+ 'has_schema' => is_array( $answer_schema ),
	273	+ )
	274	+ )
	275	+ );
	276	+
164	277	$result = $builder->generate_result();
165	278	if ( is_wp_error( $result ) ) {
166	279	return $result;
167	280	}
		@@ -185,21 +298,28 @@
185	298	}
186	299
187	300	$text = null;
188	301	if ( empty( $function_calls ) ) {
	302	+ // A turn with no function calls IS the final answer, so failing to
	303	+ // extract its text is a failed generation, not a valid empty one.
	304	+ // Swallowing it here used to surface as a "successful" run with an
	305	+ // empty answer, invisible to the retry and error paths alike.
189	306	try {
190	307	$text = $result->toText();
191	308	} catch ( \Throwable $e ) {
192		- $text = null;
	309	+ return openstation_ai_empty_answer_error( $e->getMessage() );
193	310	}
	311	+ if ( ! is_string( $text ) || '' === trim( $text ) ) {
	312	+ return openstation_ai_empty_answer_error( 'The provider response contains no text part.' );
	313	+ }
194	314	}
195	315
196	316	return array(
197	317	'text' => $text,
198	318	'function_calls' => $function_calls,
199		- 'message' => desktop_mode_ai_strip_thought_parts( $message ),
200		- 'usage' => desktop_mode_ai_result_token_usage( $result ),
201		- 'model' => desktop_mode_ai_result_model_metadata( $result ),
	319	+ 'message' => openstation_ai_strip_thought_parts( $message ),
	320	+ 'usage' => openstation_ai_result_token_usage( $result ),
	321	+ 'model' => openstation_ai_result_model_metadata( $result ),
202	322	);
203	323	}
204	324
205	325	/**
		@@ -207,9 +327,9 @@
207	327	*
208	328	* @param mixed $result GenerativeAiResult.
209	329	* @return array{ prompt: int, completion: int, total: int }|null
210	330	*/
211		-function desktop_mode_ai_result_token_usage( $result ) {
	331	+function openstation_ai_result_token_usage( $result ) {
212	332	try {
213	333	$usage = $result->getTokenUsage();
214	334	return array(
215	335	'prompt' => (int) $usage->getPromptTokens(),
		@@ -226,9 +346,9 @@
226	346	*
227	347	* @param mixed $result GenerativeAiResult.
228	348	* @return array{ id: string, name: string }|null
229	349	*/
230		-function desktop_mode_ai_result_model_metadata( $result ) {
	350	+function openstation_ai_result_model_metadata( $result ) {
231	351	try {
232	352	$model = $result->getModelMetadata();
233	353	return array(
234	354	'id' => (string) $model->getId(),