Skip to content

Commit f658893

Browse files
sr-remshataa-epamakryvasheyeu
authored
chore: docs restructure (#229) (#231)
* chore: docs restructure (#229) * Update release.yml * Update docusaurus.config.js * docs restructure * edit config to pass broken links * docs review * Update docusaurus.config.js * docs review * restore github action workflow * restore docusaurus.config.js baseurl --------- Co-authored-by: sr-remsha <46220620+sr-remsha@users.noreply.github.com> Co-authored-by: sr-remsha <sr.remsha@gmail.com> * review * Update 3.per-request-keys.md --------- Co-authored-by: Andrey Teslya <andrey_teslya@epam.com> Co-authored-by: Aliaksei Kryvasheyeu <aliaksei_kryvasheyeu@epam.com>
1 parent 60b7525 commit f658893

File tree

499 files changed

+7834
-1033
lines changed

Some content is hidden

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

499 files changed

+7834
-1033
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Overview
2-
The [EPAM RAIL team](https://epam-rail.com/about-us) manages [DIAL](https://epam-rail.com/about-us) as a multi-repository project. DIAL is API-first and can function as a headless system. All components, except for DIAL CORE (which exposes APIs), are optional. Each component publishes its own artifacts, which can be used independently. Each component also has a designated owner. The DIAL platform is released as a stable assembly of its components in the form of Helm charts.
2+
The [EPAM RAIL team](https://dialx.ai/about-us) manages [DIAL](https://dialx.ai/about-us) as a multi-repository project. DIAL is API-first and can function as a headless system. All components, except for DIAL CORE (which exposes APIs), are optional. Each component publishes its own artifacts, which can be used independently. Each component also has a designated owner. The DIAL platform is released as a stable assembly of its components in the form of Helm charts.
33

44
This document provides general guidelines for contributing to the project. Please note that some repositories may contain additional, specific recommendations.
55

@@ -25,13 +25,13 @@ Here is the current list of repositories:
2525
- [DIAL AWS Bedrock Adapter](https://github.com/epam/ai-dial-adapter-bedrock) - plugable Amazon LLMs adapter (Anthropic Claude 1/2 is included)
2626
- More LLM adapters will be released (you may contribute)
2727

28-
Please see [repository map](https://epam-rail.com/open-source).
28+
Please see [repository map](https://dialx.ai/open-source).
2929

3030
# Project Vision
3131

3232
AI DIAL is a secure, enterprise-grade, free LLM orchestrator that is API-first and model-agnostic. It is designed to be cloud-agnostic, providing horizontal features that simplify interactions with various models and LLM-centric applications, as well as the development of LLM applications. We strive to avoid dependencies on specific cloud or LLM vendors, compromises on scalability or security, excessive expansion of our tech footprint, or potential licensing risks. We typically design features as APIs, which custom extensions can leverage.
3333

34-
The solution is domain-agnostic. We prioritize use case-agnostic generic features (such as rendering charts in the frontend based on model responses) over features that are overly specific to a single domain (like supporting medical anthologies). However, specific implementations can be built as extensions or derived works. For more information, refer to our [extension framework](https://epam-rail.com/extension-framework) and [API reference](https://epam-rail.com/dial_api).
34+
The solution is domain-agnostic. We prioritize use case-agnostic generic features (such as rendering charts in the frontend based on model responses) over features that are overly specific to a single domain (like supporting medical anthologies). However, specific implementations can be built as extensions or derived works. For more information, refer to our [extension framework](https://dialx.ai/extension-framework) and [API reference](https://dialx.ai/dial_api).
3535

3636
AI DIAL is a product that is designed to **enhance** or **extend**, rather than replace or compete with:
3737

@@ -42,11 +42,11 @@ AI DIAL is a product that is designed to **enhance** or **extend**, rather than
4242
- Application development frameworks including [LangChain](https://www.langchain.com/), [LlamaIndex](https://www.llamaindex.ai/) and [SemanticKernel](https://github.com/microsoft/semantic-kernel)
4343
- Low-code application designers like [Flowise](https://flowiseai.com/)
4444

45-
We aim to complement these services, streamlining the development, deployment, and operation of GenAI applications, as well as facilitating the [interoperability](https://docs.epam-rail.com/architecture#introduction) of various applications to achieve specific business objectives. For this purpose we provide:
45+
We aim to complement these services, streamlining the development, deployment, and operation of GenAI applications, as well as facilitating the [interoperability](https://docs.dialx.ai/platform/architecture-and-concepts/architecture) of various applications to achieve specific business objectives. For this purpose we provide:
4646

47-
- [Unified API](https://epam-rail.com/dial_api) to access multimodal models, assistants, applications, and embedding models.
48-
- Essential services such as resilient file/chat/prompt//model [storage](https://docs.epam-rail.com/architecture#persistent-layer) with user-based [access control](https://docs.epam-rail.com/Roles%20and%20Access%20Control/overview).
49-
- Important operational features, including [sharing](https://epam-rail.com/dial_api#tag/Sharing), organization-wide [publications](https://epam-rail.com/dial_api#tag/Publications), [review processes](https://docs.epam-rail.com/tutorials/Collaboration/enable-publications#admin-flow), and [rate limits](https://docs.epam-rail.com/architecture#rate-limits--cost-control).
47+
- [Unified API](https://dialx.ai/dial_api) to access multimodal models, assistants, applications, and embedding models.
48+
- Essential services such as resilient file/chat/prompt//model [storage](https://docs.dialx.ai/platform/architecture-and-concepts/components#persistent-layer) with user-based [access control](https://docs.dialx.ai/platform/core/access-control-intro).
49+
- Important operational features, including [sharing](https://dialx.ai/dial_api#tag/Sharing), organization-wide [publications](https://dialx.ai/dial_api#tag/Publications), [review processes](https://docs.dialx.ai/tutorials/developers/work-with-resources/work-with-publications), and [rate limits](https://docs.dialx.ai/platform/architecture-and-concepts/components#rate-limits--cost-control).
5050

5151
## Feature Validation Checklist
5252

README.md

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,64 @@
22

33
## Project Overview and Contribution Guide
44

5-
* [Contribution Guide](/CONTRIBUTING.md)
5+
* [Contribution Guide](https://github.com/epam/ai-dial/blob/main/CONTRIBUTING.md)
6+
7+
## Architecture
8+
9+
* [Architecture Overview](docs/platform/0.architecture-and-concepts/2.architecture.md)
610

711
## Quick Start
812

9-
* [Quick Start Guide](./docs/quick-start.md)
13+
* [Quick Start Guide](./quick-start.md)
1014

1115
> Refer to [AI DIAL Chat Repository](https://github.com/epam/ai-dial-chat#overview) to learn how to launch AI DIAL Chat with default configurations.
1216
13-
## Helm Deployment
17+
## Run AI DIAL Locally
1418

15-
* [AI DIAL Generic Installation Simple Guide](https://github.com/epam/ai-dial-helm/tree/main/charts/dial/examples/generic/simple)
19+
* [Launch AI DIAL Chat with an Azure model](/docs/tutorials/1.developers/0.local-run/1.quick-start-model.md)
20+
* [Launch AI DIAL Chat with a self-hosted model](/docs/tutorials/1.developers/0.local-run/3.quick-start-with-self-hosted-model.md)
21+
* [Launch AI DIAL Chat with a sample application](/docs/tutorials/1.developers/0.local-run/0.quick-start-with-application.md)
22+
* [Launch AI DIAL Chat with a sample addon](/docs/tutorials/1.developers/0.local-run/4.quick-start-with-addon.md)
1623

17-
## Tutorials
24+
## Helm Deployment
1825

19-
* [Launch AI DIAL Chat with an Azure model](./docs/tutorials/quick-start-model.md)
20-
* [Launch AI DIAL Chat with a self-hosted model](./docs/tutorials/quick-start-with-self-hosted-model.md)
21-
* [Launch AI DIAL Chat with a Sample Application](./docs/tutorials/quick-start-with-application.md)
22-
* [Launch AI DIAL Chat with a Sample Addon](./docs/tutorials/quick-start-with-addon.md)
26+
* [AI DIAL Generic Installation Simple Guide](https://github.com/epam/ai-dial-helm/tree/main/charts/dial/examples/generic/simple)
27+
* [GCP Installation](https://github.com/epam/ai-dial-helm/blob/main/charts/dial/examples/gcp/complete/README.md)
28+
* [Azure Installation](https://github.com/epam/ai-dial-helm/blob/main/charts/dial/examples/azure/simple/README.md)
29+
* [AWS Installation](https://github.com/epam/ai-dial-helm/blob/main/charts/dial/examples/aws/complete/README.md)
2330

24-
## Development Guides
31+
## Configuration
2532

26-
* [A basic guide for development of applications for AI DIAL](https://github.com/epam/ai-dial/blob/main/docs/tutorials/quick-start-with-application.md)
33+
* Refer to [Configuration](./tutorials/2.devops/1.configuration/0.configuration-guide.md) to see configuration guidelines for AI DIAL components.
2734

2835
## AI DIAL Chat Application User Manual
2936

30-
* [AI DIAL Chat User Manual](./docs/user-guide.md)
31-
32-
## Configuration
33-
34-
* Refer to [Configuration](./docs/Deployment/configuration.md)
37+
* [AI DIAL Chat User Manual](/docs/tutorials/0.user-guide.md)
3538

3639
## Other AI DIAL Project Open Source Repositories
3740

38-
Here is the current list of repositories where you can find more details. You can also refer to [repository map](https://epam-rail.com/open-source).
41+
Here is the current list of repositories where you can find more details.
42+
43+
> You can also refer to the [open source repository map](https://dialx.ai/open-source) on the AI DIAL website.
3944
4045
- [DIAL Helm](https://github.com/epam/ai-dial-helm) - helm chart, find stable assemblies here.
41-
- [DIAL Core](https://github.com/epam/ai-dial-core) - the main component that exposes API.
42-
- [DIAL SDK](https://github.com/epam/ai-dial-sdk) - development kit for applications and model adapters.
43-
- [DIAL Chat](https://github.com/epam/ai-dial-chat) - default UI.
44-
- [DIAL Chat Themes](https://github.com/epam/ai-dial-chat-themes) - static content and UI customizations for default UI.
45-
- [DIAL CI](https://github.com/epam/ai-dial-ci) - github CI commons.
46+
- [DIAL Core](https://github.com/epam/ai-dial-core) - the main component that exposes API
47+
- [DIAL SDK](https://github.com/epam/ai-dial-sdk) - development kit for applications and model adapters
48+
- [DIAL Interceptors Python SDK](https://github.com/epam/ai-dial-interceptors-sdk) - framework for creating DIAL Interceptors in Python for chat completion and embedding models.
49+
- [DIAL Chat](https://github.com/epam/ai-dial-chat) - default UI
50+
- [DIAL Overlay](https://github.com/epam/ai-dial-chat/blob/development/libs/overlay/README.md) - a library for using AI DIAL Chat in an overlay format
51+
- [DIAL Chat Themes](https://github.com/epam/ai-dial-chat-themes) - static content and UI customizations for default UI
52+
- [Visualizer Connector](https://github.com/epam/ai-dial-chat/blob/development/libs/chat-visualizer-connector/README.md) - a library for connecting custom visualizers
53+
- [DIAL CI](https://github.com/epam/ai-dial-ci) - github CI commons
4654
- [DIAL Assistant](https://github.com/epam/ai-dial-assistant) - model agnostic assistant/addon implementation for DIAL. It allows to use self-hosted OpenAI plugins as DIAL addons.
47-
- [DIAL Analytics Realtime](https://github.com/epam/ai-dial-analytics-realtime) - simple real-time usage analytics. That transforms logs into InfluxDB metrics.
55+
- [DIAL Analytics Realtime](https://github.com/epam/ai-dial-analytics-realtime) - simple real-time usage analytics. That transforms logs into InfluxDB metrics
4856
- [DIAL Auth Helper](https://github.com/epam/ai-dial-auth-helper) - AuthProxy is a proxy service that implements OpenID-compatible Web API endpoints to avoid direct interaction with the AuthProviders' APIs, such as the KeyCloak API.
57+
_ [App Controller](https://github.com/epam/ai-dial-app-controller) - a Java-based web service application that orchestrates the building and deployment of Python applications in Kubernetes.
58+
- [App Builder](https://github.com/epam/ai-dial-app-builder-python) - a Python-based application designed to download source code from AI DIAL file storage and prepare files to build a container image.
59+
- [Python Code Interpreter](https://github.com/epam/ai-dial-code-interpreter) - uses Jupiter Kernel to execute arbitrary python code.
60+
- [DIAL-to-DIAL Adapter](https://github.com/epam/ai-dial-adapter-dial) - adapter for a local development against a remote AI DIAL Core.
4961
- Model adapters:
50-
- [DIAL Azure OpenAI Adapter](https://github.com/epam/ai-dial-adapter-openai) - plugable Azure ChatGPT adapter.
51-
- [DIAL GCP VertexAI Adapter](https://github.com/epam/ai-dial-adapter-vertexai) - plugable Google LLMs adapter.
52-
- [DIAL AWS Bedrock Adapter](https://github.com/epam/ai-dial-adapter-bedrock) - plugable Amazon LLMs adapter (Anthropic Claude 1/2 is included).
53-
- [AI DIAL Adapter](https://github.com/epam/ai-dial-adapter-dial) - application which adapts calls from one DIAL Core to calls to another DIAL Core.
54-
- More LLM adapters will be released (you may contribute).
62+
- [DIAL Azure OpenAI Adapter](https://github.com/epam/ai-dial-adapter-openai) - plugable Azure ChatGPT adapter
63+
- [DIAL GCP VertexAI Adapter](https://github.com/epam/ai-dial-adapter-vertexai) - plugable Google LLMs adapter
64+
- [DIAL AWS Bedrock Adapter](https://github.com/epam/ai-dial-adapter-bedrock) - plugable Amazon LLMs adapter (Anthropic Claude 1/2 is included)
65+
- More LLM adapters will be released (you may contribute)

dial-cookbook/examples/how_to_call_image_to_text_applications.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# How to call image-to-text DIAL applications\n",
88
"\n",
9-
"From this notebook, you will learn how to call image-to-text DIAL applications via [DIAL API chat/completions](https://epam-rail.com/dial_api#/paths/~1openai~1deployments~1%7BDeployment%20Name%7D~1chat~1completions/post) call.\n",
9+
"From this notebook, you will learn how to call image-to-text DIAL applications via [DIAL API chat/completions](https://dialx.ai/dial_api#/paths/~1openai~1deployments~1%7BDeployment%20Name%7D~1chat~1completions/post) call.\n",
1010
"\n",
1111
"\n",
1212
"https://github.com/epam/ai-dial/blob/main/dial-cookbook/examples/how_to_call_image_to_text_applications.ipynb\n",

dial-cookbook/examples/how_to_call_text_to_image_applications.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# How to call text-to-image DIAL applications\n",
88
"\n",
9-
"From this notebook, you will learn how to call text-to-image applications via [DIAL API chat/completions](https://epam-rail.com/dial_api#/paths/~1openai~1deployments~1%7BDeployment%20Name%7D~1chat~1completions/post) call.\n",
9+
"From this notebook, you will learn how to call text-to-image applications via [DIAL API chat/completions](https://dialx.ai/dial_api#/paths/~1openai~1deployments~1%7BDeployment%20Name%7D~1chat~1completions/post) call.\n",
1010
"\n",
1111
"\n",
1212
"https://github.com/epam/ai-dial/blob/main/dial-cookbook/examples/how_to_call_text_to_image_applications.ipynb\n",

docs/Auth/1. overview.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

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

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)