@faiber/faiber-knowledge 0.24.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +169 -10
- package/dist/.tsbuildinfo +1 -1
- package/dist/index.d.ts +302 -39
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +282 -3
- package/dist/index.js.map +1 -1
- package/dist/operations.d.ts +317 -237
- package/dist/operations.d.ts.map +1 -1
- package/dist/operations.js +259 -163
- package/dist/operations.js.map +1 -1
- package/dist/operations.types.d.ts +109 -421
- package/dist/operations.types.d.ts.map +1 -1
- package/dist/types.d.ts +872 -90
- package/dist/types.d.ts.map +1 -1
- package/package.json +4 -3
- package/provenance.json +26 -0
package/dist/operations.d.ts
CHANGED
|
@@ -2,697 +2,777 @@ import { ServiceApi, type Identifier, type RequestOptions } from "@faiber/sdk-co
|
|
|
2
2
|
import type * as T from "./operations.types.js";
|
|
3
3
|
export declare class KnowledgeOperations extends ServiceApi {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* List current-organization customer actions, newest first. Only status and the clamped limit are applied; page and other shared ListQuery filters are ignored.
|
|
6
6
|
* Calls `GET /api/v1/actions` through the shared IDP-aware Faiber client.
|
|
7
7
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
8
8
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
9
|
-
* @returns The complete Axios response, including the typed
|
|
9
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
10
10
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:actions.
|
|
11
11
|
*/
|
|
12
|
-
workspaceAssistantContracts(params?: T.RoutesListActionsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
12
|
+
workspaceAssistantContracts(params?: T.RoutesListActionsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeCustomerActionListResponse, unknown, {}, any>>;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Update one organization-scoped action status and customer input. Completed stamps completed_at; a later status change retains that stamp.
|
|
15
15
|
* Calls `PATCH /api/v1/actions/{id}/status` through the shared IDP-aware Faiber client.
|
|
16
16
|
* @param id Backend path identifier `id`.
|
|
17
17
|
* @param data Typed JSON request body.
|
|
18
18
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
19
|
-
* @returns The complete Axios response, including the typed
|
|
19
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
20
20
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:actions.
|
|
21
21
|
*/
|
|
22
|
-
routesUpdateActionStatusPatch(id: Identifier, data: T.RoutesUpdateActionStatusPatchInput, options?: RequestOptions<T.RoutesUpdateActionStatusPatchInput>): Promise<import("axios").AxiosResponse<
|
|
22
|
+
routesUpdateActionStatusPatch(id: Identifier, data: T.RoutesUpdateActionStatusPatchInput, options?: RequestOptions<T.RoutesUpdateActionStatusPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeCustomerActionResponse, import("./types.js").ActionStatusInput, {}, any>>;
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* List editor audit rows for the current organization, newest first and limited to 1–200. Shared query fields other than limit are ignored.
|
|
25
25
|
* Calls `GET /api/v1/audit` through the shared IDP-aware Faiber client.
|
|
26
26
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
27
27
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
28
|
-
* @returns The complete Axios response, including the typed
|
|
28
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
29
29
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:audit.
|
|
30
30
|
*/
|
|
31
|
-
routesListAuditGet(params?: T.RoutesListAuditGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
31
|
+
routesListAuditGet(params?: T.RoutesListAuditGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeAuditLogListResponse, unknown, {}, any>>;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* List up to 500 current-organization platform audit events. knowledge:memory:read additionally includes redacted memory events; knowledge:read alone excludes them.
|
|
34
34
|
* Calls `GET /api/v1/audit-events` through the shared IDP-aware Faiber client.
|
|
35
35
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
36
|
-
* @returns The complete Axios response, including the typed
|
|
37
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
36
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
37
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read; knowledge:memory:read additionally includes redacted memory events.
|
|
38
38
|
*/
|
|
39
|
-
platformAuditEventsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
39
|
+
platformAuditEventsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeAuditEventListResponse, unknown, {}, any>>;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* List current-organization chat bindings ordered by chat slug. The result is not paginated.
|
|
42
42
|
* Calls `GET /api/v1/chat-bindings` through the shared IDP-aware Faiber client.
|
|
43
43
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
44
|
-
* @returns The complete Axios response, including the typed
|
|
44
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
45
45
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
46
46
|
*/
|
|
47
|
-
routesListBindingsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
47
|
+
routesListBindingsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").ChatBindingListResponse, unknown, {}, any>>;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Create a chat binding to an authorized base with group scope and tool policy; returns 201.
|
|
50
50
|
* Calls `POST /api/v1/chat-bindings` through the shared IDP-aware Faiber client.
|
|
51
51
|
* @param data Typed JSON request body.
|
|
52
52
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
53
|
-
* @returns The complete Axios response, including the typed
|
|
53
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
54
54
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
55
55
|
*/
|
|
56
|
-
routesCreateBindingPost(data: T.RoutesCreateBindingPostInput, options?: RequestOptions<T.RoutesCreateBindingPostInput>): Promise<import("axios").AxiosResponse<
|
|
56
|
+
routesCreateBindingPost(data: T.RoutesCreateBindingPostInput, options?: RequestOptions<T.RoutesCreateBindingPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").ChatBindingResponse, T.RoutesCreateBindingPostInput, {}, any>>;
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* Delete a tenant-owned chat binding and audit the change transactionally; returns 204.
|
|
59
59
|
* Calls `DELETE /api/v1/chat-bindings/{id}` through the shared IDP-aware Faiber client.
|
|
60
60
|
* @param id Backend path identifier `id`.
|
|
61
61
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
62
|
-
* @returns The complete Axios response, including the typed
|
|
62
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
63
63
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:delete.
|
|
64
64
|
*/
|
|
65
|
-
routesDeleteBindingDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}>>;
|
|
65
|
+
routesDeleteBindingDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* Update a tenant-owned chat binding under a base lock and optional expected_version; no implicit stale retry is performed.
|
|
68
68
|
* Calls `PUT /api/v1/chat-bindings/{id}` through the shared IDP-aware Faiber client.
|
|
69
69
|
* @param id Backend path identifier `id`.
|
|
70
70
|
* @param data Typed JSON request body.
|
|
71
71
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
72
|
-
* @returns The complete Axios response, including the typed
|
|
72
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
73
73
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
74
74
|
*/
|
|
75
|
-
routesUpdateBindingPut(id: Identifier, data: T.RoutesUpdateBindingPutInput, options?: RequestOptions<T.RoutesUpdateBindingPutInput>): Promise<import("axios").AxiosResponse<
|
|
75
|
+
routesUpdateBindingPut(id: Identifier, data: T.RoutesUpdateBindingPutInput, options?: RequestOptions<T.RoutesUpdateBindingPutInput>): Promise<import("axios").AxiosResponse<import("./types.js").ChatBindingResponse, T.RoutesUpdateBindingPutInput, {}, any>>;
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* List scoped nondeleted document summaries, excluding content and metadata. No client-side synthetic pagination is applied.
|
|
78
78
|
* Calls `GET /api/v1/documents` through the shared IDP-aware Faiber client.
|
|
79
79
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
80
|
-
* @returns The complete Axios response, including the typed
|
|
80
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
81
81
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
82
82
|
*/
|
|
83
|
-
platformListDocumentsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
83
|
+
platformListDocumentsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeDocumentListResponse, unknown, {}, any>>;
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
85
|
+
* Synchronously index governed text/chunks. Identical content returns 200 unchanged; changed content returns 201 with a completed job. Embedding readiness is separate.
|
|
86
86
|
* Calls `POST /api/v1/documents` through the shared IDP-aware Faiber client.
|
|
87
87
|
* @param data Typed JSON request body.
|
|
88
88
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
89
|
-
* @returns The complete Axios response, including the typed
|
|
89
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
90
90
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
91
91
|
*/
|
|
92
|
-
platformIngestDocumentPost(data: T.PlatformIngestDocumentPostInput, options?: RequestOptions<T.PlatformIngestDocumentPostInput>): Promise<import("axios").AxiosResponse<
|
|
92
|
+
platformIngestDocumentPost(data: T.PlatformIngestDocumentPostInput, options?: RequestOptions<T.PlatformIngestDocumentPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").IngestDocumentResponse, T.PlatformIngestDocumentPostInput, {}, any>>;
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* Persist or reuse a scoped document-reprocess job and return 202 with the actual job ID. Queued does not certify execution.
|
|
95
95
|
* Calls `POST /api/v1/documents/{id}/reprocess` through the shared IDP-aware Faiber client.
|
|
96
96
|
* @param id Backend path identifier `id`.
|
|
97
97
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
98
|
-
* @returns The complete Axios response, including the typed
|
|
98
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
99
99
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
100
100
|
*/
|
|
101
|
-
platformReprocessDocumentPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
101
|
+
platformReprocessDocumentPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeQueuedJobResponse, unknown, {}, any>>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* Delete an organization-owned graph edge and record editor audit transactionally; returns 204.
|
|
104
104
|
* Calls `DELETE /api/v1/edges/{id}` through the shared IDP-aware Faiber client.
|
|
105
105
|
* @param id Backend path identifier `id`.
|
|
106
106
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
107
|
-
* @returns The complete Axios response, including the typed
|
|
107
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
108
108
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:delete.
|
|
109
109
|
*/
|
|
110
|
-
routesDeleteEdgeDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}>>;
|
|
110
|
+
routesDeleteEdgeDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* Update an organization-owned graph edge under an authorized base lock and optional expected_version; stale edits return 409.
|
|
113
113
|
* Calls `PUT /api/v1/edges/{id}` through the shared IDP-aware Faiber client.
|
|
114
114
|
* @param id Backend path identifier `id`.
|
|
115
115
|
* @param data Typed JSON request body.
|
|
116
116
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
117
|
-
* @returns The complete Axios response, including the typed
|
|
117
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
118
118
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
119
119
|
*/
|
|
120
|
-
routesUpdateEdgePut(id: Identifier, data: T.RoutesUpdateEdgePutInput, options?: RequestOptions<T.RoutesUpdateEdgePutInput>): Promise<import("axios").AxiosResponse<
|
|
120
|
+
routesUpdateEdgePut(id: Identifier, data: T.RoutesUpdateEdgePutInput, options?: RequestOptions<T.RoutesUpdateEdgePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeEdgeResponse, T.RoutesUpdateEdgePutInput, {}, any>>;
|
|
121
121
|
/**
|
|
122
|
-
*
|
|
122
|
+
* Read up to 500 active current-organization evaluation cases ordered by latest update.
|
|
123
123
|
* Calls `GET /api/v1/evaluation-cases` through the shared IDP-aware Faiber client.
|
|
124
124
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
125
|
-
* @returns The complete Axios response, including the typed
|
|
125
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
126
126
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
127
127
|
*/
|
|
128
|
-
platformListEvaluationCasesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
128
|
+
platformListEvaluationCasesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeEvaluationCaseListResponse, unknown, {}, any>>;
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
130
|
+
* Upsert a stable-key evaluation case in the current organization and return 201. Blank stable key/query and identity/secret-bearing context fail validation.
|
|
131
131
|
* Calls `POST /api/v1/evaluation-cases` through the shared IDP-aware Faiber client.
|
|
132
132
|
* @param data Typed JSON request body.
|
|
133
133
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
134
|
-
* @returns The complete Axios response, including the typed
|
|
134
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
135
135
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
136
136
|
*/
|
|
137
|
-
platformSaveEvaluationCasePost(data: T.PlatformSaveEvaluationCasePostInput, options?: RequestOptions<T.PlatformSaveEvaluationCasePostInput>): Promise<import("axios").AxiosResponse<
|
|
137
|
+
platformSaveEvaluationCasePost(data: T.PlatformSaveEvaluationCasePostInput, options?: RequestOptions<T.PlatformSaveEvaluationCasePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeEvaluationCaseResponse, T.PlatformSaveEvaluationCasePostInput, {}, any>>;
|
|
138
138
|
/**
|
|
139
|
-
*
|
|
139
|
+
* Soft-delete one authorized empty group. Child groups, active items or active rules block deletion with 409; success returns 204.
|
|
140
140
|
* Calls `DELETE /api/v1/groups/{id}` through the shared IDP-aware Faiber client.
|
|
141
141
|
* @param id Backend path identifier `id`.
|
|
142
142
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
143
|
-
* @returns The complete Axios response, including the typed
|
|
143
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
144
144
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:delete.
|
|
145
145
|
*/
|
|
146
|
-
routesDeleteGroupDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}>>;
|
|
146
|
+
routesDeleteGroupDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
147
147
|
/**
|
|
148
|
-
*
|
|
148
|
+
* Update a group under a tenant-authorized locked base. Parent moves validate cycles and descendant levels; optional expected_version detects stale drafts.
|
|
149
149
|
* Calls `PUT /api/v1/groups/{id}` through the shared IDP-aware Faiber client.
|
|
150
150
|
* @param id Backend path identifier `id`.
|
|
151
151
|
* @param data Typed JSON request body.
|
|
152
152
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
153
|
-
* @returns The complete Axios response, including the typed
|
|
153
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
154
154
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
155
155
|
*/
|
|
156
|
-
routesUpdateGroupPut(id: Identifier, data: T.RoutesUpdateGroupPutInput, options?: RequestOptions<T.RoutesUpdateGroupPutInput>): Promise<import("axios").AxiosResponse<
|
|
156
|
+
routesUpdateGroupPut(id: Identifier, data: T.RoutesUpdateGroupPutInput, options?: RequestOptions<T.RoutesUpdateGroupPutInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeGroupResponse, T.RoutesUpdateGroupPutInput, {}, any>>;
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* Soft-delete one authorized item transactionally and record editor audit; returns 204.
|
|
159
159
|
* Calls `DELETE /api/v1/items/{id}` through the shared IDP-aware Faiber client.
|
|
160
160
|
* @param id Backend path identifier `id`.
|
|
161
161
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
162
|
-
* @returns The complete Axios response, including the typed
|
|
162
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
163
163
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:delete.
|
|
164
164
|
*/
|
|
165
|
-
routesDeleteItemDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}>>;
|
|
165
|
+
routesDeleteItemDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
167
|
+
* Read a nondeleted item through its organization-owned base; absent and foreign items return 404.
|
|
168
168
|
* Calls `GET /api/v1/items/{id}` through the shared IDP-aware Faiber client.
|
|
169
169
|
* @param id Backend path identifier `id`.
|
|
170
170
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
171
|
-
* @returns The complete Axios response, including the typed
|
|
171
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
172
172
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
173
173
|
*/
|
|
174
|
-
routesGetItemGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
174
|
+
routesGetItemGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeItemResponse, unknown, {}, any>>;
|
|
175
175
|
/**
|
|
176
|
-
*
|
|
176
|
+
* Update an item transactionally with optional expected_version. Omitted/null optional scalar fields preserve current values; empty link strings clear links.
|
|
177
177
|
* Calls `PUT /api/v1/items/{id}` through the shared IDP-aware Faiber client.
|
|
178
178
|
* @param id Backend path identifier `id`.
|
|
179
179
|
* @param data Typed JSON request body.
|
|
180
180
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
181
|
-
* @returns The complete Axios response, including the typed
|
|
181
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
182
182
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
183
183
|
*/
|
|
184
|
-
routesUpdateItemPut(id: Identifier, data: T.RoutesUpdateItemPutInput, options?: RequestOptions<T.RoutesUpdateItemPutInput>): Promise<import("axios").AxiosResponse<
|
|
184
|
+
routesUpdateItemPut(id: Identifier, data: T.RoutesUpdateItemPutInput, options?: RequestOptions<T.RoutesUpdateItemPutInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeItemResponse, import("./types.js").UpdateItemInput, {}, any>>;
|
|
185
185
|
/**
|
|
186
|
-
*
|
|
186
|
+
* Search current-organization nondeleted bases by name/slug and optional status. Page defaults to 1 and limit to 50, clamped to 1–200.
|
|
187
187
|
* Calls `GET /api/v1/knowledge-bases` through the shared IDP-aware Faiber client.
|
|
188
188
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
189
189
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
190
|
-
* @returns The complete Axios response, including the typed
|
|
190
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
191
191
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
192
192
|
*/
|
|
193
|
-
routesListBasesGet(params?: T.RoutesListBasesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
193
|
+
routesListBasesGet(params?: T.RoutesListBasesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeBaseListResponse, unknown, {}, any>>;
|
|
194
194
|
/**
|
|
195
|
-
*
|
|
195
|
+
* Create a draft base for the current organization. Slug validation and organization slug uniqueness are enforced; returns 201.
|
|
196
196
|
* Calls `POST /api/v1/knowledge-bases` through the shared IDP-aware Faiber client.
|
|
197
197
|
* @param data Typed JSON request body.
|
|
198
198
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
199
|
-
* @returns The complete Axios response, including the typed
|
|
199
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
200
200
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
201
201
|
*/
|
|
202
|
-
routesCreateBasePost(data: T.RoutesCreateBasePostInput, options?: RequestOptions<T.RoutesCreateBasePostInput>): Promise<import("axios").AxiosResponse<
|
|
202
|
+
routesCreateBasePost(data: T.RoutesCreateBasePostInput, options?: RequestOptions<T.RoutesCreateBasePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeBaseResponse, T.RoutesCreateBasePostInput, {}, any>>;
|
|
203
203
|
/**
|
|
204
|
-
*
|
|
204
|
+
* Soft-delete and archive a current-organization base transactionally; retained child rows remain inaccessible through the base. Returns 204.
|
|
205
205
|
* Calls `DELETE /api/v1/knowledge-bases/{id}` through the shared IDP-aware Faiber client.
|
|
206
206
|
* @param id Backend path identifier `id`.
|
|
207
207
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
208
|
-
* @returns The complete Axios response, including the typed
|
|
208
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
209
209
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:delete.
|
|
210
210
|
*/
|
|
211
|
-
routesDeleteBaseDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}>>;
|
|
211
|
+
routesDeleteBaseDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
212
212
|
/**
|
|
213
|
-
*
|
|
213
|
+
* Read a nondeleted organization-owned base. Foreign and missing base IDs return 404.
|
|
214
214
|
* Calls `GET /api/v1/knowledge-bases/{id}` through the shared IDP-aware Faiber client.
|
|
215
215
|
* @param id Backend path identifier `id`.
|
|
216
216
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
217
|
-
* @returns The complete Axios response, including the typed
|
|
217
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
218
218
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
219
219
|
*/
|
|
220
|
-
routesGetBaseGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
220
|
+
routesGetBaseGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeBaseResponse, unknown, {}, any>>;
|
|
221
221
|
/**
|
|
222
|
-
*
|
|
222
|
+
* Update an organization-owned base under optional expected_version. Null scalar fields behave as omitted; stale versions conflict with 409.
|
|
223
223
|
* Calls `PUT /api/v1/knowledge-bases/{id}` through the shared IDP-aware Faiber client.
|
|
224
224
|
* @param id Backend path identifier `id`.
|
|
225
225
|
* @param data Typed JSON request body.
|
|
226
226
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
227
|
-
* @returns The complete Axios response, including the typed
|
|
227
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
228
228
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
229
229
|
*/
|
|
230
|
-
routesUpdateBasePut(id: Identifier, data: T.RoutesUpdateBasePutInput, options?: RequestOptions<T.RoutesUpdateBasePutInput>): Promise<import("axios").AxiosResponse<
|
|
230
|
+
routesUpdateBasePut(id: Identifier, data: T.RoutesUpdateBasePutInput, options?: RequestOptions<T.RoutesUpdateBasePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeBaseResponse, T.RoutesUpdateBasePutInput, {}, any>>;
|
|
231
231
|
/**
|
|
232
|
-
*
|
|
232
|
+
* Read graph edges after authorizing their base, ordered by latest update. This endpoint does not accept pagination.
|
|
233
233
|
* Calls `GET /api/v1/knowledge-bases/{id}/edges` through the shared IDP-aware Faiber client.
|
|
234
234
|
* @param id Backend path identifier `id`.
|
|
235
235
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
236
|
-
* @returns The complete Axios response, including the typed
|
|
236
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
237
237
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
238
238
|
*/
|
|
239
|
-
routesListEdgesGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
239
|
+
routesListEdgesGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeEdgeListResponse, unknown, {}, any>>;
|
|
240
240
|
/**
|
|
241
|
-
*
|
|
241
|
+
* Create an edge with both endpoint items in the authorized base. Invalid cross-base endpoints fail; returns 201.
|
|
242
242
|
* Calls `POST /api/v1/knowledge-bases/{id}/edges` through the shared IDP-aware Faiber client.
|
|
243
243
|
* @param id Backend path identifier `id`.
|
|
244
244
|
* @param data Typed JSON request body.
|
|
245
245
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
246
|
-
* @returns The complete Axios response, including the typed
|
|
246
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
247
247
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
248
248
|
*/
|
|
249
|
-
routesCreateEdgePost(id: Identifier, data: T.RoutesCreateEdgePostInput, options?: RequestOptions<T.RoutesCreateEdgePostInput>): Promise<import("axios").AxiosResponse<
|
|
249
|
+
routesCreateEdgePost(id: Identifier, data: T.RoutesCreateEdgePostInput, options?: RequestOptions<T.RoutesCreateEdgePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeEdgeResponse, T.RoutesCreateEdgePostInput, {}, any>>;
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
251
|
+
* Export the current mutable authoring base, groups, items, edges and rules with an export timestamp. This is not an immutable published release.
|
|
252
252
|
* Calls `GET /api/v1/knowledge-bases/{id}/export` through the shared IDP-aware Faiber client.
|
|
253
253
|
* @param id Backend path identifier `id`.
|
|
254
254
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
255
|
-
* @returns The complete Axios response, including the typed
|
|
255
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
256
256
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
257
257
|
*/
|
|
258
|
-
routesExportBaseGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
258
|
+
routesExportBaseGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeExportResponse, unknown, {}, any>>;
|
|
259
259
|
/**
|
|
260
|
-
*
|
|
260
|
+
* List nondeleted groups after authorizing their base; returns an unpaginated array ordered by level then sort order.
|
|
261
261
|
* Calls `GET /api/v1/knowledge-bases/{id}/groups` through the shared IDP-aware Faiber client.
|
|
262
262
|
* @param id Backend path identifier `id`.
|
|
263
263
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
264
|
-
* @returns The complete Axios response, including the typed
|
|
264
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
265
265
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
266
266
|
*/
|
|
267
|
-
routesListGroupsGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
267
|
+
routesListGroupsGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeGroupListResponse, unknown, {}, any>>;
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* Create a group under a tenant-authorized locked base. Parent relationships and slug uniqueness are validated; returns 201.
|
|
270
270
|
* Calls `POST /api/v1/knowledge-bases/{id}/groups` through the shared IDP-aware Faiber client.
|
|
271
271
|
* @param id Backend path identifier `id`.
|
|
272
272
|
* @param data Typed JSON request body.
|
|
273
273
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
274
|
-
* @returns The complete Axios response, including the typed
|
|
274
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
275
275
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
276
276
|
*/
|
|
277
|
-
routesCreateGroupPost(id: Identifier, data: T.RoutesCreateGroupPostInput, options?: RequestOptions<T.RoutesCreateGroupPostInput>): Promise<import("axios").AxiosResponse<
|
|
277
|
+
routesCreateGroupPost(id: Identifier, data: T.RoutesCreateGroupPostInput, options?: RequestOptions<T.RoutesCreateGroupPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeGroupResponse, T.RoutesCreateGroupPostInput, {}, any>>;
|
|
278
278
|
/**
|
|
279
|
-
*
|
|
279
|
+
* Page nondeleted items after authorizing their base. Status, kind, link identifiers and slug/kind search apply; shared group filter is ignored.
|
|
280
280
|
* Calls `GET /api/v1/knowledge-bases/{id}/items` through the shared IDP-aware Faiber client.
|
|
281
281
|
* @param id Backend path identifier `id`.
|
|
282
282
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
283
283
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
284
|
-
* @returns The complete Axios response, including the typed
|
|
284
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
285
285
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
286
286
|
*/
|
|
287
|
-
routesListItemsGet(id: Identifier, params?: T.RoutesListItemsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
287
|
+
routesListItemsGet(id: Identifier, params?: T.RoutesListItemsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeItemListResponse, unknown, {}, any>>;
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
289
|
+
* Create a draft item in an authorized group. Importance, validity and linked service/entity fields are validated; returns 201.
|
|
290
290
|
* Calls `POST /api/v1/knowledge-bases/{id}/items` through the shared IDP-aware Faiber client.
|
|
291
291
|
* @param id Backend path identifier `id`.
|
|
292
292
|
* @param data Typed JSON request body.
|
|
293
293
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
294
|
-
* @returns The complete Axios response, including the typed
|
|
294
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
295
295
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
296
296
|
*/
|
|
297
|
-
routesCreateItemPost(id: Identifier, data: T.RoutesCreateItemPostInput, options?: RequestOptions<T.RoutesCreateItemPostInput>): Promise<import("axios").AxiosResponse<
|
|
297
|
+
routesCreateItemPost(id: Identifier, data: T.RoutesCreateItemPostInput, options?: RequestOptions<T.RoutesCreateItemPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeItemResponse, import("./types.js").CreateItemInput, {}, any>>;
|
|
298
298
|
/**
|
|
299
|
-
*
|
|
299
|
+
* Publish an immutable release snapshot of complete authorized content and update the base release pointer transactionally. Invalid content fails with 400.
|
|
300
300
|
* Calls `POST /api/v1/knowledge-bases/{id}/publish` through the shared IDP-aware Faiber client.
|
|
301
301
|
* @param id Backend path identifier `id`.
|
|
302
302
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
303
|
-
* @returns The complete Axios response, including the typed
|
|
303
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
304
304
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:publish.
|
|
305
305
|
*/
|
|
306
|
-
routesPublishPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
306
|
+
routesPublishPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeReleaseResponse, unknown, {}, any>>;
|
|
307
307
|
/**
|
|
308
|
-
*
|
|
308
|
+
* Read an immutable release after authorizing its base. The base ownership check also rejects missing or deleted bases.
|
|
309
309
|
* Calls `GET /api/v1/knowledge-releases/{id}` through the shared IDP-aware Faiber client.
|
|
310
310
|
* @param id Backend path identifier `id`.
|
|
311
311
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
312
|
-
* @returns The complete Axios response, including the typed
|
|
312
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
313
313
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
314
314
|
*/
|
|
315
|
-
routesGetReleaseGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
315
|
+
routesGetReleaseGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeReleaseResponse, unknown, {}, any>>;
|
|
316
316
|
/**
|
|
317
|
-
*
|
|
317
|
+
* Search nondeleted rules across all owned active bases before stable priority/ID pagination. Base, group, enabled and localized name/slug filters apply.
|
|
318
318
|
* Calls `GET /api/v1/match-rules` through the shared IDP-aware Faiber client.
|
|
319
319
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
320
320
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
321
|
-
* @returns The complete Axios response, including the typed
|
|
321
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
322
322
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
323
323
|
*/
|
|
324
|
-
routesListRulesGet(params?: T.RoutesListRulesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
324
|
+
routesListRulesGet(params?: T.RoutesListRulesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MatchRuleListResponse, unknown, {}, any>>;
|
|
325
325
|
/**
|
|
326
|
-
*
|
|
326
|
+
* Create a rule with validated base/group relationship and conditions; outcomes retain their extensible JSON shape. Returns 201.
|
|
327
327
|
* Calls `POST /api/v1/match-rules` through the shared IDP-aware Faiber client.
|
|
328
328
|
* @param data Typed JSON request body.
|
|
329
329
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
330
|
-
* @returns The complete Axios response, including the typed
|
|
330
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
331
331
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
332
332
|
*/
|
|
333
|
-
routesCreateRulePost(data: T.RoutesCreateRulePostInput, options?: RequestOptions<T.RoutesCreateRulePostInput>): Promise<import("axios").AxiosResponse<
|
|
333
|
+
routesCreateRulePost(data: T.RoutesCreateRulePostInput, options?: RequestOptions<T.RoutesCreateRulePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").MatchRuleResponse, T.RoutesCreateRulePostInput, {}, any>>;
|
|
334
334
|
/**
|
|
335
|
-
*
|
|
335
|
+
* Soft-delete an authorized match rule and record editor audit transactionally; returns 204.
|
|
336
336
|
* Calls `DELETE /api/v1/match-rules/{id}` through the shared IDP-aware Faiber client.
|
|
337
337
|
* @param id Backend path identifier `id`.
|
|
338
338
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
339
|
-
* @returns The complete Axios response, including the typed
|
|
339
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
340
340
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:delete.
|
|
341
341
|
*/
|
|
342
|
-
routesDeleteRuleDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}>>;
|
|
342
|
+
routesDeleteRuleDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
343
343
|
/**
|
|
344
|
-
*
|
|
344
|
+
* Update a rule after locked base ownership and group validation. Optional expected_version returns 409 for stale edits.
|
|
345
345
|
* Calls `PUT /api/v1/match-rules/{id}` through the shared IDP-aware Faiber client.
|
|
346
346
|
* @param id Backend path identifier `id`.
|
|
347
347
|
* @param data Typed JSON request body.
|
|
348
348
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
349
|
-
* @returns The complete Axios response, including the typed
|
|
349
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
350
350
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
351
351
|
*/
|
|
352
|
-
routesUpdateRulePut(id: Identifier, data: T.RoutesUpdateRulePutInput, options?: RequestOptions<T.RoutesUpdateRulePutInput>): Promise<import("axios").AxiosResponse<
|
|
352
|
+
routesUpdateRulePut(id: Identifier, data: T.RoutesUpdateRulePutInput, options?: RequestOptions<T.RoutesUpdateRulePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").MatchRuleResponse, T.RoutesUpdateRulePutInput, {}, any>>;
|
|
353
353
|
/**
|
|
354
354
|
* Performs the replay memory outbox operation for the platform capability.
|
|
355
355
|
* Calls `POST /api/v1/memory-outbox/{id}/replay` through the shared IDP-aware Faiber client.
|
|
356
356
|
* @param id Backend path identifier `id`.
|
|
357
357
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
358
|
-
* @returns The complete Axios response, including the typed
|
|
358
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
359
359
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:write.
|
|
360
360
|
*/
|
|
361
|
-
platformReplayMemoryOutboxPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
361
|
+
platformReplayMemoryOutboxPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MemoryOutboxReplayResponse, unknown, {}, any>>;
|
|
362
362
|
/**
|
|
363
|
-
*
|
|
363
|
+
* List bounded current subjects with literal profile/identity search, type/status/enabled filters and stable pagination. Return separate nullable overrides, effective policy, actual counts, server capabilities and captured revision; only the bounded Profile identity allowlist is returned.
|
|
364
364
|
* Calls `GET /api/v1/memory-subjects` through the shared IDP-aware Faiber client.
|
|
365
365
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
366
366
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
367
|
-
* @returns The complete Axios response, including the typed
|
|
368
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:read.
|
|
367
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
368
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:read; current organization/subject predicates on every read.
|
|
369
369
|
*/
|
|
370
|
-
platformListMemorySubjectsGet(params?: T.PlatformListMemorySubjectsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
370
|
+
platformListMemorySubjectsGet(params?: T.PlatformListMemorySubjectsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MemorySubjectListResponse, unknown, {}, any>>;
|
|
371
371
|
/**
|
|
372
|
-
*
|
|
372
|
+
* Atomically fence selected short/long or full subject scope and update current records/counters/audit.204 confirms commit. Original Chat conversations and retained physical copies remain separate service-owned actions.
|
|
373
373
|
* Calls `DELETE /api/v1/memory-subjects/{id}` through the shared IDP-aware Faiber client.
|
|
374
374
|
* @param id Backend path identifier `id`.
|
|
375
375
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
376
376
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
377
|
-
* @returns The complete Axios response, including the typed
|
|
378
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
377
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
378
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: current authenticated subject owner OR scoped knowledge:memory:delete; common transactional scope fence/audit.
|
|
379
|
+
*/
|
|
380
|
+
platformClearMemorySubjectDelete(id: Identifier, params?: T.PlatformClearMemorySubjectDeleteQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
381
|
+
/**
|
|
382
|
+
* Read one currently authorized subject by ID. Foreign and absent tenant records return404; response separates raw nullable overrides from effective policy and provides the reviewed policy revision.
|
|
383
|
+
* Calls `GET /api/v1/memory-subjects/{id}` through the shared IDP-aware Faiber client.
|
|
384
|
+
* @param id Backend path identifier `id`.
|
|
385
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
386
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
387
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:read; current organization/subject predicates on every read.
|
|
388
|
+
*/
|
|
389
|
+
platformMemorySubjectGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MemorySubjectResponse, unknown, {}, any>>;
|
|
390
|
+
/**
|
|
391
|
+
* Read paginated authorized audit identifiers/actions/actors/dates. Retained before/after payloads and free-text reasons are excluded to prevent forgotten content reappearing through audit.
|
|
392
|
+
* Calls `GET /api/v1/memory-subjects/{id}/audit-events` through the shared IDP-aware Faiber client.
|
|
393
|
+
* @param id Backend path identifier `id`.
|
|
394
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
395
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
396
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
397
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:read; current organization/subject predicates on every read.
|
|
379
398
|
*/
|
|
380
|
-
|
|
399
|
+
platformMemoryAuditGet(id: Identifier, params?: T.PlatformMemoryAuditGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MemoryAuditListResponse, unknown, {}, any>>;
|
|
381
400
|
/**
|
|
382
|
-
*
|
|
401
|
+
* Apply an explicit correction UUID with1–32 reviewed active target IDs, an8192-byte statement and500-byte reason. Complete conflict-set CAS, immutable replay receipt and evidence/audit share one transaction;409 must never be automatically rebased.
|
|
402
|
+
* Calls `POST /api/v1/memory-subjects/{id}/corrections` through the shared IDP-aware Faiber client.
|
|
403
|
+
* @param id Backend path identifier `id`.
|
|
404
|
+
* @param data Typed JSON request body.
|
|
405
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
406
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
407
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:write AND current authenticated subject owner; active permitted long memory policy.
|
|
408
|
+
*/
|
|
409
|
+
platformCorrectMemoryPost(id: Identifier, data: T.PlatformCorrectMemoryPostInput, options?: RequestOptions<T.PlatformCorrectMemoryPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").MemoryCorrectionResponse, import("./types.js").MemoryCorrectionInput, {}, any>>;
|
|
410
|
+
/**
|
|
411
|
+
* Read1–200 atomic records with allowlisted type/lifecycle filters and deterministic pages. Expired/forgotten content is redacted. Text, JSON fact values and provenance references are bounded; no embedding/raw metadata payload is exposed.
|
|
412
|
+
* Calls `GET /api/v1/memory-subjects/{id}/memories` through the shared IDP-aware Faiber client.
|
|
413
|
+
* @param id Backend path identifier `id`.
|
|
414
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
415
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
416
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
417
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:read; current organization/subject predicates on every read.
|
|
418
|
+
*/
|
|
419
|
+
platformListMemoriesGet(id: Identifier, params?: T.PlatformListMemoriesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MemoryRecordListResponse, unknown, {}, any>>;
|
|
420
|
+
/**
|
|
421
|
+
* Set nullable personal overrides using a captured revision. Null/missing values reset under PUT semantics. Policy/override/epoch change makes the revision stale;409 commits no state or audit. Response is a safe current subject projection. Assistant disabled lanes are hard ceilings even when the legacy widening flag is true.
|
|
383
422
|
* Calls `PUT /api/v1/memory-subjects/{id}/policy` through the shared IDP-aware Faiber client.
|
|
384
423
|
* @param id Backend path identifier `id`.
|
|
385
424
|
* @param data Typed JSON request body.
|
|
386
425
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
387
|
-
* @returns The complete Axios response, including the typed
|
|
388
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
426
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
427
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: current authenticated subject owner OR scoped knowledge:memory:write; captured expected_revision and current policy rules.
|
|
389
428
|
*/
|
|
390
|
-
platformSetMemoryOverridePut(id: Identifier, data: T.PlatformSetMemoryOverridePutInput, options?: RequestOptions<T.PlatformSetMemoryOverridePutInput>): Promise<import("axios").AxiosResponse<
|
|
429
|
+
platformSetMemoryOverridePut(id: Identifier, data: T.PlatformSetMemoryOverridePutInput, options?: RequestOptions<T.PlatformSetMemoryOverridePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").MemorySubjectResponse, import("./types.js").MemoryOverrideInput, {}, any>>;
|
|
391
430
|
/**
|
|
392
|
-
*
|
|
431
|
+
* Forget one authorized retained memory row atomically with counters/audit. This does not certify source-family tombstones or erasure of associated conversation projections.
|
|
393
432
|
* Calls `DELETE /api/v1/memory-subjects/{subject_id}/memories/{memory_id}` through the shared IDP-aware Faiber client.
|
|
394
433
|
* @param subjectId Backend path identifier `subject_id`.
|
|
395
434
|
* @param memoryId Backend path identifier `memory_id`.
|
|
396
435
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
397
436
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
398
|
-
* @returns The complete Axios response, including the typed
|
|
399
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
437
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
438
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: current authenticated subject owner OR scoped knowledge:memory:delete.
|
|
439
|
+
*/
|
|
440
|
+
platformForgetMemoryDelete(subjectId: Identifier, memoryId: Identifier, params?: T.PlatformForgetMemoryDeleteQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<void, unknown, {}, any>>;
|
|
441
|
+
/**
|
|
442
|
+
* Read one memory using organization AND subject AND memory predicates. Forgotten/expired record text, fact values, confidence and evidence are redacted, including a forgotten parent subject.
|
|
443
|
+
* Calls `GET /api/v1/memory-subjects/{subject_id}/memories/{memory_id}` through the shared IDP-aware Faiber client.
|
|
444
|
+
* @param subjectId Backend path identifier `subject_id`.
|
|
445
|
+
* @param memoryId Backend path identifier `memory_id`.
|
|
446
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
447
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
448
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:memory:read; current organization/subject predicates on every read.
|
|
400
449
|
*/
|
|
401
|
-
|
|
450
|
+
platformMemoryRecordGet(subjectId: Identifier, memoryId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").MemoryRecordResponse, unknown, {}, any>>;
|
|
402
451
|
/**
|
|
403
|
-
*
|
|
452
|
+
* Remove only current-organization assistant policy cache entries and return their count after audit.
|
|
404
453
|
* Calls `POST /api/v1/platform/cache/invalidate` through the shared IDP-aware Faiber client.
|
|
405
454
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
406
|
-
* @returns The complete Axios response, including the typed
|
|
455
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
407
456
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
408
457
|
*/
|
|
409
|
-
platformInvalidatePolicyCachePost(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
458
|
+
platformInvalidatePolicyCachePost(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CacheInvalidationResponse, unknown, {}, any>>;
|
|
410
459
|
/**
|
|
411
|
-
*
|
|
460
|
+
* Read scoped base/recommender summaries and full assistant policies with enabled binding IDs. This is an inventory, not an authorization grant.
|
|
412
461
|
* Calls `GET /api/v1/platform/catalog` through the shared IDP-aware Faiber client.
|
|
413
462
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
414
|
-
* @returns The complete Axios response, including the typed
|
|
463
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
415
464
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
416
465
|
*/
|
|
417
|
-
platformCatalogGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
466
|
+
platformCatalogGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeCatalogResponse, unknown, {}, any>>;
|
|
418
467
|
/**
|
|
419
|
-
*
|
|
468
|
+
* List converter registry capabilities, configuration requirements and reported health. Registry availability does not certify that a worker executed a job.
|
|
420
469
|
* Calls `GET /api/v1/platform/converters` through the shared IDP-aware Faiber client.
|
|
421
470
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
422
|
-
* @returns The complete Axios response, including the typed
|
|
471
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
423
472
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
424
473
|
*/
|
|
425
|
-
platformConvertersGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
474
|
+
platformConvertersGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").ConverterListResponse, unknown, {}, any>>;
|
|
426
475
|
/**
|
|
427
|
-
*
|
|
476
|
+
* Read scoped inventories and last-24-hour retrieval aggregates. Metrics are null without traces; ready is not proof of every external dependency.
|
|
428
477
|
* Calls `GET /api/v1/platform/status` through the shared IDP-aware Faiber client.
|
|
429
478
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
430
|
-
* @returns The complete Axios response, including the typed
|
|
479
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
431
480
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
432
481
|
*/
|
|
433
|
-
platformStatusGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
482
|
+
platformStatusGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").PlatformStatusResponse, unknown, {}, any>>;
|
|
434
483
|
/**
|
|
435
|
-
*
|
|
484
|
+
* List up to 500 current-organization processing job rows by latest update; counters and queued status do not certify execution.
|
|
436
485
|
* Calls `GET /api/v1/processing-jobs` through the shared IDP-aware Faiber client.
|
|
437
486
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
438
|
-
* @returns The complete Axios response, including the typed
|
|
487
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
439
488
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
440
489
|
*/
|
|
441
|
-
platformProcessingJobsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
490
|
+
platformProcessingJobsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").ProcessingJobListResponse, unknown, {}, any>>;
|
|
442
491
|
/**
|
|
443
|
-
*
|
|
492
|
+
* Request cancellation of a scoped job. Queued/retry jobs become cancelled immediately; processing work retains status until worker acknowledgement.
|
|
444
493
|
* Calls `POST /api/v1/processing-jobs/{id}/cancel` through the shared IDP-aware Faiber client.
|
|
445
494
|
* @param id Backend path identifier `id`.
|
|
446
495
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
447
|
-
* @returns The complete Axios response, including the typed
|
|
496
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
448
497
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
449
498
|
*/
|
|
450
|
-
platformCancelProcessingJobPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
499
|
+
platformCancelProcessingJobPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").ProcessingJobResponse, unknown, {}, any>>;
|
|
451
500
|
/**
|
|
452
|
-
*
|
|
501
|
+
* Requeue a failed, dead-letter, retry or cancelled job with a new attempt lifecycle after scoped locks and duplicate-work checks. Ineligible jobs conflict.
|
|
453
502
|
* Calls `POST /api/v1/processing-jobs/{id}/retry` through the shared IDP-aware Faiber client.
|
|
454
503
|
* @param id Backend path identifier `id`.
|
|
455
504
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
456
|
-
* @returns The complete Axios response, including the typed
|
|
505
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
457
506
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
458
507
|
*/
|
|
459
|
-
platformRetryProcessingJobPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
508
|
+
platformRetryProcessingJobPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").ProcessingJobResponse, unknown, {}, any>>;
|
|
460
509
|
/**
|
|
461
|
-
*
|
|
510
|
+
* List scoped recommender groups with their items ordered by sort order; this is an unpaginated nested inventory.
|
|
462
511
|
* Calls `GET /api/v1/recommender-groups` through the shared IDP-aware Faiber client.
|
|
463
512
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
464
|
-
* @returns The complete Axios response, including the typed
|
|
513
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
465
514
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
466
515
|
*/
|
|
467
|
-
platformListRecommendersGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
516
|
+
platformListRecommendersGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").RecommenderGroupListResponse, unknown, {}, any>>;
|
|
468
517
|
/**
|
|
469
|
-
*
|
|
518
|
+
* Create a current-organization recommender group with max_results clamped to 1–50; returns 201.
|
|
470
519
|
* Calls `POST /api/v1/recommender-groups` through the shared IDP-aware Faiber client.
|
|
471
520
|
* @param data Typed JSON request body.
|
|
472
521
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
473
|
-
* @returns The complete Axios response, including the typed
|
|
522
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
474
523
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
475
524
|
*/
|
|
476
|
-
platformCreateRecommenderGroupPost(data: T.PlatformCreateRecommenderGroupPostInput, options?: RequestOptions<T.PlatformCreateRecommenderGroupPostInput>): Promise<import("axios").AxiosResponse<
|
|
525
|
+
platformCreateRecommenderGroupPost(data: T.PlatformCreateRecommenderGroupPostInput, options?: RequestOptions<T.PlatformCreateRecommenderGroupPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").RecommenderGroupResponse, T.PlatformCreateRecommenderGroupPostInput, {}, any>>;
|
|
477
526
|
/**
|
|
478
|
-
*
|
|
527
|
+
* Create an item only inside a current-organization recommender group; missing or foreign groups return 404 and success returns 201.
|
|
479
528
|
* Calls `POST /api/v1/recommender-groups/{id}/items` through the shared IDP-aware Faiber client.
|
|
480
529
|
* @param id Backend path identifier `id`.
|
|
481
530
|
* @param data Typed JSON request body.
|
|
482
531
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
483
|
-
* @returns The complete Axios response, including the typed
|
|
532
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
484
533
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
485
534
|
*/
|
|
486
|
-
platformCreateRecommenderItemPost(id: Identifier, data: T.PlatformCreateRecommenderItemPostInput, options?: RequestOptions<T.PlatformCreateRecommenderItemPostInput>): Promise<import("axios").AxiosResponse<
|
|
535
|
+
platformCreateRecommenderItemPost(id: Identifier, data: T.PlatformCreateRecommenderItemPostInput, options?: RequestOptions<T.PlatformCreateRecommenderItemPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").RecommenderItemResponse, T.PlatformCreateRecommenderItemPostInput, {}, any>>;
|
|
487
536
|
/**
|
|
488
|
-
*
|
|
537
|
+
* Read authoritative applied/cancelled operation outcome after waiting for concurrent configuration writers. Absence is404, never inferred success.
|
|
538
|
+
* Calls `GET /api/v1/runtime/assistants/{assistant_id}/configuration-operations/{operation_id}` through the shared IDP-aware Faiber client.
|
|
539
|
+
* @param assistantId Backend path identifier `assistant_id`.
|
|
540
|
+
* @param operationId Backend path identifier `operation_id`.
|
|
541
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
542
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
543
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write; current tenant and assistant.
|
|
544
|
+
*/
|
|
545
|
+
platformAssistantConfigurationOperationGet(assistantId: Identifier, operationId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").AssistantConfigurationOperationResponse, unknown, {}, any>>;
|
|
546
|
+
/**
|
|
547
|
+
* Write an immutable cancellation tombstone with a bounded reason before releasing a pending Chat fence. Delayed original delivery conflicts. Applied configurations require recovery and cannot be cancelled as absent.
|
|
548
|
+
* Calls `POST /api/v1/runtime/assistants/{assistant_id}/configuration-operations/{operation_id}` through the shared IDP-aware Faiber client.
|
|
549
|
+
* @param assistantId Backend path identifier `assistant_id`.
|
|
550
|
+
* @param operationId Backend path identifier `operation_id`.
|
|
551
|
+
* @param data Typed JSON request body.
|
|
552
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
553
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
554
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write; current authorized administration.
|
|
555
|
+
*/
|
|
556
|
+
platformCancelAssistantConfigurationOperationPost(assistantId: Identifier, operationId: Identifier, data: T.PlatformCancelAssistantConfigurationOperationPostInput, options?: RequestOptions<T.PlatformCancelAssistantConfigurationOperationPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").AssistantConfigurationOperationResponse, import("./types.js").AssistantConfigurationCancellation, {}, any>>;
|
|
557
|
+
/**
|
|
558
|
+
* Capture the current assistant policy revision at edit time. Zero denotes absent policy. Never fetch a fresh revision to rebase a stale submission.
|
|
559
|
+
* Calls `GET /api/v1/runtime/assistants/{assistant_id}/configure` through the shared IDP-aware Faiber client.
|
|
560
|
+
* @param assistantId Backend path identifier `assistant_id`.
|
|
561
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
562
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
563
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write; current tenant.
|
|
564
|
+
*/
|
|
565
|
+
platformAssistantConfigurationSnapshotGet(assistantId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").AssistantPolicySnapshotResponse, unknown, {}, any>>;
|
|
566
|
+
/**
|
|
567
|
+
* Apply a non-nil configuration UUID with the captured policy revision. Policy, history, bindings, epochs, audit and exact operation outcome share one transaction. Identical original-actor replay returns the immutable result without duplicate epoch changes; cancelled or changed requests conflict.
|
|
489
568
|
* Calls `PUT /api/v1/runtime/assistants/{assistant_id}/configure` through the shared IDP-aware Faiber client.
|
|
490
569
|
* @param assistantId Backend path identifier `assistant_id`.
|
|
491
570
|
* @param data Typed JSON request body.
|
|
492
571
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
493
|
-
* @returns The complete Axios response, including the typed
|
|
494
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
572
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
573
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write; current tenant and immutable operation actor.
|
|
495
574
|
*/
|
|
496
|
-
platformConfigureAssistantPut(assistantId: Identifier, data: T.PlatformConfigureAssistantPutInput, options?: RequestOptions<T.PlatformConfigureAssistantPutInput>): Promise<import("axios").AxiosResponse<
|
|
575
|
+
platformConfigureAssistantPut(assistantId: Identifier, data: T.PlatformConfigureAssistantPutInput, options?: RequestOptions<T.PlatformConfigureAssistantPutInput>): Promise<import("axios").AxiosResponse<import("./types.js").AssistantConfigurationResponse, import("./types.js").AssistantConfigurationInput, {}, any>>;
|
|
497
576
|
/**
|
|
498
|
-
*
|
|
577
|
+
* Load complete assistant contract records from enabled bindings and immutable releases. Shared dependencies are pinned; absent/incomplete/ambiguous contracts fail.
|
|
499
578
|
* Calls `GET /api/v1/runtime/assistants/{assistant_id}/contracts/{slug}` through the shared IDP-aware Faiber client.
|
|
500
579
|
* @param assistantId Backend path identifier `assistant_id`.
|
|
501
580
|
* @param slug Backend path identifier `slug`.
|
|
502
581
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
503
|
-
* @returns The complete Axios response, including the typed
|
|
582
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
504
583
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
505
584
|
*/
|
|
506
|
-
routesGetGet(assistantId: Identifier, slug: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
585
|
+
routesGetGet(assistantId: Identifier, slug: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").AssistantContractsResponse, unknown, {}, any>>;
|
|
507
586
|
/**
|
|
508
|
-
*
|
|
587
|
+
* Run the canonical assistant retrieval pipeline with evaluation surface metadata under the same governance.
|
|
509
588
|
* Calls `POST /api/v1/runtime/assistants/{assistant_id}/evaluations` through the shared IDP-aware Faiber client.
|
|
510
589
|
* @param assistantId Backend path identifier `assistant_id`.
|
|
511
590
|
* @param data Typed JSON request body.
|
|
512
591
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
513
|
-
* @returns The complete Axios response, including the typed
|
|
592
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
514
593
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
515
594
|
*/
|
|
516
|
-
platformEvaluateAssistantPost(assistantId: Identifier, data: T.PlatformEvaluateAssistantPostInput, options?: RequestOptions<T.PlatformEvaluateAssistantPostInput>): Promise<import("axios").AxiosResponse<
|
|
595
|
+
platformEvaluateAssistantPost(assistantId: Identifier, data: T.PlatformEvaluateAssistantPostInput, options?: RequestOptions<T.PlatformEvaluateAssistantPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").AssistantRuntimeResponse, T.PlatformEvaluateAssistantPostInput, {}, any>>;
|
|
517
596
|
/**
|
|
518
|
-
*
|
|
597
|
+
* Admit an idempotent assistant turn into the memory outbox under current policy and scope epochs. HTTP 202 can return queued:false; it does not certify extraction.
|
|
519
598
|
* Calls `POST /api/v1/runtime/assistants/{assistant_id}/memory/turn` through the shared IDP-aware Faiber client.
|
|
520
599
|
* @param assistantId Backend path identifier `assistant_id`.
|
|
521
600
|
* @param data Typed JSON request body.
|
|
522
601
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
523
|
-
* @returns The complete Axios response, including the typed
|
|
602
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
524
603
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
525
604
|
*/
|
|
526
|
-
platformRecordTurnPost(assistantId: Identifier, data: T.PlatformRecordTurnPostInput, options?: RequestOptions<T.PlatformRecordTurnPostInput>): Promise<import("axios").AxiosResponse<
|
|
605
|
+
platformRecordTurnPost(assistantId: Identifier, data: T.PlatformRecordTurnPostInput, options?: RequestOptions<T.PlatformRecordTurnPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").MemoryTurnResponse, T.PlatformRecordTurnPostInput, {}, any>>;
|
|
527
606
|
/**
|
|
528
|
-
*
|
|
607
|
+
* Run the canonical assistant retrieval pipeline with preview surface metadata under the same governance.
|
|
529
608
|
* Calls `POST /api/v1/runtime/assistants/{assistant_id}/preview` through the shared IDP-aware Faiber client.
|
|
530
609
|
* @param assistantId Backend path identifier `assistant_id`.
|
|
531
610
|
* @param data Typed JSON request body.
|
|
532
611
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
533
|
-
* @returns The complete Axios response, including the typed
|
|
612
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
534
613
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
535
614
|
*/
|
|
536
|
-
platformPreviewAssistantPost(assistantId: Identifier, data: T.PlatformPreviewAssistantPostInput, options?: RequestOptions<T.PlatformPreviewAssistantPostInput>): Promise<import("axios").AxiosResponse<
|
|
615
|
+
platformPreviewAssistantPost(assistantId: Identifier, data: T.PlatformPreviewAssistantPostInput, options?: RequestOptions<T.PlatformPreviewAssistantPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").AssistantRuntimeResponse, T.PlatformPreviewAssistantPostInput, {}, any>>;
|
|
537
616
|
/**
|
|
538
|
-
*
|
|
617
|
+
* Run governed assistant retrieval with policy ceilings, scoped provider evidence and context delivery tracking. A missing policy returns explicit empty context.
|
|
539
618
|
* Calls `POST /api/v1/runtime/assistants/{assistant_id}/query` through the shared IDP-aware Faiber client.
|
|
540
619
|
* @param assistantId Backend path identifier `assistant_id`.
|
|
541
620
|
* @param data Typed JSON request body.
|
|
542
621
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
543
|
-
* @returns The complete Axios response, including the typed
|
|
622
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
544
623
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
545
624
|
*/
|
|
546
|
-
platformQueryAssistantPost(assistantId: Identifier, data: T.PlatformQueryAssistantPostInput, options?: RequestOptions<T.PlatformQueryAssistantPostInput>): Promise<import("axios").AxiosResponse<
|
|
625
|
+
platformQueryAssistantPost(assistantId: Identifier, data: T.PlatformQueryAssistantPostInput, options?: RequestOptions<T.PlatformQueryAssistantPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").AssistantRuntimeResponse, T.PlatformQueryAssistantPostInput, {}, any>>;
|
|
547
626
|
/**
|
|
548
|
-
*
|
|
627
|
+
* Resolve a chat binding through immutable published knowledge and evaluate profile rules. Binding scope, levels, conditions and context budgets apply.
|
|
549
628
|
* Calls `POST /api/v1/runtime/chat/{chat_slug}/query` through the shared IDP-aware Faiber client.
|
|
550
629
|
* @param chatSlug Backend path identifier `chat_slug`.
|
|
551
630
|
* @param data Typed JSON request body.
|
|
552
631
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
553
|
-
* @returns The complete Axios response, including the typed
|
|
632
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
554
633
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
555
634
|
*/
|
|
556
|
-
routesRuntimeQueryPost(chatSlug: Identifier, data: T.RoutesRuntimeQueryPostInput, options?: RequestOptions<T.RoutesRuntimeQueryPostInput>): Promise<import("axios").AxiosResponse<T.RoutesRuntimeQueryPostResponse, T.RoutesRuntimeQueryPostInput, {}>>;
|
|
635
|
+
routesRuntimeQueryPost(chatSlug: Identifier, data: T.RoutesRuntimeQueryPostInput, options?: RequestOptions<T.RoutesRuntimeQueryPostInput>): Promise<import("axios").AxiosResponse<T.RoutesRuntimeQueryPostResponse, T.RoutesRuntimeQueryPostInput, {}, any>>;
|
|
557
636
|
/**
|
|
558
|
-
*
|
|
637
|
+
* Read complete indexed nondeleted document evidence in the current organization; missing or unindexed documents return 404.
|
|
559
638
|
* Calls `GET /api/v1/runtime/evidence/documents/{id}` through the shared IDP-aware Faiber client.
|
|
560
639
|
* @param id Backend path identifier `id`.
|
|
561
640
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
562
|
-
* @returns The complete Axios response, including the typed
|
|
641
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
563
642
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
564
643
|
*/
|
|
565
|
-
platformDocumentEvidenceGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
644
|
+
platformDocumentEvidenceGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").DocumentEvidenceResponse, unknown, {}, any>>;
|
|
566
645
|
/**
|
|
567
|
-
*
|
|
646
|
+
* Read active session evidence for the authenticated owner or participant. A current user is required even with session:read:all; inaccessible evidence returns 404.
|
|
568
647
|
* Calls `GET /api/v1/runtime/evidence/session/{id}` through the shared IDP-aware Faiber client.
|
|
569
648
|
* @param id Backend path identifier `id`.
|
|
570
649
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
571
|
-
* @returns The complete Axios response, including the typed
|
|
650
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
572
651
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
573
652
|
*/
|
|
574
|
-
platformSessionEvidenceGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
653
|
+
platformSessionEvidenceGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").SessionEvidenceResponse, unknown, {}, any>>;
|
|
575
654
|
/**
|
|
576
|
-
*
|
|
655
|
+
* Execute JSON-RPC initialize, tools/list or tools/call through the governed pipeline. JSON-RPC errors may use HTTP 200; inspect result/error before claiming success.
|
|
577
656
|
* Calls `POST /api/v1/runtime/mcp` through the shared IDP-aware Faiber client.
|
|
578
657
|
* @param data Typed JSON request body.
|
|
579
658
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
580
|
-
* @returns The complete Axios response, including the typed
|
|
659
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
581
660
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
582
661
|
*/
|
|
583
|
-
platformMcpPost(data: T.PlatformMcpPostInput, options?: RequestOptions<T.PlatformMcpPostInput>): Promise<import("axios").AxiosResponse<import("
|
|
662
|
+
platformMcpPost(data: T.PlatformMcpPostInput, options?: RequestOptions<T.PlatformMcpPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeMcpResponse, T.PlatformMcpPostInput, {}, any>>;
|
|
584
663
|
/**
|
|
585
|
-
*
|
|
664
|
+
* Attach nonnegative provider token usage and nullable cost to a scoped retrieval trace. Missing or foreign trace IDs return 404.
|
|
586
665
|
* Calls `POST /api/v1/runtime/retrieval-traces/{id}/usage` through the shared IDP-aware Faiber client.
|
|
587
666
|
* @param id Backend path identifier `id`.
|
|
588
667
|
* @param data Typed JSON request body.
|
|
589
668
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
590
|
-
* @returns The complete Axios response, including the typed
|
|
669
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
591
670
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:runtime.
|
|
592
671
|
*/
|
|
593
|
-
platformRecordRetrievalUsagePost(id: Identifier, data: T.PlatformRecordRetrievalUsagePostInput, options?: RequestOptions<T.PlatformRecordRetrievalUsagePostInput>): Promise<import("axios").AxiosResponse<
|
|
672
|
+
platformRecordRetrievalUsagePost(id: Identifier, data: T.PlatformRecordRetrievalUsagePostInput, options?: RequestOptions<T.PlatformRecordRetrievalUsagePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").RetrievalUsageResponse, T.PlatformRecordRetrievalUsagePostInput, {}, any>>;
|
|
594
673
|
/**
|
|
595
|
-
*
|
|
674
|
+
* Read the query_knowledge JSON Schema. This descriptive route has no handler permission guard; transport still uses the configured shared client.
|
|
596
675
|
* Calls `GET /api/v1/runtime/tool-schema` through the shared IDP-aware Faiber client.
|
|
597
676
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
598
|
-
* @returns The complete Axios response, including the typed
|
|
677
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
599
678
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
600
679
|
*/
|
|
601
|
-
routesToolSchemaGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
680
|
+
routesToolSchemaGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeToolSchemaResponse, unknown, {}, any>>;
|
|
602
681
|
/**
|
|
603
|
-
*
|
|
682
|
+
* List current-organization governed sources by latest update, including source version and configuration.
|
|
604
683
|
* Calls `GET /api/v1/sources` through the shared IDP-aware Faiber client.
|
|
605
684
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
606
|
-
* @returns The complete Axios response, including the typed
|
|
685
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
607
686
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:read.
|
|
608
687
|
*/
|
|
609
|
-
platformListSourcesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
688
|
+
platformListSourcesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeSourceListResponse, unknown, {}, any>>;
|
|
610
689
|
/**
|
|
611
|
-
*
|
|
690
|
+
* Create a source under a locked owned base. Validate source kind, slug and secret references; returns 201 without executing synchronization.
|
|
612
691
|
* Calls `POST /api/v1/sources` through the shared IDP-aware Faiber client.
|
|
613
692
|
* @param data Typed JSON request body.
|
|
614
693
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
615
|
-
* @returns The complete Axios response, including the typed
|
|
694
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
616
695
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
617
696
|
*/
|
|
618
|
-
platformCreateSourcePost(data: T.PlatformCreateSourcePostInput, options?: RequestOptions<T.PlatformCreateSourcePostInput>): Promise<import("axios").AxiosResponse<
|
|
697
|
+
platformCreateSourcePost(data: T.PlatformCreateSourcePostInput, options?: RequestOptions<T.PlatformCreateSourcePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeSourceResponse, import("./types.js").CreateKnowledgeSourceInput, {}, any>>;
|
|
619
698
|
/**
|
|
620
|
-
*
|
|
699
|
+
* Set active/paused desired source state under the captured expected_version. Stale intent conflicts; already-desired state is unchanged.
|
|
621
700
|
* Calls `POST /api/v1/sources/{id}/pause` through the shared IDP-aware Faiber client.
|
|
622
701
|
* @param id Backend path identifier `id`.
|
|
702
|
+
* @param data Typed JSON request body.
|
|
623
703
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
624
|
-
* @returns The complete Axios response, including the typed
|
|
704
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
625
705
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
626
706
|
*/
|
|
627
|
-
platformPauseSourcePost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
707
|
+
platformPauseSourcePost(id: Identifier, data: T.PlatformPauseSourcePostInput, options?: RequestOptions<T.PlatformPauseSourcePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeSourceResponse, import("./types.js").SourceStateInput, {}, any>>;
|
|
628
708
|
/**
|
|
629
|
-
*
|
|
709
|
+
* Persist or reuse a scoped source-sync job and return 202 with its real job ID. This receipt does not certify an available executor.
|
|
630
710
|
* Calls `POST /api/v1/sources/{id}/sync` through the shared IDP-aware Faiber client.
|
|
631
711
|
* @param id Backend path identifier `id`.
|
|
632
712
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
633
|
-
* @returns The complete Axios response, including the typed
|
|
713
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
634
714
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: knowledge:write.
|
|
635
715
|
*/
|
|
636
|
-
platformSyncSourcePost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
716
|
+
platformSyncSourcePost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeQueuedJobResponse, unknown, {}, any>>;
|
|
637
717
|
/**
|
|
638
|
-
*
|
|
718
|
+
* Read database readiness with commit/version. HTTP 503 returns the same success envelope with degraded status; Axios rejects by default.
|
|
639
719
|
* Calls `GET /health` through the shared IDP-aware Faiber client.
|
|
640
720
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
641
|
-
* @returns The complete Axios response, including the typed
|
|
721
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
642
722
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
643
723
|
*/
|
|
644
|
-
mainReadinessGetHealth(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
724
|
+
mainReadinessGetHealth(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeReadinessResponse, unknown, {}, any>>;
|
|
645
725
|
/**
|
|
646
|
-
*
|
|
726
|
+
* Read process liveness and package version. This does not check database or worker readiness.
|
|
647
727
|
* Calls `GET /health/live` through the shared IDP-aware Faiber client.
|
|
648
728
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
649
|
-
* @returns The complete Axios response, including the typed
|
|
729
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
650
730
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
651
731
|
*/
|
|
652
|
-
mainLivenessGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<T.MainLivenessGetResponse, unknown, {}>>;
|
|
732
|
+
mainLivenessGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<T.MainLivenessGetResponse, unknown, {}, any>>;
|
|
653
733
|
/**
|
|
654
|
-
*
|
|
734
|
+
* Read database readiness with commit/version. HTTP 503 returns the same success envelope with degraded status; Axios rejects by default.
|
|
655
735
|
* Calls `GET /health/ready` through the shared IDP-aware Faiber client.
|
|
656
736
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
657
|
-
* @returns The complete Axios response, including the typed
|
|
737
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
658
738
|
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
659
739
|
*/
|
|
660
|
-
mainReadinessGetHealthReady(options?: RequestOptions): Promise<import("axios").AxiosResponse<
|
|
740
|
+
mainReadinessGetHealthReady(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeReadinessResponse, unknown, {}, any>>;
|
|
661
741
|
/**
|
|
662
|
-
*
|
|
742
|
+
* Convert a 1–25,000,000-byte source using trusted Task authority and x-organization-id. The body is binary, not JSON or multipart.
|
|
663
743
|
* Calls `POST /internal/task-conversions` through the shared IDP-aware Faiber client.
|
|
664
744
|
* @param data Typed binary byte stream.
|
|
665
745
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
666
|
-
* @returns The complete Axios response, including the typed
|
|
667
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted
|
|
746
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
747
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted Task authority token in x-task-projection-token plus x-organization-id; server only.
|
|
668
748
|
*/
|
|
669
|
-
mainConvertPost(data: T.MainConvertPostInput, options?: RequestOptions<T.MainConvertPostInput>): Promise<import("axios").AxiosResponse<T.MainConvertPostResponse, T.MainConvertPostInput, {}>>;
|
|
749
|
+
mainConvertPost(data: T.MainConvertPostInput, options?: RequestOptions<T.MainConvertPostInput>): Promise<import("axios").AxiosResponse<T.MainConvertPostResponse, T.MainConvertPostInput, {}, any>>;
|
|
670
750
|
/**
|
|
671
|
-
*
|
|
751
|
+
* Find at most 100 projected Task note identities within 1–10 allowed project IDs and a query of at most 2000 characters. Requires trusted Task authority.
|
|
672
752
|
* Calls `POST /internal/task-projections/candidates` through the shared IDP-aware Faiber client.
|
|
673
753
|
* @param data Typed JSON request body.
|
|
674
754
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
675
|
-
* @returns The complete Axios response, including the typed
|
|
676
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted
|
|
755
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
756
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted Task authority token in x-task-projection-token plus x-organization-id; server only.
|
|
677
757
|
*/
|
|
678
|
-
taskProjectionsCandidatesPost(data: T.TaskProjectionsCandidatesPostInput, options?: RequestOptions<T.TaskProjectionsCandidatesPostInput>): Promise<import("axios").AxiosResponse<
|
|
758
|
+
taskProjectionsCandidatesPost(data: T.TaskProjectionsCandidatesPostInput, options?: RequestOptions<T.TaskProjectionsCandidatesPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").TaskProjectionCandidateListResponse, T.TaskProjectionsCandidatesPostInput, {}, any>>;
|
|
679
759
|
/**
|
|
680
|
-
*
|
|
760
|
+
* Retrieve passages for an authorized note/version manifest with at most 100 sources. Requires trusted Task authority; stale/deleted versions are excluded.
|
|
681
761
|
* Calls `POST /internal/task-projections/passages` through the shared IDP-aware Faiber client.
|
|
682
762
|
* @param data Typed JSON request body.
|
|
683
763
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
684
|
-
* @returns The complete Axios response, including the typed
|
|
685
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted
|
|
764
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
765
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted Task authority token in x-task-projection-token plus x-organization-id; server only.
|
|
686
766
|
*/
|
|
687
|
-
taskProjectionsPassagesPost(data: T.TaskProjectionsPassagesPostInput, options?: RequestOptions<T.TaskProjectionsPassagesPostInput>): Promise<import("axios").AxiosResponse<
|
|
767
|
+
taskProjectionsPassagesPost(data: T.TaskProjectionsPassagesPostInput, options?: RequestOptions<T.TaskProjectionsPassagesPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").KnowledgeRetrievalResponse, T.TaskProjectionsPassagesPostInput, {}, any>>;
|
|
688
768
|
/**
|
|
689
|
-
*
|
|
769
|
+
* Upsert a projected Task note under trusted Task authority. Lower or conflicting same versions return 409; exact replays are idempotent.
|
|
690
770
|
* Calls `POST /internal/task-projections/sync` through the shared IDP-aware Faiber client.
|
|
691
771
|
* @param data Typed JSON request body.
|
|
692
772
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
693
|
-
* @returns The complete Axios response, including the typed
|
|
694
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted
|
|
773
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
774
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted Task authority token in x-task-projection-token plus x-organization-id; server only.
|
|
695
775
|
*/
|
|
696
|
-
taskProjectionsSyncPost(data: T.TaskProjectionsSyncPostInput, options?: RequestOptions<T.TaskProjectionsSyncPostInput>): Promise<import("axios").AxiosResponse<
|
|
776
|
+
taskProjectionsSyncPost(data: T.TaskProjectionsSyncPostInput, options?: RequestOptions<T.TaskProjectionsSyncPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").TaskProjectionResponse, T.TaskProjectionsSyncPostInput, {}, any>>;
|
|
697
777
|
}
|
|
698
778
|
//# sourceMappingURL=operations.d.ts.map
|