@athenaintel/sdk 4.3.2159 → 4.3.2161
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 +17 -16
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +2 -2
- package/dist/cjs/Client.js +4 -4
- package/dist/cjs/api/resources/agents/client/Client.d.ts +1 -41
- package/dist/cjs/api/resources/agents/client/Client.js +2 -163
- package/dist/cjs/api/resources/agents/client/index.d.ts +1 -1
- package/dist/cjs/api/resources/agents/client/index.js +0 -15
- package/dist/cjs/api/resources/agents/resources/general/client/Client.d.ts +2 -44
- package/dist/cjs/api/resources/agents/resources/general/client/Client.js +1 -163
- package/dist/cjs/api/resources/agents/resources/general/client/index.d.ts +1 -1
- package/dist/cjs/api/resources/agents/resources/general/client/index.js +15 -0
- package/dist/cjs/api/{types → resources/agents/resources/general/client/requests}/GeneralAgentRequest.d.ts +11 -2
- package/dist/cjs/api/resources/agents/resources/general/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/agents/resources/index.d.ts +1 -6
- package/dist/cjs/api/resources/agents/resources/index.js +2 -7
- package/dist/cjs/api/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/index.js +3 -4
- package/dist/cjs/api/resources/tools/client/Client.d.ts +11 -0
- package/dist/cjs/api/resources/tools/client/Client.js +11 -0
- package/dist/cjs/api/types/index.d.ts +0 -5
- package/dist/cjs/api/types/index.js +0 -5
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +2 -2
- package/dist/esm/Client.mjs +4 -4
- package/dist/esm/api/resources/agents/client/Client.d.mts +1 -41
- package/dist/esm/api/resources/agents/client/Client.mjs +0 -128
- package/dist/esm/api/resources/agents/client/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/client/index.mjs +1 -1
- package/dist/esm/api/resources/agents/resources/general/client/Client.d.mts +2 -44
- package/dist/esm/api/resources/agents/resources/general/client/Client.mjs +1 -163
- package/dist/esm/api/resources/agents/resources/general/client/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/resources/general/client/index.mjs +1 -1
- package/dist/esm/api/{types → resources/agents/resources/general/client/requests}/GeneralAgentRequest.d.mts +11 -2
- package/dist/esm/api/resources/agents/resources/general/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/agents/resources/index.d.mts +1 -6
- package/dist/esm/api/resources/agents/resources/index.mjs +1 -6
- package/dist/esm/api/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/index.mjs +0 -1
- package/dist/esm/api/resources/tools/client/Client.d.mts +11 -0
- package/dist/esm/api/resources/tools/client/Client.mjs +11 -0
- package/dist/esm/api/types/index.d.mts +0 -5
- package/dist/esm/api/types/index.mjs +0 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +24 -434
- package/dist/cjs/api/resources/agents/client/requests/CustomAgentRequest.d.ts +0 -20
- package/dist/cjs/api/resources/agents/client/requests/CustomAgentRequest.js +0 -3
- package/dist/cjs/api/resources/agents/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/drive/client/Client.d.ts +0 -34
- package/dist/cjs/api/resources/agents/resources/drive/client/Client.js +0 -138
- package/dist/cjs/api/resources/agents/resources/drive/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/drive/client/index.js +0 -17
- package/dist/cjs/api/resources/agents/resources/drive/client/requests/DriveAgentRequest.d.ts +0 -17
- package/dist/cjs/api/resources/agents/resources/drive/client/requests/DriveAgentRequest.js +0 -3
- package/dist/cjs/api/resources/agents/resources/drive/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/drive/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/agents/resources/drive/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/drive/index.js +0 -17
- package/dist/cjs/api/resources/agents/resources/research/client/Client.d.ts +0 -34
- package/dist/cjs/api/resources/agents/resources/research/client/Client.js +0 -138
- package/dist/cjs/api/resources/agents/resources/research/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/research/client/index.js +0 -17
- package/dist/cjs/api/resources/agents/resources/research/client/requests/ResearchAgentRequest.d.ts +0 -17
- package/dist/cjs/api/resources/agents/resources/research/client/requests/ResearchAgentRequest.js +0 -3
- package/dist/cjs/api/resources/agents/resources/research/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/research/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/agents/resources/research/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/research/index.js +0 -17
- package/dist/cjs/api/resources/agents/resources/sql/client/Client.d.ts +0 -34
- package/dist/cjs/api/resources/agents/resources/sql/client/Client.js +0 -135
- package/dist/cjs/api/resources/agents/resources/sql/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/sql/client/index.js +0 -17
- package/dist/cjs/api/resources/agents/resources/sql/client/requests/SqlAgentRequest.d.ts +0 -17
- package/dist/cjs/api/resources/agents/resources/sql/client/requests/SqlAgentRequest.js +0 -3
- package/dist/cjs/api/resources/agents/resources/sql/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/sql/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/agents/resources/sql/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/sql/index.js +0 -17
- package/dist/cjs/api/types/CustomAgentResponse.d.ts +0 -4
- package/dist/cjs/api/types/CustomAgentResponse.js +0 -3
- package/dist/cjs/api/types/DriveAgentResponse.d.ts +0 -4
- package/dist/cjs/api/types/DriveAgentResponse.js +0 -3
- package/dist/cjs/api/types/ResearchAgentResponse.d.ts +0 -4
- package/dist/cjs/api/types/ResearchAgentResponse.js +0 -3
- package/dist/cjs/api/types/SqlAgentResponse.d.ts +0 -6
- package/dist/cjs/api/types/SqlAgentResponse.js +0 -3
- package/dist/esm/api/resources/agents/client/requests/CustomAgentRequest.d.mts +0 -20
- package/dist/esm/api/resources/agents/client/requests/CustomAgentRequest.mjs +0 -2
- package/dist/esm/api/resources/agents/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/drive/client/Client.d.mts +0 -34
- package/dist/esm/api/resources/agents/resources/drive/client/Client.mjs +0 -101
- package/dist/esm/api/resources/agents/resources/drive/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/drive/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/drive/client/requests/DriveAgentRequest.d.mts +0 -17
- package/dist/esm/api/resources/agents/resources/drive/client/requests/DriveAgentRequest.mjs +0 -2
- package/dist/esm/api/resources/agents/resources/drive/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/drive/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/drive/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/drive/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/research/client/Client.d.mts +0 -34
- package/dist/esm/api/resources/agents/resources/research/client/Client.mjs +0 -101
- package/dist/esm/api/resources/agents/resources/research/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/research/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/research/client/requests/ResearchAgentRequest.d.mts +0 -17
- package/dist/esm/api/resources/agents/resources/research/client/requests/ResearchAgentRequest.mjs +0 -2
- package/dist/esm/api/resources/agents/resources/research/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/research/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/research/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/research/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/sql/client/Client.d.mts +0 -34
- package/dist/esm/api/resources/agents/resources/sql/client/Client.mjs +0 -98
- package/dist/esm/api/resources/agents/resources/sql/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/sql/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/sql/client/requests/SqlAgentRequest.d.mts +0 -17
- package/dist/esm/api/resources/agents/resources/sql/client/requests/SqlAgentRequest.mjs +0 -2
- package/dist/esm/api/resources/agents/resources/sql/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/sql/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/sql/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/sql/index.mjs +0 -1
- package/dist/esm/api/types/CustomAgentResponse.d.mts +0 -4
- package/dist/esm/api/types/CustomAgentResponse.mjs +0 -2
- package/dist/esm/api/types/DriveAgentResponse.d.mts +0 -4
- package/dist/esm/api/types/DriveAgentResponse.mjs +0 -2
- package/dist/esm/api/types/ResearchAgentResponse.d.mts +0 -4
- package/dist/esm/api/types/ResearchAgentResponse.mjs +0 -2
- package/dist/esm/api/types/SqlAgentResponse.d.mts +0 -6
- package/dist/esm/api/types/SqlAgentResponse.mjs +0 -2
- /package/dist/cjs/api/{types → resources/agents/resources/general/client/requests}/GeneralAgentRequest.js +0 -0
- /package/dist/cjs/api/resources/agents/{client → resources/general/client}/requests/index.js +0 -0
- /package/dist/esm/api/{types → resources/agents/resources/general/client/requests}/GeneralAgentRequest.mjs +0 -0
- /package/dist/esm/api/resources/agents/{client → resources/general/client}/requests/index.mjs +0 -0
package/reference.md
CHANGED
|
@@ -1,82 +1,4 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
## Agents
|
|
3
|
-
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">invokeById</a>({ ...params }) -> AthenaIntelligence.CustomAgentResponse</code></summary>
|
|
4
|
-
<dl>
|
|
5
|
-
<dd>
|
|
6
|
-
|
|
7
|
-
#### 📝 Description
|
|
8
|
-
|
|
9
|
-
<dl>
|
|
10
|
-
<dd>
|
|
11
|
-
|
|
12
|
-
<dl>
|
|
13
|
-
<dd>
|
|
14
|
-
|
|
15
|
-
Coming soon!
|
|
16
|
-
|
|
17
|
-
Invoke a custom agent created in [spaces](https://resources.athenaintel.com/docs/agents/create-your-agent).
|
|
18
|
-
|
|
19
|
-
Custom agents can be created and configured in spaces to perform specialized tasks.
|
|
20
|
-
Refer to the specific agent's documentation for details on configuration options
|
|
21
|
-
and expected responses.
|
|
22
|
-
</dd>
|
|
23
|
-
</dl>
|
|
24
|
-
</dd>
|
|
25
|
-
</dl>
|
|
26
|
-
|
|
27
|
-
#### 🔌 Usage
|
|
28
|
-
|
|
29
|
-
<dl>
|
|
30
|
-
<dd>
|
|
31
|
-
|
|
32
|
-
<dl>
|
|
33
|
-
<dd>
|
|
34
|
-
|
|
35
|
-
```typescript
|
|
36
|
-
await client.agents.invokeById({
|
|
37
|
-
agent_id: "agent_id",
|
|
38
|
-
config: {
|
|
39
|
-
"key": "value"
|
|
40
|
-
},
|
|
41
|
-
messages: [{
|
|
42
|
-
"key": "value"
|
|
43
|
-
}]
|
|
44
|
-
});
|
|
45
|
-
|
|
46
|
-
```
|
|
47
|
-
</dd>
|
|
48
|
-
</dl>
|
|
49
|
-
</dd>
|
|
50
|
-
</dl>
|
|
51
|
-
|
|
52
|
-
#### ⚙️ Parameters
|
|
53
|
-
|
|
54
|
-
<dl>
|
|
55
|
-
<dd>
|
|
56
|
-
|
|
57
|
-
<dl>
|
|
58
|
-
<dd>
|
|
59
|
-
|
|
60
|
-
**request:** `AthenaIntelligence.CustomAgentRequest`
|
|
61
|
-
|
|
62
|
-
</dd>
|
|
63
|
-
</dl>
|
|
64
|
-
|
|
65
|
-
<dl>
|
|
66
|
-
<dd>
|
|
67
|
-
|
|
68
|
-
**requestOptions:** `AgentsClient.RequestOptions`
|
|
69
|
-
|
|
70
|
-
</dd>
|
|
71
|
-
</dl>
|
|
72
|
-
</dd>
|
|
73
|
-
</dl>
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
</dd>
|
|
77
|
-
</dl>
|
|
78
|
-
</details>
|
|
79
|
-
|
|
80
2
|
## Aop
|
|
81
3
|
<details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">create</a>({ ...params }) -> AthenaIntelligence.AopCreateResponseOut</code></summary>
|
|
82
4
|
<dl>
|
|
@@ -4314,6 +4236,29 @@ await client.tools.listContents();
|
|
|
4314
4236
|
<dl>
|
|
4315
4237
|
<dd>
|
|
4316
4238
|
|
|
4239
|
+
#### 📝 Description
|
|
4240
|
+
|
|
4241
|
+
<dl>
|
|
4242
|
+
<dd>
|
|
4243
|
+
|
|
4244
|
+
<dl>
|
|
4245
|
+
<dd>
|
|
4246
|
+
|
|
4247
|
+
Read a tabular asset as a JSON data frame.
|
|
4248
|
+
|
|
4249
|
+
Returns `columns`, an optional `index`, and `data` rows (pandas "split"
|
|
4250
|
+
orientation) for an asset the caller can read: an Athena spreadsheet, a
|
|
4251
|
+
file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an
|
|
4252
|
+
uploaded CSV, Excel or Parquet file. `row_limit` caps the rows returned,
|
|
4253
|
+
`columns` selects columns by name or position, `sheet_name` picks the sheet
|
|
4254
|
+
of an Excel file (the first by default), and `separator` sets the delimiter
|
|
4255
|
+
of a CSV file. Any other asset type is a 415; a file the parser cannot read
|
|
4256
|
+
is a 500 carrying the parser's message.
|
|
4257
|
+
</dd>
|
|
4258
|
+
</dl>
|
|
4259
|
+
</dd>
|
|
4260
|
+
</dl>
|
|
4261
|
+
|
|
4317
4262
|
#### 🔌 Usage
|
|
4318
4263
|
|
|
4319
4264
|
<dl>
|
|
@@ -4752,153 +4697,11 @@ await client.workspaces.updateToolRegistry({
|
|
|
4752
4697
|
</dl>
|
|
4753
4698
|
|
|
4754
4699
|
|
|
4755
|
-
</dd>
|
|
4756
|
-
</dl>
|
|
4757
|
-
</details>
|
|
4758
|
-
|
|
4759
|
-
## Agents Drive
|
|
4760
|
-
<details><summary><code>client.agents.drive.<a href="/src/api/resources/agents/resources/drive/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.DriveAgentResponse</code></summary>
|
|
4761
|
-
<dl>
|
|
4762
|
-
<dd>
|
|
4763
|
-
|
|
4764
|
-
#### 📝 Description
|
|
4765
|
-
|
|
4766
|
-
<dl>
|
|
4767
|
-
<dd>
|
|
4768
|
-
|
|
4769
|
-
<dl>
|
|
4770
|
-
<dd>
|
|
4771
|
-
|
|
4772
|
-
Coming soon! Manage folders and search for files in the internal drive.
|
|
4773
|
-
</dd>
|
|
4774
|
-
</dl>
|
|
4775
|
-
</dd>
|
|
4776
|
-
</dl>
|
|
4777
|
-
|
|
4778
|
-
#### 🔌 Usage
|
|
4779
|
-
|
|
4780
|
-
<dl>
|
|
4781
|
-
<dd>
|
|
4782
|
-
|
|
4783
|
-
<dl>
|
|
4784
|
-
<dd>
|
|
4785
|
-
|
|
4786
|
-
```typescript
|
|
4787
|
-
await client.agents.drive.invoke({
|
|
4788
|
-
config: {
|
|
4789
|
-
"key": "value"
|
|
4790
|
-
},
|
|
4791
|
-
messages: [{
|
|
4792
|
-
"key": "value"
|
|
4793
|
-
}]
|
|
4794
|
-
});
|
|
4795
|
-
|
|
4796
|
-
```
|
|
4797
|
-
</dd>
|
|
4798
|
-
</dl>
|
|
4799
|
-
</dd>
|
|
4800
|
-
</dl>
|
|
4801
|
-
|
|
4802
|
-
#### ⚙️ Parameters
|
|
4803
|
-
|
|
4804
|
-
<dl>
|
|
4805
|
-
<dd>
|
|
4806
|
-
|
|
4807
|
-
<dl>
|
|
4808
|
-
<dd>
|
|
4809
|
-
|
|
4810
|
-
**request:** `AthenaIntelligence.agents.DriveAgentRequest`
|
|
4811
|
-
|
|
4812
|
-
</dd>
|
|
4813
|
-
</dl>
|
|
4814
|
-
|
|
4815
|
-
<dl>
|
|
4816
|
-
<dd>
|
|
4817
|
-
|
|
4818
|
-
**requestOptions:** `DriveClient.RequestOptions`
|
|
4819
|
-
|
|
4820
|
-
</dd>
|
|
4821
|
-
</dl>
|
|
4822
|
-
</dd>
|
|
4823
|
-
</dl>
|
|
4824
|
-
|
|
4825
|
-
|
|
4826
4700
|
</dd>
|
|
4827
4701
|
</dl>
|
|
4828
4702
|
</details>
|
|
4829
4703
|
|
|
4830
4704
|
## Agents General
|
|
4831
|
-
<details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">batch</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse[]</code></summary>
|
|
4832
|
-
<dl>
|
|
4833
|
-
<dd>
|
|
4834
|
-
|
|
4835
|
-
#### 📝 Description
|
|
4836
|
-
|
|
4837
|
-
<dl>
|
|
4838
|
-
<dd>
|
|
4839
|
-
|
|
4840
|
-
<dl>
|
|
4841
|
-
<dd>
|
|
4842
|
-
|
|
4843
|
-
Coming soon! Call the general agent with batched requests and return the results.
|
|
4844
|
-
</dd>
|
|
4845
|
-
</dl>
|
|
4846
|
-
</dd>
|
|
4847
|
-
</dl>
|
|
4848
|
-
|
|
4849
|
-
#### 🔌 Usage
|
|
4850
|
-
|
|
4851
|
-
<dl>
|
|
4852
|
-
<dd>
|
|
4853
|
-
|
|
4854
|
-
<dl>
|
|
4855
|
-
<dd>
|
|
4856
|
-
|
|
4857
|
-
```typescript
|
|
4858
|
-
await client.agents.general.batch([{
|
|
4859
|
-
config: {
|
|
4860
|
-
enabled_tools: ["search"]
|
|
4861
|
-
},
|
|
4862
|
-
messages: [{
|
|
4863
|
-
content: "Please call the search tool for AAPL news.",
|
|
4864
|
-
role: "user"
|
|
4865
|
-
}]
|
|
4866
|
-
}]);
|
|
4867
|
-
|
|
4868
|
-
```
|
|
4869
|
-
</dd>
|
|
4870
|
-
</dl>
|
|
4871
|
-
</dd>
|
|
4872
|
-
</dl>
|
|
4873
|
-
|
|
4874
|
-
#### ⚙️ Parameters
|
|
4875
|
-
|
|
4876
|
-
<dl>
|
|
4877
|
-
<dd>
|
|
4878
|
-
|
|
4879
|
-
<dl>
|
|
4880
|
-
<dd>
|
|
4881
|
-
|
|
4882
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest[]`
|
|
4883
|
-
|
|
4884
|
-
</dd>
|
|
4885
|
-
</dl>
|
|
4886
|
-
|
|
4887
|
-
<dl>
|
|
4888
|
-
<dd>
|
|
4889
|
-
|
|
4890
|
-
**requestOptions:** `GeneralClient.RequestOptions`
|
|
4891
|
-
|
|
4892
|
-
</dd>
|
|
4893
|
-
</dl>
|
|
4894
|
-
</dd>
|
|
4895
|
-
</dl>
|
|
4896
|
-
|
|
4897
|
-
|
|
4898
|
-
</dd>
|
|
4899
|
-
</dl>
|
|
4900
|
-
</details>
|
|
4901
|
-
|
|
4902
4705
|
<details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse</code></summary>
|
|
4903
4706
|
<dl>
|
|
4904
4707
|
<dd>
|
|
@@ -4953,78 +4756,7 @@ await client.agents.general.invoke({
|
|
|
4953
4756
|
<dl>
|
|
4954
4757
|
<dd>
|
|
4955
4758
|
|
|
4956
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
4957
|
-
|
|
4958
|
-
</dd>
|
|
4959
|
-
</dl>
|
|
4960
|
-
|
|
4961
|
-
<dl>
|
|
4962
|
-
<dd>
|
|
4963
|
-
|
|
4964
|
-
**requestOptions:** `GeneralClient.RequestOptions`
|
|
4965
|
-
|
|
4966
|
-
</dd>
|
|
4967
|
-
</dl>
|
|
4968
|
-
</dd>
|
|
4969
|
-
</dl>
|
|
4970
|
-
|
|
4971
|
-
|
|
4972
|
-
</dd>
|
|
4973
|
-
</dl>
|
|
4974
|
-
</details>
|
|
4975
|
-
|
|
4976
|
-
<details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">streamEvents</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse</code></summary>
|
|
4977
|
-
<dl>
|
|
4978
|
-
<dd>
|
|
4979
|
-
|
|
4980
|
-
#### 📝 Description
|
|
4981
|
-
|
|
4982
|
-
<dl>
|
|
4983
|
-
<dd>
|
|
4984
|
-
|
|
4985
|
-
<dl>
|
|
4986
|
-
<dd>
|
|
4987
|
-
|
|
4988
|
-
Coming soon! Call the general agent and stream events for real-time chat applications.
|
|
4989
|
-
</dd>
|
|
4990
|
-
</dl>
|
|
4991
|
-
</dd>
|
|
4992
|
-
</dl>
|
|
4993
|
-
|
|
4994
|
-
#### 🔌 Usage
|
|
4995
|
-
|
|
4996
|
-
<dl>
|
|
4997
|
-
<dd>
|
|
4998
|
-
|
|
4999
|
-
<dl>
|
|
5000
|
-
<dd>
|
|
5001
|
-
|
|
5002
|
-
```typescript
|
|
5003
|
-
await client.agents.general.streamEvents({
|
|
5004
|
-
config: {
|
|
5005
|
-
enabled_tools: ["search"]
|
|
5006
|
-
},
|
|
5007
|
-
messages: [{
|
|
5008
|
-
content: "Please call the search tool for AAPL news.",
|
|
5009
|
-
role: "user"
|
|
5010
|
-
}]
|
|
5011
|
-
});
|
|
5012
|
-
|
|
5013
|
-
```
|
|
5014
|
-
</dd>
|
|
5015
|
-
</dl>
|
|
5016
|
-
</dd>
|
|
5017
|
-
</dl>
|
|
5018
|
-
|
|
5019
|
-
#### ⚙️ Parameters
|
|
5020
|
-
|
|
5021
|
-
<dl>
|
|
5022
|
-
<dd>
|
|
5023
|
-
|
|
5024
|
-
<dl>
|
|
5025
|
-
<dd>
|
|
5026
|
-
|
|
5027
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
4759
|
+
**request:** `AthenaIntelligence.agents.GeneralAgentRequest`
|
|
5028
4760
|
|
|
5029
4761
|
</dd>
|
|
5030
4762
|
</dl>
|
|
@@ -5040,148 +4772,6 @@ await client.agents.general.streamEvents({
|
|
|
5040
4772
|
</dl>
|
|
5041
4773
|
|
|
5042
4774
|
|
|
5043
|
-
</dd>
|
|
5044
|
-
</dl>
|
|
5045
|
-
</details>
|
|
5046
|
-
|
|
5047
|
-
## Agents Research
|
|
5048
|
-
<details><summary><code>client.agents.research.<a href="/src/api/resources/agents/resources/research/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.ResearchAgentResponse</code></summary>
|
|
5049
|
-
<dl>
|
|
5050
|
-
<dd>
|
|
5051
|
-
|
|
5052
|
-
#### 📝 Description
|
|
5053
|
-
|
|
5054
|
-
<dl>
|
|
5055
|
-
<dd>
|
|
5056
|
-
|
|
5057
|
-
<dl>
|
|
5058
|
-
<dd>
|
|
5059
|
-
|
|
5060
|
-
Coming soon! Conduct research using web and other sources.
|
|
5061
|
-
</dd>
|
|
5062
|
-
</dl>
|
|
5063
|
-
</dd>
|
|
5064
|
-
</dl>
|
|
5065
|
-
|
|
5066
|
-
#### 🔌 Usage
|
|
5067
|
-
|
|
5068
|
-
<dl>
|
|
5069
|
-
<dd>
|
|
5070
|
-
|
|
5071
|
-
<dl>
|
|
5072
|
-
<dd>
|
|
5073
|
-
|
|
5074
|
-
```typescript
|
|
5075
|
-
await client.agents.research.invoke({
|
|
5076
|
-
config: {
|
|
5077
|
-
"key": "value"
|
|
5078
|
-
},
|
|
5079
|
-
messages: [{
|
|
5080
|
-
"key": "value"
|
|
5081
|
-
}]
|
|
5082
|
-
});
|
|
5083
|
-
|
|
5084
|
-
```
|
|
5085
|
-
</dd>
|
|
5086
|
-
</dl>
|
|
5087
|
-
</dd>
|
|
5088
|
-
</dl>
|
|
5089
|
-
|
|
5090
|
-
#### ⚙️ Parameters
|
|
5091
|
-
|
|
5092
|
-
<dl>
|
|
5093
|
-
<dd>
|
|
5094
|
-
|
|
5095
|
-
<dl>
|
|
5096
|
-
<dd>
|
|
5097
|
-
|
|
5098
|
-
**request:** `AthenaIntelligence.agents.ResearchAgentRequest`
|
|
5099
|
-
|
|
5100
|
-
</dd>
|
|
5101
|
-
</dl>
|
|
5102
|
-
|
|
5103
|
-
<dl>
|
|
5104
|
-
<dd>
|
|
5105
|
-
|
|
5106
|
-
**requestOptions:** `ResearchClient.RequestOptions`
|
|
5107
|
-
|
|
5108
|
-
</dd>
|
|
5109
|
-
</dl>
|
|
5110
|
-
</dd>
|
|
5111
|
-
</dl>
|
|
5112
|
-
|
|
5113
|
-
|
|
5114
|
-
</dd>
|
|
5115
|
-
</dl>
|
|
5116
|
-
</details>
|
|
5117
|
-
|
|
5118
|
-
## Agents Sql
|
|
5119
|
-
<details><summary><code>client.agents.sql.<a href="/src/api/resources/agents/resources/sql/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.SqlAgentResponse</code></summary>
|
|
5120
|
-
<dl>
|
|
5121
|
-
<dd>
|
|
5122
|
-
|
|
5123
|
-
#### 📝 Description
|
|
5124
|
-
|
|
5125
|
-
<dl>
|
|
5126
|
-
<dd>
|
|
5127
|
-
|
|
5128
|
-
<dl>
|
|
5129
|
-
<dd>
|
|
5130
|
-
|
|
5131
|
-
Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for the query object.
|
|
5132
|
-
</dd>
|
|
5133
|
-
</dl>
|
|
5134
|
-
</dd>
|
|
5135
|
-
</dl>
|
|
5136
|
-
|
|
5137
|
-
#### 🔌 Usage
|
|
5138
|
-
|
|
5139
|
-
<dl>
|
|
5140
|
-
<dd>
|
|
5141
|
-
|
|
5142
|
-
<dl>
|
|
5143
|
-
<dd>
|
|
5144
|
-
|
|
5145
|
-
```typescript
|
|
5146
|
-
await client.agents.sql.invoke({
|
|
5147
|
-
config: {
|
|
5148
|
-
"key": "value"
|
|
5149
|
-
},
|
|
5150
|
-
messages: [{
|
|
5151
|
-
"key": "value"
|
|
5152
|
-
}]
|
|
5153
|
-
});
|
|
5154
|
-
|
|
5155
|
-
```
|
|
5156
|
-
</dd>
|
|
5157
|
-
</dl>
|
|
5158
|
-
</dd>
|
|
5159
|
-
</dl>
|
|
5160
|
-
|
|
5161
|
-
#### ⚙️ Parameters
|
|
5162
|
-
|
|
5163
|
-
<dl>
|
|
5164
|
-
<dd>
|
|
5165
|
-
|
|
5166
|
-
<dl>
|
|
5167
|
-
<dd>
|
|
5168
|
-
|
|
5169
|
-
**request:** `AthenaIntelligence.agents.SqlAgentRequest`
|
|
5170
|
-
|
|
5171
|
-
</dd>
|
|
5172
|
-
</dl>
|
|
5173
|
-
|
|
5174
|
-
<dl>
|
|
5175
|
-
<dd>
|
|
5176
|
-
|
|
5177
|
-
**requestOptions:** `SqlClient.RequestOptions`
|
|
5178
|
-
|
|
5179
|
-
</dd>
|
|
5180
|
-
</dl>
|
|
5181
|
-
</dd>
|
|
5182
|
-
</dl>
|
|
5183
|
-
|
|
5184
|
-
|
|
5185
4775
|
</dd>
|
|
5186
4776
|
</dl>
|
|
5187
4777
|
</details>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @example
|
|
3
|
-
* {
|
|
4
|
-
* agent_id: "agent_id",
|
|
5
|
-
* config: {
|
|
6
|
-
* "key": "value"
|
|
7
|
-
* },
|
|
8
|
-
* messages: [{
|
|
9
|
-
* "key": "value"
|
|
10
|
-
* }]
|
|
11
|
-
* }
|
|
12
|
-
*/
|
|
13
|
-
export interface CustomAgentRequest {
|
|
14
|
-
/** The ID of the custom agent to invoke. Create custom agents in [spaces](https://resources.athenaintel.com/docs/agents/create-your-agent). */
|
|
15
|
-
agent_id: string;
|
|
16
|
-
/** Configuration for the custom agent. See the agent's documentation for specific configuration options. */
|
|
17
|
-
config: Record<string, unknown>;
|
|
18
|
-
/** The messages to send to the custom agent */
|
|
19
|
-
messages: Record<string, unknown>[];
|
|
20
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export type { CustomAgentRequest } from "./CustomAgentRequest.js";
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
|
|
2
|
-
import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.js";
|
|
3
|
-
import * as core from "../../../../../../core/index.js";
|
|
4
|
-
import * as AthenaIntelligence from "../../../../../index.js";
|
|
5
|
-
export declare namespace DriveClient {
|
|
6
|
-
interface Options extends BaseClientOptions {
|
|
7
|
-
}
|
|
8
|
-
interface RequestOptions extends BaseRequestOptions {
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
export declare class DriveClient {
|
|
12
|
-
protected readonly _options: NormalizedClientOptionsWithAuth<DriveClient.Options>;
|
|
13
|
-
constructor(options?: DriveClient.Options);
|
|
14
|
-
/**
|
|
15
|
-
* Coming soon! Manage folders and search for files in the internal drive.
|
|
16
|
-
*
|
|
17
|
-
* @param {AthenaIntelligence.agents.DriveAgentRequest} request
|
|
18
|
-
* @param {DriveClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
|
-
*
|
|
20
|
-
* @throws {@link AthenaIntelligence.UnprocessableEntityError}
|
|
21
|
-
*
|
|
22
|
-
* @example
|
|
23
|
-
* await client.agents.drive.invoke({
|
|
24
|
-
* config: {
|
|
25
|
-
* "key": "value"
|
|
26
|
-
* },
|
|
27
|
-
* messages: [{
|
|
28
|
-
* "key": "value"
|
|
29
|
-
* }]
|
|
30
|
-
* })
|
|
31
|
-
*/
|
|
32
|
-
invoke(request: AthenaIntelligence.agents.DriveAgentRequest, requestOptions?: DriveClient.RequestOptions): core.HttpResponsePromise<AthenaIntelligence.DriveAgentResponse>;
|
|
33
|
-
private __invoke;
|
|
34
|
-
}
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
-
if (k2 === undefined) k2 = k;
|
|
5
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
-
}
|
|
9
|
-
Object.defineProperty(o, k2, desc);
|
|
10
|
-
}) : (function(o, m, k, k2) {
|
|
11
|
-
if (k2 === undefined) k2 = k;
|
|
12
|
-
o[k2] = m[k];
|
|
13
|
-
}));
|
|
14
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
-
}) : function(o, v) {
|
|
17
|
-
o["default"] = v;
|
|
18
|
-
});
|
|
19
|
-
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
-
var ownKeys = function(o) {
|
|
21
|
-
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
-
var ar = [];
|
|
23
|
-
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
-
return ar;
|
|
25
|
-
};
|
|
26
|
-
return ownKeys(o);
|
|
27
|
-
};
|
|
28
|
-
return function (mod) {
|
|
29
|
-
if (mod && mod.__esModule) return mod;
|
|
30
|
-
var result = {};
|
|
31
|
-
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
-
__setModuleDefault(result, mod);
|
|
33
|
-
return result;
|
|
34
|
-
};
|
|
35
|
-
})();
|
|
36
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
37
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
38
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
39
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
40
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
41
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
42
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
43
|
-
});
|
|
44
|
-
};
|
|
45
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
|
-
exports.DriveClient = void 0;
|
|
47
|
-
const BaseClient_js_1 = require("../../../../../../BaseClient.js");
|
|
48
|
-
const headers_js_1 = require("../../../../../../core/headers.js");
|
|
49
|
-
const core = __importStar(require("../../../../../../core/index.js"));
|
|
50
|
-
const environments = __importStar(require("../../../../../../environments.js"));
|
|
51
|
-
const errors = __importStar(require("../../../../../../errors/index.js"));
|
|
52
|
-
const AthenaIntelligence = __importStar(require("../../../../../index.js"));
|
|
53
|
-
class DriveClient {
|
|
54
|
-
constructor(options = {}) {
|
|
55
|
-
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* Coming soon! Manage folders and search for files in the internal drive.
|
|
59
|
-
*
|
|
60
|
-
* @param {AthenaIntelligence.agents.DriveAgentRequest} request
|
|
61
|
-
* @param {DriveClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
|
-
*
|
|
63
|
-
* @throws {@link AthenaIntelligence.UnprocessableEntityError}
|
|
64
|
-
*
|
|
65
|
-
* @example
|
|
66
|
-
* await client.agents.drive.invoke({
|
|
67
|
-
* config: {
|
|
68
|
-
* "key": "value"
|
|
69
|
-
* },
|
|
70
|
-
* messages: [{
|
|
71
|
-
* "key": "value"
|
|
72
|
-
* }]
|
|
73
|
-
* })
|
|
74
|
-
*/
|
|
75
|
-
invoke(request, requestOptions) {
|
|
76
|
-
return core.HttpResponsePromise.fromPromise(this.__invoke(request, requestOptions));
|
|
77
|
-
}
|
|
78
|
-
__invoke(request, requestOptions) {
|
|
79
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
80
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
81
|
-
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
82
|
-
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
83
|
-
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
84
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.AthenaIntelligenceEnvironment.Production, "api/v0/agents/drive/invoke"),
|
|
85
|
-
method: "POST",
|
|
86
|
-
headers: _headers,
|
|
87
|
-
contentType: "application/json",
|
|
88
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
89
|
-
requestType: "json",
|
|
90
|
-
body: request,
|
|
91
|
-
timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
|
|
92
|
-
maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
|
|
93
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
94
|
-
fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
|
|
95
|
-
logging: this._options.logging,
|
|
96
|
-
});
|
|
97
|
-
if (_response.ok) {
|
|
98
|
-
return {
|
|
99
|
-
data: _response.body,
|
|
100
|
-
rawResponse: _response.rawResponse,
|
|
101
|
-
};
|
|
102
|
-
}
|
|
103
|
-
if (_response.error.reason === "status-code") {
|
|
104
|
-
switch (_response.error.statusCode) {
|
|
105
|
-
case 422:
|
|
106
|
-
throw new AthenaIntelligence.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
107
|
-
default:
|
|
108
|
-
throw new errors.AthenaIntelligenceError({
|
|
109
|
-
statusCode: _response.error.statusCode,
|
|
110
|
-
body: _response.error.body,
|
|
111
|
-
rawResponse: _response.rawResponse,
|
|
112
|
-
});
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
|
-
switch (_response.error.reason) {
|
|
116
|
-
case "non-json":
|
|
117
|
-
throw new errors.AthenaIntelligenceError({
|
|
118
|
-
statusCode: _response.error.statusCode,
|
|
119
|
-
body: _response.error.rawBody,
|
|
120
|
-
rawResponse: _response.rawResponse,
|
|
121
|
-
});
|
|
122
|
-
case "body-is-null":
|
|
123
|
-
throw new errors.AthenaIntelligenceError({
|
|
124
|
-
statusCode: _response.error.statusCode,
|
|
125
|
-
rawResponse: _response.rawResponse,
|
|
126
|
-
});
|
|
127
|
-
case "timeout":
|
|
128
|
-
throw new errors.AthenaIntelligenceTimeoutError("Timeout exceeded when calling POST /api/v0/agents/drive/invoke.");
|
|
129
|
-
case "unknown":
|
|
130
|
-
throw new errors.AthenaIntelligenceError({
|
|
131
|
-
message: _response.error.errorMessage,
|
|
132
|
-
rawResponse: _response.rawResponse,
|
|
133
|
-
});
|
|
134
|
-
}
|
|
135
|
-
});
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
exports.DriveClient = DriveClient;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./requests/index.js";
|