Title: GenerativeAiResult::getJsonSchema
Published: May 20, 2026
Last modified: August 20, 2026

---

# GenerativeAiResult::getJsonSchema()

## In this article

 * [Source](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#wp--skip-link--target)

{@inheritDoc}

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#source)󠁿

    ```php
    public static function getJsonSchema(): array
    {
        return ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this result.'], self::KEY_CANDIDATES => ['type' => 'array', 'items' => \WordPress\AiClient\Results\DTO\Candidate::getJsonSchema(), 'minItems' => 1, 'description' => 'The generated candidates.'], self::KEY_TOKEN_USAGE => \WordPress\AiClient\Results\DTO\TokenUsage::getJsonSchema(), self::KEY_PROVIDER_METADATA => ProviderMetadata::getJsonSchema(), self::KEY_MODEL_METADATA => ModelMetadata::getJsonSchema(), self::KEY_ADDITIONAL_DATA => ['type' => 'object', 'additionalProperties' => \true, 'description' => 'Additional data included in the API response.']], 'required' => [self::KEY_ID, self::KEY_CANDIDATES, self::KEY_TOKEN_USAGE, self::KEY_PROVIDER_METADATA, self::KEY_MODEL_METADATA]];
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/php-ai-client/src/results/dto/generativeairesult.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L375)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/php-ai-client/src/Results/DTO/GenerativeAiResult.php#L375-L378)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#related)󠁿

| Uses | Description | 
| [TokenUsage::getJsonSchema()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-tokenusage/getjsonschema/)`wp-includes/php-ai-client/src/Results/DTO/TokenUsage.php` |

{@inheritDoc}

  | 
| [Candidate::getJsonSchema()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-candidate/getjsonschema/)`wp-includes/php-ai-client/src/Results/DTO/Candidate.php` |

{@inheritDoc}

  | 
| [ModelMetadata::getJsonSchema()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-providers-models-dto-modelmetadata/getjsonschema/)`wp-includes/php-ai-client/src/Providers/Models/DTO/ModelMetadata.php` |

{@inheritDoc}

  | 
| [ProviderMetadata::getJsonSchema()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-providers-dto-providermetadata/getjsonschema/)`wp-includes/php-ai-client/src/Providers/DTO/ProviderMetadata.php` |

{@inheritDoc}

  |

| Used by | Description | 
| [GenerativeAiOperation::getJsonSchema()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-operations-dto-generativeaioperation/getjsonschema/)`wp-includes/php-ai-client/src/Operations/DTO/GenerativeAiOperation.php` |

{@inheritDoc}

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-results-dto-generativeairesult/getjsonschema/?output_format=md#changelog)󠁿

| Version | Description | 
| [0.1.0](https://developer.wordpress.org/reference/since/0.1.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwordpress-aiclient-results-dto-generativeairesult%2Fgetjsonschema%2F)
before being able to contribute a note or feedback.