Skip to content

free tier and swagger ui updates #18404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---
title: Use Free Tier to Set Up Account for Business Entity Recognition and Get Service Key
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.
auto_validation: true
time: 5
tags: [tutorial>beginner, topic>machine-learning, topic>artificial-intelligence, topic>cloud, software-product>sap-business-technology-platform, software-product>sap-ai-business-services, software-product>business-entity-recognition, tutorial>free-tier]
primary_tag: topic>machine-learning
---

## Prerequisites
- 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)
- You are entitled to use the Business Entity Recognition service: [Manage Entitlements Using the Cockpit](btp-cockpit-entitlements).

## Details
### You will learn
- How to access your SAP BTP account
- What are interactive guided boosters
- 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.
---

[ACCORDION-BEGIN [Step 1: ](Go to your SAP BTP account)]

1. Open the [SAP BTP cockpit](https://account.hana.ondemand.com/cockpit#/home/allaccounts).

2. Access your global account.

!![global account](global-account.png)

>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).

[DONE]
[ACCORDION-END]


[ACCORDION-BEGIN [Step 2: ](Run booster)]

SAP Business Technology Platform creates interactive guided boosters to automate cockpit steps, so users can save time when trying out the services.

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.

1. On the navigation side bar, click **Boosters**.

!![Service Key](access-booster.png)

2. Search for **Business Entity Recognition** and click the tile to access the booster.

!![Service Key](access-booster-tile.png)

3. Click **Start**.

!![Service Key](booster-start.png)

4. Click **Next**.

!![Service Key](booster-next.png)

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**.

!![Service Key](booster-scenario.png)

6. Choose the **free** plan. You can also rename the subaccount to `ber-free-tier-service-plan-tutorial`, for example. Click **Next**.

!![Service Key](booster-subaccount.png)

>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).

7. Click **Finish**.

!![Service Key](booster-finish.png)

Follow the progress of the booster automated tasks.

!![Service Key](booster-progress.png)

When the automated tasks are done, see the **Success** dialog box.

!![Service Key](booster-success.png)

[DONE]
[ACCORDION-END]


[ACCORDION-BEGIN [Step 3: ](Get service key)]

You have successfully used the booster **Set up account for Business Entity Recognition** to create a service key for Business Entity Recognition.

Click **Download Service Key** to save the service key locally on your computer.

!![Service Key](booster-success-key.png)

>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.

Step 4 is optional. If you're not interested, you can set it to **Done** and go directly to the next tutorial.

[VALIDATE_1]
[ACCORDION-END]


[ACCORDION-BEGIN [Step 4: ](Access service instance and service key (optional))]

> 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.

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:

1. Close the booster **Success** dialog box.

!![Service Key](leave-success.png)

2. Access your global account.

!![Service Key](access-global-account.png)

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.

!![Service Key](subaccounts.png)

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.

!![Service Key](service-instance.png)

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.

!![Service Key](service-key.png)

Congratulations, you have completed this tutorial.

[DONE]
[ACCORDION-END]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Set Up Account for Business Entity Recognition and Get Service Key
title: Use Trial to Set Up Account for Business Entity Recognition and Get Service Key
description: Use a booster in SAP BTP Trial to automatically create a service instance, and the associated service key for Business Entity Recognition.
auto_validation: true
time: 5
Expand Down Expand Up @@ -72,7 +72,7 @@ Click **Download Service Key** to save the service key locally on your computer.

!![Service Key](booster-success-key.png)

>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.
>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).

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.

Expand Down
26 changes: 13 additions & 13 deletions tutorials/cp-aibus-ber-custom-data/cp-aibus-ber-custom-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create Dataset and Upload Training Data
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.
auto_validation: true
time: 20
tags: [tutorial>beginner, topic>machine-learning, topic>artificial-intelligence, topic>cloud, software-product>sap-business-technology-platform, software-product>sap-ai-business-services, software-product>business-entity-recognition]
tags: [tutorial>beginner, topic>machine-learning, topic>artificial-intelligence, topic>cloud, software-product>sap-business-technology-platform, software-product>sap-ai-business-services, software-product>business-entity-recognition, tutorial>free-tier]
primary_tag: topic>machine-learning
---

Expand Down Expand Up @@ -33,7 +33,7 @@ In the service key you created for Business Entity Recognition in the previous t

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

!![BER](png-files/swagger0.png)
!![BER](png-files/swagger.png)

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.

Expand Down Expand Up @@ -87,9 +87,9 @@ To see the details of your newly created dataset, use the **GET /datasets/{`data

!![BER](png-files/get-datasets-1.png)

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.
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.

!![BER](png-files/get-datasets-2.png)
!![BER](png-files/get-datasets-2.png)

[DONE]
[ACCORDION-END]
Expand Down Expand Up @@ -146,9 +146,9 @@ Using the `datasetId` obtained in the previous step, you can obtain the details

!![BER](png-files/get-datasets-docs-1.png)

You should receive a response, with the document details, like below. This shows you the size of the document in bytes.
You should receive a response, with the document details, like below. This shows you the size of the document in bytes.

!![BER](png-files/get-datasets-docs-2.png)
!![BER](png-files/get-datasets-docs-2.png)

[DONE]
[ACCORDION-END]
Expand All @@ -168,7 +168,7 @@ Once the training documents are uploaded, you can submit a training job. This tr

>Be aware of the following **`modelName`** guidelines:​

>- You cannot use the same name as a Business Entity Recognition pre-trained model (`sap_email_business_entity` and `sap_invoice_header`)
>- 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))

>- You cannot use `"sap_"` as a prefix

Expand All @@ -186,7 +186,7 @@ Once the training documents are uploaded, you can submit a training job. This tr

!![BER](png-files/post-training-jobs-2.png)

This indicates that your training job has been successfully submitted.
This indicates that your training job has been successfully submitted.

[VALIDATE_1]
[ACCORDION-END]
Expand All @@ -198,7 +198,7 @@ To check whether your training already succeeded, you can use the **GET /trainin

>**CAUTION:**

>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`.
>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`.

1. Click the endpoint name to expand it.

Expand All @@ -210,13 +210,13 @@ To check whether your training already succeeded, you can use the **GET /trainin

!![BER](png-files/get-training-jobs-1.png)

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.
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.

!![BER](png-files/get-training-jobs-2.png)
!![BER](png-files/get-training-jobs-2.png)

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.
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.

!![BER](png-files/get-training-jobs-3.png)
!![BER](png-files/get-training-jobs-3.png)

[DONE]
[ACCORDION-END]
Binary file modified tutorials/cp-aibus-ber-custom-data/png-files/get-datasets-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tutorials/cp-aibus-ber-custom-data/png-files/get-datasets-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tutorials/cp-aibus-ber-custom-data/png-files/post-datasets-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tutorials/cp-aibus-ber-custom-data/png-files/post-datasets-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Loading