Chat Completion (NVIDIA NIM) activity

An activity that creates text output for a chat conversation in NVIDIA NIM.


Chat Completion activity

Configure the Chat Completion activity

Examples

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the NVIDIA NIM tab.

    Open NVIDIANIM tab
  3. On the NVIDIA NIM tab, drag the Chat Completion activity onto your process.

    Drag Chat Completion activity

General Configuration

Specifies the basic settings for the Chat Completion activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Chat Completion Configuration > Model Properties tab

Specifies the configuration to generate text output for a chat conversation in NVIDIA NIM.

Figure: Chat Completion Configuration > Model Properties tab

Chat Completion Configuration Model Properties tab

Fields

Field NameDefinition

NVIDIA NIM

Description:
Specifies the access token that connects to NVIDIA NIM.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for NVIDIA NIM
Function of this Screen:
Configure an access token to connect to NVIDIA NIM.

Model

Description:
Specifies the name of the model to use to generate text output.
Allowed Values:
A model name from the list.

When you select the access token from the NVIDIA NIM field, this field shows the model names associated with the access token.

Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Temperature

Description:
Specifies the temperature value for the model to control the randomness of text output.
Allowed Values:
A decimal number.

Range:

  • 0.00 - 1.00
Default Value:
0.50
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Nucleus Sampling (top_p)

Description:
Specifies a top_p threshold value to control the randomness and predictability of text generation. This value limits the selection of possible tokens to the top_p percentage of cumulative probability.
Allowed Values:
A decimal number.

Range:

  • 0.00 - 2.00
Default Value:
1.00
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Maximum Token Length

Description:
Specifies the maximum number of tokens that can be used to generate text output.

This value limits the length of the generated text output.

Allowed Values:
An integer.

Range:

  • 1-10000
Default Value:
1024
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Chat Completion Configuration > User Message tab

Configures the chat conversation to generate text output in NVIDIA NIM, and it configures how to store the response in the AgilePoint NX app.

Figure: Chat Completion Configuration > User Message tab

Chat Completion Configuration User Message tab

Fields

Field NameDefinition

NVIDIA NIM

Description:
Specifies the access token that connects to NVIDIA NIM.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for NVIDIA NIM
Function of this Screen:
Configure an access token to connect to NVIDIA NIM.

Content

Description:
Specifies a text prompt that defines the content for the user message.

NVIDIA NIM reads the text in this field to generate text output.

Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
  • Special characters
Default Value:
None
Accepts Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Map Response To App Schema / Store Response JSON In This Variable / Store Response Content In This Variable (String)

Description:
Specifies where to store the response from NVIDIA NIM.
Allowed Values:
  • Map Response To App SchemaSelect this option if you want to map the information from the NVIDIA NIM data model to your process schema.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

  • Store Response JSON In This VariableSelect this option if you want to store the information from NVIDIA NIM to a variable in the AgilePoint NX app as JSON format.

    In the text field, specify a variable that accepts an alphanumeric string in JSON format.

  • Store Response Content In This Variable (String)Select this option if you want to store the information from NVIDIA NIM to a variable in the AgilePoint NX app as a text string.

    In the text field, specify a variable that accepts a text string.

Default Value:
Map Response To App Schema
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?