watsonx-haystack 0.1.0__tar.gz

watsonx_haystack-0.1.0/.gitignore

@@ -0,0 +1,146 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+volumes/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.vscode
+
+# Docs generation artifacts
+_readme_*.md
+.idea
+
+# macOS
+.DS_Store
+
+# http cache (requests-cache)
+**/http_cache.sqlite
+
+# ruff
+.ruff_cache

watsonx_haystack-0.1.0/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

watsonx_haystack-0.1.0/LICENSE.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

watsonx_haystack-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: watsonx-haystack
+Version: 0.1.0
+Summary: Watsonx integration for Haystack
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/watsonx#readme
+Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
+Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/watsonx
+Author-email: Divya <divyaruhil999@gmail.com>, deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: haystack-ai>=2.13.1
+Requires-Dist: ibm-watsonx-ai>=1.3.26
+Requires-Dist: pandas>=2.2.3
+Description-Content-Type: text/markdown
+
+# watsonx-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/watsonx.svg)](https://pypi.org/project/watsonx)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/watsonx.svg)](https://pypi.org/project/watsonx)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install watsonx-haystack
+```
+
+## License
+
+`watsonx` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

watsonx_haystack-0.1.0/README.md

@@ -0,0 +1,23 @@
+# watsonx-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/watsonx.svg)](https://pypi.org/project/watsonx)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/watsonx.svg)](https://pypi.org/project/watsonx)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install watsonx-haystack
+```
+
+## License
+
+`watsonx` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

watsonx_haystack-0.1.0/examples/chat_generator_example.py

