@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
44 lines (43 loc) • 1.24 kB
TypeScript
/**
* Evaluation API
* Provides endpoints for evaluating RAG systems using various metrics.
*
* The version of the OpenAPI document: 2025-04
* Contact: support@pinecone.io
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* The metrics returned for the alignment evaluation.
* @export
* @interface Metrics
*/
export interface Metrics {
/**
* The precision of the generated answer.
* @type {number}
* @memberof Metrics
*/
correctness: number;
/**
* The recall of the generated answer.
* @type {number}
* @memberof Metrics
*/
completeness: number;
/**
* The harmonic mean of correctness and completeness.
* @type {number}
* @memberof Metrics
*/
alignment: number;
}
/**
* Check if a given object implements the Metrics interface.
*/
export declare function instanceOfMetrics(value: object): boolean;
export declare function MetricsFromJSON(json: any): Metrics;
export declare function MetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Metrics;
export declare function MetricsToJSON(value?: Metrics | null): any;