ShadowExperimentService

Update a shadow experiment

Changed on

Updates a shadow experiment's description or source sampling strategy. updateMask is required; source changes also require the current etag in the request body.

patch/v2/projects/{projectId}/endpoints/{endpointId}/shadowExperiments/{id}

Request

  • Base URL
    https://api.together.ai
  • URL
    https://api.together.ai/v2/projects/{projectId}/endpoints/{endpointId}/shadowExperiments/{id}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier.

endpointIdstring required

Endpoint identifier.

idstring required

Shadow experiment identifier.

Query parameters

updateMaskstring required

Required fields to update, such as description or source.

Request body

descriptionstring

Updated free-form description.

etagstring

Opaque version tag from a prior read for optimistic concurrency.

Response

OK

idstring required

Output only. Unique shadow experiment identifier.

projectIdstring required

Output only. Project that owns the parent endpoint.

endpointIdstring required

Output only. Endpoint whose traffic this experiment samples.

namestring required

Human-readable shadow experiment name, unique within the endpoint. At most 256 characters.

descriptionstring

User defined description.

createdBystring required

Identifier of the principal that created the experiment.

createdAtstring date-time required

Timestamp when the experiment was created.

updatedAtstring date-time required

Timestamp when the experiment was last updated.

etagstring required

Opaque version tag for optimistic concurrency control. Returned on read; set it on update or delete requests for consistent read-modify-write.

state'SHADOW_EXPERIMENT_STATE_ACTIVE' | 'SHADOW_EXPERIMENT_STATE_INACTIVE' required

Derived serving state, active when the experiment has at least one target.

Changes