vania-janet/multiturn-rag-retrieval-data huggingface dataset:
* .range_link: If present, indicates that the user's input contains a date range. The start and end index values of the string that includes the date range are saved as part of the link name. Additional information is provided, including the role that each @sys-date plays in the range relationship. For example, the start date has a role type of date_from and the end date has a role type of date_to. To check a role value, you can use the syntax @sys-date.role?.type == 'date_from'. If the user input implies a range, but only one date is specified, then the range_link property is not returned, but one role type is returned. For example, if the user asks, Have you been open since yesterday. Yesterday's date is recognized as the @sys-date mention, and a role of type date_from is returned for it. A range_modifier that identifies the word in the input that triggers the identification of a range is also returned. In this example, the modifier is since.
* .relative_{timeframe}: Recognizes and captures mentions of relative date values in the user's input. Returns a number that shows the number of units between now and the specified date. The {timeframe} units can be year, month, week, weekend, or day.
* .specific_{timeframe}: Recognizes and captures mentions of specific date units in the user's input. The {timeframe} units can be year, quarter, month, day, or day_of_week.
* .year: Helper method that returns the year in the date.



The following table illustrates the information that each attribute captures from the user input.



@sys-date attributes

 Attribute Type Example 

 @sys-date string If the input is May 13, 2020, returns 2020-05-13. 
 @sys-date.alternatives array For example, if today's date is 10 March 2019, and the user enters on March 1, then the March 1st date for next year is saved as the @sys-date (2020-03-01). However, the user might have meant March 1st of 2019.
Understanding the output schema 

The Element Classification enrichment is deprecated and will no longer be available, effective 10 July 2020.

After a document is ingested by using Element Classification, the service returns JSON output in the following schema for version date 2018-10-15 or later. The output is included in the enriched_html_elements object.

{
"document": {
"title": string,
"html": string,
"hash": string
},
"model_id" : string,
"model_version" : string,
"elements": [
{
"location": {
"begin": int,
"end": int
},
"text": string,
"types":
{
"label": { "nature": string, "party": string },
"provenance_ids": string, string, ...]
...
]
}
...
],
"categories": [
{
"label": string,
"provenance_ids": string, string, ...]
}
...
],
"attributes": [
{
"type": string,
"text": string,
"location": { "begin": int, "end": int }
}
]
}
...
],
"effective_dates": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_amounts": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"interpretation": {
"value": string,
Viewing VLAN details 

To view all your VLANs and their details, take the following steps.



