You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/ai/Azure.AI.Inference/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Azure Inference client library for .NET
2
2
3
-
The client Library (in preview) does inference, including chat completions, for AI models deployed by [Azure AI Studio](https://ai.azure.com) and [Azure Machine Learning Studio](https://ml.azure.com/). It supports Serverless API endpoints and Managed Compute endpoints (formerly known as Managed Online Endpoints). The client library makes services calls using REST API version `2024-05-01-preview`, as documented in [Azure AI Model Inference API](https://learn.microsoft.com/azure/ai-studio/reference/reference-model-inference-api). For more information see [Overview: Deploy models, flows, and web apps with Azure AI Studio](https://learn.microsoft.com/azure/ai-studio/concepts/deployments-overview).
3
+
The client library (in preview) does inference, including chat completions, for AI models deployed by [Azure AI Foundry](https://ai.azure.com) and [Azure Machine Learning Studio](https://ml.azure.com/). It supports Serverless API endpoints and Managed Compute endpoints (formerly known as Managed Online Endpoints). The client library makes services calls using REST API version `2024-05-01-preview`, as documented in [Azure AI Model Inference API](https://learn.microsoft.com/azure/ai-studio/reference/reference-model-inference-api). For more information see [Overview: Deploy AI models in Azure AI Foundry portal](https://learn.microsoft.com/azure/ai-studio/concepts/deployments-overview).
4
4
5
5
Use the model inference client library to:
6
6
@@ -23,7 +23,7 @@ With some minor adjustments, this client library can also be configured to do in
23
23
### Prerequisites
24
24
25
25
* An [Azure subscription](https://azure.microsoft.com/free).
26
-
* An [AI Model from the catalog](https://ai.azure.com/explore/models) deployed through Azure AI Studio.
26
+
* An [AI Model from the catalog](https://ai.azure.com/explore/models) deployed through Azure AI Foundry.
27
27
* To construct the client library, you will need to pass in the endpoint URL. The endpoint URL has the form `https://your-host-name.your-azure-region.inference.ai.azure.com`, where `your-host-name` is your unique model deployment host name and `your-azure-region` is the Azure region where the model is deployed (e.g. `eastus2`).
28
28
* Depending on your model deployment and authentication preference, you either need a key to authenticate against the service, or Entra ID credentials. The key is a 32-character string.
Copy file name to clipboardExpand all lines: sdk/ai/Azure.AI.Projects/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
Use the AI Projects client library to:
3
3
4
4
***Develop Agents using the Azure AI Agent Service**, leveraging an extensive ecosystem of models, tools, and capabilities from OpenAI, Microsoft, and other LLM providers. The Azure AI Agent Service enables the building of Agents for a wide range of generative AI use cases. The package is currently in preview.
5
-
***Enumerate connections** in your Azure AI Studio project and get connection properties. For example, get the inference endpoint URL and credentials associated with your Azure OpenAI connection.
5
+
***Enumerate connections** in your Azure AI Foundry project and get connection properties. For example, get the inference endpoint URL and credentials associated with your Azure OpenAI connection.
Copy file name to clipboardExpand all lines: sdk/ai/Azure.AI.Projects/src/Custom/AIProjectClient.cs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ namespace Azure.AI.Projects
13
13
publicpartialclassAIProjectClient
14
14
{
15
15
/// <summary> Initializes a new instance of AzureAIClient. </summary>
16
-
/// <param name="connectionString">The Azure AI Studio project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
16
+
/// <param name="connectionString">The Azure AI Foundry project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
17
17
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
18
18
/// <exception cref="ArgumentNullException"> <paramref name="connectionString"/> is null. </exception>
@@ -24,7 +24,7 @@ public partial class AIProjectClient
24
24
/// <summary>
25
25
/// Initializes a new instance of AzureAIClient.
26
26
/// </summary>
27
-
/// <param name="connectionString">The Azure AI Studio project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
27
+
/// <param name="connectionString">The Azure AI Foundry project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
28
28
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
29
29
/// <param name="options"> The options for configuring the client. </param>
30
30
/// <exception cref="ArgumentNullException"> <paramref name="connectionString"/> is null. </exception>
Copy file name to clipboardExpand all lines: sdk/ai/Azure.AI.Projects/src/Custom/Agent/AgentsClient.cs
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ namespace Azure.AI.Projects
21
21
publicpartialclassAgentsClient
22
22
{
23
23
/// <summary> Initializes a new instance of AzureAIClient. </summary>
24
-
/// <param name="connectionString">The Azure AI Studio project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
24
+
/// <param name="connectionString">The Azure AI Foundry project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
25
25
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
26
26
/// <exception cref="ArgumentNullException"> <paramref name="connectionString"/> is null. </exception>
@@ -32,7 +32,7 @@ public partial class AgentsClient
32
32
/// <summary>
33
33
/// Initializes a new instance of AzureAIClient.
34
34
/// </summary>
35
-
/// <param name="connectionString">The Azure AI Studio project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
35
+
/// <param name="connectionString">The Azure AI Foundry project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
36
36
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
37
37
/// <param name="options"> The options for configuring the client. </param>
38
38
/// <exception cref="ArgumentNullException"> <paramref name="connectionString"/> is null. </exception>
@@ -48,10 +48,10 @@ public AgentsClient(string connectionString, TokenCredential credential, AIProje
48
48
}
49
49
50
50
/// <summary> Initializes a new instance of AzureAIClient. </summary>
51
-
/// <param name="endpoint"> The Azure AI Studio project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
51
+
/// <param name="endpoint"> The Azure AI Foundry project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
52
52
/// <param name="subscriptionId"> The Azure subscription ID. </param>
53
53
/// <param name="resourceGroupName"> The name of the Azure Resource Group. </param>
54
-
/// <param name="projectName"> The Azure AI Studio project name. </param>
54
+
/// <param name="projectName"> The Azure AI Foundry project name. </param>
55
55
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
56
56
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="subscriptionId"/>, <paramref name="resourceGroupName"/>, <paramref name="projectName"/> or <paramref name="credential"/> is null. </exception>
57
57
/// <exception cref="ArgumentException"> <paramref name="subscriptionId"/>, <paramref name="resourceGroupName"/> or <paramref name="projectName"/> is an empty string, and was expected to be non-empty. </exception>
@@ -60,10 +60,10 @@ public AgentsClient(string connectionString, TokenCredential credential, AIProje
60
60
}
61
61
62
62
/// <summary> Initializes a new instance of AzureAIClient. </summary>
63
-
/// <param name="endpoint"> The Azure AI Studio project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
63
+
/// <param name="endpoint"> The Azure AI Foundry project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
64
64
/// <param name="subscriptionId"> The Azure subscription ID. </param>
65
65
/// <param name="resourceGroupName"> The name of the Azure Resource Group. </param>
66
-
/// <param name="projectName"> The Azure AI Studio project name. </param>
66
+
/// <param name="projectName"> The Azure AI Foundry project name. </param>
67
67
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
68
68
/// <param name="options"> The options for configuring the client. </param>
69
69
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="subscriptionId"/>, <paramref name="resourceGroupName"/>, <paramref name="projectName"/> or <paramref name="credential"/> is null. </exception>
Copy file name to clipboardExpand all lines: sdk/ai/Azure.AI.Projects/src/Custom/Connection/ConnectionsClient.cs
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ namespace Azure.AI.Projects
16
16
publicpartialclassConnectionsClient
17
17
{
18
18
/// <summary> Initializes a new instance of AzureAIClient. </summary>
19
-
/// <param name="connectionString">The Azure AI Studio project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
19
+
/// <param name="connectionString">The Azure AI Foundry project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
20
20
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
21
21
/// <exception cref="ArgumentNullException"> <paramref name="connectionString"/> is null. </exception>
@@ -27,7 +27,7 @@ public partial class ConnectionsClient
27
27
/// <summary>
28
28
/// Initializes a new instance of AzureAIClient.
29
29
/// </summary>
30
-
/// <param name="connectionString">The Azure AI Studio project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
30
+
/// <param name="connectionString">The Azure AI Foundry project connection string, in the form `endpoint;subscription_id;resource_group_name;project_name`.</param>
31
31
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
32
32
/// <param name="options"> The options for configuring the client. </param>
33
33
/// <exception cref="ArgumentNullException"> <paramref name="connectionString"/> is null. </exception>
@@ -43,10 +43,10 @@ public ConnectionsClient(string connectionString, TokenCredential credential, AI
43
43
}
44
44
45
45
/// <summary> Initializes a new instance of AzureAIClient. </summary>
46
-
/// <param name="endpoint"> The Azure AI Studio project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
46
+
/// <param name="endpoint"> The Azure AI Foundry project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
47
47
/// <param name="subscriptionId"> The Azure subscription ID. </param>
48
48
/// <param name="resourceGroupName"> The name of the Azure Resource Group. </param>
49
-
/// <param name="projectName"> The Azure AI Studio project name. </param>
49
+
/// <param name="projectName"> The Azure AI Foundry project name. </param>
50
50
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
51
51
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="subscriptionId"/>, <paramref name="resourceGroupName"/>, <paramref name="projectName"/> or <paramref name="credential"/> is null. </exception>
52
52
/// <exception cref="ArgumentException"> <paramref name="subscriptionId"/>, <paramref name="resourceGroupName"/> or <paramref name="projectName"/> is an empty string, and was expected to be non-empty. </exception>
@@ -55,10 +55,10 @@ public ConnectionsClient(string connectionString, TokenCredential credential, AI
55
55
}
56
56
57
57
/// <summary> Initializes a new instance of AzureAIClient. </summary>
58
-
/// <param name="endpoint"> The Azure AI Studio project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
58
+
/// <param name="endpoint"> The Azure AI Foundry project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
59
59
/// <param name="subscriptionId"> The Azure subscription ID. </param>
60
60
/// <param name="resourceGroupName"> The name of the Azure Resource Group. </param>
61
-
/// <param name="projectName"> The Azure AI Studio project name. </param>
61
+
/// <param name="projectName"> The Azure AI Foundry project name. </param>
62
62
/// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
63
63
/// <param name="options"> The options for configuring the client. </param>
64
64
/// <exception cref="ArgumentNullException"> <paramref name="endpoint"/>, <paramref name="subscriptionId"/>, <paramref name="resourceGroupName"/>, <paramref name="projectName"/> or <paramref name="credential"/> is null. </exception>
/// <param name="clientDiagnostics"> The handler for diagnostic messaging in the client. </param>
87
87
/// <param name="pipeline"> The HTTP pipeline for sending and receiving REST requests and responses. </param>
88
88
/// <param name="tokenCredential"> The token credential to copy. </param>
89
-
/// <param name="endpoint"> The Azure AI Studio project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
89
+
/// <param name="endpoint"> The Azure AI Foundry project endpoint, in the form `https://<azure-region>.api.azureml.ms` or `https://<private-link-guid>.<azure-region>.api.azureml.ms`, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link. </param>
90
90
/// <param name="subscriptionId"> The Azure subscription ID. </param>
91
91
/// <param name="resourceGroupName"> The name of the Azure Resource Group. </param>
92
-
/// <param name="projectName"> The Azure AI Studio project name. </param>
92
+
/// <param name="projectName"> The Azure AI Foundry project name. </param>
93
93
/// <param name="apiVersion"> The API version to use for this operation. </param>
0 commit comments