use pinecone config provider

ciminf · ciminf · commit 39570da5cc4f · 2022-05-10T14:46:39.000+02:00
change forRoot to register
use config in services
add WhoAmI in index
update config structure
diff --git a/lib/interface/index.ts b/lib/interface/index.ts
@@ -1,7 +1,3 @@
+export * from './indexes';
+export * from './vectors';
 export * from './pinecone.config';
-export * from './fetch.results';
-export * from './index.description';
-export * from './index.stats';
-export * from './pinecone.config';
-export * from './query.results';
-export * from './query';
diff --git a/lib/interface/indexes/index-description-result.ts b/lib/interface/indexes/index-description-result.ts
@@ -1,4 +1,4 @@
-export interface IndexDescription {
+export interface IndexDescriptionResult {
   database: {
     dimension: number;
     index_config: {
diff --git a/lib/interface/indexes/index.ts b/lib/interface/indexes/index.ts
@@ -0,0 +1,3 @@
+export * from './index-description-result';
+export * from './who-am-i-result';
+
diff --git a/lib/interface/indexes/who-am-i-result.ts b/lib/interface/indexes/who-am-i-result.ts
@@ -0,0 +1,5 @@
+export interface WhoAmIResult {
+  project_name: string;
+  user_label: string;
+  user_name: string;
+}
diff --git a/lib/interface/pinecone.config.ts b/lib/interface/pinecone.config.ts
@@ -1,4 +1,22 @@
+export const PINECONE_CONFIG = 'PINECONE_CONFIG';
+
 export interface PineconeConfig {
-  host: string;
+  environment: string;
+  project: string;
   apiKey: string;
+  index?: string;
 }
+
+// TODO for async config
+// export interface PineconeConfigFactory {
+//   createPineconeConfig(): Promise<PineconeConfig> | PineconeConfig;
+// }
+//
+// export interface PineconeAsyncConfig
+//   extends Pick<ModuleMetadata, 'imports'> {
+//   useFactory?: (
+//       ...args: any[]
+//   ) => Promise<PineconeConfig> | PineconeConfig;
+//   inject?: any[];
+//   extraProviders?: Provider[];
+// }
diff --git a/lib/interface/vectors/fetch-results.ts b/lib/interface/vectors/fetch-results.ts
diff --git a/lib/interface/vectors/fetch.ts b/lib/interface/vectors/fetch.ts
@@ -0,0 +1,4 @@
+export interface Fetch {
+  ids: string[];
+  namespace?: string;
+}
diff --git a/lib/interface/vectors/index-stats-results.ts b/lib/interface/vectors/index-stats-results.ts
@@ -1,4 +1,4 @@
-export interface IndexStat {
+export interface IndexStatsResult {
   namespaces: {
     [key: string]: { vectorCount: number };
   };
diff --git a/lib/interface/vectors/index.ts b/lib/interface/vectors/index.ts
@@ -0,0 +1,5 @@
+export * from './fetch';
+export * from './fetch-results';
+export * from './index-stats-results';
+export * from './query';
+export * from './query-results';
diff --git a/lib/interface/vectors/query-results.ts b/lib/interface/vectors/query-results.ts
diff --git a/lib/interface/vectors/query.ts b/lib/interface/vectors/query.ts
diff --git a/lib/pinecone.module.ts b/lib/pinecone.module.ts
@@ -1,26 +1,31 @@
 import { DynamicModule, Module } from '@nestjs/common';
 import { HttpModule } from '@nestjs/axios';
 import { PineconeIndexService, PineconeVectorService } from './service';
-import { PineconeConfig } from './interface';
+import { PINECONE_CONFIG, PineconeConfig } from './interface';
 
 @Module({
   providers: [PineconeIndexService, PineconeVectorService],
 })
 export class PineconeModule {
-  static forRoot(config: PineconeConfig): DynamicModule {
+  static register(config: PineconeConfig): DynamicModule {
     return {
+      module: PineconeModule,
       imports: [
         HttpModule.register({
-          baseURL: config.host,
           headers: {
             'Api-Key': config.apiKey,
             'Content-Type': 'application/json',
           },
         }),
       ],
-      module: PineconeModule,
-      global: true,
-      providers: [PineconeIndexService, PineconeVectorService],
+      providers: [
+        {
+          provide: PINECONE_CONFIG,
+          useValue: config,
+        },
+        PineconeIndexService,
+        PineconeVectorService,
+      ],
       exports: [PineconeIndexService, PineconeVectorService],
     };
   }
diff --git a/lib/service/pinecone.index.service.ts b/lib/service/pinecone.index.service.ts
@@ -1,27 +1,43 @@
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { HttpService } from '@nestjs/axios';
 import { map, Observable } from 'rxjs';
-import { IndexDescription } from '../interface';
+import {
+  IndexDescriptionResult,
+  PINECONE_CONFIG,
+  PineconeConfig,
+  WhoAmIResult,
+} from '../interface';
 
 @Injectable()
 export class PineconeIndexService {
-  constructor(private httpService: HttpService) {}
+  constructor(
+    @Inject(PINECONE_CONFIG) private readonly config: PineconeConfig,
+    private httpService: HttpService,
+  ) {}
+
+  private url(target: string) {
+    return `https://controller.${this.config.environment}.pinecone.io${target}`;
+  }
+
+  whoAmI(): Observable<WhoAmIResult> {
+    return this.httpService.get<WhoAmIResult>(this.url('/actions/whoami')).pipe(
+      map((axiosResponse) => {
+        return axiosResponse.data;
+      }),
+    );
+  }
 
   listIndexes(): Observable<string[]> {
-    return this.httpService
-      .get<string[]>(`https://controller.us-west1-gcp.pinecone.io/databases`)
-      .pipe(
-        map((axiosResponse) => {
-          return axiosResponse.data;
-        }),
-      );
+    return this.httpService.get<string[]>(this.url(`/databases`)).pipe(
+      map((axiosResponse) => {
+        return axiosResponse.data;
+      }),
+    );
   }
 
-  describeIndex(indexName: string): Observable<IndexDescription> {
+  describeIndex(indexName: string): Observable<IndexDescriptionResult> {
     return this.httpService
-      .get<IndexDescription>(
-        `https://controller.us-west1-gcp.pinecone.io/databases/${indexName}`,
-      )
+      .get<IndexDescriptionResult>(this.url(`/databases/${indexName}`))
       .pipe(
         map((axiosResponse) => {
           return axiosResponse.data;
diff --git a/lib/service/pinecone.vector.service.ts b/lib/service/pinecone.vector.service.ts
@@ -1,22 +1,52 @@
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { HttpService } from '@nestjs/axios';
 import { map, Observable } from 'rxjs';
-import { FetchResult, IndexStat, Query, QueryResults } from '../interface';
+import {
+  Fetch,
+  FetchResult,
+  IndexStatsResult,
+  PINECONE_CONFIG,
+  PineconeConfig,
+  Query,
+  QueryResults,
+} from '../interface';
 
 @Injectable()
 export class PineconeVectorService {
-  constructor(private readonly httpService: HttpService) {}
+  constructor(
+    @Inject(PINECONE_CONFIG) private readonly config: PineconeConfig,
+    private readonly httpService: HttpService,
+  ) {}
 
-  describeIndexStats(): Observable<IndexStat> {
-    return this.httpService.get<IndexStat>(`/describe_index_stats`).pipe(
+  private indexUrl(target: string, index?: string) {
+    return `https://${index ? index : this.config.index}-${
+      this.config.project
+    }.svc.${this.config.environment}.pinecone.io${target}`;
+  }
+
+  /**
+   * The DescribeIndexStats operation returns statistics about the index's contents.
+   * @param index index name
+   */
+  describeIndexStats(index?: string): Observable<IndexStatsResult> {
+    const url = this.indexUrl('/describe_index_stats', index);
+
+    return this.httpService.get<IndexStatsResult>(url).pipe(
       map((axiosResponse) => {
         return axiosResponse.data;
       }),
     );
   }
 
-  query(query: Query): Observable<QueryResults> {
-    return this.httpService.post<QueryResults>(`/query`, query).pipe(
+  /**
+   * The Query operation searches a namespace, using one or more query vectors. It retrieves the ids of the most similar items in a namespace, along with their similarity scores.
+   * @param query
+   * @param index
+   */
+  query(query: Query, index?: string): Observable<QueryResults> {
+    const url = this.indexUrl('/query', index);
+
+    return this.httpService.post<QueryResults>(url, query).pipe(
       map((axiosResponse) => {
         return axiosResponse.data;
       }),
@@ -32,15 +62,20 @@ export class PineconeVectorService {
   //   );
   // }
 
-  fetch(query: { ids: string[]; namespace?: string }): Observable<FetchResult> {
+  /**
+   * The Fetch operation looks up and returns vectors, by id, from a single namespace. The returned vectors include the vector data and/or metadata.
+   * @param fetch
+   * @param index
+   */
+  fetch(fetch: Fetch, index?: string): Observable<FetchResult> {
     const params =
       '?' +
-      query.ids.map((id) => 'ids=' + encodeURI(id)).join('&') +
-      (query.namespace ? '&namespace=' + query.namespace : '');
+      fetch.ids.map((id) => 'ids=' + encodeURI(id)).join('&') +
+      (fetch.namespace ? '&namespace=' + fetch.namespace : '');
 
-    console.log(params);
+    const url = this.indexUrl(`/vectors/fetch${params}`, index);
 
-    return this.httpService.get<FetchResult>(`/vectors/fetch${params}`).pipe(
+    return this.httpService.get<FetchResult>(url).pipe(
       map((axiosResponse) => {
         return axiosResponse.data;
       }),

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export interface IndexDescription {`
	`1`	`+export interface IndexDescriptionResult {`
`2`	`2`	`database: {`
`3`	`3`	`dimension: number;`
`4`	`4`	`index_config: {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export * from './index-description-result';`
	`2`	`+export * from './who-am-i-result';`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export interface IndexStat {`
	`1`	`+export interface IndexStatsResult {`
`2`	`2`	`namespaces: {`
`3`	`3`	`[key: string]: { vectorCount: number };`
`4`	`4`	`};`