@credal/sdk 0.0.3 → 0.0.5
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.
- package/README.md +168 -0
- package/api/resources/copilots/client/Client.d.ts +15 -0
- package/api/resources/copilots/client/Client.js +62 -2
- package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +32 -0
- package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +5 -0
- package/api/resources/copilots/client/requests/index.d.ts +1 -0
- package/api/resources/copilots/types/FeedbackEnum.d.ts +8 -0
- package/api/resources/copilots/types/FeedbackEnum.js +10 -0
- package/api/resources/copilots/types/MessageFeedback.d.ts +8 -0
- package/api/resources/copilots/types/MessageFeedback.js +5 -0
- package/api/resources/copilots/types/MessageReply.d.ts +2 -0
- package/api/resources/copilots/types/ReferencedSource.d.ts +10 -0
- package/api/resources/copilots/types/ReferencedSource.js +5 -0
- package/api/resources/copilots/types/index.d.ts +3 -0
- package/api/resources/copilots/types/index.js +3 -0
- package/api/resources/documentCatalog/client/Client.js +2 -2
- package/api/resources/documentCollections/client/Client.js +1 -1
- package/api/resources/permissionsService/client/Client.js +3 -3
- package/api/resources/search/client/Client.js +1 -1
- package/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
- package/api/resources/users/client/Client.js +1 -1
- package/dist/api/resources/copilots/client/Client.d.ts +15 -0
- package/dist/api/resources/copilots/client/Client.js +62 -2
- package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +32 -0
- package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +5 -0
- package/dist/api/resources/copilots/client/requests/index.d.ts +1 -0
- package/dist/api/resources/copilots/types/FeedbackEnum.d.ts +8 -0
- package/dist/api/resources/copilots/types/FeedbackEnum.js +10 -0
- package/dist/api/resources/copilots/types/MessageFeedback.d.ts +8 -0
- package/dist/api/resources/copilots/types/MessageFeedback.js +5 -0
- package/dist/api/resources/copilots/types/MessageReply.d.ts +2 -0
- package/dist/api/resources/copilots/types/ReferencedSource.d.ts +10 -0
- package/dist/api/resources/copilots/types/ReferencedSource.js +5 -0
- package/dist/api/resources/copilots/types/index.d.ts +3 -0
- package/dist/api/resources/copilots/types/index.js +3 -0
- package/dist/api/resources/documentCatalog/client/Client.js +2 -2
- package/dist/api/resources/documentCollections/client/Client.js +1 -1
- package/dist/api/resources/permissionsService/client/Client.js +3 -3
- package/dist/api/resources/search/client/Client.js +1 -1
- package/dist/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
- package/dist/api/resources/users/client/Client.js +1 -1
- package/dist/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +15 -0
- package/dist/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +36 -0
- package/dist/serialization/resources/copilots/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/copilots/client/requests/index.js +3 -1
- package/dist/serialization/resources/copilots/types/FeedbackEnum.d.ts +10 -0
- package/dist/serialization/resources/copilots/types/FeedbackEnum.js +31 -0
- package/dist/serialization/resources/copilots/types/MessageFeedback.d.ts +14 -0
- package/dist/serialization/resources/copilots/types/MessageFeedback.js +35 -0
- package/dist/serialization/resources/copilots/types/MessageReply.d.ts +3 -0
- package/dist/serialization/resources/copilots/types/MessageReply.js +3 -0
- package/dist/serialization/resources/copilots/types/ReferencedSource.d.ts +16 -0
- package/dist/serialization/resources/copilots/types/ReferencedSource.js +37 -0
- package/dist/serialization/resources/copilots/types/index.d.ts +3 -0
- package/dist/serialization/resources/copilots/types/index.js +3 -0
- package/dist/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
- package/dist/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.js +1 -1
- package/package.json +1 -1
- package/reference.md +70 -0
- package/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +15 -0
- package/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +36 -0
- package/serialization/resources/copilots/client/requests/index.d.ts +1 -0
- package/serialization/resources/copilots/client/requests/index.js +3 -1
- package/serialization/resources/copilots/types/FeedbackEnum.d.ts +10 -0
- package/serialization/resources/copilots/types/FeedbackEnum.js +31 -0
- package/serialization/resources/copilots/types/MessageFeedback.d.ts +14 -0
- package/serialization/resources/copilots/types/MessageFeedback.js +35 -0
- package/serialization/resources/copilots/types/MessageReply.d.ts +3 -0
- package/serialization/resources/copilots/types/MessageReply.js +3 -0
- package/serialization/resources/copilots/types/ReferencedSource.d.ts +16 -0
- package/serialization/resources/copilots/types/ReferencedSource.js +37 -0
- package/serialization/resources/copilots/types/index.d.ts +3 -0
- package/serialization/resources/copilots/types/index.js +3 -0
- package/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
- package/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.js +1 -1
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
22
|
+
if (mod && mod.__esModule) return mod;
|
|
23
|
+
var result = {};
|
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
25
|
+
__setModuleDefault(result, mod);
|
|
26
|
+
return result;
|
|
27
|
+
};
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.FeedbackEnum = void 0;
|
|
30
|
+
const core = __importStar(require("../../../../core"));
|
|
31
|
+
exports.FeedbackEnum = core.serialization.enum_(["POSITIVE", "NEGATIVE"]);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as serializers from "../../../index";
|
|
5
|
+
import * as Credal from "../../../../api/index";
|
|
6
|
+
import * as core from "../../../../core";
|
|
7
|
+
import { FeedbackEnum } from "./FeedbackEnum";
|
|
8
|
+
export declare const MessageFeedback: core.serialization.ObjectSchema<serializers.MessageFeedback.Raw, Credal.MessageFeedback>;
|
|
9
|
+
export declare namespace MessageFeedback {
|
|
10
|
+
interface Raw {
|
|
11
|
+
feedback: FeedbackEnum.Raw;
|
|
12
|
+
suggestedAnswer?: string | null;
|
|
13
|
+
}
|
|
14
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
22
|
+
if (mod && mod.__esModule) return mod;
|
|
23
|
+
var result = {};
|
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
25
|
+
__setModuleDefault(result, mod);
|
|
26
|
+
return result;
|
|
27
|
+
};
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.MessageFeedback = void 0;
|
|
30
|
+
const core = __importStar(require("../../../../core"));
|
|
31
|
+
const FeedbackEnum_1 = require("./FeedbackEnum");
|
|
32
|
+
exports.MessageFeedback = core.serialization.object({
|
|
33
|
+
feedback: FeedbackEnum_1.FeedbackEnum,
|
|
34
|
+
suggestedAnswer: core.serialization.string().optional(),
|
|
35
|
+
});
|
|
@@ -7,6 +7,7 @@ import * as core from "../../../../core";
|
|
|
7
7
|
import { PolicyTrigger } from "./PolicyTrigger";
|
|
8
8
|
import { ResponseChunk } from "./ResponseChunk";
|
|
9
9
|
import { InsertedAuditLog } from "./InsertedAuditLog";
|
|
10
|
+
import { ReferencedSource } from "./ReferencedSource";
|
|
10
11
|
export declare const MessageReply: core.serialization.ObjectSchema<serializers.MessageReply.Raw, Credal.MessageReply>;
|
|
11
12
|
export declare namespace MessageReply {
|
|
12
13
|
interface Raw {
|
|
@@ -16,5 +17,7 @@ export declare namespace MessageReply {
|
|
|
16
17
|
warnings: string[];
|
|
17
18
|
activitySourceIdsForAudit: string[];
|
|
18
19
|
inserted_audit_log: InsertedAuditLog.Raw;
|
|
20
|
+
referencedSources: ReferencedSource.Raw[];
|
|
21
|
+
messageId: string;
|
|
19
22
|
}
|
|
20
23
|
}
|
|
@@ -31,6 +31,7 @@ const core = __importStar(require("../../../../core"));
|
|
|
31
31
|
const PolicyTrigger_1 = require("./PolicyTrigger");
|
|
32
32
|
const ResponseChunk_1 = require("./ResponseChunk");
|
|
33
33
|
const InsertedAuditLog_1 = require("./InsertedAuditLog");
|
|
34
|
+
const ReferencedSource_1 = require("./ReferencedSource");
|
|
34
35
|
exports.MessageReply = core.serialization.object({
|
|
35
36
|
policyTriggers: core.serialization.property("policy_triggers", core.serialization.list(PolicyTrigger_1.PolicyTrigger)),
|
|
36
37
|
conversationId: core.serialization.string(),
|
|
@@ -38,4 +39,6 @@ exports.MessageReply = core.serialization.object({
|
|
|
38
39
|
warnings: core.serialization.list(core.serialization.string()),
|
|
39
40
|
activitySourceIdsForAudit: core.serialization.list(core.serialization.string()),
|
|
40
41
|
insertedAuditLog: core.serialization.property("inserted_audit_log", InsertedAuditLog_1.InsertedAuditLog),
|
|
42
|
+
referencedSources: core.serialization.list(ReferencedSource_1.ReferencedSource),
|
|
43
|
+
messageId: core.serialization.string(),
|
|
41
44
|
});
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as serializers from "../../../index";
|
|
5
|
+
import * as Credal from "../../../../api/index";
|
|
6
|
+
import * as core from "../../../../core";
|
|
7
|
+
import { ExternalResourceId } from "../../common/types/ExternalResourceId";
|
|
8
|
+
export declare const ReferencedSource: core.serialization.ObjectSchema<serializers.ReferencedSource.Raw, Credal.ReferencedSource>;
|
|
9
|
+
export declare namespace ReferencedSource {
|
|
10
|
+
interface Raw {
|
|
11
|
+
id: string;
|
|
12
|
+
externalResourceId: ExternalResourceId.Raw;
|
|
13
|
+
name: string;
|
|
14
|
+
url?: string | null;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
22
|
+
if (mod && mod.__esModule) return mod;
|
|
23
|
+
var result = {};
|
|
24
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
25
|
+
__setModuleDefault(result, mod);
|
|
26
|
+
return result;
|
|
27
|
+
};
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.ReferencedSource = void 0;
|
|
30
|
+
const core = __importStar(require("../../../../core"));
|
|
31
|
+
const ExternalResourceId_1 = require("../../common/types/ExternalResourceId");
|
|
32
|
+
exports.ReferencedSource = core.serialization.object({
|
|
33
|
+
id: core.serialization.string(),
|
|
34
|
+
externalResourceId: ExternalResourceId_1.ExternalResourceId,
|
|
35
|
+
name: core.serialization.string(),
|
|
36
|
+
url: core.serialization.string().optional(),
|
|
37
|
+
});
|
|
@@ -2,7 +2,10 @@ export * from "./CreateConversationResponse";
|
|
|
2
2
|
export * from "./SendAgentMessageResponse";
|
|
3
3
|
export * from "./SendMessageResponse";
|
|
4
4
|
export * from "./MessageReply";
|
|
5
|
+
export * from "./ReferencedSource";
|
|
5
6
|
export * from "./ResponseChunk";
|
|
6
7
|
export * from "./InsertedAuditLog";
|
|
7
8
|
export * from "./MessageBlocked";
|
|
8
9
|
export * from "./PolicyTrigger";
|
|
10
|
+
export * from "./FeedbackEnum";
|
|
11
|
+
export * from "./MessageFeedback";
|
|
@@ -18,7 +18,10 @@ __exportStar(require("./CreateConversationResponse"), exports);
|
|
|
18
18
|
__exportStar(require("./SendAgentMessageResponse"), exports);
|
|
19
19
|
__exportStar(require("./SendMessageResponse"), exports);
|
|
20
20
|
__exportStar(require("./MessageReply"), exports);
|
|
21
|
+
__exportStar(require("./ReferencedSource"), exports);
|
|
21
22
|
__exportStar(require("./ResponseChunk"), exports);
|
|
22
23
|
__exportStar(require("./InsertedAuditLog"), exports);
|
|
23
24
|
__exportStar(require("./MessageBlocked"), exports);
|
|
24
25
|
__exportStar(require("./PolicyTrigger"), exports);
|
|
26
|
+
__exportStar(require("./FeedbackEnum"), exports);
|
|
27
|
+
__exportStar(require("./MessageFeedback"), exports);
|
|
@@ -12,7 +12,7 @@ export declare namespace SearchDocumentCollectionRequest {
|
|
|
12
12
|
documentCollectionId: string;
|
|
13
13
|
searchQuery: string;
|
|
14
14
|
userEmail: string;
|
|
15
|
-
structuredQueryFilters
|
|
15
|
+
structuredQueryFilters?: SingleFieldFilter.Raw[] | null;
|
|
16
16
|
searchOptions?: DocumentCollectionSearchOptions.Raw | null;
|
|
17
17
|
metadataFilterExpression?: string | null;
|
|
18
18
|
}
|
|
@@ -34,7 +34,7 @@ exports.SearchDocumentCollectionRequest = core.serialization.object({
|
|
|
34
34
|
documentCollectionId: core.serialization.string(),
|
|
35
35
|
searchQuery: core.serialization.string(),
|
|
36
36
|
userEmail: core.serialization.string(),
|
|
37
|
-
structuredQueryFilters: core.serialization.list(SingleFieldFilter_1.SingleFieldFilter),
|
|
37
|
+
structuredQueryFilters: core.serialization.list(SingleFieldFilter_1.SingleFieldFilter).optional(),
|
|
38
38
|
searchOptions: DocumentCollectionSearchOptions_1.DocumentCollectionSearchOptions.optional(),
|
|
39
39
|
metadataFilterExpression: core.serialization.string().optional(),
|
|
40
40
|
});
|