共用方式為

AciWebservice 類別

  • 參考

表示部署為 Azure 容器執行個體 上 Web 服務端點的機器學習模型。

已部署的服務是從模型、腳本和相關聯的檔案建立的。 產生的 Web 服務是具有 REST API 的負載平衡 HTTP 端點。 您可以將資料傳送至此 API 並接收模型傳回的預測。

如需詳細資訊，請參閱將模型部署到 Azure 容器執行個體。

初始化 Webservice 實例。

Webservice 建構函式會擷取與所提供工作區相關聯之 Webservice 物件的雲端標記法。 它會傳回對應至所擷取之 Webservice 物件之特定類型的子類別實例。

繼承
Webservice
AciWebservice

建構函式

AciWebservice(workspace, name)

參數

名稱 Description
workspace
必要
Workspace

包含要擷取之 Webservice 物件的工作區物件。
name
必要
str

要擷取之 Webservice 物件的 名稱。

備註

建議的部署模式是使用 deploy_configuration 方法建立部署組態物件，然後將它與 deploy 類別的 Model 方法搭配使用，如下所示。


   from azureml.core.model import InferenceConfig
   from azureml.core.webservice import AciWebservice


   service_name = 'my-custom-env-service'

   inference_config = InferenceConfig(entry_script='score.py', environment=environment)
   aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)

   service = Model.deploy(workspace=ws,
                          name=service_name,
                          models=[model],
                          inference_config=inference_config,
                          deployment_config=aci_config,
                          overwrite=True)
   service.wait_for_deployment(show_output=True)

有數種方式可將模型部署為 Web 服務，包括：

  • deploy Model已在工作區中註冊之模型的 方法。

  • deploy_from_image 的 Webservice 方法。

  • deploy_from_model Webservice的 方法，用於已在工作區中註冊的模型。 這個方法會建立映射。

  • deploy 的 Webservice 方法，它會註冊模型並建立映射。

如需使用 Web 服務的資訊，請參閱

[變數]區段會列出雲端 AciWebservice 物件的本機標記法屬性。 這些變數應該視為唯讀。 變更其值不會反映在對應的雲端物件中。

變數

名稱 Description
enable_app_insights
bool

是否已啟用 Webservice 的 AppInsights 記錄。
cname
str

Webservice 的 cname。
container_resource_requirements
ContainerResourceRequirements

Webservice 的容器資源需求。
encryption_properties
EncryptionProperties

Webservice 的加密屬性。
vnet_configuration
VnetConfiguration

Webservice 的虛擬網路屬性，應該由使用者建立和提供組態。
azureml.core.webservice.AciWebservice.location
str

Webservice 部署至的位置。
public_ip
str

Webservice 的公用 IP 位址。
azureml.core.webservice.AciWebservice.scoring_uri
str

Webservice 的評分端點
ssl_enabled
bool

是否為 Web 服務啟用 SSL
public_fqdn
str

Webservice 的公用 FQDN
environment
Environment

用來建立 Webservice 的環境物件
azureml.core.webservice.AciWebservice.models
list[Model]

部署至 Webservice 的模型清單
azureml.core.webservice.AciWebservice.swagger_uri
str

Webservice 的 swagger 端點

方法

add_properties

將索引鍵值組新增至此 Webservice 的屬性字典。
add_tags

將索引鍵值組新增至此 Webservice 的標籤字典。
deploy_configuration

建立用於部署 AciWebservice 的組態物件。
get_token

擷取此 Webservice 的驗證權杖，範圍限定為目前使用者。

注意

未實作。
remove_tags

從此 Webservice 的標記字典中移除指定的索引鍵。
run

使用提供的輸入呼叫此 Webservice。
serialize

將此 Webservice 轉換成 JSON 序列化字典。
update

使用提供的屬性更新 Webservice。

保留為 None 的值將會在此 Webservice 中保持不變。

add_properties

將索引鍵值組新增至此 Webservice 的屬性字典。

add_properties(properties)

參數

名稱 Description
properties
必要
dict[str, str]

要加入的屬性字典。

add_tags

將索引鍵值組新增至此 Webservice 的標籤字典。

add_tags(tags)

參數

名稱 Description
tags
必要
dict[str, str]

要加入之標籤的字典。

例外狀況

類型 Description
WebserviceException

deploy_configuration

建立用於部署 AciWebservice 的組態物件。

static deploy_configuration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)

參數

名稱 Description
cpu_cores
float

要配置給這個 Webservice 的 CPU 核心數目。 可以是十進位。 預設值為 0.1

預設值: None
memory_gb
float

