Skip to content

Commit

Permalink
remove evaluate from Pinecone interface
Browse files Browse the repository at this point in the history
  • Loading branch information
austin-denoble committed Feb 3, 2025
1 parent 1ed48c6 commit ceb4a16
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 72 deletions.
38 changes: 0 additions & 38 deletions src/integration/assistant-control/evaluate.test.ts

This file was deleted.

34 changes: 0 additions & 34 deletions src/pinecone.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ import {
updateAssistant,
UpdateAssistantOptions,
listAssistants,
evaluate,
AssistantEval,
} from './assistant/control';
import { AssistantHostSingleton } from './assistant/assistantHostSingleton';
import type {
Expand All @@ -43,7 +41,6 @@ import { isBrowser } from './utils/environment';
import { ValidateObjectProperties } from './utils/validateObjectProperties';
import { PineconeConfigurationProperties } from './data/vectors/types';
import { asstControlOperationsBuilder } from './assistant/control/asstControlOperationsBuilder';
import { asstMetricsOperationsBuilder } from './assistant/control/asstMetricsOperationsBuilder';
import { Assistant } from './assistant/data/assistant';

/**
Expand Down Expand Up @@ -114,8 +111,6 @@ export class Pinecone {
/** @hidden */
private _updateAssistant: ReturnType<typeof updateAssistant>;
/** @hidden */
private _evaluate: ReturnType<typeof evaluate>;
/** @hidden */
private _describeAssistant: ReturnType<typeof describeAssistant>;
/** @hidden */
private _listAssistants: ReturnType<typeof listAssistants>;
Expand Down Expand Up @@ -155,7 +150,6 @@ export class Pinecone {
const api = indexOperationsBuilder(this.config);
const infApi = inferenceOperationsBuilder(this.config);
const asstControlApi = asstControlOperationsBuilder(this.config);
const asstEvalApi = asstMetricsOperationsBuilder(this.config);

this._configureIndex = configureIndex(api);
this._createCollection = createCollection(api);
Expand All @@ -170,7 +164,6 @@ export class Pinecone {
this._createAssistant = createAssistant(asstControlApi);
this._deleteAssistant = deleteAssistant(asstControlApi);
this._updateAssistant = updateAssistant(asstControlApi);
this._evaluate = evaluate(asstEvalApi);
this._describeAssistant = describeAssistant(asstControlApi);
this._listAssistants = listAssistants(asstControlApi);

Expand Down Expand Up @@ -761,33 +754,6 @@ export class Pinecone {
return this._updateAssistant(options);
}

/**
* Evaluates a question against a given answer and a ground truth answer.
*
* @example
* ```typescript
* import { Pinecone } from '@pinecone-database/pinecone';
* const pc = new Pinecone();
* await pc.evaluate({
* question: "What is the capital of France?",
* answer: "Lyon is France's capital city",
* groundTruth: "Paris is the capital city of France"
* });
* // {
* // metrics: { correctness: 0, completeness: 0, alignment: 0 }, // 0s across the board indicates incorrect
* // reasoning: { evaluatedFacts: [ [Object] ] },
* // usage: { promptTokens: 1134, completionTokens: 21, totalTokens: 1155 }
* // }
* ```
* @param options - An {@link AssistantEval} object containing the question, the answer, and a ground truth answer to
* evaluate.
* @throws Error if the Evaluation API is not initialized.
* @returns A Promise that resolves to an {@link AlignmentResponse} object.
*/
evaluate(options: AssistantEval) {
return this._evaluate(options);
}

/** @internal */
_checkForBrowser() {
if (isBrowser()) {
Expand Down

0 comments on commit ceb4a16

Please sign in to comment.