Skip to content

Commit 15b7b7f

Browse files
authored
Merge pull request #23021 from Juliana-Morais/master
updated asset links and images
2 parents 1c620d8 + 28a3c14 commit 15b7b7f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+55
-57
lines changed

tutorials/cp-aibus-ber-custom-data/cp-aibus-ber-custom-data.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,23 @@ In the service key you created for Business Entity Recognition in the previous t
3232

3333
1. To access the Business Entity Recognition Swagger UI, add **`/api/v1`** to the `url` value, paste it into any web browser and press **Enter**.
3434

35-
<!-- border -->![BER](png-files/service-key-details.png)
35+
<!-- border -->![BER](service-key-details.png)
3636

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

39-
<!-- border -->![BER](png-files/swagger.png)
39+
<!-- border -->![BER](swagger.png)
4040

4141
3. Get the `access_token` value created in the previous tutorial: [Get OAuth Access Token for Business Entity Recognition Using Any Web Browser](cp-aibus-ber-web-oauth-token), then add **bearer** in front of it, and enter in the **Value** field.
4242

4343
```
4444
bearer <access_token>
4545
```
4646
47-
<!-- border -->![BER](png-files/Authorize.png)
47+
<!-- border -->![BER](Authorize.png)
4848
4949
4. Click **Authorize** and then click **Close**.
5050
51-
<!-- border -->![BER](png-files/Authorize2.png)
51+
<!-- border -->![BER](Authorize2.png)
5252
5353
5454
@@ -61,17 +61,17 @@ Use the **POST /datasets** endpoint to create a dataset that will be used to tra
6161
6262
2. Click **Try it out**.
6363
64-
<!-- border -->![BER](png-files/post-datasets-1.png)
64+
<!-- border -->![BER](post-datasets-1.png)
6565
6666
3. In **payload**, enter a `description` for your dataset, `"Tutorial dataset"`, for example.
6767
6868
4. Click **Execute**.
6969
70-
<!-- border -->![BER](png-files/post-datasets-2.png)
70+
<!-- border -->![BER](post-datasets-2.png)
7171
7272
5. Copy the **`datasetId`** from the **Response body**.
7373
74-
<!-- border -->![BER](png-files/post-datasets-3.png)
74+
<!-- border -->![BER](post-datasets-3.png)
7575
7676
7777
@@ -86,11 +86,11 @@ To see the details of your newly created dataset, use the **GET /datasets/{`data
8686
8787
3. Enter the **`datasetId`** obtained in the previous step and click **Execute**.
8888
89-
<!-- border -->![BER](png-files/get-datasets-1.png)
89+
<!-- border -->![BER](get-datasets-1.png)
9090
9191
You should receive a response like below. Among the `datasetId` and the `description`, you see the `documentCount`. The number of documents include the training data files that you'll upload in the next step.
9292
93-
<!-- border -->![BER](png-files/get-datasets-2.png)
93+
<!-- border -->![BER](get-datasets-2.png)
9494
9595
9696
@@ -103,9 +103,9 @@ Please bear in mind that Business Entity Recognition requires your data to be in
103103
104104
>As an alternative to uploading your own JSON file to the service, you can use the following sample files (right click on the link, then click ***Save link as*** to download the files locally):
105105
106-
>- [Sample Training Data 1](https://raw.githubusercontent.com/SAPDocuments/Tutorials/master/tutorials/cp-aibus-ber-custom-data/data/Tutorial_training_data_1.json)
106+
>- [Sample Training Data 1](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/cp-aibus-ber-custom-data/Tutorial_training_data_1.json)
107107
108-
>- [Sample Training Data 2](https://raw.githubusercontent.com/SAPDocuments/Tutorials/master/tutorials/cp-aibus-ber-custom-data/data/Tutorial_training_data_2.json)
108+
>- [Sample Training Data 2](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/cp-aibus-ber-custom-data/Tutorial_training_data_2.json)
109109
110110
>Please repeat this step twice and upload one document each time. The more data is available the better predictions the model can give you.
111111
@@ -120,11 +120,11 @@ To upload documents, do the following:
120120
121121
4. Click **Execute**.
122122
123-
<!-- border -->![BER](png-files/post-datasets-docs-1.png)
123+
<!-- border -->![BER](post-datasets-docs-1.png)
124124
125125
5. Copy the **`documentId`** from the **Response body**.
126126
127-
<!-- border -->![BER](png-files/post-datasets-docs-2.png)
127+
<!-- border -->![BER](post-datasets-docs-2.png)
128128
129129
130130
@@ -143,11 +143,11 @@ Using the `datasetId` obtained in the previous step, you can obtain the details
143143
144144
5. Click **Execute**.
145145
146-
<!-- border -->![BER](png-files/get-datasets-docs-1.png)
146+
<!-- border -->![BER](get-datasets-docs-1.png)
147147
148148
You should receive a response, with the document details, like below. This shows you the size of the document in bytes.
149149
150-
<!-- border -->![BER](png-files/get-datasets-docs-2.png)
150+
<!-- border -->![BER](get-datasets-docs-2.png)
151151
152152
153153
@@ -178,11 +178,11 @@ Once the training documents are uploaded, you can submit a training job. This tr
178178
179179
4. Click **Execute**.
180180
181-
<!-- border -->![BER](png-files/post-training-jobs-1.png)
181+
<!-- border -->![BER](post-training-jobs-1.png)
182182
183183
5. Copy the **`jobId`** from the **Response body**. This allows you to check the status of the training.
184184
185-
<!-- border -->![BER](png-files/post-training-jobs-2.png)
185+
<!-- border -->![BER](post-training-jobs-2.png)
186186
187187
This indicates that your training job has been successfully submitted.
188188
@@ -206,13 +206,13 @@ To check whether your training already succeeded, you can use the **GET /trainin
206206
207207
4. Click **Execute**.
208208
209-
<!-- border -->![BER](png-files/get-training-jobs-1.png)
209+
<!-- border -->![BER](get-training-jobs-1.png)
210210
211211
You should receive a response like below. The status `RUNNING` indicates that the training is still in progress. In case the status is `PENDING`, then the training has not started yet.
212212
213-
<!-- border -->![BER](png-files/get-training-jobs-2.png)
213+
<!-- border -->![BER](get-training-jobs-2.png)
214214
215215
You may check the status now and then. Please note that the training may take up to 5 hours. Afterwards, the training status changes to `SUCCEEDED`. Along with that, you receive all the capabilities of the model, that are the entities the model can recognize.
216216
217-
<!-- border -->![BER](png-files/get-training-jobs-3.png)
217+
<!-- border -->![BER](get-training-jobs-3.png)
218218

tutorials/cp-aibus-dar-swagger-ior-upload/cp-aibus-dar-swagger-ior-upload.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ You'll use Swagger UI, via any web browser, to call the Data Attribute Recommend
3737

3838
In the service key you created for Data Attribute Recommendation in the previous tutorial: [Use Free Tier to Set Up Account for Data Attribute Recommendation and Get Service Key](cp-aibus-dar-booster-free-key) or [Use Trial to Set Up Account for Data Attribute Recommendation and Get Service Key](cp-aibus-dar-booster-key), you find a section called `swagger` (as highlighted in the image below) with three entries, called `dm` (data manager), `mm` (model manager) and `inference`. You'll use all three Swagger UIs throughout the tutorials.
3939

40-
<!-- border -->![Service Key](png-files/service-key-details.png)
40+
<!-- border -->![Service Key](service-key-details.png)
4141

4242
For this tutorial, copy the URL of the Swagger UI for `dm` and open it in a browser tab.
4343

4444
>After finishing this tutorial, keep the Swagger UI for `dm` open to perform the clean up tasks in [Use the Invoice Object Recommendation Business Blueprint to Predict Financial Objects](cp-aibus-dar-swagger-ior-predict).
4545
4646
1. To be able to use the Swagger UI endpoints, you need to authorize yourself. In the top right corner, click **Authorize**.
4747

48-
<!-- border -->![Authorize](png-files/swagger-authorize.png)
48+
<!-- border -->![Authorize](swagger-authorize.png)
4949

5050
2. Get the `access_token` value created in the previous tutorial: [Get OAuth Access Token for Data Attribute Recommendation Using Any Web Browser](cp-aibus-dar-web-oauth-token), then add **Bearer** (with capitalized "B") in front of it, and enter in the **Value** field.
5151

@@ -55,7 +55,7 @@ For this tutorial, copy the URL of the Swagger UI for `dm` and open it in a brow
5555
5656
3. Click **Authorize** and then click **Close**.
5757
58-
<!-- border -->![Authorize](png-files/swagger-token.png)
58+
<!-- border -->![Authorize](swagger-token.png)
5959
6060
6161
@@ -144,15 +144,15 @@ To create the dataset schema, proceed as follows:
144144

145145
1. In Swagger UI, expand the endpoint `POST /datasetSchemas` by clicking on it. Then click **Try it out**.
146146

147-
<!-- border -->![Dataset Schema Endpoint](png-files/dataset-schema-endpoint.png)
147+
<!-- border -->![Dataset Schema Endpoint](dataset-schema-endpoint.png)
148148

149149
2. Copy the above dataset schema into the text area. Then click **Execute** to create it.
150150

151-
<!-- border -->![Dataset Schema Execute](png-files/dataset-schema-execute.png)
151+
<!-- border -->![Dataset Schema Execute](dataset-schema-execute.png)
152152

153153
3. Further below, you find the response of the service. The response includes a representation of dataset schema that was just created. Additionally, the dataset schema received an `id`. Copy it locally as you'll need it in the next step.
154154

155-
<!-- border -->![Dataset Schema Response](png-files/dataset-schema-response.png)
155+
<!-- border -->![Dataset Schema Response](dataset-schema-response.png)
156156

157157
You have successfully created a dataset schema.
158158

@@ -167,15 +167,15 @@ To create the dataset, proceed as follows:
167167

168168
1. Expand the endpoint `POST /datasets` by clicking on it. Then click **Try it out**.
169169

170-
<!-- border -->![Dataset Endpoint](png-files/dataset-endpoint.png)
170+
<!-- border -->![Dataset Endpoint](dataset-endpoint.png)
171171

172172
2. In the text area, replace the parameter `datasetSchemaId` with the `id` that you copied from the previous step and replace the parameter `name` with an appropriate name for you dataset, `ior_tutorial_dataset`, for example. Then click **Execute** to create the dataset.
173173

174-
<!-- border -->![Dataset Execute](png-files/dataset-execute.png)
174+
<!-- border -->![Dataset Execute](dataset-execute.png)
175175

176176
3. In the response of the service, you find the `id` of your dataset. Copy it locally as you'll need it in the next steps and also in the next tutorial: [Use the Invoice Object Recommendation Business Blueprint to Train a Machine Learning Model](cp-aibus-dar-swagger-ior-model). Additionally, you find the `status` of the dataset. The status is `NO_DATA` as no data file has been uploaded yet.
177177

178-
<!-- border -->![Dataset Response](png-files/dataset-response.png)
178+
<!-- border -->![Dataset Response](dataset-response.png)
179179

180180
You have successfully created a dataset.
181181

@@ -187,25 +187,25 @@ You have successfully created a dataset.
187187

188188
The final step of this tutorial is to upload data to your dataset.
189189

190-
In this tutorial, you'll use this [dataset](https://github.com/SAPDocuments/Tutorials/raw/master/tutorials/cp-aibus-dar-swagger-ior-upload/data/Dataset_IOR.csv). Right click on the link, then click ***Save link as*** to open the file dialog. In the dialog, replace the file ending `txt` with `csv` as indicated below. Then save the file.
190+
In this tutorial, you'll use this [dataset](https://raw.githubusercontent.com/sap-tutorials/Tutorials/master/tutorials/cp-aibus-dar-swagger-ior-upload/Dataset_IOR.csv). Right click on the link, then click ***Save link as*** to open the file dialog. In the dialog, replace the file ending `txt` with `csv` as indicated below. Then save the file.
191191

192-
<!-- border -->![Save File Dialog](png-files/save-file-dialog.png)
192+
<!-- border -->![Save File Dialog](save-file-dialog.png)
193193

194194
In Swagger UI, proceed as follows to upload to the data:
195195

196196
1. Expand the endpoint `POST /datasets/{id}/data` by clicking on it. Then click **Try it out**.
197197

198-
<!-- border -->![Data Endpoint](png-files/data-endpoint.png)
198+
<!-- border -->![Data Endpoint](data-endpoint.png)
199199

200200
2. Fill the parameter `id` with the `id` of your dataset that you previously copied.
201201

202202
3. Click **Choose File** below the parameter `Request body`. In the dialog that opens, select the IOR dataset that you just downloaded. Then click **Execute** to upload the data.
203203

204-
<!-- border -->![Data Execute](png-files/data-execute.png)
204+
<!-- border -->![Data Execute](data-execute.png)
205205

206206
In the response, you'll see that the status of your dataset has changed to `VALIDATING`. The service is now validating the data that you have uploaded.
207207

208-
<!-- border -->![Data Response](png-files/data-response.png)
208+
<!-- border -->![Data Response](data-response.png)
209209

210210
You have successfully uploaded data to your dataset.
211211

@@ -218,15 +218,15 @@ To check the validation status of your data, proceed as follows:
218218

219219
1. Expand the endpoint `GET /datasets/{id}` by clicking on it. Then click **Try it out**.
220220

221-
<!-- border -->![Dataset Status Endpoint](png-files/dataset-status-endpoint.png)
221+
<!-- border -->![Dataset Status Endpoint](dataset-status-endpoint.png)
222222

223223
2. Fill the parameter `id` with the `id` of your dataset. Click **Execute**.
224224

225-
<!-- border -->![Dataset Status Execute](png-files/dataset-status-execute.png)
225+
<!-- border -->![Dataset Status Execute](dataset-status-execute.png)
226226

227227
3. In the response of the service, you find the status of your dataset. If the status is still `VALIDATING`, check back in a few minutes. If the status is `SUCCEEDED`, your data is valid. In case the status is either `INVALID_DATA` or `VALIDATION_FAILED`, create a new dataset and upload the data once again.
228228

229-
<!-- border -->![Dataset Status Response](png-files/dataset-status-response.png)
229+
<!-- border -->![Dataset Status Response](dataset-status-response.png)
230230

231231
You have successfully created a dataset and uploaded data. You can now use the dataset to train a machine learning model.
232232

0 commit comments

Comments
 (0)