Refactor the API

Author: Strift

src/chat-workspace.ts

@@ -0,0 +1,47 @@
+import type { HttpRequests } from "./http-requests.js";
+import type {
+  ChatWorkspaceSettings,
+  ChatCompletionRequest,
+} from "./types/types.js";
+
+/**
+ * Class for handling chat workspaces.
+ *
+ * @see {@link https://www.meilisearch.com/docs/reference/api/chats}
+ */
+export class ChatWorkspace {
+  readonly #httpRequest: HttpRequests;
+  readonly #workspace: string;
+
+  constructor(httpRequests: HttpRequests, workspace: string) {
+    this.#httpRequest = httpRequests;
+    this.#workspace = workspace;
+  }
+
+  async get(): Promise<ChatWorkspaceSettings> {
+    return await this.#httpRequest.get({
+      path: `chats/${this.#workspace}/settings`,
+    });
+  }
+
+  async update(
+    settings: Partial<ChatWorkspaceSettings>,
+  ): Promise<ChatWorkspaceSettings> {
+    return await this.#httpRequest.patch({
+      path: `chats/${this.#workspace}/settings`,
+      body: settings,
+    });
+  }
+
+  async streamCompletion(
+    completion: ChatCompletionRequest,
+  ): Promise<ReadableStream<Uint8Array>> {
+    if (!completion.stream) {
+      throw new Error("The SDK only support streaming");
+    }
+    return await this.#httpRequest.postStream({
+      path: `chats/${this.#workspace}/chat/completions`,
+      body: completion,
+    });
+  }
+}

src/meilisearch.ts

@@ -29,8 +29,6 @@ import type {
   Network,
   RecordAny,
   RuntimeTogglableFeatures,
-  WorkspaceSettings,
-  ChatCompletion,
   ResourceResults,
 } from "./types/index.js";
 import { ErrorStatusCode } from "./types/index.js";
@@ -41,6 +39,7 @@ import {
   type HttpRequestsWithEnqueuedTaskPromise,
 } from "./task.js";
 import { BatchClient } from "./batch.js";
+import { ChatWorkspace } from "./chat-workspace.js";
 import type { MeiliSearchApiError } from "./errors/index.js";
 
 export class MeiliSearch {
@@ -277,6 +276,31 @@ export class MeiliSearch {
     });
   }
 
+  ///
+  /// CHATS
+  ///
+
+  /**
+   * Get a chat workspace instance
+   *
+   * @param workspace - The chat workspace UID
+   * @returns Instance of ChatWorkspace
+   */
+  chat(workspace: string): ChatWorkspace {
+    return new ChatWorkspace(this.httpRequest, workspace);
+  }
+
+  /**
+   * Get all chat workspaces
+   *
+   * @returns Promise returning an array of chat workspaces UIDs
+   */
+  async getChatWorkspaces(): Promise<ResourceResults<{ uid: string }[]>> {
+    return await this.httpRequest.get({
+      path: "chats",
+    });
+  }
+
   ///
   ///  Network
   ///
@@ -302,45 +326,6 @@ export class MeiliSearch {
     });
   }
 
-  ///
-  /// CHATS
-  ///
-
-  async getWorkspaceSettings(workspace: string): Promise<WorkspaceSettings> {
-    return await this.httpRequest.get({
-      path: `chats/${workspace}/settings`,
-    });
-  }
-
-  async updateWorkspaceSettings(
-    workspace: string,
-    settings: Partial<WorkspaceSettings>,
-  ): Promise<WorkspaceSettings> {
-    return await this.httpRequest.patch({
-      path: `chats/${workspace}/settings`,
-      body: settings,
-    });
-  }
-
-  async listWorkspaces(): Promise<ResourceResults<{ uid: string }[]>> {
-    return await this.httpRequest.get({
-      path: "chats",
-    });
-  }
-
-  async createChatCompletion(
-    workspace: string,
-    completion: ChatCompletion,
-  ): Promise<ReadableStream<Uint8Array>> {
-    if (!completion.stream) {
-      throw new Error("The SDK only support streaming");
-    }
-    return await this.httpRequest.postStream({
-      path: `chats/${workspace}/chat/completions`,
-      body: completion,
-    });
-  }
-
   ///
   /// KEYS
   ///

src/types/types.ts

@@ -704,7 +704,7 @@ export type Stats = {
  */
 
 /** @see https://www.meilisearch.com/docs/reference/api/chats#settings-parameters */
-export type WorkspaceSettings = {
+export type ChatWorkspaceSettings = {
   source: "openAi" | "azureOpenAi" | "mistral" | "gemini" | "vLlm";
   orgId?: string;
   projectId?: string;
@@ -717,7 +717,7 @@ export type WorkspaceSettings = {
   };
 };
 
-export type ChatCompletion = {
+export type ChatCompletionRequest = {
   model: string;
   messages: {
     role: "user" | "assistant" | "system";

tests/chat.test.ts

@@ -1,6 +1,6 @@
 import { beforeAll, expect, test } from "vitest";
 import { getClient, dataset } from "./utils/meilisearch-test-utils.js";
-import type { WorkspaceSettings } from "../src/types/types.js";
+import type { ChatWorkspaceSettings } from "../src/types/types.js";
 
 beforeAll(async () => {
   const client = await getClient("Admin");
@@ -27,7 +27,7 @@ const WORKSPACE_SETTINGS = {
     system:
       "You are a helpful assistant that answers questions based on the provided context.",
   },
-} satisfies WorkspaceSettings;
+} satisfies ChatWorkspaceSettings;
 
 const WORKSPACE_SETTINGS_WITHOUT_API_KEY = {
   ...WORKSPACE_SETTINGS,
@@ -38,30 +38,27 @@ const WORKSPACE_SETTINGS_WITHOUT_API_KEY = {
 test("it can update workspace settings", async () => {
   const client = await getClient("Admin");
 
-  const response = await client.updateWorkspaceSettings(
-    "myWorkspace",
-    WORKSPACE_SETTINGS,
-  );
+  const response = await client.chat("myWorkspace").update(WORKSPACE_SETTINGS);
   expect(response).toMatchObject(WORKSPACE_SETTINGS_WITHOUT_API_KEY);
 });
 
 test("it can get workspace settings", async () => {
   const client = await getClient("Admin");
-  await client.updateWorkspaceSettings("myWorkspace", WORKSPACE_SETTINGS);
-  const response = await client.getWorkspaceSettings("myWorkspace");
+  await client.chat("myWorkspace").update(WORKSPACE_SETTINGS);
+  const response = await client.chat("myWorkspace").get();
   expect(response).toMatchObject(WORKSPACE_SETTINGS_WITHOUT_API_KEY);
 });
 
 test("it can list workspaces", async () => {
   const client = await getClient("Admin");
-  await client.updateWorkspaceSettings("myWorkspace", WORKSPACE_SETTINGS);
-  const response = await client.listWorkspaces();
+  await client.chat("myWorkspace").update(WORKSPACE_SETTINGS);
+  const response = await client.getChatWorkspaces();
   expect(response.results).toEqual([{ uid: "myWorkspace" }]);
 });
 
 test("it can create a chat completion (streaming)", async () => {
   const client = await getClient("Chat");
-  const stream = await client.createChatCompletion("myWorkspace", {
+  const stream = await client.chat("myWorkspace").streamCompletion({
     model: "gpt-4o-mini",
     messages: [
       {