Added support for all List type API calls

common/api-review/generative-ai-server.api.md

@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 // Warning: (ae-incompatible-release-tags) The symbol "ArraySchema" is marked as @public, but its signature references "BaseSchema" which is marked as @internal
 //
 // @public
@@ -31,8 +33,6 @@ export interface BooleanSchema extends BaseSchema {
     type: typeof SchemaType.BOOLEAN;
 }
 
-/// <reference types="node" />
-
 // @public
 export interface CachedContent extends CachedContentBase {
     createTime?: string;

common/api-review/generative-ai.api.md

@@ -537,6 +537,7 @@ export class GoogleGenerativeAI {
     apiKey: string;
     getGenerativeModel(modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
     getGenerativeModelFromCachedContent(cachedContent: CachedContent, modelParams?: Partial<ModelParams>, requestOptions?: RequestOptions): GenerativeModel;
+    listModels(pageSize?: number, pageToken?: string, requestOptions?: RequestOptions): Promise<Response>;
 }
 
 // @public

src/gen-ai.test.ts

@@ -118,4 +118,114 @@ describe("GoogleGenerativeAI", () => {
       `Different value for "systemInstruction" specified in modelParams (yo) and cachedContent (hi)`,
     );
   });
+
+  it("listModels gets a Response without any params passed", () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listModels();
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listModels gets a Response when passed only pageSize", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listModels({ pageSize: 10 });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listModels gets a Response when passed only pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listModels({ pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listModels gets a Response when passed both pageSize and pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listModels({ pageSize: 10, pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+
+  it("listTunedModels gets a Response without any params passed", () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listTunedModels();
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listTunedModels gets a Response when passed only pageSize", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listTunedModels({ pageSize: 10 });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listTunedModels gets a Response when passed only pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listTunedModels({ pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listTunedModels gets a Response when passed only filter", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listTunedModels({ filter: "filter" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listTunedModels gets a Response when passed all params pageSize, pageToken and filter", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listTunedModels({ pageSize: 10, pageToken: "token", filter: "filter" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+
+  it("listCachedContent gets a Response without any params passed", () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCachedContent();
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listCachedContent gets a Response when passed only pageSize", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCachedContent({ pageSize: 10 });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listCachedContent gets a Response when passed only pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCachedContent({ pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listCachedContent gets a Response when passed both pageSize and pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCachedContent({ pageSize: 10, pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+
+  it("listCorpora gets a Response without any params passed", () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCorpora();
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listCorpora gets a Response when passed only pageSize", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCorpora({ pageSize: 10 });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listCorpora gets a Response when passed only pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCorpora({ pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listCorpora gets a Response when passed both pageSize and pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listCorpora({ pageSize: 10, pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+
+  it("listFiles gets a Response without any params passed", () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listFiles();
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listFiles gets a Response when passed only pageSize", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listFiles({ pageSize: 10 });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listFiles gets a Response when passed only pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listFiles({ pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
+  it("listFiles gets a Response when passed both pageSize and pageToken", async () => {
+    const genAI = new GoogleGenerativeAI("apikey");
+    const genModel = genAI.listFiles({ pageSize: 10, pageToken: "token" });
+    expect(genModel).to.be.an.instanceOf(Promise<Response>);
+  });
 });

src/gen-ai.ts

@@ -21,6 +21,7 @@ import {
 } from "./errors";
 import { CachedContent, ModelParams, RequestOptions } from "../types";
 import { GenerativeModel } from "./models/generative-model";
+import { List, makeListRequest } from "./requests/request-list";
 
 export { ChatSession } from "./methods/chat-session";
 export { GenerativeModel };
@@ -30,7 +31,7 @@ export { GenerativeModel };
  * @public
  */
 export class GoogleGenerativeAI {
-  constructor(public apiKey: string) {}
+  constructor(public apiKey: string) { }
 
   /**
    * Gets a {@link GenerativeModel} instance for the provided model name.
@@ -42,7 +43,7 @@ export class GoogleGenerativeAI {
     if (!modelParams.model) {
       throw new GoogleGenerativeAIError(
         `Must provide a model name. ` +
-          `Example: genai.getGenerativeModel({ model: 'my-model-name' })`,
+        `Example: genai.getGenerativeModel({ model: 'my-model-name' })`,
       );
     }
     return new GenerativeModel(this.apiKey, modelParams, requestOptions);
@@ -93,7 +94,7 @@ export class GoogleGenerativeAI {
         }
         throw new GoogleGenerativeAIRequestInputError(
           `Different value for "${key}" specified in modelParams` +
-            ` (${modelParams[key]}) and cachedContent (${cachedContent[key]})`,
+          ` (${modelParams[key]}) and cachedContent (${cachedContent[key]})`,
         );
       }
     }
@@ -112,4 +113,115 @@ export class GoogleGenerativeAI {
       requestOptions,
     );
   }
+
+  /**
+   * Gets a list of {@link GenerativeModel} available.
+   */
+  async listModels(
+    params: { pageSize?: number; pageToken?: string } = {},
+    requestOptions?: RequestOptions,
+  ): Promise<Response> {
+
+    const filteredParams = Object.fromEntries(
+      Object.entries({ params }).filter(([_, v]) => v != null)
+    );
+
+    const response = await makeListRequest(
+      List.MODELS,
+      this.apiKey,
+      filteredParams,
+      requestOptions,
+    );
+
+    return response.json();
+  }
+
+  /**
+   * Gets a list of tuned {@link GenerativeModel} available.
+   */
+  async listTunedModels(
+    params: { pageSize?: number; pageToken?: string; filter?: string } = {},
+    requestOptions?: RequestOptions,
+  ): Promise<Response> {
+
+    const filteredParams = Object.fromEntries(
+      Object.entries({ params }).filter(([_, v]) => v != null)
+    );
+
+    const response = await makeListRequest(
+      List.TUNED_MODELS,
+      this.apiKey,
+      filteredParams,
+      requestOptions,
+    );
+
+    return response.json();
+  }
+
+  /**
+   * Gets a list of CachedContent.
+   */
+  async listCachedContent(
+    params: { pageSize?: number; pageToken?: string } = {},
+    requestOptions?: RequestOptions,
+  ): Promise<Response> {
+
+    const filteredParams = Object.fromEntries(
+      Object.entries({ params }).filter(([_, v]) => v != null)
+    );
+
+    const response = await makeListRequest(
+      List.CASHED_CONTENTS,
+      this.apiKey,
+      filteredParams,
+      requestOptions,
+    );
+
+    return response.json();
+  }
+
+  /**
+   * Gets a list of all Corpora owned by the user.
+   */
+  async listCorpora(
+    params: { pageSize?: number; pageToken?: string } = {},
+    requestOptions?: RequestOptions,
+  ): Promise<Response> {
+
+    const filteredParams = Object.fromEntries(
+      Object.entries({ params }).filter(([_, v]) => v != null)
+    );
+
+    const response = await makeListRequest(
+      List.CORPORA,
+      this.apiKey,
+      filteredParams,
+      requestOptions,
+    );
+
+    return response.json();
+  }
+
+  /**
+   * Gets a list of the metadata for Files owned by the requesting project.
+   */
+  async listFiles(
+    params: { pageSize?: number; pageToken?: string } = {},
+    requestOptions?: RequestOptions,
+  ): Promise<Response> {
+
+    const filteredParams = Object.fromEntries(
+      Object.entries({ params }).filter(([_, v]) => v != null)
+    );
+
+    const response = await makeListRequest(
+      List.CORPORA,
+      this.apiKey,
+      filteredParams,
+      requestOptions,
+    );
+
+    return response.json();
+  }
+
 }