vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Rotation is allowed only after all locks on the previous secret version are removed.





 Creating locks in the UI 

You can create up to 1000 locks on a secret by using the Secrets Manager UI. Each lock can be used to represent a single application or service that uses your secret.

A secret is considered locked after you attach one or more locks to it. A lock can be applied only on a secret version that contains active payload, or secret data.

To help you to create a new lock and remove older locks in a single operation, you can also specify an optional mode at lock creation.



Table 1. Optional lock modes and their descriptions

 Mode Description 

 Remove previous locks Removes any other locks that match the name that you specify. If any matching locks are found in the previous version of the secret, those locks are deleted when your new lock is created.<br><br>For example, suppose that the previous version of your secret contains a lock lock-x. Creating a lock on the current version of your secret and enabling the Delete matching locks option results in removing lock-x from the previous version. 
 Remve previous locks and delete previous version data Same as the previous option, but also permanently deletes the data of the previous secret version if it doesn't have any locks that are associated with it.<br><br>Suppose that the previous version of your secret contains a lock lock-z. Creating a lock on the current version of your secret with both the Delete matching locks and Delete previous version data options results in removing lock-z from the previous version. Additionally, because the previous version doesn't have any other locks that are attached to it, the secret data that is associated with the previous version is also deleted. 





 Creating a lock on the current secret version 

You can lock the current version of a secret by using the Secrets Manager UI. A successful request attaches a new lock to the current version of your selected secret, or replaces a lock of the same name if it already exists.



1. In the console, click the Menu icon !
To define a custom repeat setting, click Open Properties, select Advanced, and then select the exact number of repeats or range of repeats that you want to define. The maximum number of repeats that are allowed for a token is 5. 



* Feature Setting: At least one of the feature settings must be defined. You can add more features to add to the number of conditions that must be met for text to match this pattern. The options are described in the following table.

Table 2. Feature settings



 Setting option Condition it adds 

 Text Must match the exact text in this token. This option is applied by default. You can remove it, but only if you add a different setting as a condition or apply the Any token setting. 
 Length Must match the character length of this token. The length is counted starting at 0 from in front of the first character. 





The rest of the options differ depending on the type of the token.



* Unannotated token that does not match a regex or dictionary term: These settings are available for tokens that are not annotated and do not match a regex or dictionary term.

Table 3. Unannotated token settings



 Setting option Description 

 Part of Speech Must be the same part of speech as this token. The following types are supported:<br><br><br><br> * adjective<br> * adposition<br> * adverb<br> * conjunction<br> * determiner<br> * interjection<br> * noun<br> * numeral<br> * pronoun<br> * residual<br> * verb<br><br><br> 
 Lemma Must have the same lemma as this token. 
 Character Type Must have the same character type as this token.
To define a custom repeat setting, click Open Properties, select Advanced, and then select the exact number of repeats or range of repeats that you want to define. The maximum number of repeats that are allowed for a token is 5. 



* Feature Setting: At least one of the feature settings must be defined. You can add more features to add to the number of conditions that must be met for text to match this pattern. The options are described in the following table.

Table 2. Feature settings



 Setting option Condition it adds 

 Text Must match the exact text in this token. This option is applied by default. You can remove it, but only if you add a different setting as a condition or apply the Any token setting. 
 Length Must match the character length of this token. The length is counted starting at 0 from in front of the first character. 



The rest of the options differ depending on the type of the token.
* Unannotated token that does not match a regex or dictionary term: These settings are available for tokens that are not annotated and do not match a regex or dictionary term.

Table 3. Unannotated token settings



 Setting option Description 

 Part of Speech Must be the same part of speech as this token. The following types are supported:<br><br><br><br> * adjective<br> * adposition<br> * adverb<br> * conjunction<br> * determiner<br> * interjection<br> * noun<br> * numeral<br> * pronoun<br> * residual<br> * verb<br><br><br> 
 Lemma Must have the same lemma as this token. 
 Character Type Must have the same character type as this token.
[Template details](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/actions-templates-review-2.png)

Template details
6. Your list of selected templates includes all the ones that you chose. You can select as many templates as you want. If you change your mind, click the trash can icon to remove a template from the list.

Zoom

![Selected templates](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/actions-templates-selected.png)

Selected templates
7. When you're ready, click Add templates.
8. In the actions editor, you can use a new action as-is, or modify it to fit your use case.

Zoom

