From 8fa9fdcd5ac10a331a1ef1dd5ef22434ffd01887 Mon Sep 17 00:00:00 2001 From: Jon Taylor Date: Sun, 12 May 2024 18:37:07 +0100 Subject: [PATCH] Reworked readme to have more pipes and cats --- README.md | 153 +++++++++++++++-------- image.png | Bin 0 -> 12851 bytes pyproject.toml | 2 +- src/pipecat/services/anthropic.py | 2 +- src/pipecat/services/azure.py | 2 +- src/pipecat/services/fal.py | 2 +- src/pipecat/services/fireworks.py | 2 +- src/pipecat/services/moondream.py | 2 +- src/pipecat/services/openai.py | 2 +- src/pipecat/services/playht.py | 2 +- src/pipecat/services/whisper.py | 2 +- src/pipecat/transports/local/audio.py | 2 +- src/pipecat/transports/local/tk.py | 2 +- src/pipecat/transports/services/daily.py | 2 +- src/pipecat/vad/silero.py | 2 +- 15 files changed, 111 insertions(+), 68 deletions(-) create mode 100644 image.png diff --git a/README.md b/README.md index 331d27b2d..02bab7547 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,33 @@ -[![PyPI](https://img.shields.io/pypi/v/pipecat-ai)](https://pypi.org/project/pipecat-ai) +
+ pipecat +
-# Pipecat — an open source framework for voice (and multimodal) assistants +# Pipecat + +[![PyPI](https://img.shields.io/pypi/v/dailyai)](https://pypi.org/project/dailyai) + +`pipecat` is a framework for building voice (and multimodal) conversational agents. Things like personal coaches, meeting assistants, story-telling toys for kids, customer support bots, and snarky social companions. Build things like this: [![AI-powered voice patient intake for healthcare](https://img.youtube.com/vi/lDevgsp9vn0/0.jpg)](https://www.youtube.com/watch?v=lDevgsp9vn0) -[ [pipecat starter kits repository](https://github.com/daily-co/pipecat-examples) ] +## Getting started with voice agents -**`Pipecat` started as a toolkit for implementing generative AI voice bots.** Things like personal coaches, meeting assistants, story-telling toys for kids, customer support bots, and snarky social companions. +You can get started with Pipecat running on your local machine, then move your agent processes to the cloud when you’re ready. You can also add a telephone number, image output, video input, use different LLMs, and more. -In 2023 a _lot_ of us got excited about the possibility of having open-ended conversations with LLMs. It became clear pretty quickly that we were all solving the same [low-level problems](https://www.daily.co/blog/how-to-talk-to-an-llm-with-your-voice/): - -- low-latency, reliable audio transport -- echo cancellation -- phrase endpointing (knowing when the bot should respond to human speech) -- interruptibility -- writing clean code to stream data through "pipelines" of speech-to-text, LLM inference, and text-to-speech models - -As our applications expanded to include additional things like image generation, function calling, and vision models, we started to think about what a complete framework for these kinds of apps could look like. - -Today, `pipecat` is: - -1. a set of code building blocks for interacting with generative AI services and creating low-latency, interruptible data pipelines that use multiple services -2. transport services that moves audio, video, and events across the Internet -3. implementations of specific generative AI services - -Currently implemented services: - -- Speech-to-text - - Deepgram - - Whisper -- LLMs - - Azure - - Fireworks - - OpenAI -- Image generation - - Azure - - Fal - - OpenAI -- Text-to-speech - - Azure - - Deepgram - - ElevenLabs -- Transport - - Daily - - Local -- Vision - - Moondream - -If you'd like to [implement a service](<(https://github.com/daily-co/pipecat/tree/main/src/pipecat/services)>), we welcome PRs! Our goal is to support lots of services in all of the above categories, plus new categories (like real-time video) as they emerge. - -## Getting started - -Today, the easiest way to get started with `pipecat` is to use [Daily](https://www.daily.co/) as your transport service. This toolkit started life as an internal SDK at Daily and millions of minutes of AI conversation have been served using it and its earlier prototype incarnations. - -``` +```shell # install the module -pip install pipecat +pip install pipecat-ai # set up an .env file with API keys cp dot-env.template .env ``` -By default, in order to minimize dependencies, only the basic framework functionality is available. Some third-party AI services require additional -dependencies that you can install with: +By default, in order to minimize dependencies, only the basic framework functionality is available. Some third-party AI services require additional dependencies that you can install with: -``` -pip install "pipecat[option,...]" +```shell +pip install "pipecat-ai[option,...]" ``` Your project may or may not need these, so they're made available as optional requirements. Here is a list: @@ -75,6 +35,89 @@ Your project may or may not need these, so they're made available as optional re - **AI services**: `anthropic`, `azure`, `fal`, `moondream`, `openai`, `playht`, `silero`, `whisper` - **Transports**: `daily`, `local`, `websocket` +## A simple voice agent running locally + +If you’re doing AI-related stuff, you probably have an OpenAI API key. + +To generate voice output, one service that’s easy to get started with is ElevenLabs. If you don’t already have an ElevenLabs developer account, you can sign up for one [here]. + +So let’s run a really simple agent that’s just a GPT-4 prompt, wired up to voice input and speaker output. + +You can change the prompt, in the code. The current prompt is “Tell me something interesting about the Roman Empire.” + +`cd examples/getting-started` to run the following examples … + +```shell +# Talk to a local pipecat process with your voice. Specify GPT-4 as the LLM. + +export OPENAI_API_KEY=... +export ELEVENLABS_API_KEY=... +python ./local-mic.py | ./pipecat-pipes-gpt-4.py | ./local-speaker.py +``` + +## WebSockets instead of pipes + +To run your agent in the cloud, you can switch the Pipecat transport layer to use a WebSocket instead of Unix pipes. + +```shell +# Talk to a local pipecat process with your voice. Specify GPT-4 as the LLM. + +export OPENAI_API_KEY=... +export ELEVENLABS_API_KEY=... +python ./local-mic-and-speaker-wss.py wss://localhost:8088 +``` + +## WebRTC for production use + +WebSockets are fine for server-to-server communication or for initial development. But for production use, you’ll need client-server audio to use a protocol designed for real-time media transport. (For an explanation of the difference between WebSockets and WebRTC, see [this post.]) + +One way to get up and running quickly with WebRTC is to sign up for a Daily developer account. Daily gives you SDKs and global infrastructure for audio (and video) routing. Every account gets 10,000 audio/video/transcription minutes free each month. + +Sign up [here](https://dashboard.daily.co/u/signup) and [create a room](https://docs.daily.co/reference/rest-api/rooms) in the developer Dashboard. Then run the examples, this time connecting via WebRTC instead of a WebSocket. + +```shell +# 1. Run the pipecat process. Provide your Daily API key and a Daily room +export DAILY_API_KEY=... +export OPENAI_API_KEY=... +export ELEVENLABS_API_KEY=... +python pipecat-daily-gpt-4.py --daily-room https://example.daily.co/pipecat + +# 2. Visit the Daily room link in any web browser to talk to the pipecat process. +# You'll want to use a Daily SDK to embed the client-side code into your own +# app. But visiting the room URL in a browser is a quick way to start building +# agents because you can focus on just the agent code at first. +open -a "Google Chrome" https://example.daily.co/pipecat +``` + +## Deploy your agent to the cloud +Now that you’ve decoupled client and server, and have a Pipecat process that can run anywhere you can run Python, you can deploy this example agent to the cloud. + +`TBC` + +## Taking it further + +### Add a telephone number +Daily supports telephone connections in addition to WebRTC streams. You can add a telephone number to your Daily room with the following REST API call. Once you’ve done that, you can call your agent on the phone. + +You’ll need to add a credit card to your Daily account to enable telephone numbers. + +`TBC` + + +### Add image output + +Daily supports telephone connections in addition to WebRTC streams. You can add a telephone number to your Daily room with the following REST API call. Once you’ve done that, you can call your agent on the phone. + +You’ll need to add a credit card to your Daily account to enable telephone numbers. + +`TBC` + +### Add video output + + +`TBC` + + ## Code examples There are two directories of examples: diff --git a/image.png b/image.png new file mode 100644 index 0000000000000000000000000000000000000000..912360f2ca695e0d5c088b56ebd70c10f99babb9 GIT binary patch literal 12851 zcmch7cU05O({DgjP!R-qsM4e;RZu{sNz>4kUZgyRBB3c&N`OZZL3#}xR9ZrBp%>+m z7K$J(RFx81KnOjQyTRXk-+RtI_niCBy>LAE-JRW?ot>Te%qhp`W# zzI5eB6vP)}e}9|WxMtk>x~5s~!2rU_xcZW_lY=2DXM54YwYQt97f*b%uwYa6+kH$*Dwt z!q3}BlZOQ%Hc*F`;uRAAVKoTllcNMpCU->@+j6{ZxzAnUrHKX&5HSz4a|{C8Y`juG z2bA2280yp30RG;ZtZm%wrJBJv0&?{uPAItpBPu9)K;ayGdnPWQ&-kYNm=FITZm`;b z>l#@akP**uCta^8e?R*~sQvJx(p2&2a0m_Pu+~4{>*b$Rx!R*66x-*^^=IYf`_34@ zhQ-7oAAUVXZh5$i&ihm9Y|I-wS%*zzel9G-h&LnA(DRs^JpB!EyGk5(Fjhx7r&8>v zL*`L7xwTCA(Y*b40#|OuGS8st$tSvAufo%I$Nbzk3hIU`e6&>*pyAxlDuc^$=(kWx zKJXQ!bWfD&O^y&x+#d#GbTo6h9aiYogQ!67t>^i<$}v@jp&njLn0Vd?WXZ8qh|k-{ zRBaee1PD*~nE#Q5ig)2*&r4~{%g{Sn{aG?HbYyjgzuniwvWvrpKh@FPjim=Aii)HY~P{opWS2Mnd@6O)>iGV-2|TiL zN*oYD9(RA5S3HE>GmpQ8aCIpm-$TgGRJ2`#L|U&K$(w)BH0;mW2SIf_3Xj@0-7t^H z>qCxrMh(Z4RC3J!^JRRps-~N>?;r4O(qEWN@LP8&++*B`7o|*=!Vg|=V%AL33AqP? z7kM8&PQPSFW-}*hcZm?AZ3cNi74vAm=R0| zxC!&b30IN_{}v9{$T^iV1Zf@&ZDA(&*G>j*tCH8WW{NzOgo%16S;(#MN}o?;f>!ZE zBl2JCvplC03ey0S3NHPB$TXD6st++@;3Y3n7Dw+uceJt>Z~9Yu2~iuGqHil0A! z{_J8BUJz)UhfwT}Dw^44rWr9$18?-(b=h#;bp2=TRRCZc_WQ*0&V~4-T!|B+;)(w8 z`pI!=k?_ev;K^)NuUyo)Ad(Mdh5ZanI1JTnhd-=s4wWwCXNt zk33qx^*=k8ud8<3evOWf#ul5`Tv%-o5pF<`yu^(qJj~8RAobaT48t}R>FA5{reoed zm*+H`5T}OB;z`(@CkO-H>dTiecXxGleUzlx(Prn~X3e`_3{=jN} zz*r%Wu}8{$UK-oyVEO3F;L8|%i6Lw<<^7DTBivROSODM{lTqgLjV-L6uUNb#aL>+t z6{zd#bsmN$pN(H{xx)rJ%Tr;0fqP}uyHIjgUcC}m6rm<0%PH?`U|lfX5@^M#81S_H zi^DYtWbrkzw%bc()fX9$VjV zJBy)$!WtOTzTXF`dsaS{CD_0x;$=mjN2C#^I@jJMje|7Kzu?I5pO5Ck8OXCh}CSPxkYuCsI@K` zcNX0eyT87MgDF~D>h4ddMiQ2tkm`nmpB_bD@E{zKcIP){J8Uof_c;jh=%uHpCy+O^ zsByqG)r@G+di#f6ERIDEX_~J|Fr=Vp7c)-sCoc5j)GgnGt))b(>+aKgR2C!zQ}5mK^HzGr>RH&3S{kMVi4(Gm-D|BQ*7 zK0B+XK1TBly(aP{SHhB_YQd2I_PIKSSy+hMSLxnZQ~nNUR{V_Iql2RHGb8b>B0PGp@jTK$b#EwyWYIvhqUpnm z=NQN7xD>XG4%Q_JMT6&{#!XwE&OR=4_dbqNN9gu(p|~4g&bDWN$q`$7)EA4$5Tpp& zpyw^G){4`ooH33`kok^+ZZ05+2bWn%0WOejKCSNkoPPdE2n4~%`$TPK_^+F7x-nGP zgCdT_1`WCbaeTap`$_{P#!E3L>AgC{I`QOc0UyH3vdOnPxptRFUc~Kd?d18+@)sT+ z1_yDoFCvh%=ZzfGBJe($!u5pl-ZU9a=RRYI)2H@#!V3P^&hs!B&NGguKd@}}H$8}1 z_`1(0h19bToZnlijP;Cakz)>8f+O`>UTr+Xm)`S<&nQIk_n>p5Z(Rynf}XTG*M0eY zw`XBzh;JJ~v(boJ6NbK4u$4@iJuyBA2>2o}zRZ4H9L;@GJ{4|wywHY>k7vw+oGB}3 zTX$`GckR4wnti58&;lzD>vBn$C*ooX057JgSw?kd1}#=O8@n(E|q zP?C5%e1*;g9VOsTN`zkk=h@)7cm41jWP}G$+>G}2aoK3-;tofZ&h3*%X?(XEKpNH-Y>v7^-`I8o_BU+@ zVzxV?xz6T&q*Wiaz@W;dVFrceUdquH!6kLRW|3H0SKesxNVI#@Snkep0nV6NerK}O zfQx@|d>e7bdi>7FG#BtfY`^%b7ZPo(sVjn=`#e z@uAPgU9XLQ9==XBAZ^*+Q`NLifT+KqdSDz3C8>nod7_e$lZV@>wC}$VVIhWZa=2~A z!vMQ8LchfO=+UG3*^cN8alA(Evtr=_iq;sK*qwKo&{YG4l-@b^cBeE5&7zeMwYzPl z>r8X;u;z1%hGsK%$b->f=;~8}8ARX(+O+#*Ie%8Q2{UFF@Epj$Ic(nGR6z^*CIt+8 zC&O#cv@0qzZasGD0=GnIVi@>5pWG~Dqk$wdfbN&39_@S`a5jfC-xGz}#+BmWK#Cf{ z(5<{Cxq9xf4_Jw1leb6T)M9eTBQAgu@Iu+AUdbOAyuKW($0S@-8rq!4A~(S%C?U7J zfOkPE+)kpAFmR|Be(?H;xIA14Zz3^pHwB(F1H7LBjCd^o1ixryFR4d$J-xs&rYmKI zjEai70OAIkSe6KpYm2|S@0Nvegi9eSA+zyxcPoai)!8Ap&MNbr<44>e`=V^!ckkYX z!>(kHykjSChynx>ffp|IGz_UsxuH_J21rQ5aM0+uyC z5hiL}t$g)D#OBT_7(Y8>k~IBXN;zk|)IkcJR-axwS{o=OP=oWP`R!&UZEBQEiV>yw zks<3%rHOpLy9*EjGc2=I=H9}@Z!uWrMqh23zg5Xdt@!zTR$`ir>xHI%8!g4aDLWe0e`eE>a~JDxDZn*7rjc7gNj!A;fT?PYilel=#y)QNjZHRGe#c{23fvg!jS zEu5>Z9QS1^Bg2*ty6S}Qr9|!X*|B#d!JLrdlNO4ci(eGpL7%LsM5Z!I@C>%t`U8VL ziQC`)xIy~;v(10Tre$mUScJ#2?>dR)*Y>?N8vV`5RCr7c2gkNVvx;oII?*0@ldWCnUB?)Vd0J8%W4;wIlX`naiYDWuB3wCcWSoJGKcYt>=O<@b)J)(>)6j2xR^VUD zUHLmI==aZsrSzDj&Zd~;55gA{1;s5JO(IAJ=+EQU9*aEM>~8!Ktoos&Mxs$a;f=VH zd(G~F7Imo~=s^%vl+EDq3S6>t_qzIQ?i)UVm1@AxypABUR1I6hF5cj>3r1g)| zmt={jhCbAW;c4*o1~gyD0|3>_UN<|m#a+lT=)B~^J0_;a3X4eygRhZT+LFtu*zncZ z!giJys_hLHW_ML-R673Zv*0sSrzyy<^^XUhk^*vzEu~1{0oxmlFZYL07Mo|Oq_nW* zWZTJ(t1ML=T`Wn)#c?qE=Sq5O{ohpZo>dgp0LoE=aE>Li+;BI79|~W`8yu8W{WJEB z#1|?0yzxE8%#NCYJ5v5?6Eq5GP@=>Y4AM0b$^yZ#r<^0_*i@R<^)E@9Eydp%;znKD zy}6^IS*{Xp5KRVMtMek5{f$U@uKSa5S1#&<2+=`XzVo^5S*c}{5CVHNrdAd=t6*N@ zR_mYJrsY3Tyh4hdiCyRx6clVyq`SR_;OHle)xesCX*||uT3X@@pRNhLaEZnPR4VEc zcyhEGi0B8VZez4OqqtC_zrXjM8#Vsw&Kr6fi1k}D#^!JVwx?q8Wm?U8re$GTTby#Q z9=l98?vDnS(%$))p=E!vu*)Z+)%ks!N>TH%B&r!iuuGa~mHI|D6Hapy%k8zos(1o9 z=uN_VToJ0KXaj~v(@GMz?z{gaYI~=)e@~o?h?V3dl%D|G+LwwJKmW>Nr9wz>_5eV? zugNZ(lf8HI6^(ZS3GP}1_iiG-pE=s|niN{ZQBDS7QhCN*;AR5`OFNd17le6$pl5#1 z=}XW)i?@gH&m5yF%COvc_%J#Y2DZfe|h41>o~7BKq^15hUrr!@Z5hlsjHt zip0v6z!Qaa6;3N-*o>A!pG8xl=~-VKqFBDqBD25rV>`^6V-*#){EKRt=CbFj0Lh0WPF~yB(pC6;`lT83VhGGM zz^?cxFkr=350Nq+Kbrb;z{fe;m~^~$zZJW_!kfMXUu~eiSI@D_A!sos86TpDC8Y{DKz&R;P$9c;6!=;70}9rVlH(F-~3Ib0P>%Cx2FF7cZk zS`$xv31+)alGc1WxSl)G-%s=z?agdhTp6Ap!@u{^=6+Hg{iMCAFhI>zz{uU-y}579 z&eYmi62m&{iHtnbNa9xp-~iz1m@akNhUY>J(UKHcn^J5{NycifE>zoDWzwRHufdKh zC*lzy`==yXtgCpl7U9{l!iB-=4*AP;bh2C|>GWdOoSYU@!pr_WmvI>a@4fuh<=Uvp zT{9lf-j_jG@*NHMU{r}yNV}nHs2rh{>NO0NV&bZPlQVf@VR)Ut3@!DKuIINB@lVqs zK2id^4VQkyjc4XqRx55ERLIpR`0qWgHp}y3GU>J3^GR=z%dgt>M{mfwKlL8wzGg@I zn9{7nO*x{OGRKIW&)K}LJbW4|b><8Bel8prVkAlg07pnEaKf)pm!{n@qEv&gUVuE? zgI*y%P26&qjd(n+Id{Ol*SZXQ>yr_ap4G4wbJxqqpLmO~w^2PnnY#!wN)e9YgDJfxU_zok06PH5RJl>m{CRS-S=|aEAWj01hj)3>2&_Sws&-ehCH@z9~n?lTGS*!1$_QHJm?$l$nMAGmwjG;PdPo%J1#2uQ*hUXUUIEqo_g`mCcD4v<8iLmb72&rC5)B43=D?;k%$0=9-)xPXJhTBLMsX1 zmIxCoxnu}aAC3`{600D%4NyU=Nu5K>FNeJ=@z^1gj}!LmnO-!L^eV?}O(VyL#C}SU z!J>fpiD!*ZgZ$qCUqB}l2kiD-vtBibQp6n!H;C;oE{zsMpiIvu5!EAua*V#}GBY$g z`SlbgEk$KQJ(d*DLad{&UArbK6jT4|yZqLLsB#uxE0k6qBWCEi+|l;RC_GxKV+Yf& zr;dCKOKTN@89LV46hDA>es(bLs?;_SSgbXP{5CQ+$PZGMWk|`NS}Ic|sjP*{==>44 zaEUyeO5Gkz$8K`!7yH#3+8}r&B9i!C`2Jd{ zf}h%FLvVA0)ZuCKdHn+*Ci&~b0N|c^_=3gTN5vm3;{19fqhP2I)Rp?7`YoS;c8sF^ zrJqw3&To(+{F6q-?${V)#egUegNpqqP&S@H%+M6~?+J6sekaFAA6flIu|*&L0xPyAQ9-Ak ztE5PvuJ8^QgyN)oSYT2;fhVMyib$Sd?{a4~rnZDx;f@aAU(5IIe~3MP6cJ1Is~2hR zgD~BeM&o=tOZV{I%OQ`i#FK7exx=329_X9jY}#Ks?9w2m5BHGn-7H839Se3UQDX*C*D~GH zK~NKG8uOa=yO`=EUT6I)-$xT^@~zX#3$F;=&Dtt0{-S9zBzBMS>gO3UwWG!?aM3ep zmc=oa4sYt+dsv4tt=Dg~hgrPw2~(O6$RUuLNy0a%HC2m%>ND{<#!3(?NQ`~TZzzy z*j*$|)MkLbyQ2w6q^M)l3S?ZT6TH`_Ee^g+OE+PY*26*gEiOP~+3AfvrVJ4oe&mo% zcv>ktVd-2be(&MIB{vcKl}C|?wKwH!b3PluD5|}t#n-}=oZSeO^V=yp1^HLq zreySK1UFrYw;QjlWFDQpWQykePFe(Zj56oi?GJV{cNbQ$er+K4EjBHj_ue3gY62kZ zd;3=xcL)=PB{$--VzY8Z8fD3Qa(m}w1koE(1jRGij7^@0%q{K z2;(#&KI}LTPIX2ob_6Nmw>hW2q(b@(ZIHX)p*u0!d0s#(kv{ARmc1G%N}>gJy=U0Z z|9u${UXW)*`Nw=C>TkP_M#?#lqB)sLN*=xvR5i2mwO;%6bU;i=^YM_F5^*{X!KeCc zNUwhUUE^cK;od-6p%l&vQUr@&TsA|bV^Gfuo>1`gn9Km9hQ)}yeX6T)V|CfYS@`|t z@xZX`PuCVEmT~}WkF`S` zL|MEAhe{irsell=`&tv^Z>tp)Q5!c0P8XHJ5WOQw=CI9r=WL!%6RREbNQAMY`rHsX zQ8E%2VaV5+F&n9`cjhtQc@^R8$l@gqE7G4=sGZFCBAp~$GLT70m;XM+CuCD_SA zZ(1>Bw8-^|EuSW5>$Dm9Av%_AUf3cC@69Z8vgG|nG;#I;GAlrf$Nv2$IFzzAd=N7S zY*20z8`m^=O3(|f%3Ez?OH@_iA~B0wI&EjVq;+5jeqB80p~`$AeQweZMYDKqP@M%lrG`=}Z~TKQ2rE{_w!S1j3bn}HYbu%K~<1oHn-Y)L#)qc0; zRg`T}am^r**%#uvd?{B~OF7J}z8<1#dEU_gLMPg4p2Y2%0nY&CB+-4wqQjTt;f9v@ z09t-%w|i;(d5;OP-H9Ffxo<)NBl02n@EPIqcID82ZRWnt0Vk0`#b|N7im(l&C=2t~ z%LogckwlfU+IiwyN=F9K!MrMIiwmy`o_roqv(;*E8hK}m%0mzPIkGRw8n$6HWooXC z@>rY|-Bn>4)Xh>16uXoKY$mUeU+~KR<{-y}Zn>{J0wq z%)6jq8OR0+iI4A7-Bi?6)AT-74*L9P-SyiWMN_V>%*I!Ww`KMA<8A#_lDF(mMwivM zLCih)Hgy>4%w)+0%gT+Yjv`T|PDH6k(%;0#H2eLoLe%ADx4+DUO;j}h1b#&QURaaw zHrk)G<4n+<9@mWo&h^*Fe4X9X#ncI6!f}#63#Sh6Gu^T<_?&J`e8!lvm>c~#E52zp z+$>rU_I+5Pz#?*}V@&V?dY=VOl?t4{$OO9js++!4^iQ6G>I>XV-fT{Elj+4a)VnX) z)7EEN`a!~9)^&QXH;oa1JEfDA^0}2mi({*1!5Ph#yylknO}Uv};<=O4bimzLKt0p% z!&l?&e#xzC^bIuJZ<+J_uz&0C>BPp7JMoJ;Yb5Z1>uyu@?TuqJxcz#f2(HvsQ=znx>Idq;dyeE0Btn= zQkJ>Ek_CqqD_)E;$Z7w9%_xXZzjck-r`L~sZSL%!cx#6L7QPn9OaWhW71*p^ckLym z5{-*V)rH@3u|##QX#63Jy{)`=N5uXN#CofuM^LlZWwN$>(Y%V_7AnH5v7S|OaAHF< zEauCTfedM%kd{&qpZy+X$c!zjpJX=GX}M@BX6&wRB0L)lQ_u{8M;vXMjJo{Fz}xpW zCrXh_Y)ws(M|qp>MB=+a-J*-8eMXhVs(w!PJry~U9Si$J-{bUkP1h$ zaDggYCZa&K`^fQiQsfCDDPk_Up*ybJ|JRgQZb{SJ%Ew|F@dd;Z+{e%q&D|+k;Eay1 z=-1O8P?OSXAk;Gyt-MrJ+%Y!2oUq=tYggoGwDZ)X1#X<^Q7%_0F9x3)jc^{-92FZs zC{TSb7X6`cO|~A`Y6#@ako22lVAUQP{EFvxvs z$a(UPj_WVl)P|Uip08pRYUme|Yq$WA*ZR8dx~n8aQ*pG9&k7GjE+d^RWJU;|7>cg# z8W?$O@AX9^%&%3*EyT`by__B{&nhoLY)@hwd}w4b6E3Hj#VWD|q>OeJv?2Ukr;8AU$%@DS5}6Y2vN%KNue-R+r9)RaebQG2JuvzQ$?!kY8_?ydcP;nx&*i^nUvi9Q$yhSmRVTus!xz?l+?2;$V zge}NYmetPaClA?ifk%jlXIyj1eTZxBLCCys2$?7@^OyvPgA+c~bIZ^nUtF)|l;ge_ zBt@Rhf5V4$Qp9%_l?CmpM6ZS% z29){f25!d3^JxEdTcXDXwGNLklWeAuYQHm}9fX8EyYWxE!1zn9Hi?8Xv0W)9Cl$## zp(^RQ)Gti)B|=~hxjaS0fx%)F2n~Y<;KyA_y}efl@AZJoDA6Ow+} z_Pp~|`{LF3j$@?ys4PS>q)rhf$xf>Hs!gaEB)>=vu!sH8%WCPxv27cP_%Ff6DJ+q7 zoAW}FC8iZaMgp`y%NG=?X1RT}ZT1D`~jSb(}tkS{hU4N4^I9w?k3XB9!Y3^}I*e*UWrZAtNM zF(@#rh<-XmCyj3e6;u(i8sJF&*OIjVi)sE()olN7hn_NzCsLMO#?xAJJq6`Glb}e% zX%-;rvk;aj+@uq^a5;#H?C1XXt^a@GIX4)Ze_FOE=8a}Jm4{(K!Jo58R14jDM6UY_ z!XBm2Fa77g8D@QCwp)eBR|A~GK^*;(=6|S?=Ua&Thkowv#pJG5#iQh2yU{>dQk%mm zL7;ijGe?!2{y$}s1jpm=A)CBGoGNAUc zTwmj)$+Q6n9q8(rzN3EcQwI8&*n9gG$n@k4DTPo|gl-gS3RG)Q8@NjQR9+jr3I?zR9`+j5HqTa zn0UXM)~wl+B^xABKR7(rXD+Myeu243_~3K{5!#eFqqb)pw^i@EDr5yd|4*54$XWqS z3}+IpGdpkYz|PCcsndeuOT!M8Qwl5IO|g+lmDPO#8*P=cr_%qOEDT`vz0jHNpf0Ig`yoWb#W7y3ThLWQm7Kc`Z)(yA1>})snq4sTdFT^))%PAG7tGUYf-U(BteL0z zqH#MyPDs=^;}S2>bO(20BkoV3FkJKbRuN6~bmC=CPTsd66Xba^?uuR$wURB3pLfE~ z|8r*|asexIDj>GF%E@W9psTVdRWs?V{&i^?*KjoXIt6Ki4aN(|9T<2$7fgg=`#7yj zrt_A_>f7oYmp?h}2?mv_nt6=~FBw+K-ypB@bU}aL6yag!TS3&wv9)iCmYZmB(sH^FymMB}l{vRop{F(p& literal 0 HcmV?d00001 diff --git a/pyproject.toml b/pyproject.toml index 49ac82492..33d61424e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,12 +33,12 @@ Website = "https://pipecat.ai" [project.optional-dependencies] anthropic = [ "anthropic~=0.25.7" ] -audio = [ "pyaudio~=0.2.0" ] azure = [ "azure-cognitiveservices-speech~=1.37.0" ] daily = [ "daily-python~=0.7.4" ] examples = [ "python-dotenv~=1.0.0", "flask~=3.0.3", "flask_cors~=4.0.1" ] fal = [ "fal-client~=0.4.0" ] fireworks = [ "openai~=1.26.0" ] +local = [ "pyaudio~=0.2.0" ] moondream = [ "einops~=0.8.0", "timm~=0.9.16", "transformers~=4.40.2" ] openai = [ "openai~=1.26.0" ] playht = [ "pyht~=0.0.28" ] diff --git a/src/pipecat/services/anthropic.py b/src/pipecat/services/anthropic.py index 8632fdaf1..25620f783 100644 --- a/src/pipecat/services/anthropic.py +++ b/src/pipecat/services/anthropic.py @@ -15,7 +15,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use Anthropic, you need to `pip install pipecat[anthropic]`. Also, set `ANTHROPIC_API_KEY` environment variable.") + "In order to use Anthropic, you need to `pip install pipecat-ai[anthropic]`. Also, set `ANTHROPIC_API_KEY` environment variable.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/services/azure.py b/src/pipecat/services/azure.py index d56058821..596e6726d 100644 --- a/src/pipecat/services/azure.py +++ b/src/pipecat/services/azure.py @@ -21,7 +21,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use Azure TTS, you need to `pip install pipecat[azure]`. Also, set `AZURE_SPEECH_API_KEY` and `AZURE_SPEECH_REGION` environment variables.") + "In order to use Azure TTS, you need to `pip install pipecat-ai[azure]`. Also, set `AZURE_SPEECH_API_KEY` and `AZURE_SPEECH_REGION` environment variables.") raise Exception(f"Missing module: {e}") from pipecat.services.openai_api_llm_service import BaseOpenAILLMService diff --git a/src/pipecat/services/fal.py b/src/pipecat/services/fal.py index 1049b4428..ca58f0337 100644 --- a/src/pipecat/services/fal.py +++ b/src/pipecat/services/fal.py @@ -23,7 +23,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use Fal, you need to `pip install pipecat[fal]`. Also, set `FAL_KEY` environment variable.") + "In order to use Fal, you need to `pip install pipecat-ai[fal]`. Also, set `FAL_KEY` environment variable.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/services/fireworks.py b/src/pipecat/services/fireworks.py index 402384d0d..6d2d44e6c 100644 --- a/src/pipecat/services/fireworks.py +++ b/src/pipecat/services/fireworks.py @@ -13,7 +13,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use Fireworks, you need to `pip install pipecat[fireworks]`. Also, set the `FIREWORKS_API_KEY` environment variable.") + "In order to use Fireworks, you need to `pip install pipecat-ai[fireworks]`. Also, set the `FIREWORKS_API_KEY` environment variable.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/services/moondream.py b/src/pipecat/services/moondream.py index f74ba828b..e069c98ed 100644 --- a/src/pipecat/services/moondream.py +++ b/src/pipecat/services/moondream.py @@ -19,7 +19,7 @@ try: from transformers import AutoModelForCausalLM, AutoTokenizer except ModuleNotFoundError as e: logger.error(f"Exception: {e}") - logger.error("In order to use Moondream, you need to `pip install pipecat[moondream]`.") + logger.error("In order to use Moondream, you need to `pip install pipecat-ai[moondream]`.") raise Exception(f"Missing module(s): {e}") diff --git a/src/pipecat/services/openai.py b/src/pipecat/services/openai.py index b15d7950b..50b8b1478 100644 --- a/src/pipecat/services/openai.py +++ b/src/pipecat/services/openai.py @@ -32,7 +32,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use OpenAI, you need to `pip install pipecat[openai]`. Also, set `OPENAI_API_KEY` environment variable.") + "In order to use OpenAI, you need to `pip install pipecat-ai[openai]`. Also, set `OPENAI_API_KEY` environment variable.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/services/playht.py b/src/pipecat/services/playht.py index 69c7bac9d..b2aa4e198 100644 --- a/src/pipecat/services/playht.py +++ b/src/pipecat/services/playht.py @@ -19,7 +19,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use PlayHT, you need to `pip install pipecat[playht]`. Also, set `PLAY_HT_USER_ID` and `PLAY_HT_API_KEY` environment variables.") + "In order to use PlayHT, you need to `pip install pipecat-ai[playht]`. Also, set `PLAY_HT_USER_ID` and `PLAY_HT_API_KEY` environment variables.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/services/whisper.py b/src/pipecat/services/whisper.py index 768e689c8..e0d14e903 100644 --- a/src/pipecat/services/whisper.py +++ b/src/pipecat/services/whisper.py @@ -22,7 +22,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use Whisper, you need to `pip install pipecat[whisper]`.") + "In order to use Whisper, you need to `pip install pipecat-ai[whisper]`.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/transports/local/audio.py b/src/pipecat/transports/local/audio.py index 32266444f..c0038d250 100644 --- a/src/pipecat/transports/local/audio.py +++ b/src/pipecat/transports/local/audio.py @@ -18,7 +18,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use local audio, you need to `pip install pipecat[audio]`. On MacOS, you also need to `brew install portaudio`.") + "In order to use local audio, you need to `pip install pipecat-ai[local]`. On MacOS, you also need to `brew install portaudio`.") raise Exception(f"Missing module: {e}") diff --git a/src/pipecat/transports/local/tk.py b/src/pipecat/transports/local/tk.py index 6a05c9a63..3d5ea9650 100644 --- a/src/pipecat/transports/local/tk.py +++ b/src/pipecat/transports/local/tk.py @@ -22,7 +22,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") logger.error( - "In order to use local audio, you need to `pip install pipecat[audio]`. On MacOS, you also need to `brew install portaudio`.") + "In order to use local audio, you need to `pip install pipecat-ai[audio]`. On MacOS, you also need to `brew install portaudio`.") raise Exception(f"Missing module: {e}") try: diff --git a/src/pipecat/transports/services/daily.py b/src/pipecat/transports/services/daily.py index 84d690569..648969f04 100644 --- a/src/pipecat/transports/services/daily.py +++ b/src/pipecat/transports/services/daily.py @@ -44,7 +44,7 @@ try: from daily import (EventHandler, CallClient, Daily) except ModuleNotFoundError as e: logger.error(f"Exception: {e}") - logger.error("In order to use the Daily transport, you need to `pip install pipecat[daily]`.") + logger.error("In order to use the Daily transport, you need to `pip install pipecat-ai[daily]`.") raise Exception(f"Missing module: {e}") VAD_RESET_PERIOD_MS = 2000 diff --git a/src/pipecat/vad/silero.py b/src/pipecat/vad/silero.py index a9e5aa0ed..f2438b085 100644 --- a/src/pipecat/vad/silero.py +++ b/src/pipecat/vad/silero.py @@ -22,7 +22,7 @@ try: except ModuleNotFoundError as e: logger.error(f"Exception: {e}") - logger.error("In order to use Silero VAD, you need to `pip install pipecat[silero]`.") + logger.error("In order to use Silero VAD, you need to `pip install pipecat-ai[silero]`.") raise Exception(f"Missing module(s): {e}")