mavenagi 0.0.0-alpha.2

package/Client.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments";
+import * as core from "./core";
+import { Conversation } from "./api/resources/conversation/client/Client";
+import { Knowledge } from "./api/resources/knowledge/client/Client";
+export declare namespace MavenAGIClient {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        organizationId: core.Supplier<string>;
+        agentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class MavenAGIClient {
+    protected readonly _options: MavenAGIClient.Options;
+    constructor(_options: MavenAGIClient.Options);
+    protected _conversation: Conversation | undefined;
+    get conversation(): Conversation;
+    protected _knowledge: Knowledge | undefined;
+    get knowledge(): Knowledge;
+}

package/Client.js

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import { Conversation } from "./api/resources/conversation/client/Client";
+import { Knowledge } from "./api/resources/knowledge/client/Client";
+export class MavenAGIClient {
+    constructor(_options) {
+        this._options = _options;
+    }
+    get conversation() {
+        var _a;
+        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Conversation(this._options)));
+    }
+    get knowledge() {
+        var _a;
+        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Knowledge(this._options)));
+    }
+}

package/README.md

@@ -0,0 +1,129 @@
+# Mavenagi TypeScript Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![npm shield](https://img.shields.io/npm/v/mavenagi)](https://www.npmjs.com/package/mavenagi)
+
+The Mavenagi TypeScript library provides convenient access to the Mavenagi API from TypeScript.
+
+## Installation
+
+```sh
+npm i -s mavenagi
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```typescript
+import { MavenAGIClient } from "mavenagi";
+
+const mavenAgi = new MavenAGIClient({
+    appId: "YOUR_APP_ID",
+    appSecret: "YOUR_APP_SECRET",
+    organizationId: "YOUR_ORGANIZATION_ID",
+    agentId: "YOUR_AGENT_ID",
+});
+await mavenAgi.conversation.initialize({
+    messages: [{}],
+    id: "string",
+    context: {},
+});
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { MavenAGIError } from 'mavenagi';
+
+try {
+    await mavenAgi.initialize(...);
+} catch (err) {
+    if (err instanceof MavenAGIError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
+}
+```
+
+## Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+-   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+-   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+-   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await mavenAgi.initialize(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+## Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await mavenAgi.initialize(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+## Aborting Requests
+
+The SDK allows users to abort requests at any point by passing in an abort signal.
+
+```typescript
+const controller = new AbortController();
+const response = await mavenAgi.initialize(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+## Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+-   Node.js 18+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { MavenAGIClient } from 'mavenagi';
+
+const mavenAgi = new MavenAGIClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/api/index.d.ts

@@ -0,0 +1 @@
+export * from "./resources";

package/api/index.js

@@ -0,0 +1 @@
+export * from "./resources";

package/api/resources/commons/errors/AgentNotFoundError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class AgentNotFoundError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.ErrorMessage);
+}

package/api/resources/commons/errors/AgentNotFoundError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class AgentNotFoundError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "AgentNotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, AgentNotFoundError.prototype);
+    }
+}

package/api/resources/commons/errors/index.d.ts

@@ -0,0 +1 @@
+export * from "./AgentNotFoundError";

package/api/resources/commons/errors/index.js

@@ -0,0 +1 @@
+export * from "./AgentNotFoundError";

package/api/resources/commons/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./errors";

package/api/resources/commons/index.js

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./errors";

package/api/resources/commons/types/ErrorMessage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ErrorMessage {
+    message?: string;
+}

package/api/resources/commons/types/ErrorMessage.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/User.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface User {
+    name?: string;
+    /** The unique ID of the user */
+    id?: Record<string, string>;
+    email?: string;
+}

package/api/resources/commons/types/User.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/commons/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ErrorMessage";
+export * from "./User";

package/api/resources/commons/types/index.js

@@ -0,0 +1,2 @@
+export * from "./ErrorMessage";
+export * from "./User";

package/api/resources/conversation/client/Client.d.ts

@@ -0,0 +1,138 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Conversation {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        organizationId: core.Supplier<string>;
+        agentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Conversation {
+    protected readonly _options: Conversation.Options;
+    constructor(_options: Conversation.Options);
+    /**
+     * Pre-populate a new conversation with messages
+     *
+     * @param {MavenAGI.ConversationRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.ConversationAlreadyExistsError}
+     * @throws {@link MavenAGI.InvalidConversationIdError}
+     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
+     * @throws {@link MavenAGI.EmptyConversationError}
+     * @throws {@link MavenAGI.AgentNotFoundError}
+     *
+     * @example
+     *     await mavenAgi.conversation.initialize({
+     *         messages: [{}],
+     *         id: "string",
+     *         context: {}
+     *     })
+     */
+    initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Get a conversation
+     *
+     * @param {string} conversationId - The ID of a conversation to get
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.ConversationNotFoundError}
+     * @throws {@link MavenAGI.AgentNotFoundError}
+     *
+     * @example
+     *     await mavenAgi.conversation.get("string")
+     */
+    get(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Append messages to an existing conversation. The conversation must be initialized first. If a message with the same id already exists, it will be ignored.
+     *
+     * @param {string} conversationId - The ID of the conversation to append messages to
+     * @param {MavenAGI.ConversationMessageRequest[]} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.ConversationNotFoundError}
+     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
+     * @throws {@link MavenAGI.AgentNotFoundError}
+     *
+     * @example
+     *     await mavenAgi.conversation.appendNewMessages("string", [{
+     *             text: "string",
+     *             userMessageType: MavenAGI.UserConversationMessageType.User,
+     *             id: "string",
+     *             context: {}
+     *         }])
+     */
+    appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Ask a question in a conversation
+     *
+     * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
+     * @param {MavenAGI.AskRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.InvalidConversationIdError}
+     * @throws {@link MavenAGI.AgentNotFoundError}
+     *
+     * @example
+     *     await mavenAgi.conversation.ask("string", {
+     *         id: "string",
+     *         text: "string",
+     *         context: {}
+     *     })
+     */
+    ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Ask a question
+     */
+    askStream(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<core.Stream<MavenAGI.StreamResponse>>;
+    /**
+     * Generate a response suggestion for each requested message id in a conversation
+     *
+     * @param {string} conversationId - The ID of a conversation the messages belong to
+     * @param {MavenAGI.GenerateMavenSuggestionsRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.InvalidConversationIdError}
+     * @throws {@link MavenAGI.ConversationNotFoundError}
+     * @throws {@link MavenAGI.ConversationMessageNotFoundError}
+     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
+     * @throws {@link MavenAGI.AgentNotFoundError}
+     *
+     * @example
+     *     await mavenAgi.conversation.generateMavenSuggestions("string", {
+     *         messageIds: ["string"]
+     *     })
+     */
+    generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Create feedback
+     *
+     * @param {MavenAGI.FeedbackRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.InvalidFeedbackTypeError}
+     * @throws {@link MavenAGI.ConversationMessageNotFoundError}
+     * @throws {@link MavenAGI.AgentNotFoundError}
+     *
+     * @example
+     *     await mavenAgi.conversation.createFeedback({
+     *         conversationMessageId: "string",
+     *         text: "string",
+     *         type: MavenAGI.FeedbackType.ThumbsUp
+     *     })
+     */
+    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}