Function

a!recordsChatField( label, labelPosition, instructions, additionalInstructions, helpTooltip, initialMessage, suggestedQuestions, recordType, identifier, fields, relatedRecordData, showWhen, height, buttonStyle )

Creates a chatbot for chatting on a record summary view.

This component uses Appian AI Copilot to answer questions about a record and related record data, 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 data fabric.

See also:

• Data fabric insights
• AI Copilot

Parameters

Usage considerations

Mobile devices

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

Reliability of responses

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

The Records Chat 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. Customers will need to contact Appian Support to enable this feature, but should review its compliance to ensure it aligns with your organization's security requirements before doing so.

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

This function returns data according to record-level security you have configured.

Compatibility

This component can't be used in a Side by Side layout.

Using the additionalInstructions parameter

Depending on where you plan to make records chat available to your users, you may want to control the component's output. You can do this by including your requirements in the additionalInstructions parameter. The text included in this parameter is sent to the model as part of the prompt.

For example, if your users will be interacting with records chat in a dashboard designed for executives, the users will probably want short and succinct replies to their questions. As the developer, you can specify that you want short replies in the additionalInstructions parameter so the model powering the component knows what an appropriate response would be in that context.

Use this parameter to specify other logic, format, or other requirements you want the model to apply in the model output.

Using the fields parameter

By default, this function will return the fields from the base record type. If you also want to return related record fields, you can reference the fields or the relationship in the fields parameter.

If you are querying a one-to-many relationship, a maximum of 100 related records will be returned. For example, when querying customers and their related support cases, the query will return up to 100 related support cases for the customer.

Using the relatedRecordData parameter

The relatedRecordData parameter allows you to filter, sort, and limit related record data from a one-to-many relationship using the a!relatedRecordData() function.

For example, let's say you're querying the Customer record type and you only want to return the last three cases associated with each customer. Since a customer can have many cases, by default, the query will return up to 100 cases related to each customer. In the relatedRecordData parameter, you could use the a!relatedRecordData() function to limit the result to three and sort the cases so the most recent appears first.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
a!recordsChatField(
  recordType: recordType!Customer,
  identifier: ri!id,
  fields: {
      recordType!Customer.id,
      recordType!Customer.firstName,
      recordType!Customer.lastName,
      recordType!Customer.relationships.case.id,
      recordType!Customer.relationships.case.title,
      recordType!Customer.relationships.case.description,
      recordType!Customer.relationships.case.createdOn,
      recordType!Customer.relationships.case.createdBy,
  },
  relatedRecordData: a!relatedRecordData(
    relationship: recordType!Customer.relationships.case,
    limit: 3,
    sort: a!sortInfo(
      field: recordType!Case.fields.createdOn,
      ascending: true
    )
  )
)

When applying a filter or sort to a!relatedRecordData(), your record field or related record field reference must start from the related record type specified in the relationship parameter. See additional usage considerations for using the a!relatedRecordData() function.

Aggregating related record data

The a!aggregationFields() function is not supported with a!recordsChatField().

If you need to aggregate related record data, use a!queryRecordType() instead.

Feature compatibility