search

ComposioHQ / composio

Composio equip's your AI agents & LLMs with 100+ high-quality integrations via function calling
https://docs.composio.dev
Other
7.48k stars 2.33k forks source link

update: Add OPENAI_API_KEY key in .env.example of rag_agent example #356

Closed apneduniya closed 1 month ago

apneduniya commented 1 month ago

PR Type

documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
.env.example
Add `OPENAI_API_KEY` to `.env.example` for RAG agent example
python/examples/rag_agent/.env.example
  • Added OPENAI_API_KEY entry to .env.example file.
  • Provided a placeholder comment for the OpenAI API key.
    		•  +1/-0     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review
    codiumai-pr-agent-pro[bot] commented 1 month ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Replace the placeholder value with a descriptive placeholder for the API key ___ **It's recommended to avoid setting placeholder values for sensitive keys directly in
    environment example files. Instead, use a descriptive placeholder or leave it blank
    to prompt users to fill in their own values.** [python/examples/rag_agent/.env.example [1]](https://github.com/ComposioHQ/composio/pull/356/files#diff-dbb71cb09d5d8969cebf72ca888dc97b165f48131d5b17ca4a76a26ed4c2d7c7R1-R1) ```diff -OPENAI_API_KEY = KEY #api key of openai +OPENAI_API_KEY = #api key of openai ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: The suggestion improves security by avoiding the use of a potentially misleading placeholder value for sensitive information. It prompts users to fill in their own values, which is a best practice for environment example files.
    		9