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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
|
%global _empty_manifest_terminate_build 0
Name: python-JarvisAI
Version: 4.8
Release: 1
Summary: JarvisAI is python library to build your own AI virtual assistant with natural language processing.
License: MIT License
URL: https://github.com/Dipeshpal/Jarvis_AI
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a6/11/49c0954223feb2e055f4e3ba92045a5c1e6cb8d0d191e6e0dae55fb98dc5/JarvisAI-4.8.tar.gz
BuildArch: noarch
Requires: python3-numpy
Requires: python3-gtts
Requires: python3-playsound
Requires: python3-pyscreenshot
Requires: python3-opencv-python
Requires: python3-SpeechRecognition
Requires: python3-pyjokes
Requires: python3-wikipedia
Requires: python3-scipy
Requires: python3-lazyme
Requires: python3-requests
Requires: python3-pyttsx3
Requires: python3-spacy
Requires: python3-pywhatkit
Requires: python3-speedtest-cli
Requires: python3-pytube
Requires: python3-pycountry
Requires: python3-pyaudio
Requires: python3-mediapipe
Requires: python3-pycaw
Requires: python3-openai-whisper
Requires: python3-shutup
Requires: python3-sounddevice
Requires: python3-html2text
Requires: python3-wikipedia
Requires: python3-Markdown
Requires: python3-markdown2
Requires: python3-lxml
Requires: python3-googlesearch-python
%description
[](http://jarvis-ai-api.herokuapp.com/)
# Hello, folks! <img src="https://raw.githubusercontent.com/MartinHeinz/MartinHeinz/master/wave.gif" width="30px">
This project is created only for those who are interested in building a Virtual Assistant. Generally, it took lots of time to write code from scratch to build a Virtual Assistant. So, I have built a Library called "JarvisAI", which gives you easy functionality to build your own Virtual Assistant.
# Content-
1. What is JarvisAI?
2. Prerequisite
3. Architecture
4. Getting Started- How to use it?
5. What it can do (Features it supports)
6. Future / Request Features
7. Contribute
8. Contact me
9. Donate
10. Thank me on-
## Premium Plan-
What is our premium plan?
- AI will be able to understand all your commands. It will answer all your questions apart from below basic intent.
- It will be able to handle intent- 'others / Unknown Intent'. Free plan doesn't support this.
- It will be automatically upgraded to use GPT-3 based model in the future. Currently, it uses other advance custom AI models to answer queries.
- Currently unlimited API calls. Later we might change / limit.
- Currently, it doesn't remember the previous context of the chat, but soon it will be. We don't store your
personal chat information.
**Check out our plan: https://jarvisai.in/dashboard**
## YouTube Tutorial-
Click on the image below to watch the tutorial on YouTube-
**Tutorial Latest-**
[](https://www.youtube.com/watch?v=hPE-kdRmYf8)
**Tutorial 1-**
[](https://www.youtube.com/watch?v=p2hdqB11S-8)
**Tutorial 2-**
[](https://www.youtube.com/watch?v=6p8bhNGtVbA)
## **1. What is Jarvis AI?**
Jarvis AI is a Python Module that is able to perform tasks like Chatbot, Assistant, etc. It provides base functionality for any assistant application. This JarvisAI is built using Tensorflow, Pytorch, Transformers, and other open-source libraries and frameworks. Well, you can contribute to this project to make it more powerful.
* Official Website: [Click Here](https://jarvisai.in)
* Official Instagram Page: [Click Here](https://www.instagram.com/_jarvisai_)
## 2. Prerequisite
- Get your Free API key from [https://jarvisai.in](https://jarvisai.in)
- To use it only Python (> 3.6) is required.
- To contribute to the project: Python is the only prerequisite for basic scripting, Machine Learning, and Deep Learning knowledge will help this model to do tasks like AI-ML. Read the How to Contribute section of this page.
## 3. Architecture
The JarvisAI’s architecture is divided into two parts.
1. User End- It is basically responsible for getting input from the user and after preprocessing input it sends input to JarvisAI’s server. And once the server sends its response back, it produces output on the user screen/system.
2. Server Side- The server is responsible to handle various kinds of AI-ML, and NLP tasks. It mainly identifies user intent by analyzing user input and interacting with other external APIs and handling user input.
## 4. Getting Started- How to use it?
#### NOTE: Old version is depreciated use latest version of JarvisAI
### 4.1. Installation-
* Install the latest version-
```bash
pip install JarvisAI
```
#### Optional Steps (Common Installation Issues)-
* [Optional Step] If Pyaudio is not working or not installed you might need to install it separately-
In the case of Mac OSX do the following:
```
brew install portaudio
pip install pyaudio
```
In the case of Windows or Linux do the following:
- Download pyaudio from: lfd.uci.edu/~gohlke/pythonlibs/#pyaudio
- ```pip install PyAudio-0.2.11-cp310-cp310-win_amd64.whl```
* [Optional Step] If pycountry is not working or not installed then Install "python3-pycountry" Package on Ubuntu/Linux-
```
sudo apt-get update -y
sudo apt-get install -y python3-pycountry
```
* [Optional Step] You might need to Install [Microsoft Visual C++ Redistributable for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#microsoft-visual-c-redistributable-for-visual-studio-2022)
### 4.2. Code You Need-
You need only this piece of code-
import JarvisAI
def custom_function(*args, **kwargs):
command = kwargs.get('query')
entities = kwargs.get('entities')
print(entities)
# write your code here to do something with the command
# perform some tasks # return is optional
return command + ' Executed'
jarvis = JarvisAI.JarvisAI(input_mechanism='text', output_mechanism='text',
google_speech_api_key=None, backend_tts_api='pyttsx3',
use_whisper_asr=False, display_logs=False,
api_key='99f605ce-5bf9-4e80-93a3-f367df65aa27')
JarvisAI.add_action('custom_function', custom_function)
jarvis.start()
### 4.3. **What's now?**
It will start your AI, it will ask you to give input and accordingly it will produce output.
You can configure `input_mechanism` and `output_mechanism` parameter for voice input/output or text input/output.
### 4.4. Let's understand the Parameters-
For text input-
input_mechanism='text'
For voice input-
input_mechanism='voice'
For text output-
output_mechanism='text'
For voice output-
output_mechanism='voice'
For voice and text output-
output_mechanism='both'
## 5. What it can do (Features it supports)-
1. Currently, it supports only english language
2. Supports voice and text input/output.
3. Supports AI based voice input (using whisper asr) and by using google api voice input.
4. All intellectual task is process in JarvisAI server so there is no load on your system.
5. Lightweight and able to understand natural language (commands)
6. Ability to add your own custom functions.
### 5.1. Supported Commands-
These are below supported intent that AI can handle, you can ask in natural language.
**Example- "What is the time now", "make me laugh", "click a photo", etc.**
**Note: Some features / command might not work. WIP. Tell me bugs.**
1. asking time
2. asking date
3. greet and hello hi kind of things goodbye
4. tell me joke
5. tell me about
6. i am bored
7. volume control
8. tell me news
9. click photo
10. places near me
11. play on youtube
12. play games
13. what can you do
14. send email
15. download youtube video
16. asking weather
17. take screenshot
18. open website
19. send whatsapp message
20. covid cases
21. check internet speed
22. others / Unknown Intent (Premium Feature)
### 5.2. Supported Input/Output Methods (Which option do I need to choose?)-
You can set below parameter while creating object of JarvisAI-
jarvis = JarvisAI.JarvisAI(input_mechanism='text', output_mechanism='text',
google_speech_api_key=None, backend_tts_api='pyttsx3',
use_whisper_asr=False, display_logs=False,
api_key='99f605ce-5bf9-4e80-93a3-f367df65aa27')
1. **For text input-**'
input_mechanism='text'
2. **For voice input-**
input_mechanism='voice'
3. **For text output-**
output_mechanism='text'
4. **For voice output-**
output_mechanism='voice'
5. **For voice and text output-**
output_mechanism='both'
## 6. Future/Request Features-
**WIP**
**You tell me**
at info@jarvisai.in or my www.dipeshpal.in/social
## 7. Contribute-
1. Clone this repo.
2. Create your file in JarvisAI/JarvisAI/features/<your_file.py>
3. Write entry function like this-
def some_func(*args, **kwargs):
query = kwargs.get("query")
entities = kwargs.get("entities")
li = ['EVENT', 'FAC', 'GPE', 'LANGUAGE', 'LAW', 'LOC', 'MONEY', 'NORP', 'ORDINAL', 'ORG',
'PERCENT', 'PERSON', 'PRODUCT', 'TIME', 'WORK_OF_ART']
topic = [entity[0] for entity in entities if entity[1] in li][0]
return "This Code Done"
- query is the text that is recognized by your microphone
- entities Named Entity Recognition is a technique of natural language processing that is used for the categorization of the data
- Example-
query: who is Narendra Modi
entities: [('Narendra Modi', 'PERSON')]
topic: Narendra Modi
So, now you got the topic from query and now you can play with the topic.
4. Your function can return someting text or perform something. Return text will be automatically print / spoken by your system.
5. In JarvisAI/JarvisAI/features_manager.py , import and add your function like this
try:
from features.your_file import some_func
except Exception as e:
from .features.your_file import some_func
action_map = {
.....
....
'your_intent': some_func
}
6. That's it now raise pull request. I'll verify your code. If working, ethical and all terms are followed, I'll approve.
7. You will become contributer.
## 8. Contact me-
- [Instagram](https://www.instagram.com/dipesh_pal17)
- [YouTube](https://www.youtube.com/dipeshpal17)
## 9. Donate-
Consider donating to JarvisAI to support our mission of keeping our servers running 24/7. Your contribution will enable us to continue doing great things and providing valuable services. Every little bit helps!
[Click Here to support](https://www.instamojo.com/@techport/)
**_Feel free to use my code, don't forget to mention credit. All the contributors will get credits in this repo._**
**_Mention below line for credits-_**
***Credits-***
- [https://jarvisai.in](https://jarvisai.in)
- [https://github.com/Dipeshpal/Jarvis_AI](https://github.com/Dipeshpal/Jarvis_AI)
- [https://www.youtube.com/dipeshpal17](https://www.youtube.com/dipeshpal17)
- [https://www.instagram.com/dipesh_pal17](https://www.instagram.com/_dipeshpal_)
## 10. Thank me on-
- Follow me on Instagram: [https://www.instagram.com/dipesh_pal17](https://www.instagram.com/_dipeshpal_)
- Subscribe me on YouTube: [https://www.youtube.com/dipeshpal17](https://www.youtube.com/dipeshpal17)
## License
[MIT](https://choosealicense.com/licenses/mit/)
%package -n python3-JarvisAI
Summary: JarvisAI is python library to build your own AI virtual assistant with natural language processing.
Provides: python-JarvisAI
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-JarvisAI
[](http://jarvis-ai-api.herokuapp.com/)
# Hello, folks! <img src="https://raw.githubusercontent.com/MartinHeinz/MartinHeinz/master/wave.gif" width="30px">
This project is created only for those who are interested in building a Virtual Assistant. Generally, it took lots of time to write code from scratch to build a Virtual Assistant. So, I have built a Library called "JarvisAI", which gives you easy functionality to build your own Virtual Assistant.
# Content-
1. What is JarvisAI?
2. Prerequisite
3. Architecture
4. Getting Started- How to use it?
5. What it can do (Features it supports)
6. Future / Request Features
7. Contribute
8. Contact me
9. Donate
10. Thank me on-
## Premium Plan-
What is our premium plan?
- AI will be able to understand all your commands. It will answer all your questions apart from below basic intent.
- It will be able to handle intent- 'others / Unknown Intent'. Free plan doesn't support this.
- It will be automatically upgraded to use GPT-3 based model in the future. Currently, it uses other advance custom AI models to answer queries.
- Currently unlimited API calls. Later we might change / limit.
- Currently, it doesn't remember the previous context of the chat, but soon it will be. We don't store your
personal chat information.
**Check out our plan: https://jarvisai.in/dashboard**
## YouTube Tutorial-
Click on the image below to watch the tutorial on YouTube-
**Tutorial Latest-**
[](https://www.youtube.com/watch?v=hPE-kdRmYf8)
**Tutorial 1-**
[](https://www.youtube.com/watch?v=p2hdqB11S-8)
**Tutorial 2-**
[](https://www.youtube.com/watch?v=6p8bhNGtVbA)
## **1. What is Jarvis AI?**
Jarvis AI is a Python Module that is able to perform tasks like Chatbot, Assistant, etc. It provides base functionality for any assistant application. This JarvisAI is built using Tensorflow, Pytorch, Transformers, and other open-source libraries and frameworks. Well, you can contribute to this project to make it more powerful.
* Official Website: [Click Here](https://jarvisai.in)
* Official Instagram Page: [Click Here](https://www.instagram.com/_jarvisai_)
## 2. Prerequisite
- Get your Free API key from [https://jarvisai.in](https://jarvisai.in)
- To use it only Python (> 3.6) is required.
- To contribute to the project: Python is the only prerequisite for basic scripting, Machine Learning, and Deep Learning knowledge will help this model to do tasks like AI-ML. Read the How to Contribute section of this page.
## 3. Architecture
The JarvisAI’s architecture is divided into two parts.
1. User End- It is basically responsible for getting input from the user and after preprocessing input it sends input to JarvisAI’s server. And once the server sends its response back, it produces output on the user screen/system.
2. Server Side- The server is responsible to handle various kinds of AI-ML, and NLP tasks. It mainly identifies user intent by analyzing user input and interacting with other external APIs and handling user input.
## 4. Getting Started- How to use it?
#### NOTE: Old version is depreciated use latest version of JarvisAI
### 4.1. Installation-
* Install the latest version-
```bash
pip install JarvisAI
```
#### Optional Steps (Common Installation Issues)-
* [Optional Step] If Pyaudio is not working or not installed you might need to install it separately-
In the case of Mac OSX do the following:
```
brew install portaudio
pip install pyaudio
```
In the case of Windows or Linux do the following:
- Download pyaudio from: lfd.uci.edu/~gohlke/pythonlibs/#pyaudio
- ```pip install PyAudio-0.2.11-cp310-cp310-win_amd64.whl```
* [Optional Step] If pycountry is not working or not installed then Install "python3-pycountry" Package on Ubuntu/Linux-
```
sudo apt-get update -y
sudo apt-get install -y python3-pycountry
```
* [Optional Step] You might need to Install [Microsoft Visual C++ Redistributable for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#microsoft-visual-c-redistributable-for-visual-studio-2022)
### 4.2. Code You Need-
You need only this piece of code-
import JarvisAI
def custom_function(*args, **kwargs):
command = kwargs.get('query')
entities = kwargs.get('entities')
print(entities)
# write your code here to do something with the command
# perform some tasks # return is optional
return command + ' Executed'
jarvis = JarvisAI.JarvisAI(input_mechanism='text', output_mechanism='text',
google_speech_api_key=None, backend_tts_api='pyttsx3',
use_whisper_asr=False, display_logs=False,
api_key='99f605ce-5bf9-4e80-93a3-f367df65aa27')
JarvisAI.add_action('custom_function', custom_function)
jarvis.start()
### 4.3. **What's now?**
It will start your AI, it will ask you to give input and accordingly it will produce output.
You can configure `input_mechanism` and `output_mechanism` parameter for voice input/output or text input/output.
### 4.4. Let's understand the Parameters-
For text input-
input_mechanism='text'
For voice input-
input_mechanism='voice'
For text output-
output_mechanism='text'
For voice output-
output_mechanism='voice'
For voice and text output-
output_mechanism='both'
## 5. What it can do (Features it supports)-
1. Currently, it supports only english language
2. Supports voice and text input/output.
3. Supports AI based voice input (using whisper asr) and by using google api voice input.
4. All intellectual task is process in JarvisAI server so there is no load on your system.
5. Lightweight and able to understand natural language (commands)
6. Ability to add your own custom functions.
### 5.1. Supported Commands-
These are below supported intent that AI can handle, you can ask in natural language.
**Example- "What is the time now", "make me laugh", "click a photo", etc.**
**Note: Some features / command might not work. WIP. Tell me bugs.**
1. asking time
2. asking date
3. greet and hello hi kind of things goodbye
4. tell me joke
5. tell me about
6. i am bored
7. volume control
8. tell me news
9. click photo
10. places near me
11. play on youtube
12. play games
13. what can you do
14. send email
15. download youtube video
16. asking weather
17. take screenshot
18. open website
19. send whatsapp message
20. covid cases
21. check internet speed
22. others / Unknown Intent (Premium Feature)
### 5.2. Supported Input/Output Methods (Which option do I need to choose?)-
You can set below parameter while creating object of JarvisAI-
jarvis = JarvisAI.JarvisAI(input_mechanism='text', output_mechanism='text',
google_speech_api_key=None, backend_tts_api='pyttsx3',
use_whisper_asr=False, display_logs=False,
api_key='99f605ce-5bf9-4e80-93a3-f367df65aa27')
1. **For text input-**'
input_mechanism='text'
2. **For voice input-**
input_mechanism='voice'
3. **For text output-**
output_mechanism='text'
4. **For voice output-**
output_mechanism='voice'
5. **For voice and text output-**
output_mechanism='both'
## 6. Future/Request Features-
**WIP**
**You tell me**
at info@jarvisai.in or my www.dipeshpal.in/social
## 7. Contribute-
1. Clone this repo.
2. Create your file in JarvisAI/JarvisAI/features/<your_file.py>
3. Write entry function like this-
def some_func(*args, **kwargs):
query = kwargs.get("query")
entities = kwargs.get("entities")
li = ['EVENT', 'FAC', 'GPE', 'LANGUAGE', 'LAW', 'LOC', 'MONEY', 'NORP', 'ORDINAL', 'ORG',
'PERCENT', 'PERSON', 'PRODUCT', 'TIME', 'WORK_OF_ART']
topic = [entity[0] for entity in entities if entity[1] in li][0]
return "This Code Done"
- query is the text that is recognized by your microphone
- entities Named Entity Recognition is a technique of natural language processing that is used for the categorization of the data
- Example-
query: who is Narendra Modi
entities: [('Narendra Modi', 'PERSON')]
topic: Narendra Modi
So, now you got the topic from query and now you can play with the topic.
4. Your function can return someting text or perform something. Return text will be automatically print / spoken by your system.
5. In JarvisAI/JarvisAI/features_manager.py , import and add your function like this
try:
from features.your_file import some_func
except Exception as e:
from .features.your_file import some_func
action_map = {
.....
....
'your_intent': some_func
}
6. That's it now raise pull request. I'll verify your code. If working, ethical and all terms are followed, I'll approve.
7. You will become contributer.
## 8. Contact me-
- [Instagram](https://www.instagram.com/dipesh_pal17)
- [YouTube](https://www.youtube.com/dipeshpal17)
## 9. Donate-
Consider donating to JarvisAI to support our mission of keeping our servers running 24/7. Your contribution will enable us to continue doing great things and providing valuable services. Every little bit helps!
[Click Here to support](https://www.instamojo.com/@techport/)
**_Feel free to use my code, don't forget to mention credit. All the contributors will get credits in this repo._**
**_Mention below line for credits-_**
***Credits-***
- [https://jarvisai.in](https://jarvisai.in)
- [https://github.com/Dipeshpal/Jarvis_AI](https://github.com/Dipeshpal/Jarvis_AI)
- [https://www.youtube.com/dipeshpal17](https://www.youtube.com/dipeshpal17)
- [https://www.instagram.com/dipesh_pal17](https://www.instagram.com/_dipeshpal_)
## 10. Thank me on-
- Follow me on Instagram: [https://www.instagram.com/dipesh_pal17](https://www.instagram.com/_dipeshpal_)
- Subscribe me on YouTube: [https://www.youtube.com/dipeshpal17](https://www.youtube.com/dipeshpal17)
## License
[MIT](https://choosealicense.com/licenses/mit/)
%package help
Summary: Development documents and examples for JarvisAI
Provides: python3-JarvisAI-doc
%description help
[](http://jarvis-ai-api.herokuapp.com/)
# Hello, folks! <img src="https://raw.githubusercontent.com/MartinHeinz/MartinHeinz/master/wave.gif" width="30px">
This project is created only for those who are interested in building a Virtual Assistant. Generally, it took lots of time to write code from scratch to build a Virtual Assistant. So, I have built a Library called "JarvisAI", which gives you easy functionality to build your own Virtual Assistant.
# Content-
1. What is JarvisAI?
2. Prerequisite
3. Architecture
4. Getting Started- How to use it?
5. What it can do (Features it supports)
6. Future / Request Features
7. Contribute
8. Contact me
9. Donate
10. Thank me on-
## Premium Plan-
What is our premium plan?
- AI will be able to understand all your commands. It will answer all your questions apart from below basic intent.
- It will be able to handle intent- 'others / Unknown Intent'. Free plan doesn't support this.
- It will be automatically upgraded to use GPT-3 based model in the future. Currently, it uses other advance custom AI models to answer queries.
- Currently unlimited API calls. Later we might change / limit.
- Currently, it doesn't remember the previous context of the chat, but soon it will be. We don't store your
personal chat information.
**Check out our plan: https://jarvisai.in/dashboard**
## YouTube Tutorial-
Click on the image below to watch the tutorial on YouTube-
**Tutorial Latest-**
[](https://www.youtube.com/watch?v=hPE-kdRmYf8)
**Tutorial 1-**
[](https://www.youtube.com/watch?v=p2hdqB11S-8)
**Tutorial 2-**
[](https://www.youtube.com/watch?v=6p8bhNGtVbA)
## **1. What is Jarvis AI?**
Jarvis AI is a Python Module that is able to perform tasks like Chatbot, Assistant, etc. It provides base functionality for any assistant application. This JarvisAI is built using Tensorflow, Pytorch, Transformers, and other open-source libraries and frameworks. Well, you can contribute to this project to make it more powerful.
* Official Website: [Click Here](https://jarvisai.in)
* Official Instagram Page: [Click Here](https://www.instagram.com/_jarvisai_)
## 2. Prerequisite
- Get your Free API key from [https://jarvisai.in](https://jarvisai.in)
- To use it only Python (> 3.6) is required.
- To contribute to the project: Python is the only prerequisite for basic scripting, Machine Learning, and Deep Learning knowledge will help this model to do tasks like AI-ML. Read the How to Contribute section of this page.
## 3. Architecture
The JarvisAI’s architecture is divided into two parts.
1. User End- It is basically responsible for getting input from the user and after preprocessing input it sends input to JarvisAI’s server. And once the server sends its response back, it produces output on the user screen/system.
2. Server Side- The server is responsible to handle various kinds of AI-ML, and NLP tasks. It mainly identifies user intent by analyzing user input and interacting with other external APIs and handling user input.
## 4. Getting Started- How to use it?
#### NOTE: Old version is depreciated use latest version of JarvisAI
### 4.1. Installation-
* Install the latest version-
```bash
pip install JarvisAI
```
#### Optional Steps (Common Installation Issues)-
* [Optional Step] If Pyaudio is not working or not installed you might need to install it separately-
In the case of Mac OSX do the following:
```
brew install portaudio
pip install pyaudio
```
In the case of Windows or Linux do the following:
- Download pyaudio from: lfd.uci.edu/~gohlke/pythonlibs/#pyaudio
- ```pip install PyAudio-0.2.11-cp310-cp310-win_amd64.whl```
* [Optional Step] If pycountry is not working or not installed then Install "python3-pycountry" Package on Ubuntu/Linux-
```
sudo apt-get update -y
sudo apt-get install -y python3-pycountry
```
* [Optional Step] You might need to Install [Microsoft Visual C++ Redistributable for Visual Studio 2022](https://visualstudio.microsoft.com/downloads/#microsoft-visual-c-redistributable-for-visual-studio-2022)
### 4.2. Code You Need-
You need only this piece of code-
import JarvisAI
def custom_function(*args, **kwargs):
command = kwargs.get('query')
entities = kwargs.get('entities')
print(entities)
# write your code here to do something with the command
# perform some tasks # return is optional
return command + ' Executed'
jarvis = JarvisAI.JarvisAI(input_mechanism='text', output_mechanism='text',
google_speech_api_key=None, backend_tts_api='pyttsx3',
use_whisper_asr=False, display_logs=False,
api_key='99f605ce-5bf9-4e80-93a3-f367df65aa27')
JarvisAI.add_action('custom_function', custom_function)
jarvis.start()
### 4.3. **What's now?**
It will start your AI, it will ask you to give input and accordingly it will produce output.
You can configure `input_mechanism` and `output_mechanism` parameter for voice input/output or text input/output.
### 4.4. Let's understand the Parameters-
For text input-
input_mechanism='text'
For voice input-
input_mechanism='voice'
For text output-
output_mechanism='text'
For voice output-
output_mechanism='voice'
For voice and text output-
output_mechanism='both'
## 5. What it can do (Features it supports)-
1. Currently, it supports only english language
2. Supports voice and text input/output.
3. Supports AI based voice input (using whisper asr) and by using google api voice input.
4. All intellectual task is process in JarvisAI server so there is no load on your system.
5. Lightweight and able to understand natural language (commands)
6. Ability to add your own custom functions.
### 5.1. Supported Commands-
These are below supported intent that AI can handle, you can ask in natural language.
**Example- "What is the time now", "make me laugh", "click a photo", etc.**
**Note: Some features / command might not work. WIP. Tell me bugs.**
1. asking time
2. asking date
3. greet and hello hi kind of things goodbye
4. tell me joke
5. tell me about
6. i am bored
7. volume control
8. tell me news
9. click photo
10. places near me
11. play on youtube
12. play games
13. what can you do
14. send email
15. download youtube video
16. asking weather
17. take screenshot
18. open website
19. send whatsapp message
20. covid cases
21. check internet speed
22. others / Unknown Intent (Premium Feature)
### 5.2. Supported Input/Output Methods (Which option do I need to choose?)-
You can set below parameter while creating object of JarvisAI-
jarvis = JarvisAI.JarvisAI(input_mechanism='text', output_mechanism='text',
google_speech_api_key=None, backend_tts_api='pyttsx3',
use_whisper_asr=False, display_logs=False,
api_key='99f605ce-5bf9-4e80-93a3-f367df65aa27')
1. **For text input-**'
input_mechanism='text'
2. **For voice input-**
input_mechanism='voice'
3. **For text output-**
output_mechanism='text'
4. **For voice output-**
output_mechanism='voice'
5. **For voice and text output-**
output_mechanism='both'
## 6. Future/Request Features-
**WIP**
**You tell me**
at info@jarvisai.in or my www.dipeshpal.in/social
## 7. Contribute-
1. Clone this repo.
2. Create your file in JarvisAI/JarvisAI/features/<your_file.py>
3. Write entry function like this-
def some_func(*args, **kwargs):
query = kwargs.get("query")
entities = kwargs.get("entities")
li = ['EVENT', 'FAC', 'GPE', 'LANGUAGE', 'LAW', 'LOC', 'MONEY', 'NORP', 'ORDINAL', 'ORG',
'PERCENT', 'PERSON', 'PRODUCT', 'TIME', 'WORK_OF_ART']
topic = [entity[0] for entity in entities if entity[1] in li][0]
return "This Code Done"
- query is the text that is recognized by your microphone
- entities Named Entity Recognition is a technique of natural language processing that is used for the categorization of the data
- Example-
query: who is Narendra Modi
entities: [('Narendra Modi', 'PERSON')]
topic: Narendra Modi
So, now you got the topic from query and now you can play with the topic.
4. Your function can return someting text or perform something. Return text will be automatically print / spoken by your system.
5. In JarvisAI/JarvisAI/features_manager.py , import and add your function like this
try:
from features.your_file import some_func
except Exception as e:
from .features.your_file import some_func
action_map = {
.....
....
'your_intent': some_func
}
6. That's it now raise pull request. I'll verify your code. If working, ethical and all terms are followed, I'll approve.
7. You will become contributer.
## 8. Contact me-
- [Instagram](https://www.instagram.com/dipesh_pal17)
- [YouTube](https://www.youtube.com/dipeshpal17)
## 9. Donate-
Consider donating to JarvisAI to support our mission of keeping our servers running 24/7. Your contribution will enable us to continue doing great things and providing valuable services. Every little bit helps!
[Click Here to support](https://www.instamojo.com/@techport/)
**_Feel free to use my code, don't forget to mention credit. All the contributors will get credits in this repo._**
**_Mention below line for credits-_**
***Credits-***
- [https://jarvisai.in](https://jarvisai.in)
- [https://github.com/Dipeshpal/Jarvis_AI](https://github.com/Dipeshpal/Jarvis_AI)
- [https://www.youtube.com/dipeshpal17](https://www.youtube.com/dipeshpal17)
- [https://www.instagram.com/dipesh_pal17](https://www.instagram.com/_dipeshpal_)
## 10. Thank me on-
- Follow me on Instagram: [https://www.instagram.com/dipesh_pal17](https://www.instagram.com/_dipeshpal_)
- Subscribe me on YouTube: [https://www.youtube.com/dipeshpal17](https://www.youtube.com/dipeshpal17)
## License
[MIT](https://choosealicense.com/licenses/mit/)
%prep
%autosetup -n JarvisAI-4.8
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-JarvisAI -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 4.8-1
- Package Spec generated
|
