Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor!: Use Secret for API keys in Cohere components #386

Merged
merged 1 commit into from
Feb 9, 2024
Merged

refactor!: Use Secret for API keys in Cohere components #386

merged 1 commit into from
Feb 9, 2024

Conversation

shadeMe
Copy link
Contributor

@shadeMe shadeMe commented Feb 9, 2024 •
edited
Loading

Related to #370.

@github-actions github-actions bot added integration:cohere type:documentation Improvements or additions to documentation labels Feb 9, 2024
@shadeMe shadeMe force-pushed the refactor/cohere-secrets branch from d80e45c to f8bdafc Compare February 9, 2024 15:15
@shadeMe shadeMe marked this pull request as ready for review February 9, 2024 15:18
@shadeMe shadeMe requested a review from a team as a code owner February 9, 2024 15:18
@shadeMe shadeMe requested review from julian-risch and removed request for a team February 9, 2024 15:18
julian-risch
julian-risch approved these changes Feb 9, 2024
View reviewed changes
Copy link
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍 I thought about whether we should add a link to a documentation page about secret management in Haystack in the docstrings where we currently just say: :param api_key: The API key for the Cohere API.. However, it's such a core concept that we can mention it in getting started pages, etc. rather than in every docstring of components with api keys.

@shadeMe
Copy link
Contributor Author

shadeMe commented Feb 9, 2024

LGTM! 👍 I thought about whether we should add a link to a documentation page about secret management in Haystack in the docstrings where we currently just say: :param api_key: The API key for the Cohere API.. However, it's such a core concept that we can mention it in getting started pages, etc. rather than in every docstring of components with api keys.

Yeah, I've already drafted a explainer doc for it. It'll appear on the sidebar under the "Haystack Concepts" section once it's merged.

@shadeMe shadeMe merged commit bca7226 into main Feb 9, 2024
10 checks passed
@shadeMe shadeMe deleted the refactor/cohere-secrets branch February 9, 2024 16:24
@shadeMe shadeMe mentioned this pull request Feb 14, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julian-risch julian-risch julian-risch approved these changes

Assignees
No one assigned
Labels
integration:cohere type:documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shadeMe @julian-risch