@coval/sdk 0.7.2 → 0.9.4

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 (124) hide show
  1. package/LICENSE +21 -0
  2. package/NOTICE +5 -0
  3. package/README.md +2 -2
  4. package/dist/CovalClient.d.ts +3 -2
  5. package/dist/CovalClient.d.ts.map +1 -1
  6. package/dist/CovalClient.js +4 -1
  7. package/dist/CovalClient.js.map +1 -1
  8. package/dist/generated/apis/PythonMetricsApi.d.ts +290 -0
  9. package/dist/generated/apis/PythonMetricsApi.d.ts.map +1 -0
  10. package/dist/generated/apis/PythonMetricsApi.js +291 -0
  11. package/dist/generated/apis/PythonMetricsApi.js.map +1 -0
  12. package/dist/generated/apis/SimulatedConversationsApi.d.ts +4 -4
  13. package/dist/generated/apis/SimulatedConversationsApi.js +2 -2
  14. package/dist/generated/apis/index.d.ts +1 -0
  15. package/dist/generated/apis/index.d.ts.map +1 -1
  16. package/dist/generated/apis/index.js +1 -0
  17. package/dist/generated/apis/index.js.map +1 -1
  18. package/dist/generated/models/CovalMetricsAPIMetricType.d.ts +2 -0
  19. package/dist/generated/models/CovalMetricsAPIMetricType.d.ts.map +1 -1
  20. package/dist/generated/models/CovalMetricsAPIMetricType.js +2 -0
  21. package/dist/generated/models/CovalMetricsAPIMetricType.js.map +1 -1
  22. package/dist/generated/models/CovalPersonasAPICreatePersonaRequest.d.ts +10 -1
  23. package/dist/generated/models/CovalPersonasAPICreatePersonaRequest.d.ts.map +1 -1
  24. package/dist/generated/models/CovalPersonasAPICreatePersonaRequest.js +2 -0
  25. package/dist/generated/models/CovalPersonasAPICreatePersonaRequest.js.map +1 -1
  26. package/dist/generated/models/CovalPersonasAPIPersonaResource.d.ts +9 -0
  27. package/dist/generated/models/CovalPersonasAPIPersonaResource.d.ts.map +1 -1
  28. package/dist/generated/models/CovalPersonasAPIPersonaResource.js +2 -0
  29. package/dist/generated/models/CovalPersonasAPIPersonaResource.js.map +1 -1
  30. package/dist/generated/models/CovalPersonasAPIUpdatePersonaRequest.d.ts +11 -1
  31. package/dist/generated/models/CovalPersonasAPIUpdatePersonaRequest.d.ts.map +1 -1
  32. package/dist/generated/models/CovalPersonasAPIUpdatePersonaRequest.js +2 -0
  33. package/dist/generated/models/CovalPersonasAPIUpdatePersonaRequest.js.map +1 -1
  34. package/dist/generated/models/CovalReviewsAPIReviewProjectResource.d.ts +1 -1
  35. package/dist/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.d.ts +1 -1
  36. package/dist/generated/models/CovalUploadedConversationsAPISubmitUploadedConversationRequest.d.ts +8 -2
  37. package/dist/generated/models/CovalUploadedConversationsAPISubmitUploadedConversationRequest.d.ts.map +1 -1
  38. package/dist/generated/models/CovalUploadedConversationsAPISubmitUploadedConversationRequest.js.map +1 -1
  39. package/dist/generated/models/CovalUploadedConversationsAPITranscriptMessage.d.ts +53 -0
  40. package/dist/generated/models/CovalUploadedConversationsAPITranscriptMessage.d.ts.map +1 -1
  41. package/dist/generated/models/CovalUploadedConversationsAPITranscriptMessage.js +17 -0
  42. package/dist/generated/models/CovalUploadedConversationsAPITranscriptMessage.js.map +1 -1
  43. package/dist/generated/models/CovalUploadedConversationsAPIUploadedConversationResource.d.ts +4 -1
  44. package/dist/generated/models/CovalUploadedConversationsAPIUploadedConversationResource.d.ts.map +1 -1
  45. package/dist/generated/models/CovalUploadedConversationsAPIUploadedConversationResource.js.map +1 -1
  46. package/dist/generated/models/PythonMetricsAPICreatePythonMetricDraftRequest.d.ts +84 -0
  47. package/dist/generated/models/PythonMetricsAPICreatePythonMetricDraftRequest.d.ts.map +1 -0
  48. package/dist/generated/models/PythonMetricsAPICreatePythonMetricDraftRequest.js +70 -0
  49. package/dist/generated/models/PythonMetricsAPICreatePythonMetricDraftRequest.js.map +1 -0
  50. package/dist/generated/models/PythonMetricsAPIInputRequirements.d.ts +45 -0
  51. package/dist/generated/models/PythonMetricsAPIInputRequirements.d.ts.map +1 -0
  52. package/dist/generated/models/PythonMetricsAPIInputRequirements.js +46 -0
  53. package/dist/generated/models/PythonMetricsAPIInputRequirements.js.map +1 -0
  54. package/dist/generated/models/PythonMetricsAPIPreviewPythonMetricBody.d.ts +33 -0
  55. package/dist/generated/models/PythonMetricsAPIPreviewPythonMetricBody.d.ts.map +1 -0
  56. package/dist/generated/models/PythonMetricsAPIPreviewPythonMetricBody.js +44 -0
  57. package/dist/generated/models/PythonMetricsAPIPreviewPythonMetricBody.js.map +1 -0
  58. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricBody.d.ts +39 -0
  59. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricBody.d.ts.map +1 -0
  60. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricBody.js +48 -0
  61. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricBody.js.map +1 -0
  62. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricResponse.d.ts +39 -0
  63. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricResponse.d.ts.map +1 -0
  64. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricResponse.js +48 -0
  65. package/dist/generated/models/PythonMetricsAPIPublishPythonMetricResponse.js.map +1 -0
  66. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResource.d.ts +108 -0
  67. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResource.d.ts.map +1 -0
  68. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResource.js +92 -0
  69. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResource.js.map +1 -0
  70. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResponse.d.ts +34 -0
  71. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResponse.d.ts.map +1 -0
  72. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResponse.js +45 -0
  73. package/dist/generated/models/PythonMetricsAPIPythonMetricDraftResponse.js.map +1 -0
  74. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResource.d.ts +64 -0
  75. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResource.d.ts.map +1 -0
  76. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResource.js +59 -0
  77. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResource.js.map +1 -0
  78. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResourceValue.d.ts +27 -0
  79. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResourceValue.d.ts.map +1 -0
  80. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResourceValue.js +32 -0
  81. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewResourceValue.js.map +1 -0
  82. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewsResponse.d.ts +34 -0
  83. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewsResponse.d.ts.map +1 -0
  84. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewsResponse.js +45 -0
  85. package/dist/generated/models/PythonMetricsAPIPythonMetricPreviewsResponse.js.map +1 -0
  86. package/dist/generated/models/index.d.ts +10 -2
  87. package/dist/generated/models/index.d.ts.map +1 -1
  88. package/dist/generated/models/index.js +10 -2
  89. package/dist/generated/models/index.js.map +1 -1
  90. package/package.json +7 -5
  91. package/src/CovalClient.ts +4 -0
  92. package/src/generated/apis/PythonMetricsApi.ts +627 -0
  93. package/src/generated/apis/SimulatedConversationsApi.ts +4 -4
  94. package/src/generated/apis/index.ts +1 -0
  95. package/src/generated/models/CovalMetricsAPIMetricType.ts +2 -0
  96. package/src/generated/models/CovalPersonasAPICreatePersonaRequest.ts +12 -15
  97. package/src/generated/models/CovalPersonasAPIPersonaResource.ts +11 -0
  98. package/src/generated/models/CovalPersonasAPIUpdatePersonaRequest.ts +13 -1
  99. package/src/generated/models/CovalReviewsAPIReviewProjectResource.ts +1 -1
  100. package/src/generated/models/CovalReviewsAPIUpdateReviewProjectRequest.ts +1 -1
  101. package/src/generated/models/CovalUploadedConversationsAPISubmitUploadedConversationRequest.ts +8 -2
  102. package/src/generated/models/CovalUploadedConversationsAPITranscriptMessage.ts +64 -0
  103. package/src/generated/models/CovalUploadedConversationsAPIUploadedConversationResource.ts +4 -1
  104. package/src/generated/models/PythonMetricsAPICreatePythonMetricDraftRequest.ts +143 -0
  105. package/src/generated/models/PythonMetricsAPIInputRequirements.ts +81 -0
  106. package/src/generated/models/PythonMetricsAPIPreviewPythonMetricBody.ts +66 -0
  107. package/src/generated/models/PythonMetricsAPIPublishPythonMetricBody.ts +75 -0
  108. package/src/generated/models/PythonMetricsAPIPublishPythonMetricResponse.ts +75 -0
  109. package/src/generated/models/PythonMetricsAPIPythonMetricDraftResource.ts +182 -0
  110. package/src/generated/models/PythonMetricsAPIPythonMetricDraftResponse.ts +74 -0
  111. package/src/generated/models/PythonMetricsAPIPythonMetricPreviewResource.ts +116 -0
  112. package/src/generated/models/PythonMetricsAPIPythonMetricPreviewResourceValue.ts +46 -0
  113. package/src/generated/models/PythonMetricsAPIPythonMetricPreviewsResponse.ts +74 -0
  114. package/src/generated/models/index.ts +10 -2
  115. package/dist/generated/models/PersonaWithPrompt.d.ts +0 -33
  116. package/dist/generated/models/PersonaWithPrompt.d.ts.map +0 -1
  117. package/dist/generated/models/PersonaWithPrompt.js +0 -44
  118. package/dist/generated/models/PersonaWithPrompt.js.map +0 -1
  119. package/dist/generated/models/SilentPersona.d.ts +0 -40
  120. package/dist/generated/models/SilentPersona.d.ts.map +0 -1
  121. package/dist/generated/models/SilentPersona.js +0 -50
  122. package/dist/generated/models/SilentPersona.js.map +0 -1
  123. package/src/generated/models/PersonaWithPrompt.ts +0 -66
  124. package/src/generated/models/SilentPersona.ts +0 -76
