{ "cells": [ { "cell_type": "markdown", "id": "38b90986-2529-4974-9dbd-931f3089b7fa", "metadata": {}, "source": [ "---\n", "title: \"Modos de execução usando a API REST\"\n", "description: \"Como executar uma tarefa de computação quântica em uma sessão do Qiskit Runtime.\"\n", "---\n", "\n", "\n", "\n", "# Modos de execução usando a API REST\n", "\n" ] }, { "cell_type": "markdown", "id": "d501206a-c250-4df7-befc-317678659d32", "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", " Versões do pacote\n", "\n", " O código desta página foi desenvolvido com base nos seguintes requisitos.\n", " Recomendamos usar essas versões ou versões mais recentes.\n", "\n", " ```\n", " qiskit[all]~=2.3.0\n", " ```\n", "
\n", "\n" ] }, { "cell_type": "markdown", "id": "2153584e-5711-4168-a4a5-0b94d02dd3e7", "metadata": {}, "source": [ "Você pode executar suas cargas de trabalho primitivas do Qiskit usando APIs REST em um dos três modos de execução, dependendo de suas necessidades: trabalho, sessão e lote. Este tópico explica esses modos.\n", "\n", "\n", " Esta documentação utiliza o módulo Python `requests` para demonstrar a API REST Qiskit Runtime. No entanto, esse fluxo de trabalho pode ser executado usando qualquer linguagem ou estrutura que suporte o trabalho com APIs REST. Consulte a [documentação de referência da API](/docs/api/qiskit-ibm-runtime/tags/jobs) para obter detalhes.\n", "\n", "\n", "\n", "\n", "## Modo de trabalho com API REST\n", "\n", "No modo de execução, é feita uma única chamada primitiva do Estimator ou do Sampler sem um gerenciador de contexto. Veja como executar um circuito quântico usando [o Estimator](/docs/guides/estimator-rest-api) e [o Sampler](/docs/guides/sampler-rest-api) para ver alguns exemplos.\n", "\n", "\n", "\n", "## Modo de sessão com API REST\n", "\n", "Uma sessão é um recurso do Qiskit Runtime que permite executar com eficiência cargas de trabalho iterativas com múltiplas tarefas em computadores quânticos. O uso de sessões ajuda a evitar atrasos causados pelo enfileiramento de cada tarefa separadamente, o que pode ser particularmente útil para tarefas iterativas que exigem comunicação frequente entre recursos clássicos e quânticos. Mais detalhes sobre as sessões podem ser encontrados na [documentação](/docs/guides/execution-modes).\n", "\n", "\n", " Os usuários do Open Plan não podem enviar trabalhos de sessão.\n", "\n", "\n", "\n", "\n", "### Iniciar uma sessão\n", "\n", "Comece criando uma sessão e obtendo um ID de sessão.\n", "\n", "```python\n", "import json\n", "import requests\n", "\n", "sessionsUrl = \"https://quantum.cloud.ibm.com/api/v1/sessions\"\n", "auth_id = \"Bearer \"\n", "backend = \"\"\n", "crn = \"\"\n", "\n", "headersList = {\n", " \"Accept\": \"application/json\",\n", " \"Content-Type\": \"application/json\",\n", " \"Authorization\": auth_id,\n", " \"Service-CRN\": crn\n", "}\n", "\n", "payload = json.dumps({\n", " \"backend\": backend,\n", " \"mode\": 'dedicated',\n", "})\n", "\n", "response = requests.request(\"POST\", sessionsUrl, data=payload, headers=headersList)\n", "\n", "sessionId = response.json()['id']\n", "\n", "print(response.json())\n", "```\n", "\n", "Saída\n", "\n", "```text\n", "{'id': 'crw9s7cdbt40008jxesg'}\n", "```\n", "\n", "\n", "\n", "### Fechar uma sessão\n", "\n", "É uma boa prática fechar o site `Session` quando todos os trabalhos estiverem concluídos. Isso reduzirá o tempo de espera dos usuários subsequentes.\n", "\n", "```python\n", "closureURL=\"https://quantum.cloud.ibm.com/api/v1/sessions/\"+sessionId+\"/close\"\n", "\n", "headersList = {\n", " \"Accept\": \"application/json\",\n", " \"Authorization\": auth_id,\n", " \"Service-CRN\": crn\n", "}\n", "\n", "closure_response = requests.request(\n", " \"DELETE\",\n", " closureURL,\n", " headers=headersList\n", " )\n", "\n", "print(\"Session closure response ok?:\",closure_response.ok,closure_response.text)\n", "```\n", "\n", "Saída\n", "\n", "```text\n", "Session closure response ok?: True\n", "```\n", "\n", "\n", "\n", "## Modo em lote com API REST\n", "\n", "Como alternativa, você pode enviar um trabalho em lote especificando o `mode` na carga útil da solicitação. O modo em lote pode ajudar a reduzir o tempo de processamento se todos os trabalhos puderem ser fornecidos desde o início. Saiba mais sobre o modo em lote no guia [de introdução aos modos de execução](/docs/guides/execution-modes#batch-mode).\n", "\n", "```python\n", "import json\n", "import requests\n", "\n", "sessionsUrl = \"https://quantum.cloud.ibm.com/api/v1/sessions\"\n", "\n", "headersList = {\n", " \"Accept\": \"application/json\",\n", " \"Authorization\": auth_id,\n", " \"Service-CRN\": crn,\n", " 'Content-Type': 'application/json'\n", "}\n", "\n", "payload = json.dumps({\n", " \"backend\": backend,\n", " \"instance\": \"hub1/group1/project1\",\n", " \"mode\": \"batch\"\n", "})\n", "\n", "response = requests.request(\"POST\", sessionsUrl, data=payload, headers=headersList)\n", "\n", "sessionId = response.json()['id']\n", "```\n", "\n", "\n", "\n", "## Exemplos de trabalhos enviados em uma sessão\n", "\n", "Depois que uma sessão é configurada, um ou mais trabalhos do Sampler ou do Estimator podem ser enviados para a mesma sessão, especificando o ID da sessão.\n", "\n", "\n", " O `` em um `PUB` pode ser um único parâmetro ou uma lista de parâmetros. Ele também suporta a transmissão `numpy` .\n", "\n", "\n", "\n", "\n", "### Trabalhos do Estimador no modo sessão\n", "\n", "\n", " \n", " ```python\n", " job_input = {\n", " 'program_id': 'estimator',\n", " \"backend\": backend,\n", " \"session_id\": sessionId, # This specifies the previously created Session\n", " \"params\": {\n", " \"pubs\": [[resulting_qasm, [obs1, obs2, obs3, obs4]]], #primitive unified blocs (PUBs) containing one circuit each.\n", " \"options\":{\n", " \"transpilation\":{\"optimization_level\": 1},\n", " \"twirling\": {\"enable_gates\": True,\"enable_measure\": True},\n", " # \"dynamical_decoupling\": {\"enable\": True, \"sequence_type\": \"XpXm\"}, #(optional)\n", " },\n", " }\n", "\n", " }\n", " ```\n", " \n", "\n", " \n", " ```python\n", " job_input = {\n", " 'program_id': 'estimator',\n", " \"backend\": backend,\n", " \"session_id\": sessionId, # This specifies the previously created Session\n", " \"params\": {\n", " \"pubs\": [[resulting_qasm, [[obs1], [obs2], [obs3], [obs4]], [[vals1], [vals2]]]], #primitive unified blocs (PUBs) containing one circuit each\n", " \"options\":{\n", " \"transpilation\":{\"optimization_level\": 1},\n", " \"twirling\": {\"enable_gates\": True,\"enable_measure\": True},\n", " # \"dynamical_decoupling\": {\"enable\": True, \"sequence_type\": \"XpXm\"}, #(optional)\n", " },\n", " }\n", " }\n", " ```\n", " \n", "\n", " \n", " ```python\n", " job_input = {\n", " 'program_id': 'estimator',\n", " \"backend\": backend,\n", " \"session_id\": sessionId, # This specifies the previously created Session\n", " \"params\": {\n", " \"pubs\": [[resulting_qasm, obs1],[resulting_qasm, obs2]], #primitive unified blocs (PUBs) containing one circuit each\n", " \"options\":{\n", " \"transpilation\":{\"optimization_level\": 1},\n", " \"twirling\": {\"enable_gates\": True,\"enable_measure\": True},\n", " # \"dynamical_decoupling\": {\"enable\": True, \"sequence_type\": \"XpXm\"}, #(optional)\n", " },\n", " }\n", " }\n", " ```\n", " \n", "\n", "\n", "\n", "\n", "### Trabalhos de amostragem no modo de sessão\n", "\n", "\n", " \n", " ```python\n", " job_input = {\n", " 'program_id': 'sampler',\n", " \"backend\": backend,\n", " \"session_id\": sessionId, # This specifies the previously created Session\n", " \"params\": {\n", " \"pubs\": [[resulting_qasm]], #primitive unified blocs (PUBs) containing one circuit each\n", " \"options\":{\n", " \"transpilation\":{\"optimization_level\": 1},\n", " \"twirling\": {\"enable_gates\": True,\"enable_measure\": True},\n", " # \"dynamical_decoupling\": {\"enable\": True, \"sequence_type\": \"XpXm\"}, #(optional)\n", " },\n", " }\n", "\n", " }\n", " ```\n", " \n", "\n", " \n", " ```python\n", " job_input = {\n", " 'program_id': 'sampler',\n", " \"backend\": backend,\n", " \"session_id\": sessionId, # This specifies the previously created Session\n", " \"params\": {\n", " \"pubs\": [[resulting_qasm, [vals1, vals2, vals3]]], #primitive unified blocs (PUBs) containing one circuit each\n", " \"options\":{\n", " \"transpilation\":{\"optimization_level\": 1},\n", " \"twirling\": {\"enable_gates\": True,\"enable_measure\": True},\n", " # \"dynamical_decoupling\": {\"enable\": True, \"sequence_type\": \"XpXm\"}, #(optional)\n", " },\n", " }\n", " }\n", " ```\n", " \n", "\n", " \n", " ```python\n", " job_input = {\n", " 'program_id': 'sampler',\n", " \"backend\": backend,\n", " \"session_id\": sessionId, # This specifies the previously created Session\n", " \"params\": {\n", " \"pubs\": [[resulting_qasm, [val1]],[resulting_qasm,None,100]], #primitive unified blocs (PUBs) containing one circuit each\n", " \"options\":{\n", " \"transpilation\":{\"optimization_level\": 1},\n", " \"twirling\": {\"enable_gates\": True,\"enable_measure\": True},\n", " # \"dynamical_decoupling\": {\"enable\": True, \"sequence_type\": \"XpXm\"}, #(optional)\n", " },\n", " }\n", " }\n", " ```\n", " \n", "\n", "\n", "\n", "\n", "## Próximas etapas\n", "\n", "\n", " * Analise exemplos detalhados de primitivas [do Sampler](/docs/guides/sampler-rest-api) usando a API REST.\n", " * Analise exemplos detalhados de primitivas [do Estimator](/docs/guides/estimator-rest-api) usando a API REST.\n", " * Pratique com primitivos trabalhando na [lição sobre função de custo](/learning/courses/variational-algorithm-design/cost-functions) em IBM Quantum® Learning.\n", " * Saiba como fazer a transpilagem localmente na seção [Transpilagem](/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 }