scc_firewall_manager_sdk.AIAssistantApi¶

All URIs are relative to the base URL, which depends on the region your organization is deployed to.

Region	Base URL
US	https://api.us.security.cisco.com/firewall
EU	https://api.eu.security.cisco.com/firewall
APJ	https://api.apj.security.cisco.com/firewall
AU	https://api.au.security.cisco.com/firewall
IN	https://api.in.security.cisco.com/firewall
UAE	https://api.uae.security.cisco.com/firewall

Method	HTTP request	Description
ask_ai_assistant_in_existing_conversation	POST /v1/ai-assistant/conversations/{conversationUid}	Ask AI Assistant (Existing Conversation)
ask_ai_assistant_in_new_conversation	POST /v1/ai-assistant/conversations	Ask AI Assistant (New Conversation)
get_ai_assistant_conversation_messages	GET /v1/ai-assistant/conversations/{conversationUid}/messages	Get Messages
get_conversation	GET /v1/ai-assistant/conversations/{conversationUid}	Get Conversation
get_conversations	GET /v1/ai-assistant/conversations	Get Conversations

ask_ai_assistant_in_existing_conversation¶

CdoTransaction ask_ai_assistant_in_existing_conversation(conversation_uid, ai_question)

Ask AI Assistant (Existing Conversation)

Ask the AI Assistant a question in the context of an existing conversation with the AI Assistant.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ai_question import AiQuestion
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.AIAssistantApi(api_client)
    conversation_uid = 'conversation_uid_example' # str | 
    ai_question = scc_firewall_manager_sdk.AiQuestion() # AiQuestion | 

    try:
        # Ask AI Assistant (Existing Conversation)
        api_response = api_instance.ask_ai_assistant_in_existing_conversation(conversation_uid, ai_question)
        print("The response of AIAssistantApi->ask_ai_assistant_in_existing_conversation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAssistantApi->ask_ai_assistant_in_existing_conversation: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
conversation_uid	str
ai_question	AiQuestion

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the question.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

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

ask_ai_assistant_in_new_conversation¶

CdoTransaction ask_ai_assistant_in_new_conversation(ai_question)

Ask AI Assistant (New Conversation)

Start a new conversation with the AI Assistant by asking a question.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ai_question import AiQuestion
from scc_firewall_manager_sdk.models.cdo_transaction import CdoTransaction
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.AIAssistantApi(api_client)
    ai_question = scc_firewall_manager_sdk.AiQuestion() # AiQuestion | 

    try:
        # Ask AI Assistant (New Conversation)
        api_response = api_instance.ask_ai_assistant_in_new_conversation(ai_question)
        print("The response of AIAssistantApi->ask_ai_assistant_in_new_conversation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAssistantApi->ask_ai_assistant_in_new_conversation: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
ai_question	AiQuestion

Return type¶

CdoTransaction

Authorization¶

bearerAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
202	Security Cloud Control Transaction object that can be used to track the status of the question.	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

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

get_ai_assistant_conversation_messages¶

List[AiMessage] get_ai_assistant_conversation_messages(conversation_uid)

Get Messages

Get a list of messages in a single AI Assistant conversation. Note: this endpoint is not paginated, and returns the full list of messages.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ai_message import AiMessage
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.AIAssistantApi(api_client)
    conversation_uid = 'conversation_uid_example' # str | The unique identifier, represented as a UUID, of the conversation in Security Cloud Control.

    try:
        # Get Messages
        api_response = api_instance.get_ai_assistant_conversation_messages(conversation_uid)
        print("The response of AIAssistantApi->get_ai_assistant_conversation_messages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAssistantApi->get_ai_assistant_conversation_messages: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
conversation_uid	str	The unique identifier, represented as a UUID, of the conversation in Security Cloud Control.

Return type¶

List[AiMessage]

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	List of Conversation Messages	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

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

get_conversation¶

AiConversation get_conversation(conversation_uid)

Get Conversation

Get an AI Assistant conversation by UID in the Security Cloud Control tenant.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ai_conversation import AiConversation
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.AIAssistantApi(api_client)
    conversation_uid = 'conversation_uid_example' # str | The unique identifier, represented as a UUID, of the conversation in Security Cloud Control.

    try:
        # Get Conversation
        api_response = api_instance.get_conversation(conversation_uid)
        print("The response of AIAssistantApi->get_conversation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAssistantApi->get_conversation: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
conversation_uid	str	The unique identifier, represented as a UUID, of the conversation in Security Cloud Control.

Return type¶

AiConversation

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Conversation object	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
404	Entity not found.	-
500	Internal server error.	-

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

get_conversations¶

AiAssistantConversationPage get_conversations(limit=limit, offset=offset, sort=sort)

Get Conversations

Get a list of AI Assistant Conversations. Note: the total number of conversations is set to -1 as this information is currently unavailable.

Example¶

• Bearer (JWT) Authentication (bearerAuth):

import scc_firewall_manager_sdk
from scc_firewall_manager_sdk.models.ai_assistant_conversation_page import AiAssistantConversationPage
from scc_firewall_manager_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.us.security.cisco.com/firewall
# See configuration.py for a list of all supported configuration parameters.
configuration = scc_firewall_manager_sdk.Configuration(
    host = "https://api.us.security.cisco.com/firewall"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = scc_firewall_manager_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with scc_firewall_manager_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = scc_firewall_manager_sdk.AIAssistantApi(api_client)
    limit = '50' # str | Number of results to retrieve. (optional) (default to '50')
    offset = '0' # str | Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified. (optional) (default to '0')
    sort = ['name:DESC'] # List[str] | The fields to sort results by. (optional)

    try:
        # Get Conversations
        api_response = api_instance.get_conversations(limit=limit, offset=offset, sort=sort)
        print("The response of AIAssistantApi->get_conversations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling AIAssistantApi->get_conversations: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
limit	str	Number of results to retrieve.	[optional] [default to '50']
offset	str	Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.	[optional] [default to '0']
sort	List[str]	The fields to sort results by.	[optional]

Return type¶

AiAssistantConversationPage

Authorization¶

bearerAuth

HTTP request headers¶

• Content-Type: Not defined
• Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	List of Conversations	-
400	Invalid input provided. Check the response for details.	-
401	Request not authorized.	-
403	User does not have sufficient privileges to perform this operation.	-
500	Internal server error.	-

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