You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
title: Use Free Tier to Set Up Account for Business Entity Recognition and Get Service Key
3
+
description: Use the Free Tier service plan and an SAP BTP booster to automatically create a service instance, and the associated service key for Business Entity Recognition.
- You have created an account on SAP BTP to try out free tier service plans: [Get an Account on SAP BTP to Try Out Free Tier Service Plans](btp-free-tier-account)
12
+
- You are entitled to use the Business Entity Recognition service: [Manage Entitlements Using the Cockpit](btp-cockpit-entitlements).
13
+
14
+
## Details
15
+
### You will learn
16
+
- How to access your SAP BTP account
17
+
- What are interactive guided boosters
18
+
- How to use the **Set up account for Business Entity Recognition** booster to assign entitlements, update your subaccount, create a service instance and the associated service key for Business Entity Recognition.
19
+
---
20
+
21
+
[ACCORDION-BEGIN [Step 1: ](Go to your SAP BTP account)]
22
+
23
+
1. Open the [SAP BTP cockpit](https://account.hana.ondemand.com/cockpit#/home/allaccounts).
24
+
25
+
2. Access your global account.
26
+
27
+
!
28
+
29
+
>You can also perform this tutorial series using a trial account. For that, follow the steps in [Use Trial to Set Up Account for Business Entity Recognition and Get Service Key](cp-aibus-ber-booster-key).
30
+
31
+
[DONE]
32
+
[ACCORDION-END]
33
+
34
+
35
+
[ACCORDION-BEGIN [Step 2: ](Run booster)]
36
+
37
+
SAP Business Technology Platform creates interactive guided boosters to automate cockpit steps, so users can save time when trying out the services.
38
+
39
+
Now, you will use the **Set up account for Business Entity Recognition** booster to automatically assign entitlements, update your subaccount, create a service instance and the associated service key for Business Entity Recognition.
40
+
41
+
1. On the navigation side bar, click **Boosters**.
42
+
43
+
!
44
+
45
+
2. Search for **Business Entity Recognition** and click the tile to access the booster.
46
+
47
+
!
48
+
49
+
3. Click **Start**.
50
+
51
+
!
52
+
53
+
4. Click **Next**.
54
+
55
+
!
56
+
57
+
5. If you want to create a dedicated subaccount for the service instance, choose **Create Subaccount**. If you want to use an already created subaccount, choose **Select Subaccount** (the selection comes in the next step). For this tutorial, we'll create a dedicated subaccount. When you're done if the selection, click **Next**.
58
+
59
+
!
60
+
61
+
6. Choose the **free** plan. You can also rename the subaccount to `ber-free-tier-service-plan-tutorial`, for example. Click **Next**.
62
+
63
+
!
64
+
65
+
>You can also perform this tutorial series using the `standard` service plan. For that, choose the `standard` plan in this step (instead of free). For more information on the service plans available for Business Entity Recognition, see [Service Plans](https://help.sap.com/docs/Business_Entity_Recognition/b43f8f61368d455793a241d2b10baeb2/cbdf2b3ebb7946c6a218a6c8612a15d3.html).
66
+
67
+
7. Click **Finish**.
68
+
69
+
!
70
+
71
+
Follow the progress of the booster automated tasks.
72
+
73
+
!
74
+
75
+
When the automated tasks are done, see the **Success** dialog box.
76
+
77
+
!
78
+
79
+
[DONE]
80
+
[ACCORDION-END]
81
+
82
+
83
+
[ACCORDION-BEGIN [Step 3: ](Get service key)]
84
+
85
+
You have successfully used the booster **Set up account for Business Entity Recognition** to create a service key for Business Entity Recognition.
86
+
87
+
Click **Download Service Key** to save the service key locally on your computer.
88
+
89
+
!
90
+
91
+
>If you face any issue with the booster **Set up account for Business Entity Recognition**, you can alternatively follow the steps in [Set Up a BTP Account for Tutorials](group.btp-setup) to manually create the service instance and service key for Business Entity Recognition using the free tier service plan.
92
+
93
+
Step 4 is optional. If you're not interested, you can set it to **Done** and go directly to the next tutorial.
94
+
95
+
[VALIDATE_1]
96
+
[ACCORDION-END]
97
+
98
+
99
+
[ACCORDION-BEGIN [Step 4: ](Access service instance and service key (optional))]
100
+
101
+
> This is an optional step. Use it only if you want to access the service instance and service key, you created with the **Set up account for Business Entity Recognition** booster, without having to run it once again.
102
+
103
+
Do the following to access your service instance and service key, without having to run the **Set up account for Business Entity Recognition** booster once again:
104
+
105
+
1. Close the booster **Success** dialog box.
106
+
107
+
!
108
+
109
+
2. Access your global account.
110
+
111
+
!
112
+
113
+
3. Click **Account Explorer** on the navigation side bar and access the subaccount you used to create the service instance and service key for Business Entity Recognition.
114
+
115
+
!
116
+
117
+
4. Click **Instances and Subscriptions** on the navigation side bar. You see the service instance you created with the **Set up account for Business Entity Recognition** booster.
118
+
119
+
!
120
+
121
+
5. Click the navigation arrow to open the details of your service instance. Select **Service Keys (1)**. Then, click the dots to **View**, **Download** or **Delete** your service key.
122
+
123
+
!
124
+
125
+
Congratulations, you have completed this tutorial.
Copy file name to clipboardExpand all lines: tutorials/cp-aibus-ber-booster-key/cp-aibus-ber-booster-key.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Set Up Account for Business Entity Recognition and Get Service Key
2
+
title: Use Trial to Set Up Account for Business Entity Recognition and Get Service Key
3
3
description: Use a booster in SAP BTP Trial to automatically create a service instance, and the associated service key for Business Entity Recognition.
4
4
auto_validation: true
5
5
time: 5
@@ -72,7 +72,7 @@ Click **Download Service Key** to save the service key locally on your computer.
72
72
73
73
!
74
74
75
-
>If you face any issue with the booster **Set up account for Business Entity Recognition**, you can alternatively follow the steps in [Create Service Instance for Business Entity Recognition](cp-aibus-ber-service-instance) to create the service key for Business Entity Recognition manually.
75
+
>If you face any issue with the booster **Set up account for Business Entity Recognition**, you can alternatively follow the steps in [Use Trial to Create a Service Instance for Business Entity Recognition](cp-aibus-ber-service-instance).
76
76
77
77
You are now all set to [Get OAuth Access Token for Business Entity Recognition via Web Browser](cp-aibus-ber-web-oauth-token). Step 4 is optional. If you're not interested, you can set it to **Done** and go directly to the next tutorial.
Copy file name to clipboardExpand all lines: tutorials/cp-aibus-ber-custom-data/cp-aibus-ber-custom-data.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Create Dataset and Upload Training Data
3
3
description: Perform the initial steps to train your own Business Entity Recognition custom model to get machine learning entity predictions for the text you submit to the service.
@@ -33,7 +33,7 @@ In the service key you created for Business Entity Recognition in the previous t
33
33
34
34
2. To be able to use the Swagger UI endpoints, you need to authorize yourself. In the top right corner, click **Authorize**.
35
35
36
-
!
36
+
!
37
37
38
38
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.
39
39
@@ -87,9 +87,9 @@ To see the details of your newly created dataset, use the **GET /datasets/{`data
87
87
88
88
!
89
89
90
-
You receive a response like below. Among the `datasetId` and the `description`, you see the number of documents. Those documents include your training data and you upload some in the following step.
90
+
You should receive a response like below. Among the `datasetId` and the `description`, you see the `documentCount`. The number of documentsinclude the training data files that you'll upload in the next step.
91
91
92
-
!
92
+
!
93
93
94
94
[DONE]
95
95
[ACCORDION-END]
@@ -146,9 +146,9 @@ Using the `datasetId` obtained in the previous step, you can obtain the details
146
146
147
147
!
148
148
149
-
You should receive a response, with the document details, like below. This shows you the size of the document in bytes.
149
+
You should receive a response, with the document details, like below. This shows you the size of the document in bytes.
150
150
151
-
!
151
+
!
152
152
153
153
[DONE]
154
154
[ACCORDION-END]
@@ -168,7 +168,7 @@ Once the training documents are uploaded, you can submit a training job. This tr
168
168
169
169
>Be aware of the following **`modelName`** guidelines:
170
170
171
-
>- You cannot use the same name as a Business Entity Recognition pre-trained model (`sap_email_business_entity` and `sap_invoice_header`)
171
+
>- You cannot use the same name as one of the Business Entity Recognition pre-trained models (see [Extracted Entities by Pre-trained Model](https://help.sap.com/docs/Business_Entity_Recognition/b43f8f61368d455793a241d2b10baeb2/7eb1408001564d679adcd3bc4796800f.html))
172
172
173
173
>- You cannot use `"sap_"` as a prefix
174
174
@@ -186,7 +186,7 @@ Once the training documents are uploaded, you can submit a training job. This tr
186
186
187
187
!
188
188
189
-
This indicates that your training job has been successfully submitted.
189
+
This indicates that your training job has been successfully submitted.
190
190
191
191
[VALIDATE_1]
192
192
[ACCORDION-END]
@@ -198,7 +198,7 @@ To check whether your training already succeeded, you can use the **GET /trainin
198
198
199
199
>**CAUTION:**
200
200
201
-
>In the Trial version of the service, only one training job with `SUCCEEDED` status is allowed. See [Trial Account Input Limits](https://help.sap.com/viewer/b43f8f61368d455793a241d2b10baeb2/SHIP/en-US/c80a45cc7416409eb9bf64667487c375.html). Use the endpoint **DELETE /training/jobs/{`jobId`}** to delete a training job before its status changes to `SUCCEEDED`.
201
+
>In the trial and free tier versions of the service, only one training job with `SUCCEEDED` status is allowed. See [Free Service Plan and Trial Account Technical Constraints](https://help.sap.com/docs/Business_Entity_Recognition/b43f8f61368d455793a241d2b10baeb2/c80a45cc7416409eb9bf64667487c375.html). Use the endpoint **DELETE /training/jobs/{`jobId`}** to delete a training job before its status changes to `SUCCEEDED`.
202
202
203
203
1. Click the endpoint name to expand it.
204
204
@@ -210,13 +210,13 @@ To check whether your training already succeeded, you can use the **GET /trainin
210
210
211
211
!
212
212
213
-
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.
213
+
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.
214
214
215
-
!
215
+
!
216
216
217
-
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.
217
+
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.
0 commit comments