instana_client.AIManagementApi

All URIs are relative to https://unit-tenant.instana.io

Method	HTTP request	Description
add_llm_egress_gateway	POST /api/llm/gateways	Create a new LLM gateway
delete_llm_egress_gateway	DELETE /api/llm/gateways/{id}	Delete a LLM egress gateway
enable_llm_egress_gateway	PUT /api/llm/gateways/{id}/enable	Set the enabled status of a LLM gateway
get_llm_capabilities	GET /api/llm/capabilities	Get all LLM capabilities
get_llm_egress_gateway_by_id	GET /api/llm/gateways/{id}	Get a LLM gateway by ID
get_llm_egress_gateways	GET /api/llm/gateways	Get all LLM gateways
test_llm_gateway	POST /api/llm/gateways/test	Test LLM gateway connection parameters
update_llm_egress_gateway	PUT /api/llm/gateways/{id}	Update an existing LLM gateway.

add_llm_egress_gateway

LLMEgressGateway add_llm_egress_gateway(llm_egress_gateway)

Create a new LLM gateway

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.llm_egress_gateway import LLMEgressGateway
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    llm_egress_gateway = {"name":"Example LLM egress Handler","description":"This is a sample custom handler used for testing.","aiModel":"watsonx-gpt-4","supports":{"capabilities":["anomaly-detection","remediation"]},"metadata":{"source":"user","version":"1.0.0"},"endpointUrl":"https://example.com/handler","endpointApiKey":"secret-api-key","watsonxKey":"watsonx-123","watsonxProject":"project-xyz","watsonxUrl":"https://watsonx.example.com","instanaAgents":{"agents":["agent-1","agent-2"]}} # LLMEgressGateway | 

    try:
        # Create a new LLM gateway
        api_response = api_instance.add_llm_egress_gateway(llm_egress_gateway)
        print("The response of AIManagementApi->add_llm_egress_gateway:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIManagementApi->add_llm_egress_gateway: %s\n" % e)

Parameters

Name	Type	Description	Notes
llm_egress_gateway	LLMEgressGateway

Return type

LLMEgressGateway

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_llm_egress_gateway

delete_llm_egress_gateway(id)

Delete a LLM egress gateway

Delete a LLM egress gateway by ID.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    id = 'id_example' # str | LLM gateway ID

    try:
        # Delete a LLM egress gateway
        api_instance.delete_llm_egress_gateway(id)
    except Exception as e:
        print("Exception when calling AIManagementApi->delete_llm_egress_gateway: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	LLM gateway ID

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_llm_egress_gateway

enable_llm_egress_gateway(id)

Set the enabled status of a LLM gateway

Enable a LLM gateway by ID. Any other enabled gateway for the same capability will be automatically disabled.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    id = 'id_example' # str | LLM gateway ID

    try:
        # Set the enabled status of a LLM gateway
        api_instance.enable_llm_egress_gateway(id)
    except Exception as e:
        print("Exception when calling AIManagementApi->enable_llm_egress_gateway: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	LLM gateway ID

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_llm_capabilities

List[str] get_llm_capabilities()

Get all LLM capabilities

Retrieve all available LLM capabilities.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)

    try:
        # Get all LLM capabilities
        api_response = api_instance.get_llm_capabilities()
        print("The response of AIManagementApi->get_llm_capabilities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIManagementApi->get_llm_capabilities: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized access - requires user authentication.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_llm_egress_gateway_by_id

LLMEgressGateway get_llm_egress_gateway_by_id(id)

Get a LLM gateway by ID

Retrieve a LLM gateway by ID.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.llm_egress_gateway import LLMEgressGateway
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    id = 'id_example' # str | LLM gateway ID

    try:
        # Get a LLM gateway by ID
        api_response = api_instance.get_llm_egress_gateway_by_id(id)
        print("The response of AIManagementApi->get_llm_egress_gateway_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIManagementApi->get_llm_egress_gateway_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	LLM gateway ID

Return type

LLMEgressGateway

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_llm_egress_gateways

List[LLMEgressGateway] get_llm_egress_gateways(enabled=enabled, capability=capability)

Get all LLM gateways

Retrieve all LLM gateways. Optionally filter by enabled status or capability.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.llm_egress_gateway import LLMEgressGateway
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    enabled = True # bool | Filter by enabled status (true/false) (optional)
    capability = 'capability_example' # str | Filter by capability name (optional)

    try:
        # Get all LLM gateways
        api_response = api_instance.get_llm_egress_gateways(enabled=enabled, capability=capability)
        print("The response of AIManagementApi->get_llm_egress_gateways:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIManagementApi->get_llm_egress_gateways: %s\n" % e)

Parameters

Name	Type	Description	Notes
enabled	bool	Filter by enabled status (true/false)	[optional]
capability	str	Filter by capability name	[optional]

Return type

List[LLMEgressGateway]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_llm_gateway

TestConnectionResponse test_llm_gateway(llm_gateway_test_connection_request)

Test LLM gateway connection parameters

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.llm_gateway_test_connection_request import LLMGatewayTestConnectionRequest
from instana_client.models.test_connection_response import TestConnectionResponse
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    llm_gateway_test_connection_request = {"id":"WATSONX","connectionParameters":{"url":"https://watsonx.example.com","apiKey":"secret-api-key","project":"project-xyz"}} # LLMGatewayTestConnectionRequest | 

    try:
        # Test LLM gateway connection parameters
        api_response = api_instance.test_llm_gateway(llm_gateway_test_connection_request)
        print("The response of AIManagementApi->test_llm_gateway:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIManagementApi->test_llm_gateway: %s\n" % e)

Parameters

Name	Type	Description	Notes
llm_gateway_test_connection_request	LLMGatewayTestConnectionRequest

Return type

TestConnectionResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_llm_egress_gateway

LLMEgressGateway update_llm_egress_gateway(id, llm_egress_gateway)

Update an existing LLM gateway.

Update an existing LLM gateway by ID.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.llm_egress_gateway import LLMEgressGateway
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.AIManagementApi(api_client)
    id = 'id_example' # str | LLM gateway ID
    llm_egress_gateway = {"name":"Example LLM egress Handler","description":"This is a sample custom handler used for testing.","aiModel":"watsonx-gpt-4","supports":{"capabilities":["anomaly-detection","remediation"]},"metadata":{"source":"user","version":"1.0.0"},"endpointUrl":"https://example.com/handler","endpointApiKey":"secret-api-key","watsonxKey":"watsonx-123","watsonxProject":"project-xyz","watsonxUrl":"https://watsonx.example.com","instanaAgents":{"agents":["agent-1","agent-2"]}} # LLMEgressGateway | 

    try:
        # Update an existing LLM gateway.
        api_response = api_instance.update_llm_egress_gateway(id, llm_egress_gateway)
        print("The response of AIManagementApi->update_llm_egress_gateway:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIManagementApi->update_llm_egress_gateway: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	LLM gateway ID
llm_egress_gateway	LLMEgressGateway

Return type

LLMEgressGateway

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

AIManagementApi.md

Latest commit

History

AIManagementApi.md

File metadata and controls

instana_client.AIManagementApi

add_llm_egress_gateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_llm_egress_gateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_llm_egress_gateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_llm_capabilities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_llm_egress_gateway_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_llm_egress_gateways

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_llm_gateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_llm_egress_gateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details