-
Notifications
You must be signed in to change notification settings - Fork 189
Add UniRate integration #557
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.
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
Open
rob-browncc
wants to merge
2
commits into
deepset-ai:main
Choose a base branch
from
rob-browncc:add-unirate
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| layout: integration | ||
| name: UniRate | ||
| description: Currency exchange rates, conversion, and currency listings for Haystack pipelines via the UniRate API. | ||
| authors: | ||
| - name: UniRate Team | ||
| socials: | ||
| github: UniRate-API | ||
| pypi: https://pypi.org/project/haystack-unirate/ | ||
| repo: https://github.com/UniRate-API/haystack-unirate | ||
| type: Custom Component | ||
| report_issue: https://github.com/UniRate-API/haystack-unirate/issues | ||
| logo: /logos/unirate.png | ||
| version: Haystack 2.0 | ||
| toc: true | ||
| --- | ||
|
|
||
| ### **Table of Contents** | ||
|
|
||
| - [Overview](#overview) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
|
|
||
| ## Overview | ||
|
|
||
| `haystack-unirate` integrates the [UniRate API](https://unirateapi.com) into | ||
| Haystack 2.x pipelines. It ships three `@component`-decorated building blocks: | ||
|
|
||
| - **`UniRateExchangeRate`** — latest rate for a currency pair (or all targets). | ||
| - **`UniRateConverter`** — convert a monetary amount between two currencies. | ||
| - **`UniRateCurrencies`** — list every supported currency code. | ||
|
|
||
| UniRate covers 593+ fiat, crypto, and commodity instruments. Latest rates, | ||
| conversion, and currency listings are available on the free tier; historical | ||
| data requires a Pro plan. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| pip install haystack-unirate | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Set your API key in the `UNIRATE_API_KEY` environment variable (get one free at | ||
| [unirateapi.com](https://unirateapi.com)), then: | ||
|
|
||
| ```python | ||
| from haystack import Pipeline | ||
| from haystack.utils import Secret | ||
| from haystack_unirate import UniRateConverter | ||
|
|
||
| pipeline = Pipeline() | ||
| pipeline.add_component( | ||
| "convert", UniRateConverter(api_key=Secret.from_env_var("UNIRATE_API_KEY")) | ||
| ) | ||
|
|
||
| result = pipeline.run( | ||
| {"convert": {"from_currency": "USD", "to_currency": "EUR", "amount": 100}} | ||
| ) | ||
| print(result["convert"]["result"]) # e.g. 92.5 | ||
| ``` | ||
|
|
||
| All components support `to_dict` / `from_dict` for pipeline serialization and | ||
| use Haystack `Secret` for API-key handling. | ||
|
|
||
| ## License | ||
|
|
||
| `haystack-unirate` is distributed under the terms of the | ||
| [MIT license](https://github.com/UniRate-API/haystack-unirate/blob/main/LICENSE). | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A pipeline usage should present more than just one component. Typically, we highlight how it might be combined with a chat generator.