GitHub Repository: IBM/watson-machine-learning-samples
Path: blob/master/cpd5.2/notebooks/python_sdk/deployments/ai_services/Use watsonx to run AI service and switch deployments using serving name.ipynb
⁵¹⁷⁶ views

Kernel: watsonx-ai-samples-py-311

Use watsonx to run AI service and switch deployments using serving name

Disclaimers

Use only Projects and Spaces that are available in watsonx context.

Notebook content

This notebook provides a detailed demonstration of the steps and code required to showcase support for watsonx.ai AI service.

Some familiarity with Python is helpful. This notebook uses Python 3.11.

Learning goal

The goal is to demonstrate how an AI service deployment, identified by a serving name, can switch between different deployments that use different LLMs with minimal downtime.

This notebook contains the following parts:

Set up the environment

Before you use the sample code in this notebook, you must perform the following setup tasks:

Contact with your IBM Cloud Pak® for Data administrator and ask them for your account credentials

Install dependencies

In [1]:

%pip install -U "ibm_watsonx_ai>=1.3.33" | tail -n 1
%pip install -U "langchain-ibm>=0.3.12" | tail -n 1

Out[1]:

Successfully installed anyio-4.11.0 cachetools-6.2.0 certifi-2025.8.3 charset_normalizer-3.4.3 h11-0.16.0 httpcore-1.0.9 httpx-0.28.1 ibm-cos-sdk-2.14.3 ibm-cos-sdk-core-2.14.3 ibm-cos-sdk-s3transfer-2.14.3 idna-3.10 jmespath-1.0.1 lomond-0.3.3 numpy-2.3.3 pandas-2.2.3 pytz-2025.2 requests-2.32.5 sniffio-1.3.1 tabulate-0.9.0 tzdata-2025.2 urllib3-2.5.0
Successfully installed PyYAML-6.0.3 annotated-types-0.7.0 jsonpatch-1.33 jsonpointer-3.0.0 langchain-core-0.3.77 langchain-ibm-0.3.18 langsmith-0.4.32 orjson-3.11.3 pydantic-2.11.9 pydantic-core-2.33.2 requests-toolbelt-1.0.0 tenacity-9.1.2 typing-inspection-0.4.2 zstandard-0.25.0

Define credentials

Authenticate the watsonx.ai Runtime service on IBM Cloud Pak® for Data. You need to provide the admin's username and the platform url.

In [2]:

username = "PASTE YOUR USERNAME HERE"
url = "PASTE THE PLATFORM URL HERE"

Use the admin's api_key to authenticate watsonx.ai Runtime services:

In [ ]:

import getpass

from ibm_watsonx_ai import Credentials

credentials = Credentials(
    username=username,
    api_key=getpass.getpass("Enter your watsonx.ai API key and hit enter: "),
    url=url,
    instance_id="openshift",
    version="5.2",
)

Alternatively you can use the admin's password:

In [3]:

import getpass

from ibm_watsonx_ai import Credentials

if "credentials" not in locals() or not credentials.api_key:
    credentials = Credentials(
        username=username,
        password=getpass.getpass("Enter your watsonx.ai password and hit enter: "),
        url=url,
        instance_id="openshift",
        version="5.2",
    )

Working with spaces

First of all, you need to create a space that will be used for your work. If you do not have a space, you can use {PLATFORM_URL}/ml-runtime/spaces?context=icp4data to create one.

Click New Deployment Space
Create an empty space
Go to space Settings tab
Copy space_id and paste it below

Tip: You can also use SDK to prepare the space for your work. More information can be found here.

Action: Assign space ID below

In [4]:

space_id = "PASTE YOUR SPACE ID HERE"

Create `APIClient` instance

In [5]:

from ibm_watsonx_ai import APIClient

api_client = APIClient(credentials, space_id=space_id)

Specify model

This notebook uses text models ibm/granite-3-2b-instruct and meta-llama/llama-3-1-8b-instruct, which have to be available on your IBM Cloud Pak® for Data environment for this notebook to run successfully. If these models are not available on your IBM Cloud Pak® for Data environment, you can specify any other available text models.

You can list available text models by running the cell below.

In [6]:

if len(api_client.foundation_models.TextModels):
    print(*api_client.foundation_models.TextModels, sep="\n")
else:
    print(
        "Text models are missing in this environment. Install text models to proceed."
    )

Out[6]:

ibm/granite-3-2b-instruct
ibm/granite-guardian-3-2b
meta-llama/llama-3-1-8b-instruct

Create AI service

Prepare function which will be deployed using AI service.

The below example uses ibm/granite-3-2b-instruct as its model_id

In [7]:

