Skip to content

Commit 1cd9cd7

Browse files
authoredMar 13, 2025··
chore: useguide sync (#235)
* docs updates * docs updates * fix images * Update user-guide.md * docs review and useguide_sync * fix for images * fix for broken links
1 parent 748c2bb commit 1cd9cd7

38 files changed

+260
-39
lines changed
 

‎docs/img/app-builder.png

70.3 KB
Loading

‎docs/img/app-logs.png

55.5 KB
Loading

‎docs/img/code-app-builder.png

65.3 KB
Loading

‎docs/img/conv-info.png

7.08 KB
Loading

‎docs/img/mindmap.png

992 KB
Loading

‎docs/img/mindmap2.png

695 KB
Loading

‎docs/img/quick-app-builder.png

64.7 KB
Loading

‎docs/img/use-prompt.png

7.41 KB
Loading

‎docs/img/view-toggle.png

53.5 KB
Loading

‎docs/platform/0.architecture-and-concepts/1.concepts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In AI DIAL, an “application” is any programming logic that conforms to the U
1414
AI DIAL Chat users can engage with applications via standard or fully customized interfaces. Applications can interact via the Unified API or registered custom endpoints, enabling creation of complex scenarios and utilizing all AI DIAL features.
1515
You can expand the platform by introducing custom application types to build the applications you need, using the AI DIAL SDK to streamline the development process.
1616

17-
> Refer to [Applications](/docs/tutorials/0.user-guide.md#applications-1) to learn how to develop, add and manage apps in DIAL.
17+
> Refer to [Applications](/docs/tutorials/0.user-guide.md#applications) to learn how to develop, add and manage apps in DIAL.
1818
1919
## Application Server
2020

‎docs/platform/1.deployment-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ AI DIAL minimizes technical complexity and licensing risks by leveraging communi
2828

2929
#### Storage
3030

31-
Data portability is paramount. AI DIAL stores all user data in BLOB storage, simplifying cloud-to-cloud migrations. Furthermore, its decentralized design eliminates the need for a centralized database, relying instead on Redis and cloud storage solutions. This approach makes AI DIAL an ideal platform for building web-scale businesses.
31+
Data portability is paramount. AI DIAL stores all user data in BLOB storage, simplifying cloud-to-cloud migrations. Furthermore, its decentralized design eliminates the need for a centralized database, relying instead on Redis and cloud storage solutions. This approach makes AI DIAL an ideal platform for building web-scale solutions.
3232

3333
> Refer to [Persistent Layer](/docs/platform/0.architecture-and-concepts/3.components.md#persistent-layer) to learn more.
3434

‎docs/platform/2.supported-models.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Supported Models
22

3-
In this list, you can find models that we have tested and verified. We are committed to adding more and constantly update this list. You can use our OpenAI adapter to connect to a much wider spectrum of models compatible with OpenAI API.
4-
5-
> Refer to [OpenAI](https://github.com/epam/ai-dial-adapter-openai), [Bedrock](https://github.com/epam/ai-dial-adapter-bedrock/?tab=readme-ov-file#supported-models), [Vertex](https://github.com/epam/ai-dial-adapter-vertexai/?tab=readme-ov-file#supported-models) adapters to view more details about them and the supported models.
3+
AI DIAL allows you to access models from all major LLM providers, language models from the open-source community, alternative vendors, and fine-tuned micro models, as well as self-hosted or models listed on HuggingFace or DeepSeek.
64

75
You can use [DIAL SDK](https://github.com/epam/ai-dial-sdk) to create custom model adapters. Applications and model adapters implemented using this framework will be compatible with [AI DIAL API](https://dialx.ai/dial_api) that was designed based on [Azure OpenAI API](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference).
86

7+
## LLM Adapters
8+
9+
AI DIAL includes adapters for all major LLM providers such as Amazon Bedrock, Google Vertex AI, and Azure OpenAI:
10+
11+
> * [OpenAI](https://github.com/epam/ai-dial-adapter-openai)
12+
> * [Bedrock](https://github.com/epam/ai-dial-adapter-bedrock/?tab=readme-ov-file#supported-models)
13+
> * [Vertex](https://github.com/epam/ai-dial-adapter-vertexai/?tab=readme-ov-file#supported-models)
14+
15+
## Available Models
16+
17+
In this list, you can find models that we have tested and verified. We are committed to adding more and constantly update this list. You can use our OpenAI adapter to connect to a much wider spectrum of models compatible with OpenAI API.
18+
919
| Vendor | Models |
1020
| :-- | :-- |
1121
| AI21| ai21.j2-grande-instruct, ai21.j2-jumbo-instruct |
@@ -14,7 +24,7 @@ You can use [DIAL SDK](https://github.com/epam/ai-dial-sdk) to create custom mod
1424
| Cohere| cohere.command-text-v14 |
1525
| Databricks| databricks-bge-large-en, databricks-llama-2-70b-chat, databricks-mixtral-8x7b-instruct, databricks-dbrx-instruct |
1626
| E5| e5-large-v2 |
17-
| Google| chat-bison@001, chat-bison-32k@002, chat-bison, codechat-bison@001, codechat-bison-32k@002, codechat-bison, gemini-pro, gemini-pro-vision, gemini-1.5-pro-preview-0409, gemini-1.5-flash-001, textembedding-gecko@001, imagegeneration@005 |
27+
| Google| chat-bison@001, chat-bison-32k@002, chat-bison, codechat-bison@001, codechat-bison-32k@002, codechat-bison, gemini-pro, gemini-pro-vision, gemini-1.5-pro-preview-0409, gemini-1.5-flash-001, gemini-2.0-flash-exp, gemini-exp-1206, gemini-2.0-flash-thinking-exp-1219, textembedding-gecko@001, imagegeneration@005 |
1828
| Meta| meta.llama3-8b-instruct-v1, meta.llama3-70b-instruct-v1, meta.llama3, meta.llama2-13b-chat-v1, meta.llama2-70b-chat-v1, meta.llama2, CodeLlama-34b-Instruct-hf, Llama-3-8B-Instruct |
1929
| Mistral| Mistral-7B-Instruct, Mixtral-8x7B-Instruct-v0.1, mistral-large-azure |
2030
| OpenAI| gpt-35-turbo-0301, gpt-35-turbo-0613, gpt-35-turbo-1106, gpt-35-turbo-0125, gpt-35-turbo, gpt-35-turbo-16k, gpt-4-0613, gpt-4, gpt-4-1106-preview, gpt-4-0125-preview, gpt-4-turbo-2024-04-09, gpt-4-turbo, gpt-4-32k-0314, gpt-4-32k-0613, gpt-4-32k, gpt-4-vision-preview, gpt-4o-2024-05-13, dall-e-3, text-embedding-ada-002, text-embedding-3-large, text-embedding-3-small |

‎docs/platform/6.realtime-analytics-intro.md

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Examples of the computed artifacts:
2525
* Language of conversations.
2626
* Any other calculated statistics based on conversations.
2727

28+
## Configuration
29+
2830
> Refer to [Analytics Realtime Configuration](/docs/tutorials/2.devops/1.configuration/2.realtime-analytics-config.md) to see configuration guidelines.
2931
3032
## Disable Logging of User Information

‎docs/platform/7.collaboration-intro.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,19 @@ You can publish/unpublish conversations, prompts (or even a collection of those)
1919
> * Refer to [Enable Publications](/docs/tutorials/2.devops/1.configuration/1.enable-publications-chat.md) to learn how to enable and configured publications in AI DIAL Chat.
2020
> * Refer to [Publications](/docs/tutorials/1.developers/1.work-with-resources/0.work-with-publications.md) to see development tutorials.
2121
> * Refer to [User Guide](/docs/tutorials/0.user-guide.md#publications) to learn about this feature and how to use it in AI DIAL Chat.
22+
> * Refer to [Publication API](https://dialx.ai/dial_api#tag/Publications).
2223
2324
## Sharing
2425

2526
In AI DIAL, when a resource is created or uploaded from an external source, it is stored in a dedicated [storage bucket](/docs/platform/0.architecture-and-concepts/1.concepts.md#persistent-layer). You can share these resources with other users or applications. The sharing functionality is available through both the DIAL API and the AI DIAL Chat UI.
2627

2728
> * Refer to [Sharing](/docs/tutorials/1.developers/1.work-with-resources/1.sharing.md) to see development tutorials.
2829
> * Refer to [Conversations](/docs/tutorials/0.user-guide.md#share), [Prompts](/docs/tutorials/0.user-guide.md#share-1) to see user can share resources in AI DIAL Chat.
30+
> * Refer to [Sharing API](https://dialx.ai/dial_api#tag/Sharing).
2931
3032
## Notification
3133

3234
AI DIAL API support two slightly different types of notifications: notifications and subscribe. Notifications are user to notify about specific actions, e.g. when a publication request is approved. Subscriptions allows receiving notifications about changes such as DELETE, CREATE, UPDATE made to DIAL resources such as applications, files, conversations and prompts.
3335

34-
> Refer to [Notifications](/docs/tutorials/1.developers/1.work-with-resources/2.notifications.md) to see development tutorials.
36+
> * Refer to [Notifications](/docs/tutorials/1.developers/1.work-with-resources/2.notifications.md) to see development tutorials.
37+
> * Refer to [Notifications API](https://dialx.ai/dial_api#tag/Notifications).

0 commit comments

Comments
 (0)
Please sign in to comment.