Azure Text Analytics Connection
Overview
The Azure Text Analytics connection allows IB-X Agents to connect to Azure AI Language using customer-managed Azure credentials.
Use this connection with workflow activities that analyze text for information such as:
- Sentiment
- Language
- Key phrases
- Categorized entities
- Personally identifiable information (PII)
Configuring an Azure Text Analytics connection is optional when using IB-X Azure Text Analytics Credits through the IntelliBuddies Integration Gateway.
Connection Properties
Configure the following properties when creating an Azure Text Analytics connection.
| Property | Description |
|---|---|
| Endpoint URL | Endpoint URL of the Azure AI Language resource. For example, https://my-language-service.cognitiveservices.azure.com/. |
| Access Key | Access key associated with the Azure AI Language resource. |
Endpoint URL
Specify the endpoint URL of the Azure AI Language resource that IB-X should connect to.
For example:
https://my-language-service.cognitiveservices.azure.com/
Use the endpoint associated with the Azure resource intended for text analytics operations.
Access Key
Specify the access key associated with the configured Azure AI Language resource.
IB-X uses this key to authenticate requests sent to the configured Azure resource.
The Access Key is a sensitive credential.
Protect the key from unauthorized access and manage it according to your organization's credential-management and security policies.
Using IB-X Azure Text Analytics Credits
Configuring an Azure Text Analytics connection is optional when using IB-X Azure Text Analytics Credits.
When this option is selected:
- A customer-managed Azure Text Analytics connection is not required.
- Requests are routed through the IntelliBuddies Integration Gateway.
- Customer-managed Azure credentials do not need to be configured in IB-X.
- Usage consumes IB-X Currency.
This provides an alternative to configuring and maintaining your own Azure AI Language resource and credentials.
Testing the Connection
After providing the required Endpoint URL and Access Key, click Test Connection to verify that IB-X can connect to the configured Azure AI Language resource.
Connection or authentication issues can result from:
- An incorrect Endpoint URL
- An invalid or expired Access Key
- Network connectivity problems
- Authentication failures
A successful connection test confirms that IB-X can connect to the configured Azure resource using the supplied credentials. The Azure resource must also support the text analysis operation performed by the workflow activity using the connection.
Used By
The Azure Text Analytics connection is used by the following workflow activities:
- Analyze Sentiment
- Detect Language
- Extract Key Phrases
- Extract Categorized Entities
- Extract PII Entities
The connection provides the Azure AI Language resource and credentials used by these activities to perform the corresponding text analysis operations.
Security Considerations
When configuring an Azure Text Analytics connection:
- Protect the Access Key from unauthorized access.
- Use credentials associated with the appropriate Azure AI Language resource.
- Restrict access to connection management based on organizational requirements.
- Rotate Azure access keys according to your organization's security policies.
When using IB-X Azure Text Analytics Credits through the Integration Gateway, customer-managed Azure credentials do not need to be configured in IB-X.
For information about creating, editing, testing, cloning, deleting, and auditing connections, see Connections.