BaseJob 類別
使用方法從原始 Blob 資料建立作業、上傳 Blob 數據和下載結果的基底作業類別。
- 繼承
-
azure.quantum.job.workspace_item.WorkspaceItemBaseJob
建構函式
BaseJob(workspace: Workspace, details: ItemDetails, **kwargs)
參數
名稱 | Description |
---|---|
workspace
必要
|
作業的工作區實例 |
details
必要
|
<xref:ItemDetails>
項目詳細數據模型,包含專案標識碼、名稱和其他詳細數據 |
方法
create_job_id |
建立新作業的唯一標識符。 |
download_attachment |
從 Azure 記憶體中作業的容器下載附件。 附件是建立為作業執行一部分之數據的 Blob,或是透過使用 upload_attachment 方法直接從 Python 上傳來建立。 |
download_blob_properties |
下載 Blob 屬性 |
download_data |
從 Blob URI 下載檔 |
from_input_data |
根據原始input_data承載建立新的 Azure Quantum 作業。 |
from_storage_uri |
如果輸入數據已上傳至 Blob 記憶體,請從 URI 建立新的作業 |
upload_attachment |
將附件上傳至作業的容器檔案。 附件的名稱會識別。 上傳至現有的附件會覆寫其先前的內容。 |
upload_input_data |
上傳輸入數據檔 |
create_job_id
建立新作業的唯一標識符。
static create_job_id() -> str
download_attachment
從 Azure 記憶體中作業的容器下載附件。 附件是建立為作業執行一部分之數據的 Blob,或是透過使用 upload_attachment 方法直接從 Python 上傳來建立。
download_attachment(name: str, container_uri: str = None)
參數
名稱 | Description |
---|---|
name
必要
|
附件名稱 |
container_uri
|
容器 URI,預設為作業的連結容器。 預設值: None
|
傳回
類型 | Description |
---|---|
附件數據 |
download_blob_properties
下載 Blob 屬性
download_blob_properties(blob_uri: str)
參數
名稱 | Description |
---|---|
blob_uri
必要
|
Blob URI |
傳回
類型 | Description |
---|---|
Blob 屬性 |
download_data
從 Blob URI 下載檔
download_data(blob_uri: str) -> dict
參數
名稱 | Description |
---|---|
blob_uri
必要
|
Blob URI |
傳回
類型 | Description |
---|---|
來自 Blob 的承載 |
from_input_data
根據原始input_data承載建立新的 Azure Quantum 作業。
from_input_data(workspace: Workspace, name: str, target: str, input_data: bytes, content_type: ContentType = ContentType.json, blob_name: str = 'inputData', encoding: str = '', job_id: str = None, container_name: str = None, provider_id: str = None, input_data_format: str = None, output_data_format: str = None, input_params: Dict[str, Any] = None, session_id: str | None = None, **kwargs) -> BaseJob
參數
名稱 | Description |
---|---|
workspace
必要
|
要提交input_data的 Azure Quantum 工作區 |
name
必要
|
作業的名稱 |
target
必要
|
Azure Quantum 目標 |
input_data
必要
|
要送出的原始輸入數據 |
blob_name
|
輸入數據 Blob 名稱,預設為 “inputData” 預設值: inputData
|
content_type
|
內容類型,例如“application/json” 預設值: ContentType.json
|
encoding
必要
|
input_data編碼,例如 「gzip」,預設為空字串 |
job_id
|
作業標識碼,預設值為 None 預設值: None
|
container_name
|
容器名稱,預設為 None 預設值: None
|
provider_id
|
提供者標識碼,預設為 None 預設值: None
|
input_data_format
|
輸入數據格式,預設值為 None 預設值: None
|
output_data_format
|
輸出數據格式,預設值為 None 預設值: None
|
input_params
|
輸入參數,預設值為 None 預設值: None
|
input_params
必要
|
作業的輸入參數 |
session_id
|
預設值: None
|
傳回
類型 | Description |
---|---|
Azure Quantum 作業 |
from_storage_uri
如果輸入數據已上傳至 Blob 記憶體,請從 URI 建立新的作業
from_storage_uri(workspace: Workspace, name: str, target: str, input_data_uri: str, provider_id: str, input_data_format: str, output_data_format: str, container_uri: str = None, job_id: str = None, input_params: Dict[str, Any] = None, submit_job: bool = True, session_id: str | None = None, **kwargs) -> BaseJob
參數
名稱 | Description |
---|---|
workspace
必要
|
將 Blob 提交至的 Azure Quantum 工作區 |
name
必要
|
作業名稱 |
target
必要
|
Azure Quantum 目標 |
input_data_uri
必要
|
輸入數據 URI |
provider_id
必要
|
提供者標識碼 |
input_data_format
必要
|
輸入數據格式 |
output_data_format
必要
|
輸出數據格式 |
container_uri
|
容器 URI,預設為 None 預設值: None
|
job_id
|
預先產生的作業標識碼,預設為 None 預設值: None
|
input_params
|
輸入參數,預設值為 None 預設值: None
|
submit_job
|
如果作業應該提交至服務,則預設為 True 預設值: True
|
session_id
|
預設值: None
|
傳回
類型 | Description |
---|---|
作業實例 |
upload_attachment
將附件上傳至作業的容器檔案。 附件的名稱會識別。 上傳至現有的附件會覆寫其先前的內容。
upload_attachment(name: str, data: bytes, container_uri: str = None, **kwargs) -> str
參數
名稱 | Description |
---|---|
name
必要
|
附件名稱 |
data
必要
|
二進位格式的附件數據 |
container_uri
|
容器 URI,預設為作業的連結容器。 預設值: None
|
傳回
類型 | Description |
---|---|
上傳的數據 URI |
upload_input_data
上傳輸入數據檔
static upload_input_data(container_uri: str, input_data: bytes, content_type: ContentType | None = ContentType.json, blob_name: str = 'inputData', encoding: str = '', return_sas_token: bool = False) -> str
參數
名稱 | Description |
---|---|
container_uri
必要
|
容器 URI |
input_data
必要
|
以二進位格式輸入數據 |
content_type
|
內容類型,例如“application/json” 預設值: ContentType.json
|
blob_name
|
Blob 名稱,預設為 “inputData” 預設值: inputData
|
encoding
必要
|
編碼方式,例如 “gzip”,默認為 “” |
return_sas_token
|
將 SAS 令牌當做 URI 的一部分傳回旗標,預設為 False 預設值: False
|
傳回
類型 | Description |
---|---|
上傳的數據 URI |
屬性
container_name
工作輸入/輸出數據容器名稱
details
作業詳細數據