Alphanumeric collection prebuilt component

The alphanumeric collection prebuilt component collects alphanumeric sequences from the end-user. The minimum and maximum length accepted can be configured via input parameters.

The component captures chunks of characters from the user on each conversational turn and concatenates them to form the final sequence. The minimum and maximum length accepted per chunk can be configured via input parameters.

The sequence capture will continue until the end-user indicates they are done with the sequence with input that matches the prebuilt_components_confirmation_done intent.

Phonetic alphabet

This component supports the use of phonetic alphabets such as the NATO Phonetic Alphabet.

User input Captured sequence
alpha bravo charlie 123 abc123
A B Cat 1 2 3 ABC123
A as in apple, B as in banana, C for chili, one fifteen ABC115

Additional functionalities

The following additional functionalities are provided by this prebuilt component:

Sample dialogs

The following sample dialogs demonstrate common scenarios handled by this prebuilt component. The sample dialogs demonstrate behavior when the component is called via telephony, which triggers the Default Welcome Intent and the first agent response at the start of the conversation.

Single chunk

End-user provides an alphanumeric sequence in one chunk and says 'I'm done'; agent successfully accepts it.

User input Agent response
Please start by saying the first 1 to 8 characters of the alphanumeric sequence. Once you're done, say "I'm done" to finish the collection. You can also say "playback" at any time to check the current collected sequence.
fvfd3433
Alright. I got fvfd3433, is that correct?
yes
Okay. Tell me the next 1 to 8 characters in the sequence.
I'm done
Thank you for confirming. The final alphanumeric sequence I got is fvfd3433, is that correct?
yes
Fantastic, I've collected the alphanumeric sequence.

Multiple chunks

End-user provides alphanumeric sequence in 2 chunks; agent successfully accepts it.

User input Agent response
Please start by saying the first 1 to 8 characters of the alphanumeric sequence. Once you're done, say "I'm done" to finish the collection. You can also say "playback" at any time to check the current collected sequence.
fvfd3433
Alright. I got fvfd3433, is that correct?
yes
Okay. Tell me the next 1 to 8 characters in the sequence.
gh67
Alright. I got gh67, is that correct?
yes
Okay. Tell me the next 1 to 8 characters in the sequence.
I'm done
Thank you for confirming. The final alphanumeric sequence I got is fvfd3433gh67, is that correct?
yes
Fantastic, I've collected the alphanumeric sequence.

Successful retry

End-user provides alphanumeric sequence; agent re-prompts the end-user to confirm it. End-user says 'No' to the confirmation and provides an alphanumeric sequence again; agent successfully accepts it.

User input Agent response
Please start by saying the first 1 to 8 characters of the alphanumeric sequence. Once you're done, say "I'm done" to finish the collection. You can also say "playback" at any time to check the current collected sequence.
fvfd3433
Alright. I got fd3433, is that correct?
no
Sorry about that, can you please provide the first 1 to 8 characters again?
fvfd3433
Alright. I got fvfd3433, is that correct?
yes
Okay. Tell me the next 1 to 8 characters in the sequence.
I'm done
Thank you for confirming. The final alphanumeric sequence I got is fvfd3433, is that correct?
yes
Fantastic, I've collected the alphanumeric sequence.

Unsuccessful retries

End-user is unable to provide an alphanumeric sequence of 1 to 8 characters within three attempts and the component exits the flow.

User input Agent response
Please start by saying the first 1 to 8 characters of the alphanumeric sequence. Once you're done, say "I'm done" to finish the collection. You can also say "playback" at any time to check the current collected sequence.
123N
Alright. I got 123M, is that correct?
no
Sorry about that, can you please provide the first 1 to 8 characters again?
123N
Alright. I got 123M, is that correct?
no
Sorry about that, can you please provide the first 1 to 8 characters again?

Please spell out each letter of your sequence with a word starting with each letter. For example, if your sequence is AB123, say "Apple Baby 123".
123 Nest
Alright. I got 123N, is that correct?
no
Sorry, I've used too many attempts and failed to collect the alphanumeric sequence.

