athena-intelligence 0.1.82__py3-none-any.whl → 0.1.83__py3-none-any.whl

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.
athena/snippet/client.py CHANGED
@@ -31,13 +31,24 @@ class SnippetClient:
31
31
  request_options: typing.Optional[RequestOptions] = None,
32
32
  ) -> GetSnippetsResponse:
33
33
  """
34
- Parameters:
35
- - page: typing.Optional[int]. Page number starting from 1
34
+ Parameters
35
+ ----------
36
+ page : typing.Optional[int]
37
+ Page number starting from 1
36
38
 
37
- - page_size: typing.Optional[int]. Number of items per page
39
+ page_size : typing.Optional[int]
40
+ Number of items per page
38
41
 
39
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
40
- ---
42
+ request_options : typing.Optional[RequestOptions]
43
+ Request-specific configuration.
44
+
45
+ Returns
46
+ -------
47
+ GetSnippetsResponse
48
+ Successful Response
49
+
50
+ Examples
51
+ --------
41
52
  from athena.client import Athena
42
53
 
43
54
  client = Athena(
@@ -89,11 +100,20 @@ class SnippetClient:
89
100
 
90
101
  def get_by_id(self, *, id: str, request_options: typing.Optional[RequestOptions] = None) -> GetSnippetOut:
91
102
  """
92
- Parameters:
93
- - id: str.
103
+ Parameters
104
+ ----------
105
+ id : str
106
+
107
+ request_options : typing.Optional[RequestOptions]
108
+ Request-specific configuration.
109
+
110
+ Returns
111
+ -------
112
+ GetSnippetOut
113
+ Successful Response
94
114
 
95
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
96
- ---
115
+ Examples
116
+ --------
97
117
  from athena.client import Athena
98
118
 
99
119
  client = Athena(
@@ -154,13 +174,24 @@ class AsyncSnippetClient:
154
174
  request_options: typing.Optional[RequestOptions] = None,
155
175
  ) -> GetSnippetsResponse:
156
176
  """
157
- Parameters:
158
- - page: typing.Optional[int]. Page number starting from 1
177
+ Parameters
178
+ ----------
179
+ page : typing.Optional[int]
180
+ Page number starting from 1
159
181
 
160
- - page_size: typing.Optional[int]. Number of items per page
182
+ page_size : typing.Optional[int]
183
+ Number of items per page
161
184
 
162
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
163
- ---
185
+ request_options : typing.Optional[RequestOptions]
186
+ Request-specific configuration.
187
+
188
+ Returns
189
+ -------
190
+ GetSnippetsResponse
191
+ Successful Response
192
+
193
+ Examples
194
+ --------
164
195
  from athena.client import AsyncAthena
165
196
 
166
197
  client = AsyncAthena(
@@ -212,11 +243,20 @@ class AsyncSnippetClient:
212
243
 
213
244
  async def get_by_id(self, *, id: str, request_options: typing.Optional[RequestOptions] = None) -> GetSnippetOut:
214
245
  """
215
- Parameters:
216
- - id: str.
246
+ Parameters
247
+ ----------
248
+ id : str
249
+
250
+ request_options : typing.Optional[RequestOptions]
251
+ Request-specific configuration.
252
+
253
+ Returns
254
+ -------
255
+ GetSnippetOut
256
+ Successful Response
217
257
 
218
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
219
- ---
258
+ Examples
259
+ --------
220
260
  from athena.client import AsyncAthena
221
261
 
222
262
  client = AsyncAthena(
athena/tools/client.py CHANGED
@@ -46,13 +46,22 @@ class ToolsClient:
46
46
  request_options: typing.Optional[RequestOptions] = None,
47
47
  ) -> FirecrawlScrapeUrlDataReponseDto:
48
48
  """
49
- Parameters:
50
- - url: str.
49
+ Parameters
50
+ ----------
51
+ url : str
51
52
 
52
- - params: typing.Optional[typing.Dict[str, typing.Any]].
53
+ params : typing.Optional[typing.Dict[str, typing.Any]]
53
54
 
54
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
55
- ---
55
+ request_options : typing.Optional[RequestOptions]
56
+ Request-specific configuration.
57
+
58
+ Returns
59
+ -------
60
+ FirecrawlScrapeUrlDataReponseDto
61
+ Successful Response
62
+
63
+ Examples
64
+ --------
56
65
  from athena.client import Athena
57
66
 
58
67
  client = Athena(
@@ -113,15 +122,24 @@ class ToolsClient:
113
122
  request_options: typing.Optional[RequestOptions] = None,
114
123
  ) -> LangchainDocumentsRequestOut:
115
124
  """
