Skip to content

Commit 2474431

Browse files
committed
Renamed GenAI Suite to AI Services across all files, including endpoints; renamed Services folder to Reference; fix all broken links
1 parent 80fb229 commit 2474431

File tree

36 files changed

+132
-132
lines changed

36 files changed

+132
-132
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ Inner shortcode
367367
Tags let you display badges, usually below a headline.
368368

369369
This is mainly used for pointing out if a feature is only available in the
370-
GenAI Suite, the Data Platform, the Arango Managed Platform (AMP), or multiple
370+
AI Services, the Data Platform, the Arango Managed Platform (AMP), or multiple
371371
of them. See [Environment remarks](#environment-remarks) for details.
372372

373373
It is also used for [Edition remarks](#edition-remarks) in content before
@@ -677,15 +677,15 @@ Pages and sections about features that are only available in certain environment
677677
such as in ArangoDB Shell should indicate where they are available using the
678678
`tag` shortcode.
679679

680-
Features exclusive to the Data Platform, GenAI Data Platform,
680+
Features exclusive to the Data Platform, AI Services Data Platform,
681681
Arango Managed Platform (AMP), and ArangoDB generally don't need to be tagged
682682
because they are in dedicated parts of the documentation. However, if there are
683683
subsections with different procedures, each can be tagged accordingly.
684684

685-
In the GenAI Data Platform only:
685+
In the AI Services Data Platform only:
686686

687687
```markdown
688-
{{< tag "GenAI Data Platform" >}}
688+
{{< tag "AI Services Data Platform" >}}
689689
```
690690

691691
In the Arango Managed Platform only:

site/content/gen-ai/_index.md renamed to site/content/ai-services/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: GenAI Suite
3-
menuTitle: GenAI Suite
2+
title: AI Services
3+
menuTitle: AI Services
44
weight: 2
55
description: >-
66
A comprehensive AI solution that transforms your data into intelligent knowledge graphs with GraphRAG capabilities, applies advanced machine learning with GraphML, and provides enterprise-grade tools for analytics, natural language querying, and AI-powered insights, all through an intuitive web interface
77
---
88

99
## What's included
1010

11-
The GenAI Suite is comprised of two major components:
11+
AI Services are comprised of two major components:
1212

1313
- [**GraphRAG**](./graphrag/_index.md): A complete solution for extracting entities
1414
from text files to create a knowledge graph that you can then query with a
@@ -27,10 +27,10 @@ Alongside these components, you also get the following additional features:
2727
interactive notebooks for experimentation and development of applications
2828
that use ArangoDB as their backend.
2929
- **Public and private LLM support**: Use public LLMs such as OpenAI
30-
or private LLMs with [Triton Inference Server](services/triton-inference-server.md).
31-
- [**MLflow integration**](services/mlflow.md): Use the popular MLflow as a model registry for private LLMs
30+
or private LLMs with [Triton Inference Server](reference/triton-inference-server.md).
31+
- [**MLflow integration**](reference/mlflow.md): Use the popular MLflow as a model registry for private LLMs
3232
or to run machine learning experiments as part of the Arango Data Platform.
3333
- **Application Programming Interfaces**: Use the underlying APIs of the
34-
GenAI Suite services and build your own integrations. See the
34+
AI Services and build your own integrations. See the
3535
[API reference](https://arangoml.github.io/platform-dss-api/GenAI-Service/proto/index.html) documentation
3636
for more details.

site/content/gen-ai/graph-analytics.md renamed to site/content/ai-services/graph-analytics.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ How to perform the steps is detailed in the subsequent sections.
4444
1. Determine the approximate size of the data that you will load into the GAE
4545
and ensure the machine to run the engine on has sufficient memory. The data as well as the
4646
temporarily needed space for computations and results needs to fit in memory.
47-
2. [Start a `graphanalytics` service](#start-a-graphanalytics-service) via the GenAI service
47+
2. [Start a `graphanalytics` service](#start-a-graphanalytics-service) via the AI service
4848
that manages various Platform components for graph intelligence and machine learning.
4949
It only takes a few seconds until the engine service can be used. The engine
5050
runs adjacent to the pods of the ArangoDB Core.
@@ -90,7 +90,7 @@ Single server deployments using ArangoDB version 3.11 are not supported.
9090

9191
{{< tab "Arango Data Platform" >}}
9292
You can use any of the available authentication methods the Arango Data Platform
93-
supports to start and stop `graphanalytics` services via the GenAI service as
93+
supports to start and stop `graphanalytics` services via the AI service as
9494
well as to authenticate requests to the [Engine API](#engine-api).
9595

9696
- HTTP Basic Authentication
@@ -129,30 +129,30 @@ setting in ArangoGraph:
129129

130130
The interface for managing the engines depends on the environment you use:
131131

132-
- **Arango Data Platform**: [GenAI service](#genai-service)
132+
- **Arango Data Platform**: [AI service](#ai-service)
133133
- **ArangoGraph**: [Management API](#management-api)
134134

135-
### GenAI service
135+
### AI service
136136

137-
{{< tag "GenAI Data Platform" >}}
137+
{{< tag "AI Services Data Platform" >}}
138138

139-
GAEs are deployed and deleted via the [GenAI service](services/gen-ai.md)
139+
GAEs are deployed and deleted via the [AI service](reference/gen-ai.md)
140140
in the Arango Data Platform.
141141

142142
If you use cURL, you need to use the `-k` / `--insecure` option for requests
143143
if the Platform deployment uses a self-signed certificate (default).
144144

145145
#### Start a `graphanalytics` service
146146

147-
`POST <ENGINE_URL>/gen-ai/v1/graphanalytics`
147+
`POST <ENGINE_URL>/ai/v1/graphanalytics`
148148

149-
Start a GAE via the GenAI service with an empty request body:
149+
Start a GAE via the AI service with an empty request body:
150150

151151
```sh
152152
# Example with a JWT session token
153153
ADB_TOKEN=$(curl -sSk -d '{"username":"root", "password": ""}' -X POST https://127.0.0.1:8529/_open/auth | jq -r .jwt)
154154

155-
Service=$(curl -sSk -H "Authorization: bearer $ADB_TOKEN" -X POST https://127.0.0.1:8529/gen-ai/v1/graphanalytics)
155+
Service=$(curl -sSk -H "Authorization: bearer $ADB_TOKEN" -X POST https://127.0.0.1:8529/ai/v1/graphanalytics)
156156
ServiceID=$(echo "$Service" | jq -r ".serviceInfo.serviceId")
157157
if [[ "$ServiceID" == "null" ]]; then
158158
echo "Error starting gral engine"
@@ -164,21 +164,21 @@ echo "$Service" | jq
164164

165165
#### List the services
166166

167-
`POST <ENGINE_URL>/gen-ai/v1/list_services`
167+
`POST <ENGINE_URL>/ai/v1/list_services`
168168

169-
You can list all running services managed by the GenAI service, including the
169+
You can list all running services managed by the AI service, including the
170170
`graphanalytics` services:
171171

172172
```sh
173-
curl -sSk -H "Authorization: bearer $ADB_TOKEN" -X POST https://127.0.0.1:8529/gen-ai/v1/list_services | jq
173+
curl -sSk -H "Authorization: bearer $ADB_TOKEN" -X POST https://127.0.0.1:8529/ai/v1/list_services | jq
174174
```
175175

176176
#### Stop a `graphanalytics` service
177177

178-
Delete the desired engine via the GenAI service using the service ID:
178+
Delete the desired engine via the AI service using the service ID:
179179

180180
```sh
181-
curl -sSk -H "Authorization: bearer $ADB_TOKEN" -X DELETE https://127.0.0.1:8529/gen-ai/v1/service/$ServiceID | jq
181+
curl -sSk -H "Authorization: bearer $ADB_TOKEN" -X DELETE https://127.0.0.1:8529/ai/v1/service/$ServiceID | jq
182182
```
183183

184184
### Management API
@@ -314,7 +314,7 @@ To determine the base URL of the engine API, use the base URL of the Platform
314314
deployment and append `/gral/<SERVICE_ID>`, e.g.
315315
`https://127.0.0.1:8529/gral/arangodb-gral-tqcge`.
316316

317-
The service ID is returned by the call to the GenAI service for
317+
The service ID is returned by the call to the AI service for
318318
[starting the `graphanalytics` service](#start-a-graphanalytics-service).
319319
You can also list the service IDs like so:
320320

site/content/gen-ai/graph-to-ai.md renamed to site/content/ai-services/graph-to-ai.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ menuTitle: From Graph to AI
44
weight: 25
55
description: >-
66
ArangoDB's set of tools and technologies enables analytics, machine learning,
7-
and GenAI applications powered by graph data
7+
and AI applications powered by graph data
88
aliases:
99
- data-science/overview
1010
---
1111

1212
{{< tip >}}
13-
The Arango Data Platform & GenAI Suite is available as a pre-release. To get
13+
The Arango Data Platform & AI Services are available as a pre-release. To get
1414
exclusive early access, [get in touch](https://arangodb.com/contact/) with
1515
the ArangoDB team.
1616
{{< /tip >}}
@@ -20,7 +20,7 @@ data science applications. The core database system includes multi-model storage
2020
of information with scalable graph and information retrieval capabilities that
2121
you can directly use for your research and product development.
2222

23-
ArangoDB also offers a dedicated GenAI Suite, using the database core
23+
ArangoDB also offers dedicated AI Services, using the database core
2424
as the foundation for higher-level features. Whether you want to turbocharge
2525
generative AI applications with a GraphRAG solution or apply analytics and
2626
machine learning to graph data at scale, ArangoDB covers these needs.

site/content/gen-ai/graphml/_index.md renamed to site/content/ai-services/graphml/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases:
88
- arangographml
99
---
1010
{{< tip >}}
11-
The Arango Data Platform & GenAI Suite is available as a pre-release. To get
11+
The Arango Data Platform & AI Services are available as a pre-release. To get
1212
exclusive early access, [get in touch](https://arangodb.com/contact/) with
1313
the ArangoDB team.
1414
{{< /tip >}}
File renamed without changes.
File renamed without changes.

site/content/gen-ai/graphml/ui.md renamed to site/content/ai-services/graphml/ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ giving you a clear path from data to prediction:
2222
To create a new GraphML project using the Arango Data Platform web interface, follow these steps:
2323

2424
1. From the left-hand sidebar, select the database where you want to create the project.
25-
2. In the left-hand sidebar, click **GenAI Suite** to open the GraphML project management interface, then click **Run GraphML**.
25+
2. In the left-hand sidebar, click **AI Services** to open the GraphML project management interface, then click **Run GraphML**.
2626
![Create GraphML Project](../../images/create-graphml-project-ui.png)
2727
3. In the **GraphML projects** view, click **Add new project**.
2828
4. The **Create ML project** modal opens. Enter a **Name** for your machine learning project.

site/content/gen-ai/graphrag/_index.md renamed to site/content/ai-services/graphrag/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ menuTitle: GraphRAG
44
weight: 5
55
description: >-
66
ArangoDB's GraphRAG solution combines graph-based retrieval-augmented generation
7-
with Large Language Models (LLMs) for turbocharged GenAI solutions
7+
with Large Language Models (LLMs) for turbocharged AI solutions
88
aliases:
99
llm-knowledge-graphs
1010
---
1111
{{< tip >}}
12-
The Arango Data Platform & GenAI Suite is available as a pre-release. To get
12+
The Arango Data Platform & AI Services are available as a pre-release. To get
1313
exclusive early access, [get in touch](https://arangodb.com/contact/) with
1414
the ArangoDB team.
1515
{{< /tip >}}
@@ -56,5 +56,5 @@ relationships and connections becoming more sophisticated over time.
5656
- **[GraphRAG Tutorial using integrated Notebook servers](tutorial-notebook.md)**: Follow hands-on examples and implementation guidance via Jupyter Notebooks.
5757

5858
For deeper implementation details, explore the individual services:
59-
- **[Importer Service](../services/importer.md)**: Transform documents into knowledge graphs.
60-
- **[Retriever Service](../services/retriever.md)**: Query and extract insights from your knowledge graphs.
59+
- **[Importer Service](../reference/importer.md)**: Transform documents into knowledge graphs.
60+
- **[Retriever Service](../reference/retriever.md)**: Query and extract insights from your knowledge graphs.

site/content/gen-ai/graphrag/technical-overview.md renamed to site/content/ai-services/graphrag/technical-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >-
99
{{< tag "ArangoDB Platform" >}}
1010

1111
{{< tip >}}
12-
The ArangoDB Platform & GenAI Suite is available as a pre-release. To get
12+
The ArangoDB Platform & AI Services are available as a pre-release. To get
1313
exclusive early access, [get in touch](https://arangodb.com/contact/) with
1414
the ArangoDB team.
1515
{{< /tip >}}
@@ -34,7 +34,7 @@ ArangoDB's unique capabilities and flexible integration of knowledge graphs and
3434
LLMs provide a powerful and efficient solution for anyone seeking to extract
3535
valuable insights from diverse datasets.
3636

37-
The GraphRAG component of the GenAI Suite brings all the capabilities
37+
The GraphRAG component of AI Services brings all the capabilities
3838
together with an easy-to-use interface, so you can make the knowledge accessible
3939
to your organization.
4040

@@ -76,7 +76,7 @@ information in a structured graph format, allowing efficient querying and retrie
7676
3. Store the generated Knowledge Graph in the database for retrieval and reasoning.
7777

7878
For detailed information about the service, see the
79-
[Importer](../services/importer.md) service documentation.
79+
[Importer](../reference/importer.md) service documentation.
8080

8181
### Extract information from the Knowledge Graph
8282

@@ -87,7 +87,7 @@ You can extract information from Knowledge Graphs using two distinct methods:
8787
- Local retrieval
8888

8989
For detailed information about the service, see the
90-
[Retriever](../services/retriever.md) service documentation.
90+
[Retriever](../reference/retriever.md) service documentation.
9191

9292
#### Global retrieval
9393

@@ -134,7 +134,7 @@ collection, and then it expands that subgraph over related entities, relations
134134

135135
If you're working in an air-gapped environment or need to keep your data
136136
private, you can use the private LLM mode with
137-
[Triton Inference Server](../services/triton-inference-server.md).
137+
[Triton Inference Server](../reference/triton-inference-server.md).
138138

139139
This option allows you to run the service completely within your own
140140
infrastructure. The Triton Inference Server is a crucial component when

0 commit comments

Comments
 (0)