> ## Documentation Index
> Fetch the complete documentation index at: https://novita.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Fonctionnalités avancées

Ce document couvre les fonctionnalités avancées et les bonnes pratiques pour Novita Agent Runtime.

***

## Sommaire

* [Référence du fichier de configuration](#configuration-file-reference)
* [Gestion des variables d’environnement](#environment-variables-management)
* [Réponses en streaming](#streaming-responses)
* [Gestion des versions](#version-management)
* [Contrôles d’intégrité](#health-checks)
* [Conversations multi-tours](#multi-turn-conversations)
* [Projets d’exemple](#example-projects)

***

## Référence du fichier de configuration

### Structure de .novita-agent.yaml

Le `.novita-agent.yaml` le fichier de configuration utilise le format YAML de style Kubernetes:

```yaml theme={"system"}
apiVersion: v1
kind: Agent
metadata:
  name: my-agent              # Agent name (must consist of lowercase letters, numbers, and hyphens only)
  version: 1.0.0              # Agent version (semantic versioning)
  author: dev@example.com     # Author email (required)
  description: My AI Agent    # Agent description (optional)
  created: '2025-10-23T10:30:00Z'  # Creation time (auto-generated)

spec:
  entrypoint: app.py          # Python entry file (must be .py file)
  
  # Environment variables configuration (optional)
  envVars:
    MODEL_NAME: deepseek/deepseek-v3-0324
    TEMPERATURE: '0.7'
  
  # Runtime configuration (optional, applied to the built sandbox template)
  runtime:
    timeout: 300              # Startup timeout in seconds (1-3600, default 300)
    memory_limit: 1Gi         # Memory limit (supports "512Mi", "1Gi", etc.)
    cpu_limit: '1'            # CPU limit (supports "1", "1000m", etc.)

# Status field (maintained by the system, should not be modified manually by users)
status:
  phase: deployed             # Current phase: pending/building/deployed/failed
  agent_id: agent-xxxxx       # Agent ID (auto-generated after deployment)
  last_deployed: '2025-10-23T10:35:00Z'  # Last deployment time
  build_id: build_xyz789      # Build ID (auto-generated after deployment)
```

### Modification de la configuration

#### Modification des paramètres de CPU et de mémoire

Modifiez la configuration des ressources sous `spec.runtime` in `.novita-agent.yaml`:

```yaml theme={"system"}
spec:
  runtime:
    # CPU configuration
    cpu_limit: '2'        # 2 CPU cores
    # Memory configuration
    memory_limit: 2Gi     # 2 GB memory
```

#### Modification des variables d’environnement

Le `spec.envVars` dans `.novita-agent.yaml` n’est utilisé que pour la CLI `agent invoke` commande et ne seront pas transmis au modèle de sandbox déployé.

Modifiez les variables d’environnement sous `spec.envVars` dans `.novita-agent.yaml`:

```yaml theme={"system"}
spec:
  envVars:
    # LLM configuration
    MODEL_NAME: deepseek/deepseek-v3-0324
    TEMPERATURE: '0.7'
```

**Remarque**:

* ⚠️ **Ne stockez pas d’informations sensibles** (telles que des clés API) dans `.novita-agent.yaml`
* Vous pouvez également transmettre des variables d’environnement via le `--env` paramètre lors de l’exécution de `agent invoke` command

#### Redéployer pour appliquer les modifications de configuration

Après avoir modifié les spécifications des ressources dans `.novita-agent.yaml`, un redéploiement est requis:

```bash theme={"system"}
# Redeploy (creates a new version)
npx novita-sandbox-cli agent launch
```

***

## Gestion des variables d’environnement

Il existe plusieurs façons de transmettre des variables d’environnement aux Agents s’exécutant dans des instances sandbox :

### Méthode 1 : définir dans le fichier de configuration (invocation CLI uniquement)

Définissez les variables d’environnement sous `spec.envVars` dans `.novita-agent.yaml`:

```yaml theme={"system"}
spec:
  envVars:
    MODEL_NAME: deepseek/deepseek-v3-0324
    TEMPERATURE: '0.7'
```

### Méthode 2 : transmettre dynamiquement via le SDK

Lors de l’appel d’un Agent à l’aide du SDK `invoke_agent_runtime` méthode, transmettez-les dynamiquement via le `envVars` paramètre:

```python theme={"system"}
import os
from novita_sandbox.agent_runtime import AgentRuntimeClient

client = AgentRuntimeClient(api_key=os.getenv("NOVITA_API_KEY"))

response = await client.invoke_agent_runtime(
    agentId="agent-xxxxx",
    payload=payload,
    envVars={
        # Read sensitive information from environment variables
        "NOVITA_API_KEY": os.getenv("NOVITA_API_KEY"),
        "DATABASE_PASSWORD": os.getenv("DATABASE_PASSWORD"),
        
        # Or pass directly
        "MODEL_NAME": "deepseek/deepseek-v3-0324",
        "TEMPERATURE": "0.7"
    }
)
```

***

## Réponses en streaming

### Implémenter le streaming avec des générateurs synchrones

Utilisez des générateurs Python pour implémenter des réponses en streaming :

```python theme={"system"}
from novita_sandbox.agent_runtime import AgentRuntimeApp

app = AgentRuntimeApp()

@app.entrypoint
def streaming_agent(request: dict):
    """Synchronous streaming response"""
    prompt = request.get("prompt", "")

    # Use generator to return chunks
    for i, chunk in enumerate(generate_response(prompt)):
        yield {
            "chunk": chunk,
            "type": "content",
            "index": i
        }
    # Send end marker
    yield {"chunk": "", "type": "end"}

```

### Implémenter le streaming avec des générateurs asynchrones

Utilisez les générateurs asynchrones Python :

```python theme={"system"}
import asyncio

@app.entrypoint
async def async_streaming_agent(request: dict):
    """Async streaming response"""
    prompt = request.get("prompt", "")

    async for chunk in async_generate_response(prompt):
        yield {
            "chunk": chunk,
            "type": "content"
        }
    yield {"chunk": "", "type": "end"}

```

### Exemple de réponse en streaming LangChain

Exemple complet utilisant LangChain pour les réponses en streaming:

```python theme={"system"}
import os
from langchain_openai import ChatOpenAI
from langchain.callbacks.base import BaseCallbackHandler
from novita_sandbox.agent_runtime import AgentRuntimeApp

app = AgentRuntimeApp()

class StreamingHandler(BaseCallbackHandler):
    """Streaming callback handler"""
    def __init__(self):
        self.tokens = []
    
    def on_llm_new_token(self, token: str, **kwargs):
        self.tokens.append(token)

@app.entrypoint
def langchain_streaming_agent(request: dict):
    """LangChain streaming response"""
    prompt = request.get("prompt", "")

    # Create streaming-enabled LLM
    llm = ChatOpenAI(
        api_key=os.getenv("NOVITA_API_KEY"),
        streaming=True
    )
    
    # Stream invocation
    for chunk in llm.stream(prompt):
        if chunk.content:
            yield {
                "chunk": chunk.content,
                "type": "content"
            }
    yield {"chunk": "", "type": "end"}
```

### Invocation d’un Agent en streaming

Invoquez un Agent en streaming à l’aide du SDK :

```python theme={"system"}
import asyncio
import json
import os
from novita_sandbox.agent_runtime import AgentRuntimeClient

async def call_streaming_agent():
    client = AgentRuntimeClient(api_key=os.getenv("NOVITA_API_KEY"))
    
    payload = json.dumps({
        "prompt": "Tell me a story"
    }).encode()
    
    response = await client.invoke_agent_runtime(
        agentId="agent-xxxxx",
        payload=payload
    )
    
    # Process streaming response
    print("Streaming response:")
    print(response)
```

***

## Gestion des versions

### Déploiement d’une nouvelle version de l’agent

Modifiez le numéro de version et déployez une nouvelle version :

```bash theme={"system"}
# Modify version number
npx novita-sandbox-cli agent configure --agent-version 1.1.0

# Deploy new version
npx novita-sandbox-cli agent launch
```

Après un déploiement réussi, un nouveau `agent_id` est généré. Chaque déploiement génère un unique `agent_id` qui correspond à une version spécifique.

***

## Contrôles de santé

### Point de terminaison de contrôle de santé par défaut

AgentRuntimeApp fournit automatiquement un `/ping` point de terminaison de vérification de l’état:

```python theme={"system"}
from novita_sandbox.agent_runtime import AgentRuntimeApp

app = AgentRuntimeApp()

# Default health check automatically responds with {"status": "Healthy"}
```

### Vérifications d’état personnalisées

Utilisez le `@app.ping` décorateur pour personnaliser la logique de contrôle d’intégrité:

```python theme={"system"}
@app.ping
def custom_health_check():
    """Custom health check"""
    # Check dependent services
    db_ok = check_database_connection()
    llm_ok = check_llm_service()
    
    if db_ok and llm_ok:
        return {"status": "Healthy"}
    elif db_ok or llm_ok:
        return {"status": "HealthyBusy"}  # Partially available
    else:
        return {"status": "Unhealthy"}  # Unavailable

def check_database_connection():
    """Check database connection"""
    try:
        # Simulate database check
        return True
    except:
        return False

def check_llm_service():
    """Check LLM service"""
    try:
        # Simulate LLM service check
        return True
    except:
        return False
```

### Statuts de vérification d’état pris en charge

Les agents peuvent retourner les statuts d’état suivants :

\| Statut | Description | Code d’état HTTP |
\|--------|-------------|------------------| `Healthy` | L’agent est entièrement disponible | 200 | `HealthyBusy` | L’agent est partiellement disponible (p. ex., traitement d’une charge importante) | 200 | `Unhealthy` | L’agent est indisponible | 503 |

***

## Conversations multi-tours

### Utiliser l’ID de session pour les conversations multi-tours

Utilisez le `runtimeSessionId` paramètre permettant d’acheminer plusieurs requêtes vers la même instance de sandbox:

```python theme={"system"}
import uuid
import json
import os
from novita_sandbox.agent_runtime import AgentRuntimeClient

async def multi_turn_conversation():
    runtime_session_id = str(uuid.uuid4())
    client = AgentRuntimeClient(api_key=os.getenv("NOVITA_API_KEY"))
    agent_id = "agent-xxxxx"
    
    # First turn
    response1 = await client.invoke_agent_runtime(
        agentId=agent_id,
        payload=json.dumps({"prompt": "Hello, my name is John"}).encode(),
        runtimeSessionId=runtime_session_id,
    )
    print(f"AI: {response1}")
    
    # Second turn (sent to the same sandbox instance, Agent remembers the context)
    response2 = await client.invoke_agent_runtime(
        agentId=agent_id,
        payload=json.dumps({"prompt": "What's my name?"}).encode(),
        runtimeSessionId=runtime_session_id,
    )
    print(f"AI: {response2}")  # Should answer "John"
```

***

## Projets d’exemple

Nous fournissons un projet d’exemple complet basé sur LangGraph, montrant comment créer de véritables applications d’IA avec Novita Agent Runtime.

### Dépôt du projet

🔗 [https://github.com/novitalabs/Novita-CollabHub/tree/main/examples/agent-runtime/agentic-frameworks/langgraph](https://github.com/novitalabs/Novita-CollabHub/tree/main/examples/agent-runtime/agentic-frameworks/langgraph)