116
- Parameters:
117
- - document_id: str.
125
+ Parameters
126
+ ----------
127
+ document_id : str
128
+
129
+ pagination_limit : typing.Optional[int]
118
130
 
119
- - pagination_limit: typing.Optional[int].
131
+ pagination_offset : typing.Optional[int]
120
132
 
121
- - pagination_offset: typing.Optional[int].
133
+ request_options : typing.Optional[RequestOptions]
134
+ Request-specific configuration.
122
135
 
123
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
124
- ---
136
+ Returns
137
+ -------
138
+ LangchainDocumentsRequestOut
139
+ Successful Response
140
+
141
+ Examples
142
+ --------
125
143
  from athena.client import Athena
126
144
 
127
145
  client = Athena(
@@ -192,21 +210,33 @@ class ToolsClient:
192
210
  request_options: typing.Optional[RequestOptions] = None,
193
211
  ) -> DataFrameRequestOut:
194
212
  """
195
- Parameters:
196
- - document_id: str.
213
+ Parameters
214
+ ----------
215
+ document_id : str
216
+
217
+ row_limit : typing.Optional[int]
197
218
 
198
- - row_limit: typing.Optional[int].
219
+ index_column : typing.Optional[int]
199
220
 
200
- - index_column: typing.Optional[int].
221
+ columns : typing.Optional[typing.Union[ToolsDataFrameRequestColumnsItem, typing.Sequence[ToolsDataFrameRequestColumnsItem]]]
222
+ should be a list of strings or a list of integers
201
223
 
202
- - columns: typing.Optional[typing.Union[ToolsDataFrameRequestColumnsItem, typing.Sequence[ToolsDataFrameRequestColumnsItem]]]. should be a list of strings or a list of integers
224
+ sheet_name : typing.Optional[str]
225
+ only for excel files
203
226
 
204
- - sheet_name: typing.Optional[str]. only for excel files
227
+ separator : typing.Optional[str]
228
+ only for csv files
205
229
 
206
- - separator: typing.Optional[str]. only for csv files
230
+ request_options : typing.Optional[RequestOptions]
231
+ Request-specific configuration.
207
232
 
208
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
209
- ---
233
+ Returns
234
+ -------
235
+ DataFrameRequestOut
236
+ Successful Response
237
+
238
+ Examples
239
+ --------
210
240
  from athena.client import Athena
211
241
 
212
242
  client = Athena(
@@ -274,11 +304,20 @@ class ToolsClient:
274
304
  self, *, document_id: str, request_options: typing.Optional[RequestOptions] = None
275
305
  ) -> typing.Iterator[bytes]:
276
306
  """
277
- Parameters:
278
- - document_id: str.
307
+ Parameters
308
+ ----------
309
+ document_id : str
310
+
311
+ request_options : typing.Optional[RequestOptions]
312
+ Request-specific configuration.
279
313
 
280
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
281
- ---
314
+ Yields
315
+ ------
316
+ typing.Iterator[bytes]
317
+ Stream the file in original format.
318
+
319
+ Examples
320
+ --------
282
321
  from athena.client import Athena
283
322
 
