Evaluate an answer

Evaluate the correctness and completeness of a response from an assistant or a RAG system. The correctness and completeness are evaluated based on the precision and recall of the generated answer with respect to the ground truth answer facts. Alignment is the harmonic mean of correctness and completeness.

For guidance and examples, see Evaluate answers.

POST /evaluation/metrics/alignment

Python

# pip install --upgrade pinecone
import os
from pinecone import Pinecone

pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])

result = pc.assistants.evaluate_alignment(
    question="What are the capital cities of France, England and Spain?",
    answer="Paris is the capital city of France and Barcelona of Spain",
    ground_truth_answer="Paris is the capital city of France, London of England and Madrid of Spain",
)
print(result.scores.correctness, result.scores.completeness, result.scores.alignment)

200

{
  "metrics": {
    "correctness": 123,
    "completeness": 123,
    "alignment": 123
  },
  "reasoning": {
    "evaluated_facts": [
      {
        "fact": {
          "content": "<string>"
        },
        "entailment": "<string>"
      }
    ]
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  }
}

Python

# pip install --upgrade pinecone
import os
from pinecone import Pinecone

pc = Pinecone(api_key=os.environ["PINECONE_API_KEY"])

result = pc.assistants.evaluate_alignment(
    question="What are the capital cities of France, England and Spain?",
    answer="Paris is the capital city of France and Barcelona of Spain",
    ground_truth_answer="Paris is the capital city of France, London of England and Madrid of Spain",
)
print(result.scores.correctness, result.scores.completeness, result.scores.alignment)

Authorizations

Api-Key · string · header · required

An API Key is required to call Pinecone APIs. Get yours from the console.

Headers

X-Pinecone-Api-Version · string · default: 2026-07 · required

Required date-based version header

Body

application/json

The request body for the alignment evaluation.

The request for the alignment evaluation.

question · string · required

The question for which the answer was generated.

Example:

"What is the capital city of Spain?"

answer · string · required

The generated answer.

Example:

"Barcelona."

ground_truth_answer · string · required

The ground truth answer to the question.

Example:

"Madrid."

Response

200

application/json

The evaluation metrics and reasoning for the generated answer.

The response for the alignment evaluation.

metrics · Metrics · object · required

The metrics returned for the alignment evaluation.

Show child attributes

reasoning · Reasoning · object · required

The reasoning behind the alignment evaluation.

Show child attributes

usage · Token counts · object · required

Contains the token usage details for LLM interactions, including tokens used in requests (prompt_tokens), tokens used in responses (completion_tokens), and the total number of tokens (total_tokens).

Show child attributes