Unable to run Fabric-DataAgent-OpenAI-Client-sample notebook

[blaidddrwg]

I have started with a clean dev box, a clean Conda installation with Python 3.10, and a clean github clone of the Fabric-Samples repo.

I am trying to run the Fabric-DataAgent-OpenAI-Client-sample Jupyter notebook. The first cell - i.e. install the fabric data agent sdk, went fine. 

Trying to run the second cell, which is titled "Import Data Agent methods and specify Data Agent name", gives me the following error:

Which basically says that it couldn't find the synapse.ml.fabric package. I see that it is not there on the SynapseML repo/package list either.

How can I fix this? Where do I get synapse.ml.fabric package?

[burakkaragoz]

Hi @blaidddrwg ,

I totally get where you’re coming from, this tripped me up as well when I first tried out the sample. So, the “No module named ‘synapse’” error means that the synapse.ml.fabric package isn’t available in your environment, and you’re right, it doesn’t actually show up in the SynapseML repo/package list either.

From what I’ve seen, that specific module (synapse.ml.fabric) isn’t released publicly yet, and it’s not available via pip or conda at the moment. The Fabric Data Agent SDK itself is available, but some of the internal dependencies (like synapse.ml.fabric) seem to be only present in certain Microsoft-hosted environments or maybe internal builds.

A couple of things you could try:

• Double check if there’s a requirements.txt or env.yml in the sample repo, sometimes they sneak in private feed configs or alternative install instructions there.
• If there’s nothing there, you might want to reach out to the repo owners or check if there’s a preview program for the SDK or those specific libraries. Sometimes these packages are rolled out in waves.
• As a last resort, you could try running the notebook directly inside a Microsoft Fabric workspace (if you have access) since those environments might have the needed package pre-installed.

Hope that helps a little, even if it’s not the perfect answer. I wish this package was just pip installable, would make life way easier 🙂

If my response resolved your query, kindly mark it as the Accepted Solution to assist others. Additionally, I would be grateful for a 'Kudos' if you found my response helpful.

[v-tsaipranay]

Hi @blaidddrwg ,

Thank you for reaching out to the Microsoft Fabric Community.

The error you're seeing (ModuleNotFoundError: No module named 'synapse.ml.fabric') is happening because the synapse.ml.fabric module used in the sample notebook isn’t publicly available. It seems to be part of an internal or preview-only package that isn't currently shared through public sources like PyPI or the SynapseML GitHub repository.

To proceed, we recommend using the supported approach for working with the Fabric Data Agent. Microsoft provides an SDK and REST API that you can use instead, and the full guidance is available here:

Fabric data agent Python SDK (preview) - Microsoft Fabric | Microsoft Learn

Hope this helps. Please reach out for further assistance.

If this post helps, then please consider to Accept as the solution to help the other members find it more quickly and a kudos would be appreciated.

Thank you.