Skip to content

Commit

Permalink
Merge pull request #144 from filip-michalsky/documentation
Browse files Browse the repository at this point in the history
Local startup
  • Loading branch information
filip-michalsky authored May 8, 2024
2 parents 2ebf6b7 + 024806a commit ab318bd
Show file tree
Hide file tree
Showing 61 changed files with 1,310 additions and 207 deletions.
4 changes: 3 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ CONFIG_PATH=examples/example_agent_setup.json
PRODUCT_CATALOG=examples/sample_product_catalog.txt
PRODUCT_PRICE_MAPPING=examples/example_product_price_id_mapping.json


#Gmail API config for sending emails
GMAIL_APP_PASSWORD=xx
GMAIL_MAIL=yy
Expand All @@ -24,3 +23,6 @@ PAYMENT_GATEWAY_URL=https://agent-payments-gateway.vercel.app/payment
CALENDLY_API_KEY=xx
CALENDLY_EVENT_UUID=yy

#Enable local api startup
ENVIRONMENT=development

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ examples/sales_agent_bedrock.ipynb
**__pycache__
/scratch
**.chroma/
.env.filip


# Distribution / packaging
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Updates to the SalesGPT project: Building the world's best AI Sales Agents and virtual workers.

May 8, 2024
---------------
Version 0.1.3
- SalesGPT has analytics tracking built into documentation for improved understanding of important features and update necessities
- Added option for local frontend startup with ENVIRONMENT variable

March 22, 2024
---------------
Version 0.1.2
Expand Down
Binary file modified api-website/_build/doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file modified api-website/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/modules.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.agents.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.chains.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.logger.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.parsers.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.prompts.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.prompts_cn.doctree
Binary file not shown.
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.stages.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.templates.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.tools.doctree
Binary file not shown.
Binary file modified api-website/_build/doctrees/salesgpt/salesgpt.version.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion api-website/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e5df60454524fb28d5e2b3c23043e531
config: c5bf57642e839bbe8412743aae371109
tags: 645f666f9bcd5a90fca523b33c5a78b7
59 changes: 59 additions & 0 deletions api-website/_build/html/_sources/googleanalytics/README.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.. -*- restructuredtext -*-
===========================================
Google Analytics extension for Sphinx
===========================================

:author: Domen Kožar <domen@dev.si>


About
=====

This extensions allows you to track generated html files
with Google Analytics web service.


Installing from sphinx-contrib checkout
---------------------------------------

Checkout googleanalytics sphinx extension::

$ git clone https://github.com/sphinx-contrib/googleanalytics

Change into the googleanalytics directory::

$ cd googleanalytics

Install the module::

$ python setup.py install


Enabling the extension in Sphinx_
---------------------------------

Just add ``sphinxcontrib.googleanalytics`` to the list of extensions in the ``conf.py``
file. For example::

extensions = ['sphinxcontrib.googleanalytics']


Configuration
-------------

For now one optional configuration is added to Sphinx_. It can be set in
``conf.py`` file:

``googleanalytics_id`` <string>:
UA id for your site, example::
googleanalytics_id = 'UA-123-123-123'

``googleanalytics_enabled`` <bool>:
True by default, use it to turn off tracking.


.. Links:
.. _gnuplot: http://www.gnuplot.info/
.. _Sphinx: http://sphinx.pocoo.org/

4 changes: 4 additions & 0 deletions api-website/_build/html/_static/google_analytics_tracker.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'GTM-NX3SZD79');
1 change: 1 addition & 0 deletions api-website/_build/html/_static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #E40000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #008400 } /* Generic.Inserted */
Expand Down
62 changes: 55 additions & 7 deletions api-website/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,28 @@
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-VH1ZNBVHSP"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-VH1ZNBVHSP');
</script>

<script async src="https://www.googletagmanager.com/gtag/js?id=GTM-NX3SZD79"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'GTM-NX3SZD79');

</script>

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; SalesGPT documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=a36129ee" />

