Semantic Similarity Evaluator

Allows you to check for semantic similarity or dissimilarity between input and output and a target value, so you can avoid sentences that you don’t want to be present without having to match on the exact text.

POST /langevals/similarity/evaluate

Try it

Python

Offline Evaluation

import langwatch

df = langwatch.dataset.get_dataset("dataset-id").to_pandas()

evaluation = langwatch.evaluation.init("my-incredible-evaluation")

for index, row in evaluation.loop(df.iterrows()):
    # your execution code here       
    evaluation.run(
        "langevals/similarity",
        index=index,
        data={
            "input": row["input"],
            "output": output,
        },
        settings={}
    )

200

[
  {
    "status": "processed",
    "score": 123,
    "passed": true,
    "label": "<string>",
    "details": "<string>",
    "cost": {
      "currency": "<string>",
      "amount": 123
    },
    "raw_response": {},
    "error_type": "<string>",
    "traceback": [
      "<string>"
    ]
  }
]

Authorizations

X-Auth-Token · string · header · required

Body

application/json

data · object · required

Show child attributes

data. input · string

The input text to evaluate

data. output · string

The output text to evaluate

settings · object

Evaluator settings

Show child attributes

settings. field · string · default: output

field setting

settings. rule · string · default: is_not_similar_to

rule setting

settings. value · string · default: example

value setting

settings. threshold · number · default: 0.3

threshold setting

settings. embeddings_model · string · default: openai/text-embedding-3-small

embeddings_model setting

Response

200

application/json

Successful evaluation

status · enum<string> · required

Available options: processed, skipped, error

score · number

Evaluation score

passed · boolean

Whether the evaluation passed

label · string

Evaluation label

details · string

Additional details about the evaluation

cost · object

Show child attributes

cost. currency · string · required

cost. amount · number · required

raw_response · object

Raw response from the evaluator

error_type · string

Type of error if status is 'error'

traceback · string[]

Error traceback if status is 'error'