Skip to content
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

add conversations > connect your frontend page with client examples #8119

Merged
merged 4 commits into from
Nov 23, 2024

Conversation

atierian
Copy link
Member

Description of changes:

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.


### Create a conversation

Conversation routes defined in your schema are accessible via the `.conversations` namespace. First create a client instance with the `generateClient()` function.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this should go above the previous section since its the first time in the page using the client?

Copy link
Member Author

@atierian atierian Nov 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 07a979b

The response from the AI assistant will be a JSON object that matches the `inputSchema` definition. See [Subscribe to assistant responses](#subscribe-to-assistant-responses) for more information on how to handle the response.

### Subscribe to assistant responses

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add a callout here that the React hook takes care of reconciling the stream events into, just to not scare people thinking they have to do this stuff

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. I didn't add it in this PR because the examples are only for the data client. We should include this once we have good hook examples.

@atierian atierian force-pushed the ai.conversation-client-examples branch from 53184f1 to 07a979b Compare November 22, 2024 22:49
@atierian atierian marked this pull request as ready for review November 22, 2024 22:50
@atierian atierian requested review from a team as code owners November 22, 2024 22:50
dbanksdesign
dbanksdesign previously approved these changes Nov 22, 2024
Copy link
Contributor

@dbanksdesign dbanksdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@atierian atierian enabled auto-merge (squash) November 22, 2024 23:13
dindjarinjs
dindjarinjs previously approved these changes Nov 22, 2024
Co-authored-by: Danny Banks <djb@amazon.com>
@atierian atierian dismissed stale reviews from dindjarinjs and dbanksdesign via 64d0bf5 November 22, 2024 23:29
@atierian atierian merged commit b850c31 into main Nov 23, 2024
12 checks passed
@atierian atierian deleted the ai.conversation-client-examples branch November 23, 2024 00:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants