Skip to content

Commit 325554d

Browse files
Automatic commit: Move 'cp-aibus-pr-swagger-ui-custom', 'cp-aibus-pr-web-oauth-token' from QA to Production (#20692)
1 parent 66419d7 commit 325554d

22 files changed

+20
-22
lines changed

tutorials/cp-aibus-pr-swagger-ui-custom/cp-aibus-pr-swagger-ui-custom.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,23 @@ In the service key you created for Personalized Recommendation in the previous t
3131

3232
1. To access the Personalized Recommendation Swagger UI, add **`/doc`** to the `url` value, paste it into any web browser and press **Enter**.
3333

34-
<!-- border -->![PRS](png-files/service-key-details.png)
34+
<!-- border -->![PRS](service-key-details.png)
3535

3636
2. To be able to use the Swagger UI endpoints, you need to authorize yourself. In the top right corner, click **Authorize**.
3737

38-
<!-- border -->![PRS](png-files/Swagger.png)
38+
<!-- border -->![PRS](Swagger.png)
3939

4040
3. Get the `access_token` value created in the previous tutorial: [Get OAuth Access Token for Personalized Recommendation via Web Browser](cp-aibus-pr-web-oauth-token), then add **Bearer** in front of it, and enter in the **Value** field.
4141

4242
```
4343
bearer <access_token>
4444
```
4545
46-
<!-- border -->![PRS](png-files/Authorize.png)
46+
<!-- border -->![PRS](Authorize.png)
4747
4848
4. Click **Authorize** and then click **Close**.
4949
50-
<!-- border -->![PRS](png-files/Authorize-close.png)
50+
<!-- border -->![PRS](Authorize-close.png)
5151
5252
5353
@@ -146,31 +146,31 @@ Use the **POST /standard/rs/v1/tenants/{tenant}/jobs/file-upload** endpoint to u
146146
147147
2. Click **Try it out**.
148148
149-
<!-- border -->![PRS](png-filesTraining-section.png)
149+
<!-- border -->![PRS](Training-section.png)
150150
151151
3. Enter tenant name. You must enter a name for the tenants, so please input a name of your choice.
152152
153153
4. Upload Data. Choose the ZIP file that contains the newly created training data.
154154
155155
5. Enter site name. A site name is also required, but if you leave this field blank, it is automatically filled with "default".
156156
157-
<!-- border -->![PRS](png-filesActions-required.png)
157+
<!-- border -->![PRS](Actions-required.png)
158158
159159
6. Set `serve_model` to `true`. Make this setting to automatically deploy the real-time model serving instance.
160160
161-
<!-- border -->![PRS](png-filesSet-serve-model.png)
161+
<!-- border -->![PRS](Set-serve-model.png)
162162
163163
7. Click the **Execute** button. *Bear in mind that users with the free tier model for SAP BTP are limited to a total number of 2 trainings per month*. When you call the third training API, you get a 403 response stating that you have exceeded your quota for the month.
164164
165165
After you trigger the training, there are two possible outcomes:
166166
167167
- Still ongoing, where the status is "PENDING", and code 200.
168168
169-
<!-- border -->![PRS](png-filesPending-status.png)
169+
<!-- border -->![PRS](Pending-status.png)
170170
171171
- Conflict, where the trigger clashed with the ongoing training from the previous trigger. The status is "Previously submitted job still in progress", and the code is 409.
172172
173-
<!-- border -->![PRS](png-filesConflict-error.png)
173+
<!-- border -->![PRS](Conflict-error.png)
174174
175175
176176
@@ -185,21 +185,21 @@ Use the **GET /standard/rs/v1/tenants/{tenant}/jobs/latest** endpoint to check t
185185
186186
3. Enter tenant name and site name (must be exactly the same as in the previous step). Click **Execute**.
187187
188-
<!-- border -->![PRS](png-filesLatest-path.png)
188+
<!-- border -->![PRS](Latest-path.png)
189189
190190
There are three possible outcomes:
191191
192192
- Job is still ongoing, with the status "SUBMITTED" and code 200. Please wait for around 5–10 minutes before rechecking the progress.
193193
194-
<!-- border -->![PRS](png-filesSubmitted-status.png)
194+
<!-- border -->![PRS](Submitted-status.png)
195195
196196
- The job is completed, with the status "SUCCEEDED" and code 200. You can now proceed to the next step.
197197
198-
<!-- border -->![PRS](png-filesSucceeded-status.png)
198+
<!-- border -->![PRS](Succeeded-status.png)
199199
200200
- The job fails, with status "FAILED" and code 200. Please retrigger the training and make sure that you have entered all information correctly.
201201
202-
<!-- border -->![PRS](png-filesFailed-status.png)
202+
<!-- border -->![PRS](Failed-status.png)
203203
204204
205205
@@ -212,7 +212,7 @@ Use the **POST /standard/rs/v1/tenants/{tenant}/recommendations/next-items** end
212212
213213
1. Click the endpoint name to expand it.
214214
215-
<!-- border -->![PRS](png-filesInference-section.png)
215+
<!-- border -->![PRS](Inference-section.png)
216216
217217
2. Click **Try it out**.
218218
@@ -246,19 +246,18 @@ You can expect the following responses:
246246
247247
- The model is able to understand the request and successfully return a set of recommendations. This returns a 200 code, stating the recommended items with their respective confidence scores.
248248
249-
<!-- border -->![PRS](png-filesSuccessfully-return.png)
249+
<!-- border -->![PRS](Successfully-return.png)
250250
251251
- The user entered an incorrect payload. This returns a 400 code, stating that the model doesn't understand the payload request.
252252
253-
<!-- border -->![PRS](png-filesIncorrect-payload.png)
253+
<!-- border -->![PRS](Incorrect-payload.png)
254254
255255
- Forbidden. The user has exceeded their inference quota for the month. A short message is displayed with code 403. *Bear in mind that users with the free tier model for SAP BTP are limited to a total number of 1000 inference requests per month*.
256256
257-
<!-- border -->![PRS](png-filesForbidden.png)
257+
<!-- border -->![PRS](Forbidden.png)
258258
259259
- The training process has not finished yet. This returns a 404 code, stating that no model instances were found.
260260
261-
<!-- border -->![PRS](png-filesNot-finished-yet.png)
261+
<!-- border -->![PRS](Not-finished-yet.png)
262262
263263
You have now successfully used the Personalized Recommendation service and your own dataset to train a machine learning model and get recommendations based on users' browsing history and/or item description.
264-

tutorials/cp-aibus-pr-web-oauth-token/cp-aibus-pr-web-oauth-token.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ author_profile: https://github.com/Juliana-Morais
2121

2222
To get your OAuth access token you will need the values highlighted in the image below from the service key you created in the previous tutorial: [Use the Free Tier Service Plan to Set Up Account for Personalized Recommendation and Get Service Key](cp-aibus-pr-booster-free-key).
2323

24-
<!-- border -->![PR Token](png-files/service-key-details.png)
24+
<!-- border -->![PR Token](service-key-details.png)
2525

2626

2727

@@ -37,7 +37,7 @@ To get your OAuth access token you will need the values highlighted in the image
3737

3838
4. Click **Sign in** or **OK** (depending on the web browser you work with).
3939

40-
<!-- border -->![PR Token](png-files/web-browser.png)
40+
<!-- border -->![PR Token](web-browser.png)
4141

4242
You should receive a response like the following:
4343

@@ -54,4 +54,3 @@ You should receive a response like the following:
5454
Once the token has been generated, make sure to copy and save it locally for easy access. The token is valid for 12 hours (43199 seconds). After that, you'll need to generate a new one.
5555

5656
You have successfully generated your OAuth access token for the Personalized Recommendation service and you are now all set to: [Get recommendations based on users' browsing history and/or item description](cp-aibus-pr-swagger-ui).
57-

0 commit comments

Comments
 (0)