-
Notifications
You must be signed in to change notification settings - Fork 16
/
ai.abcmouse.com.yaml
84 lines (84 loc) · 2.56 KB
/
ai.abcmouse.com.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
openapi: 3.0.0
info:
version: src
title: ABCmouseMobileServiceLayer
servers:
- url: https://ai.abcmouse.com/ws/ai/0.1/gpt
description: Production server (uses live data)
paths:
/ChatPlugin/RecommendActivities/:
post:
operationId: ChatPluginRecommendActivities
summary: 'API for fetching a list of learning activities based on the users search criteria'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChatPluginRecommendActivitiesRequest'
responses:
'200':
description: 'Activities found'
content:
application/json:
schema:
$ref: '#/components/schemas/ChatPluginRecommendActivitiesResponse'
'500':
description: 'One or more services is unavailable'
components:
schemas:
ChatPluginRecommendActivitiesResponse:
description: ''
type: object
properties:
activities:
type: array
items:
$ref: '#/components/schemas/ChatPluginActivity'
ChatPluginActivity:
description: ''
type: object
properties:
name:
type: string
nullable: false
url:
type: string
nullable: false
ChatPluginRecommendActivitiesRequest:
description: ''
type: object
properties:
search_term:
description: '(Optional) A general search term used to find activities, you should exclude connectors like "and" or "or"'
type: string
nullable: false
subjects:
description: '(Optional) A list of subjects to filter, Either explicitly stated by the user or implicitly inferred by the users request'
type: array
nullable: true
items:
type: string
nullable: true
enum:
- Math
- ELA
- Science
- Art
- Music
- ELL
- Health
grade_level:
description: '(Optional) The childs grade level, Either explicitly stated by the user or implicitly inferred by the users request'
type: string
nullable: true
enum:
- Pre-K
- Kindergarten
- 1st Grade
- 2nd Grade
age:
description: '(Optional) The childs grade level, Either explicitly stated by the user or implicitly inferred by the users request'
type: number
nullable: true
minimum: 2
maximum: 7