284
323
  client = Athena(
@@ -337,24 +376,33 @@ class ToolsClient:
337
376
  def tool_first_workflow(
338
377
  self,
339
378
  *,
340
- model: typing.Optional[LlmModel] = OMIT,
341
379
  tool_name: str,
342
380
  content: str,
381
+ model: typing.Optional[LlmModel] = OMIT,
343
382
  tool_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
344
383
  request_options: typing.Optional[RequestOptions] = None,
345
384
  ) -> ExcecuteToolFirstWorkflowOut:
346
385
  """
347
- Parameters:
348
- - model: typing.Optional[LlmModel].
386
+ Parameters
387
+ ----------
388
+ tool_name : str
389
+
390
+ content : str
391
+
392
+ model : typing.Optional[LlmModel]
349
393
 
350
- - tool_name: str.
394
+ tool_kwargs : typing.Optional[typing.Dict[str, typing.Any]]
351
395
 
352
- - content: str.
396
+ request_options : typing.Optional[RequestOptions]
397
+ Request-specific configuration.
353
398
 
354
- - tool_kwargs: typing.Optional[typing.Dict[str, typing.Any]].
399
+ Returns
400
+ -------
401
+ ExcecuteToolFirstWorkflowOut
402
+ Successful Response
355
403
 
356
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
357
- ---
404
+ Examples
405
+ --------
358
406
  from athena import LlmModel
359
407
  from athena.client import Athena
360
408
 
@@ -423,21 +471,30 @@ class ToolsClient:
423
471
  request_options: typing.Optional[RequestOptions] = None,
424
472
  ) -> ResearcherOut:
425
473
  """
426
- Parameters:
427
- - query: str.
474
+ Parameters
475
+ ----------
476
+ query : str
477
+
478
+ max_sections : int
479
+
480
+ guidelines : typing.Sequence[str]
428
481
 
429
- - max_sections: int.
482
+ publish_formats : typing.Optional[PublishFormats]
430
483
 
431
- - guidelines: typing.Sequence[str].
484
+ source : typing.Optional[str]
432
485
 
433
- - publish_formats: typing.Optional[PublishFormats].
486
+ athena_document_ids : typing.Optional[typing.Sequence[str]]
434
487
 
435
- - source: typing.Optional[str].
488
+ request_options : typing.Optional[RequestOptions]
489
+ Request-specific configuration.
436
490
 
437
- - athena_document_ids: typing.Optional[typing.Sequence[str]].
491
+ Returns
492
+ -------
493
+ ResearcherOut
494
+ Successful Response
438
495
 
439
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
440
- ---
496
+ Examples
497
+ --------
441
498
  from athena import PublishFormats
442
499
  from athena.client import Athena
443
500
 
@@ -514,11 +571,20 @@ class ToolsClient:
514
571
  self, *, document_id: str, request_options: typing.Optional[RequestOptions] = None
515
572
  ) -> ConvertPdfToSheetOut:
516
573
  """
517
- Parameters:
518
- - document_id: str.
574
+ Parameters
575
+ ----------
576
+ document_id : str
519
577
 
520
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
521
- ---
578
+ request_options : typing.Optional[RequestOptions]
579
+ Request-specific configuration.
580
+
581
+ Returns
582
+ -------
583
+ ConvertPdfToSheetOut
584
+ Successful Response
585
+
586
+ Examples
587
+ --------
522
588
  from athena.client import Athena
523
589
 
524
590
  client = Athena(
@@ -574,13 +640,22 @@ class ToolsClient:
574
640
  request_options: typing.Optional[RequestOptions] = None,
575
641
  ) -> SemanticQueryOut:
576
642
  """
577
- Parameters:
578
- - query: QueryModel.
643
+ Parameters
644
+ ----------
645
+ query : QueryModel
646
+
647
+ table_name : typing.Optional[str]
648
+
649
+ request_options : typing.Optional[RequestOptions]
650
+ Request-specific configuration.
579
651
 
580
- - table_name: typing.Optional[str].
652
+ Returns
653
+ -------
654
+ SemanticQueryOut
655
+ Successful Response
581
656
 
582
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
583
- ---
657
+ Examples
658
+ --------
584
659
  from athena import FilterModel, FilterOperator, QueryModel, TimeDimensionModel
585
660
  from athena.client import Athena
586
661
 
@@ -662,13 +737,22 @@ class AsyncToolsClient:
662
737
  request_options: typing.Optional[RequestOptions] = None,
663
738
  ) -> FirecrawlScrapeUrlDataReponseDto:
664
739
  """
665
- Parameters:
666
- - url: str.
740
+ Parameters
741
+ ----------
742
+ url : str
667
743
 
668
- - params: typing.Optional[typing.Dict[str, typing.Any]].
744
+ params : typing.Optional[typing.Dict[str, typing.Any]]
669
745
 
670
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
671
- ---
746
+ request_options : typing.Optional[RequestOptions]
747
+ Request-specific configuration.
748
+
749
+ Returns
750
+ -------
751
+ FirecrawlScrapeUrlDataReponseDto
752
+ Successful Response
753
+
754
+ Examples
755
+ --------
672
756
  from athena.client import AsyncAthena
673
757
 
674
758
  client = AsyncAthena(
@@ -729,15 +813,24 @@ class AsyncToolsClient:
729
813
  request_options: typing.Optional[RequestOptions] = None,
730
814
  ) -> LangchainDocumentsRequestOut:
731
815
  """
732
- Parameters:
733
- - document_id: str.
816
+ Parameters
817
+ ----------
818
+ document_id : str
819
+
820
+ pagination_limit : typing.Optional[int]
734
821
 
735
- - pagination_limit: typing.Optional[int].
822
+ pagination_offset : typing.Optional[int]
736
823
 
737
- - pagination_offset: typing.Optional[int].
824
+ request_options : typing.Optional[RequestOptions]
825
+ Request-specific configuration.
738
826
 