@@ -0,0 +1,627 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Coval Agents API
5
+ * Manage configurations for simulations and evaluations.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@coval.dev
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime.js';
16
+ import {
17
+ type PythonMetricsAPICreatePythonMetricDraftRequest,
18
+ PythonMetricsAPICreatePythonMetricDraftRequestFromJSON,
19
+ PythonMetricsAPICreatePythonMetricDraftRequestToJSON,
20
+ } from '../models/PythonMetricsAPICreatePythonMetricDraftRequest.js';
21
+ import {
22
+ type PythonMetricsAPIPreviewPythonMetricBody,
23
+ PythonMetricsAPIPreviewPythonMetricBodyFromJSON,
24
+ PythonMetricsAPIPreviewPythonMetricBodyToJSON,
25
+ } from '../models/PythonMetricsAPIPreviewPythonMetricBody.js';
26
+ import {
27
+ type PythonMetricsAPIPublishPythonMetricBody,
28
+ PythonMetricsAPIPublishPythonMetricBodyFromJSON,
29
+ PythonMetricsAPIPublishPythonMetricBodyToJSON,
30
+ } from '../models/PythonMetricsAPIPublishPythonMetricBody.js';
31
+ import {
32
+ type PythonMetricsAPIPublishPythonMetricResponse,
33
+ PythonMetricsAPIPublishPythonMetricResponseFromJSON,
34
+ PythonMetricsAPIPublishPythonMetricResponseToJSON,
35
+ } from '../models/PythonMetricsAPIPublishPythonMetricResponse.js';
36
+ import {
37
+ type PythonMetricsAPIPythonMetricDraftResponse,
38
+ PythonMetricsAPIPythonMetricDraftResponseFromJSON,
39
+ PythonMetricsAPIPythonMetricDraftResponseToJSON,
40
+ } from '../models/PythonMetricsAPIPythonMetricDraftResponse.js';
41
+ import {
42
+ type PythonMetricsAPIPythonMetricPreviewsResponse,
43
+ PythonMetricsAPIPythonMetricPreviewsResponseFromJSON,
44
+ PythonMetricsAPIPythonMetricPreviewsResponseToJSON,
45
+ } from '../models/PythonMetricsAPIPythonMetricPreviewsResponse.js';
46
+
47
+ export interface CancelPythonMetricPreviewRequest {
48
+ draftId: string;
49
+ previewId: string;
50
+ xCovalWorkspaceId?: string;
51
+ }
52
+
53
+ export interface CreatePythonMetricDraftRequest {
54
+ pythonMetricsAPICreatePythonMetricDraftRequest: PythonMetricsAPICreatePythonMetricDraftRequest;
55
+ xCovalWorkspaceId?: string;
56
+ }
57
+
58
+ export interface GetPythonMetricDraftRequest {
59
+ draftId: string;
60
+ xCovalWorkspaceId?: string;
61
+ }
62
+
63
+ export interface GetPythonMetricPreviewRequest {
64
+ draftId: string;
65
+ previewId: string;
66
+ xCovalWorkspaceId?: string;
67
+ }
68
+
69
+ export interface PreviewPythonMetricRequest {
70
+ draftId: string;
71
+ pythonMetricsAPIPreviewPythonMetricBody: PythonMetricsAPIPreviewPythonMetricBody;
72
+ xCovalWorkspaceId?: string;
73
+ }
74
+
75
+ export interface PublishPythonMetricRequest {
76
+ draftId: string;
77
+ pythonMetricsAPIPublishPythonMetricBody: PythonMetricsAPIPublishPythonMetricBody;
78
+ xCovalWorkspaceId?: string;
79
+ }
80
+
81
+ /**
82
+ * PythonMetricsApi - interface
83
+ *
84
+ * @export
85
+ * @interface PythonMetricsApiInterface
86
+ */
87
+ export interface PythonMetricsApiInterface {
88
+ /**
89
+ * Creates request options for cancelPythonMetricPreview without sending the request
90
+ * @param {string} draftId
91
+ * @param {string} previewId
92
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
93
+ * @throws {RequiredError}
94
+ * @memberof PythonMetricsApiInterface
95
+ */
96
+ cancelPythonMetricPreviewRequestOpts(requestParameters: CancelPythonMetricPreviewRequest): Promise<runtime.RequestOpts>;
97
+
98
+ /**
99
+ * Cancel a pending preview. An already running evaluation cannot overwrite terminal cancellation.
100
+ * @summary Cancel a historical preview
101
+ * @param {string} draftId
102
+ * @param {string} previewId
103
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ * @memberof PythonMetricsApiInterface
107
+ */
108
+ cancelPythonMetricPreviewRaw(requestParameters: CancelPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricPreviewsResponse>>;
109
+
110
+ /**
111
+ * Cancel a pending preview. An already running evaluation cannot overwrite terminal cancellation.
112
+ * Cancel a historical preview
113
+ */
114
+ cancelPythonMetricPreview(requestParameters: CancelPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricPreviewsResponse>;
115
+
116
+ /**
117
+ * Creates request options for createPythonMetricDraft without sending the request
118
+ * @param {PythonMetricsAPICreatePythonMetricDraftRequest} pythonMetricsAPICreatePythonMetricDraftRequest
119
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
120
+ * @throws {RequiredError}
121
+ * @memberof PythonMetricsApiInterface
122
+ */
123
+ createPythonMetricDraftRequestOpts(requestParameters: CreatePythonMetricDraftRequest): Promise<runtime.RequestOpts>;
124
+
125
+ /**
126
+ * Save an immutable hidden draft pinned to the accepted runtime. Source or input changes require another draft.
127
+ * @summary Save a Python metric draft
128
+ * @param {PythonMetricsAPICreatePythonMetricDraftRequest} pythonMetricsAPICreatePythonMetricDraftRequest
129
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
130
+ * @param {*} [options] Override http request option.
131
+ * @throws {RequiredError}
132
+ * @memberof PythonMetricsApiInterface
133
+ */
134
+ createPythonMetricDraftRaw(requestParameters: CreatePythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricDraftResponse>>;
135
+
136
+ /**
137
+ * Save an immutable hidden draft pinned to the accepted runtime. Source or input changes require another draft.
138
+ * Save a Python metric draft
139
+ */
140
+ createPythonMetricDraft(requestParameters: CreatePythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricDraftResponse>;
141
+
142
+ /**
143
+ * Creates request options for getPythonMetricDraft without sending the request
144
+ * @param {string} draftId
145
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
146
+ * @throws {RequiredError}
147
+ * @memberof PythonMetricsApiInterface
148
+ */
149
+ getPythonMetricDraftRequestOpts(requestParameters: GetPythonMetricDraftRequest): Promise<runtime.RequestOpts>;
150
+
151
+ /**
152
+ * Read the immutable definition and fingerprint of a draft in the authenticated workspace.
153
+ * @summary Get a Python metric draft
154
+ * @param {string} draftId
155
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ * @memberof PythonMetricsApiInterface
159
+ */
160
+ getPythonMetricDraftRaw(requestParameters: GetPythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricDraftResponse>>;
161
+
162
+ /**
163
+ * Read the immutable definition and fingerprint of a draft in the authenticated workspace.
164
+ * Get a Python metric draft
165
+ */
166
+ getPythonMetricDraft(requestParameters: GetPythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricDraftResponse>;
167
+
168
+ /**
169
+ * Creates request options for getPythonMetricPreview without sending the request
170
+ * @param {string} draftId
171
+ * @param {string} previewId
172
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
173
+ * @throws {RequiredError}
174
+ * @memberof PythonMetricsApiInterface
175
+ */
176
+ getPythonMetricPreviewRequestOpts(requestParameters: GetPythonMetricPreviewRequest): Promise<runtime.RequestOpts>;
177
+
178
+ /**
179
+ * Read a preview outcome, including successful numeric zero or boolean false values.
180
+ * @summary Get a historical preview result
181
+ * @param {string} draftId
182
+ * @param {string} previewId
183
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
184
+ * @param {*} [options] Override http request option.
185
+ * @throws {RequiredError}
186
+ * @memberof PythonMetricsApiInterface
187
+ */
188
+ getPythonMetricPreviewRaw(requestParameters: GetPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricPreviewsResponse>>;
189
+
190
+ /**
191
+ * Read a preview outcome, including successful numeric zero or boolean false values.
192
+ * Get a historical preview result
193
+ */
194
+ getPythonMetricPreview(requestParameters: GetPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricPreviewsResponse>;
195
+
196
+ /**
197
+ * Creates request options for previewPythonMetric without sending the request
198
+ * @param {string} draftId
199
+ * @param {PythonMetricsAPIPreviewPythonMetricBody} pythonMetricsAPIPreviewPythonMetricBody
200
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
201
+ * @throws {RequiredError}
202
+ * @memberof PythonMetricsApiInterface
203
+ */
204
+ previewPythonMetricRequestOpts(requestParameters: PreviewPythonMetricRequest): Promise<runtime.RequestOpts>;
205
+
206
+ /**
207
+ * Queue a historical conversation evaluation. Poll the returned preview ID for the durable result.
208
+ * @summary Evaluate a draft on a historical conversation
209
+ * @param {string} draftId
210
+ * @param {PythonMetricsAPIPreviewPythonMetricBody} pythonMetricsAPIPreviewPythonMetricBody
211
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
212
+ * @param {*} [options] Override http request option.
213
+ * @throws {RequiredError}
214
+ * @memberof PythonMetricsApiInterface
215
+ */
216
+ previewPythonMetricRaw(requestParameters: PreviewPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricPreviewsResponse>>;
217
+
218
+ /**
219
+ * Queue a historical conversation evaluation. Poll the returned preview ID for the durable result.
220
+ * Evaluate a draft on a historical conversation
221
+ */
222
+ previewPythonMetric(requestParameters: PreviewPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricPreviewsResponse>;
223
+
224
+ /**
225
+ * Creates request options for publishPythonMetric without sending the request
226
+ * @param {string} draftId
227
+ * @param {PythonMetricsAPIPublishPythonMetricBody} pythonMetricsAPIPublishPythonMetricBody
228
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
229
+ * @throws {RequiredError}
230
+ * @memberof PythonMetricsApiInterface
231
+ */
232
+ publishPythonMetricRequestOpts(requestParameters: PublishPythonMetricRequest): Promise<runtime.RequestOpts>;
233
+
234
+ /**
235
+ * Publish only when successful preview evidence matches this exact draft fingerprint and runtime version.
236
+ * @summary Publish an approved and tested Python metric
237
+ * @param {string} draftId
238
+ * @param {PythonMetricsAPIPublishPythonMetricBody} pythonMetricsAPIPublishPythonMetricBody
239
+ * @param {string} [xCovalWorkspaceId] Active workspace; defaults to the authenticated organization’s default workspace.
240
+ * @param {*} [options] Override http request option.
241
+ * @throws {RequiredError}
242
+ * @memberof PythonMetricsApiInterface
243
+ */
244
+ publishPythonMetricRaw(requestParameters: PublishPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPublishPythonMetricResponse>>;
245
+
246
+ /**
247
+ * Publish only when successful preview evidence matches this exact draft fingerprint and runtime version.
248
+ * Publish an approved and tested Python metric
249
+ */
250
+ publishPythonMetric(requestParameters: PublishPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPublishPythonMetricResponse>;
251
+
252
+ }
253
+
254
+ /**
255
+ *
256
+ */
257
+ export class PythonMetricsApi extends runtime.BaseAPI implements PythonMetricsApiInterface {
258
+
259
+ /**
260
+ * Creates request options for cancelPythonMetricPreview without sending the request
261
+ */
262
+ async cancelPythonMetricPreviewRequestOpts(requestParameters: CancelPythonMetricPreviewRequest): Promise<runtime.RequestOpts> {
263
+ if (requestParameters['draftId'] == null) {
264
+ throw new runtime.RequiredError(
265
+ 'draftId',
266
+ 'Required parameter "draftId" was null or undefined when calling cancelPythonMetricPreview().'
267
+ );
268
+ }
269
+
270
+ if (requestParameters['previewId'] == null) {
271
+ throw new runtime.RequiredError(
272
+ 'previewId',
273
+ 'Required parameter "previewId" was null or undefined when calling cancelPythonMetricPreview().'
274
+ );
275
+ }
276
+
277
+ const queryParameters: any = {};
278
+
279
+ const headerParameters: runtime.HTTPHeaders = {};
280
+
281
+ if (requestParameters['xCovalWorkspaceId'] != null) {
282
+ headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
283
+ }
284
+
285
+ if (this.configuration && this.configuration.apiKey) {
286
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Python_Metrics_API_ApiKeyAuth authentication
287
+ }
288
+
289
+
290
+ let urlPath = `/python-metric-drafts/{draft_id}/previews/{preview_id}/cancel`;
291
+ urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
292
+ urlPath = urlPath.replace('{preview_id}', encodeURIComponent(String(requestParameters['previewId'])));
293
+
294
+ return {
295
+ path: urlPath,
296
+ method: 'POST',
297
+ headers: headerParameters,
298
+ query: queryParameters,
299
+ };
300
+ }
301
+
302
+ /**
303
+ * Cancel a pending preview. An already running evaluation cannot overwrite terminal cancellation.
304
+ * Cancel a historical preview
305
+ */
306
+ async cancelPythonMetricPreviewRaw(requestParameters: CancelPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricPreviewsResponse>> {
307
+ const requestOptions = await this.cancelPythonMetricPreviewRequestOpts(requestParameters);
308
+ const response = await this.request(requestOptions, initOverrides);
309
+
310
+ return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricPreviewsResponseFromJSON(jsonValue));
311
+ }
312
+
313
+ /**
314
+ * Cancel a pending preview. An already running evaluation cannot overwrite terminal cancellation.
315
+ * Cancel a historical preview
316
+ */
317
+ async cancelPythonMetricPreview(requestParameters: CancelPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricPreviewsResponse> {
318
+ const response = await this.cancelPythonMetricPreviewRaw(requestParameters, initOverrides);
319
+ return await response.value();
320
+ }
321
+
322
+ /**
323
+ * Creates request options for createPythonMetricDraft without sending the request
324
+ */
325
+ async createPythonMetricDraftRequestOpts(requestParameters: CreatePythonMetricDraftRequest): Promise<runtime.RequestOpts> {
326
+ if (requestParameters['pythonMetricsAPICreatePythonMetricDraftRequest'] == null) {
327
+ throw new runtime.RequiredError(
328
+ 'pythonMetricsAPICreatePythonMetricDraftRequest',
329
+ 'Required parameter "pythonMetricsAPICreatePythonMetricDraftRequest" was null or undefined when calling createPythonMetricDraft().'
330
+ );
331
+ }
332
+
333
+ const queryParameters: any = {};
334
+
335
+ const headerParameters: runtime.HTTPHeaders = {};
336
+
337
+ headerParameters['Content-Type'] = 'application/json';
338
+
339
+ if (requestParameters['xCovalWorkspaceId'] != null) {
340
+ headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
341
+ }
342
+
343
+ if (this.configuration && this.configuration.apiKey) {
344
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Python_Metrics_API_ApiKeyAuth authentication
345
+ }
346
+
347
+
348
+ let urlPath = `/python-metric-drafts`;
349
+
350
+ return {
351
+ path: urlPath,
352
+ method: 'POST',
353
+ headers: headerParameters,
354
+ query: queryParameters,
355
+ body: PythonMetricsAPICreatePythonMetricDraftRequestToJSON(requestParameters['pythonMetricsAPICreatePythonMetricDraftRequest']),
356
+ };
357
+ }
358
+
359
+ /**
360
+ * Save an immutable hidden draft pinned to the accepted runtime. Source or input changes require another draft.
361
+ * Save a Python metric draft
362
+ */
363
+ async createPythonMetricDraftRaw(requestParameters: CreatePythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricDraftResponse>> {
364
+ const requestOptions = await this.createPythonMetricDraftRequestOpts(requestParameters);
365
+ const response = await this.request(requestOptions, initOverrides);
366
+
367
+ return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricDraftResponseFromJSON(jsonValue));
368
+ }
369
+
370
+ /**
371
+ * Save an immutable hidden draft pinned to the accepted runtime. Source or input changes require another draft.
372
+ * Save a Python metric draft
373
+ */
374
+ async createPythonMetricDraft(requestParameters: CreatePythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricDraftResponse> {
375
+ const response = await this.createPythonMetricDraftRaw(requestParameters, initOverrides);
376
+ return await response.value();
377
+ }
378
+
379
+ /**
380
+ * Creates request options for getPythonMetricDraft without sending the request
381
+ */
382
+ async getPythonMetricDraftRequestOpts(requestParameters: GetPythonMetricDraftRequest): Promise<runtime.RequestOpts> {
383
+ if (requestParameters['draftId'] == null) {
384
+ throw new runtime.RequiredError(
385
+ 'draftId',
386
+ 'Required parameter "draftId" was null or undefined when calling getPythonMetricDraft().'
387
+ );
388
+ }
389
+
390
+ const queryParameters: any = {};
391
+
392
+ const headerParameters: runtime.HTTPHeaders = {};
393
+
394
+ if (requestParameters['xCovalWorkspaceId'] != null) {
395
+ headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
396
+ }
397
+
398
+ if (this.configuration && this.configuration.apiKey) {
399
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Python_Metrics_API_ApiKeyAuth authentication
400
+ }
401
+
402
+
403
+ let urlPath = `/python-metric-drafts/{draft_id}`;
404
+ urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
405
+
406
+ return {
407
+ path: urlPath,
408
+ method: 'GET',
409
+ headers: headerParameters,
410
+ query: queryParameters,
411
+ };
412
+ }
413
+
414
+ /**
415
+ * Read the immutable definition and fingerprint of a draft in the authenticated workspace.
416
+ * Get a Python metric draft
417
+ */
418
+ async getPythonMetricDraftRaw(requestParameters: GetPythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricDraftResponse>> {
419
+ const requestOptions = await this.getPythonMetricDraftRequestOpts(requestParameters);
420
+ const response = await this.request(requestOptions, initOverrides);
421
+
422
+ return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricDraftResponseFromJSON(jsonValue));
423
+ }
424
+
425
+ /**
426
+ * Read the immutable definition and fingerprint of a draft in the authenticated workspace.
427
+ * Get a Python metric draft
428
+ */
429
+ async getPythonMetricDraft(requestParameters: GetPythonMetricDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricDraftResponse> {
430
+ const response = await this.getPythonMetricDraftRaw(requestParameters, initOverrides);
431
+ return await response.value();
432
+ }
433
+
434
+ /**
435
+ * Creates request options for getPythonMetricPreview without sending the request
436
+ */
437
+ async getPythonMetricPreviewRequestOpts(requestParameters: GetPythonMetricPreviewRequest): Promise<runtime.RequestOpts> {
438
+ if (requestParameters['draftId'] == null) {
439
+ throw new runtime.RequiredError(
440
+ 'draftId',
441
+ 'Required parameter "draftId" was null or undefined when calling getPythonMetricPreview().'
442
+ );
443
+ }
444
+
445
+ if (requestParameters['previewId'] == null) {
446
+ throw new runtime.RequiredError(
447
+ 'previewId',
448
+ 'Required parameter "previewId" was null or undefined when calling getPythonMetricPreview().'
449
+ );
450
+ }
451
+
452
+ const queryParameters: any = {};
453
+
454
+ const headerParameters: runtime.HTTPHeaders = {};
455
+
456
+ if (requestParameters['xCovalWorkspaceId'] != null) {
457
+ headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
458
+ }
459
+
460
+ if (this.configuration && this.configuration.apiKey) {
461
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Python_Metrics_API_ApiKeyAuth authentication
462
+ }
463
+
464
+
465
+ let urlPath = `/python-metric-drafts/{draft_id}/previews/{preview_id}`;
466
+ urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
467
+ urlPath = urlPath.replace('{preview_id}', encodeURIComponent(String(requestParameters['previewId'])));
468
+
469
+ return {
470
+ path: urlPath,
471
+ method: 'GET',
472
+ headers: headerParameters,
473
+ query: queryParameters,
474
+ };
475
+ }
476
+
477
+ /**
478
+ * Read a preview outcome, including successful numeric zero or boolean false values.
479
+ * Get a historical preview result
480
+ */
481
+ async getPythonMetricPreviewRaw(requestParameters: GetPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricPreviewsResponse>> {
482
+ const requestOptions = await this.getPythonMetricPreviewRequestOpts(requestParameters);
483
+ const response = await this.request(requestOptions, initOverrides);
484
+
485
+ return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricPreviewsResponseFromJSON(jsonValue));
486
+ }
487
+
488
+ /**
489
+ * Read a preview outcome, including successful numeric zero or boolean false values.
490
+ * Get a historical preview result
491
+ */
492
+ async getPythonMetricPreview(requestParameters: GetPythonMetricPreviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricPreviewsResponse> {
493
+ const response = await this.getPythonMetricPreviewRaw(requestParameters, initOverrides);
494
+ return await response.value();
495
+ }
496
+
497
+ /**
498
+ * Creates request options for previewPythonMetric without sending the request
499
+ */
500
+ async previewPythonMetricRequestOpts(requestParameters: PreviewPythonMetricRequest): Promise<runtime.RequestOpts> {
501
+ if (requestParameters['draftId'] == null) {
502
+ throw new runtime.RequiredError(
503
+ 'draftId',
504
+ 'Required parameter "draftId" was null or undefined when calling previewPythonMetric().'
505
+ );
506
+ }
507
+
508
+ if (requestParameters['pythonMetricsAPIPreviewPythonMetricBody'] == null) {
509
+ throw new runtime.RequiredError(
510
+ 'pythonMetricsAPIPreviewPythonMetricBody',
511
+ 'Required parameter "pythonMetricsAPIPreviewPythonMetricBody" was null or undefined when calling previewPythonMetric().'
512
+ );
513
+ }
514
+
515
+ const queryParameters: any = {};
516
+
517
+ const headerParameters: runtime.HTTPHeaders = {};
518
+
519
+ headerParameters['Content-Type'] = 'application/json';
520
+
521
+ if (requestParameters['xCovalWorkspaceId'] != null) {
522
+ headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
523
+ }
524
+
525
+ if (this.configuration && this.configuration.apiKey) {
526
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Python_Metrics_API_ApiKeyAuth authentication
527
+ }
528
+
529
+
530
+ let urlPath = `/python-metric-drafts/{draft_id}/previews`;
531
+ urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
532
+
533
+ return {
534
+ path: urlPath,
535
+ method: 'POST',
536
+ headers: headerParameters,
537
+ query: queryParameters,
538
+ body: PythonMetricsAPIPreviewPythonMetricBodyToJSON(requestParameters['pythonMetricsAPIPreviewPythonMetricBody']),
539
+ };
540
+ }
541
+
542
+ /**
543
+ * Queue a historical conversation evaluation. Poll the returned preview ID for the durable result.
544
+ * Evaluate a draft on a historical conversation
545
+ */
546
+ async previewPythonMetricRaw(requestParameters: PreviewPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPythonMetricPreviewsResponse>> {
547
+ const requestOptions = await this.previewPythonMetricRequestOpts(requestParameters);
548
+ const response = await this.request(requestOptions, initOverrides);
549
+
550
+ return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPythonMetricPreviewsResponseFromJSON(jsonValue));
551
+ }
552
+
553
+ /**
554
+ * Queue a historical conversation evaluation. Poll the returned preview ID for the durable result.
555
+ * Evaluate a draft on a historical conversation
556
+ */
557
+ async previewPythonMetric(requestParameters: PreviewPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPythonMetricPreviewsResponse> {
558
+ const response = await this.previewPythonMetricRaw(requestParameters, initOverrides);
559
+ return await response.value();
560
+ }
561
+
562
+ /**
563
+ * Creates request options for publishPythonMetric without sending the request
564
+ */
565
+ async publishPythonMetricRequestOpts(requestParameters: PublishPythonMetricRequest): Promise<runtime.RequestOpts> {
566
+ if (requestParameters['draftId'] == null) {
567
+ throw new runtime.RequiredError(
568
+ 'draftId',
569
+ 'Required parameter "draftId" was null or undefined when calling publishPythonMetric().'
570
+ );
571
+ }
572
+
573
+ if (requestParameters['pythonMetricsAPIPublishPythonMetricBody'] == null) {
574
+ throw new runtime.RequiredError(
575
+ 'pythonMetricsAPIPublishPythonMetricBody',
576
+ 'Required parameter "pythonMetricsAPIPublishPythonMetricBody" was null or undefined when calling publishPythonMetric().'
577
+ );
578
+ }
579
+
580
+ const queryParameters: any = {};
581
+
582
+ const headerParameters: runtime.HTTPHeaders = {};
583
+
584
+ headerParameters['Content-Type'] = 'application/json';
585
+
586
+ if (requestParameters['xCovalWorkspaceId'] != null) {
587
+ headerParameters['X-Coval-Workspace-Id'] = String(requestParameters['xCovalWorkspaceId']);
588
+ }
589
+
590
+ if (this.configuration && this.configuration.apiKey) {
591
+ headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Python_Metrics_API_ApiKeyAuth authentication
592
+ }
593
+
594
+
595
+ let urlPath = `/python-metric-drafts/{draft_id}/publish`;
596
+ urlPath = urlPath.replace('{draft_id}', encodeURIComponent(String(requestParameters['draftId'])));
597
+
598
+ return {
599
+ path: urlPath,
600
+ method: 'POST',
601
+ headers: headerParameters,
602
+ query: queryParameters,
603
+ body: PythonMetricsAPIPublishPythonMetricBodyToJSON(requestParameters['pythonMetricsAPIPublishPythonMetricBody']),
604
+ };
605
+ }
606
+
607
+ /**
608
+ * Publish only when successful preview evidence matches this exact draft fingerprint and runtime version.
609
+ * Publish an approved and tested Python metric
610
+ */
611
+ async publishPythonMetricRaw(requestParameters: PublishPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PythonMetricsAPIPublishPythonMetricResponse>> {
612
+ const requestOptions = await this.publishPythonMetricRequestOpts(requestParameters);
613
+ const response = await this.request(requestOptions, initOverrides);
614
+
615
+ return new runtime.JSONApiResponse(response, (jsonValue) => PythonMetricsAPIPublishPythonMetricResponseFromJSON(jsonValue));
616
+ }
617
+
618
+ /**
619
+ * Publish only when successful preview evidence matches this exact draft fingerprint and runtime version.
620
+ * Publish an approved and tested Python metric
621
+ */
622
+ async publishPythonMetric(requestParameters: PublishPythonMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PythonMetricsAPIPublishPythonMetricResponse> {
623
+ const response = await this.publishPythonMetricRaw(requestParameters, initOverrides);
624
+ return await response.value();
625
+ }
626
+
627
+ }
@@ -129,7 +129,7 @@ export interface SimulatedConversationsApiInterface {
129
129
  deleteSimulatedConversationRequestOpts(requestParameters: DeleteSimulatedConversationRequest): Promise<runtime.RequestOpts>;
130
130
 
131
131
  /**
132
- * Cancel or delete a simulation.
132
+ * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
133
133
  * @summary Delete or cancel simulation
134
134
  * @param {string} simulationId The simulation ID to delete/cancel
135
135
  * @param {*} [options] Override http request option.
@@ -139,7 +139,7 @@ export interface SimulatedConversationsApiInterface {
139
139
  deleteSimulatedConversationRaw(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
140
140
 
141
141
  /**
142
- * Cancel or delete a simulation.
142
+ * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
143
143
  * Delete or cancel simulation
144
144
  */
145
145
  deleteSimulatedConversation(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -391,7 +391,7 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
391
391
  }
392
392
 
393
393
  /**
394
- * Cancel or delete a simulation.
394
+ * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
395
395
  * Delete or cancel simulation
396
396
  */
397
397
  async deleteSimulatedConversationRaw(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
@@ -402,7 +402,7 @@ export class SimulatedConversationsApi extends runtime.BaseAPI implements Simula
402
402
  }
403
403
 
404
404
  /**
405
- * Cancel or delete a simulation.
405
+ * Cancel or delete a simulation. Retry a temporarily busy simulation after receiving HTTP 503.
406
406
  * Delete or cancel simulation
407
407
  */
408
408
  async deleteSimulatedConversation(requestParameters: DeleteSimulatedConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
@@ -16,6 +16,7 @@ export * from './MutationsApi.js';
16
16
  export * from './OrganizationConversationsConfigApi.js';
17
17
  export * from './OrganizationUsersApi.js';
18
18
  export * from './PersonasApi.js';
19
+ export * from './PythonMetricsApi.js';
19
20
  export * from './ReportsApi.js';
20
21
  export * from './ReviewAnnotationsApi.js';
21
22
  export * from './ReviewProjectsApi.js';