FWfw-ai-external
gateway.openapi_Gateway

Update Evaluator

Changed on

Updates evaluator metadata (display_name, description, default_dataset). Changing requirements or entry_point triggers a rebuild. To upload new source code, set prepare_code_upload: true then follow the upload flow.

patch/v1/accounts/{account_id}/evaluators/{evaluator_id}

Request

Path parameters

account_idstring required

The Account Id

evaluator_idstring required

The Evaluator Id

Query parameters

prepareCodeUploadboolean

If true, prepare a new code upload/build attempt by transitioning the evaluator to BUILDING state. Can be used without update_mask.

Request body

displayNamestring
descriptionstring
createTimestring date-time
createdBystring
updateTimestring date-time
state'STATE_UNSPECIFIED' | 'ACTIVE' | 'BUILDING' | 'BUILD_FAILED'
requirementsstring
entryPointstring
commitHashstring
defaultDatasetstring
encryptionState'ENCRYPTION_STATE_UNSPECIFIED' | 'ENCRYPTION_STATE_PLAINTEXT' | 'ENCRYPTION_STATE_CMEK'

EncryptionState is the authoritative, per-resource CMEK marker: the single source of truth for whether a resource's customer-data artifacts are encrypted. It is stamped at resource creation from the owning account's CMEK config and is immutable for the resource's life, so a resource always reads back with the state it was created under regardless of the account's current flag. The encrypt-on-write / decrypt-on-read decision for the resource's data keys off this field.

  • ENCRYPTION_STATE_UNSPECIFIED: Unstamped/legacy rows that predate CMEK. Treated as PLAINTEXT.
  • ENCRYPTION_STATE_PLAINTEXT: Customer-data artifacts are stored as plaintext (Fireworks-owned, no CMEK).
  • ENCRYPTION_STATE_CMEK: Customer-data artifacts are CMEK-encrypted; reads MUST decrypt (fail-closed).

Response

A successful response.

namestring
displayNamestring
descriptionstring
createTimestring date-time
createdBystring
updateTimestring date-time
state'STATE_UNSPECIFIED' | 'ACTIVE' | 'BUILDING' | 'BUILD_FAILED'
requirementsstring
entryPointstring
commitHashstring
defaultDatasetstring
encryptionState'ENCRYPTION_STATE_UNSPECIFIED' | 'ENCRYPTION_STATE_PLAINTEXT' | 'ENCRYPTION_STATE_CMEK'

EncryptionState is the authoritative, per-resource CMEK marker: the single source of truth for whether a resource's customer-data artifacts are encrypted. It is stamped at resource creation from the owning account's CMEK config and is immutable for the resource's life, so a resource always reads back with the state it was created under regardless of the account's current flag. The encrypt-on-write / decrypt-on-read decision for the resource's data keys off this field.

  • ENCRYPTION_STATE_UNSPECIFIED: Unstamped/legacy rows that predate CMEK. Treated as PLAINTEXT.
  • ENCRYPTION_STATE_PLAINTEXT: Customer-data artifacts are stored as plaintext (Fireworks-owned, no CMEK).
  • ENCRYPTION_STATE_CMEK: Customer-data artifacts are CMEK-encrypted; reads MUST decrypt (fail-closed).

Changes

  • 3bf245180173Revision changes
    • info

      added the optional property to the response with the status

  • 920bcfb416a7Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status