method get_job_by_id() missing in Qiskit Function Intro (#2629)

Closes #2627 which was opened by @johannesgreiner. Johannes, can you
provide more info on the fix please?

---------

Co-authored-by: Johannes Greiner <[email protected]>
Co-authored-by: Eric Arellano <[email protected]>

Author: 3 people

docs/guides/functions.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "id": "a47ac9aa-4bb9-4240-806e-9beabfd2dda2",
+   "id": "97b94d47-ba58-4251-91f2-93097e50f2c9",
    "metadata": {},
    "source": [
     "# Introduction to Qiskit Functions\n",
@@ -22,7 +22,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "0be0fe02-bc50-45a6-aaf6-2120dac862c2",
+   "id": "a4c425ca-c6c6-4232-b4b9-b2a365d10ad9",
    "metadata": {
     "tags": [
      "version-info"
@@ -45,7 +45,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "098d8fd4-1558-40df-a1b1-ad70fdef8863",
+   "id": "1fe03d0f-c7bb-439b-b98e-91ca400b62fc",
    "metadata": {},
    "source": [
     "Qiskit Functions simplify and accelerate utility-scale algorithm discovery and application development, by abstracting away parts of the quantum software development workflow. In this way, Qiskit Functions free up time normally spent hand-writing code and fine-tuning experiments.\n",
@@ -61,7 +61,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "df18227b-787a-4dc6-a8c7-7abd0f67110c",
+   "id": "5e5b0531-f286-4573-8b1e-664ca5496d2d",
    "metadata": {},
    "source": [
     "Functions are provided by IBM® and third-party partners. Each is performant for specific workload characteristics and have unique performance-tuning options. Premium Plan users can get started with IBM Qiskit Functions for free, or procure a license from one of the partners who have contributed a function to the catalog.\n",
@@ -103,7 +103,7 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "e872c222-aee9-40eb-8778-9a8e5434a11c",
+   "id": "6699700c-ae26-4c10-8d09-05ee77a1afb7",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -115,7 +115,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "80441467-1d9a-4107-8570-22afa6e369f7",
+   "id": "a00d2d76-dfbe-4a92-be82-8dea393ff12a",
    "metadata": {},
    "source": [
     "<LegacyContent>\n",
@@ -151,7 +151,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "6f2d0a37-1c6d-4cad-a9ce-c4d05c7aaaf1",
+   "id": "374939e2-54ac-4b72-92df-19a5fe9ec352",
    "metadata": {},
    "source": [
     "<LegacyContent>\n",
@@ -172,7 +172,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "5154cbea-ccfa-42ea-a9ef-c31699c3b2c0",
+   "id": "e3cada45-0364-4096-8481-6eb99d43c656",
    "metadata": {},
    "source": [
     "4. After you have authenticated, you can list the functions from the Qiskit Functions Catalog that you have access to:"
@@ -181,7 +181,7 @@
   {
    "cell_type": "code",
    "execution_count": 2,
-   "id": "55b73ad8-6e3b-4b76-8ba5-ae7ea339ffcc",
+   "id": "275b4b94-7656-403e-8997-941c03c7ef55",
    "metadata": {},
    "outputs": [
     {
@@ -210,7 +210,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "a1c73799-30ec-44dc-b4b9-06e59d521d8c",
+   "id": "de09ad8c-bd6d-4a02-8b24-7bb73beca811",
    "metadata": {},
    "source": [
     "### Run enabled functions\n",
@@ -221,7 +221,7 @@
   {
    "cell_type": "code",
    "execution_count": 3,
-   "id": "4ac22236-2a34-46fb-890f-30d6ba70081e",
+   "id": "65a26da5-f537-44ed-9cb4-b335518d009d",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -230,7 +230,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "deb844d3-051a-4db1-b0a1-4ba9801ef95e",
+   "id": "0a5f87e4-3082-4ec5-a7ae-7ddb5c35632a",
    "metadata": {},
    "source": [
     "Each Qiskit Function has custom inputs, options, and outputs. Check the specific documentation pages for the function you want to run for more information. By default, all users can only run one function job at a time:"
@@ -241,6 +241,7 @@
    "execution_count": null,
    "id": "139ac1d5-3727-4f44-a26c-0d8a1d8a58f2",
    "metadata": {
+    "scrolled": true,
     "tags": [
      "remove-cell"
     ]
@@ -289,7 +290,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "b1518e8e-04ea-4e4e-9f30-10f87dd4ee82",
+   "id": "113d4382-a987-492d-9e12-b66d3b955bc4",
    "metadata": {},
    "source": [
     "### Check job status\n",
@@ -311,7 +312,7 @@
   {
    "cell_type": "code",
    "execution_count": 6,
-   "id": "d811be20-cf0d-4070-a126-b40af6a33132",
+   "id": "d0574d73-0966-4426-b2f5-94df72a07caa",
    "metadata": {},
    "outputs": [
     {
@@ -331,7 +332,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "8e6528b5-c36f-48e1-bb2f-2416ccb12902",
+   "id": "439fbefc-f7d3-4e6e-b3e6-61a3664ac5e9",
    "metadata": {},
    "source": [
     "### Retrieve results\n",
@@ -342,7 +343,7 @@
   {
    "cell_type": "code",
    "execution_count": 7,
-   "id": "04f6a446-fbc6-438a-bc07-00fc9d551d83",
+   "id": "45e302d8-f3c2-4868-8b7c-6d451f6119a9",
    "metadata": {},
    "outputs": [
     {
@@ -360,7 +361,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "76c32136-f449-454c-896b-ff9d0edf9abc",
+   "id": "d809d8fa-479c-4c3b-81d7-3408925cec68",
    "metadata": {},
    "source": [
     "You can also cancel a job at any time:"
@@ -369,7 +370,7 @@
   {
    "cell_type": "code",
    "execution_count": 8,
-   "id": "7ddc2394-64a9-4fdd-bb3d-7729433fcd9c",
+   "id": "0e55d4d6-4680-4671-907f-35aac16971ef",
    "metadata": {},
    "outputs": [
     {
@@ -389,7 +390,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "5b5d7c8d-7a96-41e2-93aa-528513acdd21",
+   "id": "1ef980bc-9030-4f8a-84d6-a0abd15923ac",
    "metadata": {},
    "source": [
     "### List previously run jobs run with Qiskit Functions\n",
@@ -399,8 +400,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
-   "id": "c1a2832b-1ca3-4ef1-9a8a-3f3804b3aedf",
+   "execution_count": 8,
+   "id": "4becfe13-68dd-481d-bb43-fc502c254623",
    "metadata": {},
    "outputs": [
     {
@@ -418,7 +419,7 @@
        " <Job | eaa2db93-0d2f-4b52-9f1b-a69fc03dc3d6>]"
       ]
      },
-     "execution_count": 9,
+     "execution_count": 8,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -430,7 +431,35 @@
   },
   {
    "cell_type": "markdown",
-   "id": "9137071a-e39c-4b66-afbd-697db38cc670",
+   "id": "af7fa72a-f272-43ff-800d-5ae37dd42b2b",
+   "metadata": {},
+   "source": [
+    "If you already have the job ID for a certain job, you can retrieve the job with `catalog.get_job_by_id()`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "18d87f07-8a8e-4b93-80d0-7c07e49272e2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# First, get the most recent job that has been executed.\n",
+    "latest_job = old_jobs[0]\n",
+    "\n",
+    "# We can also get that same job with get_job_by_id\n",
+    "job_by_id = catalog.get_job_by_id(latest_job.job_id)\n",
+    "\n",
+    "# Verify that the job is the same using both retrieval methods.\n",
+    "assert job_by_id == latest_job\n",
+    "\n",
+    "# Print the job_id for this job.\n",
+    "print(job_by_id.job_id)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e15f89f8-925d-4d13-8fb8-80ad1d8ac7f6",
    "metadata": {},
    "source": [
     "### Fetch error messages\n",
@@ -441,7 +470,7 @@
   {
    "cell_type": "code",
    "execution_count": 10,
-   "id": "abfdf746-bc46-4df7-85b3-4a7a61ab7ca7",
+   "id": "3e9d090a-7eb4-476e-92f8-6871803a704d",
    "metadata": {},
    "outputs": [
     {
@@ -458,7 +487,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "7c8c3e5d-1de2-4fed-be03-d134dc3fd907",
+   "id": "709b39ca-5dbd-42c0-830c-1248c2e5d63c",
    "metadata": {},
    "source": [
     "## Next steps\n",
@@ -494,5 +523,5 @@
   "title": "Introduction to Qiskit Functions"
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }