vania-janet/multiturn-rag-retrieval-data huggingface dataset:
As part of this demonstration, we run the sender program (amqsputc) using the alice's userid to send a message to protected queue. We then run receiver program (amqsgetc) using the bob's userid to receive the message from an alias queue.



1. Create the following environment variables in alice's command shell.

On Mac:
export MQSAMP_USER_ID=alice
export MQSERVER="CLOUD.ADMIN.SVRCONN/TCP/<HOSTNAME>(<PORT>)"
export MQS_KEYSTORE_CONF="/alice/.mqs/keystore.conf"

On Linux:
export MQSAMP_USER_ID=alice
export MQSERVER="CLOUD.ADMIN.SVRCONN/TCP/<HOSTNAME>(<PORT>)"
export MQS_KEYSTORE_CONF="/home/alice/.mqs/keystore.conf"

On Windows:
set MQSAMP_USER_ID=alice
set MQSERVER=CLOUD.ADMIN.SVRCONN/TCP/<HOSTNAME>(<PORT>)
set MQS_KEYSTORE_CONF=C:Usersalice.mqskeystore.conf



* <HOSTNAME> - this is 'hostname' in the file connection_info.txt
* <PORT> - this is 'listenerPort' in the file connection_info.txt



2. Create the following environment variables in bob's command shell.

On Mac:
export MQSAMP_USER_ID=bob
export MQSERVER="CLOUD.ADMIN.SVRCONN/TCP/<HOSTNAME>(<PORT>)"
export MQS_KEYSTORE_CONF=/bob/.mqs/keystore.conf

On Linux:
export MQSAMP_USER_ID=bob
export MQSERVER="CLOUD.ADMIN.SVRCONN/TCP/<HOSTNAME>(<PORT>)"
Metric Name ibm_mq_qmgr_non_durable_subscription_delete_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 Expired message count 

Total number of expired messages for a queue manager



Table 8: Expired message count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_expired_message_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 Failed MQCB count 

Total number of failed MQCB for a queue manager



Table 9: Failed MQCB count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_failed_mqcb_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 Failed MQCLOSE count 

Total number of failed MQCLOSE for a queue manager



Table 10: Failed MQCLOSE count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_failed_mqclose_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 Failed MQCONN/MQCONNX count 

Total number of failed MQCONN/MQCONNX for a queue manager



Table 11: Failed MQCONN/MQCONNX count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_failed_mqconn_mqconnx_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 Failed MQGET count 

Total number of failed MQGET for a queue manager



Table 12: Failed MQGET count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_failed_mqget_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 Failed MQINQ count 

Total number of failed MQINQ for a queue manager



