AciWebservice 類別

表示部署為 Azure 容器實例上 Web 服務端點的機器學習模型。

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

初始化 Webservice 實例。

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

建構函式

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 是否為 Web 服務啟用 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 Web 服務的公用 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 是否要為此 Web 服務啟用 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 名稱標籤，則會針對評分端點產生。預設值: None
primary_key	str 要用於此 Webservice 的主要驗證金鑰。預設值: 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 要部署至 Web 服務的新映像。預設值: 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 是否要為此 Web 服務啟用 AppInsights。預設值: None
models	list[Model] 要封裝至更新服務的 Model 物件清單。預設值: None
inference_config	InferenceConfig 用來提供必要模型部署屬性的 InferenceConfig 物件。預設值: None

傳回

類型	Description
None

共用方式為

AciWebservice 類別

建構函式

參數

備註

變數

方法

add_properties

參數

add_tags

參數

例外狀況

deploy_configuration

參數

傳回

例外狀況

get_token

傳回

例外狀況

remove_tags

參數

run

參數

傳回

例外狀況

serialize

傳回

update

參數

傳回

意見反應