{
"cells": [
{
"cell_type": "markdown",
"id": "0998165a-381f-4561-a79a-bf584aed9687",
"metadata": {},
"source": [
"---\n",
"title: \"REST API を使用した見積もりツール\"\n",
"description: \"REST API で Estimator プリミティブを使用する方法。\"\n",
"---\n",
"\n",
"{/* cspell:ignore IIZII, XIZZZ, accum */}\n",
"\n",
"\n",
"\n",
"# REST API を使用した見積もりツール\n",
"\n"
]
},
{
"cell_type": "markdown",
"id": "da948b6b-2ead-4359-aed4-b824e43ccbfb",
"metadata": {
"tags": [
"version-info"
]
},
"source": [
"{/*\n",
" DO NOT EDIT THIS CELL!!!\n",
" This cell's content is generated automatically by a script. Anything you add\n",
" here will be removed next time the notebook is run. To add new content, create\n",
" a new cell before or after this one.\n",
" */}\n",
"\n",
"\n",
" パッケージ・バージョン
\n",
"\n",
" このページのコードは、以下の要件に基づいて開発されました。\n",
" これらのバージョン以降のご利用をお勧めします。\n",
"\n",
" ```\n",
" qiskit[all]~=2.3.0\n",
" ```\n",
" \n",
"\n"
]
},