Skip to content

Commit

Permalink
clean up docstrings, README, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
austin-denoble committed Jan 19, 2025
1 parent 2acac44 commit 4c343de
Show file tree
Hide file tree
Showing 18 changed files with 131 additions and 455 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1260,7 +1260,7 @@ that guide its behavior, and attach metadata for organization and tracking purpo
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();

const assistant = await pc.assistant.createAssistant({
const assistant = await pc.createAssistant({
name: 'product-assistant',
instructions: 'You are a helpful product recommendation assistant.',
metadata: {
Expand All @@ -1279,7 +1279,7 @@ const assistant = await pc.assistant.createAssistant({
```typescript
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
await pc.assistant.deleteAssistant('test1');
await pc.deleteAssistant('test1');
```

### Get information about an Assistant
Expand All @@ -1289,7 +1289,7 @@ await pc.assistant.deleteAssistant('test1');
```typescript
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
const test = await pc.assistant.getAssistant('test1');
const test = await pc.describeAssistant('test1');
console.log(test);
// {
// name: 'test10',
Expand All @@ -1309,7 +1309,7 @@ console.log(test);
```typescript
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
await pc.assistant.updateAssistant({
await pc.updateAssistant({
name: 'test1',
instructions: 'some new instructions!',
});
Expand All @@ -1329,7 +1329,7 @@ names, instructions, metadata, status, and host.
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();

const assistants = await pc.assistant.listAssistants();
const assistants = await pc.listAssistants();
console.log(assistants);
// {
// assistants: [{
Expand Down Expand Up @@ -1519,7 +1519,7 @@ Assistant performed.
```typescript
import { Pinecone } from '@pinecone-database/pinecone';
const pc = new Pinecone();
await pc.assistant.evaluate({
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',
Expand Down
273 changes: 0 additions & 273 deletions src/assistant/control/AssistantCtrlPlane.ts

This file was deleted.

35 changes: 23 additions & 12 deletions src/assistant/control/__tests__/createAssistant.test.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
import { AssistantCtrlPlane } from '../AssistantCtrlPlane';
import { ManageAssistantsApi } from '../../../pinecone-generated-ts-fetch/assistant_control';
import {
Assistant,
CreateAssistantOperationRequest,
ManageAssistantsApi,
} from '../../../pinecone-generated-ts-fetch/assistant_control';
import { createAssistant } from '../createAssistant';

const setupManageAssistantsApi = () => {
const fakeCreateAssistant: (
req: CreateAssistantOperationRequest
) => Promise<Assistant> = jest
.fn()
.mockImplementation(() => Promise.resolve({}));

const MAP = {
createAssistant: fakeCreateAssistant,
} as ManageAssistantsApi;
return MAP;
};

describe('AssistantCtrlPlane', () => {
let assistantCtrlPlane: AssistantCtrlPlane;
const mockApi = {
createAssistant: jest.fn(),
} as unknown as ManageAssistantsApi;
const mockConfig = { apiKey: 'test-api-key' };
let manageAssistantsApi: ManageAssistantsApi;

beforeEach(() => {
assistantCtrlPlane = new AssistantCtrlPlane(mockConfig, {
assistantApi: mockApi,
});
manageAssistantsApi = setupManageAssistantsApi();
});

describe('createAssistant', () => {
Expand All @@ -24,7 +35,7 @@ describe('AssistantCtrlPlane', () => {
};

await expect(
assistantCtrlPlane.createAssistant(invalidRequest)
createAssistant(manageAssistantsApi)(invalidRequest)
).rejects.toThrow(
'Invalid region specified. Must be one of "us" or "eu"'
);
Expand All @@ -48,7 +59,7 @@ describe('AssistantCtrlPlane', () => {

for (const request of validRequests) {
await expect(
assistantCtrlPlane.createAssistant(request)
createAssistant(manageAssistantsApi)(request)
).resolves.not.toThrow();
}
});
Expand Down
Loading

0 comments on commit 4c343de

Please sign in to comment.