dev -> main

.env.example

@@ -1,5 +1,19 @@
+# Image Tags
+# ----------
+
+TAG=dev
+
 # Security
 # --------
+
+# Please set these access keys to something random and unique.
+# Note: For just testing, you can set them to the same value.
+
+# On Linux, you can generate a random key with:
+# > openssl rand -base64 32
+# OR
+# > tr -dc 'A-Za-z0-9+_/' </dev/urandom | head -c 32; echo
+
 JWT_SHARED_KEY=<your_jwt_shared_key>
 AGENTS_API_KEY=<your_agents_api_key>
 COZO_AUTH_TOKEN=<your_cozo_auth_token>
@@ -9,33 +23,60 @@ LITELLM_MASTER_KEY=<your_litellm_master_key>
 LITELLM_SALT_KEY=<your_litellm_salt_key>
 LITELLM_REDIS_PASSWORD=<your_litellm_redis_password>
 
-# Memory Store
-# -----------
+# LLM Providers
+# --------------
 
-# COZO_HOST=http://memory-store:9070
-# COZO_PORT=9070
-# COZO_ROCKSDB_DIR=cozo.db
-# COZO_BACKUP_DIR=/backup
-# COZO_MNT_DIR=/data
+### Recommended LLM Providers
 
-# Gateway
-# ------
+# OPENAI_API_KEY=<your_openai_api_key>
+# VOYAGE_API_KEY=<your_voyage_api_key>
 
-# GATEWAY_PORT=80
-# TRAEFIK_LOG_LEVEL=INFO
+# HUGGING_FACE_HUB_TOKEN=<your_hugging_face_hub_token>
+# ANTHROPIC_API_KEY=<your_anthropic_api_key>
+# GROQ_API_KEY=<your_groq_api_key>
+# CLOUDFLARE_API_KEY=<your_cloudflare_api_key>
+# CLOUDFLARE_ACCOUNT_ID=<your_cloudflare_account_id>
+# NVIDIA_NIM_API_KEY=<your_nvidia_nim_api_key>
+# GITHUB_API_KEY=<your_github_api_key>
+# GOOGLE_APPLICATION_CREDENTIALS=.keys/julep-vertexai-svc.json
 
 # Agents API
 # ---------
 
+### Embedding Model
+### > Set to either "voyage/voyage-3" or "Alibaba-NLP/gte-large-en-v1.5"
+### > Use Alibaba-NLP/gte-large-en-v1.5 with local embedding server
+
+# EMBEDDING_MODEL_ID=voyage/voyage-3
+# EMBEDDING_MODEL_ID=Alibaba-NLP/gte-large-en-v1.5
+
 # AGENTS_API_HOSTNAME=localhost
 # AGENTS_API_PROTOCOL=http
 # AGENTS_API_KEY_HEADER_NAME=Authorization
 # AGENTS_API_URL=http://agents-api:8080
 # TRUNCATE_EMBED_TEXT=true
 # WORKER_URL=temporal:7233
 # AGENTS_API_DEBUG=false
-# EMBEDDING_MODEL_ID=Alibaba-NLP/gte-large-en-v1.5
 # NUM_GPUS=1
+# INTEGRATION_SERVICE_URL=http://integrations:8000
+# USE_BLOB_STORE_FOR_TEMPORAL=false
+# BLOB_STORE_CUTOFF_KB=1024
+# BLOB_STORE_BUCKET=agents-api
+
+# Memory Store
+# -----------
+
+# COZO_HOST=http://memory-store:9070
+# COZO_PORT=9070
+# COZO_ROCKSDB_DIR=cozo.db
+# COZO_BACKUP_DIR=/backup
+# COZO_MNT_DIR=/data
+
+# Gateway
+# ------
+
+# GATEWAY_PORT=80
+# TRAEFIK_LOG_LEVEL=INFO
 
 # Temporal
 # --------
@@ -55,16 +96,14 @@ LITELLM_REDIS_PASSWORD=<your_litellm_redis_password>
 # LITELLM_REDIS_HOST=litellm-redis
 # LITELLM_REDIS_PORT=6379
 
-# LLM Providers
-# --------------
+# Blob Store
+# -----------
 
-# OPENAI_API_KEY=<your_openai_api_key>
-# HUGGING_FACE_HUB_TOKEN=<your_hugging_face_hub_token>
-# ANTHROPIC_API_KEY=<your_anthropic_api_key>
-# GROQ_API_KEY=<your_groq_api_key>
-# CLOUDFLARE_API_KEY=<your_cloudflare_api_key>
-# CLOUDFLARE_ACCOUNT_ID=<your_cloudflare_account_id>
-# NVIDIA_NIM_API_KEY=<your_nvidia_nim_api_key>
-# GITHUB_API_KEY=<your_github_api_key>
-# VOYAGE_API_KEY=<your_voyage_api_key>
-# GOOGLE_APPLICATION_CREDENTIALS=.keys/julep-vertexai-svc.json
+# S3_ENDPOINT=http://seaweedfs:8333
+# S3_ACCESS_KEY=<your_s3_access_key>
+# S3_SECRET_KEY=<your_s3_secret_key>
+
+# Integrations Service
+# ------------
+
+# INTEGRATIONS_SERVICE_PORT=8000

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,33 @@
+name: "🐛 Bug Report"
+description: "Submit a bug report to help us improve"
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: We value your time and your efforts to submit this bug report is appreciated. 🙏
+
+  - type: textarea
+    id: description
+    attributes:
+      label: "📜 Description"
+      description: "A clear and concise description of what the bug is."
+      placeholder: "It bugs out when ..."
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: "👟 Reproduction steps"
+      description: "How do you trigger this bug? Please walk us through it step by step."
+      placeholder: "1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error"
+
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this bug has been raised before?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Have Question?
+    url: https://discord.com/invite/JTSBGRZrzj
+    about: Join Official Discord server

