mavenagi 1.2.8 → 1.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/Client.js +2 -2
  2. package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +1 -1
  3. package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +9 -1
  4. package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +12 -0
  5. package/dist/Client.js +2 -2
  6. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +1 -1
  7. package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +9 -1
  8. package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +12 -0
  9. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +2 -0
  10. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +2 -0
  11. package/dist/version.d.ts +1 -1
  12. package/dist/version.js +1 -1
  13. package/package.json +1 -1
  14. package/reference.md +1 -1
  15. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +2 -0
  16. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +2 -0
  17. package/version.d.ts +1 -1
  18. package/version.js +1 -1
package/Client.js CHANGED
@@ -58,8 +58,8 @@ class MavenAGIClient {
58
58
  "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
59
59
  "X-Fern-Language": "JavaScript",
60
60
  "X-Fern-SDK-Name": "mavenagi",
61
- "X-Fern-SDK-Version": "1.2.8",
62
- "User-Agent": "mavenagi/1.2.8",
61
+ "X-Fern-SDK-Version": "1.2.9",
62
+ "User-Agent": "mavenagi/1.2.9",
63
63
  "X-Fern-Runtime": core.RUNTIME.type,
64
64
  "X-Fern-Runtime-Version": core.RUNTIME.version,
65
65
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts CHANGED
@@ -27,7 +27,7 @@ export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument
27
27
  contentType: MavenAGI.KnowledgeDocumentContentType;
28
28
  /** The title of the document. Will be shown as part of answers. */
29
29
  title: string;
30
- /** ID of the asset associated with this document. Either this or content is required, but not both */
30
+ /** ID of the asset associated with this document. This asset will be transformed into text and set as the content of the document. The following types are supported: `application/pdf`, `text/plain`. Either this or content is required, but not both */
31
31
  assetId?: MavenAGI.EntityIdBase;
32
32
  /** The content of the document. Not shown directly to users. May be provided in HTML or markdown. HTML will be converted to markdown automatically. Images are not currently supported and will be ignored. Either this or assetId is required, but not both */
33
33
  content?: string;
package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts CHANGED
@@ -16,6 +16,13 @@ import * as MavenAGI from "../../../index";
16
16
  * agentId: "support",
17
17
  * type: MavenAGI.EntityType.KnowledgeBaseVersion
18
18
  * },
19
+ * knowledgeBaseId: {
20
+ * referenceId: "help-docs",
21
+ * appId: "help-center",
22
+ * organizationId: "acme",
23
+ * agentId: "support",
24
+ * type: MavenAGI.EntityType.KnowledgeBase
25
+ * },
19
26
  * content: "## Getting started This is a getting started guide for the help center.",
20
27
  * title: "Getting started",
21
28
  * metadata: {
@@ -23,7 +30,8 @@ import * as MavenAGI from "../../../index";
23
30
  * },
24
31
  * createdAt: new Date("2024-01-01T00:00:00.000Z"),
25
32
  * updatedAt: new Date("2024-02-02T00:00:00.000Z"),
26
- * llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
33
+ * llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
34
+ * knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
27
35
  * }
28
36
  */
29
37
  export interface KnowledgeDocumentResponse extends MavenAGI.KnowledgeDocumentSearchResponse {
package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts CHANGED
@@ -16,8 +16,16 @@ import * as MavenAGI from "../../../index";
16
16
  * agentId: "support",
17
17
  * type: MavenAGI.EntityType.KnowledgeBaseVersion
18
18
  * },
19
+ * knowledgeBaseId: {
20
+ * referenceId: "help-docs",
21
+ * appId: "help-center",
22
+ * organizationId: "acme",
23
+ * agentId: "support",
24
+ * type: MavenAGI.EntityType.KnowledgeBase
25
+ * },
19
26
  * title: "How it works",
20
27
  * llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
28
+ * knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus.Never,
21
29
  * url: "https://help-center.acme.com/how-it-works",
22
30
  * createdAt: new Date("2024-01-01T00:00:00.000Z"),
23
31
  * updatedAt: new Date("2024-02-02T00:00:00.000Z")
@@ -31,10 +39,14 @@ export interface KnowledgeDocumentSearchResponse extends MavenAGI.BaseKnowledgeD
31
39
  * This may be missing on legacy documents.
32
40
  */
33
41
  knowledgeBaseVersionId?: MavenAGI.EntityId;
