Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface EvaluateFeatureRequest



entityId: undefined | string

An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.

evaluationContext?: string | LazyJsonString

A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.

If you include this parameter, the value must be a JSON object. A JSON array is not supported.

feature: undefined | string

The name of the feature being evaluated.

project: undefined | string

The name or ARN of the project that contains this feature.