Feedback Definitions Client

The Feedback Definitions client provides methods for managing feedback score definitions in the Opik platform.

class opik.rest_api.feedback_definitions.client.FeedbackDefinitionsClient(*, client_wrapper: SyncClientWrapper)

Bases: object

find_feedback_definitions(*, page: int | None = None, size: int | None = None, name: str | None = None, type: Literal['numerical', 'categorical'] | Any | None = None, request_options: RequestOptions | None = None) → FeedbackDefinitionPagePublic

Find Feedback definitions

Parameters:

  • page (Optional[int])

  • size (Optional[int])

  • name (Optional[str])

  • type (Optional[FindFeedbackDefinitionsRequestType])

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Feedback definitions resource

Return type:

FeedbackDefinitionPagePublic

create_feedback_definition(*, request: FeedbackCreate_Numerical | FeedbackCreate_Categorical, request_options: RequestOptions | None = None) → None

Get feedback definition

Parameters:

  • request (FeedbackCreate)

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

get_feedback_definition_by_id(id: str, *, request_options: RequestOptions | None = None) → FeedbackPublic_Numerical | FeedbackPublic_Categorical

Get feedback definition by id

Parameters:

  • id (str)

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

Feedback definition resource

Return type:

FeedbackPublic

update_feedback_definition(id: str, *, request: FeedbackUpdate_Numerical | FeedbackUpdate_Categorical, request_options: RequestOptions | None = None) → None

Update feedback definition by id

Parameters:

  • id (str)

  • request (FeedbackUpdate)

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

delete_feedback_definition_by_id(id: str, *, request_options: RequestOptions | None = None) → None

Delete feedback definition by id

Parameters:

  • id (str)

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

delete_feedback_definitions_batch(*, ids: Sequence[str], request_options: RequestOptions | None = None) → None

Delete feedback definitions batch

Parameters:

  • ids (Sequence[str])

  • request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Usage Example

import opik

client = opik.Opik()

# Find feedback definitions
definitions = client.rest_client.feedback_definitions.find_feedback_definitions(
    type="numerical",
    page=0,
    size=10
)

# Create a feedback definition
client.rest_client.feedback_definitions.create_feedback_definition(
    name="accuracy",
    type="numerical",
    min_value=0.0,
    max_value=1.0
)

# Get a feedback definition by ID
definition = client.rest_client.feedback_definitions.get_feedback_definition_by_id(
    "definition-id"
)