42
+ /** ID that uniquely identifies the knowledge base that contains this document. */
43
+ knowledgeBaseId: MavenAGI.EntityId;
34
44
  /** The title of the document. Will be shown as part of answers. May be missing on legacy documents. */
35
45
  title?: string;
36
46
  /** Whether the document is included in the agent's knowledge. */
37
47
  llmInclusionStatus: MavenAGI.LlmInclusionStatus;
48
+ /** Whether the knowledge base is included in the agent's knowledge. */
49
+ knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus;
38
50
  /** The time at which this document was created. */
39
51
  createdAt: Date;
40
52
  /** The time at which this document was last modified. */
package/dist/Client.js CHANGED
@@ -58,8 +58,8 @@ class MavenAGIClient {
58
58
  "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
59
59
  "X-Fern-Language": "JavaScript",
60
60
  "X-Fern-SDK-Name": "mavenagi",
61
- "X-Fern-SDK-Version": "1.2.8",
62
- "User-Agent": "mavenagi/1.2.8",
61
+ "X-Fern-SDK-Version": "1.2.9",
62
+ "User-Agent": "mavenagi/1.2.9",
63
63
  "X-Fern-Runtime": core.RUNTIME.type,
64
64
  "X-Fern-Runtime-Version": core.RUNTIME.version,
65
65
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts CHANGED
@@ -27,7 +27,7 @@ export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument
27
27
  contentType: MavenAGI.KnowledgeDocumentContentType;
28
28
  /** The title of the document. Will be shown as part of answers. */
29
29
  title: string;
30
- /** ID of the asset associated with this document. Either this or content is required, but not both */
30
+ /** ID of the asset associated with this document. This asset will be transformed into text and set as the content of the document. The following types are supported: `application/pdf`, `text/plain`. Either this or content is required, but not both */
31
31
  assetId?: MavenAGI.EntityIdBase;
32
32
  /** The content of the document. Not shown directly to users. May be provided in HTML or markdown. HTML will be converted to markdown automatically. Images are not currently supported and will be ignored. Either this or assetId is required, but not both */
33
33
  content?: string;
package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts CHANGED
@@ -16,6 +16,13 @@ import * as MavenAGI from "../../../index";
16
16
  * agentId: "support",
17
17
  * type: MavenAGI.EntityType.KnowledgeBaseVersion
18
18
  * },
19
+ * knowledgeBaseId: {
20
+ * referenceId: "help-docs",
21
+ * appId: "help-center",
22
+ * organizationId: "acme",
23
+ * agentId: "support",
24
+ * type: MavenAGI.EntityType.KnowledgeBase
25
+ * },
19
26
  * content: "## Getting started This is a getting started guide for the help center.",
20
27
  * title: "Getting started",
21
28
  * metadata: {
@@ -23,7 +30,8 @@ import * as MavenAGI from "../../../index";
23
30
  * },
24
31
  * createdAt: new Date("2024-01-01T00:00:00.000Z"),
25
32
  * updatedAt: new Date("2024-02-02T00:00:00.000Z"),
26
- * llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
33
+ * llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
34
+ * knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
27
35
  * }
28
36
  */
29
37
  export interface KnowledgeDocumentResponse extends MavenAGI.KnowledgeDocumentSearchResponse {
package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts CHANGED
@@ -16,8 +16,16 @@ import * as MavenAGI from "../../../index";
16
16
  * agentId: "support",
17
17
  * type: MavenAGI.EntityType.KnowledgeBaseVersion
18
18
  * },
19
+ * knowledgeBaseId: {
20
+ * referenceId: "help-docs",
21
+ * appId: "help-center",
22
+ * organizationId: "acme",
23
+ * agentId: "support",
24
+ * type: MavenAGI.EntityType.KnowledgeBase
25
+ * },
19
26
  * title: "How it works",
20
27
  * llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
28
+ * knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus.Never,
21
29
  * url: "https://help-center.acme.com/how-it-works",
22
30
  * createdAt: new Date("2024-01-01T00:00:00.000Z"),
23
31
  * updatedAt: new Date("2024-02-02T00:00:00.000Z")
@@ -31,10 +39,14 @@ export interface KnowledgeDocumentSearchResponse extends MavenAGI.BaseKnowledgeD
31
39
  * This may be missing on legacy documents.
32
40
  */
33
41
  knowledgeBaseVersionId?: MavenAGI.EntityId;