739
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
740
- ---
827
+ Returns
828
+ -------
829
+ LangchainDocumentsRequestOut
830
+ Successful Response
831
+
832
+ Examples
833
+ --------
741
834
  from athena.client import AsyncAthena
742
835
 
743
836
  client = AsyncAthena(
@@ -808,21 +901,33 @@ class AsyncToolsClient:
808
901
  request_options: typing.Optional[RequestOptions] = None,
809
902
  ) -> DataFrameRequestOut:
810
903
  """
811
- Parameters:
812
- - document_id: str.
904
+ Parameters
905
+ ----------
906
+ document_id : str
907
+
908
+ row_limit : typing.Optional[int]
813
909
 
814
- - row_limit: typing.Optional[int].
910
+ index_column : typing.Optional[int]
815
911
 
816
- - index_column: typing.Optional[int].
912
+ columns : typing.Optional[typing.Union[ToolsDataFrameRequestColumnsItem, typing.Sequence[ToolsDataFrameRequestColumnsItem]]]
913
+ should be a list of strings or a list of integers
817
914
 
818
- - columns: typing.Optional[typing.Union[ToolsDataFrameRequestColumnsItem, typing.Sequence[ToolsDataFrameRequestColumnsItem]]]. should be a list of strings or a list of integers
915
+ sheet_name : typing.Optional[str]
916
+ only for excel files
819
917
 
820
- - sheet_name: typing.Optional[str]. only for excel files
918
+ separator : typing.Optional[str]
919
+ only for csv files
821
920
 
822
- - separator: typing.Optional[str]. only for csv files
921
+ request_options : typing.Optional[RequestOptions]
922
+ Request-specific configuration.
823
923
 
824
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
825
- ---
924
+ Returns
925
+ -------
926
+ DataFrameRequestOut
927
+ Successful Response
928
+
929
+ Examples
930
+ --------
826
931
  from athena.client import AsyncAthena
827
932
 
828
933
  client = AsyncAthena(
@@ -890,11 +995,20 @@ class AsyncToolsClient:
890
995
  self, *, document_id: str, request_options: typing.Optional[RequestOptions] = None
891
996
  ) -> typing.AsyncIterator[bytes]:
892
997
  """
893
- Parameters:
894
- - document_id: str.
998
+ Parameters
999
+ ----------
1000
+ document_id : str
1001
+
1002
+ request_options : typing.Optional[RequestOptions]
1003
+ Request-specific configuration.
895
1004
 
896
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
897
- ---
1005
+ Yields
1006
+ ------
1007
+ typing.AsyncIterator[bytes]
1008
+ Stream the file in original format.
1009
+
1010
+ Examples
1011
+ --------
898
1012
  from athena.client import AsyncAthena
899
1013
 
900
1014
  client = AsyncAthena(
@@ -953,24 +1067,33 @@ class AsyncToolsClient:
953
1067
  async def tool_first_workflow(
954
1068
  self,
955
1069
  *,
956
- model: typing.Optional[LlmModel] = OMIT,
957
1070
  tool_name: str,
958
1071
  content: str,
1072
+ model: typing.Optional[LlmModel] = OMIT,
959
1073
  tool_kwargs: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
960
1074
  request_options: typing.Optional[RequestOptions] = None,
961
1075
  ) -> ExcecuteToolFirstWorkflowOut:
962
1076
  """
963
- Parameters:
964
- - model: typing.Optional[LlmModel].
1077
+ Parameters
1078
+ ----------
1079
+ tool_name : str
1080
+
1081
+ content : str
1082
+
1083
+ model : typing.Optional[LlmModel]
965
1084
 
966
- - tool_name: str.
1085
+ tool_kwargs : typing.Optional[typing.Dict[str, typing.Any]]
967
1086
 
968
- - content: str.
1087
+ request_options : typing.Optional[RequestOptions]
1088
+ Request-specific configuration.
969
1089
 
970
- - tool_kwargs: typing.Optional[typing.Dict[str, typing.Any]].
1090
+ Returns
1091
+ -------
1092
+ ExcecuteToolFirstWorkflowOut
1093
+ Successful Response
971
1094
 
972
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
973
- ---
1095
+ Examples
1096
+ --------
974
1097
  from athena import LlmModel
975
1098
  from athena.client import AsyncAthena
976
1099
 
@@ -1039,21 +1162,30 @@ class AsyncToolsClient:
1039
1162
  request_options: typing.Optional[RequestOptions] = None,
1040
1163
  ) -> ResearcherOut:
1041
1164
  """
1042
- Parameters:
1043
- - query: str.
1165
+ Parameters
1166
+ ----------
1167
+ query : str
1168
+
1169
+ max_sections : int
1170
+
1171
+ guidelines : typing.Sequence[str]
1044
1172
 
1045
- - max_sections: int.
1173
+ publish_formats : typing.Optional[PublishFormats]
1046
1174
 
1047
- - guidelines: typing.Sequence[str].
1175
+ source : typing.Optional[str]
1048
1176
 
1049
- - publish_formats: typing.Optional[PublishFormats].
1177
+ athena_document_ids : typing.Optional[typing.Sequence[str]]
1050
1178
 
1051
- - source: typing.Optional[str].
1179
+ request_options : typing.Optional[RequestOptions]
1180
+ Request-specific configuration.
1052
1181
 
1053
- - athena_document_ids: typing.Optional[typing.Sequence[str]].
1182
+ Returns
1183
+ -------
1184
+ ResearcherOut
1185
+ Successful Response
1054
1186
 
1055
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
1056
- ---
1187
+ Examples
1188
+ --------
1057
1189
  from athena import PublishFormats
1058
1190
  from athena.client import AsyncAthena
1059
1191
 
@@ -1130,11 +1262,20 @@ class AsyncToolsClient:
1130
1262
  self, *, document_id: str, request_options: typing.Optional[RequestOptions] = None
1131
1263
  ) -> ConvertPdfToSheetOut:
