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.

Sign up for GitHub

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

Jump to bottom

Move moments API from beta to public #111

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Move moments API from beta to public #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 6 additions & 7 deletions guides/V1_get_moment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
---
link: 'get-moment-by-id'
is: 'beta'
is: 'published'
---
## Get a moment by id

**NOTE**: This graphql object is currently in `BETA` release and is only available with the following http request header:

x-graphql-view: BETA


This is a sample GraphQL query to get moment by id. Be sure to switch "moment-id" to the actual id you're curious about.

```
Expand All @@ -23,4 +18,8 @@ query getMomentById {

```

Try it out with our GraphQL tool - <a href="https://developer.watsonwork.ibm.com/tools/graphql?query=query%20getMomentById%20{%20%20moment(id:%20%22moment-id%22)%20{%20%20%20%20id%20%20%20%20live%20%20%20%20startTime%20%20%20%20endTime%20%20}}" target="_blank">Get a moment by id</a>
Get a moment by ID, see it in action with our GraphQL tool.

<div class="try-it-now">
<a href="https://developer.watsonwork.ibm.com/tools/graphql?query=query%20getMomentById%20%7B%0Amoment(id%3A%20%22moment-id%22)%20%7B%0Aid%0Alive%0AstartTime%0AendTime%0A%7D%0A%7D" target="_blank">Try it now</a>
</div>
8 changes: 6 additions & 2 deletions guides/V1_get_moments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
copyright: 'Copyright IBM Corp. 2017'
link: 'get-a-list-of-moments'
is: 'beta'
is: 'published'
---
## Get a list of moments

