Skip to content

Commit 3be30e3

Browse files
authored
chore: docs review (#220)
* fixed links to other docs * fixed links * fix links * fix links * review and fix for links * fix links * add new demo video * fix links
1 parent 9af2dfd commit 3be30e3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+151
-192
lines changed

docs/Auth/2. Web/1.overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ JSON Web Token (JWT) is used for web authentication to securely transmit informa
88

99
1. Configure your identity service provider (IDP)
1010
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.
1212

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.
1414
1515
## Example
1616

1717
For example purposes, lets configure Microsoft Entra to work with AI DIAL as an identity service provider:
1818

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.
2323

docs/Auth/3. programmatic-auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ In the following example, `"myApiKey"` API key is created for a project `"MyProj
2828

2929
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.
3030

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.
3232
3333
Roles used by API keys must be declared in the `roles` section.
3434

3535
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.
3636

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.
3838

3939
**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`.
4040

docs/Deployment/Bedrock Model Deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ IAM (Identity and Access Management) users in AWS (Amazon Web Services) are enti
8080

8181
#### Assign to Service Account
8282

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.
8484

8585
> 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.
8686
@@ -94,7 +94,7 @@ Add your model with its parameters in the `models` section.
9494

9595
> Refer to [AI DIAL Core Configuration](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json#L30) to view an example.
9696
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.
9898
9999
### Configure AI DIAL Adapter
100100

docs/Deployment/OpenAI Model Deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ From this instruction, you will learn how to create an Azure OpenAI model GPT-3.
7171

7272
#### Configure Kubernetes Service Account
7373

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.
7575

7676
> 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.
7777
@@ -87,7 +87,7 @@ Add your model with its parameters in the `models` section.
8787

8888
> Refer to [AI DIAL Core Configuration](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json#L30) to view an example.
8989
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.
9191
9292
### Configure AI DIAL Adapter
9393

docs/Deployment/Vertex Model Deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ To communicate with VertexAI models, it is necessary to have a service account.
7676

7777
#### Configure Kubernetes Service Account
7878

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.
8080

8181
> 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.
8282
@@ -90,7 +90,7 @@ Add your model with its parameters in the `models` section.
9090

9191
> Refer to [AI DIAL Core Configuration](https://github.com/epam/ai-dial-core/blob/development/sample/aidial.config.json#L30) to view an example.
9292
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.
9494
9595
### Configure AI DIAL Adapter
9696

docs/Deployment/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ To work with Azure, AWS or GCP models, AI DIAL uses applications called Adapters
8787
You can modify adapters settings using environment variables.
8888

8989
> Refer to these repositories to learn how to configure adapters:
90-
> * [Bedrock Model Deployment](./Bedrock%20Model%20Deployment.md#configure-adapter)
91-
> * [OpenAI Model Deployment](./OpenAI%20Model%20Deployment.md#configure-adapter)
92-
> * [Vertex Model Deployment](./Vertex%20Model%20Deployment.md#configure-adapter)
90+
> * [Bedrock Model Deployment](/docs/Deployment/Bedrock%20Model%20Deployment.md)
91+
> * [OpenAI Model Deployment](/docs/Deployment/OpenAI%20Model%20Deployment.md)
92+
> * [Vertex Model Deployment](/docs/Deployment/Vertex%20Model%20Deployment.md)
9393
9494
## Assistant Parameters
9595

docs/Deployment/custom_apps_deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Follow steps described in this guide, to deploy your custom application using a Helm chart and integrate it with AI DIAL Core configuration.
66

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.
88
> * 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.
99
> * Refer to [DIAL Helm](https://github.com/epam/ai-dial-helm) to view deployment examples.
1010

docs/Roles and Access Control/1.overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ In AI DIAL, you can use **roles** for various purposes:
77
* Implement a custom logic in applications
88
* Give access to specific system features
99

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.
1111
1212
## Access to Resources
1313

@@ -25,7 +25,7 @@ In the following example, we grant access to `chat-gpt-35-turbo` model for users
2525
}
2626
```
2727

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.
2929
3030
## Access Restriction
3131

docs/Roles and Access Control/2.chat-users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ You can configure AI DIAL to work with various identity service providers, where
44

55
In the system configuration, you can then add rules and restrictions to manage access to your users to various system resources.
66

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.
88
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.
99

1010
**Important**: you must always use roles from the JWT claims that you receive from your IDP.

docs/Roles and Access Control/3.API Keys.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## API Keys
44

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.
66

77
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.
88

99
To create and configure access control for API keys:
1010

11-
1. [Create API Key](/Auth/programmatic-auth#step-1-define-api-keys)
12-
2. [Assign role(s)](/Auth/programmatic-auth#step-2-assign-roles)
11+
1. [Create API Key](/docs/Auth/3.%20programmatic-auth.md#step-1-define-api-keys)
12+
2. [Assign role(s)](/docs/Auth/3.%20programmatic-auth.md#step-2-assign-roles)
1313
3. Add restrictions:
1414

1515
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

Comments
 (0)