Skip to main content
POST

Authorizations

Api-Key
string
header
required

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

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

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.

reasoning
Reasoning · object
required

The reasoning behind the alignment evaluation.

usage
TokenCounts · object
required

Token counts for the input prompt and completion.