Expand Down Expand Up @@ -66,4 +66,8 @@ query getMoments($spaceId: String!) {

```

Try it out with our GraphQL tool - <a href="https://developer.watsonwork.ibm.com/tools/graphql?query=query%20getMoments(%24spaceId%3A%20String!)%20%7B%0A%20%20moments(spaceId%3A%20%24spaceId)%20%7B%0A%20%20%20%20items%20%7B%0A%20%20%20%20%20%20id%0A%20%20%20%20%20%20live%0A%20%20%20%20%20%20startTime%0A%20%20%20%20%20%20endTime%0A%20%20%20%20%20%20keyMessage%20%7B%0A%20%20%20%20%20%20%20%20id%0A%20%20%20%20%20%20%20%20content%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20summaryPhrases(first%3A%203)%20%7B%0A%20%20%20%20%20%20%20%20label%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20participants(first%3A%2010)%20%7B%0A%20%20%20%20%20%20%20%20user%20%7B%0A%20%20%20%20%20%20%20%20%20%20id%0A%20%20%20%20%20%20%20%20%20%20displayName%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20messageCount%0A%20%20%20%20%20%20%20%20viaAppUsers%20%7B%0A%20%20%20%20%20%20%20%20%20%20displayName%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20priority%20%7B%0A%20%20%20%20%20%20%20%20predicted%0A%20%20%20%20%20%20%20%20support%20%7B%0A%20%20%20%20%20%20%20%20%20%20category%0A%20%20%20%20%20%20%20%20%20%20...%20on%20SupportingParticipant%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20person%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20displayName%0A%20%20%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%20%20...%20on%20SupportingPhrase%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20label%0A%20%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D%0A&operationName=getMoments" target="_blank">Get a list of moments</a>
Get a list of moments in a space, see it in action with our GraphQL tool.

<div class="try-it-now">
<a href="https://developer.watsonwork.ibm.com/tools/graphql?query=query%20getMoments(%24spaceId%3A%20String!)%20%7B%0Amoments(spaceId%3A%20%24spaceId)%20%7B%0Aitems%20%7B%0Aid%0Alive%0AstartTime%0AendTime%0AkeyMessage%20%7B%0Aid%0Acontent%0A%7D%0AsummaryPhrases(first%3A%203)%20%7B%0Alabel%0A%7D%0Aparticipants(first%3A%2010)%20%7B%0Auser%20%7B%0Aid%0AdisplayName%0A%7D%0AmessageCount%0AviaAppUsers%20%7B%0AdisplayName%0A%7D%0A%7D%0Apriority%20%7B%0Apredicted%0Asupport%20%7B%0Acategory%0A...%20on%20SupportingParticipant%20%7B%0Aperson%20%7B%0AdisplayName%0A%7D%0A%7D%0A...%20on%20SupportingPhrase%20%7B%0Alabel%0A%7D%0A%7D%0A%7D%0A%7D%0A%7D%0A%7D" target="_blank">Try it now</a>
</div>
13 changes: 3 additions & 10 deletions guides/V1_get_moments_in_conversation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
---
copyright: 'Copyright IBM Corp. 2018'
link: 'get-a-list-of-moments-in-conversation'
is: 'beta'
is: 'published'
---
## Get a list of moments in conversation

**NOTE**: This graphql object is currently in `BETA` release and is only available with the following http request header:

x-graphql-view: BETA

or with <a href="https://developer.watsonwork.ibm.com/tools/graphql?apiType=beta" target="_blank" >apiType=beta on the graphical GraphQL tool URL</a>.


This is a sample GraphQL query to get moments in a conversation. Be sure to switch "conversation-id" to the id of the conversation you're curious about.

```
Expand All @@ -32,8 +25,8 @@ query getMomentsInConversation {
}
```

Get a list of moments in conversation, see it in action with our GraphQL tool.
Get a list of moments in a conversation, see it in action with our GraphQL tool.

<div class="try-it-now">
<a href="https://developer.watsonwork.ibm.com/tools/graphql?apiType=beta&query=query%20getMomentsInConversation%20%7B%0Aconversation(id%3A%20%22conversation-id%22)%20%7B%0Amoments%20%7B%0Aitems%20%7B%0Aid%0Alive%0AstartTime%0AendTime%0AsummaryPhrases(first%3A%203)%20%7B%0Alabel%0A%7D%0A%7D%0A%7D%0A%7D%0A%7D" target="_blank">Try it now</a>
<a href="https://developer.watsonwork.ibm.com/tools/graphql?query=query%20getMomentsInConversation%20%7B%0Aconversation(id%3A%20%22conversation-id%22)%20%7B%0Amoments%20%7B%0Aitems%20%7B%0Aid%0Alive%0AstartTime%0AendTime%0AsummaryPhrases(first%3A%203)%20%7B%0Alabel%0A%7D%0A%7D%0A%7D%0A%7D%0A%7D" target="_blank">Try it now</a>
</div>
14 changes: 4 additions & 10 deletions guides/V1_moment_main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
---
copyright: 'Copyright IBM Corp. 2018'
link: 'moment'
is: 'beta'
is: 'published'
---
# Moment

**NOTE**: This graphql object is currently in `BETA` release and is only available with the following http request header:

x-graphql-view: BETA

or with <a href="https://developer.watsonwork.ibm.com/tools/graphql?apiType=beta" target="_blank" >apiType=beta on the graphical GraphQL tool URL</a>.


Watson Work Services analyzes messages in each space to identify **moments**.

Each moment includes a summary of a group of messages. The summary includes summary phrases, participants, and other information extracted from messages.
Expand All @@ -25,7 +18,7 @@ The [Conversation](./guides/V1_conversation_main.md) object also references the
| property | type | description |
| ------------- |:------------- |:-----|
| id | ID | The unique ID for this moment. The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. |
| live | Boolean | The status whether this moment is still under updating |
| live | Boolean | True indicates this moment is ongoing and may receive updates |
| startTime | Date | Date and time this moment started |
| endTime | Date | Date and time this moment ended |
| keyMessage | Message | A messages which is most representative of the discussion in the moment |
Expand All @@ -42,6 +35,8 @@ The [Conversation](./guides/V1_conversation_main.md) object also references the
| label | String | The display string of this phrase |
| score | Float | The confidence of this phrase, if applicable |

An line fragment can be used to see more details for each type of SummaryPhrase. See also https://graphql.org/learn/queries/#inline-fragments.

### Keyword (implements SummaryPhrase)

The keyword interface is used to distinguish a keyword summary phrase, but currently adds no unique properties of its own.
Expand All @@ -51,7 +46,6 @@ The keyword interface is used to distinguish a keyword summary phrase, but curre
| ------------- |:------------- |:-----|
| count | Int | The count of this entity phrase in the moment |


## Participant
| property | type | description |
| ------------- |:------------- |:-----|
Expand Down