mavenagi 1.1.0 → 1.2.0

package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeBaseRefreshFrequency = void 0;
+exports.KnowledgeBaseRefreshFrequency = {
+    None: "NONE",
+    Daily: "DAILY",
+    Weekly: "WEEKLY",
+    Monthly: "MONTHLY",
+};

package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts

@@ -16,7 +16,9 @@ import * as MavenAGI from "../../../index";
  *         type: MavenAGI.KnowledgeBaseType.Api,
  *         metadata: {
  *             "key": "value"
- *         }
+ *         },
+ *         tags: new Set(["tag1", "tag2"]),
+ *         refreshFrequency: MavenAGI.KnowledgeBaseRefreshFrequency.Daily
  *     }
  */
 export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties {
@@ -26,4 +28,16 @@ export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties
     type: MavenAGI.KnowledgeBaseType;
     /** Metadata for the knowledge base. */
     metadata: Record<string, string>;
+    /** The tags of the knowledge base. */
+    tags: Set<string>;
+    /** Determines whether documents in the knowledge base are sent to the LLM as part of a conversation. */
+    llmInclusionStatus?: MavenAGI.LlmInclusionStatus;
+    /** How often the knowledge base should be refreshed. */
+    refreshFrequency: MavenAGI.KnowledgeBaseRefreshFrequency;
+    /**
+     * The IDs of the segment that must be matched for the knowledge base to be relevant to a conversation.
+     * Segments are replacing inline preconditions - a Knowledge Base may not have both an inline precondition and a segment.
+     * Inline precondition support will be removed in a future release.
+     */
+    segmentId?: MavenAGI.EntityId;
 }

package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeBaseSearchRequest extends MavenAGI.BasePaginatedRequest {
+    sort?: MavenAGI.KnowledgeBaseField;
+    filter?: MavenAGI.KnowledgeBaseFilter;
+}

package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeBasesResponse extends MavenAGI.Page {
+    /** The knowledge bases that match the search criteria */
+    knowledgeBases: MavenAGI.KnowledgeBaseResponse[];
+}

package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/knowledge/types/KnowledgeDocumentField.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type KnowledgeDocumentField = "Title" | "CreatedAt" | "UpdatedAt" | "Language";
+export declare const KnowledgeDocumentField: {
+    readonly Title: "Title";
+    readonly CreatedAt: "CreatedAt";
+    readonly UpdatedAt: "UpdatedAt";
+    readonly Language: "Language";
+};

package/dist/api/resources/knowledge/types/KnowledgeDocumentField.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeDocumentField = void 0;
+exports.KnowledgeDocumentField = {
+    Title: "Title",
+    CreatedAt: "CreatedAt",
+    UpdatedAt: "UpdatedAt",
+    Language: "Language",
+};

package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface KnowledgeDocumentFilter {
+    /**
+     * Full-text search query for matching knowledge documents by content.
+     * When you search with this parameter, you're performing a full-text search across the knowledge document title and metadata.
+     *
+     * This field also supports a syntax for advanced filtering the `metadata` field.
+     *
+     * Metadata examples:
+     * - `metadata:myvalue` - matches knowledge documents with any metadata field set to `myvalue`
+     * - `metadata.mykey:myvalue` - matches knowledge documents with a metadata field `mykey` set to `myvalue`
+     * - `metadata.mykey:myvalue OR anothervalue` - matches knowledge documents with a metadata field `mykey` set to `myvalue` or `anothervalue`
+     * - `metadata.mykey:*` - matches knowledge documents with a metadata field `mykey`
+     * - `-metadata:myvalue` - matches knowledge documents that do not have any metadata field set to `myvalue`
+     * - `_exists_:metadata` - matches knowledge documents that have any metadata field set
+     */
+    search?: string;
+    /** Filter by title */
+    title?: string;
+    /** Filter knowledge documents created on or after this timestamp */
+    createdAfter?: Date;
+    /** Filter knowledge documents created on or before this timestamp */
+    createdBefore?: Date;
+}

package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeDocumentSearchRequest extends MavenAGI.BasePaginatedRequest {
+    sort?: MavenAGI.KnowledgeDocumentField;
+    filter?: MavenAGI.KnowledgeDocumentFilter;
+}

package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeDocumentSearchResponse extends MavenAGI.BaseKnowledgeDocument {
+    /** ID that uniquely identifies this knowledge document within its knowledge base */
+    knowledgeDocumentId: MavenAGI.EntityId;
+    /** Metadata for the knowledge document. */
+    metadata: Record<string, string>;
+}

package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeDocumentsResponse extends MavenAGI.Page {
+    /** The knowledge documents that match the search criteria. Content will not be included. */
+    knowledgeDocuments: MavenAGI.KnowledgeDocumentSearchResponse[];
+}

package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/knowledge/types/index.d.ts

@@ -2,6 +2,8 @@ export * from "./KnowledgeBaseProperties";
 export * from "./KnowledgeBaseRequest";
 export * from "./KnowledgeBaseResponse";
 export * from "./KnowledgeBaseType";
