@breign/client 1.0.111 → 1.0.113
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/dist/apis/AgentApi.d.ts +60 -10
- package/dist/apis/AgentApi.js +99 -7
- package/dist/apis/MetricsApi.d.ts +131 -7
- package/dist/apis/MetricsApi.js +269 -5
- package/dist/models/AgentFeedbackMetricsUio.d.ts +50 -0
- package/dist/models/AgentFeedbackMetricsUio.js +60 -0
- package/dist/models/AgentMetricsByAppUio.d.ts +56 -0
- package/dist/models/AgentMetricsByAppUio.js +64 -0
- package/dist/models/AgentMetricsOverviewUio.d.ts +79 -0
- package/dist/models/AgentMetricsOverviewUio.js +31 -0
- package/dist/models/AgentMetricsPeriodComparisonUio.d.ts +41 -0
- package/dist/models/AgentMetricsPeriodComparisonUio.js +55 -0
- package/dist/models/AgentMetricsPeriodSnapshotUio.d.ts +68 -0
- package/dist/models/AgentMetricsPeriodSnapshotUio.js +74 -0
- package/dist/models/AgentMetricsUnitsTypeUio.d.ts +1 -0
- package/dist/models/AgentMetricsUnitsTypeUio.js +2 -1
- package/dist/models/AgentTokenBreakdownUio.d.ts +44 -0
- package/dist/models/AgentTokenBreakdownUio.js +58 -0
- package/dist/models/AgentTokenUsageByTaskUio.d.ts +38 -0
- package/dist/models/AgentTokenUsageByTaskUio.js +54 -0
- package/dist/models/AgentTokenUsageMetricUio.d.ts +56 -0
- package/dist/models/AgentTokenUsageMetricUio.js +66 -0
- package/dist/models/AgentToolUsageMetricUio.d.ts +38 -0
- package/dist/models/AgentToolUsageMetricUio.js +54 -0
- package/dist/models/AppCreateRequestEphemeralInstancesUio.d.ts +38 -0
- package/dist/models/AppCreateRequestEphemeralInstancesUio.js +54 -0
- package/dist/models/AppCreateRequestUio.d.ts +7 -0
- package/dist/models/AppCreateRequestUio.js +3 -0
- package/dist/models/AppUio.d.ts +3 -3
- package/dist/models/AppUio.js +3 -3
- package/dist/models/AppUpdateRequestUio.d.ts +7 -0
- package/dist/models/AppUpdateRequestUio.js +3 -0
- package/dist/models/EphemeralInstancesMetricsResponseUio.d.ts +39 -0
- package/dist/models/EphemeralInstancesMetricsResponseUio.js +55 -0
- package/dist/models/EphemeralInstancesTimeSeriesPointUio.d.ts +44 -0
- package/dist/models/EphemeralInstancesTimeSeriesPointUio.js +58 -0
- package/dist/models/MetricForDayInnerIdUio.d.ts +56 -0
- package/dist/models/MetricForDayInnerIdUio.js +56 -0
- package/dist/models/MetricForDayInnerUio.d.ts +51 -0
- package/dist/models/MetricForDayInnerUio.js +57 -0
- package/dist/models/MetricForVisitorByMonthInnerUio.d.ts +44 -0
- package/dist/models/MetricForVisitorByMonthInnerUio.js +58 -0
- package/dist/models/MetricUio.d.ts +6 -0
- package/dist/models/MetricUio.js +2 -0
- package/dist/models/MetricsBrainsAgentResponseUio.d.ts +51 -0
- package/dist/models/MetricsBrainsAgentResponseUio.js +63 -0
- package/dist/models/MetricsTopAgentsResponseInnerUio.d.ts +50 -0
- package/dist/models/MetricsTopAgentsResponseInnerUio.js +54 -0
- package/dist/models/MetricsTopAgentsUsageResponseInnerUio.d.ts +44 -0
- package/dist/models/MetricsTopAgentsUsageResponseInnerUio.js +58 -0
- package/dist/models/MetricsUsersResponseUio.d.ts +39 -0
- package/dist/models/MetricsUsersResponseUio.js +55 -0
- package/dist/models/OrgUsageMetricsResponseTotalUio.d.ts +38 -0
- package/dist/models/OrgUsageMetricsResponseTotalUio.js +54 -0
- package/dist/models/OrgUsageMetricsResponseUio.d.ts +40 -0
- package/dist/models/OrgUsageMetricsResponseUio.js +56 -0
- package/dist/models/OrgUsageTimeSeriesPointUio.d.ts +50 -0
- package/dist/models/OrgUsageTimeSeriesPointUio.js +62 -0
- package/dist/models/SubscriptionAdditionalMetricUio.d.ts +44 -0
- package/dist/models/SubscriptionAdditionalMetricUio.js +58 -0
- package/dist/models/SubscriptionInteractionsMetricUio.d.ts +39 -0
- package/dist/models/SubscriptionInteractionsMetricUio.js +55 -0
- package/dist/models/SubscriptionMetricUio.d.ts +6 -5
- package/dist/models/SubscriptionMetricUio.js +12 -5
- package/dist/models/TotalTokensUsedByAgentUio.d.ts +38 -0
- package/dist/models/TotalTokensUsedByAgentUio.js +50 -0
- package/dist/models/index.d.ts +24 -1
- package/dist/models/index.js +24 -1
- package/dist/openapi.json +1069 -67
- package/package.json +1 -1
- package/dist/models/AppEphemeralInstancesUio.d.ts +0 -38
- package/dist/models/AppEphemeralInstancesUio.js +0 -50
package/dist/apis/MetricsApi.js
CHANGED
|
@@ -46,7 +46,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
46
46
|
};
|
|
47
47
|
})();
|
|
48
48
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
49
|
-
exports.MetricsApi = void 0;
|
|
49
|
+
exports.GetMetricsOrganizationUsageGranularityEnum = exports.GetMetricsOrganizationEphemeralInstancesGranularityEnum = exports.MetricsApi = void 0;
|
|
50
50
|
const runtime = __importStar(require("../runtime"));
|
|
51
51
|
const index_1 = require("../models/index");
|
|
52
52
|
/**
|
|
@@ -60,10 +60,10 @@ class MetricsApi extends runtime.BaseAPI {
|
|
|
60
60
|
async getMetricsRaw(requestParameters, initOverrides) {
|
|
61
61
|
const queryParameters = {};
|
|
62
62
|
if (requestParameters['startDate'] != null) {
|
|
63
|
-
queryParameters['startDate'] = requestParameters['startDate']
|
|
63
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
64
64
|
}
|
|
65
65
|
if (requestParameters['endDate'] != null) {
|
|
66
|
-
queryParameters['endDate'] = requestParameters['endDate']
|
|
66
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
67
67
|
}
|
|
68
68
|
const headerParameters = {};
|
|
69
69
|
if (this.configuration && this.configuration.apiKey) {
|
|
@@ -92,10 +92,10 @@ class MetricsApi extends runtime.BaseAPI {
|
|
|
92
92
|
async getMetricsAgentsRaw(requestParameters, initOverrides) {
|
|
93
93
|
const queryParameters = {};
|
|
94
94
|
if (requestParameters['startDate'] != null) {
|
|
95
|
-
queryParameters['startDate'] = requestParameters['startDate']
|
|
95
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
96
96
|
}
|
|
97
97
|
if (requestParameters['endDate'] != null) {
|
|
98
|
-
queryParameters['endDate'] = requestParameters['endDate']
|
|
98
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
99
99
|
}
|
|
100
100
|
const headerParameters = {};
|
|
101
101
|
if (this.configuration && this.configuration.apiKey) {
|
|
@@ -117,5 +117,269 @@ class MetricsApi extends runtime.BaseAPI {
|
|
|
117
117
|
const response = await this.getMetricsAgentsRaw({ startDate: startDate, endDate: endDate }, initOverrides);
|
|
118
118
|
return await response.value();
|
|
119
119
|
}
|
|
120
|
+
/**
|
|
121
|
+
* Retrieves metrics for a brain agent
|
|
122
|
+
* Get metrics for a brain agent
|
|
123
|
+
*/
|
|
124
|
+
async getMetricsBrainsAgentRaw(requestParameters, initOverrides) {
|
|
125
|
+
if (requestParameters['organizationId'] == null) {
|
|
126
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsBrainsAgent().');
|
|
127
|
+
}
|
|
128
|
+
if (requestParameters['agentId'] == null) {
|
|
129
|
+
throw new runtime.RequiredError('agentId', 'Required parameter "agentId" was null or undefined when calling getMetricsBrainsAgent().');
|
|
130
|
+
}
|
|
131
|
+
const queryParameters = {};
|
|
132
|
+
const headerParameters = {};
|
|
133
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
134
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
135
|
+
}
|
|
136
|
+
const response = await this.request({
|
|
137
|
+
path: `/organizations/{organizationId}/metrics/agents/{agentId}`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))).replace(`{${"agentId"}}`, encodeURIComponent(String(requestParameters['agentId']))),
|
|
138
|
+
method: 'GET',
|
|
139
|
+
headers: headerParameters,
|
|
140
|
+
query: queryParameters,
|
|
141
|
+
}, initOverrides);
|
|
142
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MetricsBrainsAgentResponseUioFromJSON)(jsonValue));
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Retrieves metrics for a brain agent
|
|
146
|
+
* Get metrics for a brain agent
|
|
147
|
+
*/
|
|
148
|
+
async getMetricsBrainsAgent(organizationId, agentId, initOverrides) {
|
|
149
|
+
const response = await this.getMetricsBrainsAgentRaw({ organizationId: organizationId, agentId: agentId }, initOverrides);
|
|
150
|
+
return await response.value();
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Retrieves usage metrics broken down by day within a date range (admin only)
|
|
154
|
+
* Get day-specific metrics
|
|
155
|
+
*/
|
|
156
|
+
async getMetricsDayMetricsRaw(requestParameters, initOverrides) {
|
|
157
|
+
if (requestParameters['organizationId'] == null) {
|
|
158
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsDayMetrics().');
|
|
159
|
+
}
|
|
160
|
+
const queryParameters = {};
|
|
161
|
+
const headerParameters = {};
|
|
162
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
163
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
164
|
+
}
|
|
165
|
+
const response = await this.request({
|
|
166
|
+
path: `/metrics/organizations/{organizationId}/day-metrics`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
|
|
167
|
+
method: 'GET',
|
|
168
|
+
headers: headerParameters,
|
|
169
|
+
query: queryParameters,
|
|
170
|
+
}, initOverrides);
|
|
171
|
+
return new runtime.JSONApiResponse(response);
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Retrieves usage metrics broken down by day within a date range (admin only)
|
|
175
|
+
* Get day-specific metrics
|
|
176
|
+
*/
|
|
177
|
+
async getMetricsDayMetrics(organizationId, initOverrides) {
|
|
178
|
+
const response = await this.getMetricsDayMetricsRaw({ organizationId: organizationId }, initOverrides);
|
|
179
|
+
return await response.value();
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Returns ephemeral instance creation counts over time for all agents in the organization
|
|
183
|
+
* Get ephemeral instances metrics for an organization
|
|
184
|
+
*/
|
|
185
|
+
async getMetricsOrganizationEphemeralInstancesRaw(requestParameters, initOverrides) {
|
|
186
|
+
if (requestParameters['organizationId'] == null) {
|
|
187
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsOrganizationEphemeralInstances().');
|
|
188
|
+
}
|
|
189
|
+
const queryParameters = {};
|
|
190
|
+
if (requestParameters['startDate'] != null) {
|
|
191
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
192
|
+
}
|
|
193
|
+
if (requestParameters['endDate'] != null) {
|
|
194
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
195
|
+
}
|
|
196
|
+
if (requestParameters['granularity'] != null) {
|
|
197
|
+
queryParameters['granularity'] = requestParameters['granularity'];
|
|
198
|
+
}
|
|
199
|
+
const headerParameters = {};
|
|
200
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
201
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
202
|
+
}
|
|
203
|
+
const response = await this.request({
|
|
204
|
+
path: `/metrics/organizations/{organizationId}/ephemeral-instances`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
|
|
205
|
+
method: 'GET',
|
|
206
|
+
headers: headerParameters,
|
|
207
|
+
query: queryParameters,
|
|
208
|
+
}, initOverrides);
|
|
209
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EphemeralInstancesMetricsResponseUioFromJSON)(jsonValue));
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* Returns ephemeral instance creation counts over time for all agents in the organization
|
|
213
|
+
* Get ephemeral instances metrics for an organization
|
|
214
|
+
*/
|
|
215
|
+
async getMetricsOrganizationEphemeralInstances(organizationId, startDate, endDate, granularity, initOverrides) {
|
|
216
|
+
const response = await this.getMetricsOrganizationEphemeralInstancesRaw({ organizationId: organizationId, startDate: startDate, endDate: endDate, granularity: granularity }, initOverrides);
|
|
217
|
+
return await response.value();
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* Returns LLM requests and token usage over time for all agents in the organization
|
|
221
|
+
* Get usage metrics for an organization
|
|
222
|
+
*/
|
|
223
|
+
async getMetricsOrganizationUsageRaw(requestParameters, initOverrides) {
|
|
224
|
+
if (requestParameters['organizationId'] == null) {
|
|
225
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsOrganizationUsage().');
|
|
226
|
+
}
|
|
227
|
+
const queryParameters = {};
|
|
228
|
+
if (requestParameters['startDate'] != null) {
|
|
229
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
230
|
+
}
|
|
231
|
+
if (requestParameters['endDate'] != null) {
|
|
232
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
233
|
+
}
|
|
234
|
+
if (requestParameters['granularity'] != null) {
|
|
235
|
+
queryParameters['granularity'] = requestParameters['granularity'];
|
|
236
|
+
}
|
|
237
|
+
const headerParameters = {};
|
|
238
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
239
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
240
|
+
}
|
|
241
|
+
const response = await this.request({
|
|
242
|
+
path: `/metrics/organizations/{organizationId}/usage`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
|
|
243
|
+
method: 'GET',
|
|
244
|
+
headers: headerParameters,
|
|
245
|
+
query: queryParameters,
|
|
246
|
+
}, initOverrides);
|
|
247
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.OrgUsageMetricsResponseUioFromJSON)(jsonValue));
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Returns LLM requests and token usage over time for all agents in the organization
|
|
251
|
+
* Get usage metrics for an organization
|
|
252
|
+
*/
|
|
253
|
+
async getMetricsOrganizationUsage(organizationId, startDate, endDate, granularity, initOverrides) {
|
|
254
|
+
const response = await this.getMetricsOrganizationUsageRaw({ organizationId: organizationId, startDate: startDate, endDate: endDate, granularity: granularity }, initOverrides);
|
|
255
|
+
return await response.value();
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Retrieves usage metrics broken down by top agents within a date range (admin only)
|
|
259
|
+
* Get top agents metrics
|
|
260
|
+
*/
|
|
261
|
+
async getMetricsTopAgentsRaw(requestParameters, initOverrides) {
|
|
262
|
+
if (requestParameters['organizationId'] == null) {
|
|
263
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsTopAgents().');
|
|
264
|
+
}
|
|
265
|
+
const queryParameters = {};
|
|
266
|
+
if (requestParameters['startDate'] != null) {
|
|
267
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
268
|
+
}
|
|
269
|
+
if (requestParameters['endDate'] != null) {
|
|
270
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
271
|
+
}
|
|
272
|
+
if (requestParameters['agentsIds'] != null) {
|
|
273
|
+
queryParameters['agentsIds'] = requestParameters['agentsIds'];
|
|
274
|
+
}
|
|
275
|
+
const headerParameters = {};
|
|
276
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
277
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
278
|
+
}
|
|
279
|
+
const response = await this.request({
|
|
280
|
+
path: `/metrics/organizations/{organizationId}/top-agents/conversations`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
|
|
281
|
+
method: 'GET',
|
|
282
|
+
headers: headerParameters,
|
|
283
|
+
query: queryParameters,
|
|
284
|
+
}, initOverrides);
|
|
285
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.MetricsTopAgentsResponseInnerUioFromJSON));
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* Retrieves usage metrics broken down by top agents within a date range (admin only)
|
|
289
|
+
* Get top agents metrics
|
|
290
|
+
*/
|
|
291
|
+
async getMetricsTopAgents(organizationId, startDate, endDate, agentsIds, initOverrides) {
|
|
292
|
+
const response = await this.getMetricsTopAgentsRaw({ organizationId: organizationId, startDate: startDate, endDate: endDate, agentsIds: agentsIds }, initOverrides);
|
|
293
|
+
return await response.value();
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* Retrieves usage metrics broken down by top agents within a date range (admin only)
|
|
297
|
+
* Get top agents usage metrics
|
|
298
|
+
*/
|
|
299
|
+
async getMetricsTopAgentsUsageRaw(requestParameters, initOverrides) {
|
|
300
|
+
if (requestParameters['organizationId'] == null) {
|
|
301
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsTopAgentsUsage().');
|
|
302
|
+
}
|
|
303
|
+
const queryParameters = {};
|
|
304
|
+
if (requestParameters['startDate'] != null) {
|
|
305
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
306
|
+
}
|
|
307
|
+
if (requestParameters['endDate'] != null) {
|
|
308
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
309
|
+
}
|
|
310
|
+
if (requestParameters['agentsIds'] != null) {
|
|
311
|
+
queryParameters['agentsIds'] = requestParameters['agentsIds'];
|
|
312
|
+
}
|
|
313
|
+
const headerParameters = {};
|
|
314
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
315
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
316
|
+
}
|
|
317
|
+
const response = await this.request({
|
|
318
|
+
path: `/metrics/organizations/{organizationId}/top-agents/usage`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
|
|
319
|
+
method: 'GET',
|
|
320
|
+
headers: headerParameters,
|
|
321
|
+
query: queryParameters,
|
|
322
|
+
}, initOverrides);
|
|
323
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.MetricsTopAgentsUsageResponseInnerUioFromJSON));
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Retrieves usage metrics broken down by top agents within a date range (admin only)
|
|
327
|
+
* Get top agents usage metrics
|
|
328
|
+
*/
|
|
329
|
+
async getMetricsTopAgentsUsage(organizationId, startDate, endDate, agentsIds, initOverrides) {
|
|
330
|
+
const response = await this.getMetricsTopAgentsUsageRaw({ organizationId: organizationId, startDate: startDate, endDate: endDate, agentsIds: agentsIds }, initOverrides);
|
|
331
|
+
return await response.value();
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* Retrieves usage metrics broken down by users within a date range (admin only)
|
|
335
|
+
* Get users metrics
|
|
336
|
+
*/
|
|
337
|
+
async getMetricsUsersVisitorsRaw(requestParameters, initOverrides) {
|
|
338
|
+
if (requestParameters['organizationId'] == null) {
|
|
339
|
+
throw new runtime.RequiredError('organizationId', 'Required parameter "organizationId" was null or undefined when calling getMetricsUsersVisitors().');
|
|
340
|
+
}
|
|
341
|
+
const queryParameters = {};
|
|
342
|
+
if (requestParameters['startDate'] != null) {
|
|
343
|
+
queryParameters['startDate'] = requestParameters['startDate'];
|
|
344
|
+
}
|
|
345
|
+
if (requestParameters['endDate'] != null) {
|
|
346
|
+
queryParameters['endDate'] = requestParameters['endDate'];
|
|
347
|
+
}
|
|
348
|
+
const headerParameters = {};
|
|
349
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
350
|
+
headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
|
|
351
|
+
}
|
|
352
|
+
const response = await this.request({
|
|
353
|
+
path: `/metrics/organizations/{organizationId}/users`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
|
|
354
|
+
method: 'GET',
|
|
355
|
+
headers: headerParameters,
|
|
356
|
+
query: queryParameters,
|
|
357
|
+
}, initOverrides);
|
|
358
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MetricsUsersResponseUioFromJSON)(jsonValue));
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* Retrieves usage metrics broken down by users within a date range (admin only)
|
|
362
|
+
* Get users metrics
|
|
363
|
+
*/
|
|
364
|
+
async getMetricsUsersVisitors(organizationId, startDate, endDate, initOverrides) {
|
|
365
|
+
const response = await this.getMetricsUsersVisitorsRaw({ organizationId: organizationId, startDate: startDate, endDate: endDate }, initOverrides);
|
|
366
|
+
return await response.value();
|
|
367
|
+
}
|
|
120
368
|
}
|
|
121
369
|
exports.MetricsApi = MetricsApi;
|
|
370
|
+
/**
|
|
371
|
+
* @export
|
|
372
|
+
*/
|
|
373
|
+
exports.GetMetricsOrganizationEphemeralInstancesGranularityEnum = {
|
|
374
|
+
Hour: 'hour',
|
|
375
|
+
Day: 'day',
|
|
376
|
+
Week: 'week'
|
|
377
|
+
};
|
|
378
|
+
/**
|
|
379
|
+
* @export
|
|
380
|
+
*/
|
|
381
|
+
exports.GetMetricsOrganizationUsageGranularityEnum = {
|
|
382
|
+
Hour: 'hour',
|
|
383
|
+
Day: 'day',
|
|
384
|
+
Week: 'week'
|
|
385
|
+
};
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* brain-client
|
|
3
|
+
* Api ands models for brain-app and brain-app
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.0.0-SNAPSHOT
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AgentFeedbackMetricsUio
|
|
16
|
+
*/
|
|
17
|
+
export interface AgentFeedbackMetricsUio {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof AgentFeedbackMetricsUio
|
|
22
|
+
*/
|
|
23
|
+
positive: number;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof AgentFeedbackMetricsUio
|
|
28
|
+
*/
|
|
29
|
+
negative: number;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof AgentFeedbackMetricsUio
|
|
34
|
+
*/
|
|
35
|
+
total: number;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof AgentFeedbackMetricsUio
|
|
40
|
+
*/
|
|
41
|
+
satisfactionRate?: number;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the AgentFeedbackMetricsUio interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfAgentFeedbackMetricsUio(value: object): value is AgentFeedbackMetricsUio;
|
|
47
|
+
export declare function AgentFeedbackMetricsUioFromJSON(json: any): AgentFeedbackMetricsUio;
|
|
48
|
+
export declare function AgentFeedbackMetricsUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentFeedbackMetricsUio;
|
|
49
|
+
export declare function AgentFeedbackMetricsUioToJSON(json: any): AgentFeedbackMetricsUio;
|
|
50
|
+
export declare function AgentFeedbackMetricsUioToJSONTyped(value?: AgentFeedbackMetricsUio | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* brain-client
|
|
6
|
+
* Api ands models for brain-app and brain-app
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.0.0-SNAPSHOT
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfAgentFeedbackMetricsUio = instanceOfAgentFeedbackMetricsUio;
|
|
17
|
+
exports.AgentFeedbackMetricsUioFromJSON = AgentFeedbackMetricsUioFromJSON;
|
|
18
|
+
exports.AgentFeedbackMetricsUioFromJSONTyped = AgentFeedbackMetricsUioFromJSONTyped;
|
|
19
|
+
exports.AgentFeedbackMetricsUioToJSON = AgentFeedbackMetricsUioToJSON;
|
|
20
|
+
exports.AgentFeedbackMetricsUioToJSONTyped = AgentFeedbackMetricsUioToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the AgentFeedbackMetricsUio interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfAgentFeedbackMetricsUio(value) {
|
|
25
|
+
if (!('positive' in value) || value['positive'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('negative' in value) || value['negative'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('total' in value) || value['total'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
function AgentFeedbackMetricsUioFromJSON(json) {
|
|
34
|
+
return AgentFeedbackMetricsUioFromJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
function AgentFeedbackMetricsUioFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
|
+
if (json == null) {
|
|
38
|
+
return json;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
'positive': json['positive'],
|
|
42
|
+
'negative': json['negative'],
|
|
43
|
+
'total': json['total'],
|
|
44
|
+
'satisfactionRate': json['satisfactionRate'] == null ? undefined : json['satisfactionRate'],
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
function AgentFeedbackMetricsUioToJSON(json) {
|
|
48
|
+
return AgentFeedbackMetricsUioToJSONTyped(json, false);
|
|
49
|
+
}
|
|
50
|
+
function AgentFeedbackMetricsUioToJSONTyped(value, ignoreDiscriminator = false) {
|
|
51
|
+
if (value == null) {
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
'positive': value['positive'],
|
|
56
|
+
'negative': value['negative'],
|
|
57
|
+
'total': value['total'],
|
|
58
|
+
'satisfactionRate': value['satisfactionRate'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* brain-client
|
|
3
|
+
* Api ands models for brain-app and brain-app
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.0.0-SNAPSHOT
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AgentMetricsByAppUio
|
|
16
|
+
*/
|
|
17
|
+
export interface AgentMetricsByAppUio {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof AgentMetricsByAppUio
|
|
22
|
+
*/
|
|
23
|
+
appId?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof AgentMetricsByAppUio
|
|
28
|
+
*/
|
|
29
|
+
appName: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof AgentMetricsByAppUio
|
|
34
|
+
*/
|
|
35
|
+
tokens: number;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof AgentMetricsByAppUio
|
|
40
|
+
*/
|
|
41
|
+
conversations: number;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof AgentMetricsByAppUio
|
|
46
|
+
*/
|
|
47
|
+
uniqueUsers: number;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the AgentMetricsByAppUio interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfAgentMetricsByAppUio(value: object): value is AgentMetricsByAppUio;
|
|
53
|
+
export declare function AgentMetricsByAppUioFromJSON(json: any): AgentMetricsByAppUio;
|
|
54
|
+
export declare function AgentMetricsByAppUioFromJSONTyped(json: any, ignoreDiscriminator: boolean): AgentMetricsByAppUio;
|
|
55
|
+
export declare function AgentMetricsByAppUioToJSON(json: any): AgentMetricsByAppUio;
|
|
56
|
+
export declare function AgentMetricsByAppUioToJSONTyped(value?: AgentMetricsByAppUio | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* brain-client
|
|
6
|
+
* Api ands models for brain-app and brain-app
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.0.0-SNAPSHOT
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfAgentMetricsByAppUio = instanceOfAgentMetricsByAppUio;
|
|
17
|
+
exports.AgentMetricsByAppUioFromJSON = AgentMetricsByAppUioFromJSON;
|
|
18
|
+
exports.AgentMetricsByAppUioFromJSONTyped = AgentMetricsByAppUioFromJSONTyped;
|
|
19
|
+
exports.AgentMetricsByAppUioToJSON = AgentMetricsByAppUioToJSON;
|
|
20
|
+
exports.AgentMetricsByAppUioToJSONTyped = AgentMetricsByAppUioToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the AgentMetricsByAppUio interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfAgentMetricsByAppUio(value) {
|
|
25
|
+
if (!('appName' in value) || value['appName'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('tokens' in value) || value['tokens'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('conversations' in value) || value['conversations'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('uniqueUsers' in value) || value['uniqueUsers'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
function AgentMetricsByAppUioFromJSON(json) {
|
|
36
|
+
return AgentMetricsByAppUioFromJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
function AgentMetricsByAppUioFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
+
if (json == null) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'appId': json['appId'] == null ? undefined : json['appId'],
|
|
44
|
+
'appName': json['appName'],
|
|
45
|
+
'tokens': json['tokens'],
|
|
46
|
+
'conversations': json['conversations'],
|
|
47
|
+
'uniqueUsers': json['uniqueUsers'],
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
function AgentMetricsByAppUioToJSON(json) {
|
|
51
|
+
return AgentMetricsByAppUioToJSONTyped(json, false);
|
|
52
|
+
}
|
|
53
|
+
function AgentMetricsByAppUioToJSONTyped(value, ignoreDiscriminator = false) {
|
|
54
|
+
if (value == null) {
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
'appId': value['appId'],
|
|
59
|
+
'appName': value['appName'],
|
|
60
|
+
'tokens': value['tokens'],
|
|
61
|
+
'conversations': value['conversations'],
|
|
62
|
+
'uniqueUsers': value['uniqueUsers'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
@@ -10,7 +10,14 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { SubscriptionMetricUio } from './SubscriptionMetricUio';
|
|
13
|
+
import type { AgentMetricsByAppUio } from './AgentMetricsByAppUio';
|
|
14
|
+
import type { AgentTokenUsageByTaskUio } from './AgentTokenUsageByTaskUio';
|
|
15
|
+
import type { AgentTokenBreakdownUio } from './AgentTokenBreakdownUio';
|
|
16
|
+
import type { AgentToolUsageMetricUio } from './AgentToolUsageMetricUio';
|
|
17
|
+
import type { AgentFeedbackMetricsUio } from './AgentFeedbackMetricsUio';
|
|
18
|
+
import type { AgentTokenUsageMetricUio } from './AgentTokenUsageMetricUio';
|
|
13
19
|
import type { CostMetricUio } from './CostMetricUio';
|
|
20
|
+
import type { AgentMetricsPeriodComparisonUio } from './AgentMetricsPeriodComparisonUio';
|
|
14
21
|
/**
|
|
15
22
|
*
|
|
16
23
|
* @export
|
|
@@ -41,6 +48,78 @@ export interface AgentMetricsOverviewUio {
|
|
|
41
48
|
* @memberof AgentMetricsOverviewUio
|
|
42
49
|
*/
|
|
43
50
|
userVoiceMessagesCount: number;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {number}
|
|
54
|
+
* @memberof AgentMetricsOverviewUio
|
|
55
|
+
*/
|
|
56
|
+
totalRequests?: number;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {number}
|
|
60
|
+
* @memberof AgentMetricsOverviewUio
|
|
61
|
+
*/
|
|
62
|
+
totalTokensUsed?: number;
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @type {number}
|
|
66
|
+
* @memberof AgentMetricsOverviewUio
|
|
67
|
+
*/
|
|
68
|
+
ephemeralInstancesCreated?: number;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {number}
|
|
72
|
+
* @memberof AgentMetricsOverviewUio
|
|
73
|
+
*/
|
|
74
|
+
uniqueUsersCount?: number;
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
* @type {number}
|
|
78
|
+
* @memberof AgentMetricsOverviewUio
|
|
79
|
+
*/
|
|
80
|
+
errorConversationCount?: number;
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @type {AgentTokenBreakdownUio}
|
|
84
|
+
* @memberof AgentMetricsOverviewUio
|
|
85
|
+
*/
|
|
86
|
+
tokenBreakdown?: AgentTokenBreakdownUio;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @type {Array<AgentTokenUsageByTaskUio>}
|
|
90
|
+
* @memberof AgentMetricsOverviewUio
|
|
91
|
+
*/
|
|
92
|
+
tokenUsageByTask?: Array<AgentTokenUsageByTaskUio>;
|
|
93
|
+
/**
|
|
94
|
+
*
|
|
95
|
+
* @type {AgentFeedbackMetricsUio}
|
|
96
|
+
* @memberof AgentMetricsOverviewUio
|
|
97
|
+
*/
|
|
98
|
+
feedback?: AgentFeedbackMetricsUio;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @type {Array<AgentMetricsByAppUio>}
|
|
102
|
+
* @memberof AgentMetricsOverviewUio
|
|
103
|
+
*/
|
|
104
|
+
metricsByApp?: Array<AgentMetricsByAppUio>;
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @type {Array<AgentToolUsageMetricUio>}
|
|
108
|
+
* @memberof AgentMetricsOverviewUio
|
|
109
|
+
*/
|
|
110
|
+
topTools?: Array<AgentToolUsageMetricUio>;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @type {AgentMetricsPeriodComparisonUio}
|
|
114
|
+
* @memberof AgentMetricsOverviewUio
|
|
115
|
+
*/
|
|
116
|
+
periodComparison?: AgentMetricsPeriodComparisonUio;
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @type {Array<AgentTokenUsageMetricUio>}
|
|
120
|
+
* @memberof AgentMetricsOverviewUio
|
|
121
|
+
*/
|
|
122
|
+
tokenUsage?: Array<AgentTokenUsageMetricUio>;
|
|
44
123
|
/**
|
|
45
124
|
*
|
|
46
125
|
* @type {SubscriptionMetricUio}
|