共用方式為


SessionHost 類別

允許其他物件「裝載」會話的通訊協定。 例如,目標物件可以裝載開啟的會話,並讓所有正在透過該會話送出的工作與該會話相關聯。

範例 (作業 1 到 3 將會與工作階段 “MySession” 相關聯):


   with target.open_session(name="MySession") as session:
        job1 = target.submit(input_data=input_data, job_name="Job 1")
        job2 = target.submit(input_data=input_data, job_name="Job 2")
        job3 = target.submit(input_data=input_data, job_name="Job 3")
繼承
SessionHost

建構函式

SessionHost(*args, **kwargs)

方法

get_latest_session_id

取得與此對象相關聯的最新 (open) 會話識別碼。 此標識碼是用來將作業與最新的 (開啟) 工作階段產生關聯。

open_session

開啟工作階段,並將所有未來的作業提交關聯至該工作階段,直到會話關閉為止(在結束具有 區塊 後自動發生)。

範例 (作業 1 到 3 將會與工作階段 “MySession” 相關聯):


   with target.open_session(name="MySession") as session:
        job1 = target.submit(input_data=input_data, job_name="Job 1")
        job2 = target.submit(input_data=input_data, job_name="Job 2")
        job3 = target.submit(input_data=input_data, job_name="Job 3")

注意:如果會話主機(通常是 目標 或 qiskit 後端)已經有與其相關聯的會話(在 latest_session 屬性中),則此方法會先嘗試關閉該會話,再開啟新的會話。

get_latest_session_id

取得與此對象相關聯的最新 (open) 會話識別碼。 此標識碼是用來將作業與最新的 (開啟) 工作階段產生關聯。

get_latest_session_id() -> str | None

傳回

類型 Description

最新的會話標識碼。

open_session

開啟工作階段,並將所有未來的作業提交關聯至該工作階段,直到會話關閉為止(在結束具有 區塊 後自動發生)。

範例 (作業 1 到 3 將會與工作階段 “MySession” 相關聯):


   with target.open_session(name="MySession") as session:
        job1 = target.submit(input_data=input_data, job_name="Job 1")
        job2 = target.submit(input_data=input_data, job_name="Job 2")
        job3 = target.submit(input_data=input_data, job_name="Job 3")

注意:如果會話主機(通常是 目標 或 qiskit 後端)已經有與其相關聯的會話(在 latest_session 屬性中),則此方法會先嘗試關閉該會話,再開啟新的會話。

open_session(details: SessionDetails | None = None, id: str | None = None, name: str | None = None, job_failure_policy: str | SessionJobFailurePolicy | None = None, **kwargs) -> Session

參數

名稱 Description
details

會話詳細數據模型,包含會話標識碼、名稱、job_failure_policy、provider_id和目標。 應該傳遞此參數,其中包含所有會話詳細數據值,相同的值應該傳遞為個別參數。

預設值: None
id

會話的標識碼。 如果未傳遞,則會使用一個隨機 uuid。

預設值: None
name

工作階段的名稱。 如果未傳遞,名稱將會 session-{session-id}

預設值: None
job_failure_policy

決定會話何時會失敗、關閉且不接受進一步作業的原則。

預設值: None

傳回

類型 Description

會話物件,其開啟後會更新詳細數據。

屬性

latest_session

取得與此對象相關聯的最新 (open) 工作階段。

傳回

類型 Description

最新的會話物件。