Expand All @@ -18,6 +37,17 @@
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-NX3SZD79');</script>
<!-- End Google Tag Manager -->
</script>
<script>https://www.googletagmanager.com/gtag/js?id=GTM-NX3SZD79</script>
<script>google_analytics_tracker.js</script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -114,6 +144,8 @@ <h2 id="A">A</h2>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.adetermine_conversation_stage">adetermine_conversation_stage() (salesgpt.agents.SalesGPT method)</a>
</li>
<li><a href="salesgpt/salesgpt.parsers.html#salesgpt.parsers.SalesConvoOutputParser.ai_prefix">ai_prefix (salesgpt.parsers.SalesConvoOutputParser attribute)</a>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.astep">astep() (salesgpt.agents.SalesGPT method)</a>
Expand All @@ -130,12 +162,14 @@ <h2 id="C">C</h2>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.company_values">company_values (salesgpt.agents.SalesGPT attribute)</a>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.conversation_history">conversation_history (salesgpt.agents.SalesGPT attribute)</a>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.completion_bedrock">completion_bedrock() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.conversation_purpose">conversation_purpose (salesgpt.agents.SalesGPT attribute)</a>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.conversation_history">conversation_history (salesgpt.agents.SalesGPT attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.conversation_purpose">conversation_purpose (salesgpt.agents.SalesGPT attribute)</a>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.conversation_stage_dict">conversation_stage_dict (salesgpt.agents.SalesGPT attribute)</a>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.conversation_stage_id">conversation_stage_id (salesgpt.agents.SalesGPT attribute)</a>
Expand All @@ -157,6 +191,8 @@ <h2 id="D">D</h2>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.salesgptapi.html#salesgpt.salesgptapi.SalesGPTAPI.do">do() (salesgpt.salesgptapi.SalesGPTAPI method)</a>
</li>
<li><a href="salesgpt/salesgpt.salesgptapi.html#salesgpt.salesgptapi.SalesGPTAPI.do_stream">do_stream() (salesgpt.salesgptapi.SalesGPTAPI method)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -184,10 +220,18 @@ <h2 id="F">F</h2>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.generate_calendly_invitation_link">generate_calendly_invitation_link() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.generate_stripe_payment_link">generate_stripe_payment_link() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.parsers.html#salesgpt.parsers.SalesConvoOutputParser.get_format_instructions">get_format_instructions() (salesgpt.parsers.SalesConvoOutputParser method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.get_mail_body_subject_from_query">get_mail_body_subject_from_query() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.get_product_id_from_query">get_product_id_from_query() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.get_tools">get_tools() (in module salesgpt.tools)</a>
</li>
</ul></td>
Expand All @@ -203,6 +247,10 @@ <h2 id="H">H</h2>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.salesgptapi.html#salesgpt.salesgptapi.SalesGPTAPI.initialize_agent">initialize_agent() (salesgpt.salesgptapi.SalesGPTAPI method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.input_keys">input_keys (salesgpt.agents.SalesGPT property)</a>
</li>
Expand Down Expand Up @@ -384,6 +432,10 @@ <h2 id="S">S</h2>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.salesperson_role">salesperson_role (salesgpt.agents.SalesGPT attribute)</a>
</li>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.seed_agent">seed_agent() (salesgpt.agents.SalesGPT method)</a>
</li>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.send_email_tool">send_email_tool() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.send_email_with_gmail">send_email_with_gmail() (in module salesgpt.tools)</a>
</li>
<li><a href="salesgpt/salesgpt.tools.html#salesgpt.tools.setup_knowledge_base">setup_knowledge_base() (in module salesgpt.tools)</a>
</li>
Expand Down Expand Up @@ -416,10 +468,6 @@ <h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.agents.html#salesgpt.agents.SalesGPT.use_tools">use_tools (salesgpt.agents.SalesGPT attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="salesgpt/salesgpt.salesgptapi.html#salesgpt.salesgptapi.SalesGPTAPI.USE_TOOLS">USE_TOOLS (salesgpt.salesgptapi.SalesGPTAPI attribute)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Loading

0 comments on commit ab318bd

Please sign in to comment.