@unofficialbox/box-open-sdk 0.4.0 → 0.4.2
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 +1 -1
- package/dist/cjs/models/schemas/ai.js +3 -0
- package/dist/cjs/models/schemas/ai_studio.js +3 -0
- package/dist/cjs/models/schemas/app_item_associations.js +3 -0
- package/dist/cjs/models/schemas/archives.js +3 -0
- package/dist/cjs/models/schemas/authorization.js +3 -0
- package/dist/cjs/models/schemas/automate_workflows.js +3 -0
- package/dist/cjs/models/schemas/avatars.js +3 -0
- package/dist/cjs/models/schemas/chunked_uploads.js +3 -0
- package/dist/cjs/models/schemas/classifications.js +3 -0
- package/dist/cjs/models/schemas/collaboration_allowlist_entries.js +3 -0
- package/dist/cjs/models/schemas/collaboration_allowlist_exempt_targets.js +3 -0
- package/dist/cjs/models/schemas/collections.js +3 -0
- package/dist/cjs/models/schemas/comments.js +3 -0
- package/dist/cjs/models/schemas/device_pinners.js +3 -0
- package/dist/cjs/models/schemas/docgen.js +3 -0
- package/dist/cjs/models/schemas/docgen_template.js +3 -0
- package/dist/cjs/models/schemas/email_aliases.js +3 -0
- package/dist/cjs/models/schemas/enterprise_configurations.js +3 -0
- package/dist/cjs/models/schemas/events.js +3 -0
- package/dist/cjs/models/schemas/external_users.js +3 -0
- package/dist/cjs/models/schemas/file_requests.js +3 -0
- package/dist/cjs/models/schemas/file_version_legal_holds.js +3 -0
- package/dist/cjs/models/schemas/file_version_retentions.js +3 -0
- package/dist/cjs/models/schemas/file_versions.js +3 -0
- package/dist/cjs/models/schemas/files.js +3 -0
- package/dist/cjs/models/schemas/folder_locks.js +3 -0
- package/dist/cjs/models/schemas/folders.js +3 -0
- package/dist/cjs/models/schemas/groups.js +3 -0
- package/dist/cjs/models/schemas/hub_collaborations.js +3 -0
- package/dist/cjs/models/schemas/hub_document.js +3 -0
- package/dist/cjs/models/schemas/hub_items.js +3 -0
- package/dist/cjs/models/schemas/hubs.js +3 -0
- package/dist/cjs/models/schemas/integration_mappings.js +3 -0
- package/dist/cjs/models/schemas/invites.js +3 -0
- package/dist/cjs/models/schemas/legal_hold_policies.js +3 -0
- package/dist/cjs/models/schemas/legal_hold_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/list_collaborations.js +3 -0
- package/dist/cjs/models/schemas/memberships.js +3 -0
- package/dist/cjs/models/schemas/metadata_cascade_policies.js +3 -0
- package/dist/cjs/models/schemas/metadata_taxonomies.js +3 -0
- package/dist/cjs/models/schemas/metadata_templates.js +3 -0
- package/dist/cjs/models/schemas/notes.js +3 -0
- package/dist/cjs/models/schemas/query.js +3 -0
- package/dist/cjs/models/schemas/recent_items.js +3 -0
- package/dist/cjs/models/schemas/retention_policies.js +3 -0
- package/dist/cjs/models/schemas/retention_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/search.js +3 -0
- package/dist/cjs/models/schemas/session_termination.js +3 -0
- package/dist/cjs/models/schemas/shared_links_folders.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_reports.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segment_members.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segment_restrictions.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barrier_segments.js +3 -0
- package/dist/cjs/models/schemas/shield_information_barriers.js +3 -0
- package/dist/cjs/models/schemas/shield_lists.js +3 -0
- package/dist/cjs/models/schemas/sign_requests.js +3 -0
- package/dist/cjs/models/schemas/sign_templates.js +3 -0
- package/dist/cjs/models/schemas/skills.js +3 -0
- package/dist/cjs/models/schemas/storage_policies.js +3 -0
- package/dist/cjs/models/schemas/storage_policy_assignments.js +3 -0
- package/dist/cjs/models/schemas/task_assignments.js +3 -0
- package/dist/cjs/models/schemas/tasks.js +3 -0
- package/dist/cjs/models/schemas/terms_of_service_user_statuses.js +3 -0
- package/dist/cjs/models/schemas/terms_of_services.js +3 -0
- package/dist/cjs/models/schemas/transfer.js +3 -0
- package/dist/cjs/models/schemas/trashed_files.js +3 -0
- package/dist/cjs/models/schemas/trashed_folders.js +3 -0
- package/dist/cjs/models/schemas/trashed_items.js +3 -0
- package/dist/cjs/models/schemas/trashed_web_links.js +3 -0
- package/dist/cjs/models/schemas/uploads.js +3 -0
- package/dist/cjs/models/schemas/user_collaborations.js +3 -0
- package/dist/cjs/models/schemas/users.js +3 -0
- package/dist/cjs/models/schemas/web_links.js +3 -0
- package/dist/cjs/models/schemas/webhooks.js +3 -0
- package/dist/cjs/models/schemas/workflows.js +3 -0
- package/dist/cjs/models/schemas/zip_downloads.js +3 -0
- package/dist/cjs/models/schemas.js +90 -0
- package/dist/esm/models/schemas/ai.js +2 -0
- package/dist/esm/models/schemas/ai_studio.js +2 -0
- package/dist/esm/models/schemas/app_item_associations.js +2 -0
- package/dist/esm/models/schemas/archives.js +2 -0
- package/dist/esm/models/schemas/authorization.js +2 -0
- package/dist/esm/models/schemas/automate_workflows.js +2 -0
- package/dist/esm/models/schemas/avatars.js +2 -0
- package/dist/esm/models/schemas/chunked_uploads.js +2 -0
- package/dist/esm/models/schemas/classifications.js +2 -0
- package/dist/esm/models/schemas/collaboration_allowlist_entries.js +2 -0
- package/dist/esm/models/schemas/collaboration_allowlist_exempt_targets.js +2 -0
- package/dist/esm/models/schemas/collections.js +2 -0
- package/dist/esm/models/schemas/comments.js +2 -0
- package/dist/esm/models/schemas/device_pinners.js +2 -0
- package/dist/esm/models/schemas/docgen.js +2 -0
- package/dist/esm/models/schemas/docgen_template.js +2 -0
- package/dist/esm/models/schemas/email_aliases.js +2 -0
- package/dist/esm/models/schemas/enterprise_configurations.js +2 -0
- package/dist/esm/models/schemas/events.js +2 -0
- package/dist/esm/models/schemas/external_users.js +2 -0
- package/dist/esm/models/schemas/file_requests.js +2 -0
- package/dist/esm/models/schemas/file_version_legal_holds.js +2 -0
- package/dist/esm/models/schemas/file_version_retentions.js +2 -0
- package/dist/esm/models/schemas/file_versions.js +2 -0
- package/dist/esm/models/schemas/files.js +2 -0
- package/dist/esm/models/schemas/folder_locks.js +2 -0
- package/dist/esm/models/schemas/folders.js +2 -0
- package/dist/esm/models/schemas/groups.js +2 -0
- package/dist/esm/models/schemas/hub_collaborations.js +2 -0
- package/dist/esm/models/schemas/hub_document.js +2 -0
- package/dist/esm/models/schemas/hub_items.js +2 -0
- package/dist/esm/models/schemas/hubs.js +2 -0
- package/dist/esm/models/schemas/integration_mappings.js +2 -0
- package/dist/esm/models/schemas/invites.js +2 -0
- package/dist/esm/models/schemas/legal_hold_policies.js +2 -0
- package/dist/esm/models/schemas/legal_hold_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/list_collaborations.js +2 -0
- package/dist/esm/models/schemas/memberships.js +2 -0
- package/dist/esm/models/schemas/metadata_cascade_policies.js +2 -0
- package/dist/esm/models/schemas/metadata_taxonomies.js +2 -0
- package/dist/esm/models/schemas/metadata_templates.js +2 -0
- package/dist/esm/models/schemas/notes.js +2 -0
- package/dist/esm/models/schemas/query.js +2 -0
- package/dist/esm/models/schemas/recent_items.js +2 -0
- package/dist/esm/models/schemas/retention_policies.js +2 -0
- package/dist/esm/models/schemas/retention_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/search.js +2 -0
- package/dist/esm/models/schemas/session_termination.js +2 -0
- package/dist/esm/models/schemas/shared_links_folders.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_reports.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segment_members.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segment_restrictions.js +2 -0
- package/dist/esm/models/schemas/shield_information_barrier_segments.js +2 -0
- package/dist/esm/models/schemas/shield_information_barriers.js +2 -0
- package/dist/esm/models/schemas/shield_lists.js +2 -0
- package/dist/esm/models/schemas/sign_requests.js +2 -0
- package/dist/esm/models/schemas/sign_templates.js +2 -0
- package/dist/esm/models/schemas/skills.js +2 -0
- package/dist/esm/models/schemas/storage_policies.js +2 -0
- package/dist/esm/models/schemas/storage_policy_assignments.js +2 -0
- package/dist/esm/models/schemas/task_assignments.js +2 -0
- package/dist/esm/models/schemas/tasks.js +2 -0
- package/dist/esm/models/schemas/terms_of_service_user_statuses.js +2 -0
- package/dist/esm/models/schemas/terms_of_services.js +2 -0
- package/dist/esm/models/schemas/transfer.js +2 -0
- package/dist/esm/models/schemas/trashed_files.js +2 -0
- package/dist/esm/models/schemas/trashed_folders.js +2 -0
- package/dist/esm/models/schemas/trashed_items.js +2 -0
- package/dist/esm/models/schemas/trashed_web_links.js +2 -0
- package/dist/esm/models/schemas/uploads.js +2 -0
- package/dist/esm/models/schemas/user_collaborations.js +2 -0
- package/dist/esm/models/schemas/users.js +2 -0
- package/dist/esm/models/schemas/web_links.js +2 -0
- package/dist/esm/models/schemas/webhooks.js +2 -0
- package/dist/esm/models/schemas/workflows.js +2 -0
- package/dist/esm/models/schemas/zip_downloads.js +2 -0
- package/dist/esm/models/schemas.js +76 -1
- package/dist/types/managers/metadata_taxonomies.d.ts +2 -2
- package/dist/types/managers/retention_policies.d.ts +1 -1
- package/dist/types/models/schemas/ai.d.ts +240 -0
- package/dist/types/models/schemas/ai_studio.d.ts +172 -0
- package/dist/types/models/schemas/app_item_associations.d.ts +34 -0
- package/dist/types/models/schemas/archives.d.ts +27 -0
- package/dist/types/models/schemas/authorization.d.ts +43 -0
- package/dist/types/models/schemas/automate_workflows.d.ts +29 -0
- package/dist/types/models/schemas/avatars.d.ts +11 -0
- package/dist/types/models/schemas/chunked_uploads.d.ts +47 -0
- package/dist/types/models/schemas/classifications.d.ts +66 -0
- package/dist/types/models/schemas/collaboration_allowlist_entries.d.ts +21 -0
- package/dist/types/models/schemas/collaboration_allowlist_exempt_targets.d.ts +19 -0
- package/dist/types/models/schemas/collections.d.ts +15 -0
- package/dist/types/models/schemas/comments.d.ts +33 -0
- package/dist/types/models/schemas/device_pinners.d.ts +20 -0
- package/dist/types/models/schemas/docgen.d.ts +40 -0
- package/dist/types/models/schemas/docgen_template.d.ts +29 -0
- package/dist/types/models/schemas/email_aliases.d.ts +14 -0
- package/dist/types/models/schemas/enterprise_configurations.d.ts +251 -0
- package/dist/types/models/schemas/events.d.ts +71 -0
- package/dist/types/models/schemas/external_users.d.ts +16 -0
- package/dist/types/models/schemas/file_requests.d.ts +41 -0
- package/dist/types/models/schemas/file_version_legal_holds.d.ts +16 -0
- package/dist/types/models/schemas/file_version_retentions.d.ts +17 -0
- package/dist/types/models/schemas/file_versions.d.ts +32 -0
- package/dist/types/models/schemas/files.d.ts +27 -0
- package/dist/types/models/schemas/folder_locks.d.ts +27 -0
- package/dist/types/models/schemas/folders.d.ts +28 -0
- package/dist/types/models/schemas/groups.d.ts +42 -0
- package/dist/types/models/schemas/hub_collaborations.d.ts +57 -0
- package/dist/types/models/schemas/hub_document.d.ts +67 -0
- package/dist/types/models/schemas/hub_items.d.ts +46 -0
- package/dist/types/models/schemas/hubs.d.ts +43 -0
- package/dist/types/models/schemas/integration_mappings.d.ts +83 -0
- package/dist/types/models/schemas/invites.d.ts +19 -0
- package/dist/types/models/schemas/legal_hold_policies.d.ts +43 -0
- package/dist/types/models/schemas/legal_hold_policy_assignments.d.ts +43 -0
- package/dist/types/models/schemas/list_collaborations.d.ts +14 -0
- package/dist/types/models/schemas/memberships.d.ts +29 -0
- package/dist/types/models/schemas/metadata_cascade_policies.d.ts +29 -0
- package/dist/types/models/schemas/metadata_taxonomies.d.ts +60 -0
- package/dist/types/models/schemas/metadata_templates.d.ts +71 -0
- package/dist/types/models/schemas/notes.d.ts +13 -0
- package/dist/types/models/schemas/query.d.ts +62 -0
- package/dist/types/models/schemas/recent_items.d.ts +25 -0
- package/dist/types/models/schemas/retention_policies.d.ts +60 -0
- package/dist/types/models/schemas/retention_policy_assignments.d.ts +47 -0
- package/dist/types/models/schemas/search.d.ts +98 -0
- package/dist/types/models/schemas/session_termination.d.ts +10 -0
- package/dist/types/models/schemas/shared_links_folders.d.ts +11 -0
- package/dist/types/models/schemas/shield_information_barrier_reports.d.ts +27 -0
- package/dist/types/models/schemas/shield_information_barrier_segment_members.d.ts +24 -0
- package/dist/types/models/schemas/shield_information_barrier_segment_restrictions.d.ts +24 -0
- package/dist/types/models/schemas/shield_information_barrier_segments.d.ts +26 -0
- package/dist/types/models/schemas/shield_information_barriers.d.ts +31 -0
- package/dist/types/models/schemas/shield_lists.d.ts +88 -0
- package/dist/types/models/schemas/sign_requests.d.ts +136 -0
- package/dist/types/models/schemas/sign_templates.d.ts +90 -0
- package/dist/types/models/schemas/skills.d.ts +120 -0
- package/dist/types/models/schemas/storage_policies.d.ts +12 -0
- package/dist/types/models/schemas/storage_policy_assignments.d.ts +34 -0
- package/dist/types/models/schemas/task_assignments.d.ts +17 -0
- package/dist/types/models/schemas/tasks.d.ts +37 -0
- package/dist/types/models/schemas/terms_of_service_user_statuses.d.ts +27 -0
- package/dist/types/models/schemas/terms_of_services.d.ts +27 -0
- package/dist/types/models/schemas/transfer.d.ts +4 -0
- package/dist/types/models/schemas/trashed_files.d.ts +49 -0
- package/dist/types/models/schemas/trashed_folders.d.ts +47 -0
- package/dist/types/models/schemas/trashed_items.d.ts +1 -0
- package/dist/types/models/schemas/trashed_web_links.d.ts +41 -0
- package/dist/types/models/schemas/uploads.d.ts +28 -0
- package/dist/types/models/schemas/user_collaborations.d.ts +26 -0
- package/dist/types/models/schemas/users.d.ts +98 -0
- package/dist/types/models/schemas/web_links.d.ts +20 -0
- package/dist/types/models/schemas/webhooks.d.ts +37 -0
- package/dist/types/models/schemas/workflows.d.ts +93 -0
- package/dist/types/models/schemas/zip_downloads.d.ts +29 -0
- package/dist/types/models/schemas.d.ts +180 -3579
- package/docs/managers/retention_policies.md +1 -1
- package/package.json +1 -1
|
@@ -1,2 +1,77 @@
|
|
|
1
1
|
// Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
|
|
2
|
-
export
|
|
2
|
+
export * from './schemas/ai.js';
|
|
3
|
+
export * from './schemas/ai_studio.js';
|
|
4
|
+
export * from './schemas/app_item_associations.js';
|
|
5
|
+
export * from './schemas/archives.js';
|
|
6
|
+
export * from './schemas/authorization.js';
|
|
7
|
+
export * from './schemas/automate_workflows.js';
|
|
8
|
+
export * from './schemas/avatars.js';
|
|
9
|
+
export * from './schemas/chunked_uploads.js';
|
|
10
|
+
export * from './schemas/classifications.js';
|
|
11
|
+
export * from './schemas/collaboration_allowlist_entries.js';
|
|
12
|
+
export * from './schemas/collaboration_allowlist_exempt_targets.js';
|
|
13
|
+
export * from './schemas/collections.js';
|
|
14
|
+
export * from './schemas/comments.js';
|
|
15
|
+
export * from './schemas/device_pinners.js';
|
|
16
|
+
export * from './schemas/docgen.js';
|
|
17
|
+
export * from './schemas/docgen_template.js';
|
|
18
|
+
export * from './schemas/email_aliases.js';
|
|
19
|
+
export * from './schemas/enterprise_configurations.js';
|
|
20
|
+
export * from './schemas/events.js';
|
|
21
|
+
export * from './schemas/external_users.js';
|
|
22
|
+
export * from './schemas/file_requests.js';
|
|
23
|
+
export * from './schemas/file_version_legal_holds.js';
|
|
24
|
+
export * from './schemas/file_version_retentions.js';
|
|
25
|
+
export * from './schemas/file_versions.js';
|
|
26
|
+
export * from './schemas/files.js';
|
|
27
|
+
export * from './schemas/folder_locks.js';
|
|
28
|
+
export * from './schemas/folders.js';
|
|
29
|
+
export * from './schemas/groups.js';
|
|
30
|
+
export * from './schemas/hub_collaborations.js';
|
|
31
|
+
export * from './schemas/hub_document.js';
|
|
32
|
+
export * from './schemas/hub_items.js';
|
|
33
|
+
export * from './schemas/hubs.js';
|
|
34
|
+
export * from './schemas/integration_mappings.js';
|
|
35
|
+
export * from './schemas/invites.js';
|
|
36
|
+
export * from './schemas/legal_hold_policies.js';
|
|
37
|
+
export * from './schemas/legal_hold_policy_assignments.js';
|
|
38
|
+
export * from './schemas/list_collaborations.js';
|
|
39
|
+
export * from './schemas/memberships.js';
|
|
40
|
+
export * from './schemas/metadata_cascade_policies.js';
|
|
41
|
+
export * from './schemas/metadata_taxonomies.js';
|
|
42
|
+
export * from './schemas/metadata_templates.js';
|
|
43
|
+
export * from './schemas/notes.js';
|
|
44
|
+
export * from './schemas/query.js';
|
|
45
|
+
export * from './schemas/recent_items.js';
|
|
46
|
+
export * from './schemas/retention_policies.js';
|
|
47
|
+
export * from './schemas/retention_policy_assignments.js';
|
|
48
|
+
export * from './schemas/search.js';
|
|
49
|
+
export * from './schemas/session_termination.js';
|
|
50
|
+
export * from './schemas/shared_links_folders.js';
|
|
51
|
+
export * from './schemas/shield_information_barrier_reports.js';
|
|
52
|
+
export * from './schemas/shield_information_barrier_segment_members.js';
|
|
53
|
+
export * from './schemas/shield_information_barrier_segment_restrictions.js';
|
|
54
|
+
export * from './schemas/shield_information_barrier_segments.js';
|
|
55
|
+
export * from './schemas/shield_information_barriers.js';
|
|
56
|
+
export * from './schemas/shield_lists.js';
|
|
57
|
+
export * from './schemas/sign_requests.js';
|
|
58
|
+
export * from './schemas/sign_templates.js';
|
|
59
|
+
export * from './schemas/skills.js';
|
|
60
|
+
export * from './schemas/storage_policies.js';
|
|
61
|
+
export * from './schemas/storage_policy_assignments.js';
|
|
62
|
+
export * from './schemas/task_assignments.js';
|
|
63
|
+
export * from './schemas/tasks.js';
|
|
64
|
+
export * from './schemas/terms_of_service_user_statuses.js';
|
|
65
|
+
export * from './schemas/terms_of_services.js';
|
|
66
|
+
export * from './schemas/transfer.js';
|
|
67
|
+
export * from './schemas/trashed_files.js';
|
|
68
|
+
export * from './schemas/trashed_folders.js';
|
|
69
|
+
export * from './schemas/trashed_items.js';
|
|
70
|
+
export * from './schemas/trashed_web_links.js';
|
|
71
|
+
export * from './schemas/uploads.js';
|
|
72
|
+
export * from './schemas/user_collaborations.js';
|
|
73
|
+
export * from './schemas/users.js';
|
|
74
|
+
export * from './schemas/web_links.js';
|
|
75
|
+
export * from './schemas/webhooks.js';
|
|
76
|
+
export * from './schemas/workflows.js';
|
|
77
|
+
export * from './schemas/zip_downloads.js';
|
|
@@ -16,7 +16,7 @@ export interface MetadataTaxonomiesManagerListNodesOptions {
|
|
|
16
16
|
limit?: number;
|
|
17
17
|
}
|
|
18
18
|
/** Optional parameters for MetadataTaxonomiesManager.listMetadataTemplateFieldOptions. */
|
|
19
|
-
export interface
|
|
19
|
+
export interface MetadataTaxonomiesManagerListMetadataTemplateFieldOptions {
|
|
20
20
|
level?: Array<number>;
|
|
21
21
|
parent?: Array<string>;
|
|
22
22
|
ancestor?: Array<string>;
|
|
@@ -49,6 +49,6 @@ export declare class MetadataTaxonomiesManager {
|
|
|
49
49
|
deleteNode(namespace: string, taxonomyKey: string, nodeId: string): Promise<void>;
|
|
50
50
|
updateNode(namespace: string, taxonomyKey: string, nodeId: string, body: models.schemas.UpdateNodeRequest): Promise<models.schemas.MetadataTaxonomyNode>;
|
|
51
51
|
/** Iterate every `models.schemas.MetadataTaxonomyNode` across pages, threading the marker cursor. */
|
|
52
|
-
listMetadataTemplateFieldOptions(namespace: string, templateKey: string, fieldKey: string, opts?:
|
|
52
|
+
listMetadataTemplateFieldOptions(namespace: string, templateKey: string, fieldKey: string, opts?: MetadataTaxonomiesManagerListMetadataTemplateFieldOptions): AsyncIterableIterator<models.schemas.MetadataTaxonomyNode>;
|
|
53
53
|
private listMetadataTemplateFieldOptionsPage;
|
|
54
54
|
}
|
|
@@ -3,7 +3,7 @@ import type * as models from '../models/index.js';
|
|
|
3
3
|
/** Optional parameters for RetentionPoliciesManager.list. */
|
|
4
4
|
export interface RetentionPoliciesManagerListOptions {
|
|
5
5
|
policy_name?: string;
|
|
6
|
-
policy_type?: models.schemas.
|
|
6
|
+
policy_type?: models.schemas.RetentionPolicyType2;
|
|
7
7
|
created_by_user_id?: string;
|
|
8
8
|
fields?: Array<string>;
|
|
9
9
|
limit?: number;
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
import type { AiAgentAskType, AiAgentBasicGenToolEmbeddings, AiAgentExtractType, AiAgentSpreadsheetTool, AiAgentTextGenType, AiCitationType, AiLlmEndpointParams, FieldsOptions, MetadataTemplateType } from '../schemas.js';
|
|
2
|
+
export type AiAgent = (AiAgentAsk & {
|
|
3
|
+
type: "ai_agent_ask";
|
|
4
|
+
}) | (AiAgentTextGen & {
|
|
5
|
+
type: "ai_agent_text_gen";
|
|
6
|
+
}) | (AiAgentExtract & {
|
|
7
|
+
type: "ai_agent_extract";
|
|
8
|
+
}) | (AiAgentExtractStructured & {
|
|
9
|
+
type: "ai_agent_extract_structured";
|
|
10
|
+
}) | {
|
|
11
|
+
type: string;
|
|
12
|
+
[key: string]: unknown;
|
|
13
|
+
};
|
|
14
|
+
export interface AiAgentAsk {
|
|
15
|
+
type: AiAgentAskType;
|
|
16
|
+
long_text?: AiAgentLongTextTool;
|
|
17
|
+
basic_text?: AiAgentBasicTextTool;
|
|
18
|
+
spreadsheet?: AiAgentSpreadsheetTool;
|
|
19
|
+
long_text_multi?: AiAgentLongTextTool;
|
|
20
|
+
basic_text_multi?: AiAgentBasicTextTool;
|
|
21
|
+
basic_image?: AiAgentBasicTextTool;
|
|
22
|
+
basic_image_multi?: AiAgentBasicTextTool;
|
|
23
|
+
}
|
|
24
|
+
export interface AiAgentBasicGenTool {
|
|
25
|
+
model?: string;
|
|
26
|
+
num_tokens_for_completion?: number;
|
|
27
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
28
|
+
system_message?: string;
|
|
29
|
+
prompt_template?: string;
|
|
30
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
31
|
+
content_template?: string;
|
|
32
|
+
}
|
|
33
|
+
export interface AiAgentBasicTextTool {
|
|
34
|
+
model?: string;
|
|
35
|
+
num_tokens_for_completion?: number;
|
|
36
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
37
|
+
system_message?: string;
|
|
38
|
+
prompt_template?: string;
|
|
39
|
+
}
|
|
40
|
+
export interface AiAgentExtract {
|
|
41
|
+
type: AiAgentExtractType;
|
|
42
|
+
long_text?: AiAgentLongTextTool;
|
|
43
|
+
basic_text?: AiAgentBasicTextTool;
|
|
44
|
+
basic_image?: AiAgentBasicTextTool;
|
|
45
|
+
}
|
|
46
|
+
export interface AiAgentExtractStructured {
|
|
47
|
+
type: AiAgentExtractStructuredType;
|
|
48
|
+
long_text?: AiAgentLongTextTool;
|
|
49
|
+
basic_text?: AiAgentBasicTextTool;
|
|
50
|
+
basic_image?: AiAgentBasicTextTool;
|
|
51
|
+
}
|
|
52
|
+
export interface AiAgentInfo {
|
|
53
|
+
models?: Array<AiAgentInfoModels>;
|
|
54
|
+
processor?: string;
|
|
55
|
+
}
|
|
56
|
+
export interface AiAgentLongTextTool {
|
|
57
|
+
model?: string;
|
|
58
|
+
num_tokens_for_completion?: number;
|
|
59
|
+
llm_endpoint_params?: AiLlmEndpointParams;
|
|
60
|
+
system_message?: string;
|
|
61
|
+
prompt_template?: string;
|
|
62
|
+
embeddings?: AiAgentBasicGenToolEmbeddings;
|
|
63
|
+
}
|
|
64
|
+
export interface AiAgentReference {
|
|
65
|
+
type: AiAgentReferenceType;
|
|
66
|
+
id: string;
|
|
67
|
+
}
|
|
68
|
+
export interface AiAgentTextGen {
|
|
69
|
+
type: AiAgentTextGenType;
|
|
70
|
+
basic_gen?: AiAgentBasicGenTool;
|
|
71
|
+
}
|
|
72
|
+
export interface AiAsk {
|
|
73
|
+
mode: AiAskMode;
|
|
74
|
+
prompt: string;
|
|
75
|
+
items: Array<AiItemAsk>;
|
|
76
|
+
dialogue_history?: Array<AiDialogueHistory>;
|
|
77
|
+
include_citations?: boolean;
|
|
78
|
+
ai_agent?: AiAskAgent;
|
|
79
|
+
}
|
|
80
|
+
export type AiAskAgent = (AiAgentReference & {
|
|
81
|
+
type: "ai_agent_id";
|
|
82
|
+
}) | (AiAgentAsk & {
|
|
83
|
+
type: "ai_agent_ask";
|
|
84
|
+
}) | {
|
|
85
|
+
type: string;
|
|
86
|
+
[key: string]: unknown;
|
|
87
|
+
};
|
|
88
|
+
export interface AiCitation {
|
|
89
|
+
content?: string;
|
|
90
|
+
id?: string;
|
|
91
|
+
type?: AiCitationType;
|
|
92
|
+
name?: string;
|
|
93
|
+
}
|
|
94
|
+
export interface AiDialogueHistory {
|
|
95
|
+
prompt?: string;
|
|
96
|
+
answer?: string;
|
|
97
|
+
created_at?: string;
|
|
98
|
+
}
|
|
99
|
+
export interface AiExtract {
|
|
100
|
+
prompt: string;
|
|
101
|
+
items: Array<AiItemBase>;
|
|
102
|
+
ai_agent?: AiExtractAgent;
|
|
103
|
+
}
|
|
104
|
+
export type AiExtractAgent = (AiAgentReference & {
|
|
105
|
+
type: "ai_agent_id";
|
|
106
|
+
}) | (AiAgentExtract & {
|
|
107
|
+
type: "ai_agent_extract";
|
|
108
|
+
}) | {
|
|
109
|
+
type: string;
|
|
110
|
+
[key: string]: unknown;
|
|
111
|
+
};
|
|
112
|
+
export interface AiExtractFieldOption {
|
|
113
|
+
key: string;
|
|
114
|
+
}
|
|
115
|
+
export type AiExtractResponse = Record<string, unknown>;
|
|
116
|
+
export interface AiExtractStructured {
|
|
117
|
+
items: Array<AiItemBase>;
|
|
118
|
+
metadata_template?: AiExtractStructuredMetadataTemplate;
|
|
119
|
+
fields?: Array<AiExtractStructuredFields>;
|
|
120
|
+
ai_agent?: AiExtractStructuredAgent;
|
|
121
|
+
include_confidence_score?: boolean;
|
|
122
|
+
include_reference?: boolean;
|
|
123
|
+
taxonomy_sources?: Array<AiTaxonomySource>;
|
|
124
|
+
}
|
|
125
|
+
export type AiExtractStructuredAgent = (AiAgentReference & {
|
|
126
|
+
type: "ai_agent_id";
|
|
127
|
+
}) | (AiAgentExtractStructured & {
|
|
128
|
+
type: "ai_agent_extract_structured";
|
|
129
|
+
}) | {
|
|
130
|
+
type: string;
|
|
131
|
+
[key: string]: unknown;
|
|
132
|
+
};
|
|
133
|
+
export interface AiExtractStructuredResponse {
|
|
134
|
+
answer: AiExtractResponse;
|
|
135
|
+
created_at: string;
|
|
136
|
+
completion_reason?: string;
|
|
137
|
+
confidence_score?: Record<string, unknown>;
|
|
138
|
+
reference?: Record<string, unknown>;
|
|
139
|
+
ai_agent_info?: AiAgentInfo;
|
|
140
|
+
}
|
|
141
|
+
export interface AiExtractSubField {
|
|
142
|
+
key: string;
|
|
143
|
+
description?: string;
|
|
144
|
+
displayName?: string;
|
|
145
|
+
prompt?: string;
|
|
146
|
+
type?: string;
|
|
147
|
+
options?: Array<AiExtractFieldOption>;
|
|
148
|
+
}
|
|
149
|
+
export interface AiItemBase {
|
|
150
|
+
id: string;
|
|
151
|
+
type: AiCitationType;
|
|
152
|
+
content?: string;
|
|
153
|
+
}
|
|
154
|
+
export interface AiItemAsk {
|
|
155
|
+
id: string;
|
|
156
|
+
type: AiItemAskType;
|
|
157
|
+
content?: string;
|
|
158
|
+
}
|
|
159
|
+
export interface AiOptionsRules {
|
|
160
|
+
multi_select?: boolean;
|
|
161
|
+
selectable_levels?: Array<number>;
|
|
162
|
+
}
|
|
163
|
+
export interface AiResponse {
|
|
164
|
+
answer: string;
|
|
165
|
+
created_at: string;
|
|
166
|
+
completion_reason?: string;
|
|
167
|
+
ai_agent_info?: AiAgentInfo;
|
|
168
|
+
}
|
|
169
|
+
export interface AiResponseFull {
|
|
170
|
+
answer: string;
|
|
171
|
+
created_at: string;
|
|
172
|
+
completion_reason?: string;
|
|
173
|
+
ai_agent_info?: AiAgentInfo;
|
|
174
|
+
citations?: Array<AiCitation>;
|
|
175
|
+
}
|
|
176
|
+
export interface AiTaxonomyFileReference {
|
|
177
|
+
type?: AiCitationType;
|
|
178
|
+
taxonomy_key?: string;
|
|
179
|
+
id?: string;
|
|
180
|
+
}
|
|
181
|
+
export interface AiTaxonomyReference {
|
|
182
|
+
type?: AiTaxonomyReferenceType;
|
|
183
|
+
taxonomy_key?: string;
|
|
184
|
+
namespace?: string;
|
|
185
|
+
}
|
|
186
|
+
export type AiTaxonomySource = (AiTaxonomyReference & {
|
|
187
|
+
type: "taxonomy";
|
|
188
|
+
}) | (AiTaxonomyFileReference & {
|
|
189
|
+
type: "file";
|
|
190
|
+
}) | {
|
|
191
|
+
type: string;
|
|
192
|
+
[key: string]: unknown;
|
|
193
|
+
};
|
|
194
|
+
export interface AiTextGen {
|
|
195
|
+
prompt: string;
|
|
196
|
+
items: Array<AiTextGenItems>;
|
|
197
|
+
dialogue_history?: Array<AiDialogueHistory>;
|
|
198
|
+
ai_agent?: AiTextGenAgent;
|
|
199
|
+
}
|
|
200
|
+
export type AiTextGenAgent = (AiAgentReference & {
|
|
201
|
+
type: "ai_agent_id";
|
|
202
|
+
}) | (AiAgentTextGen & {
|
|
203
|
+
type: "ai_agent_text_gen";
|
|
204
|
+
}) | {
|
|
205
|
+
type: string;
|
|
206
|
+
[key: string]: unknown;
|
|
207
|
+
};
|
|
208
|
+
export type AiAgentExtractStructuredType = "ai_agent_extract_structured" | (string & {});
|
|
209
|
+
export interface AiAgentInfoModels {
|
|
210
|
+
name?: string;
|
|
211
|
+
provider?: string;
|
|
212
|
+
supported_purpose?: string;
|
|
213
|
+
}
|
|
214
|
+
export type AiAgentReferenceType = "ai_agent_id" | (string & {});
|
|
215
|
+
export type AiAskMode = "multiple_item_qa" | "single_item_qa" | (string & {});
|
|
216
|
+
export interface AiExtractStructuredMetadataTemplate {
|
|
217
|
+
template_key?: string;
|
|
218
|
+
type?: MetadataTemplateType;
|
|
219
|
+
scope?: string;
|
|
220
|
+
}
|
|
221
|
+
export interface AiExtractStructuredFields {
|
|
222
|
+
key: string;
|
|
223
|
+
description?: string;
|
|
224
|
+
displayName?: string;
|
|
225
|
+
prompt?: string;
|
|
226
|
+
type?: string;
|
|
227
|
+
options?: Array<FieldsOptions>;
|
|
228
|
+
fields?: Array<AiExtractSubField>;
|
|
229
|
+
taxonomy_key?: string;
|
|
230
|
+
namespace?: string;
|
|
231
|
+
options_rules?: AiOptionsRules;
|
|
232
|
+
}
|
|
233
|
+
export type AiItemAskType = "file" | "hubs" | (string & {});
|
|
234
|
+
export type AiTaxonomyReferenceType = "taxonomy" | (string & {});
|
|
235
|
+
export interface AiTextGenItems {
|
|
236
|
+
id: string;
|
|
237
|
+
type: AiCitationType;
|
|
238
|
+
content?: string;
|
|
239
|
+
}
|
|
240
|
+
export type GetAgentDefaultMode = "ask" | "text_gen" | "extract" | "extract_structured" | (string & {});
|