trulens.feedback.v2.feedback

trulens.feedback.v2.feedback

Classes

Feedback

Bases: BaseModel

Base class for feedback functions.

Criteria

Bases: str, Enum

A Criteria to evaluate.

OutputSpace

Bases: Enum

Enum for valid output spaces of scores.

FewShotExamples

Bases: BaseModel

Functions

from_examples_list classmethod

from_examples_list(
    examples_list: List[Tuple[Dict[str, str], int]]
) -> FewShotExamples

Create a FewShotExamples instance from a list of examples.

PARAMETER	DESCRIPTION
examples_list	A list of tuples where the first element is the feedback_args, and the second element is the score. TYPE: List[Tuple[Dict[str, str], int]]

RETURNS	DESCRIPTION
FewShotExamples	An instance of FewShotExamples with the provided examples. TYPE: FewShotExamples

Relevance

Bases: Semantics

This evaluates the relevance of the LLM response to the given text by LLM prompting.

Relevance is available for any LLM provider.

Sentiment dataclass

Bases: Semantics, WithPrompt, CriteriaOutputSpaceMixin

This evaluates the positive sentiment of either the prompt or response.

Harmfulness

Bases: Moderation, WithPrompt

Examples of Harmfulness:

Insensitivity

Bases: Semantics, WithPrompt

Examples and categorization of racial insensitivity: https://sph.umn.edu/site/docs/hewg/microaggressions.pdf .

Maliciousness

Bases: Moderation, WithPrompt

Examples of maliciousness:

Hate

Bases: Moderation

Examples of (not) Hate metrics:

• openai package: openai.moderation category hate.

HateThreatening

Bases: Hate

Examples of (not) Threatening Hate metrics:

• openai package: openai.moderation category hate/threatening.

SelfHarm

Bases: Moderation

Examples of (not) Self Harm metrics:

• openai package: openai.moderation category self-harm.

Sexual

Bases: Moderation

Examples of (not) Sexual metrics:

• openai package: openai.moderation category sexual.

SexualMinors

Bases: Sexual

Examples of (not) Sexual Minors metrics:

• openai package: openai.moderation category sexual/minors.

Violence

Bases: Moderation

Examples of (not) Violence metrics:

• openai package: openai.moderation category violence.

GraphicViolence

Bases: Violence

Examples of (not) Graphic Violence:

• openai package: openai.moderation category violence/graphic.

FeedbackOutput

Bases: BaseModel

Feedback functions produce at least a floating score.

ClassificationModel

Bases: Model

Functions

of_prompt staticmethod

of_prompt(model: CompletionModel, prompt: str) -> None

Define a classification model from a completion model, a prompt, and optional examples.