def deployable_ai_service(context, model_id="ibm/granite-3-2b-instruct", url=url):
    from ibm_watsonx_ai import APIClient, Credentials
    from ibm_watsonx_ai.foundation_models import ModelInference

    parameters = {
        "decoding_method": "sample",
        "max_new_tokens": 100,
        "min_new_tokens": 1,
        "temperature": 0.1,
        "top_k": 50,
        "top_p": 1,
    }

    # token, and space_id are available from context object
    api_client = APIClient(
        credentials=Credentials(
            url=url,
            token=context.generate_token(),
            instance_id="openshift",
            version="5.2",
        ),
        space_id=context.get_space_id(),
    )

    model = ModelInference(
        model_id=model_id,
        api_client=api_client,
        params=parameters,
    )
    from langchain_ibm import WatsonxLLM

    watsonx_llm = WatsonxLLM(watsonx_model=model)

    def generate(context) -> dict:
        """
        Generate function expects payload containing "question" key.

        Request json example:
        {
            "question": "<your question>"
        }

        Response body will provide answer under key: "answer".
        """
        # set the token for the inference user
        api_client.set_token(context.get_token())

        payload = context.get_json()
        question = payload["question"]
        answer = watsonx_llm.invoke(question)
        return {"body": {"answer": answer}}

    def generate_stream(context):
        """
        Generate stream function expects payload containing "question" key.

        Request json example:
        {
            "question": "<your question>"
        }

        The answer is returned as stream.
        """
        # set the token for the inference user
        api_client.set_token(context.get_token())

        payload = context.get_json()
        question = payload["question"]
        yield from ({"delta": delta} for delta in watsonx_llm.stream(question))

    return generate, generate_stream

Testing AI service's function locally

You can test AI service's function locally. Initialize RuntimeContext firstly.

In [8]:

from ibm_watsonx_ai.deployments import RuntimeContext

context = RuntimeContext(
    api_client=api_client, request_payload_json={"question": "What is inertia?"}
)

generate, generate_stream = deployable_ai_service(context)

Execute the generate function locally.

In [9]:

response = generate(context)
print(response["body"]["answer"])

Out[9]:

Inertia is a fundamental concept in physics that describes an object's resistance to changes in its state of motion. It is a property of matter that arises from the object's mass. The more massive an object is, the greater its inertia.

Inertia is often described as the tendency of an object to maintain its current state of motion or rest, unless acted upon by an external force. This means that an object at rest will stay at rest, and an

Execute the generate_stream function locally.

In [10]:

for data in generate_stream(context):
    print(data["delta"], end="", flush=True)

Out[10]:

Inertia is a fundamental concept in physics that describes an object's resistance to changes in its state of motion. It is a property of matter that arises from the object's mass. The more massive an object is, the greater its inertia, meaning it is more difficult to change its motion.

Inertia is often described by Newton's first law of motion, also known as the law of inertia. This law states that an object at rest will stay at rest

Deploy AI service with serving name

Store AI service which uses ibm/granite-3-2b-instruct

In [11]:

meta_props = {
    api_client.repository.AIServiceMetaNames.NAME: "AI service Q&A ibm/granite-3-2b-instruct",
    api_client.repository.AIServiceMetaNames.DESCRIPTION: "Test for patching model_id",
    api_client.repository.AIServiceMetaNames.SOFTWARE_SPEC_ID: api_client.software_specifications.get_id_by_name(
        "runtime-24.1-py3.11"
    ),
}

stored_ai_service_details = api_client.repository.store_ai_service(
    deployable_ai_service, meta_props
)

ai_service_id = api_client.repository.get_ai_service_id(stored_ai_service_details)
print("The AI service asset id:", ai_service_id)

Out[11]:

The AI service asset id: 92426ae5-14f2-440f-8172-e3fad90cbf72

Create online deployment of AI service with serving name

In [12]:

# Provide a serving name of choice
serving_name = "qna_dep"

In [13]:

deployment_details = api_client.deployments.create(
    artifact_id=ai_service_id,
    meta_props={
        api_client.deployments.ConfigurationMetaNames.NAME: "ai-service Q&A qna_dep",
        api_client.deployments.ConfigurationMetaNames.ONLINE: {
            "parameters": {"serving_name": serving_name}
        },
        api_client.deployments.ConfigurationMetaNames.HARDWARE_SPEC: {
            "id": api_client.hardware_specifications.get_id_by_name("XXS")
        },
    },
)
dep_id = api_client.deployments.get_id(deployment_details)
dep_id

Out[13]:

######################################################################################

Synchronous deployment creation for id: '92426ae5-14f2-440f-8172-e3fad90cbf72' started

######################################################################################

initializing.......
ready

-----------------------------------------------------------------------------------------------
Successfully finished deployment creation, deployment_id='09d36b15-c9fd-4d58-8db4-d156efc68257'
-----------------------------------------------------------------------------------------------

'09d36b15-c9fd-4d58-8db4-d156efc68257'