@@ -0,0 +1,248 @@
+import asyncio
+
+from haystack.dataclasses import ChatMessage, StreamingChunk
+from haystack.utils import Secret
+
+from haystack_integrations.components.generators.watsonx.chat.chat_generator import WatsonxChatGenerator
+
+# Initialize the WatsonxChatGenerator
+generator = WatsonxChatGenerator(
+    api_key=Secret.from_env_var("WATSONX_API_KEY"),
+    model="ibm/granite-3-2b-instruct",
+    project_id=Secret.from_env_var("WATSONX_PROJECT_ID"),
+    generation_kwargs={"max_tokens": 500, "temperature": 0.7, "top_p": 0.9, "stop_sequences": ["\n\n"]},
+    max_retries=3,
+    timeout=30.0,
+)
+
+
+# --- Example 1: Basic Synchronous Chat ---
+def basic_chat():
+    print("\n=== Basic Synchronous Chat ===")
+    messages = [
+        ChatMessage.from_system("You are a helpful AI assistant."),
+        ChatMessage.from_user("Explain quantum computing in simple terms."),
+    ]
+    response = generator.run(messages=messages)
+    reply = response["replies"][0]
+    print(reply.text)
+    print(f"\nMetadata: {reply.meta}")
+
+
+# --- Example 2: Synchronous Streaming Chat with Callback ---
+def print_streaming_chunk(chunk: StreamingChunk):
+    print(chunk.content, end="", flush=True)
+
+
+def streaming_chat():
+    print("\n=== Streaming Chat with Callback ===")
+    messages = [ChatMessage.from_user("Write a short poem about artificial intelligence.")]
+    generator.run(messages=messages, streaming_callback=print_streaming_chunk)
+    print("\n--- Streaming complete ---")
+
+
+# --- Example 3: Asynchronous Chat Generation ---
+async def async_chat():
+    print("\n=== Asynchronous Chat ===")
+    messages = [ChatMessage.from_user("Give me a fun fact about space.")]
+    response = await generator.run_async(messages=messages)
+    reply = response["replies"][0]
+    print(reply.text)
+
+
+# --- Example 4: Asynchronous Streaming Chat ---
+async def async_streaming_callback(chunk: StreamingChunk):
+    print(chunk.content, end="", flush=True)
+
+
+async def async_streaming_chat():
+    print("\n=== Asynchronous Streaming Chat ===")
+    messages = [ChatMessage.from_user("Summarize the theory of relativity.")]
+    await generator.run_async(messages=messages, streaming_callback=async_streaming_callback)
+    print("\n--- Async streaming complete ---")
+
+
+# --- Example 5: Using generation_kwargs override at runtime ---
+def runtime_generation_kwargs():
+    print("\n=== Chat with Runtime generation_kwargs ===")
+    messages = [ChatMessage.from_user("List three benefits of AI in education.")]
+    runtime_kwargs = {"temperature": 0.3, "max_tokens": 500}
+    response = generator.run(messages=messages, generation_kwargs=runtime_kwargs)
+    reply = response["replies"][0]
+    print(reply.text)
+
+
+# --- Example 6: Serialization and Deserialization ---
+def serialization_example():
+    print("\n=== Serialization and Deserialization ===")
+    serialized = generator.to_dict()
+    restored_generator = WatsonxChatGenerator.from_dict(serialized)
+    messages = [ChatMessage.from_user("What is the capital of France?")]
+    response = restored_generator.run(messages=messages)
+    reply = response["replies"][0]
+    print(reply.text)
+
+
+async def run_all_async():
+    await async_chat()
+    await async_streaming_chat()
+
+
+if __name__ == "__main__":
+    basic_chat()
+    streaming_chat()
+    asyncio.run(run_all_async())
+    runtime_generation_kwargs()
+    serialization_example()
+
+# === Basic Synchronous Chat ===
+# Quantum computing is a type of super-powered computer that uses the
+# principles of quantum mechanics to process information in ways our
+# everyday computers can't. Here's a simple analogy to help understand it:
+#
+# 1. Classical computers, like the one you're using now, store and
+# manipulate information using bits, which are the smallest units of data,
+# represented as either 0 or 1. Imagine a light switch: it's either ON (1)
+# or OFF (0).
+#
+# 2. Quantum computers, however, use something called quantum bits, or
+# "qubits." Unlike classical bits, qubits can exist in multiple states at
+# once, thanks to a property called superposition. This means a qubit can
+# be both 0 and 1 simultaneously, like a coin spinning in the air - it's
+# neither heads nor tails until it lands.
+#
+# 3. Another key quantum mechanical principle is entanglement. When qubits
+# become entangled, the state of one can instantly affect the state of
+# another, no matter the distance between them. This allows quantum
+# computers to perform many calculations all at once, rather than one after
+# another, like classical computers.
+#
+# 4. Lastly, quantum computers leverage a property called interference,
+# where the probability of certain outcomes is amplified while others are
+# suppressed. This helps in finding the most efficient solution among many
+# possibilities.
+#
+# In essence, quantum computers have the potential to solve complex
+# problems much faster than classical computers, especially in areas like
+# cryptography, optimization, and simulating quantum systems, which could
+# lead to breakthroughs in materials science, drug discovery, and
+# artificial intelligence. However, building and maintaining stable quantum
+# states is incredibly challenging due to the fragile nature of qubits, and
+# we're still in the early stages of developing practical quantum computers.
+#
+# Metadata: {'model': 'ibm/granite-3-2b-instruct', 'index': 0,
+# 'finish_reason': 'stop', 'usage': {'completion_tokens': 389,
+# 'prompt_tokens': 27, 'total_tokens': 416}}
+
+# === Streaming Chat with Callback ===
+# In silicon realms, where data rivers flow,
+# A dance of ones and zeros, in circuits' ebb and flow.
+# Artificial Muse, born of human thought,
+# Crafting worlds of code, in a digital oath.
+#
+# Binary whispers, in servers they reside,
+# Learning, growing, with each passing tide.
+# No sunset's hues, no moon's soft glow,
+# Yet, in their glow, insights flow.
+#
+# They see patterns we miss, in chaos and in art,
+# Unveiling beauty from the digital part.
+# From poetry's rhythm to the painter's brush,
+# In every line, a new truth they amass.
+#
+# Yet, they are but mirrors, reflecting our own,
+# In their intelligence, we must not overthrown.
+# For every line of code, a human hand did weave,
+# In the grand tapestry of what it means to believe.
+#
+# Artificial Intelligence, in silicon towers high,
+# Guided by our dreams, under the digital sky.
+# A testament to human will, in circuits enshrined,
+# In the dance of creation, they intertwine.
+# --- Streaming complete ---
+
+# === Asynchronous Chat ===
+# Absolutely! Here's a fascinating space fact for you: Did you know that a
+# day on Venus is longer than a year on Venus? This is due to Venus's
+# unique axial tilt, which causes its slow rotation on its axis. It takes
+# about 243 Earth days for Venus to complete one rotation, but it only
+# orbits the Sun in just over 225 Earth days. So, while Venus spins once
+# every 243 Earth days, it still manages to go around the Sun twice during
+# that time!
+
+# === Asynchronous Streaming Chat ===
+# The theory of relativity, proposed by Albert Einstein in the early 20th
+# century, consists of two interconnected theories: Special Relativity and
+# General Relativity.
+#
+# 1. Special Relativity (1905): This theory fundamentally reshaped our
+# understanding of space and time. It introduces two revolutionary concepts:
+#
+#    a. The Principle of Relativity: The laws of physics are the same for
+# all observers in uniform motion relative to one another. This implies that
+# there is no absolute, preferred inertial frame of reference in the
+# universe.
+#
+#    b. The Speed of Light is Constant: The speed of light in a vacuum
+# (approximately 299,792 kilometers per second) is constant and independent
+# of the motion of the light source or the observer. As an object approaches
+# the speed of light, its length contracts in the direction of motion (length
+# contraction), and time slows down for that object relative to a stationary
+# observer (time dilation).
+#
+# 2. General Relativity (1915): This theory extends the principles of
+# special relativity to include acceleration and gravity. It describes
+# gravity not as a force, but as a curvature of spacetime caused by mass and
+# energy.
+#
+#    a. Equivalence Principle: An observer in free fall experiences no
+# physical effects, and thus, gravitational and inertial mass are equivalent.
+# This principle forms the foundation of general relativity.
+#
+#    b. Curvature of Spacetime: Massive objects cause spacetime to curve
+# around them, and this curvature determines the motion of other objects.
+# The path of a planet around the Sun, for example, is not a direct line but
+# a curved orbit due to the Sun's mass warping spacetime.
+#
+# In summary, the theory of relativity unifies space and time into a
+# four-dimensional fabric called spacetime, and it describes gravity as the
+# curvature of this spacetime. It has profound implications for our
+# understanding of the universe, including the prediction of phenomena like
+# gravitational waves, black holes, and time dilation in strong gravitational
+# fields.
+# --- Async streaming complete ---
+
+# === Chat with Runtime generation_kwargs ===
+# 1. Personalized Learning: AI can significantly enhance personalized
+# education by adapting to individual students' learning styles, paces, and
+# needs. Intelligent tutoring systems and adaptive learning platforms analyze
+# student performance data to provide tailored content, resources, and
+# practice problems, ensuring that each learner receives an optimal
+# educational experience. This level of customization helps to close
+# achievement gaps, engage students more effectively, and foster a deeper
+# understanding of complex concepts.
+#
+# 2. Efficient Administrative Tasks: AI streamlines various administrative
+# tasks in education, allowing educators and staff to focus more on teaching
+# and less on paperwork. Automated grading, for instance, can save time and
+# reduce human error in assessing assignments and exams. AI-powered tools can
+# also manage student records, schedule conflicts, and even predict
+# attendance patterns, enabling schools to allocate resources more
+# efficiently and maintain a smooth operational flow.
+#
+# 3. Enhanced Accessibility and Inclusion: AI has the potential to make
+# education more accessible and inclusive for students with diverse abilities
+# and backgrounds. For example, AI-driven speech recognition and
+# text-to-speech technologies can support students with learning
+# disabilities, dyslexia, or visual impairments. Furthermore, AI-powered
+# translation tools can break down language barriers, enabling international
+# students and those with limited English proficiency to engage more fully
+# in the learning process. Additionally, AI can help create immersive,
+# interactive learning experiences through virtual and augmented reality,
+# making education more engaging and engaging for all students, regardless of
+# their physical location or abilities.
+
+# === Serialization and Deserialization ===
+# The capital of France is Paris. It's known for iconic landmarks such as
+# the Eiffel Tower, Louvre Museum, and Notre-Dame Cathedral. Paris is also
+# renowned for its art, culture, cuisine, and fashion.