Table 13: Failed MQINQ count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_failed_mqinq_total
[Failed MQPUT count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_mqput_total) 
 [Failed MQPUT1 count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_mqput1_total) 
 [Failed MQSET count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_mqset_total) 
 [Failed MQSUBRQ count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_mqsubrq_total) 
 [Failed browse count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_browse_total) 
 [Failed create/alter/resume subscription count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_subscription_create_alter_resume_total) 
 [Failed topic MQPUT/MQPUT1 count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_failed_topic_mqput_mqput1_total) 
 [Got non-persistent messages - byte count](https://cloud.ibm.com/docs/mqcloud?topic=mqcloud-monitor_sysdigibm_mq_qmgr_non_persistent_message_destructive_get_total)
The circuits can be parameterized. This parameter is now specified in the run() method of the Estimator class.
* Required: False



* observables - DEPRECATED:



* Description: A list of SparsePauliOp. This parameter is now specified in the run() method of the Estimator class.
* Required: False



* parameters - DEPRECATED



* Description: A list of parameters for the quantum circuits. This is (ParameterView or a list of Parameter objects), specifying the order in which parameter values will be bound to the quantum circuits. The circuits can be parameterized. This parameter is now specified in the run() method of the Estimator class.
* Required: False



* skip_transpilation - DEPRECATED:



* Description: Skip circuit transpilation. The default value is False. The circuits can be parameterized. This parameter is now specified in the Optionstranspilation setting: options = Options(transpilation={"skip_transpilation": True}).
* Required: False.



* service - DEPRECATED:



* Description: Optional instance of qiskit_ibm_runtime.QiskitRuntimeServiceclass. The default value is QiskitRuntimeService(), which tries to initialize your default saved account. This parameter can now be specified when you initialize a Session instance.
* Required: False.



* options



* Type: dictionary or Options class
* Description: Runtime settings that control the execution environment.
* Required: False



* backend: Optional instance of qiskit_ibm_runtime.IBMBackend class or string name of backend. If not specified, the least busy backend is used. This parameter can now be specified when you initialize a Session instance.



* image: The runtime image used to run the program, specified in the form image_name:tag. Not all accounts are authorized to select a different image.
* log_level - DEPRECATED: Logging level to set in the execution environment.
Environment variables for Kafka events that are delivered to jobs 

All events that are delivered to a job are received as environment variables. These environment variables include a prefix of CE_ and are based on the [CloudEvents spec](https://cloudevents.io).

Each event contains some common environment variables that appear every time that the event is delivered to a job. The actual set of variables in each event can include more options. For more information, see the [CloudEvent attributes](https://github.com/cloudevents/spec/blob/v1.0.1/spec.mdcontext-attributes).

The following table describes the environment variables that are specific to Kafka events.



Table 2. Environment variables for events

 Variable Description 

 CE_DATA The data (body) for the event. 
 CE_DOMAIN The domain name portion of the URL of the application (and project). 
 CE_ID A unique identifier for the event, unless an event is replayed, in which case, it is assigned the same ID. 
 CE_SOURCE A URI-reference that indicates where this event originated from within the event producer. For Kafka events, this header is in the following format: /apis/v1/namespaces/[PROJECT_SUBDOMAIN]/kafkasources/kafkasub[TOPIC_NAME]. 
 CE_SPECVERSION The version of the CloudEvents spec. This value is always 1.0. 
 CE_SUBDOMAIN The subdomain portion of the URL associated with the application (and project). If you are familiar with Kubernetes, CE_SUBDOMAIN maps to the Kubernetes namespace associated with your project. 
 CE_SUBJECT The Kafka partition number and offset. For example, partition:01 refers to partition 0 and offset 1. 
 CE_TIME The time that the event was generated. 
 CE_TYPE The type of the event. For Kafka events, this is dev.knative.kafka.event. 



Example output

CE_DATA={"message":"This is a test message ","message_number":1}
The messaging REST API documentation can be found [here](https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.dev.doc/q130960_.htm).



 Non 'DEV.' queues 

If a new queue has been created whose name does not start with 'DEV.' the predefined authorization records will not apply. Therefore applications will not have the required permissions to send or receive messages to this queue. Review the [Assigning user/group access to a queue](https://cloud.ibm.com/docs/services/mqcloud?topic=mqcloud-mqoc_configure_auth_record) guide for more information and for the steps required to configure the authorization record required for this queue.





 Example: Putting a message on a queue in an IBM queue manager 

If you have authenticated using token-based authentication, point to the place you stored your cookie to identify yourself as an authenticated user.

curl -X POST https://web-qm1-abcd.qm.eu-gb.mqcloud.ibm.com/ibmmq/rest/v3/messaging/qmgr/qm1/queue/TEST.QUEUE/message -H "Content-Type: text/plain" -H "ibm-mq-rest-csrf-token: value" --data "hello world" -b cookiejar.txt

Please note that by default any messages sent via the messaging REST API will be treated as non-persistent, regardless of the target queue's configured default persistence setting. To change the default behaviour, you can include an optional header ibm-mq-md-persistence which must be specified as one of the following values: - persistent - nonPersistent

To send a persistent message, the example above would then take the following form:
Apache Kafka concepts 

Apache Kafka is a distributed streaming platform used by many companies for numerous batch workloads, as well as real-time data integration, and data streaming use cases.

Zoom

![Kafka architecture diagram.](https://cloud.ibm.com/docs-content/v1/content/e0c3acba1296ff980e76d5db456d53adefaabba4/EventStreams/kafka_overview.png)

Figure 1. The diagram shows a Kafka architecture.

The following list defines some Apache Kafka concepts:



 Brokers 

Apache Kafka is a distributed messaging system. A Kafka cluster consists of a set of brokers. A cluster has a minimum of three brokers.

Zoom

![Brokers diagram.](https://cloud.ibm.com/docs-content/v1/content/e0c3acba1296ff980e76d5db456d53adefaabba4/EventStreams/concepts_brokers.png)

Figure 2. Diagram that shows an example broker.





 Messages 

A message is a unit of data in Kafka. Each message is represented as a record, which comprises two parts: key and value. The key is commonly used for data about the message and the value is the body of the message. Kafka uses the terms record and message interchangeably.





 Topics and partitions 

Each topic is a named stream of messages. A topic is made up of one or more partitions. The messages on a partition are ordered by a number that is called the offset. With multiple partitions distributed across the brokers, the scalability of a topic is increased.

If a topic has more than one partition, it allows data to be fed through in parallel to increase throughput by distributing the partitions across the cluster. The number of partitions also influences the balancing of workload among consumers.
Segment By Service instance, The queue manager name 







 MQCTL count 

Total MQCTL count for a queue manager



Table 32: MQCTL count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqctl_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 MQDISC count 

Total MQDISC count for a queue manager



Table 33: MQDISC count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqdisc_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 MQINQ count 

Total MQINQ count for a queue manager



Table 34: MQINQ count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqinq_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 MQOPEN count 

Total MQOPEN count for a queue manager



Table 35: MQOPEN count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqopen_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 MQSET count 

Total MQSET count for a queue manager



Table 36: MQSET count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqset_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 MQSTAT count 

Total MQSTAT count for a queue manager



Table 37: MQSTAT count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqstat_total 
 Metric Type counter 
 Value Type none 
 Segment By Service instance, The queue manager name 







 MQSUBRQ count 

Total MQSUBRQ count for a queue manager



Table 38: MQSUBRQ count metric metadata

 Metadata Description 

 Metric Name ibm_mq_qmgr_mqsubrq_total
v1 [cURL](https://cloud.ibm.com/apidocs/assistant/assistant-v1createworkspace)[node](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=nodecreateworkspace)[java](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=javacreateworkspace)[python](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=pythoncreateworkspace) 
 Get information about a workspace Get information about a workspace, optionally including all workspace content. v1 [cURL](https://cloud.ibm.com/apidocs/assistant/assistant-v1getworkspace)[node](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=nodegetworkspace)[java](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=javagetworkspace)[python](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=pythongetworkspace) 
 Update workspace Update an existing workspace with new or modified data. You must provide component objects defining the content of the updated workspace. v1 [cURL](https://cloud.ibm.com/apidocs/assistant/assistant-v1updateworkspace)[node](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=nodeupdateworkspace)[java](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=javaupdateworkspace)[python](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=pythonupdateworkspace) 
 Delete workspace Delete a workspace from the service instance.
[Introducing PKCS #11](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-uko-pkcs11-intro).





 Accessing the cloud HSM with the GREP11 API 

In addition to the PKCS #11 API, you can also use the Enterprise PKCS #11 over gRPC (GREP11) API to access the Hyper Protect Crypto Services cloud HSM.

[Enterprise PKCS #11 (EP11)](https://www.ibm.com/security/cryptocards/pciecc3/ep11) is an IBM-supported cryptographic API that is enabled in the Hyper Protect Crypto Services cloud HSM. EP11 is designed for users that are seeking support for open standards and enhanced security. The [EP11 library](https://www.ibm.com/security/cryptocards/pciecc4/library) offers a wide variety of general-purpose cryptographic functions and provides an interface that is similar to the PKCS #11 API. Existing applications that use PKCS #11 can benefit from enhanced security because the applications can be migrated easily to meet the EP11 requirements.

Hyper Protect Crypto Services leverages [gRPC](https://grpc.io/) to enable remote application access to the cloud HSM. gRPC is a modern open source high-performance remote procedure call (RPC) framework that can connect services in and across data centers for load balancing, tracing, health checking, and authentication. With gRPC, applications can remotely access the Hyper Protect Crypto Services cloud HSM to call EP11 cryptographic functions. For more information about GREP11 API, see [Introducing EP11 over gRPC](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-uko-grep11-intro).

With the PKCS #11 and GREP11 APIs, you can perform remote cryptographic procedure calls, and, by default, impose message size limits. The maximum receiving message size is 64 MB and the outgoing message size has no limit.





 Comparing the PKCS 11 API with the GREP11 API
2160_sc_30_nwd_1_tl_The_20synchronous_20HTTP_20interface_20_7C_20IBM_20Cloud_20Docs_p_https_3A_2F_2Fcloud.ibm.com_2Fdocs_2Fspeech-to-text_3Ftopic_3Dspeech-to-text-http_r_lt_951_evt_pageLoad_sv_1_rn_994248](https://bat.bing.com/action/0?ti=146001191&Ver=2&mid=72b37ccf-47a9-473e-ba6b-b554aa8c2367&sid=cca51480229211eeac887b94c5a6c542&vid=cca50460229211ee874f7dc32b9b9a8d&vids=0&msclkid=N&pi=918639831&lg=en-US&sw=3840&sh=2160&sc=30&nwd=1&tl=The%20synchronous%20HTTP%20interface%20%7C%20IBM%20Cloud%20Docs&p=https%3A%2F%2Fcloud.ibm.com%2Fdocs%2Fspeech-to-text%3Ftopic%3Dspeech-to-text-http&r=&lt=951&evt=pageLoad&sv=1&rn=994248)
v2 [cURL](https://cloud.ibm.com/apidocs/assistant/assistant-v2message-stateless)[node](https://cloud.ibm.com/apidocs/assistant/assistant-v2?code=nodemessage-stateless)[java](https://cloud.ibm.com/apidocs/assistant/assistant-v2?code=javamessage-stateless)[python](https://cloud.ibm.com/apidocs/assistant/assistant-v2?code=pythonmessage-stateless) 







 Authoring methods 



 Method Description API ver Reference 

 List workspaces List the workspaces associated with a Watson Assistant service instance. v1 [cURL](https://cloud.ibm.com/apidocs/assistant/assistant-v1listworkspaces)[node](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=nodelistworkspaces)[java](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=javalistworkspaces)[python](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=pythonlistworkspaces) 
 Create workspace Create a workspace based on component objects. You must provide workspace components defining the content of the new workspace. v1 [cURL](https://cloud.ibm.com/apidocs/assistant/assistant-v1createworkspace)[node](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=nodecreateworkspace)[java](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=javacreateworkspace)[python](https://cloud.ibm.com/apidocs/assistant/assistant-v1?code=pythoncreateworkspace) 
 Get information about a workspace Get information about a workspace, optionally including all workspace content.
* [Known limitations](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-known-limitations)
* [Usage FAQs](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-faq-usage)
* [Pricing FAQs](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-faq-pricing)
* Developer community



* [StackOverflow](http://stackoverflow.com/questions/tagged/ibm-watson-cognitive+speech-to-text)



* [Accessibility](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-accessibility-platform)



* [About this product](https://www.ibm.com/cloud/watson-speech-to-text)



Expand all | Collapse all

Collapse



1. [IBM Cloud Docs](https://cloud.ibm.com/docs)
2. [Speech to Text](https://cloud.ibm.com/docs/speech-to-text)
3.



Search in collection

Search in collection





LangSwitcher dropdown

English

Close menu

DeutschEnglish

EspañolFrançaisItaliano日本語한국어Português/Brasil简体中文繁體中文





 The synchronous HTTP interface * Last updated 2023-01-23 

The synchronous HTTP interface of the IBM Watson® Speech to Text service provides a single POST /v1/recognize method for requesting speech recognition with the service. This method is the simplest means of obtaining a transcript. It offers two ways of submitting a speech recognition request:



* The first sends all of the audio in a single stream via the body of the request. You specify the parameters of the operation as request headers and query parameters.
apiconnect.product_updateSpaceScope.update Update the Product object by ID 
 apiconnect.product_delSpaceScope.delete Delete the Product object by ID 
 apiconnect.product_updateByNameVersionSpaceScope.update Update the Product object by name and version 
 apiconnect.product_delByNameVersionSpaceScope.delete Delete a Product 
 apiconnect.product_replaceSpaceScope.create Hot replace a product 
 apiconnect.product_supersedeSpaceScope.create Supersede a product 
 apiconnect.product_migrateSubscriptionsSpaceScope.create Migrate list of subscriptions between products 
 apiconnect.product_replaceByNameVersionSpaceScope.create Hot replace the product 
 apiconnect.product_supersedeByNameVersionSpaceScope.create Supersede a product 
 apiconnect.product_migrateSubscriptionsByNameVersionSpaceScope.create Migrate list of subscriptions between products 
 apiconnect.api_updateSpaceScope.update Update the API object by ID 
 apiconnect.api_updateByNameVersionSpaceScope.update Update the API object by name and version 
 apiconnect.me_singletonUpdate.update Update the Me object 
 apiconnect.me_singletonDel.delete Delete the Me object 
 apiconnect.me_changePassword.create Change my password 
 apiconnect.me_resetPassword.create Reset password 
 apiconnect.me_signOut.create Sign out 
 apiconnect.webhook_updateCatalogScope.update Update the Webhook object by name or ID 







 Viewing events 

Events that are generated by an API Connect Reserved instance are automatically forwarded to the IBM Cloud Activity Tracker service instance that is available in the same location.

IBM Cloud Activity Tracker can have only one instance per location. To view events, you must access the web UI of the IBM Cloud Activity Tracker service in the same location where your service instance is available.
* For information about all service updates, see the [Release notes for Speech to Text for IBM Cloud](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-release-notes).
* For information about the latest service update, see the [2 May 2023](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-release-notesspeech-to-text-2may2023) service update in the release notes.



IBM Cloud Pak for Data

for installed or on-premises instances of Speech to Text for IBM Cloud Pak for Data. For links to information about installing and managing Speech to Text for IBM Cloud Pak for Data, see [Installing IBM Watson Speech to Text for IBM Cloud Pak for Data](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-speech-install-data).



* For information about all service updates, see the [Release notes for Speech to Text for IBM Cloud Pak for Data](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-release-notes-data).
* For information about the latest service update, see the [2 May 2023 (Version 4.6.5)](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-release-notes-dataspeech-to-text-data-2may2023) service update in the release notes.









 Speech recognition 

The Speech to Text service offers three interfaces for speech recognition: a WebSocket interface, a synchronous HTTP interface, and an asynchronous HTTP interface. The interfaces let you specify the language of your audio and its format and sampling rate. They also provide many parameters that you can use to tailor how you request audio and the information that the service sends in response. You can also request metrics about the service's analysis of your audio and the audio itself.