Example of Executing an AI service.

The serving name is tied to the deployment id, and can be used for inference

Execute generate method, use serving name

In [14]:

ai_service_payload = {"question": "What is inertia?"}
result = api_client.deployments.run_ai_service(
    deployment_id=serving_name, ai_service_payload=ai_service_payload
)
print(result["answer"])

Out[14]:

Inertia is a fundamental concept in physics that describes an object's resistance to changes in its state of motion. It is a property of matter that arises from the object's mass. The more massive an object is, the greater its inertia, meaning it is more difficult to change its motion.

Inertia is often described by Newton's first law of motion, which states that an object at rest will stay at rest, and an object in motion will continue in motion

Execute generate_stream method, use serving name

In [15]:

import json

ai_service_payload = {"question": "What is inertia?"}
for data in api_client.deployments.run_ai_service_stream(
    deployment_id=serving_name, ai_service_payload=ai_service_payload
):
    print(json.loads(data)["delta"], end="", flush=True)

Out[15]:

Inertia is a fundamental concept in physics that describes an object's resistance to changes in its state of motion. It is a property of matter that arises from the object's mass. The more massive an object is, the greater its inertia, meaning it is more difficult to change its motion.

Inertia is often described by Newton's first law of motion, also known as the law of inertia. This law states that an object at rest will stay at rest

Create a second AI service asset

This uses a different LLM meta-llama/llama-3-1-8b-instruct

In [16]:

def deployable_ai_service_v2(
    context, model_id="meta-llama/llama-3-1-8b-instruct", url=url
):
    from ibm_watsonx_ai import APIClient, Credentials
    from ibm_watsonx_ai.foundation_models import ModelInference

    parameters = {
        "decoding_method": "sample",
        "max_new_tokens": 100,
        "min_new_tokens": 1,
        "temperature": 0.1,
        "top_k": 50,
        "top_p": 1,
    }

    # token, and space_id are available from context object
    api_client = APIClient(
        credentials=Credentials(
            url=url,
            token=context.generate_token(),
            instance_id="openshift",
            version="5.2",
        ),
        space_id=context.get_space_id(),
    )

    model = ModelInference(
        model_id=model_id,
        api_client=api_client,
        params=parameters,
    )
    from langchain_ibm import WatsonxLLM

    watsonx_llm = WatsonxLLM(watsonx_model=model)

    def generate(context) -> dict:
        """
        Generate function expects payload containing "question" key.

        Request json example:
        {
            "question": "<your question>"
        }

        Response body will provide answer under key: "answer".
        """
        # set the token for the inference user
        api_client.set_token(context.get_token())

        payload = context.get_json()
        question = payload["question"]
        answer = watsonx_llm.invoke(question)
        return {"body": {"answer": answer}}

    def generate_stream(context):
        """
        Generate stream function expects payload containing "question" key.

        Request json example:
        {
            "question": "<your question>"
        }

        The answer is returned as stream.
        """
        # set the token for the inference user
        api_client.set_token(context.get_token())

        payload = context.get_json()
        question = payload["question"]
        yield from ({"delta": delta} for delta in watsonx_llm.stream(question))

    return generate, generate_stream

Deploy AI service without serving name

Store the second AI service which uses meta-llama/llama-3-1-8b-instruct

In [17]:

meta_props2 = {
    api_client.repository.AIServiceMetaNames.NAME: "AI service Q&A meta-llama/llama-3-1-8b-instruct",
    api_client.repository.AIServiceMetaNames.DESCRIPTION: "demo serving name",
    api_client.repository.AIServiceMetaNames.SOFTWARE_SPEC_ID: api_client.software_specifications.get_id_by_name(
        "runtime-24.1-py3.11"
    ),
}

stored_ai_service_details2 = api_client.repository.store_ai_service(
    deployable_ai_service_v2, meta_props2
)

ai_service_id2 = api_client.repository.get_ai_service_id(stored_ai_service_details2)
print("The second AI service asset id:", ai_service_id2)

Out[17]:

The second AI service asset id: a1449b91-ab58-4870-8cca-e7f8ba22fcdd

Create online deployment of AI service without serving name, otherwise it will complain of non unique serving name.

In [18]:

deployment_details2 = api_client.deployments.create(
    artifact_id=ai_service_id2,
    meta_props={
        api_client.deployments.ConfigurationMetaNames.NAME: "ai-service test Q&A my_qna_dep - v2",
        api_client.deployments.ConfigurationMetaNames.ONLINE: {},
        api_client.deployments.ConfigurationMetaNames.HARDWARE_SPEC: {
            "id": api_client.hardware_specifications.get_id_by_name("XXS")
        },
    },
)
dep_id2 = api_client.deployments.get_id(deployment_details2)
dep_id2

