-
Notifications
You must be signed in to change notification settings - Fork 905
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc(sdks/ts): Generate docs for sdks/ts (CI)
- Loading branch information
1 parent
e84fdb1
commit c6e6079
Showing
21 changed files
with
251 additions
and
267 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| @julep/sdk / [Modules](modules.md) | ||
|
|
||
| <sup>English | [中文翻译](/README-CN.md)</sup> | ||
|
|
||
| <div align="center"> | ||
| <img src="https://socialify.git.ci/julep-ai/julep/image?description=1&descriptionEditable=Open-source%20platform%20for%20building%20stateful%20AI%20apps&font=Source%20Code%20Pro&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fjulep-ai%2Fjulep%2Fdev%2F.github%2Fjulep-logo.svg&owner=1&pattern=Solid&stargazers=1&theme=Auto" alt="julep" width="640" height="320" /> | ||
| </div> | ||
|
|
@@ -49,48 +51,38 @@ We've built a lot of AI apps and understand how difficult it is to evaluate hund | |
| 1. The barrier to making LLM apps with memory, knowledge & tools is too high. | ||
| 2. Agentic behaviour is hard to control when done through multi-agent frameworks. | ||
|
|
||
| **The Solution**: | ||
| - **Statefulness By Design**: Manages context by default. Uses [CozoDB](https://cozodb.org/) to save & retrieve conversation history, OpenAPI specification tools & documents. | ||
| - **Support for Users & Agents**: Allows creating different user <-> agent interactions like `One Agent <-> Many Users`; `Many Agents <-> One User` etc. Read more: https://docs.julep.ai/concepts/ | ||
| - **Use and switch between any LLMs anytime**: Switch and use different LLMs, providers and models, self-hosted or otherwise. | ||
| - **Production-ready**: Julep comes ready to be deployed to production using Docker Compose. Support for k8s coming soon! | ||
| - **90+ tools built-in**: Connect your AI app to 150+ third-party applications using [Composio](https://docs.composio.dev/framework/julep/) natively. | ||
| - ***GitHub Actions-like workflows for tasks**: Define agentic workflows to be executed asynchronously with one ore more without worrying about timeouts or multiplying hallucinations. | ||
| --- | ||
| ## Features | ||
| - **Statefulness By Design**: Manages conversation history by default. Use simple flags; `remember` & `recall` to tune whether to save or retrieve conversation history. | ||
| - **Support for Users & Agents**: Allows creating different user <-> agent interactions like `One Agent <-> Many Users`; `Many Agents <-> One User` etc. [Read more,](https://docs.julep.ai/concepts/). | ||
| - **Built-in RAG**: Add, delete & update documents to give the LLM context about the user or an agent depending on your use case. [Read more here.](https://docs.julep.ai/guides/build-a-retrieval-augmented-generation-rag-agent) | ||
| - **90+ tools built-in**: Connect your AI app to 90+ third-party applications using [Composio](https://docs.composio.dev/framework/julep/) natively. `toolset.handle_tool_calls(julep_client, session.id, response)` will call and handle your tools for you! [See example](https://docs.julep.ai/guides/use-julep-with-composio) | ||
| - **Local-first**: Julep comes ready to be deployed to production using Docker Compose. Support for k8s coming soon! | ||
| - **Switch LLMs on the fly**: Update the Agent to switch between LLMs from OpenAI, Anthropic or Ollama. All the while preserving state. | ||
| - ***Assign Tasks to Agents**: Define agentic workflows to be executed asynchronously with one ore more without worrying about timeouts or multiplying hallucinations. [Work in progress](https://github.com/julep-ai/julep/discussions/387) | ||
|
|
||
| > (*) Coming soon! | ||
| <!--  --> | ||
| --- | ||
| ## Guides | ||
| You can view the different features of Julep in action in the [guide docs](https://docs.julep.ai/guides/). | ||
| 1. [Simple Conversational Bot](https://deepnote.com/app/julep-ai-761c/Julep-Mixers-4dfff09a-84f2-4278-baa3-d1a00b88ba26) | ||
| 2. [Search Agent](https://docs.julep.ai/guides/) | ||
| 3. [RAG Agent](https://docs.julep.ai/guides/build-a-retrieval-augmented-generation-rag-agent) | ||
| 5. [GitHub Agent with Composio](https://docs.julep.ai/guides/use-julep-with-composio) | ||
| 5. [GPT 4o for Vision](https://docs.julep.ai/guides/image-+-text-with-gpt-4o) | ||
| --- | ||
|
|
||
| ## Quickstart | ||
| ### Option 1: Use the Julep Cloud | ||
| Our hosted platform is in Beta! | ||
|
|
||
| To get access: | ||
| [Join our Discord](https://discord.com/invite/JTSBGRZrzj) or Drop a "Hey" over at [email protected]! | ||
| - Head over to https://platform.julep.ai | ||
| - Generate and add your `JULEP_API_KEY` in `.env` | ||
|
|
||
| ### Option 2: Install and run Julep locally | ||
| - Download the `docker-compose.yml` file along with the `.env` file for configuration to run the Julep platform locally | ||
|
|
||
| ```bash | ||
| # Add the docker compose to your project dir | ||
| wget https://raw.githubusercontent.com/julep-ai/julep/dev/deploy/docker-compose.yml | ||
| # Add the .env file to your project dir | ||
| wget https://raw.githubusercontent.com/julep-ai/julep/dev/deploy/.env.example -O .env | ||
| # Pull the latest images | ||
| docker compose pull | ||
| # Start the services (in detached mode) | ||
| docker compose up -d | ||
| ``` | ||
| - The API would now be available at: `http://0.0.0.0:8080` | ||
|
|
||
| - Next, add your OpenAI/Anthropic API Key to the `.env` | ||
|
|
||
| - Set your environment variables | ||
| ```bash | ||
| export JULEP_API_KEY=myauthkey | ||
| export JULEP_API_URL=http://0.0.0.0:8080 | ||
| ``` | ||
|
|
||
| Head over to docs on [self-hosting](https://docs.julep.ai/guides/self-hosting) to see how to run Julep locally! | ||
| ### Installation | ||
|
|
||
| ``` | ||
|
|
@@ -197,20 +189,12 @@ npm install @julep/sdk | |
|
|
||
| For more information on using the TypeScript SDK, please refer to the [TypeScript SDK documentation](https://docs.julep.ai/api-reference/js-sdk-docs). | ||
|
|
||
| --- | ||
| ## Examples | ||
| You can test different examples of using Julep to make apps in the [example app docs](https://docs.julep.ai/cookbooks/example-apps). | ||
|
|
||
| 1. [Simple Conversational Bot](https://deepnote.com/app/julep-ai-761c/Julep-Mixers-4dfff09a-84f2-4278-baa3-d1a00b88ba26) | ||
| 2. [Discord Bot with Long-Term Memory](https://replit.com/@alt-glitch/LLM-App-with-Long-Term-Memory) | ||
| 3. [AI Dungeon Master](https://github.com/julep-ai/julep-examples/tree/main/dungeon-master) | ||
| 4. [Community Feedback Agent](https://github.com/julep-ai/julep-examples/tree/main/community-feedback) | ||
| --- | ||
|
|
||
| ## Deployment | ||
| Check out the [self-hosting guide](https://docs.julep.ai/agents/self-hosting) to host the platform yourself. | ||
|
|
||
| If you want to deploy Julep to production, [let's hop on a call](https://calendly.com/diwank-julep/45min)! | ||
| If you want to deploy Julep to production, [let's hop on a call](https://cal.com/ishitaj/15min)! | ||
|
|
||
| We'll help you customise the platform and help you get set up with: | ||
| - Multi-tenancy | ||
|
|
@@ -232,6 +216,6 @@ If you have any questions, need assistance, or want to get in touch with the Jul | |
|
|
||
| - [Discord](https://discord.com/invite/JTSBGRZrzj): Join our community forum to discuss ideas, ask questions, and get help from other Julep AI users and the development team. | ||
| - GitHub Issues: For technical issues, bug reports, and feature requests, please open an issue on the Julep AI GitHub repository. | ||
| - Email Support: If you need direct assistance from our support team, send an email to diwank@julep.ai, and we'll get back to you as soon as possible. | ||
| - Email Support: If you need direct assistance from our support team, send an email to hey@julep.ai, and we'll get back to you as soon as possible. | ||
| - Follow for updates on [X](https://twitter.com/julep_ai) & [LinkedIn](https://www.linkedin.com/company/julep-ai/) | ||
| - [Hop on a call](https://calendly.com/diwank-julep): We wanna know what you're building and how we can tweak and tune Julep to help you build your next AI app. | ||
| - [Hop on a call](https://cal.com/ishitaj/15min): We wanna know what you're building and how we can tweak and tune Julep to help you build your next AI app. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.