1132
1264
  """
1133
- Parameters:
1134
- - document_id: str.
1265
+ Parameters
1266
+ ----------
1267
+ document_id : str
1135
1268
 
1136
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
1137
- ---
1269
+ request_options : typing.Optional[RequestOptions]
1270
+ Request-specific configuration.
1271
+
1272
+ Returns
1273
+ -------
1274
+ ConvertPdfToSheetOut
1275
+ Successful Response
1276
+
1277
+ Examples
1278
+ --------
1138
1279
  from athena.client import AsyncAthena
1139
1280
 
1140
1281
  client = AsyncAthena(
@@ -1190,13 +1331,22 @@ class AsyncToolsClient:
1190
1331
  request_options: typing.Optional[RequestOptions] = None,
1191
1332
  ) -> SemanticQueryOut:
1192
1333
  """
1193
- Parameters:
1194
- - query: QueryModel.
1334
+ Parameters
1335
+ ----------
1336
+ query : QueryModel
1337
+
1338
+ table_name : typing.Optional[str]
1339
+
1340
+ request_options : typing.Optional[RequestOptions]
1341
+ Request-specific configuration.
1195
1342
 
1196
- - table_name: typing.Optional[str].
1343
+ Returns
1344
+ -------
1345
+ SemanticQueryOut
1346
+ Successful Response
1197
1347
 
1198
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
1199
- ---
1348
+ Examples
1349
+ --------
1200
1350
  from athena import FilterModel, FilterOperator, QueryModel, TimeDimensionModel
1201
1351
  from athena.client import AsyncAthena
1202
1352
 
athena/upload/client.py CHANGED
@@ -27,11 +27,21 @@ class UploadClient:
27
27
  self, *, files: typing.List[core.File], request_options: typing.Optional[RequestOptions] = None
28
28
  ) -> UploadDocumentsOut:
29
29
  """
30
- Parameters:
31
- - files: typing.List[core.File]. See core.File for more documentation
30
+ Parameters
31
+ ----------
32
+ files : typing.List[core.File]
33
+ See core.File for more documentation
32
34
 
33
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
34
- ---
35
+ request_options : typing.Optional[RequestOptions]
36
+ Request-specific configuration.
37
+
38
+ Returns
39
+ -------
40
+ UploadDocumentsOut
41
+ Successful Response
42
+
43
+ Examples
44
+ --------
35
45
  from athena.client import Athena
36
46
 
37
47
  client = Athena(
@@ -87,11 +97,21 @@ class AsyncUploadClient:
87
97
  self, *, files: typing.List[core.File], request_options: typing.Optional[RequestOptions] = None
88
98
  ) -> UploadDocumentsOut:
89
99
  """
90
- Parameters:
91
- - files: typing.List[core.File]. See core.File for more documentation
100
+ Parameters
101
+ ----------
102
+ files : typing.List[core.File]
103
+ See core.File for more documentation
104
+
105
+ request_options : typing.Optional[RequestOptions]
106
+ Request-specific configuration.
107
+
108
+ Returns
109
+ -------
110
+ UploadDocumentsOut
111
+ Successful Response
92
112
 
93
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
94
- ---
113
+ Examples
114
+ --------
95
115
  from athena.client import AsyncAthena
96
116
 
97
117
  client = AsyncAthena(