Skip to main content
Version: Current

Azure Document Analysis Connection

Overview​

The Azure Document Analysis connection allows IB-X Agents to connect to Azure AI Document Intelligence using customer-managed Azure credentials.

Use this connection with workflow activities that analyze documents such as:

  • PDFs
  • Scanned images
  • Invoices
  • Receipts
  • Contracts
  • Identity documents
  • Forms
note

Configuring an Azure Document Analysis connection is optional when using IB-X Azure Document Analysis Credits through the IntelliBuddies Integration Gateway.

Connection Properties​

Configure the following properties when creating an Azure Document Analysis connection.

PropertyDescription
Endpoint URLEndpoint URL of the Azure AI Document Intelligence resource. For example, https://my-document-intelligence.cognitiveservices.azure.com/.
Access KeyAccess key associated with the Azure AI Document Intelligence resource.

Endpoint URL​

Specify the endpoint URL of the Azure AI Document Intelligence resource that IB-X should connect to.

For example:

https://my-document-intelligence.cognitiveservices.azure.com/

Use the endpoint associated with the Azure resource intended for document analysis operations.

Access Key​

Specify the access key associated with the configured Azure AI Document Intelligence resource.

IB-X uses this key to authenticate requests sent to the configured Azure resource.

caution

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 Document Analysis Credits​

Configuring an Azure Document Analysis connection is optional when using IB-X Azure Document Analysis Credits.

When this option is selected:

  • A customer-managed Azure Document Analysis 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 Document Intelligence 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 Document Intelligence resource.

Connection or authentication issues can result from:

  • An incorrect Endpoint URL
  • An invalid or expired Access Key
  • Network connectivity problems
  • Authentication failures
note

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 document analysis operation performed by the workflow activity using the connection.

Used By​

The Azure Document Analysis connection is used by the following workflow activity:

The connection provides the Azure AI Document Intelligence resource and credentials used by the activity to perform document analysis.

Security Considerations​

When configuring an Azure Document Analysis connection:

  • Protect the Access Key from unauthorized access.
  • Use credentials associated with the appropriate Azure AI Document Intelligence 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 Document Analysis 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.