UNPKG

hud-ai

Version:

Hud.ai API Client

github.com/FoundryAI/hud-ai-node

FoundryAI/hud-ai-node

92 lines (76 loc) • 3.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# Collateral | Attribute | Type | Description | | --------- | ---- | ----------- | | `id` | string | Resource ID **Cannot be edited** | | `createdAt` | Date | Creation date **Cannot be edited** | | `updatedAt` | Date | Last touch date **Cannot be edited** | | `organizationId` | string | Organization that owns the collateral | | `name` | string | File name | | `description` | string | Additional user-readable metadata | | `contentUrl` | string | Location where the content has been uploaded (e.g. `https://uploads.hud.ai/organizations/org-id/collateral/upload.pdf`) | | `plaintextUrl` | string | Parsed `.txt` file containing content | | `filetype` | string | e.g. `pdf` or `application/msword` | | `size` | number | File size in bytes | | `dataScienceMetadata` | Object | Here there be monsters, do not edit | ## `client.collateral.list(query)` | Param | Type | |-------|------| | `query` | Object | | `query.organizationId`* | **string** | | `query.id` | string | | `query.name` | string | | `query.limit` | number | | `query.offset` | number | ## `client.collateral.search(query)` | Param | Type | |-------|------| | `query` | Object | | `query.organizationId` | string | | `query.id` | string | | `query.text` | string | | `query.filetype` | string | | `query.limit` | number | | `query.offset` | number | ## `client.collateral.create(params)` | Param | Type | |-------|------| | `params` | Object | | `params.organizationId`* | **string** | | `params.name`* | **string** | | `params.contentUrl`* | **string** | | `params.description` | string | | `params.plaintextUrl` | string | | `params.filetype` | string | | `params.size` | number | | `params.dataScienceMetadata` | Object | ## `client.collateral.get(params)` | Param | Type | |-------|------| | `params` | Object | | `params.organizationId`* | **string** | | `params.id`* | **string** | ## `client.collateral.downloadUri(params)` | Param | Type | |-------|------| | `params` | Object | | `params.organizationId`* | **string** | | `params.id`* | **string** | ## `client.collateral.update(params)` | Param | Type | |-------|------| | `params` | Object | | `params.organizationId`* | **string** | | `params.id`* | **string** | | `params.name` | string | | `params.contentUrl` | string | | `params.description` | string | | `params.plaintextUrl` | string | | `params.filetype` | string | | `params.size` | number | | `params.dataScienceMetadata` | Object | ## `client.collateral.destroy(params)` | Param | Type | |-------|------| | `params` | Object | | `params.organizationId`* | **string** | | `params.id`* | **string** |