要配置給此 Webservice) GB 的記憶體 (數量。 可以是十進位。 預設值為 0.5

預設值: None
tags
dict[str, str]

索引鍵值標籤的字典，可提供此 Webservice。

預設值: None
properties
dict[str, str]

索引鍵值屬性的字典，可提供此 Webservice。 部署之後無法變更這些屬性，不過可以新增新的索引鍵值組。

預設值: None
description
str

提供此 Webservice 的描述。

預設值: None
location
str

要作為部署此 Webservice 的 Azure 區域。 如果未指定，則將會使用工作區位置。 如需可用區域的詳細資訊，請參閱 依區域的產品。

預設值: None
auth_enabled
bool

是否要啟用此 Web 服務的驗證。 預設為 False。

預設值: None
ssl_enabled
bool

是否要為此 Web 服務啟用 SSL。 預設為 False。

預設值: None
enable_app_insights
bool

是否要為此 Webservice 啟用 AppInsights。 預設為 False。

預設值: None
ssl_cert_pem_file
str

如果已啟用 SSL，則需要的憑證檔案。

預設值: None
ssl_key_pem_file
str

啟用 SSL 時所需的金鑰檔案。

預設值: None
ssl_cname
str

如果 SSL 已啟用，則為 cname。

預設值: None
dns_name_label
str

評分端點的 DNS 名稱標籤。 如果未指定唯一的 DNS 名稱標籤，則會產生評分端點的唯一 DNS 名稱標籤。

預設值: None
primary_key
str

要用於此 Web 服務的主要驗證金鑰。

預設值: None
secondary_key
str

要用於此 Webservice 的次要驗證金鑰。

預設值: None
collect_model_data
bool

是否啟用 Webservice 的模型資料收集。

預設值: None
cmk_vault_base_url
str

客戶管理的金鑰保存庫基底 URL

預設值: None
cmk_key_name
str

客戶管理的金鑰名稱。

預設值: None
cmk_key_version
str

客戶管理的金鑰版本。

預設值: None
vnet_name
str

虛擬網路名稱。

預設值: None
subnet_name
str

虛擬網路內的子網名稱。

預設值: None

傳回

類型 Description
AciServiceDeploymentConfiguration

部署 Webservice 物件時要使用的組態物件。

例外狀況

類型 Description
WebserviceException

get_token

擷取此 Webservice 的驗證權杖，範圍限定為目前使用者。

注意

未實作。

get_token()

傳回

類型 Description
str, datetime

此 Webservice 的驗證權杖，以及何時應該重新整理。

例外狀況

類型 Description
azureml.exceptions.NotImplementedError

remove_tags

從此 Webservice 的標記字典中移除指定的索引鍵。

remove_tags(tags)

參數

名稱 Description
tags
必要
list[str]

要移除的索引鍵清單。

run

使用提供的輸入呼叫此 Webservice。

run(input_data)

參數

名稱 Description
input_data
必要
<xref:varies>

用來呼叫 Webservice 的輸入。

傳回

類型 Description
dict

呼叫 Webservice 的結果。

例外狀況

類型 Description
WebserviceException

serialize

將此 Webservice 轉換成 JSON 序列化字典。

serialize()

傳回

類型 Description
dict

這個 Webservice 物件的 JSON 表示。

update

使用提供的屬性更新 Webservice。

保留為 None 的值將會在此 Webservice 中保持不變。

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

參數

名稱 Description
image
Image

要部署至 Webservice 的新映射。

預設值: None
tags
dict[str, str]

索引鍵值標籤的字典，可提供此 Webservice。 將會取代現有的標籤。

預設值: None
properties
dict[str, str]

要加入至現有屬性字典之索引鍵值屬性的字典。

預設值: None
description
str

提供此 Webservice 的描述。

預設值: None
auth_enabled
bool

啟用或停用此 Webservice 的驗證。

預設值: None
ssl_enabled
bool

是否要為此 Web 服務啟用 SSL。

預設值: None
ssl_cert_pem_file
str

如果已啟用 SSL，則需要的憑證檔案。

預設值: None
ssl_key_pem_file
str

啟用 SSL 時所需的金鑰檔案。

預設值: None
ssl_cname
str

如果 SSL 已啟用，則為 cname。

預設值: None
enable_app_insights
bool

是否要為此 Webservice 啟用 AppInsights。

預設值: None
models
list[Model]

要封裝至更新服務的 Model 物件清單。

預設值: None
inference_config
InferenceConfig

InferenceConfig 物件，用來提供所需的模型部署屬性。

預設值: None

傳回

類型 Description
None