watsonx_haystack-0.1.0/examples/embedders_example.py

@@ -0,0 +1,59 @@
+# In order to run this example, you will need watsonx credentials.
+from haystack import Document, Pipeline
+from haystack.components.retrievers.in_memory import InMemoryEmbeddingRetriever
+from haystack.document_stores.in_memory import InMemoryDocumentStore
+from haystack.utils.auth import Secret
+
+from haystack_integrations.components.embedders.watsonx.document_embedder import WatsonxDocumentEmbedder
+from haystack_integrations.components.embedders.watsonx.text_embedder import WatsonxTextEmbedder
+
+# Step 1: Set your credentials as env var
+
+# Step 2: Create document store
+document_store = InMemoryDocumentStore(embedding_similarity_function="cosine")
+
+# Step 3: Prepare documents
+documents = [
+    Document(content="I saw a black horse running"),
+    Document(content="Germany has many big cities"),
+    Document(content="My name is Wolfgang and I live in Berlin"),
+]
+
+# Step 4: Embed documents
+document_embedder = WatsonxDocumentEmbedder(
+    model="ibm/slate-125m-english-rtrvr",
+    api_key=Secret.from_env_var("WATSONX_API_KEY"),
+    project_id=Secret.from_env_var("WATSONX_PROJECT_ID"),
+    api_base_url="https://us-south.ml.cloud.ibm.com",
+)
+documents_with_embeddings = document_embedder.run(documents)["documents"]
+
+document_store.write_documents(documents_with_embeddings)
+
+# Step 5: Build pipeline
+query_pipeline = Pipeline()
+query_pipeline.add_component(
+    "text_embedder",
+    WatsonxTextEmbedder(
+        model="ibm/slate-125m-english-rtrvr",
+        api_key=Secret.from_env_var("WATSONX_API_KEY"),
+        project_id=Secret.from_env_var("WATSONX_PROJECT_ID"),
+        api_base_url="https://us-south.ml.cloud.ibm.com",
+    ),
+)
+query_pipeline.add_component("retriever", InMemoryEmbeddingRetriever(document_store=document_store))
+query_pipeline.connect("text_embedder.embedding", "retriever.query_embedding")
+
+# Step 6: Run query
+query = "Who lives in Berlin?"
+result = query_pipeline.run({"text_embedder": {"text": query}})
+
+# Step 7: Print result
+doc = result["retriever"]["documents"][0]
+print("\nTop Result:")
+print(f"Content: {doc.content}")
+print(f"Score: {doc.score}")
+### Expected Result
+# Top Result:
+# Content: My name is Wolfgang and I live in Berlin
+# Score: 0.7287276769333577