Skip to content

Commit

Permalink
Improve docs (#4128)
Browse files Browse the repository at this point in the history
  • Loading branch information
ljupcovangelski authored Sep 26, 2023
1 parent 4b72cf2 commit aea7497
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/docs/connectors/conversational-ai/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import ButtonBox from "@site/src/components/ButtonBox";

Level up your channels' communication with Airy Core's conversational AI [connectors](/concepts/architecture#components).

Airy Core features conversational AI [connectors](/concepts/architecture#components) that you can easily install and configure on your instance.
Airy Core features conversational AI [connectors](/concepts/architecture#components) that you can easily install and configure on your instance. For all of the LLM connectors that Airy supports, please refer to our [Enterprise Docs](https://airy.co/docs/enterprise/).

<ButtonBoxList>
<ButtonBox
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Airy Core contains the following components:
icon={<ElectricPlugSVG />}
iconInvertible={true}
title='WebSockets to power real-time applications'
description="A WebSocket server that allows clients to receive near real-time updates about data flowing through the system."
description="A WebSocket server that allows clients to receive near real-time updates about data flowing through the system. Particularly useful in combination with our LLM connectors and apps, that can send real-time data to enrich the interaction your customers."
link='/api/websocket'
/>
<ButtonBox
Expand All @@ -64,7 +64,7 @@ Airy Core contains the following components:
icon={<DiamondSVG />}
iconInvertible={true}
title='UI: From a control center to dashboards'
description="No-code interfaces to manage and control Airy, your connectors and your streams."
description="No-code interfaces to manage and control Airy, your connectors, your LLM integrations and your streams. "
link='/ui/inbox/introduction'
/>
</ButtonBoxList>
Expand Down
26 changes: 22 additions & 4 deletions docs/docs/getting-started/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,21 +118,39 @@ A tag is a special use case of metadata, which is used to tag
common, Airy Core provides specialized endpoints and filters for tagging
conversations.

## AI & ML

## Large language model

A type of artificial intelligence model designed to understand and generate human-like text based on vast amounts of data. It's trained on diverse internet text to predict the next word in a sequence, enabling it to answer questions, generate content, and assist with various tasks. Airy allows a plug-able interface into different LLMs.

## Vector database

A high-dimensional database store which is suitable for persistent storage for natural language processing or images. The data is represented as vectors and retrieval is based on similarity, allowing for efficient similarity searches and context creation. Vector databases are very convenient for storing vector representations of streaming data that can be queried and add context to questions that are sent to LLMs, in real time.

## Automation

The ability of a an Airy component to react and simulate human-like conversations and automate specific tasks, in real time. It aims to provide users with immediate, consistent responses, reducing the need for human intervention in customer support, inquiries, and other conversational scenarios.

## Source

A source represents a system that generates messaging data that a user wants to
process with Airy Core.

## Stream

The whole Airy platform is based on Kafka and real-time streaming of messages. In the context of `streams` feature that Airy supports, a `stream` is the process of joining two or multiple Kafka topics, combining the data and creating an outout topic where the result of the streaming operation will be stored. It is based on KSQL.

### Provider

Source providers are API platforms that allow Airy Core to connect to one or
more of their sources typically via a webhook. E.g. Twilio is a source provider
for the Twilio SMS and WhatsApp sources.

## App

Third party open-source packages that can be installed alongside Airy, in the same Kubernetes cluster, to provide a more robust and powerful application development environment. These `Apps` can vary from databases (ex. PostgreSQL or Redis) to LLM implementations and vector databases (ex. Llama2 or FAISS).

## Stream

The whole Airy platform is based on Kafka and real-time streaming of messages. In the context of `streams` feature that Airy supports, a `stream` is the process of joining two or multiple Kafka topics, combining the data and creating an outout topic where the result of the streaming operation will be stored. It is based on KSQL.

## User

A user represents one authorized agent in Airy Core, which is different from a Contact
Expand Down
84 changes: 56 additions & 28 deletions lib/typescript/translations/translations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,19 @@ const resources = {
translation: {
//Components
chromaDescription: 'Chroma is a vector database that helps LLM applications to have long term memory.',
faissDescription: 'FAISS is a vector database that allows developers to quickly group and search embeddings of documents that are similar to each other.',
llama2Description: 'LLama2 is a large language model that can be downloaded and deployed in a self-hosted environment.',
mosaicDescription: 'Mosaic is an AI tool to easily train and deploy generative AI models on your data, in your secure environment.',
pineconeDescription: 'Pinecone is a fully managed vector database solution, used to store and search vector embeddings.',
weaviateDescription: 'Weaviate is an open-source vector database that allows storing object and vector embeddings from various ML-models.',
faissDescription:
'FAISS is a vector database that allows developers to quickly group and search embeddings of documents that are similar to each other.',
llama2Description:
'LLama2 is a large language model that can be downloaded and deployed in a self-hosted environment.',
mosaicDescription:
'Mosaic is an AI tool to easily train and deploy generative AI models on your data, in your secure environment.',
pineconeDescription:
'Pinecone is a fully managed vector database solution, used to store and search vector embeddings.',
weaviateDescription:
'Weaviate is an open-source vector database that allows storing object and vector embeddings from various ML-models.',
openaiDescription: 'The OpenAI connector is a bidirectional connector that connects Airy to the OpenAI LLM.',
gmailDescription: 'The GMail connector is a bidirectional connector for sending and receiving e-mail messages through the Google Mail API.',
gmailDescription:
'The GMail connector is a bidirectional connector for sending and receiving e-mail messages through the Google Mail API.',

//Input Component
fieldCannotBeEmpty: 'This field cannot be empty.',
Expand Down Expand Up @@ -607,14 +613,22 @@ const resources = {
de: {
translation: {
//Components
chromaDescription: 'Chroma ist eine Vektordatenbank, die LLM-Anwendungen dabei hilft, über ein Langzeitgedächtnis zu verfügen.',
faissDescription: 'FAISS ist eine Vektordatenbank, die es Entwicklern ermöglicht, Einbettungen von einander ähnlichen Dokumenten schnell zu gruppieren und zu durchsuchen.',
llama2Description: 'LLama2 ist ein großes Sprachmodell, das heruntergeladen und in einer selbst gehosteten Umgebung bereitgestellt werden kann.',
mosaicDescription: 'Mosaik ist ein KI-Tool zum einfachen Trainieren und Bereitstellen generativer KI-Modelle auf Ihren Daten in Ihrer sicheren Umgebung.',
pineconeDescription: 'Pinecone ist eine vollständig verwaltete Vektordatenbanklösung, die zum Speichern und Durchsuchen von Vektoreinbettungen verwendet wird.',
weaviateDescription: 'Weaviate ist eine Open-Source-Vektordatenbank, die das Speichern von Objekt- und Vektoreinbettungen aus verschiedenen ML-Modellen ermöglicht.',
openaiDescription: 'Der OpenAI-Connector ist ein bidirektionaler Connector, der Airy mit dem OpenAI LLM verbindet.',
gmailDescription: 'Der GMail-Connector ist ein bidirektionaler Connector zum Senden und Empfangen von E-Mail-Nachrichten über die Google Mail-API.',
chromaDescription:
'Chroma ist eine Vektordatenbank, die LLM-Anwendungen dabei hilft, über ein Langzeitgedächtnis zu verfügen.',
faissDescription:
'FAISS ist eine Vektordatenbank, die es Entwicklern ermöglicht, Einbettungen von einander ähnlichen Dokumenten schnell zu gruppieren und zu durchsuchen.',
llama2Description:
'LLama2 ist ein großes Sprachmodell, das heruntergeladen und in einer selbst gehosteten Umgebung bereitgestellt werden kann.',
mosaicDescription:
'Mosaik ist ein KI-Tool zum einfachen Trainieren und Bereitstellen generativer KI-Modelle auf Ihren Daten in Ihrer sicheren Umgebung.',
pineconeDescription:
'Pinecone ist eine vollständig verwaltete Vektordatenbanklösung, die zum Speichern und Durchsuchen von Vektoreinbettungen verwendet wird.',
weaviateDescription:
'Weaviate ist eine Open-Source-Vektordatenbank, die das Speichern von Objekt- und Vektoreinbettungen aus verschiedenen ML-Modellen ermöglicht.',
openaiDescription:
'Der OpenAI-Connector ist ein bidirektionaler Connector, der Airy mit dem OpenAI LLM verbindet.',
gmailDescription:
'Der GMail-Connector ist ein bidirektionaler Connector zum Senden und Empfangen von E-Mail-Nachrichten über die Google Mail-API.',

//Input Component
fieldCannotBeEmpty: 'Dieses Feld kann nicht leer sein.',
Expand Down Expand Up @@ -1220,14 +1234,21 @@ const resources = {
fr: {
translation: {
//Components
chromaDescription: 'Chroma est une base de données vectorielle qui aide les applications LLM à disposer d\'une mémoire à long terme.',
faissDescription: 'FAISS est une base de données vectorielle qui permet aux développeurs de regrouper et de rechercher rapidement des intégrations de documents similaires les uns aux autres.',
llama2Description: 'LLama2 est un grand modèle de langage qui peut être téléchargé et déployé dans un environnement auto-hébergé.',
mosaicDescription: 'Mosaic est un outil d\'IA permettant de former et de déployer facilement des modèles d\'IA génératifs sur vos données, dans votre environnement sécurisé.',
pineconeDescription: 'Pinecone est une solution de base de données vectorielle entièrement gérée, utilisée pour stocker et rechercher des intégrations vectorielles.',
weaviateDescription: 'Weaviate est une base de données vectorielles open source qui permet de stocker des intégrations d\'objets et de vecteurs à partir de divers modèles ML.',
chromaDescription:
"Chroma est une base de données vectorielle qui aide les applications LLM à disposer d'une mémoire à long terme.",
faissDescription:
'FAISS est une base de données vectorielle qui permet aux développeurs de regrouper et de rechercher rapidement des intégrations de documents similaires les uns aux autres.',
llama2Description:
'LLama2 est un grand modèle de langage qui peut être téléchargé et déployé dans un environnement auto-hébergé.',
mosaicDescription:
"Mosaic est un outil d'IA permettant de former et de déployer facilement des modèles d'IA génératifs sur vos données, dans votre environnement sécurisé.",
pineconeDescription:
'Pinecone est une solution de base de données vectorielle entièrement gérée, utilisée pour stocker et rechercher des intégrations vectorielles.',
weaviateDescription:
"Weaviate est une base de données vectorielles open source qui permet de stocker des intégrations d'objets et de vecteurs à partir de divers modèles ML.",
openaiDescription: 'Le connecteur OpenAI est un connecteur bidirectionnel qui connecte Airy au OpenAI LLM.',
gmailDescription: 'Le connecteur GMail est un connecteur bidirectionnel permettant d\'envoyer et de recevoir des messages électroniques via l\'API Google Mail.',
gmailDescription:
"Le connecteur GMail est un connecteur bidirectionnel permettant d'envoyer et de recevoir des messages électroniques via l'API Google Mail.",

//Input Component
fieldCannotBeEmpty: 'Ce champ ne peut pas être vide.',
Expand Down Expand Up @@ -1827,14 +1848,21 @@ const resources = {
es: {
translation: {
//Components
chromaDescription: 'Chroma es una base de datos vectorial que ayuda a las aplicaciones LLM a tener memoria a largo plazo.',
faissDescription: 'FAISS es una base de datos vectorial que permite a los desarrolladores agrupar y buscar rápidamente incrustaciones de documentos que son similares entre sí.',
llama2Description: 'LLama2 es un modelo de lenguaje grande que se puede descargar e implementar en un entorno autohospedado.',
mosaicDescription: 'Mosaic es una herramienta de IA para entrenar e implementar fácilmente modelos de IA generativos en sus datos, en su entorno seguro.',
pineconeDescription: 'Pinecone es una solución de base de datos de vectores totalmente administrada, que se utiliza para almacenar y buscar incrustaciones de vectores.',
weaviateDescription: 'Weaviate es una base de datos vectorial de código abierto que permite almacenar incrustaciones de objetos y vectores de varios modelos ML.',
chromaDescription:
'Chroma es una base de datos vectorial que ayuda a las aplicaciones LLM a tener memoria a largo plazo.',
faissDescription:
'FAISS es una base de datos vectorial que permite a los desarrolladores agrupar y buscar rápidamente incrustaciones de documentos que son similares entre sí.',
llama2Description:
'LLama2 es un modelo de lenguaje grande que se puede descargar e implementar en un entorno autohospedado.',
mosaicDescription:
'Mosaic es una herramienta de IA para entrenar e implementar fácilmente modelos de IA generativos en sus datos, en su entorno seguro.',
pineconeDescription:
'Pinecone es una solución de base de datos de vectores totalmente administrada, que se utiliza para almacenar y buscar incrustaciones de vectores.',
weaviateDescription:
'Weaviate es una base de datos vectorial de código abierto que permite almacenar incrustaciones de objetos y vectores de varios modelos ML.',
openaiDescription: 'El conector OpenAI es un conector bidireccional que conecta Airy con OpenAI LLM.',
gmailDescription: 'El conector GMail es un conector bidireccional para enviar y recibir mensajes de correo electrónico a través de la API de Google Mail.',
gmailDescription:
'El conector GMail es un conector bidireccional para enviar y recibir mensajes de correo electrónico a través de la API de Google Mail.',

//Input Component
fieldCannotBeEmpty: 'El campo de texto no puede estar vacío.',
Expand Down

0 comments on commit aea7497

Please sign in to comment.