feat(askfern): Add index and chat API definitons. (#3276)

Author: eyw520

.prettierignore

@@ -1,6 +1,6 @@
 .DS_Store
 
-
+servers/fai
 lib
 build
 **/dist/**

fern/apis/fai/definition/analytics.yml

@@ -1,4 +1,4 @@
-docs: APIs for the FAI (Acorn) Service
+docs: FAI Analytics API
 
 imports:
   commons: ./commons.yml

fern/apis/fai/definition/chat.yml

@@ -0,0 +1,36 @@
+docs: FAI Chat API
+
+imports:
+  commons: ./commons.yml
+
+service:
+  auth: false
+  base-path: /chat
+  endpoints:
+    chatCompletion:
+      docs: Create a docs chat completion for a given domain
+      path: /{domain}
+      method: POST
+      path-parameters:
+        domain: string
+      request:
+        name: ChatCompletionRequest
+        body:
+          properties:
+            model: optional<string>
+            system_prompt: optional<string>
+            messages: list<ChatTurn>
+      response: ChatCompletionResponse
+      errors:
+        - commons.BadRequestError
+        - commons.InternalError
+
+types:
+  ChatCompletionResponse:
+    properties:
+      turn: ChatTurn
+
+  ChatTurn:
+    properties:
+      role: string
+      text: string

fern/apis/fai/definition/index.yml

@@ -0,0 +1,35 @@
+docs: FAI Index API
+
+imports:
+  commons: ./commons.yml
+
+service:
+  auth: false
+  base-path: /index
+  endpoints:
+    indexDocument:
+      docs: Index a document for a given domain
+      path: /{domain}
+      method: POST
+      path-parameters:
+        domain: string
+      request:
+        name: IndexRequest
+        body:
+          properties:
+            index_name:
+              type: optional<string>
+              default: custom
+              docs: The name of the index to which the document will be added
+            document_id:
+              type: string
+              docs: A unique identifier for the document
+            context:
+              type: string
+              docs: The context of the document that will be indexed
+            content:
+              type: string
+              docs: The content of the document that will be returned in the tool response
+      errors:
+        - commons.BadRequestError
+        - commons.InternalError

packages/fai-sdk/README.md

@@ -23,15 +23,19 @@ Instantiate and use the client with the following:
 import { FernFaiClient } from "@fern-api/fai-sdk";
 
 const client = new FernFaiClient({ token: "YOUR_TOKEN" });
-await client.queries.createQuery({
-    query_id: "query_id",
-    conversation_id: "conversation_id",
-    domain: "domain",
-    text: "text",
-    role: "role",
-    source: "source",
-    created_at: "2024-01-15T09:30:00Z",
-    time_to_first_token: undefined,
+await client.chat.chatCompletion("domain", {
+    model: undefined,
+    system_prompt: undefined,
+    messages: [
+        {
+            role: "role",
+            text: "text",
+        },
+        {
+            role: "role",
+            text: "text",
+        },
+    ],
 });
 ```
 
@@ -57,7 +61,7 @@ will be thrown.
 import { FernFaiError } from "@fern-api/fai-sdk";
 
 try {
-    await client.queries.createQuery(...);
+    await client.chat.chatCompletion(...);
 } catch (err) {
     if (err instanceof FernFaiError) {
         console.log(err.statusCode);
@@ -75,7 +79,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.queries.createQuery(..., {
+const response = await client.chat.chatCompletion(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -97,7 +101,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.queries.createQuery(..., {
+const response = await client.chat.chatCompletion(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -107,7 +111,7 @@ const response = await client.queries.createQuery(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.queries.createQuery(..., {
+const response = await client.chat.chatCompletion(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -118,7 +122,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.queries.createQuery(..., {
+const response = await client.chat.chatCompletion(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -130,7 +134,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.queries.createQuery(...).withRawResponse();
+const { data, rawResponse } = await client.chat.chatCompletion(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);

packages/fai-sdk/reference.md

@@ -146,6 +146,92 @@ await client.analytics.getInsights("domain");
 </dl>
 </details>
 
+## Chat
+
+<details><summary><code>client.chat.<a href="/src/api/resources/chat/client/Client.ts">chatCompletion</a>(domain, { ...params }) -> FernFai.ChatCompletionResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a docs chat completion for a given domain
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chat.chatCompletion("domain", {
+    model: undefined,
+    system_prompt: undefined,
+    messages: [
+        {
+            role: "role",
+            text: "text",
+        },
+        {
+            role: "role",
+            text: "text",
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**domain:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `FernFai.ChatCompletionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Chat.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Conversations
 
 <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">getConversation</a>(domain, conversationId) -> FernFai.Conversation</code></summary>
@@ -219,6 +305,84 @@ await client.conversations.getConversation("domain", "conversation_id");
 </dl>
 </details>
 
+## Index
+
+<details><summary><code>client.index.<a href="/src/api/resources/index/client/Client.ts">indexDocument</a>(domain, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Index a document for a given domain
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.index.indexDocument("domain", {
+    index_name: undefined,
+    document_id: "document_id",
+    context: "context",
+    content: "content",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**domain:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `FernFai.IndexRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Index.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Queries
 
 <details><summary><code>client.queries.<a href="/src/api/resources/queries/client/Client.ts">createQuery</a>({ ...params }) -> void</code></summary>

packages/fai-sdk/src/Client.ts

@@ -6,7 +6,9 @@ import * as environments from "./environments.js";
 import * as core from "./core/index.js";
 import { mergeHeaders } from "./core/headers.js";
 import { Analytics } from "./api/resources/analytics/client/Client.js";
+import { Chat } from "./api/resources/chat/client/Client.js";
 import { Conversations } from "./api/resources/conversations/client/Client.js";
+import { Index } from "./api/resources/index/client/Client.js";
 import { Queries } from "./api/resources/queries/client/Client.js";
 
 export declare namespace FernFaiClient {
@@ -34,7 +36,9 @@ export declare namespace FernFaiClient {
 export class FernFaiClient {
     protected readonly _options: FernFaiClient.Options;
     protected _analytics: Analytics | undefined;
+    protected _chat: Chat | undefined;
     protected _conversations: Conversations | undefined;
+    protected _index: Index | undefined;
     protected _queries: Queries | undefined;
 
     constructor(_options: FernFaiClient.Options = {}) {
@@ -44,7 +48,7 @@ export class FernFaiClient {
                 {
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@fern-api/fai-sdk",
-                    "X-Fern-SDK-Version": "0.0.38",
+                    "X-Fern-SDK-Version": "0.0.43",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -57,10 +61,18 @@ export class FernFaiClient {
         return (this._analytics ??= new Analytics(this._options));
     }
 
+    public get chat(): Chat {
+        return (this._chat ??= new Chat(this._options));
+    }
+
     public get conversations(): Conversations {
         return (this._conversations ??= new Conversations(this._options));
     }
 
+    public get index(): Index {
+        return (this._index ??= new Index(this._options));
+    }
+
     public get queries(): Queries {
         return (this._queries ??= new Queries(this._options));
     }