Documents Chat

Function

Copy link to clipboard

a!documentsChatField( label, labelPosition, instructions, showWhen, helpTooltip, documents, height )

Creates a chat for users to ask questions about a curated set of documents.

This component uses Appian AI Copilot to answer questions about a curated set of documents, enabling users to interact with conversational AI to get quick insights. This component requires no third-party integration to get started. All you need to do is configure the parameters to begin chatting with your documents.

See also:

• AI Copilot

Parameters

Copy link to clipboard

Usage considerations

Copy link to clipboard

Documents

Copy link to clipboard

This component requires documents to exist in Appian as a document object.

Retention

Copy link to clipboard

Documents that haven't been accessed in 30 days become inactive. When a person hasn't chatted with a document in the last 30 days, responses might take a little longer to load the next time you chat with the document. To keep a document ready for quick use, simply access it within 30 days.

Mobile devices

Copy link to clipboard

This component is supported on mobile devices when accessed via web browsers, but not supported on Appian Mobile.

Reliability of responses

Copy link to clipboard

As with any generative AI feature, this component may produce invalid or undesirable answers. Generative AI models sometimes produce "hallucinations," or responses that contain inaccurate information. Users should verify information in chat responses for accuracy.

This component may not provide consistent answers. In other words, the response the component provides today might differ from an answer to the same question with the same data tomorrow.

Compliance

Copy link to clipboard

This component is powered by private AI, meaning that your inputs and outputs are protected and remain within the boundaries of your Appian Cloud site at all times.

This component is available only on Appian Cloud. Self-managed customers don't have access to this feature.

You will receive the following error until the feature is enabled on your site: This function is currently unavailable. Please contact your system administrator if this problem persists.

This feature is available for environments in select regions.

If your Appian environment isn't in a supported region, you can elect to send your data to a supported region. This doesn't change your environment's region. Contact Appian Support to learn more.

Security

Copy link to clipboard

This function enforces object security, ensuring that users can only interact with data they are authorized to access when using this component. In other words, users must have at least Viewer permission on a document to ask questions and receive responses regarding that document

Examples

Copy link to clipboard

To experiment with examples, copy and paste the expression into an interface object.

1
2
3
4
5
6
7
8
{
  a!documentsChatField(
    label: "Documents Chat",
    labelPosition: "COLLAPSED",
    documents: ri!record[recordType!SMRT Document Collection.relationships.smrtDocument.fields.documentId],
    height: "AUTO"
  )
}
Copy

Feature compatibility

Copy link to clipboard

Feedback

Copy link to clipboard