Chat Completion (OpenAI) activity

Configure the Chat Completion activity

Examples

(External) AgilePoint NX Connector For OpenAI
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.

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 Software Update 1 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
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?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the OpenAI tab.
On the OpenAI tab, drag the Chat Completion activity onto your process.

General Configuration

Specifies the basic settings for the Chat Completion activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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

Configures the OpenAI model to generate text output.

Fields

Field Name	Definition
OpenAI	Description: Specifies the access token that connects to OpenAI. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for OpenAI. Function of this Screen: Configure an access token to connect to OpenAI.
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 OpenAI 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?
Frequency Penalty	Description: Specifies the frequency penalty for the OpenAI model to use the same words or phrases in generated text output. A high value means the model uses the same words or phrases less frequently. A low value means the model uses the same words or phrases more frequently. Allowed Values: A decimal number. Range: -2.00 - 2.00 Default Value: 0.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?
Presence Penalty	Description: Specifies the presence penalty for the OpenAI model to use the same word frequently in generated text output. A high value means the model uses the same word less frequently. A low value means the model uses the same word more frequently. Allowed Values: A decimal number. Range: -2.00 - 2.00 Default Value: 0.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?
Temperature	Description: Specifies the temperature value for the model to control the randomness of text output. 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?
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: 4096 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?
Stop Sequences	Description: Specifies one or more stop sequences to make the OpenAI model stop creating text. The model stops creating text when it finds the specified stop sequence. Allowed Values: A maximum of 4 stop sequences, separated by semicolons (;). Stop sequences are specific words, phrases, or special characters other than semicolons (;). Default Value: None Accepts Variables: Yes Example: Thank you;Best regards;I hope this helps For list items, if the stop sequence value is 11, the model generates stops generating list items after 10 items. If the stop sequence is a period (.), the model stops generating text at the end of a sentence.

Chat Completion Configuration > System Instruction tab

Configures the system instruction that is used to guide the OpenAI model to generate text output.

Fields

Field Name	Definition
OpenAI	Description: Specifies the access token that connects to OpenAI. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for OpenAI. Function of this Screen: Configure an access token to connect to OpenAI.
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 OpenAI 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?
System Instruction Length	Description: Specifies the maximum length of characters for a system instruction. Allowed Values: An integer. Range: 100-10000 Default Value: 1500 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?
System Instruction	Description: Specifies the name or ID of the system instruction to guide the OpenAI model. Allowed Values: A system instruction from the list. When you select the access token from the OpenAI field, this field shows the list of system instructions 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?
System Instruction Preview	Description: Shows a preview of the selected system instruction. When you select the system instruction in the System Instruction field, this field shows the preview of the specified system instruction. You can add or change the instructions in this field. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None 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 > System Instruction > Goals / Mission tab

Specifies the goals or rules for the OpenAI model to generate text output.

Fields

Field Name	Definition
Instruction Name	Description: Specifies the name of the system instruction that is used to guide the OpenAI model to generate text output. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None 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?
Goals / Mission	Description: Specifies the goals or rules for the OpenAI model to generate text output. To Open this Field: On the Chat Completion Configuration screen, in the System Instruction tab, click Add System Instruction . Allowed Values: More than one line of text. Default Value: None 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?
Instruction	Description: Specifies any guidance or information to refine the response of the model to generate text output. Allowed Values: More than one line of text. Default Value: None 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?
Save To OpenAI	Description: Specifies whether to save the system instruction in OpenAI. Allowed Values: Deselected - Saves the system instruction in the configured activity. Selected - Saves the system instruction in OpenAI. Default Value: Selected 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 > System Instruction > Skills tab

Specifies the skills or roles for the OpenAI model used to generate text output.

Fields

Field Name	Definition
Instruction Name	Description: Specifies the name of the system instruction that is used to guide the OpenAI model to generate text output. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None 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?
Skills	Description: Specifies the skills or roles for the OpenAI model used to generate text output. To Open this Field: On the Chat Completion Configuration screen, in the System Instruction tab, click Add System Instruction . Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None 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?
Instruction	Description: Specifies any guidance or information to refine the response of the model to generate text output. Allowed Values: More than one line of text. Default Value: None 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?
Save To OpenAI	Description: Specifies whether to save the system instruction in OpenAI. Allowed Values: Deselected - Saves the system instruction in the configured activity. Selected - Saves the system instruction in OpenAI. Default Value: Selected 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 > System Instruction > Input tab

Specifies the input content the OpenAI model used to generate text output.

Fields

Field Name	Definition
Instruction Name	Description: Specifies the name of the system instruction that is used to guide the OpenAI model to generate text output. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None 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?
Input	Description: Specifies the input content the OpenAI model used to generate text output. To Open this Field: On the Chat Completion Configuration screen, in the System Instruction tab, click Add System Instruction . Allowed Values: More than one line of text. Default Value: None 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?
Instruction	Description: Specifies any guidance or information to refine the response of the model to generate text output. Allowed Values: More than one line of text. Default Value: None 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?
Save To OpenAI	Description: Specifies whether to save the system instruction in OpenAI. Allowed Values: Deselected - Saves the system instruction in the configured activity. Selected - Saves the system instruction in OpenAI. Default Value: Selected 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 > System Instruction > Output tab

Specifies the output format the OpenAI model used to generate text output.

Fields

Field Name	Definition
Instruction Name	Description: Specifies the name of the system instruction that is used to guide the OpenAI model to generate text output. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Special characters Default Value: None 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?
Output	Description: Specifies the output format the OpenAI model used to generate text output. To Open this Field: On the Chat Completion Configuration screen, in the System Instruction tab, click Add System Instruction . Allowed Values: More than one line of text. Default Value: None 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?
Instruction	Description: Specifies any guidance or information to refine the response of the model to generate text output. Allowed Values: More than one line of text. Default Value: None 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?
Save To OpenAI	Description: Specifies whether to save the system instruction in OpenAI. Allowed Values: Deselected - Saves the system instruction in the configured activity. Selected - Saves the system instruction in OpenAI. Default Value: Selected 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 OpenAI, and it configures how to store the response in the AgilePoint NX app.

Fields

Field Name	Definition
OpenAI	Description: Specifies the access token that connects to OpenAI. Allowed Values: A list of access tokens configured for your environment. Default Value: None
Create	Opens this Screen: Access Token for OpenAI. Function of this Screen: Configure an access token to connect to OpenAI.
Content	Description: Specifies a text prompt that defines the content for the user message. OpenAI 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 OpenAI. Allowed Values: Map Response To App Schema – Select this option if you want to map the information from OpenAI data model to your process schema. Click the Schema Mapping 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 Variable – Select this option if you want to store the information from OpenAI 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 OpenAI to a variable in the AgilePoint NX app as a text string. In the text field, specify a variable that accepts an alphanumeric 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?