update startup parameters in genai service; add project_db_name in project creation; move and extend Projects

Author: nerpaula

site/content/3.12/data-science/graphrag/services/gen-ai.md

@@ -35,22 +35,15 @@ in the platform. All services support the `profiles` field, which you can use
 to define the profile to use for the service. For example, you can define a
 GPU profile that enables the service to run an LLM on GPU resources.
 
-## LLM Host Service Creation Request Body
+## Service Creation Request Body
 
-```json
-{
-    "env": {
-        "model_name": "<registered_model_name>"
-    }
-}
-```
-
-## Using Labels in Creation Request Body
+The following example shows a complete request body with all available options:
 
 ```json
 {
     "env": {
-        "model_name": "<registered_model_name>"
+        "model_name": "<registered_model_name>",
+        "profiles": "gpu,internal"
     },
     "labels": {
         "key1": "value1",
@@ -59,32 +52,116 @@ GPU profile that enables the service to run an LLM on GPU resources.
 }
 ```
 
-{{< info >}}
-Labels are optional. Labels can be used to filter and identify services in
-the Platform. If you want to use labels, define them as a key-value pair in `labels`
-within the `env` field.
-{{< /info >}}
+**Optional fields:**
+
+- **labels**: Key-value pairs used to filter and identify services in the platform.
+- **profiles**: A comma-separated string defining which profiles to use for the 
+  service (e.g., `"gpu,internal"`). If not set, the service is created with the 
+  default profile. Profiles must be present and created in the platform before 
+  they can be used.
+
+The parameters required for the deployment of each service are defined in the
+corresponding service documentation. See [Importer](importer.md)
+and [Retriever](retriever.md).
+
+## Projects
+
+Projects help you organize your GraphRAG work by grouping related services and 
+keeping your data separate. When the Importer service creates ArangoDB collections 
+(such as documents, chunks, entities, relationships, and communities), it uses 
+your project name as a prefix. For example, a project named `docs` will have 
+collections like `docs_Documents`, `docs_Chunks`, and so on.
 
-## Using Profiles in Creation Request Body
+### Creating a project
+
+To create a new GraphRAG project, send a POST request to the project endpoint:
+
+```bash
+curl -X POST "https://<ExternalEndpoint>:8529/gen-ai/v1/project" \
+  -H "Authorization: Bearer <your-bearer-token>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "project_name": "docs",
+    "project_type": "graphrag",
+    "project_db_name": "documentation",
+    "project_description": "A documentation project for GraphRAG."
+  }'
+```
+
+Where:
+- **project_name** (required): Unique identifier for your project. Must be 1-63 
+  characters and contain only letters, numbers, underscores (`_`), and hyphens (`-`).
+- **project_type** (required): Type of project (e.g., `"graphrag"`).
+- **project_db_name** (required): The ArangoDB database name where the project 
+  will be created.
+- **project_description** (optional): A description of your project.
+
+Once created, you can reference your project in service deployments using the 
+`genai_project_name` field:
 
 ```json
 {
-    "env": {
-        "model_name": "<registered_model_name>",
-        "profiles": "gpu,internal"
-    }
+  "env": {
+    "genai_project_name": "docs"
+  }
 }
 ```
 
-{{< info >}}
-The `profiles` field is optional. If it is not set, the service is created with
-the default profile. Profiles must be present and created in the Platform before
-they can be used. If you want to use profiles, define them as a comma-separated
-string in `profiles` within the `env` field.
-{{< /info >}}
+### Listing projects
 
-The parameters required for the deployment of each service are defined in the
-corresponding service documentation.
+**List all project names in a database:**
+
+```bash
+curl -X GET "https://<ExternalEndpoint>:8529/gen-ai/v1/all_project_names/<database_name>" \
+  -H "Authorization: Bearer <your-bearer-token>"
+```
+
+This returns only the project names for quick reference.
+
+**List all projects with full metadata in a database:**
+
+```bash
+curl -X GET "https://<ExternalEndpoint>:8529/gen-ai/v1/all_projects/<database_name>" \
+  -H "Authorization: Bearer <your-bearer-token>"
+```
+
+This returns complete project objects including metadata, associated services, 
+and knowledge graph information.
+
+### Getting project details
+
+Retrieve comprehensive metadata for a specific project:
+
+```bash
+curl -X GET "https://<ExternalEndpoint>:8529/gen-ai/v1/project_by_name/<database_name>/<project_name>" \
+  -H "Authorization: Bearer <your-bearer-token>"
+```
+
+The response includes:
+- Project configuration
+- Associated Importer and Retriever services
+- Knowledge graph metadata
+- Service status information
+- Last modification timestamp
+
+### Deleting a project
+
+Remove a project's metadata from the GenAI service:
+
+```bash
+curl -X DELETE "https://<ExternalEndpoint>:8529/gen-ai/v1/project/<database_name>/<project_name>" \
+  -H "Authorization: Bearer <your-bearer-token>"
+```
+
+{{< warning >}}
+Deleting a project only removes the project metadata from the GenAI service. 
+It does **not** delete:
+- Services associated with the project (must be deleted separately)
+- ArangoDB collections and data
+- Knowledge graphs
+
+You must manually delete services and collections if needed.
+{{< /warning >}}
 
 ## Obtaining a Bearer Token
 
