IBM Generative AI Python SDK (Tech Preview)
============================================

This is the Python SDK for IBM Foundation Models Studio to bring IBM Generative AI into Python programs and to also extend it with useful operations and types.

You can start a trial version or request a demo via https://www.ibm.com/products/watsonx-ai.

.. toctree::
    :hidden:

    Getting Started <getting_started>
    V3 Migration Guide <v3_migration_guide>
    V2 Migration Guide <v2_migration_guide>
    Examples <rst_source/examples>
    FAQ <faq>
    Changelog <changelog>

.. admonition:: Migration to V3
   :class: tip

   We recently updated the SDK with improved moderations and schemas. See the :doc:`V3 Migration Guide <v3_migration_guide>`.

.. admonition:: Migration to V2
   :class: tip

   We rewrote nearly the whole SDK to be faster and more reliable than V1 and would bring you all the latest features
   available on the API. To easily migrate, we prepared the :doc:`V2 Migration Guide <v2_migration_guide>`.

Top Features
------------

✅ Very Performant.

✅ Generated Typings directly from the API.

✅ Smart Requests Concurrency Handling.

✅ Retry Mechanism in case of network or API failure.

✅ Batching Large Requests automatically.

✅ Easy to extend (see :ref:`example <examples.extensions.extra>`).

✅ Integrations to :ref:`LangChain <examples.extensions.langchain>`, :ref:`LLamaIndex <examples.extensions.llama_index>` and :ref:`HuggingFace <examples.extensions.huggingface>`.

✅ :ref:`LocalServer extension <examples.extensions.localserver>` – run local API compatible with SDK.



First Steps
-----------

To start using the SDK and the power of generative AI, ensure you have an API key from one of the supported environments.
Then jump straight into :doc:`Getting Started <getting_started>` page and explore all prepared :doc:`examples <rst_source/examples>`.


Important pages
------------------

* :doc:`Getting Started <getting_started>`
* :doc:`Examples <rst_source/examples>`
* :doc:`V3 Migration Guide <v3_migration_guide>`
* :doc:`V2 Migration Guide <v2_migration_guide>`
* :doc:`Extensions <extensions>`
* :doc:`FAQ <faq>`
* :doc:`Modules<rst_source/modules>`
* :ref:`modindex`
* :ref:`genindex`