1.  From your browser, open the [IBM Cloud console](https://cloud.ibm.com/) and log in to your account.
2.  From the console, click the Menu icon ![menu icon](https://cloud.ibm.com/docs-content/v1/content/icons/icon_hamburger.svg) and select Classic Infrastructure.
3.  Select Network > IP Management > VLANs.
4.  Click the Fully qualified name link to view more details about that specific VLAN.





  Tagging VLANs 

You can tag all VLANs on your account with one or more alphanumeric identifiers to make it easier to search for and select specific VLANs. Use custom tags to locate VLANs on your account rather than information such as the fully qualified name, data center, or pod. Follow these steps to create or update VLAN tags.



1.  Click the Add tags button at the top of the VLAN Details page. If one or more tags are already present on the VLAN, click the pencil icon to update them.
2.  In the Update tags window that appears, enter one or more tags to be created or remove existing tags by clicking the x on the tag.
3.  Click Save to update the tags.







  Other actions available 



*  Click the Edit button in the Details section to [edit the VLAN name](https://cloud.ibm.com/docs/vlans?topic=vlans-edit-vlan-name).
*  View any subnets and devices associated with the VLAN. You can manage them by navigating to their respective details pages.
*  View and [configure VLAN trunks](https://cloud.ibm.com/docs/vlans?topic=vlans-configuring-vlan-trunks).
"digest": "sha256:865b0c35e6da393b8e80b7e3799f777572399a4cff047eb02a81fa6e7a48ed4b",
"platform": {
"architecture": "amd64",
"os": "linux"
}
},
{
"mediaType": "application/vnd.docker.distribution.manifest.v2+json",
"size": 538,
"digest": "sha256:1d71e323557502cc78ee6c237331a09b0c33ba59c14e5f683da3b1c6218779cc",
"platform": {
"architecture": "ppc64le",
"os": "linux"
}
}
]
}

For this output to be valid, the images, with the [digests](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_overviewoverview_elements_digest) from the previous output, must exist in the same repository as the manifest list or OCI index that you are trying to tag. To confirm whether one of the images is missing, you can run the following command. Replace <src_repo> with the name of your namespace and repository in the format mynamespace/myrepo.

ibmcloud cr digests --restrict <src_repo>

For example, if you run the following command:

ibmcloud cr digests --restrict mynamespace/myrepo

You get the following response:

Listing images...

Repository Digest Tags Type Created Size Security status
The UUID portion of the URL is the name of the namespace. 
 Service instance ibm_service_instance The service instance segment identifies the instance that the metric is associated with. 
 HTTP status code ibm_codeengine_status HTTP status code. 
 Application name ibm_codeengine_application_name Name of the application. 
 Application revision name ibm_codeengine_revision_name Name of the application revision. 
 Gateway instance ibm_codeengine_gateway_instance The gateway instance. 
 Jobrun condition ibm_codeengine_jobrun_condition The condition of the job run. 
 Project name ibm_codeengine_project_name Name of the project.
In Container Registry, any reference to "digest" means "image digest".





 Dockerfile 

A Dockerfile is a text file that contains instructions to build a Docker image.

Typically, a container image is built upon a base image that contains a base operating system, such as Ubuntu. You can incrementally change the base image with your Dockerfile instructions to define the environment that the app needs to run. Every change to the base image describes a new layer of the image, and you can make multiple changes in a single Dockerfile line. The instructions in a Dockerfile also might reference build artifacts that are stored separately, such as an app, the configuration of the app, and its dependencies. For more information about Dockerfile, see [Dockerfile reference](https://docs.docker.com/engine/reference/builder/).





 Docker V2 container images 

A container image that is compliant with the [Docker: Image Manifest V2, schema 2](https://docs.docker.com/registry/spec/manifest-v2-2/) specification.

The media type for Docker Image Manifest V2, schema 2 is application/vnd.docker.distribution.manifest.v2+json and the media type for the manifest list is application/vnd.docker.distribution.manifest.list.v2+json. A Docker V2 container image is a type of OCI container image. For more information about support for Docker, see [Docker](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_overviewdocker).





 Domain name 

The name of a host system. A domain name consists of a sequence of subnames that are separated by a delimiter character, for example, www.ibm.com.

The domain names that Container Registry uses are in the format us.icr.io. Earlier domain names that Container Registry used are in the format registry.ng.bluemix.net. Both formats of domain name refer to the same registry and content. The Container Registry service responds to earlier and canonical domain names equally.
Config Object Displays configuration metadata for the image. For more information, see [Config field details](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_cli_listregistry_cli_list_imageinspect_config). 
 Container String Displays the ID of the container that created the image. 
 ContainerConfig Object Displays the default configuration for containers that are started from this image. For more information, see [Config field details](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_cli_listregistry_cli_list_imageinspect_config). 
 Created String Displays the UNIX timestamp when the image was created. 
 DockerVersion String Displays the Docker version that was used to build this image. 
 ID String Displays the unique identifier for an image. 
 Os String Displays the operating system family that was used to build this image, and that is required to run the image. 
 OsVersion String Displays the version of the operating system that was used to build this image. 
 Parent String Displays the ID of the parent image that was used to build this image. 
 RootFS Object Displays metadata that describes the root file system for the image. For more information, see [RootFS field details](https://cloud.ibm.com/docs/Registry?topic=Registry-registry_cli_listregistry_cli_list_imageinspect_rootfs). 
 Size Integer (64 bit) Displays the size of the image in bytes. 
 VirtualSize Integer (64 bit) Displays the sum of the size of each layer in the image in bytes. 





 Config field details 



Table 4. Available fields and data types in Config

 Field Type Description 

 ArgsEscaped Boolean Displays true if the command is already escaped (Windows® specific). 
 AttachStderr Boolean Displays true if the standard error stream is attached to the container and false if not. 
 AttachStdin Boolean Displays true if the standard input stream is attached to the container and false if not.
"href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/5400b7d6ac9f0a183f70abbe8b8d54c6",
"id": "5400b7d6ac9f0a183f70abbe8b8d54c6",
"name": "Default"
},
"resource_type": "share",
"size": 200,
"targets": [],
"user_tags": [
"description:user-tags-test",
"tag1:value1",
"tag2:value2",
"tag3:value with spaces"
],
"zone": {
"href": "https://us-south-stage01.iaasdev.cloud.ibm.com/v1/regions/us-south/zones/us-south-1",
"name": "us-south-1"
}
}
Show more





 Next steps 

Learn more about [data encryption](https://cloud.ibm.com/docs/vpc?topic=vpc-vpc-encryption-about) for VPC resources.
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"termination_dates": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_types": [
{
"confidence_level": string,
"text": string,
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_terms": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"interpretation": {
"value": string,
"numeric_value": number,
"unit": string,
},
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"payment_terms": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"interpretation": {
"value": string,
"numeric_value": number,
"unit": string,
},
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_currencies": [
{
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_amounts": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"interpretation": {
"value": string,
"numeric_value": number,
"unit": string,
},
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"termination_dates": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_types": [
{
"confidence_level": string,
"text": string,
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"contract_terms": [
{
"confidence_level": string,
"text": string,
"text_normalized": string,
"interpretation": {
"value": string,
"numeric_value": number,
"unit": string,
},
"provenance_ids": string, string, ... ],
"location": { "begin": int, "end": int }
},
...
],
"payment_terms": [
{
::slsa-provenance-statement::{"subject":[{"name": "icr.io/johndoe/hello-containers-slsa-demo:1-master-287919f9-20220915220023", "digest": {"sha256": "6038ec21bd927a6bb578f58eed3b43d389d27671f1c7bb44ac2c4d7260c3176d"}}]}
::slsa-provenance-statement::{"materials":[{"uri":"https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.0.tgz","digest":{"sha512":"qRmjj8nj9qmLTQXXmaR1cck3UXSRMPrbsLJAasZpF+t3riI71BXed5ebIOYwQntykeZuhjsdweEc9BxH5Jc26w=="}}]}
::slsa-provenance-statement::{"materials":[{"uri":"https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.18.6.tgz","digest":{"sha512":"TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q=="}}]}

The slsa-provenance-statement workflow command is defined as ::slsa-provenance-statement:: followed by a JSON format that defines a subject and materials. Subject is mandatory and no SLSA document is created without a subject. Materials is optional and corresponds to external resources that are used to produce the artifacts.
Review the following table to find available Go template options and data types for the [ibmcloud cr image-digests](https://cloud.ibm.com/docs/Registry?topic=Registry-containerregclibx_cr_image_digests) command.



Table 1. Available fields and data types in the Container Registry command to list image digests

 Field Type Description 

 Created Integer (64 bit) Displays when the image was created, expressed in number of seconds in UNIX time. 
 Digest String Displays the unique identifier for an image. 
 ManifestType String Displays the image manifest type. 
 Repository String Displays the repository of the image. 
 SecurityStatus Object Displays the vulnerability status for the image. You can filter and format the following values:<br><br><br><br> * Statusstring<br> * IssueCountint<br> * ExemptionCountint<br><br><br><br>The possible statuses are described in [Reviewing a vulnerability report by using the CLI](https://cloud.ibm.com/docs/Registry?topic=Registry-va_index&interface=cliva_registry_cli). 
 Size Integer (64 bit) Displays the size of the image in bytes. 
 Tags Array of strings Displays the tags for the image. 







 Go template options for ibmcloud cr image-list 

Review the following table to find available Go template options and data types for the [ibmcloud cr image-list](https://cloud.ibm.com/docs/Registry?topic=Registry-containerregclibx_cr_image_list) command.



Table 2. Available fields and data types in the Container Registry command to list images

 Field Type Description 

 Created Integer (64 bit) Displays when the image was created, expressed in number of seconds in UNIX time. 
 Digest String Displays the unique identifier for an image. 
 ManifestType String Displays the image manifest type. 
 Namespace String Displays the namespace where the image is stored. 
 Repository String Displays the repository of the image. 
 SecurityStatus Object Displays the vulnerability status for the image.
) 
 Kato Kantoushi Interjection 
 Kedo Keiyodoushi Adjective verb 
 Keyo Keiyoshi Adjective (For example, 美し for "beautiful" or 明る for "bright.") 
 Kigo Kigou Symbol 
 Koyu Koyuumeishi Proper noun 
 Mesi Meishi Noun 
 Reta Rentaishi Determiner 
 Stbi Setsubiji Suffix 
 Stto Settoji Prefix 
 Stzo Setsuzokushi Conjunction 
 Suji Suuji Numeral
@sys-time.part_of_day string If the input is this morning, returns two @sys-time values, 6:00:00 and 12:00:00. Also returns a range_link object with time-from and time-to role types. 
 @sys-time.range_link string For the input Are you open from 9AM to 11AM, two @sys-time entities are detected. Each @sys-time entity that is detected has a range_link object in its output. If a range is implied but only one time value is provided, then only one @sys-time value is returned. For the input Are you open until 9PM, 9PM is recognized as the @sys-time mention, and a role of type time_to is returned for it. The range_modifier in this example is until. 
 @sys-time.relative_{timeframe} number For 5 hours ago, returns relative_hour = -5. For in two minutes, returns relative_minute = 2. For in a second, returns relative_second = 1. 
 @sys-time.second number If the input mentions the time 5:30:10 PM, returns 10. If no second value is specified, then this helper returns 0. 
 @sys-time.specific_{timeframe} string For at 5 o'clock, returns specific_hour = 5. For at 2:30, returns specific_minute = 30. For 23:30:22, returns specific_second = 22. 









 Date and time mentions 

Some user input contains information that includes both date and time information. Your assistant captures both values and saves them as two separate entity mentions, one @sys-date and one @sys-time.

The relationship between the date and time values is established in two ways:



* Each entity that participates in the relationship contains the same datetime_link attribute.
* The literal string that spans the complete date and time mention, when they are mentioned together in input, is the same for both entities. The location information is appended to the datetime_link name.





 Recognized formats 



* now
* two hours from now
* on Monday at 4pm
You can identify images by using either the digest <dns>/<namespace>/<repo>@<digest> or by tag <dns>/<namespace>/<repo>:<tag>. Where <dns> is the domain name, <namespace> is the namespace, <repo> is the repository, <digest> is the digest, and <tag> is the tag.

To find the names of your images, run one of the following commands:



* To identify your image by digest, run the ibmcloud cr image-digests command. Combine the content of the Repository column (repository) and the Digest column (digest) separated by an at (@) symbol to create the image name in the format repository@digest.
* To identify your image by tag, run the ibmcloud cr image-list command. Combine the content of the Repository column (repository) and Tag column (tag) separated by a colon (:) to create the image name in the format repository:tag.



--quiet, -q
: (Optional) Reduces the output to display essential elements only.





 Example 

To view the contents of the manifest for the image us.icr.io/birds/bluebird:1, run the following command.

ibmcloud cr manifest-inspect us.icr.io/birds/bluebird:1







 ibmcloud cr namespace-add 

Choose a name for your

namespaceand add it to your IBM Cloud account.

You can create a namespace in a

resource groupof your choice by using one of the following options.



* Before you create the namespace, run the [ibmcloud target -g <resource_group>](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cliibmcloud_target) command, where <resource_group> is the resource group.
* Specify the required resource group by using the -g option on the ibmcloud cr namespace-add command.
@sys-time.part_of_day string If the input is this morning, returns two @sys-time values, 6:00:00 and 12:00:00. Also returns a range_link object with time-from and time-to role types. 
 @sys-time.range_link string For the input Are you open from 9AM to 11AM, two @sys-time entities are detected. Each @sys-time entity that is detected has a range_link property in its output. If a range is implied but only one time value is provided, then only one @sys-time value is returned. For the input Are you open until 9PM, 9PM is recognized as the @sys-time mention, and a role of type time_to is returned for it. The range_modifier in this example is until. 
 @sys-time.relative_{timeframe} number For 5 hours ago, returns relative_hour = -5. For in two minutes, returns relative_minute = 2. For in a second, returns relative_second = 1. 
 @sys-time.second number If the input mentions the time 5:30:10 PM, returns 10. If no second value is specified, then this helper returns 0. 
 @sys-time.specific_{timeframe} string For at 5 o'clock, returns specific_hour = 5. For at 2:30, returns specific_minute = 30. For 23:30:22, returns specific_second = 22. 









 Date and time mentions 

Some user input contains information that includes both date and time information. Your assistant captures both values and saves them as two separate entity mentions, one @sys-date and one @sys-time.

The relationship between the date and time values is established in two ways:



* Each entity that participates in the relationship contains the same datetime_link attribute.
* The literal string that spans the complete date and time mention, when they are mentioned together in input, is the same for both entities. The location information is appended to the datetime_link name.





 Recognized formats 



* now
* two hours from now
* on Monday at 4pm
Additional information is provided, including the role that each @sys-date plays in the range relationship. For example, the start date has a role type of date_from and the end date has a role type of date_to. To check a role value, you can use the syntax @sys-date.role?.type == 'date_from'. If the user input implies a range, but only one date is specified, then the range_link object is not returned, but one role type is returned. For example, if the user asks, Have you been open since yesterday. Yesterday's date is recognized as the @sys-date mention, and a role of type date_from is returned for it. A range_modifier that identifies the word in the input that triggers the identification of a range is also returned. In this example, the modifier is since.
* .relative_{timeframe}: Recognizes and captures mentions of relative date values in the user's input. Returns a number that shows the number of units between now and the specified date. The {timeframe} units can be year, month, week, weekend, or day.
* .specific_{timeframe}: Recognizes and captures mentions of specific date units in the user's input. The {timeframe} units can be year, quarter, month, day, or day_of_week.
* .year: Helper method that returns the year in the date.



The following table illustrates the information that each attribute captures from the user input.



@sys-date attributes

 Attribute Type Example 

 @sys-date string If the input is May 13, 2020, returns 2020-05-13. 
 @sys-date.alternatives array For example, if today's date is 10 March 2019, and the user enters on March 1, then the March 1st date for next year is saved as the @sys-date (2020-03-01). However, the user might have meant March 1st of 2019. The system also saves this year's date (2019-03-01) as an alternative date value.