azure-sdk-for-python API reference
400 public APIs from azure-sdk-for-python (Azure/azure-sdk-for-python) — 310 classes, 25 functions, 65 methods. Signatures extracted by static analysis of the actual source.
Repository: Azure/azure-sdk-for-python
| Kind | Count |
|---|---|
| Classes | 310 |
| Functions | 25 |
| Methods | 65 |
API list
func
conda.conda_helper_functions.get_package_path(package_name:str) -> Optional[str]Get the filesystem path of an SDK package given its name.
func
conda.conda_helper_functions.is_stable_on_pypi(package_name:str) -> boolCheck if a package has any stable (GA) release on PyPI.
func
conda.update_conda_files.format_requirement(req:str) -> strFormat a requirement string for conda meta.yaml.
func
conda.update_conda_files.update_mgmt_plane_release_log(package_dict:dict, all_mgmt_plane_names:list[str], release_date:str) -> list[str]Update azure-mgmt release log.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.model_base.Modelmethod
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.model_base.Model.as_dict(*exclude_readonly:bool=False) -> dict[str, typing.Any]Return a dict that can be turned into json using json.dump.
func
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.model_base.serialize_xml(model:Model, exclude_readonly:bool=False) -> strSerialize a model to XML.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.DeserializerResponse object model deserializer.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Deserializer.deserialize_object(attr, **kwargs)Deserialize a generic object.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Deserializer.failsafe_deserialize(target_obj, data, content_type=None)Ignores any errors encountered in deserialization, and falls back to not deserializing the object.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.SerializerRequest object model serializer.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Serializer.body(data, data_type, **kwargs)Serialize data intended for a request body.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Serializer.serialize_basic(data, data_type, **kwargs)Serialize basic builting data type.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Serializer.serialize_data(data, data_type, **kwargs)Serialize generic data according to supplied data type.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Serializer.serialize_unicode(data)Special handling for serializing unicode strings in Py2.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.serialization.Serializer.url(name, data, data_type, **kwargs)Serialize data intended for a URL path.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor._utils.utils.ClientMixinABCDO NOT use this class.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.AdvisorScoresOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.AdvisorScoresOperations.get(name:str, **kwargs:Any) -> _models.AdvisorScoreEntityGets the advisor score.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.AssessmentTypesOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.AssessmentTypesOperations.list(**kwargs:Any) -> AsyncItemPaged['_models.AssessmentTypeResult']Get assessment types list.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.AssessmentsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.ConfigurationsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.Operations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.Operations.list(**kwargs:Any) -> AsyncItemPaged['_models.OperationEntity']List the operations for the provider.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.RecommendationMetadataOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.RecommendationMetadataOperations.get(name:str, **kwargs:Any) -> _models.MetadataEntityGets the metadata entity.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.RecommendationsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.SuppressionsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.WorkloadsOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.WorkloadsOperations.list(**kwargs:Any) -> AsyncItemPaged['_models.WorkloadResult']Get Workloads list.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.resiliencyReviewsOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.aio.operations._operations.resiliencyReviewsOperations.get(review_id:str, **kwargs:Any) -> _models.ResiliencyReviewGet existing resiliency review.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.AggregatedThe aggregation level of the score.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.CategoryThe category of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.ConfigurationNameType of ConfigurationName.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.ControlThe sub-category of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.DigestConfigStateState of digest configuration.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.ImpactThe business impact of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.PredictionTypeType of the prediction.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.PriorityThe Priority of the Recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._enums.ReviewStatusReview status.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ARMErrorResponseBodyARM error response body.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.AdvisorScoreEntityPropertiesThe Advisor score data.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ArmErrorResponseArmErrorResponse.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.AssessmentResultPropertiesAssessment result properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ConfigDataThe Advisor configuration data structure.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ConfigDataPropertiesConfiguration data properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.DigestConfigAdvisor Digest configuration entity.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ErrorDetailThe error detail.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ErrorResponseError response.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ExtensionResourceThe base extension resource.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.MetadataEntityThe metadata entity contract.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.MetadataEntityPropertiesThe metadata entity properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.MetadataSupportedValueDetailThe metadata supported value detail.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.OperationDisplayInfoThe operation supported by Advisor.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.OperationEntityThe operation supported by Advisor.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.PredictionRequestParameters for predict recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.PredictionRequestPropertiesProperties given for the predictor.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.PredictionResponseResponse used by predictions.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.PredictionResponsePropertiesProperties of the prediction.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ProxyResourceProxy Resource.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.RecommendationPatchPayloadThe recommendation patch payload.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.RecommendationPropertiesThe properties of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ResiliencyReviewPropertiesResiliency review properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ResourceResource.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ResourceMetadataRecommendation resource metadata.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ResourceRecommendationBaseAdvisor Recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ScoreEntityThe details of Advisor Score.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.ShortDescriptionA summary of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.SuppressionPropertiesThe properties of the suppression.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.models._models.WorkloadResultThe Workload result data structure.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.AdvisorScoresOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.AdvisorScoresOperations.get(name:str, **kwargs:Any) -> _models.AdvisorScoreEntityGets the advisor score.
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.AdvisorScoresOperations.list(**kwargs:Any) -> ItemPaged['_models.AdvisorScoreEntity']Gets the list of advisor scores.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.AssessmentTypesOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.AssessmentTypesOperations.list(**kwargs:Any) -> ItemPaged['_models.AssessmentTypeResult']Get assessment types list.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.AssessmentsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.ConfigurationsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.Operations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.Operations.list(**kwargs:Any) -> ItemPaged['_models.OperationEntity']List the operations for the provider.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.RecommendationMetadataOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.RecommendationMetadataOperations.get(name:str, **kwargs:Any) -> _models.MetadataEntityGets the metadata entity.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.RecommendationsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.SuppressionsOperations..
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.WorkloadsOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.WorkloadsOperations.list(**kwargs:Any) -> ItemPaged['_models.WorkloadResult']Get Workloads list.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.resiliencyReviewsOperations..
method
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.operations._operations.resiliencyReviewsOperations.get(review_id:str, **kwargs:Any) -> _models.ResiliencyReviewGet existing resiliency review.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ARMErrorResponseBodyARM error response body.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.AdvisorScoreEntityPropertiesThe Advisor score data.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ArmErrorResponseArmErrorResponse.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.AssessmentResultPropertiesAssessment result properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ConfigDataThe Advisor configuration data structure.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ConfigDataPropertiesConfiguration data properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.DigestConfigAdvisor Digest configuration entity.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ErrorDetailThe error detail.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ErrorResponseError response.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ExtensionResourceThe base extension resource.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.MetadataEntityThe metadata entity contract.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.MetadataEntityPropertiesThe metadata entity properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.MetadataSupportedValueDetailThe metadata supported value detail.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.OperationDisplayInfoThe operation supported by Advisor.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.OperationEntityThe operation supported by Advisor.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.PredictionRequestParameters for predict recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.PredictionRequestPropertiesProperties given for the predictor.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.PredictionResponseResponse used by predictions.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.PredictionResponsePropertiesProperties of the prediction.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ProxyResourceProxy Resource.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.RecommendationPatchPayloadThe recommendation patch payload.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.RecommendationPropertiesThe properties of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ResiliencyReviewPropertiesResiliency review properties.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ResourceResource.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ResourceMetadataRecommendation resource metadata.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ResourceRecommendationBaseAdvisor Recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ScoreEntityThe details of Advisor Score.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.ShortDescriptionA summary of the recommendation.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.SuppressionPropertiesThe properties of the suppression.
class
sdk.advisor.azure-mgmt-advisor.azure.mgmt.advisor.types.WorkloadResultThe Workload result data structure.
func
sdk.agentserver.azure-ai-agentserver-core.azure.ai.agentserver.core._config.resolve_agent_id() -> strResolve the agent ID.
class
sdk.agentserver.azure-ai-agentserver-core.azure.ai.agentserver.core.storage._generated._models.ApiErrorApiError.
func
sdk.agentserver.azure-ai-agentserver-core.azure.ai.agentserver.core.storage._generated._utils.model_base.serialize_xml(model:Model, exclude_readonly:bool=False) -> strSerialize a model to XML.
class
sdk.agentserver.azure-ai-agentserver-core.azure.ai.agentserver.core.streaming._protocol.EventStreamA multi-cast event stream.
class
sdk.agentserver.azure-ai-agentserver-invocations.azure.ai.agentserver.invocations._constants.InvocationConstantsInvocation protocol constants.
class
sdk.agentserver.azure-ai-agentserver-optimization.azure.ai.agentserver.optimization._models.OptimizationConfigResolved optimization config.
func
sdk.agentserver.azure-ai-agentserver-responses._scripts.generate_validators.main() -> intRun the validator generator CLI.
func
sdk.agentserver.azure-ai-agentserver-responses._scripts.validator_schema_walker.resolve_ref(ref:str) -> strExtract schema name from OpenAPI $ref values.
func
sdk.agentserver.azure-ai-agentserver-responses.azure.ai.agentserver.responses._data_url.is_data_url(value:str | None) -> boolCheck whether *value* is a ``data:`` URL.
func
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform._utils.model_base.serialize_xml(model:Model, exclude_readonly:bool=False) -> strSerialize a model to XML.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.aio.operations._operations.AgriServiceOperations..
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.aio.operations._operations.Operations..
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._enums.ActionTypeExtensible enum.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._models.ErrorDetailThe error detail.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._models.ErrorResponseError response.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._models.MoboBrokerResourceMoboBroker resource.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._models.OperationREST API Operation.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._models.ResourceResource.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.models._models.TrackedResourceTracked Resource.
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.operations._operations.AgriServiceOperations..
class
sdk.agricultureplatform.azure-mgmt-agricultureplatform.azure.mgmt.agricultureplatform.operations._operations.Operations..
class
sdk.agrifood.azure-agrifood-farming.azure.agrifood.farming._serialization.DeserializerResponse object model deserializer.
class
sdk.agrifood.azure-agrifood-farming.azure.agrifood.farming._serialization.SerializerRequest object model serializer.
class
sdk.agrifood.azure-agrifood-farming.azure.agrifood.farming._serialization.UTCTime Zone info for handling UTC
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood._serialization.DeserializerResponse object model deserializer.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood._serialization.SerializerRequest object model serializer.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood._serialization.UTCTime Zone info for handling UTC
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._extensions_operations.ExtensionsOperations..
method
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._extensions_operations.ExtensionsOperations.delete(resource_group_name:str, farm_beats_resource_name:str, extension_id:str, **kwargs:Any) -> NoneUninstall extension.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._farm_beats_extensions_operations.FarmBeatsExtensionsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._farm_beats_models_operations.FarmBeatsModelsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._locations_operations.LocationsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._operations.Operations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._private_endpoint_connections_operations.PrivateEndpointConnectionsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._private_link_resources_operations.PrivateLinkResourcesOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._solutions_discoverability_operations.SolutionsDiscoverabilityOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._solutions_operations.SolutionsOperations..
method
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.aio.operations._solutions_operations.SolutionsOperations.delete(resource_group_name:str, farm_beats_resource_name:str, **kwargs:Any) -> NoneUninstall Solution.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._agri_food_mgmt_client_enums.ActionTypeEnum.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.ApiPropertiesApi properties.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.ArmAsyncOperationArm async operation class.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.CheckNameAvailabilityResponseThe check availability result.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.ErrorDetailThe error detail.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.ExtensionExtension resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.FarmBeatsFarmBeats ARM Resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.FarmBeatsExtensionFarmBeats extension resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.FarmBeatsSolutionFarmBeats solution resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.FarmBeatsSolutionPropertiesFarmBeatsSolution properties.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.FarmBeatsUpdatePropertiesFarmBeats ARM Resource properties.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.FarmBeatsUpdateRequestModelFarmBeats update request.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.IdentityIdentity for the resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.InsightInsight.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.InsightAttachmentInsightAttachment.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.MarketplaceOfferDetailsMarketplaceOfferDetails.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.MeasureMeasure.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.PrivateEndpointThe private endpoint resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.PrivateLinkResourceA private link resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.PrivateLinkResourceListResultA list of private link resources.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.ResourceParameterResourceParameter.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.SensorIntegrationSensor integration request model.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.SolutionSolution resource.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.SolutionEvaluatedOutputSolutionEvaluatedOutput.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.models._models_py3.SolutionPropertiesSolution resource properties.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._extensions_operations.ExtensionsOperations..
method
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._extensions_operations.ExtensionsOperations.delete(resource_group_name:str, farm_beats_resource_name:str, extension_id:str, **kwargs:Any) -> NoneUninstall extension.
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._farm_beats_extensions_operations.FarmBeatsExtensionsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._farm_beats_models_operations.FarmBeatsModelsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._locations_operations.LocationsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._operations.Operations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._private_endpoint_connections_operations.PrivateEndpointConnectionsOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._private_link_resources_operations.PrivateLinkResourcesOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._solutions_discoverability_operations.SolutionsDiscoverabilityOperations..
class
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._solutions_operations.SolutionsOperations..
method
sdk.agrifood.azure-mgmt-agrifood.azure.mgmt.agrifood.operations._solutions_operations.SolutionsOperations.delete(resource_group_name:str, farm_beats_resource_name:str, **kwargs:Any) -> NoneUninstall Solution.
class
sdk.ai.azure-ai-agents.azure.ai.agents._client.AgentsClientAgentsClient.
class
sdk.ai.azure-ai-agents.azure.ai.agents._configuration.AgentsClientConfigurationConfiguration for AgentsClient.
method
sdk.ai.azure-ai-agents.azure.ai.agents._patch.AgentsClient.delete_agent(agent_id:str, **kwargs:Any) -> NoneDeletes an agent.
func
sdk.ai.azure-ai-agents.azure.ai.agents._patch.patch_sdk()Do not remove from this file.
func
sdk.ai.azure-ai-agents.azure.ai.agents._utils.model_base.serialize_xml(model:Model, exclude_readonly:bool=False) -> strSerialize a model to XML.
class
sdk.ai.azure-ai-agents.azure.ai.agents._utils.serialization.DeserializerResponse object model deserializer.
class
sdk.ai.azure-ai-agents.azure.ai.agents._utils.serialization.SerializerRequest object model serializer.
class
sdk.ai.azure-ai-agents.azure.ai.agents._utils.utils.ClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio._client.AgentsClientAgentsClient.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio._configuration.AgentsClientConfigurationConfiguration for AgentsClient.
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio._patch.AgentsClient.delete_agent(agent_id:str, **kwargs:Any) -> NoneDeletes an agent.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.FilesOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.FilesOperations.get(file_id:str, **kwargs:Any) -> _models.FileInfoReturns information about a specific file.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.MessagesOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.MessagesOperations.get(thread_id:str, message_id:str, **kwargs:Any) -> _models.ThreadMessageRetrieves an existing message.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.RunStepsOperations..
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.RunsOperations..
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.ThreadsOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.ThreadsOperations.get(thread_id:str, **kwargs:Any) -> _models.AgentThreadGets information about an existing thread.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.VectorStoreFileBatchesOperations..
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.VectorStoreFilesOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.VectorStoreFilesOperations.get(vector_store_id:str, file_id:str, **kwargs:Any) -> _models.VectorStoreFileRetrieves a vector store file.
class
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._operations.VectorStoresOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._patch.FilesOperations.delete(file_id:str, **kwargs:Any) -> NoneDelete a previously uploaded file.
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._patch.ThreadsOperations.delete(thread_id:str, **kwargs:Any) -> NoneDeletes an existing thread.
method
sdk.ai.azure-ai-agents.azure.ai.agents.aio.operations._patch.VectorStoreFilesOperations.delete(vector_store_id:str, file_id:str, **kwargs:Any) -> NoneDeletes a vector store file.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.FileStateThe state of the file.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.ImageDetailLevelSpecifies an image's detail level.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.IncompleteDetailsReasonThe reason why the run is incomplete.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.MessageStreamEventMessage operation related streaming events.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.OpenApiAuthTypeAuthentication type for OpenApi endpoint.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.ResponseFormatPossible API response formats.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.RunStepStatusPossible values for the status of a run step.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.RunStepStreamEventRun step operation related streaming events.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.RunStepTypeThe possible types of run steps.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.RunStreamEventRun operation related streaming events.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.ThreadStreamEventThread operation related streaming events.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.VectorStoreChunkingStrategyRequestTypeType of chunking strategy.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.VectorStoreChunkingStrategyResponseTypeType of chunking strategy.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.VectorStoreDataSourceAssetTypeType of vector storage asset.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.VectorStoreFileStatusVector store file status.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._enums.VectorStoreStatusVector store possible status.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.AISearchIndexResourceA AI Search Index resource.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.AgentDeletionStatusThe status of an agent deletion operation.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.AgentV1ErrorError payload returned by the agents API.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.AgentsNamedToolChoiceSpecifies a tool the model should use.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.AzureFunctionDefinitionThe definition of Azure function.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.AzureFunctionToolCallDetailsThe Azure function call description.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.BingCustomSearchConfigurationA bing custom search configuration.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.BingCustomSearchToolParametersThe bing custom search tool parameters.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ClickActionA click action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ComputerUseActionAn abstract representation of a computer use action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ComputerUseToolParametersThe computer use tool parameters.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.CoordinatePointA coordinate point with x and y values.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.DeepResearchDetailsThe details of the Deep Research tool.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.DoubleClickActionA double click action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.DragActionA drag action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.FabricDataAgentToolParametersThe fabric data agent tool parameters.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.FileSearchRankingOptionsRanking options for file search.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.FileSearchToolCallContentThe file search result content object.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.FunctionArgumentThe function argument and description.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.IncompleteRunDetailsDetails on why the run is incomplete.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.MessageDeltaChunkRepresents a message delta i.e.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.MoveActionA mouse move action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.RunCompletionUsageUsage statistics related to the run.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.RunStepCompletionUsageUsage statistics related to the run step.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.RunStepDeltaChunkRepresents a run step delta i.e.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.RunStepFileSearchToolCallResultFile search tool call result.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.RunStepFileSearchToolCallResultsThe results of the file search.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ScreenshotActionA screenshot action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ScrollActionA scroll action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ThreadDeletionStatusThe status of a thread deletion operation.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ToolConnectionA connection resource.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.ToolResourcesA set of resources that are used by the agent's tools.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.TypeActionAn action to type in text.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.UploadFileRequestUploadFileRequest.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.VectorStoreAutoChunkingStrategyRequestThe default strategy.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.VectorStoreExpirationPolicyThe expiration policy for a vector store.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._models.WaitActionA wait action.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.BaseFunctionToolA tool that executes user-defined functions.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.BaseFunctionTool.definitions() -> List[FunctionToolDefinition]Get the function definitions.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.BaseFunctionTool.resources() -> ToolResourcesGet the tool resources for the agent.
class
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.ConnectionToolA tool that requires connection ids.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.ConnectionTool.resources() -> ToolResourcesGet the connection tool resources.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.allow_tool(tool_name:str) -> NoneAdd a tool to the list of allowed tools.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.definitions() -> List[MCPToolDefinition]Get the MCP tool definition.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.disallow_tool(tool_name:str) -> NoneRemove a tool from the list of allowed tools.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.headers() -> Dict[str, str]Get the headers for the MCP tool.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.resources() -> ToolResourcesGet the tool resources for the agent.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.server_label() -> strGet the server label for the MCP tool.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.server_url() -> strGet the server URL for the MCP tool.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.set_approval_mode(require_approval:str) -> NoneUpdate the headers for the MCP tool.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.McpTool.update_headers(key:str, value:str) -> NoneUpdate the headers for the MCP tool.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.MessageDeltaChunk.text() -> strGet the text content of the delta chunk.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.Tool.definitions() -> List[ToolDefinitionT]Get the tool definitions.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.Tool.execute(tool_call:Any) -> AnyExecute the tool with the provided tool call.
method
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.Tool.resources() -> ToolResourcesGet the tool resources.
func
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.get_tool_definitions(tools:List['Tool']) -> List[ToolDefinition]Get the tool definitions from tools.
func
sdk.ai.azure-ai-agents.azure.ai.agents.models._patch.get_tool_resources(tools:List['Tool']) -> ToolResourcesGet the tool resources from tools.
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.FilesOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.FilesOperations.get(file_id:str, **kwargs:Any) -> _models.FileInfoReturns information about a specific file.
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.MessagesOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.MessagesOperations.get(thread_id:str, message_id:str, **kwargs:Any) -> _models.ThreadMessageRetrieves an existing message.
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.RunStepsOperations..
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.RunsOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.RunsOperations.cancel(thread_id:str, run_id:str, **kwargs:Any) -> _models.ThreadRunCancels a run of an in‐progress thread.
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.ThreadsOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.ThreadsOperations.get(thread_id:str, **kwargs:Any) -> _models.AgentThreadGets information about an existing thread.
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.VectorStoreFileBatchesOperations..
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.VectorStoreFilesOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.VectorStoreFilesOperations.get(vector_store_id:str, file_id:str, **kwargs:Any) -> _models.VectorStoreFileRetrieves a vector store file.
class
sdk.ai.azure-ai-agents.azure.ai.agents.operations._operations.VectorStoresOperations..
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._patch.FilesOperations.delete(file_id:str, **kwargs:Any) -> NoneDelete a previously uploaded file.
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._patch.ThreadsOperations.delete(thread_id:str, **kwargs:Any) -> NoneDeletes an existing thread.
method
sdk.ai.azure-ai-agents.azure.ai.agents.operations._patch.VectorStoreFilesOperations.delete(vector_store_id:str, file_id:str, **kwargs:Any) -> NoneDeletes a vector store file.
func
sdk.ai.azure-ai-agents.azure.ai.agents.telemetry._trace_function.async_wrapper(*args:Any, **kwargs:Any) -> AnyWrapper function for asynchronous functions.
func
sdk.ai.azure-ai-agents.azure.ai.agents.telemetry._trace_function.sanitize_for_attributes(value:Any, is_recursive:bool=False) -> AnySanitize a value to be used as an attribute.
func
sdk.ai.azure-ai-agents.azure.ai.agents.telemetry._trace_function.sync_wrapper(*args:Any, **kwargs:Any) -> AnyWrapper function for synchronous functions.
class
sdk.ai.azure-ai-inference.azure.ai.inference._client.ChatCompletionsClientChatCompletionsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference._client.EmbeddingsClientEmbeddingsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference._client.ImageEmbeddingsClientImageEmbeddingsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference._configuration.EmbeddingsClientConfigurationConfiguration for EmbeddingsClient.
func
sdk.ai.azure-ai-inference.azure.ai.inference._model_base.serialize_xml(model:Model, exclude_readonly:bool=False) -> strSerialize a model to XML.
class
sdk.ai.azure-ai-inference.azure.ai.inference._patch.ChatCompletionsClientChatCompletionsClient.
method
sdk.ai.azure-ai-inference.azure.ai.inference._patch.ChatCompletionsClient.get_model_info(**kwargs:Any) -> _models.ModelInfoReturns information about the AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference._patch.EmbeddingsClientEmbeddingsClient.
method
sdk.ai.azure-ai-inference.azure.ai.inference._patch.EmbeddingsClient.get_model_info(**kwargs:Any) -> _models.ModelInfoReturns information about the AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference._patch.ImageEmbeddingsClientImageEmbeddingsClient.
method
sdk.ai.azure-ai-inference.azure.ai.inference._patch.ImageEmbeddingsClient.get_model_info(**kwargs:Any) -> _models.ModelInfoReturns information about the AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference._serialization.DeserializerResponse object model deserializer.
class
sdk.ai.azure-ai-inference.azure.ai.inference._serialization.SerializerRequest object model serializer.
class
sdk.ai.azure-ai-inference.azure.ai.inference._vendor.ChatCompletionsClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-inference.azure.ai.inference._vendor.EmbeddingsClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-inference.azure.ai.inference._vendor.ImageEmbeddingsClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._client.ChatCompletionsClientChatCompletionsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._client.EmbeddingsClientEmbeddingsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._client.ImageEmbeddingsClientImageEmbeddingsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._configuration.EmbeddingsClientConfigurationConfiguration for EmbeddingsClient.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._patch.ChatCompletionsClientChatCompletionsClient.
method
sdk.ai.azure-ai-inference.azure.ai.inference.aio._patch.ChatCompletionsClient.get_model_info(**kwargs:Any) -> _models.ModelInfoReturns information about the AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._patch.EmbeddingsClientEmbeddingsClient.
method
sdk.ai.azure-ai-inference.azure.ai.inference.aio._patch.EmbeddingsClient.get_model_info(**kwargs:Any) -> _models.ModelInfoReturns information about the AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._patch.ImageEmbeddingsClientImageEmbeddingsClient.
method
sdk.ai.azure-ai-inference.azure.ai.inference.aio._patch.ImageEmbeddingsClient.get_model_info(**kwargs:Any) -> _models.ModelInfoReturns information about the AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._vendor.ChatCompletionsClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._vendor.EmbeddingsClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-inference.azure.ai.inference.aio._vendor.ImageEmbeddingsClientMixinABCDO NOT use this class.
class
sdk.ai.azure-ai-inference.azure.ai.inference.models._enums.EmbeddingEncodingFormatThe format of the embeddings result.
class
sdk.ai.azure-ai-inference.azure.ai.inference.models._enums.ModelTypeThe type of AI model.
class
sdk.ai.azure-ai-inference.azure.ai.inference.models._models.ImageEmbeddingInputRepresents an image with optional text.
class
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._invoker.InvokerExceptionException class for Invoker
class
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._invoker.InvokerFactoryFactory class for Invoker
class
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._mustache.ChevronErrorCustom exception for Chevron errors.
func
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._mustache.grab_literal(template:str, l_del:str) -> tuple[str, str]Parse a literal from the template.
func
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._mustache.parse_tag(template:str, l_del:str, r_del:str) -> tuple[tuple[str, str], str]Parse a tag from a template.
func
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._mustache.tokenize(template:str, def_ldel:str='{{', def_rdel:str='}}') -> Iterator[tuple[str, str]]Tokenize a mustache template.
class
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._parsers.PromptyChatParserPrompty Chat Parser
func
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._prompty_utils.load(prompty_file:Union[str, Path], configuration:str='default') -> PromptyLoad a prompty file.
class
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._renderers.MustacheRendererRender a mustache template.
func
sdk.ai.azure-ai-inference.azure.ai.inference.prompts._utils.remove_leading_empty_space(multiline_str:str) -> strProcesses a multiline string by: 1.
class
sdk.ai.azure-ai-projects.azure.ai.projects._client.AIProjectClientAIProjectClient.
class
sdk.ai.azure-ai-projects.azure.ai.projects._configuration.AIProjectClientConfigurationConfiguration for AIProjectClient.
class
sdk.ai.azure-ai-projects.azure.ai.projects._patch.AIProjectClientAIProjectClient.
func
sdk.ai.azure-ai-projects.azure.ai.projects._utils.model_base.serialize_xml(model:Model, exclude_readonly:bool=False) -> strSerialize a model to XML.
class
sdk.ai.azure-ai-projects.azure.ai.projects._utils.serialization.DeserializerResponse object model deserializer.
class
sdk.ai.azure-ai-projects.azure.ai.projects._utils.serialization.SerializerRequest object model serializer.
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio._client.AIProjectClientAIProjectClient.
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio._configuration.AIProjectClientConfigurationConfiguration for AIProjectClient.
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio._patch.AIProjectClientAIProjectClient.
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch.BetaOperations..
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_agents_async.AgentsOperations..
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_connections_async.ConnectionsOperations..
method
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_connections_async.ConnectionsOperations.get(name:str, *include_credentials:Optional[bool]=False, **kwargs:Any) -> ConnectionGet a connection by name.
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_datasets_async.DatasetsOperations..
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_evaluation_rules_async.EvaluationRulesOperations..
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_models_async.BetaModelsOperations..
class
sdk.ai.azure-ai-projects.azure.ai.projects.aio.operations._patch_telemetry_async.TelemetryOperations..
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AgentBlueprintReferenceTypeType of AgentBlueprintReferenceType.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AgentEndpointProtocolType of AgentEndpointProtocol.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AgentKindType of AgentKind.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AgentObjectTypeType of AgentObjectType.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AgentSessionStatusThe status of an agent session.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AgentStateThe operational state of an agent.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.AttackStrategyStrategies for attacks.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.ComputerEnvironmentType of ComputerEnvironment.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.ConnectionTypeThe Type (or category) of the connection.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.ContainerMemoryLimitType of ContainerMemoryLimit.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.ContainerSkillTypeType of ContainerSkillType.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.CredentialTypeThe credential type used by the connection.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.CustomToolParamFormatTypeType of CustomToolParamFormatType.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.DataGenerationJobTypeThe supported data generation job types.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.DatasetTypeEnum to determine the type of data.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.DayOfWeekDays of the week for recurrence schedule.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.DeploymentTypeType of DeploymentType.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluationLevelThe level at which evaluation is performed.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluationRuleActionTypeType of the evaluation action.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluationRuleEventTypeType of the evaluation rule event.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluationTaxonomyInputTypeType of the evaluation taxonomy input.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluatorCategoryThe category of the evaluator.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluatorDefinitionTypeThe type of evaluator definition.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluatorMetricTypeThe type of the evaluator.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.EvaluatorTypeThe type of the evaluator.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.FoundryModelArtifactProfileCategoryThe artifact profile category.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.FoundryModelSourceTypeThe source type of the model.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.FoundryModelWarningCodeWarning code for model artifacts.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.FoundryModelWeightTypeThe weight type of the model.
class
sdk.ai.azure-ai-projects.azure.ai.projects.models._enums.GrammarSyntax1Type of GrammarSyntax1.
About this data
These signatures were extracted from the public source of Azure/azure-sdk-for-python
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.