![New action](https://cloud.ibm.com/docs-content/v1/content/ca9232b3702768f24bb897f48f10778fcda28718/watson-assistant/images/actions-templates-editor.png)

New action



You can create multiple actions from the same template. For example, if you used the Book a meeting template to create an action, you can choose that template again. If the first action is still named Book a meeting, the new action is added with the name Book a meeting (1).





 Preview actions 

Most action templates are complete. (Starter kit templates are marked with an asterisk and require setup.) You can try out an action right away even without making any changes.

To preview the action that you created from a template:



1. In the actions editor, click Preview.
2. Try some of the example phrases from Customer starts with to see how the assistant responds.

Zoom
Assembling a team 

The creation of a model requires input from subject matter experts, project managers, and users who can understand and interpret statistical models. You must add a user in Knowledge Studio for each person who needs to log in.



 Before you begin 



* Make sure you're using a supported browser. For more information, see [Browser requirements](https://cloud.ibm.com/docs/watson-knowledge-studio?topic=watson-knowledge-studio-system-requirements).
* [Create an instance of Knowledge Studio](https://cloud.ibm.com/docs/watson-knowledge-studio?topic=watson-knowledge-studio-wks_tutintroinstance). Make sure you select a Standard or Premium plan. Lite plans are limited to one user.
* Make sure that you are assigned an Admin role for your Knowledge Studio instance. The first user to launch Knowledge Studio is automatically assigned an Admin role.
* Understand the [Knowledge Studio roles](https://cloud.ibm.com/docs/watson-knowledge-studio?topic=watson-knowledge-studio-rolesdescriptions) that you can assign.







 Adding users in Knowledge Studio 

To add users to a Knowledge Studio service instance:



1. [Launch the Knowledge Studio application.](https://cloud.ibm.com/docs/watson-knowledge-studio?topic=watson-knowledge-studio-wks_tutintrolaunching-the-knowledge-studio-application)
2. Click the Settings icon ![the Settings icon](https://cloud.ibm.com/docs-content/v1/content/50eddb8fd81f33092880335ff107a78ff5cd0f65/watson-knowledge-studio/images/settings.png), then click Manage service details.
3. In the Manage users section, enter the IBMid for the user you want to add.
4. Select the role you want to give to the user.
Before you create a key ring for your Key Protect instance, keep in mind the following considerations:



* Every Key Protect instance comes with a default key ring. Each newly created Key Protect instance comes with a generated key ring with an ID of default. All keys that are not associated with an otherwise specified key ring exists within the default key ring.
* Key rings can hold standard and root keys. Key rings can contain both standard and root keys. There is not a limit on how many keys can exist within a key ring.
* A key can only be a part of one key ring at a time. A key can only be a part of one key ring. Key ring assignment happens upon key creation. If a key ring id is not passed in upon creation, the key will be a part of the default key ring.



The maximum amount of key rings is 50 per service instance.



 Creating key rings with the UI 

You must have either the service "Writer" or "Manager" role to create a key ring.

To create a key ring:



1. Click on Key rings in the left navigation.
2. In the Key rings panel, click the Create button.
3. In the Create a key ring tab, give your new key ring a name, following the instructions on permitted characters. Then click Create.



After it is created, your new key ring will appear in the list of key rings and you are able to transfer keys to it or create keys for it.





 Creating key rings with the API 

Create a key ring by making a POST call to the following endpoint.

https://<region>.kms.cloud.ibm.com/api/v2/keys



1. [Retrieve your authentication credentials to work with keys in the service](https://cloud.ibm.com/docs/key-protect?topic=key-protect-set-up-api).
2. Create a key ring by running the following curl command.
This documentation is for the classic Watson Assistant experience. To see the documentation for the new Watson Assistant, please go [here](https://cloud.ibm.com/docs/watson-assistant).



 Backing up and restoring data 

Back up and restore your data by downloading, and then uploading the data.

You can download the following data from a Watson Assistant service instance:



* Dialog skill training data (intents and entities)
* Dialog skill dialog
* Actions skill



You cannot download the following data:



* Search skill
* Assistant, including any configured integrations





 Retaining logs 

If you want to store logs of conversations that users have had with your assistant, you can use the /logs API to export your log data. See [API reference](https://cloud.ibm.com/apidocs/assistant/assistant-v1listlogs) for details.

To get the workspace ID for a skill, from the skill tile, click the ![open and close list of options](https://cloud.ibm.com/docs-content/v1/content/417db917d18067d9dcc4cf2612564a9a87c3ddc8/assistant/images/kebab.png) icon, and then choose View API Details.

Logs are stored for a different amount of time depending on your service plan. For example, Lite plans provide logs from the past 7 days only. See [Log limits](https://cloud.ibm.com/docs/assistant?topic=assistant-logslogs-limits) for more information.

You cannot import logs from one skill into another skill.





 Downloading a skill 

To back up actions or dialog skill data, download the skill as a JSON file, and store the JSON file.



1. Find the actions or dialog skill tile on the Skills page or on the configuration page of an assistant that uses the skill.
2. Click the !
Enabling a system entity makes it possible to quickly populate your skill with training data that is common to many use cases.

System entities can be used to recognize a broad range of values for the object types they represent. For example, the @sys-number system entity matches any numerical value, including whole numbers, decimal fractions, or even numbers written out as words.

System entities are centrally maintained, so any updates are available automatically. You cannot modify system entities.



1. From the skill menu, click to expand Entities, and then click System entities.

![Screen capture of "System entities" tab](https://cloud.ibm.com/docs-content/v1/content/a2b18c153837bce00a5b4de496e4b4ca64bbf56e/assistant-data/images/system-entities1.png)

v1.3: On the Entities page, click System entities.
2. Browse through the list of system entities to choose the ones that are useful for your application.



* To see more information about a system entity, including examples of matching input, click the entity in the list.
* For details about the available system entities, see [System entities](https://cloud.ibm.com/docs/assistant-data?topic=assistant-data-system-entities).



3. Click the toggle switch next to a system entity to enable or disable it.



After you enable system entities, Watson Assistant begins to retrain. After training is complete, you can use the entities.





 Entity limits 



Limit details

 Entities per skill Entity values per skill Entity synonyms per skill Contextual entities and annotations 

 1,000 100,000 100,000 150 contextual entities with 3000 annotations 



System entities that you enable for use count toward your totals.





 Editing entities 

You can click any entity in the list to open it for editing. You can rename or delete entities, and you can add, edit, or delete values, synonyms, or patterns.

If you change the entity type from synonym to pattern, or vice versa, the existing values are converted, but might not be useful as-is.
* You can include multiple words that are separated by spaces.



* For most languages, the service enforces a maximum of 40 total characters, not including leading or trailing spaces.
* For Japanese, the service enforces a maximum limit of 25 total characters, not including leading or trailing spaces. If you add a custom word or sounds-like that exceeds this limit, the service automatically treats the word as if it were added by a corpus. The word does not appear as a custom word for the model. For the most effective training, it is recommended that Japanese custom words and sounds-likes contain no more than 20 characters.









 Guidelines for Japanese 

Follow these guidelines when specifying a sounds-like for Japanese:



* Use only full-width Katakana characters by using the ― lengthen symbol (chou-on, or 長音, in Japanese). Do not use half-width characters. (For the display_as field, if you enter a half-width character, it is rendered as a half-width character in transcription results.)
* Use contracted sounds (yoh-on, or 拗音, in Japanese) only in the following syllable contexts:

イェ, ウィ, ウェ, ウォ, キィ, キャ, キュ, キョ, ギャ, ギュ, ギョ, クァ, クィ, クェ, クォ

グァ, グォ, シィ, シェ, シャ, シュ, ショ, ジィ, ジェ, ジャ, ジュ, ジョ, スィ, ズィ, チェ

チャ, チュ, チョ, ヂェ, ヂャ, ヂュ, ヂョ, ツァ, ツィ, ツェ, ツォ, ティ, テュ, ディ, デャ

デュ, デョ, トゥ, ドゥ, ニェ, ニャ, ニュ, ニョ, ヒャ, ヒュ, ヒョ, ビャ, ビュ, ビョ, ピィ

ピャ, ピュ, ピョ, ファ, フィ, フェ, フォ, フュ, ミャ, ミュ, ミョ, リィ, リェ, リャ, リュ

リョ, ヴァ, ヴィ, ヴェ, ヴォ, ヴュ
You can add or delete audio and retrain a model as often as needed. You must retrain a model for any changes to its audio to take effect.



 Create a custom acoustic model 

You use the POST /v1/acoustic_customizations method to create a new custom acoustic model. The method accepts a JSON object that defines the attributes of the new custom model as the body of the request. The new custom model is owned by the instance of the service whose credentials are used to create it. For more information, see [Ownership of custom models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-usagecustom-owner).

You can create a maximum of 1024 custom acoustic models per owning credentials. For more information, see [Maximum number of custom models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-usagecustom-maximum).

A new custom acoustic model has the following attributes:

name (required string)
: A user-defined name for the new custom acoustic model. Use a localized name that matches the language of the custom model and reflects the acoustic environment of the model, such as Mobile custom model or Noisy car custom model.



* Include a maximum of 256 characters in the name.
* Do not use backslashes, slashes, colons, equal signs, ampersands, or question marks in the name.
* Use a name that is unique among all custom acoustic models that you own.



base_model_name (required string)
: The name of the base language model that is to be customized by the new model. You must use the name of a model that is returned by the GET /v1/models method. The new custom model can be used only with the base model that it customizes.

description (optional string)
: A recommended description of the new custom model.



* Use a localized description that matches the language of the custom model.
* Include a maximum of 128 characters in the description.



The following example creates a new custom acoustic model named Example acoustic model.
Working with audio resources 

Acoustic model customization is available only for previous-generation models. It is not available for next-generation models.

You can add individual audio files or archive files that contain multiple audio files to a custom acoustic model. The recommended means of adding audio resources is by adding archive files. Creating and adding a single archive file is considerably more efficient than adding multiple audio files individually. You can also submit requests to add multiple different audio resources at the same time.



 Adding an audio resource 

You use the POST /v1/acoustic_customizations/{customization_id}/audio/{audio_name} method to add either type of audio resource to a custom acoustic model. You pass the audio resource as the body of the request and include the following parameters:



* The customization_id path parameter to specify the customization ID of the model.
* The audio_name path parameter to specify a name for the audio resource.



* Use a localized name that matches the language of the custom model and reflects the contents of the resource.
* Include a maximum of 128 characters in the name.
* Do not use characters that need to be URL-encoded. For example, do not use spaces, slashes, backslashes, colons, ampersands, double quotes, plus signs, equals signs, questions marks, and so on in the name. (The service does not prevent the use of these characters. But because they must be URL-encoded wherever used, their use is strongly discouraged.)
* Do not use the name of an audio resource that has already been added to the custom model.





When you update a model's audio resources, you must train the model for the changes to take effect during transcription. For more information, see [Train the custom acoustic model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustictrainModel-acoustic).





 Adding an audio file 

To add an individual audio file to a custom acoustic model, you specify the format (MIME type) of the audio with the Content-Type header. You can add audio with any format that is supported for use with recognition requests.
Created: Fri, 15 Jan 2021 13:32:30 -0500
Updated: Fri, 15 Jan 2021 13:32:45 -0500

Quotas:
Category Used Limit
App revisions 33 100
Apps 10 100
Build runs 4 100
Builds 4 100
Configmaps 7 100
CPU 6.15 64
Ephemeral storage 5415750Ki 256G
Instances (active) 6 250
Instances (total) 9 2500
Job runs 4 100
Jobs 3 100
Memory 26400M 256G
Secrets 21 100
Subscriptions (cron) 1 100
Subscriptions (IBM Cloud Object Storage) 0 100





 How can I set policies so others can work with my project? 

See information about [managing user access](https://cloud.ibm.com/docs/codeengine?topic=codeengine-iam) to learn about setting IAM policies so others can work with your Code Engine project.





 Are there project limits to consider? 

The maximum number of projects that you can create per region is 20. For more information about limits for projects, see [Project quotas](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limitsproject_quotas).







 Create a project 

You can create a project through the console or with the CLI.



 Creating a project from the console 



1. From the [Projects page on the Code Engine console](https://cloud.ibm.com/codeengine/projects), click Create. Alternatively, from the [Code Engine console](https://cloud.ibm.com/codeengine/overview), you can select Start creating from either Run a container image or Run your source code, and then click Create project from the Start creating page.
2. Choose a location to deploy the project.
3. Enter a name for the project. The name must be unique for all your projects within the specified location.
4. Choose the resource group where you want to create the project.
5. Click Create.
FAQs for Placement groups 



  Can I assign my instance to more than one placement group? 

No, an instance can be assigned to only one placement group.





  What is the maximum number of instances that I can have per placement group? 

If you are using the host spread placement strategy, you can have a maximum of 12 instances per placement group. If you are using the power spread placement strategy, you can have a maximum of four instances per placement group.

If more instances are needed, you can request a quota increase through IBM [customer support](https://cloud.ibm.com/docs/get-support?topic=get-support-using-avatar).





  Can I move an instance from one placement group to another? 

No, the placement group strategy can't be modified after the placement group is created. Also, to remove an instance from a placement group, the instance must be deleted first.





  Can I use an instance that has placement group strategy within an instance group? 

Yes, you can use instances that are provisioned with a placement group strategy within an instance group. The instance template includes the placement group attribute. Any instances that are started within an instance group that has a specified placement group is placed according to the placement group strategy. Placement groups allow instances from multiple zones to allow instance groups to support instances with subnets that span multiple zones.





  Can I resize an instance that is part of a placement group? 

Yes, you can resize an instance that is part of a placement group. When an instance is resized, the instance is stopped, the profile is updated, and the instance is restarted. When the instance is restarted, the instance is placed according to the placement group strategy.





  Can I provision an instance with both a placement group strategy and a dedicate host placement at the same time? 

No, placement groups and dedicated host are mutually exclusive. An instance can be provisioned with one or the other, not both.





  Can instances that are provisioned in different zones be assigned to the same placement group? 

Yes, instances that are provisioned in different zones can be placed into the same placement group for both the host spread and power spread placement group strategies.