.github/ISSUE_TEMPLATE/docs_improvement.yml

@@ -0,0 +1,52 @@
+name: "📝 Docs Improvement"
+description: "Suggest improvements or additions to the documentation"
+title: "[Docs]: "
+labels: ["documentation"]
+assignees: []
+body:
+    - type: markdown
+      attributes:
+       value: Thanks for taking the time to help improve our documentation! Please provide the following details
+
+    - type: input
+      id: current_section
+      attributes:
+            label: "Current Section"
+            description: "Which section of the documentation needs improvement?"
+            placeholder: "e.g., Installation Guide"
+
+    - type: textarea
+      id: improvement_suggestion
+      attributes:
+            label: "Improvement Suggestion"
+            description: "Describe the improvement or addition you are suggesting."
+            placeholder: "e.g., Add more details about setting up the environment."
+
+    - type: textarea
+      id: additional_context
+      attributes:
+            label: "Additional Context"
+            description: "Any additional context or information that might be helpful."
+            placeholder: "e.g., Links to related documentation, screenshots, etc."
+    - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this issue has been raised before?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true
+  - type: dropdown
+    id: willing-to-submit-pr
+    attributes:
+      label: Are you willing to submit PR?
+      description: This is absolutely not required, but we are happy to guide you in the contribution process.
+      options:
+        - "Yes I am willing to submit a PR!"
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: 🧑‍⚖️ Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/julep-ai/julep/blob/dev/.github/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,48 @@
+name: 🚀 Feature
+description: "Submit a proposal for a new feature"
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: We value your time and your efforts to submit this feature request is appreciated. 🙏
+  - type: textarea
+    id: feature-description
+    validations:
+      required: true
+    attributes:
+      label: "🔖 Feature description"
+      description: "A clear and concise description of what the feature is."
+      placeholder: "You should add ..."
+  - type: textarea
+    id: pitch
+    attributes:
+      label: "🎤 Why is this feature needed ?"
+      description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable."
+      placeholder: "In my use-case, ..."
+  - type: textarea
+    id: solution
+    attributes:
+      label: "✌️ How do you aim to achieve this?"
+      description: "A clear and concise description of what you want to happen."
+      placeholder: "I want this feature to, ..."
+  - type: textarea
+    id: alternative
+    attributes:
+      label: "🔄️ Additional Information"
+      description: "A clear and concise description of any alternative solutions or additional solutions you've considered."
+      placeholder: "I tried, ..."
+  - type: checkboxes
+    id: no-duplicate-issues
+    attributes:
+      label: "👀 Have you spent some time to check if this feature request has been raised before?"
+      options:
+        - label: "I checked and didn't find similar issue"
+          required: true
+  - type: dropdown
+    id: willing-to-submit-pr
+    attributes:
+      label: Are you willing to submit PR?
+      description: This is absolutely not required, but we are happy to guide you in the contribution process.
+      options:
+        - "Yes I am willing to submit a PR!"

.github/SUPPORT.md

@@ -0,0 +1,62 @@
+# Support for Julep
+
+Welcome to the Julep support page! We're here to help you with any questions or issues you may encounter while using our platform. This document outlines the various ways you can get support and engage with our community.
+
+## Getting Help
+
+### Documentation
+
+Our comprehensive documentation is the first place to look for answers:
+
+- [Explore Docs](https://docs.julep.ai)
+
+Here you'll find detailed guides, API references, and tutorials to help you make the most of Julep.
+
+### Community Support
+
+Join our vibrant community to get help from other users and the Julep team:
+
+- [Discord](https://discord.com/invite/JTSBGRZrzj): Join our Discord server for real-time chat and support.
+- [GitHub Discussions](https://github.com/julep-ai/julep/discussions): Ask questions, share ideas, and discuss Julep with other developers.
+
+### Social Media
+
+Follow us on social media for updates, tips, and community highlights:
+
+- [𝕏 (Twitter)](https://x.com/julep_ai)
+- [LinkedIn](https://www.linkedin.com/company/julep-ai)
+
+## Reporting Issues
+
+If you encounter a bug or have a feature request, please open an issue on our GitHub repository:
+
+- [GitHub Issues](https://github.com/julep-ai/julep/issues)
+
+When reporting issues, please provide as much detail as possible, including:
+
+- Steps to reproduce the issue
+- Expected behavior
+- Actual behavior
+- Any error messages or logs
+- Your environment (Julep version, operating system, etc.)
+
+## Contributing
+
+We welcome contributions to Julep! If you're interested in contributing, please check out our:
+
+- [Contributing Guidelines](https://github.com/julep-ai/julep/blob/main/CONTRIBUTING.md)
+- [Code of Conduct](https://github.com/julep-ai/julep/blob/main/CODE_OF_CONDUCT.md)
+
+## API Keys
+
+While we are in beta, you can reach out on [Discord](https://discord.com/invite/JTSBGRZrzj) to get your API key.
+
+## Staying Updated
+
+To stay informed about the latest updates, features, and community news:
+
+- Watch our [GitHub repository](https://github.com/julep-ai/julep)
+- Follow us on [𝕏 (Twitter)](https://x.com/julep_ai)
+- Join our [Discord](https://discord.com/invite/JTSBGRZrzj) for announcements
+
+Thank you for using Julep! We're excited to see what you build with our platform.