- md5
- d3bb10a8ba39f61ca385da273977ed67
- sha1
- db73ad84bca26d0120cb420ea5cc2befd98257e1
- sha256
- 05ef5fb817e5a7e5ab910792a76bb36111873568db0c60bb6aebaf1ab78eb377
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
<?php
/**
* WordPress AI Client API.
*
* @package WordPress
* @subpackage AI
* @since 7.0.0
*/
use WordPress\AiClient\AiClient;
use WordPress\AiClient\Files\DTO\File;
use WordPress\AiClient\Messages\DTO\Message;
use WordPress\AiClient\Messages\DTO\MessagePart;
/**
* Returns whether AI features are supported in the current environment.
*
* @since 7.0.0
*
* @return bool Whether AI features are supported.
*/
function wp_supports_ai(): bool {
// Return early if AI is disabled by the current environment.
if ( defined( 'WP_AI_SUPPORT' ) && ! WP_AI_SUPPORT ) {
return false;
}
/**
* Filters whether the current request can use AI.
*
* This allows plugins and 3rd-party code to disable AI features on a per-request basis, or to even override explicit
* preferences defined by the site owner.
*
* @since 7.0.0
*
* @param bool $is_enabled Whether AI is available. Default to true.
*/
return (bool) apply_filters( 'wp_supports_ai', true );
}
/**
* Creates a new AI prompt builder using the default provider registry.
*
* This is the main entry point for generating AI content in WordPress. It returns
* a fluent builder that can be used to configure and execute AI prompts.
*
* The prompt can be provided as a simple string for basic text prompts, or as more
* complex types for advanced use cases like multi-modal content or conversation history.
*
* @since 7.0.0
*
* @param string|MessagePart|Message|array|list<string|MessagePart|array>|list<Message>|null $prompt Optional. Initial prompt content.
* A string for simple text prompts,
* a MessagePart or Message object for
* structured content, an array for a
* message array shape, or a list of
* parts or messages for multi-turn
* conversations. Default null.
* @return WP_AI_Client_Prompt_Builder The prompt builder instance.
*/
function wp_ai_client_prompt( $prompt = null ): WP_AI_Client_Prompt_Builder {
return new WP_AI_Client_Prompt_Builder( AiClient::defaultRegistry(), $prompt );
}
/**
* Creates a new AI embedding builder using the default provider registry.
*
* This is the main entry point for generating embeddings in WordPress. It returns
* a fluent builder that can be used to configure and generate embedding vectors.
*
* Each input can be provided as a simple string for basic text inputs, or as more
* complex types. Pass multiple arguments, or a single list of inputs, to embed
* multiple inputs at once, each producing its own embedding vector.
*
* A model must be specified on the returned builder via `using_model()` or
* `using_provider_model()`. Embedding vectors are only comparable to other
* vectors produced by the same model, so no model is selected automatically.
*
* @since 7.2.0
*
* @param string|MessagePart|File|array ...$input Optional. Initial input(s) to embed.
* A string for simple text inputs,
* a MessagePart or File object for
* structured content, or an array for
* a message part array shape.
* Alternatively, a single list of any
* of these to embed multiple inputs.
* @return WP_AI_Client_Embedding_Builder The embedding builder instance.
*/
function wp_ai_client_embedding( ...$input ): WP_AI_Client_Embedding_Builder {
/*
* A single list argument is a list of inputs. It cannot be a single input, since
* the only array input is a message part array shape, which is never a list.
*/
if ( 1 === count( $input ) && isset( $input[0] ) && is_array( $input[0] ) && array_is_list( $input[0] ) ) {
$input = $input[0];
}
return new WP_AI_Client_Embedding_Builder( AiClient::defaultRegistry(), array() === $input ? null : $input );
}
The same content is in 5 releases, WordPress 7.2-beta1 to 7.2-beta5. See them all, or every version of this file.