WordPress\AiClient\Operations\DTO

GenerativeAiOperation::getJsonSchemapublic staticWP 0.1.0

{@inheritDoc}

Method of the class: GenerativeAiOperation{}

No Hooks.

Returns

null. Nothing (null).

Usage

$result = GenerativeAiOperation::getJsonSchema(): array;

Changelog

Since 0.1.0 Introduced.

GenerativeAiOperation::getJsonSchema() code WP 7.0.2

public static function getJsonSchema(): array
{
    return ['oneOf' => [
        // Succeeded state - has result
        ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this operation.'], self::KEY_STATE => ['type' => 'string', 'const' => OperationStateEnum::succeeded()->value], self::KEY_RESULT => GenerativeAiResult::getJsonSchema()], 'required' => [self::KEY_ID, self::KEY_STATE, self::KEY_RESULT], 'additionalProperties' => \false],
        // All other states - no result
        ['type' => 'object', 'properties' => [self::KEY_ID => ['type' => 'string', 'description' => 'Unique identifier for this operation.'], self::KEY_STATE => ['type' => 'string', 'enum' => [OperationStateEnum::starting()->value, OperationStateEnum::processing()->value, OperationStateEnum::failed()->value, OperationStateEnum::canceled()->value], 'description' => 'The current state of the operation.']], 'required' => [self::KEY_ID, self::KEY_STATE], 'additionalProperties' => \false],
    ]];
}