+export * from "./KnowledgeBaseRefreshFrequency";
+export * from "./KnowledgeBasePatchRequest";
 export * from "./KnowledgeBaseVersion";
 export * from "./KnowledgeBaseVersionType";
 export * from "./KnowledgeBaseVersionStatus";
@@ -11,3 +13,12 @@ export * from "./BaseKnowledgeDocument";
 export * from "./KnowledgeDocumentContentType";
 export * from "./KnowledgeDocumentRequest";
 export * from "./KnowledgeDocumentResponse";
+export * from "./KnowledgeBaseField";
+export * from "./KnowledgeDocumentField";
+export * from "./KnowledgeBaseFilter";
+export * from "./KnowledgeDocumentFilter";
+export * from "./KnowledgeBaseSearchRequest";
+export * from "./KnowledgeBasesResponse";
+export * from "./KnowledgeDocumentSearchRequest";
+export * from "./KnowledgeDocumentSearchResponse";
+export * from "./KnowledgeDocumentsResponse";

package/dist/api/resources/knowledge/types/index.js

@@ -18,6 +18,8 @@ __exportStar(require("./KnowledgeBaseProperties"), exports);
 __exportStar(require("./KnowledgeBaseRequest"), exports);
 __exportStar(require("./KnowledgeBaseResponse"), exports);
 __exportStar(require("./KnowledgeBaseType"), exports);
+__exportStar(require("./KnowledgeBaseRefreshFrequency"), exports);
+__exportStar(require("./KnowledgeBasePatchRequest"), exports);
 __exportStar(require("./KnowledgeBaseVersion"), exports);
 __exportStar(require("./KnowledgeBaseVersionType"), exports);
 __exportStar(require("./KnowledgeBaseVersionStatus"), exports);
@@ -27,3 +29,12 @@ __exportStar(require("./BaseKnowledgeDocument"), exports);
 __exportStar(require("./KnowledgeDocumentContentType"), exports);
 __exportStar(require("./KnowledgeDocumentRequest"), exports);
 __exportStar(require("./KnowledgeDocumentResponse"), exports);
+__exportStar(require("./KnowledgeBaseField"), exports);
+__exportStar(require("./KnowledgeDocumentField"), exports);
+__exportStar(require("./KnowledgeBaseFilter"), exports);
+__exportStar(require("./KnowledgeDocumentFilter"), exports);
+__exportStar(require("./KnowledgeBaseSearchRequest"), exports);
+__exportStar(require("./KnowledgeBasesResponse"), exports);
+__exportStar(require("./KnowledgeDocumentSearchRequest"), exports);
+__exportStar(require("./KnowledgeDocumentSearchResponse"), exports);
+__exportStar(require("./KnowledgeDocumentsResponse"), exports);

package/dist/api/resources/segments/client/Client.d.ts

@@ -0,0 +1,120 @@
+/**
+ * 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 Segments {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
+        organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
+        agentId: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Segments {
+    protected readonly _options: Segments.Options;
+    constructor(_options: Segments.Options);
+    /**
+     * @param {MavenAGI.SegmentsSearchRequest} request
+     * @param {Segments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.segments.search({})
+     */
+    search(request: MavenAGI.SegmentsSearchRequest, requestOptions?: Segments.RequestOptions): core.HttpResponsePromise<MavenAGI.SegmentsSearchResponse>;
+    private __search;
+    /**
+     * Update a segment or create it if it doesn't exist.
+     *
+     * @param {MavenAGI.SegmentRequest} request
+     * @param {Segments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.segments.createOrUpdate({
+     *         segmentId: {
+     *             referenceId: "admin-users"
+     *         },
+     *         name: "Admin users",
+     *         precondition: {
+     *             preconditionType: "group",
+     *             operator: "AND",
+     *             preconditions: [{
+     *                     preconditionType: "user",
+     *                     key: "userKey"
+     *                 }, {
+     *                     preconditionType: "user",
+     *                     key: "userKey2"
+     *                 }]
+     *         }
+     *     })
+     */
+    createOrUpdate(request: MavenAGI.SegmentRequest, requestOptions?: Segments.RequestOptions): core.HttpResponsePromise<MavenAGI.SegmentResponse>;
+    private __createOrUpdate;
+    /**
+     * Get a segment by its supplied ID
+     *
+     * @param {string} segmentReferenceId - The reference ID of the segment to get. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.SegmentGetRequest} request
+     * @param {Segments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.segments.get("admin-users")
+     */
+    get(segmentReferenceId: string, request?: MavenAGI.SegmentGetRequest, requestOptions?: Segments.RequestOptions): core.HttpResponsePromise<MavenAGI.SegmentResponse>;
+    private __get;
+    /**
+     * Update mutable segment fields
+     *
+     * The `appId` field can be provided to update a segment owned by a different app.
+     * All other fields will overwrite the existing value on the segment only if provided.
+     *
+     * @param {string} segmentReferenceId - The reference ID of the segment to update. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.SegmentPatchRequest} request
+     * @param {Segments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.segments.patch("segmentReferenceId", {})
+     */
+    patch(segmentReferenceId: string, request: MavenAGI.SegmentPatchRequest, requestOptions?: Segments.RequestOptions): core.HttpResponsePromise<MavenAGI.SegmentResponse>;
+    private __patch;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}