[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/php-ai-client/src/Results/DTO/ -> EmbeddingResult.php (summary)

(no description)

File Size: 225 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

EmbeddingResult:: (12 methods):
  __construct()
  getId()
  getEmbeddings()
  getEmbedding()
  getDimensions()
  getTokenUsage()
  getProviderMetadata()
  getModelMetadata()
  getAdditionalData()
  getJsonSchema()
  toArray()
  fromArray()


Class: EmbeddingResult  - X-Ref

Represents the result of an embedding generation operation.

__construct(string $id, array $embeddings, int $dimensions, \WordPress\AiClient\Results\DTO\TokenUsage $tokenUsage, ProviderMetadata $providerMetadata, ModelMetadata $modelMetadata, array $additionalData = [])   X-Ref
Constructor.

param: string $id Unique identifier for this result.
param: list<Embedding|EmbeddingList> $embeddings The generated embedding vectors.
param: int $dimensions The vector dimension count.
param: TokenUsage $tokenUsage Token usage statistics.
param: ProviderMetadata $providerMetadata Provider metadata.
param: ModelMetadata $modelMetadata Model metadata.
param: array<string, mixed> $additionalData Additional data.

getId()   X-Ref
{@inheritDoc}


getEmbeddings()   X-Ref
Gets the generated embedding vectors.

return: list<Embedding> The embeddings.

getEmbedding()   X-Ref
Gets the first generated embedding vector.

return: Embedding The first embedding.

getDimensions()   X-Ref
Gets the vector dimension count.

return: int The vector dimension count.

getTokenUsage()   X-Ref
{@inheritDoc}


getProviderMetadata()   X-Ref
{@inheritDoc}


getModelMetadata()   X-Ref
{@inheritDoc}


getAdditionalData()   X-Ref
{@inheritDoc}


getJsonSchema()   X-Ref
Gets the JSON schema for embedding results.

return: array<string, mixed> The JSON schema.

toArray()   X-Ref
Converts the embedding result to an array.

return: EmbeddingResultArrayShape The embedding result array.

fromArray(array $array)   X-Ref
Creates an embedding result from an array.

return: self The embedding result instance.
param: EmbeddingResultArrayShape $array The embedding result array.



Generated : Wed Oct 14 08:20:33 2026 Cross-referenced by PHPXref