feat(askfern): Support custom context indexing. (#3278)

Author: eyw520

fern/apis/fai/definition/index.yml

@@ -25,11 +25,65 @@ service:
               type: string
               docs: A unique identifier for the document
             context:
-              type: string
-              docs: The context of the document that will be indexed
+              type: list<string>
+              docs: The context of the document, as a list of strings, 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
+
+    getDocument:
+      docs: Get a document for a given domain
+      path: /{domain}
+      method: GET
+      path-parameters:
+        domain: string
+      request:
+        name: GetRequest
+        query-parameters:
+          document_id:
+            type: string
+            docs: The unique identifier of the document to get
+      errors:
+        - commons.BadRequestError
+        - commons.InternalError
+
+    updateDocument:
+      docs: Update a document for a given domain
+      path: /{domain}/update
+      method: POST
+      path-parameters:
+        domain: string
+      request:
+        name: UpdateRequest
+        query-parameters:
+          document_id:
+            type: string
+            docs: The unique identifier of the document to update
+          is_active:
+            type: boolean
+            docs: Whether the document is active
+          context:
+            type: list<string>
+            docs: The context of the document, as a list of strings, that will be indexed.
+          content:
+            type: string
+            docs: The content of the document that will be returned in the tool response. If not provided, the document will be removed from the index.
+      response: ContextResponse
+      errors:
+        - commons.BadRequestError
+        - commons.InternalError
+
+types:
+  ContextResponse:
+    properties:
+      document_id: string
+      domain: string
+      context_id: string
+      context: list<string>
+      content: string
+      is_active: boolean
+      created_at: datetime
+      updated_at: datetime

packages/fai-sdk/reference.md

@@ -338,7 +338,7 @@ Index a document for a given domain
 await client.index.indexDocument("domain", {
     index_name: undefined,
     document_id: "document_id",
-    context: "context",
+    context: ["context", "context"],
     content: "content",
 });
 ```
@@ -383,6 +383,155 @@ await client.index.indexDocument("domain", {
 </dl>
 </details>
 
+<details><summary><code>client.index.<a href="/src/api/resources/index/client/Client.ts">getDocument</a>(domain, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get a document for a given domain
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.index.getDocument("domain", {
+    document_id: "document_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**domain:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `FernFai.GetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Index.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.index.<a href="/src/api/resources/index/client/Client.ts">updateDocument</a>(domain, { ...params }) -> FernFai.ContextResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update a document for a given domain
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.index.updateDocument("domain", {
+    document_id: "document_id",
+    is_active: true,
+    context: ["context", "context"],
+    content: "content",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**domain:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `FernFai.UpdateRequest`
+
+</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

@@ -48,7 +48,7 @@ export class FernFaiClient {
                 {
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@fern-api/fai-sdk",
-                    "X-Fern-SDK-Version": "0.0.43",
+                    "X-Fern-SDK-Version": "0.0.51",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

packages/fai-sdk/src/api/resources/index.ts

@@ -4,11 +4,12 @@ export * as chat from "./chat/index.js";
 export * from "./chat/types/index.js";
 export * as conversations from "./conversations/index.js";
 export * from "./conversations/types/index.js";
+export * as index from "./index/index.js";
+export * from "./index/types/index.js";
 export * as queries from "./queries/index.js";
 export * from "./queries/types/index.js";
 export * as commons from "./commons/index.js";
 export * from "./commons/errors/index.js";
-export * as index from "./index/index.js";
 export * from "./analytics/client/requests/index.js";
 export * from "./chat/client/requests/index.js";
 export * from "./index/client/requests/index.js";