42
+ /** ID that uniquely identifies the knowledge base that contains this document. */
43
+ knowledgeBaseId: MavenAGI.EntityId;
34
44
  /** The title of the document. Will be shown as part of answers. May be missing on legacy documents. */
35
45
  title?: string;
36
46
  /** Whether the document is included in the agent's knowledge. */
37
47
  llmInclusionStatus: MavenAGI.LlmInclusionStatus;
48
+ /** Whether the knowledge base is included in the agent's knowledge. */
49
+ knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus;
38
50
  /** The time at which this document was created. */
39
51
  createdAt: Date;
40
52
  /** The time at which this document was last modified. */
package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts CHANGED
@@ -9,8 +9,10 @@ export declare namespace KnowledgeDocumentSearchResponse {
9
9
  interface Raw extends BaseKnowledgeDocument.Raw {
10
10
  knowledgeDocumentId: EntityId.Raw;
11
11
  knowledgeBaseVersionId?: EntityId.Raw | null;
12
+ knowledgeBaseId: EntityId.Raw;
12
13
  title?: string | null;
13
14
  llmInclusionStatus: LlmInclusionStatus.Raw;
15
+ knowledgeBaseLlmInclusionStatus: LlmInclusionStatus.Raw;
14
16
  createdAt: string;
15
17
  updatedAt: string;
16
18
  }
package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js CHANGED
@@ -43,8 +43,10 @@ exports.KnowledgeDocumentSearchResponse = core.serialization
43
43
  .object({
44
44
  knowledgeDocumentId: EntityId_1.EntityId,
45
45
  knowledgeBaseVersionId: EntityId_1.EntityId.optional(),
46
+ knowledgeBaseId: EntityId_1.EntityId,
46
47
  title: core.serialization.string().optional(),
47
48
  llmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus,
49
+ knowledgeBaseLlmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus,
48
50
  createdAt: core.serialization.date(),
49
51
  updatedAt: core.serialization.date(),
50
52
  })
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.8";
1
+ export declare const SDK_VERSION = "1.2.9";
package/dist/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.2.8";
4
+ exports.SDK_VERSION = "1.2.9";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mavenagi",
3
- "version": "1.2.8",
3
+ "version": "1.2.9",
4
4
  "private": false,
5
5
  "repository": "github:mavenagi/mavenagi-node",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -4169,7 +4169,7 @@ Create or update a knowledge document. Requires an existing knowledge base with
4169
4169
  Will throw an exception if the latest version is not in progress.
4170
4170
 
4171
4171
  <Tip>
4172
- This API maintains document version history. If for the same reference ID none of the `title`, `text`, `sourceUrl`, `metadata` fields
4172
+ This API maintains document version history. If for the same reference ID none of the `title`, `text`, `sourceUrl`, `metadata` fields
4173
4173
  have changed, a new document version will not be created. The existing version will be reused.
4174
4174
  </Tip>
4175
4175
  </dd>
package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts CHANGED
@@ -9,8 +9,10 @@ export declare namespace KnowledgeDocumentSearchResponse {
9
9
  interface Raw extends BaseKnowledgeDocument.Raw {
10
10
  knowledgeDocumentId: EntityId.Raw;
11
11
  knowledgeBaseVersionId?: EntityId.Raw | null;
12
+ knowledgeBaseId: EntityId.Raw;
12
13
  title?: string | null;
13
14
  llmInclusionStatus: LlmInclusionStatus.Raw;
15
+ knowledgeBaseLlmInclusionStatus: LlmInclusionStatus.Raw;
14
16
  createdAt: string;
15
17
  updatedAt: string;
16
18
  }
package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js CHANGED
@@ -43,8 +43,10 @@ exports.KnowledgeDocumentSearchResponse = core.serialization
43
43
  .object({
44
44
  knowledgeDocumentId: EntityId_1.EntityId,
45
45
  knowledgeBaseVersionId: EntityId_1.EntityId.optional(),
46
+ knowledgeBaseId: EntityId_1.EntityId,
46
47
  title: core.serialization.string().optional(),
47
48
  llmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus,
49
+ knowledgeBaseLlmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus,
48
50
  createdAt: core.serialization.date(),
49
51
  updatedAt: core.serialization.date(),
50
52
  })
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.8";
1
+ export declare const SDK_VERSION = "1.2.9";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.2.8";
4
+ exports.SDK_VERSION = "1.2.9";