
{
"cell_type": "markdown",
"id": "3d9ef591-91fd-4a49-a065-5e2cda4d41be",
"metadata": {},
"source": [
"このトピックの手順では、REST API を使用してワークロードを実行および構成する方法について説明し、任意のプログラムからそれらを呼び出す方法を示します。\n",
"\n",
"\n",
" このドキュメントでは、 Python`requests` モジュールを使用してREST APIの動作を説明しています。 ただし、このワークフローは、REST API の操作をサポートするあらゆる言語やフレームワークを使用して実行することができます。 詳細については、 [APIリファレンス](/docs/api/qiskit-ibm-runtime/tags/jobs)を参照してください。\n",
"\n",
"\n",
"\n",
"\n",
"## 1. アカウントを初期化する\n",
"\n",
"Estimatorはマネージドサービスであるため、まずアカウントを初期化する必要があります。 その後、期待値を計算するために使用するデバイスを選択できます。\n",
"\n",
"[このトピック](/docs/guides/cloud-setup-rest-api)では、アカウントの初期化方法、利用可能なバックエンドの確認方法、およびトークンの無効化方法について詳しく説明しています。\n",
"\n",
"\n",
"\n",
"## 2. QASM回路を作成する\n",
"\n",
"Estimatorプリミティブの入力として、少なくとも1つの回路が必要です。\n",
"\n",
"QASM量子回路を定義せよ。 例:\n",
"\n",
"```python\n",
"qasm_string='''\n",
"OPENQASM 3;\n",
"include \"stdgates.inc\";\n",
"qreg q[2];\n",
"creg c[2];\n",
"x q[0];\n",
"cx q[0], q[1];\n",
"c[0] = measure q[0];\n",
"c[1] = measure q[1];\n",
"'''\n",
"```\n",
"\n",
"以下のコードスニペットでは、が新しい文字列に `qasm_string` トランスパイル `resulting_qasm`されていることを前提としています。\n",
"\n",
"\n",
"\n",
"## 3. Estimatorの V2 APIを使用して量子回路を実行する\n",
"\n",
"\n",
" 以下のジョブでは、 IBM QuantumV2 プリミティブが使用されています。 と は `SamplerV2` 、いずれも1つ以上のプリミティブ統一ブロック（PUB）を入力として `EstimatorV2` 受け取る。 各 PUB は、1つの回路と、その回路にブロードキャストされるデータ（複数のオブザーバブルやパラメータを含む場合がある）を含むタプルです。 各 PUB は結果を返します。\n",
"\n",
"\n",
"```python\n",
"import requests\n",
"\n",
"url = 'https://quantum.cloud.ibm.com/api/v1/jobs'\n",
"auth_id = \"Bearer \"\n",
"crn = \"\"\n",
"backend = \"\"\n",
"\n",
"headers = {\n",
" 'Content-Type': 'application/json',\n",
" 'Authorization':auth_id,\n",
" 'Service-CRN': crn\n",
" }\n",
"\n",
"job_input = {\n",
" 'program_id': 'estimator',\n",
" \"backend\": backend,\n",
" \"params\": {\n",
" \"pubs\": [ #primitive unified blocs (PUBs) containing one circuit each.\n",
" [resulting_qasm, # QASM circuit\n",
" {\"IIZII\": 1, \"XIZZZ\": 2.3}, # Observable\n",
" None # parameter values\n",
" ]]\n",
"}}\n",
"\n",
"response = requests.post(url, headers=headers, json=job_input)\n",
"\n",
"if response.status_code == 200:\n",
" job_id = response.json().get('id')\n",
" print(\"Job created:\",response.text)\n",
"else:\n",
" print(f\"Error: {response.status_code}\")\n",
"```\n",
"\n",
"\n",
"\n",
"## 4. ジョブのステータスを確認し、結果を取得する\n",
"\n",
"次に、APIに `job_id` を渡します：\n",
"\n",
"```python\n",
"response_status_singlejob= requests.get(url+'/'+job_id, headers=headers)\n",
"response_status_singlejob.json().get('state')\n",
"```\n",
"\n",
"出力\n",
"\n",
"```text\n",
">>> Job ID: 58223448-5100-4dec-a47a-942fb30edcad\n",
">>> Job Status: JobStatus.RUNNING\n",
"```\n",
"\n",
"求人検索結果を表示：\n",
"\n",
"```python\n",
"response_result= requests.get(url+'/'+job_id+'/results', headers=headers)\n",
"\n",
"res_dict=response_result.json()\n",
"\n",
"estimator_result=res_dict['results']\n",
"print(estimator_result)\n",
"```\n",
"\n",
"出力\n",
"\n",
"```text\n",
"[{'data': {'evs': 0.7428980350102542, 'stds': 0.029884014518789213, 'ensemble_standard_error': 0.03261147170624149}, 'metadata': {'shots': 10016, 'target_precision': 0.01, 'circuit_metadata': {}, 'resilience': {}, 'num_randomizations': 32}}]\n",
"```\n",
"\n",
"\n",
"\n",
"## 5. オプションの操作\n",
"\n",
"エラー軽減技術により、ユーザーは実行時のデバイスノイズをモデル化することで、回路エラーを軽減することができます。 これにより、通常、モデルの学習に関連する量子側の前処理オーバーヘッドと、生成されたモデルを用いて生データの誤差を補正するための古典側の後処理オーバーヘッドが発生することになる。\n",
"\n",
"プリミティブに組み込まれたエラー軽減技術は、高度な耐障害性オプションです。 これらのオプションを指定するには、ジョブを送信する際に オプション `resilience_level` を使用してください。\n",
"\n",
"以下の例は、動的デカップリング、トゥワリング、およびTREX + ZNEのデフォルト設定を示しています。 その他のオプションや詳細については、「 [エラーの軽減および抑制手法](/docs/guides/error-mitigation-and-suppression-techniques) 」のトピックをご覧ください。\n",
"\n",
"\n",
"\n",
"### TREX + ZNE\n",
"\n",
"```python\n",
"import requests\n",
"\n",
"url = 'https://quantum.cloud.ibm.com/api/v1/jobs'\n",
"auth_id = \"Bearer \"\n",
"crn = \"\"\n",
"backend = \"BACKEND_NAME\"\n",
"\n",
"headers = {\n",
" 'Content-Type': 'application/json',\n",
" 'Authorization':auth_id,\n",
" 'Service-CRN': crn\n",
" }\n",
"job_input = {\n",
" 'program_id': 'estimator',\n",
" \"backend\": backend,\n",
" \"params\": {\n",
" \"pubs\": [ #primitive unified blocs (PUBs) containing one circuit each\n",
" [resulting_qasm, # QASM circuit\n",
" {\"IIZII\": 1, \"XIZZZ\": 2.3}, # Observable\n",
" None # parameter values\n",
" ]]\n",
" \"options\": {\n",
" \"resilience\": {\n",
" \"measure_mitigation\": True,\n",
" \"zne_mitigation\": True,\n",
" \"zne\": {\n",
" \"extrapolator\":[\"exponential\", \"linear\"],\n",
" \"noise_factors\":[1, 3, 5],\n",
" },\n",
" },\n",
" },\n",
" }\n",
"}\n",
"\n",
"response = requests.post(url, headers=headers, json=job_input)\n",
"\n",
"if response.status_code == 200:\n",
" job_id = response.json().get('id')\n",
" print(\"Job created:\",response.text)\n",
"else:\n",
" print(f\"Error: {response.status_code}\")\n",
"```\n",
"\n",
"\n",
"\n",
"### 動的デカップリング\n",
"\n",
"```python\n",
"import requests\n",
"\n",
"url = 'https://quantum.cloud.ibm.com/api/v1/jobs'\n",
"auth_id = \"Bearer \"\n",
"crn = \"\"\n",
"backend = \"BACKEND_NAME\"\n",
"\n",
"headers = {\n",
" 'Content-Type': 'application/json',\n",
" 'Authorization':auth_id,\n",
" 'Service-CRN': crn\n",
" }\n",
"job_input = {\n",
" 'program_id': 'estimator',\n",
" \"backend\": backend,\n",
" \"params\": {\n",
" \"pubs\": [ #primitive unified blocs (PUBs) containing one circuit each\n",
" [resulting_qasm, # QASM circuit\n",
" {\"IIZII\": 1, \"XIZZZ\": 2.3}, # Observable\n",
" None # parameter values\n",
" ]]\n",
" \"options\": {\n",
" \"dynamical_decoupling\": {\n",
" \"enable\": True,\n",
" \"sequence_type\": 'XpXm',\n",
" \"extra_slack_distribution\": 'middle',\n",
" \"scheduling_method\": 'alap',\n",
" },\n",
" },\n",
" }\n",
"}\n",
"\n",
"response = requests.post(url, headers=headers, json=job_input)\n",
"\n",
"if response.status_code == 200:\n",
" job_id = response.json().get('id')\n",
" print(\"Job created:\",response.text)\n",
"else:\n",
" print(f\"Error: {response.status_code}\")\n",
"```\n",
"\n",
"\n",
"\n",
"### くるくる回る\n",
"\n",
"```python\n",
"import requests\n",
"\n",
"url = 'https://quantum.cloud.ibm.com/api/v1/jobs'\n",
"auth_id = \"Bearer \"\n",
"crn = \"\"\n",
"backend = \"BACKEND_NAME\"\n",
"\n",
"headers = {\n",
" 'Content-Type': 'application/json',\n",
" 'Authorization':auth_id,\n",
" 'Service-CRN': crn\n",
" }\n",
"job_input = {\n",
" 'program_id': 'estimator',\n",
" \"backend\": backend,\n",
" \"params\": {\n",
" \"pubs\": [ #primitive unified blocs (PUBs) containing one circuit each\n",
" [resulting_qasm, # QASM circuit\n",
" {\"IIZII\": 1, \"XIZZZ\": 2.3}, # Observable\n",
" None # parameter values\n",
" ]]\n",
" \"options\": {\n",
" \"twirling\": {\n",
" \"enable_gates\": True,\n",
" \"enable_measure\": True,\n",
" \"num_randomizations\": \"auto\",\n",
" \"shots_per_randomization\": \"auto\",\n",
" \"strategy\": \"active-accum\",\n",
" },\n",
" },\n",
" }\n",
"}\n",
"\n",
"response = requests.post(url, headers=headers, json=job_input)\n",
"\n",
"if response.status_code == 200:\n",
" job_id = response.json().get('id')\n",
" print(\"Job created:\",response.text)\n",
"else:\n",
" print(f\"Error: {response.status_code}\")\n",
"```\n",
"\n",
"\n",
"\n",
"## パラメータ化回路\n",
"\n",
"\n",
"\n",
"### 1. アカウントを初期化する\n",
"\n",
"まず、アカウントを初期化する必要があります。 その後、計算を実行するデバイスを選択できます。\n",
"\n",
"[このトピック](/docs/guides/cloud-setup-rest-api)では、アカウントの初期化方法、利用可能なバックエンドの確認方法、およびトークンの無効化方法について詳しく説明しています。\n",
"\n",
"\n",
"\n",
"### 2. パラメータを定義する\n",
"\n",
"```python\n",
"import requests\n",
"import qiskit_ibm_runtime\n",
"from qiskit_ibm_runtime import QiskitRuntimeService\n",
"from qiskit.transpiler import generate_preset_pass_manager\n",
"from qiskit.qasm3 import dumps\n",
"from qiskit import QuantumCircuit\n",
"from qiskit.circuit import Parameter\n",
"from qiskit import transpile\n",
"\n",
"service = QiskitRuntimeService(channel='ibm_quantum')\n",
"backend = service.backend(\"\")\n",
"\n",
"pm = generate_preset_pass_manager(backend=backend, optimization_level=1)\n",
"\n",
"theta = Parameter('theta')\n",
"phi = Parameter('phi')\n",
"parameter_values = {'theta': 1.57, 'phi': 3.14} # In case we want to pass a dictionary\n",
"```\n",
"\n",
"\n",
"\n",
"### 3. 量子回路を作成し、パラメータ化ゲートを追加する\n",
"\n",
"```python\n",
"qc = QuantumCircuit(2)\n",
"\n",
"# Add parameterized gates\n",
"qc.rx(theta, 0)\n",
"qc.ry(phi, 1)\n",
"qc.cx(0, 1)\n",
"qc.measure_all()\n",
"\n",
"# Draw the original circuit\n",
"qc.draw('mpl')\n",
"\n",
"# Get an ISA circuit\n",
"isa_circuit = pm.run(qc)\n",
"```\n",
"\n",
"\n",
"\n",
"### 4. QASM 3 コードを生成する\n",
"\n",
"```python\n",
"qasm_str = dumps(isa_circuit)\n",
"print(\"Generated QASM 3 code:\")\n",
"print(qasm_str)\n",
"```\n",
"\n",
"\n",
"\n",
"### 5. Estimatorの V2 APIを使用して量子回路を実行する\n",
"\n",
"```python\n",
"import requests\n",
"\n",
"url = 'https://quantum.cloud.ibm.com/api/v1/jobs'\n",
"auth_id = \"Bearer \"\n",
"crn = \"\"\n",
"backend = \"\"\n",
"\n",
"headers = {\n",
" 'Content-Type': 'application/json',\n",
" 'Authorization':auth_id,\n",
" 'Service-CRN': crn\n",
" }\n",
"\n",
"job_input = {\n",
" 'program_id': 'estimator',\n",
" \"backend\": backend,\n",
" \"params\": {\n",
" # Choose one option: direct parameter transfer or through a dictionary\n",
" #\"pubs\": [[qasm_str,[1,2],500]], # primitive unified blocs (PUBs) containing one circuit each.\n",
" \"pubs\": [[qasm_str,parameter_values,500]], # primitive unified blocs (PUBs) containing one circuit each.\n",
"}}\n",
"\n",
"response = requests.post(url, headers=headers, json=job_input)\n",
"\n",
"if response.status_code == 200:\n",
" job_id = response.json().get('id')\n",
" print(f\"Job created: {response.text}\")\n",
"else:\n",
" print(f\"Error: {response.status_code}\")\n",
"```\n",
"\n",
"```python\n",
"print(response.text)\n",
"```\n",
"\n",
"\n",
"\n",
"### 6. ジョブのステータスを確認し、結果を取得する\n",
"\n",
"次に、APIに `job_id` を渡します：\n",
"\n",
"```python\n",
"response_status_singlejob = requests.get(f\"{url}/{job_id}\", headers=headers)\n",
"response_status_singlejob.json().get('state')\n",
"```\n",
"\n",
"出力\n",
"\n",
"```text\n",
"{'status': 'Completed'}\n",
"```\n",
"\n",
"求人検索結果を表示：\n",
"\n",
"```python\n",
"response_result = requests.get(f\"{url}/{job_id}/results\", headers=headers)\n",
"\n",
"res_dict=response_result.json()\n",
"\n",
"# Get results for the first PUB\n",
"counts=res_dict['results'][0]['data']['c']['samples']\n",
"\n",
"print(counts[:20])\n",
"```\n",
"\n",
"出力\n",
"\n",
"```text\n",
"['0x1', '0x2', '0x1', '0x2', '0x1', '0x2', '0x0', '0x2', '0x1', '0x1', '0x2', '0x2', '0x1', '0x1', '0x1', '0x1', '0x1', '0x1', '0x1', '0x1']\n",
"```\n",
"\n",
"\n",
"\n",
"## 次のステップ\n",
"\n",
"\n",
" * ニーズに応じて、ワークロードを実行する方法はいくつかあります。具体的には、ジョブモード、セッションモード、バッチモードです。 「[実行モード](/docs/guides/execution-modes-rest-api) 」のトピックで、セッションモードとバッチモードの使い方について学びましょう。 なお、Open Planユーザーはセッションジョブを送信できません。\n",
" * REST API を使用して[アカウントを初期化](/docs/guides/cloud-setup-rest-api)する方法について学びましょう。\n",
" * IBM Quantum® Learning の「 [Cost関数](/learning/courses/variational-algorithm-design/cost-functions) 」のレッスンに取り組んで、プリミティブ型の扱い方を練習しましょう。\n",
" * 「[トランスパイル](/docs/guides/transpile) 」のセクションで、ローカルでのトランスパイル方法について学びましょう。\n",
"\n",
"\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"id": "a1b8767d",
"source": "© IBM Corp., 2017-2026"
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3"
}
},
"nbformat": 4,
"nbformat_minor": 4
}