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: docs/Auth/2. Web/1.overview.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,16 @@ JSON Web Token (JWT) is used for web authentication to securely transmit informa
8
8
9
9
1. Configure your identity service provider (IDP)
10
10
2. Configure AI DIAL Core and Chat to work with your IDP
11
-
3. (Optional) Further, you can create roles and permission in AI DIAL for your users. Refer to [Chat Users](/Roles%20and%20Access%20Control/chat-users) to learn how to do this.
11
+
3. (Optional) Further, you can create roles and permission in AI DIAL for your users. Refer to [Chat Users](/docs/Roles%20and%20Access%20Control/2.chat-users.md) to learn how to do this.
12
12
13
-
> Refer to [Auth0](./IDPs/auth0), [AWS Cognito](./IDPs/cognito), [MS Entra](./IDPs/entraID), [Google Identity](./IDPs/google), [Keycloak](./IDPs/keycloak), [Okta](./IDPs/okta) to view how to enable them as an identity and access management solution for AI DIAL users.
13
+
> Refer to [Auth0](/docs/Auth/2.%20Web/2.IDPs/auth0.md), [AWS Cognito](/docs/Auth/2.%20Web/2.IDPs/cognito.md), [MS Entra](/docs/Auth/2.%20Web/2.IDPs/entraID.md), [Google Identity](/docs/Auth/2.%20Web/2.IDPs/google.md), [Keycloak](/docs/Auth/2.%20Web/2.IDPs/keycloak.md), [Okta](/docs/Auth/2.%20Web/2.IDPs/okta.md) to view how to enable them as an identity and access management solution for AI DIAL users.
14
14
15
15
## Example
16
16
17
17
For example purposes, lets configure Microsoft Entra to work with AI DIAL as an identity service provider:
18
18
19
-
1.[Configure Microsoft Entra](/Auth/Web/IDPs/entraID#configure-microsoft-entra-id): create application, client secret, and user group.
20
-
2.[Configure AI DIAL Chat](/Auth/Web/IDPs/entraID#ai-dial-chat-settings) to work with MS Entra.
21
-
3.[Configure AI DIAL Core](/Auth/Web/IDPs/entraID#ai-dial-core-settings) to work with MS Entra.
22
-
4. (Optional) You can now create and assign roles and limits to manage access control of your users to various system resources such as applications, models, assistants and addons. Refer to [Create and assign roles](/Auth/Web/IDPs/entraID#assignment-of-roles) to learn more. Refer to [Roles & Access Control](/Roles%20and%20Access%20Control/overview) to learn more about roles and how to use them.
19
+
1.[Configure Microsoft Entra](/docs/Auth/2.%20Web/2.IDPs/entraID.md#configure-microsoft-entra-id): create application, client secret, and user group.
20
+
2.[Configure AI DIAL Chat](/docs/Auth/2.%20Web/2.IDPs/entraID.md#ai-dial-chat-settings) to work with MS Entra.
21
+
3.[Configure AI DIAL Core](/docs/Auth/2.%20Web/2.IDPs/entraID.md#ai-dial-core-settings) to work with MS Entra.
22
+
4. (Optional) You can now create and assign roles and limits to manage access control of your users to various system resources such as applications, models, assistants and addons. Refer to [Create and assign roles](/docs/Auth/2.%20Web/2.IDPs/entraID.md#assignment-of-roles) to learn more. Refer to [Roles & Access Control](/docs/Roles%20and%20Access%20Control/1.overview.md) to learn more about roles and how to use them.
Copy file name to clipboardExpand all lines: docs/Auth/3. programmatic-auth.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
@@ -28,13 +28,13 @@ In the following example, `"myApiKey"` API key is created for a project `"MyProj
28
28
29
29
API keys must be associated with roles. Such roles are used to manage access to system resources and restrict the number of requests that can be sent to them.
30
30
31
-
> Refer to [Roles](/Roles%20and%20Access%20Control/overview) to learn more how to use roles.
31
+
> Refer to [Roles](/docs/Roles%20and%20Access%20Control/1.overview.md) to learn more how to use roles.
32
32
33
33
Roles used by API keys must be declared in the `roles` section.
34
34
35
35
In the previous example, we assigned the `default` role for `myApiKey` API key. On this step, we need to declare the `default` role in the `roles` section to make a valid configuration.
36
36
37
-
Optionally, we can configure limits for this role, or leave them empty to apply an unlimited access. In this example, we grant an unlimited access for the `default` role to the `chat-gpt-35-turbo` model. You can refer to [Roles & Access Control](/Roles%20and%20Access%20Control/API%20Keys) to learn how to define access limits for API keys.
37
+
Optionally, we can configure limits for this role, or leave them empty to apply an unlimited access. In this example, we grant an unlimited access for the `default` role to the `chat-gpt-35-turbo` model. You can refer to [Roles & Access Control](/docs/Roles%20and%20Access%20Control/3.API%20Keys.md) to learn how to define access limits for API keys.
38
38
39
39
**Note**, that it is mandatory to define at least one role and assign it for an API key, but you can leave `limits` empty (as shown in the previous example) to apply the default value - `unlimited`.
Copy file name to clipboardExpand all lines: docs/Deployment/Bedrock Model Deployment.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
@@ -80,7 +80,7 @@ IAM (Identity and Access Management) users in AWS (Amazon Web Services) are enti
80
80
81
81
#### Assign to Service Account
82
82
83
-
In case your cluster is located at AWS, the best practise for using Bedrock is to assign an IAM Policy to your Service Account. You can do this via IAM Roles.
83
+
In case your cluster is located at AWS, the best practice for using Bedrock is to assign an IAM Policy to your Service Account. You can do this via IAM Roles.
84
84
85
85
> Refer to [AWS Documentation](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html) to learn how to configure an IAM roles for service accounts.
86
86
@@ -94,7 +94,7 @@ Add your model with its parameters in the `models` section.
94
94
95
95
> Refer to [AI DIAL Core Configuration](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json#L30) to view an example.
96
96
97
-
> Refer to [Configure core config](./configuration.md#core-parameters) to view the configuration of AI DIAL core parameters in the helm-based installation.
97
+
> Refer to [Configure core config](/docs/Deployment/configuration.md#core-parameters) to view the configuration of AI DIAL core parameters in the helm-based installation.
Copy file name to clipboardExpand all lines: docs/Deployment/OpenAI Model Deployment.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
@@ -71,7 +71,7 @@ From this instruction, you will learn how to create an Azure OpenAI model GPT-3.
71
71
72
72
#### Configure Kubernetes Service Account
73
73
74
-
In case your cluster is located at Azure, the best practise for using Azure OpenAI is to assign an Azure user-assigned managed identity to Kubernetes Service Account. You can do this using Microsoft Entra Workload ID with Azure Kubernetes Service.
74
+
In case your cluster is located at Azure, the best practice for using Azure OpenAI is to assign an Azure user-assigned managed identity to Kubernetes Service Account. You can do this using Microsoft Entra Workload ID with Azure Kubernetes Service.
75
75
76
76
> Refer to [Azure Documentation](https://learn.microsoft.com/en-us/azure/aks/workload-identity-overview) to learn how to configure Microsoft Entra Workload ID with Azure Kubernetes Service.
77
77
@@ -87,7 +87,7 @@ Add your model with its parameters in the `models` section.
87
87
88
88
> Refer to [AI DIAL Core Configuration](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json#L30) to view an example.
89
89
90
-
> Refer to [Configure core config](./configuration.md#core-parameters) to view the configuration of AI DIAL core parameters in the helm-based installation.
90
+
> Refer to [Configure core config](/docs/Deployment/configuration.md#core-parameters) to view the configuration of AI DIAL core parameters in the helm-based installation.
Copy file name to clipboardExpand all lines: docs/Deployment/Vertex Model Deployment.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
@@ -76,7 +76,7 @@ To communicate with VertexAI models, it is necessary to have a service account.
76
76
77
77
#### Configure Kubernetes Service Account
78
78
79
-
In case your cluster is located at GCP, the best practise for using VertexAI is to assign a GCP IAM service account to Kubernetes Service Account. You can do this via Workload Identity Federation for GKE.
79
+
In case your cluster is located at GCP, the best practice for using VertexAI is to assign a GCP IAM service account to Kubernetes Service Account. You can do this via Workload Identity Federation for GKE.
80
80
81
81
> Refer to [GCP Documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) to learn how to configure a Workload Identity Federation for GKE.
82
82
@@ -90,7 +90,7 @@ Add your model with its parameters in the `models` section.
90
90
91
91
> Refer to [AI DIAL Core Configuration](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json#L30) to view an example.
92
92
93
-
> Refer to [Configure core config](./configuration.md#core-parameters) to view the configuration of AI DIAL core parameters in the helm-based installation.
93
+
> Refer to [Configure core config](/docs/Deployment/configuration.md#core-parameters) to view the configuration of AI DIAL core parameters in the helm-based installation.
Copy file name to clipboardExpand all lines: docs/Deployment/custom_apps_deployment.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
@@ -4,7 +4,7 @@
4
4
5
5
Follow steps described in this guide, to deploy your custom application using a Helm chart and integrate it with AI DIAL Core configuration.
6
6
7
-
> * Refer to [User Guide](../user-guide#applications-1) to learn about DIAL apps.
7
+
> * Refer to [User Guide](/docs/user-guide.md#applications-1) to learn about DIAL apps.
8
8
> * Refer to [DIAL Core dynamic setting](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json) to learn how to add apps to config.
9
9
> * Refer to [DIAL Helm](https://github.com/epam/ai-dial-helm) to view deployment examples.
Copy file name to clipboardExpand all lines: docs/Roles and Access Control/1.overview.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
@@ -7,7 +7,7 @@ In AI DIAL, you can use **roles** for various purposes:
7
7
* Implement a custom logic in applications
8
8
* Give access to specific system features
9
9
10
-
> Watch a [demo video](../video%20demos/demos/dial-roles-and-rate-limits) to learn more.
10
+
> Watch a [demo video](/docs/video%20demos/demos/3.dial-roles-and-rate-limits.md) to learn more.
11
11
12
12
## Access to Resources
13
13
@@ -25,7 +25,7 @@ In the following example, we grant access to `chat-gpt-35-turbo` model for users
25
25
}
26
26
```
27
27
28
-
> Refer to [configuration example](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json) to view the full example and to [Chat Users](/Roles%20and%20Access%20Control/chat-users) to learn how to configure access for chat users and to [API Keys](/Roles%20and%20Access%20Control/API%20Keys) to learn how to configure access for applications.
28
+
> Refer to [configuration example](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json) to view the full example and to [Chat Users](/docs/Roles%20and%20Access%20Control/2.chat-users.md) to learn how to configure access for chat users and to [API Keys](/docs/Roles%20and%20Access%20Control/3.API%20Keys.md) to learn how to configure access for applications.
Copy file name to clipboardExpand all lines: docs/Roles and Access Control/2.chat-users.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
@@ -4,7 +4,7 @@ You can configure AI DIAL to work with various identity service providers, where
4
4
5
5
In the system configuration, you can then add rules and restrictions to manage access to your users to various system resources.
6
6
7
-
1. For chat users, you can define user groups/roles/pools (it depends on a specific IDP) in your identity service provider (IDP) which are then passed to AI DIAL in JWT. Refer to [Auth](/Auth/Web/overview) to view supported IDPs and learn how to configure them.
7
+
1. For chat users, you can define user groups/roles/pools (it depends on a specific IDP) in your identity service provider (IDP) which are then passed to AI DIAL in JWT. Refer to [Auth](/docs/Auth/2.%20Web/1.overview.md) to view supported IDPs and learn how to configure them.
8
8
2. You can then utilize user roles from the JWT claims to define roles in the AI DIAL configuration as a `userRoles` parameter value. In the following example, we grant access to `chat-gpt-35-turbo` model for users with the `operator` user role. Using the same pattern, you can define user access to applications, addons, assistants.
9
9
10
10
**Important**: you must always use roles from the JWT claims that you receive from your IDP.
Copy file name to clipboardExpand all lines: docs/Roles and Access Control/3.API Keys.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
3
3
## API Keys
4
4
5
-
API keys can be used not only for [authentication](/Auth/programmatic-auth), but also to manage access to system resources and apply restrictions on such access.
5
+
API keys can be used not only for [authentication](/docs/Auth/3.%20programmatic-auth.md), but also to manage access to system resources and apply restrictions on such access.
6
6
7
7
This is done via assigning of **roles** to API keys. Roles must be associated with specific system resources such as models, applications, addons and assistants.
8
8
9
9
To create and configure access control for API keys:
10
10
11
-
1.[Create API Key](/Auth/programmatic-auth#step-1-define-api-keys)
Roles used by API keys must be declared in the `roles` section. In the following example, we assign the `basic` role for `projectKey1` API key. It grants access to the `chat-gpt-35-turbo` model with some restrictions:
0 commit comments