Wyler.metge (talk | contribs) Updated via BpClonePage extension. Source page: draft:Contact-center-administrator-guide/CallCenterConfiguration/IntegrationAccounts/AIProvider |
Wyler.metge (talk | contribs) Updated via BpClonePage extension. Source page: draft:Contact-center-administrator-guide/CallCenterConfiguration/IntegrationAccounts/AIProvider |
||
| Line 4: | Line 4: | ||
Each AI Provider offers a number of language models with varying capabilities. The following AI Providers are supported: | Each AI Provider offers a number of language models with varying capabilities. The following AI Providers are supported: | ||
* [[ | * [[#OpenAI Properties|OpenAI]] | ||
* [[ | |||
{{Note|Learn how to add an AI integration account and use the AI Agent block in your scenarios with the [[Tutorials-for-admins/AI/HowtoUseAIAgentinScenarios|AI Agent tutorial]]}} | * [[#Google Vertex AI Properties|Google Vertex AI]] | ||
* [[#Anthropic_Claude_AI_Properties|Anthropic Claude AI]] | |||
* [[#Custom_AI_Gateway_Properties|Custom AI Gateway]] | |||
{{Note|Learn how to add an AI integration account and use the [[Scenario-builder-reference-guide/ScenarioBlocks/AIAgent|AI Agent scenario block]] in your scenarios with the [[Tutorials-for-admins/AI/HowtoUseAIAgentinScenarios|AI Agent tutorial]]}} | |||
== OpenAI Properties == | == OpenAI Properties == | ||
After adding an OpenAI account, the properties dialog will appear. Enter the API key for your OpenAI account and click the '''Read Models''' button to retrieve the list of GPT models that can be accessed from your account. Once configured, the account can be selected as an ''AI Provider'' in an AI Agent scenario block. | After adding an OpenAI account, the properties dialog will appear. Enter the API key for your OpenAI account and click the '''Read Models''' button to retrieve the list of GPT models that can be accessed from your account. Once configured, the account can be selected as an ''AI Provider'' in an AI Agent scenario block. | ||
[[File:OpenAI integration account.png|center|thumb| | [[File:OpenAI integration account.png|center|thumb|481x481px|OpenAI integration account properties]] | ||
=== Name === | === Name === | ||
| Line 32: | Line 38: | ||
== Google Vertex AI Properties == | == Google Vertex AI Properties == | ||
After adding a Google Vertex AI account, the properties dialog will appear. In Properties, you will upload the JSON-formatted key file for the service account, select the desired region, and choose the model. Once configured, the account can be selected as an ''AI Provider'' in an AI Agent scenario block. Note that [[Faq/VertexAI#How_do_I_Activate_Vertex_AI_for_a_Project.3F|Vertex AI must be enabled]] for the Google Cloud Platform project associated with the service account used for the integration. | After adding a Google Vertex AI account, the properties dialog will appear. In Properties, you will upload the JSON-formatted key file for the service account, select the desired region, and choose the model. Once configured, the account can be selected as an ''AI Provider'' in an AI Agent scenario block. Note that [[Faq/VertexAI#How_do_I_Activate_Vertex_AI_for_a_Project.3F|Vertex AI must be enabled]] for the Google Cloud Platform project associated with the service account used for the integration. | ||
[[File:Google Vertex AI Integration Account.png|center|thumb| | [[File:Google Vertex AI Integration Account.png|center|thumb|546x546px|Google Vertex AI integration account properties]] | ||
=== Name === | === Name === | ||
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name. | The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name. | ||
| Line 49: | Line 55: | ||
=== Test Connection === | === Test Connection === | ||
Click to verify that Bright Pattern Contact Center can connect to your Google Vertex AI account using the provided credentials and region. | Click to verify that Bright Pattern Contact Center can connect to your Google Vertex AI account using the provided credentials and region. | ||
== Anthropic Claude AI Properties == | |||
After adding an ''Anthropic Claude AI'' account, the properties dialog will appear. Enter the API key for your [https://console.anthropic.com/ Anthropic developer account] and click the '''Read Models''' button to retrieve the list of Claude models that can be accessed from your account. Once configured, the account can be selected as an ''AI Provider'' for relevant features, such as the [[Scenario-builder-reference-guide/ScenarioBlocks/AIAgent|AI Agent]] and [[Scenario-builder-reference-guide/ScenarioBlocks/AskAI|Ask AI]] scenario blocks. | |||
[[File:Anthropic Claude AI integration account settings.png|center|thumb|526x526px|Anthropic Claude AI integration account properties]] | |||
=== Name === | |||
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name. | |||
=== Type === | |||
Automatically set as ''AI Providers (Anthropic Claude AI)''. | |||
=== API Key === | |||
The Anthropic API key to use with this integration account. You can create and manage API keys from your [https://console.anthropic.com Anthropic account console]. | |||
=== Model === | |||
Select the Claude model that this integration account will provide. If the list is empty, click the '''Read Models''' button to retrieve the list of models. Refer to the Anthropic models documentation for information about model capabilities and pricing. | |||
=== Read Models === | |||
Click this button to refresh the list of Claude models available to your Anthropic account. | |||
=== Test Connection === | |||
Click to verify that Bright Pattern Contact Center can connect to your Anthropic account using the provided API key. | |||
== Custom AI Gateway Properties == | |||
After adding a Custom AI Gateway account, the properties dialog will appear. This account type allows you to integrate with any AI provider that offers an API method compatible with the [https://platform.openai.com/docs/api-reference/chat/create OpenAI Chat Completions API endpoint]. Once configured, the account can be selected as an ''AI Provider'' for relevant features, such as the [[Scenario-builder-reference-guide/ScenarioBlocks/AIAgent|AI Agent]] and [[Scenario-builder-reference-guide/ScenarioBlocks/AskAI|Ask AI]] scenario blocks. | |||
[[File:Custom AI Gateway integration account settings.png|center|thumb|530x530px|Custom gateway settings]] | |||
=== Name === | |||
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name. | |||
=== Type === | |||
Automatically set as ''AI Providers (Custom AI Gateway)''. | |||
=== URL === | |||
The full path to the custom AI provider's API endpoint for chat completions (e.g., <code><nowiki>https://api.example.com/v1/chat/completions</nowiki></code>). The endpoint '''must conform''' to the [https://platform.openai.com/docs/api-reference/chat/create OpenAI Chat Completions API specification]. If the protocol (<code>http://</code> or <code>https://</code>) is omitted, <code>https://</code> is assumed. | |||
=== API Key === | |||
The API key to use with the custom AI provider. | |||
=== Model === | |||
Enter the exact Model ID that this integration account will provide (e.g., <code>llama3-70b-8192</code>). This value is defined by your AI provider. | |||
=== Test Connection === | |||
Click to verify that Bright Pattern Contact Center can connect to the specified URL using the provided API key and model. | |||
== Recommended Reading == | == Recommended Reading == | ||
| Line 54: | Line 104: | ||
* [[Scenario-builder-reference-guide/ScenarioBlocks/AIAgent|AI Agent scenario block]] | * [[Scenario-builder-reference-guide/ScenarioBlocks/AIAgent|AI Agent scenario block]] | ||
* [[Tutorials-for-admins/AI/HowtoUseAIAgentinScenarios|How to use the AI Agent in scenarios]] | * [[Tutorials-for-admins/AI/HowtoUseAIAgentinScenarios|How to use the AI Agent in scenarios]] | ||
* [[Scenario-builder-reference-guide/ScenarioBlocks/AskAI|Ask AI scenario block]] | |||
Revision as of 07:36, 29 July 2025
AI Provider Integration
AI Provider integrations allow you to take advantage of language models from third-party AI providers in voice and chat scenarios. These models allow the AI Agent scenario block to hold purposeful conversations with customers and extract relevant data to scenario variables, which can then be used for further automation.
Each AI Provider offers a number of language models with varying capabilities. The following AI Providers are supported:
|
Learn how to add an AI integration account and use the AI Agent scenario block in your scenarios with the AI Agent tutorial | |
OpenAI Properties
After adding an OpenAI account, the properties dialog will appear. Enter the API key for your OpenAI account and click the Read Models button to retrieve the list of GPT models that can be accessed from your account. Once configured, the account can be selected as an AI Provider in an AI Agent scenario block.
Name
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name.
Type
Automatically set as AI Providers (OpenAI).
API Key
The OpenAI API key to use with this integration account. The API keys page of your OpenAI account allows you to generate API keys.
GPT Model
Select the GPT model that this integration account will provide. If the list is empty, click the Read Models button to retrieve the list of models. Refer to the OpenAI models documentation for information about model capabilities and pricing.
Read Models
Click this button to refresh the list of GPT models available to your OpenAI account.
Test Connection
Click to verify that Bright Pattern Contact Center can connect to your OpenAI account using the provided API key.
Google Vertex AI Properties
After adding a Google Vertex AI account, the properties dialog will appear. In Properties, you will upload the JSON-formatted key file for the service account, select the desired region, and choose the model. Once configured, the account can be selected as an AI Provider in an AI Agent scenario block. Note that Vertex AI must be enabled for the Google Cloud Platform project associated with the service account used for the integration.
Name
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name.
Type
Automatically set as AI Providers (Google Vertex AI).
Region
Select the Google Cloud region for your Vertex AI instance from the dropdown list. The list is automatically populated with available regions.
Credentials JSON
Upload the JSON-formatted key file for the Google Cloud service account that will provide the model. Refer to the Vertex AI FAQ article for more information on how to retrieve your credentials.
Model
Select the desired Vertex AI model that will be provided by this integration account. Refer to the Google models documentation for information about model capabilities and pricing.
Test Connection
Click to verify that Bright Pattern Contact Center can connect to your Google Vertex AI account using the provided credentials and region.
Anthropic Claude AI Properties
After adding an Anthropic Claude AI account, the properties dialog will appear. Enter the API key for your Anthropic developer account and click the Read Models button to retrieve the list of Claude models that can be accessed from your account. Once configured, the account can be selected as an AI Provider for relevant features, such as the AI Agent and Ask AI scenario blocks.
Name
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name.
Type
Automatically set as AI Providers (Anthropic Claude AI).
API Key
The Anthropic API key to use with this integration account. You can create and manage API keys from your Anthropic account console.
Model
Select the Claude model that this integration account will provide. If the list is empty, click the Read Models button to retrieve the list of models. Refer to the Anthropic models documentation for information about model capabilities and pricing.
Read Models
Click this button to refresh the list of Claude models available to your Anthropic account.
Test Connection
Click to verify that Bright Pattern Contact Center can connect to your Anthropic account using the provided API key.
Custom AI Gateway Properties
After adding a Custom AI Gateway account, the properties dialog will appear. This account type allows you to integrate with any AI provider that offers an API method compatible with the OpenAI Chat Completions API endpoint. Once configured, the account can be selected as an AI Provider for relevant features, such as the AI Agent and Ask AI scenario blocks.
Name
The unique name of this integration account. Because you can have multiple integration accounts of the same type, it is recommended to use a descriptive name.
Type
Automatically set as AI Providers (Custom AI Gateway).
URL
The full path to the custom AI provider's API endpoint for chat completions (e.g., https://api.example.com/v1/chat/completions). The endpoint must conform to the OpenAI Chat Completions API specification. If the protocol (http:// or https://) is omitted, https:// is assumed.
API Key
The API key to use with the custom AI provider.
Model
Enter the exact Model ID that this integration account will provide (e.g., llama3-70b-8192). This value is defined by your AI provider.
Test Connection
Click to verify that Bright Pattern Contact Center can connect to the specified URL using the provided API key and model.
Recommended Reading
For more information on using AI integrations, refer to the following: