@spaciv/sdk 0.1.0 → 0.1.1

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.
@@ -72,6 +72,9 @@ src/models/AssistantConversationFailureBody.ts
72
72
  src/models/AssistantConversationListEntry.ts
73
73
  src/models/AssistantConversationListRes.ts
74
74
  src/models/AssistantModelListBody.ts
75
+ src/models/AssistantTranscriptBody.ts
76
+ src/models/AssistantTranscriptMessage.ts
77
+ src/models/AssistantTranscriptToolCall.ts
75
78
  src/models/AuthAPIKeyTokenReqBody.ts
76
79
  src/models/AuthAPIKeyTokenResBody.ts
77
80
  src/models/AuthLoginPassReqBody.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @spaciv/sdk@0.1.0
1
+ ## @spaciv/sdk@0.1.1
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @spaciv/sdk@0.1.0 --save
39
+ npm install @spaciv/sdk@0.1.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -10,13 +10,16 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AssistantChatPollBody, AssistantChatReq, AssistantChatRes, AssistantConfigBody, AssistantConfigPutReq, AssistantConversationListRes, AssistantModelListBody } from '../models/index';
13
+ import type { AssistantChatPollBody, AssistantChatReq, AssistantChatRes, AssistantConfigBody, AssistantConfigPutReq, AssistantConversationListRes, AssistantModelListBody, AssistantTranscriptBody } from '../models/index';
14
14
  export interface AssistantApiCreateChatRequest {
15
15
  assistantChatReq?: AssistantChatReq;
16
16
  }
17
17
  export interface AssistantApiDeleteConversationsRequest {
18
18
  id: string;
19
19
  }
20
+ export interface AssistantApiGetConversationsTranscriptRequest {
21
+ id: string;
22
+ }
20
23
  export interface AssistantApiPollConversationsRequest {
21
24
  id: string;
22
25
  since?: string;
@@ -75,6 +78,20 @@ export interface AssistantApiInterface {
75
78
  * Get the assistant configuration
76
79
  */
77
80
  getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
81
+ /**
82
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
83
+ * @summary Get a conversation\'s transcript
84
+ * @param {string} id UUID of the conversation to read.
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ * @memberof AssistantApiInterface
88
+ */
89
+ getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
90
+ /**
91
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
92
+ * Get a conversation\'s transcript
93
+ */
94
+ getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
78
95
  /**
79
96
  * Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
80
97
  * @summary List conversations
@@ -179,6 +196,16 @@ export declare class AssistantApi extends runtime.BaseAPI implements AssistantAp
179
196
  * Get the assistant configuration
180
197
  */
181
198
  getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
199
+ /**
200
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
201
+ * Get a conversation\'s transcript
202
+ */
203
+ getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
204
+ /**
205
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
206
+ * Get a conversation\'s transcript
207
+ */
208
+ getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
182
209
  /**
183
210
  * Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
184
211
  * List conversations
@@ -139,6 +139,45 @@ class AssistantApi extends runtime.BaseAPI {
139
139
  return yield response.value();
140
140
  });
141
141
  }
142
+ /**
143
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
144
+ * Get a conversation\'s transcript
145
+ */
146
+ getConversationsTranscriptRaw(requestParameters, initOverrides) {
147
+ return __awaiter(this, void 0, void 0, function* () {
148
+ if (requestParameters['id'] == null) {
149
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getConversationsTranscript().');
150
+ }
151
+ const queryParameters = {};
152
+ const headerParameters = {};
153
+ if (this.configuration && this.configuration.accessToken) {
154
+ const token = this.configuration.accessToken;
155
+ const tokenString = yield token("accessToken", []);
156
+ if (tokenString) {
157
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
158
+ }
159
+ }
160
+ let urlPath = `/v1/assistant/conversations/{id}/transcript`;
161
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
162
+ const response = yield this.request({
163
+ path: urlPath,
164
+ method: 'GET',
165
+ headers: headerParameters,
166
+ query: queryParameters,
167
+ }, initOverrides);
168
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AssistantTranscriptBodyFromJSON)(jsonValue));
169
+ });
170
+ }
171
+ /**
172
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
173
+ * Get a conversation\'s transcript
174
+ */
175
+ getConversationsTranscript(requestParameters, initOverrides) {
176
+ return __awaiter(this, void 0, void 0, function* () {
177
+ const response = yield this.getConversationsTranscriptRaw(requestParameters, initOverrides);
178
+ return yield response.value();
179
+ });
180
+ }
142
181
  /**
143
182
  * Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
144
183
  * List conversations
@@ -10,13 +10,16 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AssistantChatPollBody, AssistantChatReq, AssistantChatRes, AssistantConfigBody, AssistantConfigPutReq, AssistantConversationListRes, AssistantModelListBody } from '../models/index';
13
+ import type { AssistantChatPollBody, AssistantChatReq, AssistantChatRes, AssistantConfigBody, AssistantConfigPutReq, AssistantConversationListRes, AssistantModelListBody, AssistantTranscriptBody } from '../models/index';
14
14
  export interface AssistantApiCreateChatRequest {
15
15
  assistantChatReq?: AssistantChatReq;
16
16
  }
17
17
  export interface AssistantApiDeleteConversationsRequest {
18
18
  id: string;
19
19
  }
20
+ export interface AssistantApiGetConversationsTranscriptRequest {
21
+ id: string;
22
+ }
20
23
  export interface AssistantApiPollConversationsRequest {
21
24
  id: string;
22
25
  since?: string;
@@ -75,6 +78,20 @@ export interface AssistantApiInterface {
75
78
  * Get the assistant configuration
76
79
  */