Phonetic alphabet

End-user provides alphanumeric sequence; agent re-prompts the end-user to confirm it. End-user says 'No' to the confirmation two consecutive times, the phonetic conversion is enabled and the end-user provides an alphanumeric sequence again; agent successfully accepts it.

User input Agent response
Please start by saying the first 1 to 8 characters of the alphanumeric sequence. Once you're done, say "I'm done" to finish the collection. You can also say "playback" at any time to check the current collected sequence.
123N
Alright. I got 123M, is that correct?
no
Sorry about that, can you please provide the first 1 to 8 characters again?
123N
Alright. I got 123M, is that correct?
no
Sorry about that, can you please provide the first 1 to 8 characters again?

Please spell out each letter of your sequence with a word starting with each letter. For example, if your sequence is AB123, say "Apple Baby 123".
123 N as in Nancy
Alright. I got 123N, is that correct?
yes
Okay. Tell me the next 1 to 8 characters in the sequence.
567BC
Alright. I got 567BC, is that correct?
that's all
Thank you for confirming. The final alphanumeric sequence I got is 123N56BC. Is that correct?
yep
Fantastic, I've collected the alphanumeric sequence.

Invalid sequence length

End-user provides alphanumeric sequence with a length that is outside the predefined minimum and maximum length of the alphanumeric sequence. Agent prompts end-user to start over, the end-user declines, and the component exits the flow.

User input Agent response
Please start by saying the first 1 to 8 characters of the alphanumeric sequence. Once you're done, say "I'm done" to finish the collection. You can also say "playback" at any time to check the current collected sequence.
123M
Alright. I got 123M, is that correct?
done
Sorry, you provided an alphanumeric sequence that is outside the required length of 5 to 30 characters. Do you want to start over?
no
Sorry, I've used too many tries and failed to collect the alphanumeric sequence.

Naming conventions

This prebuilt component uses the following naming conventions:

Feature Format Example
Flow [Component Name] Alphanumeric Collection
Component Specific Intent prebuilt_components_[component_name]_[intent_name] prebuilt_components_alphanumeric_collection_support_continue
Parameter [param_name] alphanumeric_max_length

Input parameters

Input parameters are parameters that are used to configure certain behaviors of the component. The parameters will be used by one or more conditions within the flow to determine how the component should behave. Flow-scoped parameters must be set on the start page of the component as described below. Session-scoped parameters may be set either by a calling flow, or on the start page of this component.

You can configure the minimum and maximum lengths accepted per capture and for the final collected sequence by modifying parameter presets in the flow's start page.

This prebuilt component accepts the following input parameters:

Parameter Name Description Input Format
$flow.alphanumeric_min_length Minimum length of the final alphanumeric sequence. The default value is 1. integer
$flow.alphanumeric_max_length Maximum length of the final alphanumeric sequence. The default value is 30. integer
$flow.lower_limit Minimum length of the chunk a user can provide each turn. The default value is 1. integer
$flow.upper_limit Maximum length of the chunk a user can provide each turn. The default value is 8. integer

To configure the input parameters for this component, expand for instructions.

  1. Open the Dialogflow CX console.
  2. Choose your Google Cloud project.
  3. Select your agent.
  4. Select the Build tab.
  5. Click the imported component in the Flows section.
  6. Click the Start Page in the Pages section.
  7. Click the true Route in the Start Page.
  8. In the Route window, edit the Parameter Presets values as needed.
  9. Click Save.

Output parameters

Output parameters are session parameters that will remain active after exiting the component. These parameters contain important information collected by the component. This prebuilt component provides values for the following output parameters:

Parameter Name Description Output Format
alphanumeric_collection_alphanumeric_sequence This parameter returns the alphanumeric sequence captured by the component string

Basic setup

To set up this prebuilt component:

  1. Import the prebuilt component.

Complete

Your agent should now be set up and ready to test.