Skip to content

Commit

Permalink
Add suggested replies to note type
Browse files Browse the repository at this point in the history
  • Loading branch information
nbramblett committed Dec 26, 2023
1 parent d5ce02d commit 4b5e9de
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/chat-core.messagenotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ This data will come from the API. As such, a user’s first request may have thi
| [goalFirstMsgIndex?](./chat-core.messagenotes.goalfirstmsgindex.md) | | number | _(Optional)_ The index of the message that started the current goal. |
| [queryResult?](./chat-core.messagenotes.queryresult.md) | | object | _(Optional)_ Data retrieved from Yext Search, REST api, etc. |
| [searchQuery?](./chat-core.messagenotes.searchquery.md) | | string | _(Optional)_ The query used for Yext Search, REST api, etc. |
| [suggestedReplies?](./chat-core.messagenotes.suggestedreplies.md) | | string\[\] | _(Optional)_ A set of pre-generated replies given by the AI. |

13 changes: 13 additions & 0 deletions docs/chat-core.messagenotes.suggestedreplies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/chat-core](./chat-core.md) &gt; [MessageNotes](./chat-core.messagenotes.md) &gt; [suggestedReplies](./chat-core.messagenotes.suggestedreplies.md)

## MessageNotes.suggestedReplies property

A set of pre-generated replies given by the AI.

**Signature:**

```typescript
suggestedReplies?: string[];
```
1 change: 1 addition & 0 deletions etc/chat-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ export interface MessageNotes {
goalFirstMsgIndex?: number;
queryResult?: object;
searchQuery?: string;
suggestedReplies?: string[];
}

// @public
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@yext/chat-core",
"version": "0.7.5",
"version": "0.7.6",
"description": "Typescript Networking Library for the Yext Chat API",
"main": "./dist/commonjs/index.js",
"module": "./dist/esm/index.mjs",
Expand Down
2 changes: 2 additions & 0 deletions src/models/endpoints/MessageNotes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,6 @@ export interface MessageNotes {
collectedData?: Record<string, unknown>;
/** The index of the message that started the current goal. */
goalFirstMsgIndex?: number;
/** A set of pre-generated replies given by the AI. */
suggestedReplies?: string[];
}

0 comments on commit 4b5e9de

Please sign in to comment.