77
80
  getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
81
+ /**
82
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
83
+ * @summary Get a conversation\'s transcript
84
+ * @param {string} id UUID of the conversation to read.
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ * @memberof AssistantApiInterface
88
+ */
89
+ getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
90
+ /**
91
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
92
+ * Get a conversation\'s transcript
93
+ */
94
+ getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
78
95
  /**
79
96
  * Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
80
97
  * @summary List conversations
@@ -179,6 +196,16 @@ export declare class AssistantApi extends runtime.BaseAPI implements AssistantAp
179
196
  * Get the assistant configuration
180
197
  */
181
198
  getConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantConfigBody>;
199
+ /**
200
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
201
+ * Get a conversation\'s transcript
202
+ */
203
+ getConversationsTranscriptRaw(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssistantTranscriptBody>>;
204
+ /**
205
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
206
+ * Get a conversation\'s transcript
207
+ */
208
+ getConversationsTranscript(requestParameters: AssistantApiGetConversationsTranscriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssistantTranscriptBody>;
182
209
  /**
183
210
  * Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
184
211
  * List conversations
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { AssistantChatPollBodyFromJSON, AssistantChatReqToJSON, AssistantChatResFromJSON, AssistantConfigBodyFromJSON, AssistantConfigPutReqToJSON, AssistantConversationListResFromJSON, AssistantModelListBodyFromJSON, } from '../models/index';
24
+ import { AssistantChatPollBodyFromJSON, AssistantChatReqToJSON, AssistantChatResFromJSON, AssistantConfigBodyFromJSON, AssistantConfigPutReqToJSON, AssistantConversationListResFromJSON, AssistantModelListBodyFromJSON, AssistantTranscriptBodyFromJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -136,6 +136,45 @@ export class AssistantApi extends runtime.BaseAPI {
136
136
  return yield response.value();
137
137
  });
138
138
  }
139
+ /**
140
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
141
+ * Get a conversation\'s transcript
142
+ */
143
+ getConversationsTranscriptRaw(requestParameters, initOverrides) {
144
+ return __awaiter(this, void 0, void 0, function* () {
145
+ if (requestParameters['id'] == null) {
146
+ throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getConversationsTranscript().');
147
+ }
148
+ const queryParameters = {};
149
+ const headerParameters = {};
150
+ if (this.configuration && this.configuration.accessToken) {
151
+ const token = this.configuration.accessToken;
152
+ const tokenString = yield token("accessToken", []);
153
+ if (tokenString) {
154
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
155
+ }
156
+ }
157
+ let urlPath = `/v1/assistant/conversations/{id}/transcript`;
158
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
159
+ const response = yield this.request({
160
+ path: urlPath,
161
+ method: 'GET',
162
+ headers: headerParameters,
163
+ query: queryParameters,
164
+ }, initOverrides);
165
+ return new runtime.JSONApiResponse(response, (jsonValue) => AssistantTranscriptBodyFromJSON(jsonValue));
166
+ });
167
+ }
168
+ /**
169
+ * Returns the conversation as it is stored, for debugging and evaluating the assistant: every message the assistant has been shown, including the results of its tool calls and the ids that pair each result with its call, and the summary that replaces the earliest messages once the conversation has been compacted. Returns `404` if the conversation does not exist. Requires the *AI assistant* and *Download AI assistant conversation* permissions.
170
+ * Get a conversation\'s transcript
171
+ */
172
+ getConversationsTranscript(requestParameters, initOverrides) {
173
+ return __awaiter(this, void 0, void 0, function* () {
174
+ const response = yield this.getConversationsTranscriptRaw(requestParameters, initOverrides);
175
+ return yield response.value();
176
+ });
177
+ }
139
178
  /**
140
179
  * Returns the caller\'s own assistant conversations in the current project. A conversation belongs to the user who started it and is not visible to anyone else. Requires the *AI assistant* permission.
141
180
  * List conversations
@@ -0,0 +1,45 @@
1
+ /**
2
+ * spaciv API
3
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@spaciv.com
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
+ import type { AssistantTranscriptMessage } from './AssistantTranscriptMessage';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AssistantTranscriptBody
17
+ */
18
+ export interface AssistantTranscriptBody {
19
+ /**
20
+ *
21
+ * @type {Array<AssistantTranscriptMessage>}
22
+ * @memberof AssistantTranscriptBody
23
+ */
24
+ messages: Array<AssistantTranscriptMessage>;
25
+ /**
26
+ * What the assistant is told of the messages it no longer replays, once the conversation has been compacted. Empty until then.
27
+ * @type {string}
28
+ * @memberof AssistantTranscriptBody
29
+ */
30
+ summary: string;
31
+ /**
32
+ * How many of the leading messages the summary stands in for.
33
+ * @type {number}
34
+ * @memberof AssistantTranscriptBody
35
+ */
36
+ summaryUpTo: number;
37
+ }
38
+ /**
39
+ * Check if a given object implements the AssistantTranscriptBody interface.
40
+ */
41
+ export declare function instanceOfAssistantTranscriptBody(value: object): value is AssistantTranscriptBody;
42
+ export declare function AssistantTranscriptBodyFromJSON(json: any): AssistantTranscriptBody;
43
+ export declare function AssistantTranscriptBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssistantTranscriptBody;
44
+ export declare function AssistantTranscriptBodyToJSON(json: any): AssistantTranscriptBody;
45
+ export declare function AssistantTranscriptBodyToJSONTyped(value?: AssistantTranscriptBody | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * spaciv API
5
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@spaciv.com
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
+ import { AssistantTranscriptMessageFromJSON, AssistantTranscriptMessageToJSON, } from './AssistantTranscriptMessage';
15
+ /**
16
+ * Check if a given object implements the AssistantTranscriptBody interface.
17
+ */
18
+ export function instanceOfAssistantTranscriptBody(value) {
19
+ if (!('messages' in value) || value['messages'] === undefined)
20
+ return false;
21
+ if (!('summary' in value) || value['summary'] === undefined)
22
+ return false;
23
+ if (!('summaryUpTo' in value) || value['summaryUpTo'] === undefined)
24
+ return false;
25
+ return true;
26
+ }
27
+ export function AssistantTranscriptBodyFromJSON(json) {
28
+ return AssistantTranscriptBodyFromJSONTyped(json, false);
29
+ }
30
+ export function AssistantTranscriptBodyFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'messages': (json['messages'].map(AssistantTranscriptMessageFromJSON)),
36
+ 'summary': json['summary'],
37
+ 'summaryUpTo': json['summaryUpTo'],
38
+ };
39
+ }
40
+ export function AssistantTranscriptBodyToJSON(json) {
41
+ return AssistantTranscriptBodyToJSONTyped(json, false);
42
+ }
43
+ export function AssistantTranscriptBodyToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'messages': (value['messages'].map(AssistantTranscriptMessageToJSON)),
49
+ 'summary': value['summary'],
50
+ 'summaryUpTo': value['summaryUpTo'],
51
+ };
52
+ }
@@ -0,0 +1,98 @@
1
+ /**
2
+ * spaciv API
3
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@spaciv.com
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
+ import type { AssistantTranscriptToolCall } from './AssistantTranscriptToolCall';
13
+ import type { AssistantChatPollAttachment } from './AssistantChatPollAttachment';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface AssistantTranscriptMessage
18
+ */
19
+ export interface AssistantTranscriptMessage {
20
+ /**
21
+ * Files attached to a user message. Empty on every other message.
22
+ * @type {Array<AssistantChatPollAttachment>}
23
+ * @memberof AssistantTranscriptMessage
24
+ */
25
+ attachments: Array<AssistantChatPollAttachment>;
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof AssistantTranscriptMessage
30
+ */
31
+ createdAt: string;
32
+ /**
33
+ * Whether the tool call a tool message answers failed: the tool refused it, returned an error, or was not available.
34
+ * @type {boolean}
35
+ * @memberof AssistantTranscriptMessage
36
+ */
37
+ failed: boolean;
38
+ /**
39
+ * The message's index in the conversation. A poll's message ids start with it.
40
+ * @type {string}
41
+ * @memberof AssistantTranscriptMessage
42
+ */
43
+ id: string;
44
+ /**
45
+ * Why a notice was given, as the id a poll shows it with.
46
+ * @type {string}
47
+ * @memberof AssistantTranscriptMessage
48
+ */
49
+ reason: string;
50
+ /**
51
+ *
52
+ * @type {string}
53
+ * @memberof AssistantTranscriptMessage
54
+ */
55
+ requestId: string;
56
+ /**
57
+ *
58
+ * @type {string}
59
+ * @memberof AssistantTranscriptMessage
60
+ */
61
+ role: AssistantTranscriptMessageRoleEnum;
62
+ /**
63
+ * For a tool message, the result the assistant was given.
64
+ * @type {string}
65
+ * @memberof AssistantTranscriptMessage
66
+ */
67
+ text: string;
68
+ /**
69
+ * The id of the tool call a tool message is the result of.
70
+ * @type {string}
71
+ * @memberof AssistantTranscriptMessage
72
+ */
73
+ toolCallId: string;
74
+ /**
75
+ * The tools an assistant message called. Empty on every other message.
76
+ * @type {Array<AssistantTranscriptToolCall>}
77
+ * @memberof AssistantTranscriptMessage
78
+ */
79
+ toolCalls: Array<AssistantTranscriptToolCall>;
80
+ }
81
+ /**
82
+ * @export
83
+ */
84
+ export declare const AssistantTranscriptMessageRoleEnum: {
85
+ readonly User: "user";
86
+ readonly Assistant: "assistant";
87
+ readonly Tool: "tool";
88
+ readonly Notice: "notice";
89
+ };
90
+ export type AssistantTranscriptMessageRoleEnum = typeof AssistantTranscriptMessageRoleEnum[keyof typeof AssistantTranscriptMessageRoleEnum];
91
+ /**
92
+ * Check if a given object implements the AssistantTranscriptMessage interface.
93
+ */
94
+ export declare function instanceOfAssistantTranscriptMessage(value: object): value is AssistantTranscriptMessage;
95
+ export declare function AssistantTranscriptMessageFromJSON(json: any): AssistantTranscriptMessage;
96
+ export declare function AssistantTranscriptMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssistantTranscriptMessage;
97
+ export declare function AssistantTranscriptMessageToJSON(json: any): AssistantTranscriptMessage;
98
+ export declare function AssistantTranscriptMessageToJSONTyped(value?: AssistantTranscriptMessage | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,90 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * spaciv API
5
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@spaciv.com
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
+ import { AssistantTranscriptToolCallFromJSON, AssistantTranscriptToolCallToJSON, } from './AssistantTranscriptToolCall';
15
+ import { AssistantChatPollAttachmentFromJSON, AssistantChatPollAttachmentToJSON, } from './AssistantChatPollAttachment';
16
+ /**
17
+ * @export
18
+ */
19
+ export const AssistantTranscriptMessageRoleEnum = {
20
+ User: 'user',
21
+ Assistant: 'assistant',
22
+ Tool: 'tool',
23
+ Notice: 'notice'
24
+ };
25
+ /**
26
+ * Check if a given object implements the AssistantTranscriptMessage interface.
27
+ */
28
+ export function instanceOfAssistantTranscriptMessage(value) {
29
+ if (!('attachments' in value) || value['attachments'] === undefined)
30
+ return false;
31
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
32
+ return false;
33
+ if (!('failed' in value) || value['failed'] === undefined)
34
+ return false;
35
+ if (!('id' in value) || value['id'] === undefined)
36
+ return false;
37
+ if (!('reason' in value) || value['reason'] === undefined)
38
+ return false;
39
+ if (!('requestId' in value) || value['requestId'] === undefined)
40
+ return false;
41
+ if (!('role' in value) || value['role'] === undefined)
42
+ return false;
43
+ if (!('text' in value) || value['text'] === undefined)
44
+ return false;
45
+ if (!('toolCallId' in value) || value['toolCallId'] === undefined)
46
+ return false;
47
+ if (!('toolCalls' in value) || value['toolCalls'] === undefined)
48
+ return false;
49
+ return true;
50
+ }
51
+ export function AssistantTranscriptMessageFromJSON(json) {
52
+ return AssistantTranscriptMessageFromJSONTyped(json, false);
53
+ }
54
+ export function AssistantTranscriptMessageFromJSONTyped(json, ignoreDiscriminator) {
55
+ if (json == null) {
56
+ return json;
57
+ }
58
+ return {
59
+ 'attachments': (json['attachments'].map(AssistantChatPollAttachmentFromJSON)),
60
+ 'createdAt': json['createdAt'],
61
+ 'failed': json['failed'],
62
+ 'id': json['id'],
63
+ 'reason': json['reason'],
64
+ 'requestId': json['requestId'],
65
+ 'role': json['role'],
66
+ 'text': json['text'],
67
+ 'toolCallId': json['toolCallId'],
68
+ 'toolCalls': (json['toolCalls'].map(AssistantTranscriptToolCallFromJSON)),
69
+ };
70
+ }
71
+ export function AssistantTranscriptMessageToJSON(json) {
72
+ return AssistantTranscriptMessageToJSONTyped(json, false);
73
+ }
74
+ export function AssistantTranscriptMessageToJSONTyped(value, ignoreDiscriminator = false) {
75
+ if (value == null) {
76
+ return value;
77
+ }
78
+ return {
79
+ 'attachments': (value['attachments'].map(AssistantChatPollAttachmentToJSON)),
80
+ 'createdAt': value['createdAt'],
81
+ 'failed': value['failed'],
82
+ 'id': value['id'],
83
+ 'reason': value['reason'],
84
+ 'requestId': value['requestId'],
85
+ 'role': value['role'],
86
+ 'text': value['text'],
87
+ 'toolCallId': value['toolCallId'],
88
+ 'toolCalls': (value['toolCalls'].map(AssistantTranscriptToolCallToJSON)),
89
+ };
90
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * spaciv API
3
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@spaciv.com
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 AssistantTranscriptToolCall
16
+ */
17
+ export interface AssistantTranscriptToolCall {
18
+ /**
19
+ * The call's JSON arguments.
20
+ * @type {string}
21
+ * @memberof AssistantTranscriptToolCall
22
+ */
23
+ arguments: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof AssistantTranscriptToolCall
28
+ */
29
+ id: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof AssistantTranscriptToolCall
34
+ */
35
+ name: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the AssistantTranscriptToolCall interface.
39
+ */
40
+ export declare function instanceOfAssistantTranscriptToolCall(value: object): value is AssistantTranscriptToolCall;
41
+ export declare function AssistantTranscriptToolCallFromJSON(json: any): AssistantTranscriptToolCall;
42
+ export declare function AssistantTranscriptToolCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssistantTranscriptToolCall;
43
+ export declare function AssistantTranscriptToolCallToJSON(json: any): AssistantTranscriptToolCall;
44
+ export declare function AssistantTranscriptToolCallToJSONTyped(value?: AssistantTranscriptToolCall | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * spaciv API
5
+ * The spaciv API powers workplace planning: modelling how many people an organisation has, how they work, and how much space that requires. ## Getting started 1. Exchange credentials for an access token using one of the operations under **Authentication**. 2. Send that token on every subsequent request as `Authorization: Bearer <token>`. 3. Access tokens are short lived. Call `POST /v1/auth/refresh-token` to obtain a new one before the old one expires. ## Conventions Every operation is versioned under `/v1`. Collections are plural (`GET /v1/dashboards` lists, `POST /v1/dashboards` creates) and individual records live beneath them (`/v1/dashboards/{id}`). Singular paths such as `/v1/account`, `/v1/project` and `/v1/user` refer to the record the access token was issued for. Request and response bodies are JSON. Timestamps are RFC 3339. Identifiers are opaque strings unless documented otherwise, and collection operations return the records visible to the account the token was issued for. Failures return an [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) problem document with a `detail` field describing what went wrong.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@spaciv.com
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
+ * Check if a given object implements the AssistantTranscriptToolCall interface.
16
+ */
17
+ export function instanceOfAssistantTranscriptToolCall(value) {
18
+ if (!('arguments' in value) || value['arguments'] === undefined)
19
+ return false;
20
+ if (!('id' in value) || value['id'] === undefined)
21
+ return false;
22
+ if (!('name' in value) || value['name'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function AssistantTranscriptToolCallFromJSON(json) {
27
+ return AssistantTranscriptToolCallFromJSONTyped(json, false);
28
+ }
29
+ export function AssistantTranscriptToolCallFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'arguments': json['arguments'],
35
+ 'id': json['id'],
36
+ 'name': json['name'],
37
+ };
38
+ }
39
+ export function AssistantTranscriptToolCallToJSON(json) {
40
+ return AssistantTranscriptToolCallToJSONTyped(json, false);
41
+ }
42
+ export function AssistantTranscriptToolCallToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'arguments': value['arguments'],
48
+ 'id': value['id'],
49
+ 'name': value['name'],
50
+ };
51
+ }
@@ -37,6 +37,9 @@ export * from './AssistantConversationFailureBody';
37
37
  export * from './AssistantConversationListEntry';
38
38
  export * from './AssistantConversationListRes';
39
39
  export * from './AssistantModelListBody';
40
+ export * from './AssistantTranscriptBody';
41
+ export * from './AssistantTranscriptMessage';
42
+ export * from './AssistantTranscriptToolCall';
40
43
  export * from './AuthAPIKeyTokenReqBody';
41
44
  export * from './AuthAPIKeyTokenResBody';
42
45
  export * from './AuthLoginPassReqBody';