Sync updates from stainless branch: ehhuang/dev (#27)

Author: ehhuang

src/core.ts

@@ -184,6 +184,7 @@ export class APIPromise<T> extends Promise<T> {
 
 export abstract class APIClient {
   baseURL: string;
+  #baseURLOverridden: boolean;
   maxRetries: number;
   timeout: number;
   httpAgent: Agent | undefined;
@@ -193,18 +194,21 @@ export abstract class APIClient {
 
   constructor({
     baseURL,
+    baseURLOverridden,
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
     fetch: overriddenFetch,
   }: {
     baseURL: string;
+    baseURLOverridden: boolean;
     maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
     fetch: Fetch | undefined;
   }) {
     this.baseURL = baseURL;
+    this.#baseURLOverridden = baseURLOverridden;
     this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
@@ -314,7 +318,7 @@ export abstract class APIClient {
     { retryCount = 0 }: { retryCount?: number } = {},
   ): { req: RequestInit; url: string; timeout: number } {
     const options = { ...inputOptions };
-    const { method, path, query, headers: headers = {} } = options;
+    const { method, path, query, defaultBaseURL, headers: headers = {} } = options;
 
     const body =
       ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
@@ -324,7 +328,7 @@ export abstract class APIClient {
       : null;
     const contentLength = this.calculateContentLength(body);
 
-    const url = this.buildURL(path!, query);
+    const url = this.buildURL(path!, query, defaultBaseURL);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
     options.timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
@@ -517,11 +521,12 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined, defaultBaseURL?: string | undefined): string {
+    const baseURL = (!this.#baseURLOverridden && defaultBaseURL) || this.baseURL;
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
-      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
     if (!isEmptyObj(defaultQuery)) {
@@ -806,6 +811,7 @@ export type RequestOptions<
   query?: Req | undefined;
   body?: Req | null | undefined;
   headers?: Headers | undefined;
+  defaultBaseURL?: string | undefined;
 
   maxRetries?: number;
   stream?: boolean | undefined;
@@ -828,6 +834,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   query: true,
   body: true,
   headers: true,
+  defaultBaseURL: true,
 
   maxRetries: true,
   stream: true,

src/index.ts

@@ -292,6 +292,7 @@ export class LlamaStackClient extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
+      baseURLOverridden: baseURL ? baseURL !== 'http://any-hosted-llama-stack.com' : false,
       timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
@@ -331,6 +332,13 @@ export class LlamaStackClient extends Core.APIClient {
   benchmarks: API.Benchmarks = new API.Benchmarks(this);
   files: API.Files = new API.Files(this);
 
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'http://any-hosted-llama-stack.com';
+  }
+
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
   }

src/resources/vector-stores/vector-stores.ts

@@ -95,7 +95,7 @@ export interface VectorStore {
 
   created_at: number;
 
-  file_counts: Record<string, number>;
+  file_counts: VectorStore.FileCounts;
 
   metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
@@ -114,6 +114,20 @@ export interface VectorStore {
   name?: string;
 }
 
+export namespace VectorStore {
+  export interface FileCounts {
+    cancelled: number;
+
+    completed: number;
+
+    failed: number;
+
+    in_progress: number;
+
+    total: number;
+  }
+}
+
 /**
  * Response from deleting a vector store.
  */
@@ -276,14 +290,25 @@ export interface VectorStoreSearchParams {
   /**
    * Ranking options for fine-tuning the search results.
    */
-  ranking_options?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+  ranking_options?: VectorStoreSearchParams.RankingOptions;
 
   /**
    * Whether to rewrite the natural language query for vector search (default false)
    */
   rewrite_query?: boolean;
 }
 
+export namespace VectorStoreSearchParams {
+  /**
+   * Ranking options for fine-tuning the search results.
+   */
+  export interface RankingOptions {
+    ranker?: string;
+
+    score_threshold?: number;
+  }
+}
+
 VectorStores.Files = Files;
 
 export declare namespace VectorStores {

tests/api-resources/vector-stores/vector-stores.test.ts

@@ -122,7 +122,7 @@ describe('resource vectorStores', () => {
       query: 'string',
       filters: { foo: true },
       max_num_results: 0,
-      ranking_options: { foo: true },
+      ranking_options: { ranker: 'ranker', score_threshold: 0 },
       rewrite_query: true,
     });
   });

tests/index.test.ts

@@ -171,6 +171,28 @@ describe('instantiate client', () => {
       const client = new LlamaStackClient({});
       expect(client.baseURL).toEqual('http://any-hosted-llama-stack.com');
     });
+
+    test('in request options', () => {
+      const client = new LlamaStackClient({});
+      expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual(
+        'http://localhost:5000/option/foo',
+      );
+    });
+
+    test('in request options overridden by client options', () => {
+      const client = new LlamaStackClient({ baseURL: 'http://localhost:5000/client' });
+      expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual(
+        'http://localhost:5000/client/foo',
+      );
+    });
+
+    test('in request options overridden by env variable', () => {
+      process.env['LLAMA_STACK_BASE_URL'] = 'http://localhost:5000/env';
+      const client = new LlamaStackClient({});
+      expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual(
+        'http://localhost:5000/env/foo',
+      );
+    });
   });
 
   test('maxRetries option is correctly set', () => {