@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/knowledgeBase.d.ts

@@ -0,0 +1,84 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.knowledgeBase` (Knowledge Base): 2 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"list_kb_documents_repos__repo_id__kb_get">;
+ *
+ * Reference with examples: knowledgeBase.md
+ */
+/* eslint-disable */
+
+/** `g8.api.knowledgeBase.<member>` -> the operationId it calls. */
+export interface KnowledgeBaseMembers {
+  listKbDocuments: "list_kb_documents_repos__repo_id__kb_get";
+  searchKb: "search_kb_repos__repo_id__kb_search_post";
+}
+
+/** Input and output of every `g8.api.knowledgeBase` operation, keyed by operationId. */
+export interface KnowledgeBaseOperations {
+  /**
+   * GET /repos/{repo_id}/kb
+   * List Kb Documents
+   * tier: read · scope: knowledge:read
+   */
+  list_kb_documents_repos__repo_id__kb_get: {
+    input: {
+    path: {
+      /** Repository ID */
+      repo_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_dict__;
+  };
+  /**
+   * POST /repos/{repo_id}/kb/search
+   * Search Kb
+   * tier: write · scope: knowledge:write
+   */
+  search_kb_repos__repo_id__kb_search_post: {
+    input: {
+    path: {
+      /** Repository ID */
+      repo_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: KBSearchRequest;
+  };
+    output: ApiResponse_list_dict__;
+  };
+}
+
+// 3 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_list_dict__ {
+  data: Array<Record<string, unknown>>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface KBSearchRequest {
+  /** Max results */
+  limit?: number;
+  /** Search query */
+  query: string;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}

package/docs/api/knowledgeBase.md

@@ -0,0 +1,96 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.knowledgeBase`: Knowledge Base
+
+2 operations (1 read, 1 write).
+
+No hand-written client covers this area. Call it through `g8.api.knowledgeBase.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [knowledgeBase.d.ts](knowledgeBase.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`listKbDocuments`](#op-listkbdocuments) | `GET /api/v1/repos/{repo_id}/kb` | read | `knowledge:read` | List Kb Documents |
+| [`searchKb`](#op-searchkb) | `POST /api/v1/repos/{repo_id}/kb/search` | write | `knowledge:write` | Search Kb |
+
+---
+
+<a id="op-listkbdocuments"></a>
+
+### `g8.api.knowledgeBase.listKbDocuments(input)`
+
+**List Kb Documents**
+
+- HTTP: `GET /api/v1/repos/{repo_id}/kb`
+- operationId: `list_kb_documents_repos__repo_id__kb_get` (also callable as `g8.api.call("list_kb_documents_repos__repo_id__kb_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `knowledge:read`
+
+List all KB documents grouped by section.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+
+**Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.knowledgeBase.listKbDocuments({ path: { repo_id: "id" } });
+```
+
+---
+
+<a id="op-searchkb"></a>
+
+### `g8.api.knowledgeBase.searchKb(input)`
+
+**Search Kb**
+
+- HTTP: `POST /api/v1/repos/{repo_id}/kb/search`
+- operationId: `search_kb_repos__repo_id__kb_search_post` (also callable as `g8.api.call("search_kb_repos__repo_id__kb_search_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `knowledge:write`
+
+Search the GTM knowledge base using full-text search.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.repo_id` | `string` | yes | Repository ID |
+| `body` | `KBSearchRequest` | yes | Request body; fields below. |
+
+Body fields (`KBSearchRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.query` | `string` | yes | Search query |
+| `body.limit` | `integer` | no | Max results default `10`, min 1, max 50 |
+
+**Returns** `ApiResponse_list_dict__`: the envelope `{ data: Array<Record<string, unknown>>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.knowledgeBase.searchKb({ path: { repo_id: "id" }, body: { query: "example" } });
+```