1+ docs : FAI Guidance API
2+
3+ imports :
4+ commons : ./commons.yml
5+
6+ service :
7+ auth : false
8+ base-path : /guidance
9+ endpoints :
10+ createGuidance :
11+ docs : Index a guidance document for a given domain
12+ path : /{domain}/create
13+ method : POST
14+ audiences :
15+ - customers
16+ path-parameters :
17+ domain : string
18+ request :
19+ name : IndexGuidanceRequest
20+ body :
21+ properties :
22+ context :
23+ type : list<string>
24+ docs : The context of the guidance document, as a list of strings, that will be indexed.
25+ document :
26+ type : string
27+ docs : The content of the guidance document that will be returned in the tool response
28+ errors :
29+ - commons.BadRequestError
30+ - commons.InternalError
31+
32+ updateGuidanceById :
33+ docs : Update a guidance document for a given domain
34+ path : /{domain}/{guidance_id}
35+ method : PATCH
36+ audiences :
37+ - customers
38+ path-parameters :
39+ domain : string
40+ guidance_id : string
41+ request :
42+ name : UpdateGuidanceRequest
43+ body :
44+ properties :
45+ context :
46+ type : list<string>
47+ docs : The context of the document, as a list of strings, that will be indexed.
48+ document :
49+ type : string
50+ docs : The content of the document that will be returned in the tool response. If not provided, the document will be removed from the index.
51+ response : Guidance
52+ errors :
53+ - commons.BadRequestError
54+ - commons.InternalError
55+
56+ deleteGuidanceById :
57+ docs : Delete a guidance document for a given domain
58+ path : /{domain}/{guidance_id}
59+ method : DELETE
60+ audiences :
61+ - customers
62+ path-parameters :
63+ domain : string
64+ guidance_id : string
65+ errors :
66+ - commons.BadRequestError
67+ - commons.InternalError
68+
69+ getGuidanceById :
70+ docs : Get a guidance document for a given domain
71+ path : /{domain}/{guidance_id}
72+ method : GET
73+ audiences :
74+ - customers
75+ path-parameters :
76+ domain : string
77+ guidance_id : string
78+ response : Guidance
79+ errors :
80+ - commons.BadRequestError
81+ - commons.InternalError
82+
83+ getGuidances :
84+ docs : Retrieve all paginated guidance documents for a given domain
85+ path : /{domain}
86+ method : GET
87+ audiences :
88+ - customers
89+ path-parameters :
90+ domain :
91+ type : string
92+ docs : The domain to retrieve documents for
93+ request :
94+ name : GetGuidancesRequest
95+ query-parameters :
96+ page : optional<integer>
97+ limit : optional<integer>
98+ response : GuidanceList
99+ errors :
100+ - commons.BadRequestError
101+ - commons.InternalError
102+
103+ types :
104+ Guidance :
105+ properties :
106+ guidance_id : string
107+ context : list<string>
108+ domain : string
109+ document : string
110+ created_at : datetime
111+ updated_at : datetime
112+
113+ GuidanceList :
114+ properties :
115+ guidances : list<Guidance>
116+ pagination : Pagination
117+
118+ Pagination :
119+ properties :
120+ total : integer
121+ page : integer
122+ limit : integer
0 commit comments