@@ -103,7 +180,7 @@ documentation.
 
 ## Complete Service lifecycle example
 
-The example below shows how to install, monitor, and uninstall the Importer service.
+The example below shows how to install, monitor, and uninstall the [Importer](importer.md) service.
 
 ### Step 1: Installing the service
 
@@ -113,11 +190,10 @@ curl -X POST https://<ExternalEndpoint>:8529/gen-ai/v1/graphragimporter \
   -H "Content-Type: application/json" \
   -d '{
     "env": {
-      "username": "<your-username>",
       "db_name": "<your-database-name>",
-      "api_provider": "<your-api-provider>",
-      "triton_url": "<your-arangodb-llm-host-url>",
-      "triton_model": "<your-triton-model>"
+      "chat_api_provider": "<your-api-provider>",
+      "chat_api_key": "<your-llm-provider-api-key>",
+      "chat_model": "<model-name>"
     }
   }'
 ```
@@ -178,16 +254,6 @@ curl -X DELETE https://<ExternalEndpoint>:8529/gen-ai/v1/service/arangodb-graphr
 - **Authentication**: All requests use the same Bearer token in the `Authorization` header
 {{< /info >}}
 
-### Customizing the example
-
-Replace the following values with your actual configuration:
-- `<your-username>` - Your database username.
-- `<your-database-name>` - Target database name.
-- `<your-api-provider>` - Your API provider (e.g., `triton`)
-- `<your-arangodb-llm-host-url>` - Your LLM host service URL.
-- `<your-triton-model>` - Your Triton model name (e.g., `mistral-nemo-instruct`).
-- `<your-bearer-token>` - Your authentication token.
-
 ## Service configuration
 
 The GenAI orchestrator service is **started by default**. 

site/content/3.12/data-science/graphrag/services/importer.md

@@ -30,54 +30,17 @@ different concepts in your document with the Retriever service.
 You can also use the GraphRAG Importer service via the ArangoDB [web interface](../web-interface.md).
 {{< /tip >}}
 
-## Creating a new project
-
-To create a new GraphRAG project, use the `CreateProject` method by sending a
-`POST` request to the `genai/v1/project` endpoint. You must provide a unique
-`project_name` and a `project_type` in the request body. Optionally, you can
-provide a `project_description`.
-
-The `project_name` must follow these validation rules:
-- Length: 1–63 characters
-- Allowed characters: letters, numbers, underscores (`_`), and hyphens (`-`)
-
-```curl
-curl -X POST "https://<ExternalEndpoint>:8529/gen-ai/v1/project" \
--H "Content-Type: application/json" \
--d '{
-  "project_name": "docs",
-  "project_type": "graphrag",
-  "project_description": "A documentation project for GraphRAG."
-}'
-```
-
-All the relevant ArangoDB collections (such as documents, chunks, entities,
-relationships, and communities) created during the import process will
-have the project name as a prefix. For example, the Documents collection will
-become `<project_name>_Documents`. The Knowledge Graph will also use the project
-name as a prefix. If no project name is specified, then all collections
-are prefixed with `default_project`, e.g., `default_project_Documents`.
-
-Once created, you can reference your project in other services (such as the 
-Importer or Retriever) using the `genai_project_name` field:
-
-```json
-{
-  "genai_project_name": "docs"
-}
-```
-
-### Project metadata
+## Prerequisites
 
-Additional project metadata is accessible via the following endpoint, replacing
-`<your_project>` with the actual name of your project:
+Before importing data, you need to create a GraphRAG project. Projects help you 
+organize your work and keep your data separate from other projects.
 
-```
-GET /gen-ai/v1/project_by_name/<your_project>
-```
+For detailed instructions on creating and managing projects, see the 
+[Projects](gen-ai.md#projects) section in the GenAI Orchestration Service 
+documentation.
 
-The endpoint provides comprehensive metadata about your project's components,
-including its importer and retriever services and their status.
+Once you have created a project, you can reference it when deploying the Importer 
+service using the `genai_project_name` field in the service configuration.
 
 ## Deployment options
 

site/content/3.12/data-science/graphrag/services/retriever.md

@@ -41,12 +41,14 @@ You can also use the GraphRAG Retriever service via the [web interface](../web-i
 
 ## Prerequisites
 
-Before using the Retriever service, you need to create a GraphRAG project and 
-import data using the Importer service.
+Before using the Retriever service, you need to:
 
-For detailed instructions on creating a project, see 
-[Creating a new project](importer.md#creating-a-new-project) in the Importer 
-documentation.
+1. **Create a GraphRAG project** - For detailed instructions on creating and 
+   managing projects, see the [Projects](gen-ai.md#projects) section in the 
+   GenAI Orchestration Service documentation.
+
+2. **Import data** - Use the [Importer](importer.md) service to transform your 
+   text documents into a knowledge graph stored in ArangoDB.
 
 ## Search methods