Skip to content

Add new prompt info in README.md #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,13 @@

This repository is part of the Bot Builder Community Project and contains Bot Builder Extensions for the Python SDK, including middleware, dialogs, helpers and more. Other repos within the Bot Builder Community Project exist for extensions for [JavaScript](https://github.com/BotBuilderCommunity/botbuilder-community-js), [.NET](https://github.com/BotBuilderCommunity/botbuilder-community-dotnet), [Java](https://github.com/BotBuilderCommunity/botbuilder-community-java) and [tools](https://github.com/BotBuilderCommunity/botbuilder-community-tools) - you can find our other repos under [our GitHub organisation for the project](https://github.com/BotBuilderCommunity/).

This repo will be updated shortly to add the first extensions - please contribute you own too!
To see a list of current extensions available for the Bot Builder Python SDK, use the links below to jump to a section
* [Dialogs & Prompts](#dialogs-and-prompts)


## Dialogs and Prompts
The following dialogs are currently available;

| Name | Description | Sample | PIP |
| ---- | ----------- | ------- | --- |
| [@botbuildercommunity/dialog-prompts](libraries/botbuilder-community-dialogs-prompts/README.md) | A variety of prompts using the [Microsoft Recognizers Text](https://github.com/microsoft/Recognizers-Text) suite, such as currency, temperature, age and dimension. | coming soon | coming soon |
62 changes: 62 additions & 0 deletions libraries/botbuilder-community-dialogs-prompts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,65 @@ Below is an example of how you might use this result.
result = step_context.result
await turn_context.send_activity(result)
```

## Phone Number

The `PhoneNumberPrompt` will extract a phone number from a message from the user.

```python
dialogs.add(new PhoneNumberPrompt('phprompt');
```

Example

```python
User : My phone number is 1 (877) 609-2233
PhoneNumberPrompt return as 1 (877) 609-2233
```

## Email Address

The `EmailPrompt` will extract an email address from a message from the user.

```python
dialogs.add(new EmailPrompt('eprompt');
```

Example

```python
User : My email id is r.vinoth@live.com
EmailPrompt return as r.vinoth@live.com
```

## Internet Protocols

The `InternetProtocolPrompt` will extract one of the following types based on which InternetProtocolPromptType enum value is passed in:

* IPAddress
* URL

```python
dialogs.add(InternetProtocolPrompt("urlprompt",InternetProtocolPromptType.URL))
```
Example

```python
User : My favorite web site is http://rvinothrajendran.github.io/
InternetProtocolPrompt return as http://rvinothrajendran.github.io/
```

## GUID

The `GUIDPrompt` will extract a GUID from a message from the user.

```python
dialogs.add(new GuidPrompt('gprompt');
```

Example

```python
User : my azure id is "7d7b0205-9411-4a29-89ac-b9cd905886fa"
GUIDPrompt return as "7d7b0205-9411-4a29-89ac-b9cd905886fa"
```