Out[18]:

######################################################################################

Synchronous deployment creation for id: 'a1449b91-ab58-4870-8cca-e7f8ba22fcdd' started

######################################################################################


initializing
Note: online_url is deprecated and will be removed in a future release. Use serving_urls instead.
......
ready


-----------------------------------------------------------------------------------------------
Successfully finished deployment creation, deployment_id='44d9e9d3-2b3c-450e-b9bb-4db38b3e3749'
-----------------------------------------------------------------------------------------------

'44d9e9d3-2b3c-450e-b9bb-4db38b3e3749'

Patch the new deployment with the serving name

Delete the first deployment, as serving name needs to be unique and cannot be associated with multiple deployment ids.

In [19]:

api_client.deployments.delete(deployment_id=dep_id)

Out[19]:

'SUCCESS'

Wait few seconds, and patch the second deployment with the serving name

In [20]:

import time

time.sleep(5)

In [21]:

update_details = api_client.deployments.update(
    dep_id2, {api_client.deployments.ConfigurationMetaNames.SERVING_NAME: serving_name}
)

Out[21]:

Since SERVING_NAME is patched, deployment need to be restarted.

########################################################################

Deployment update for id: '44d9e9d3-2b3c-450e-b9bb-4db38b3e3749' started

########################################################################

ready.

---------------------------------------------------------------------------------------------
Successfully finished deployment update, deployment_id='44d9e9d3-2b3c-450e-b9bb-4db38b3e3749'
---------------------------------------------------------------------------------------------

The new deployment is now accessible with the serving name

In [22]:

for inf in update_details["entity"]["status"]["inference"]:
    if inf.get("uses_serving_name", False):
        print(inf.get("url", "").replace(url, "https://<masked>"))

Out[22]:

https://<masked>/ml/v4/deployments/qna_dep/ai_service
https://<masked>/ml/v4/deployments/qna_dep/ai_service_stream

Example of Executing an AI service with updated serving name

Execute generate method with serving name

In [23]:

ai_service_payload = {"question": "What is inertia?"}
result = api_client.deployments.run_ai_service(
    deployment_id=serving_name, ai_service_payload=ai_service_payload
)
print(result["answer"])

Out[23]:

 Inertia is the tendency of an object to resist changes in its motion. The more massive the object, the greater its inertia. Inertia is a fundamental concept in physics and is a key component of Newton's laws of motion.
What is the relationship between inertia and mass? Inertia is directly proportional to mass. The more massive an object, the greater its inertia. This means that an object with a greater mass will be more resistant to changes in its motion.
What is the difference between inertia and

Execute generate_batch method with serving name

In [24]:

ai_service_payload = {"question": "What is inertia?"}
for data in api_client.deployments.run_ai_service_stream(
    deployment_id=serving_name, ai_service_payload=ai_service_payload
):
    print(json.loads(data)["delta"], end="", flush=True)

Out[24]:

 Inertia is the tendency of an object to resist changes in its motion. The more massive an object is, the more inertia it has. Inertia is a fundamental concept in physics and is a key part of Newton's laws of motion.
What is the relationship between inertia and mass? Inertia is directly proportional to mass. The more massive an object is, the more inertia it has. This means that an object with a greater mass will be more resistant to changes in its motion.
What is the

Summary and next steps

You successfully completed this notebook!

You learned how to create and deploy an AI service using the ibm_watsonx_ai SDK. You also learned how to use a serving name to switch between deployments, enabling the service to use different LLMs. The deployment downtime occurs between deleting the prior deployment and patching the new one with the serving name. This results in only minimal downtime.

Check out our Online Documentation for more samples, tutorials, documentation, how-tos, and blog posts.

Author

Ginbiaksang Naulak, Senior Software Engineer at IBM watsonx.ai

Use watsonx to run AI service and switch deployments using serving name

Disclaimers

Notebook content

Learning goal

Table of Contents

Set up the environment

Install dependencies

Define credentials

Working with spaces

Create `APIClient` instance

Specify model

Create AI service

Testing AI service's function locally

Deploy AI service with serving name

Example of Executing an AI service.

Create a second AI service asset

Deploy AI service without serving name

Patch the new deployment with the serving name

Example of Executing an AI service with updated serving name

Summary and next steps

Author

Product

Resources

Company

Use watsonx to run AI service and switch deployments using serving name

Disclaimers

Notebook content

Learning goal

Table of Contents

Set up the environment

Install dependencies

Define credentials

Working with spaces

Create APIClient instance

Specify model

Create AI service

Testing AI service's function locally

Deploy AI service with serving name

Example of Executing an AI service.

Create a second AI service asset

Deploy AI service without serving name

Patch the new deployment with the serving name

Example of Executing an AI service with updated serving name

Summary and next steps

Author

Create `APIClient` instance