feat(i18n): update translations (#1569)

* feat(i18n): update translations

* remove duplicate sections

* fix typos
This commit is contained in:
Waleed
2025-10-07 16:50:14 -07:00
committed by GitHub
parent c6f6c9e2a5
commit 8200e9a88f
18 changed files with 4738 additions and 510 deletions

View File

@@ -10,7 +10,7 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
Das offizielle Python SDK für Sim ermöglicht es Ihnen, Workflows programmatisch aus Ihren Python-Anwendungen mithilfe des offiziellen Python SDKs auszuführen.
<Callout type="info">
Das Python SDK unterstützt Python 3.8+ und bietet synchrone Workflow-Ausführung. Alle Workflow-Ausführungen sind derzeit synchron.
Das Python SDK unterstützt Python 3.8+ mit asynchroner Ausführungsunterstützung, automatischer Ratenbegrenzung mit exponentiellem Backoff und Nutzungsverfolgung.
</Callout>
## Installation
@@ -74,12 +74,17 @@ result = client.execute_workflow(
- `workflow_id` (str): Die ID des auszuführenden Workflows
- `input_data` (dict, optional): Eingabedaten, die an den Workflow übergeben werden
- `timeout` (float, optional): Timeout in Sekunden (Standard: 30.0)
- `stream` (bool, optional): Streaming-Antworten aktivieren (Standard: False)
- `selected_outputs` (list[str], optional): Block-Ausgaben, die im `blockName.attribute`Format gestreamt werden sollen (z.B. `["agent1.content"]`)
- `async_execution` (bool, optional): Asynchron ausführen (Standard: False)
**Rückgabewert:** `WorkflowExecutionResult`
**Rückgabe:** `WorkflowExecutionResult | AsyncExecutionResult`
Wenn `async_execution=True`, wird sofort mit einer Task-ID zum Abfragen zurückgegeben. Andernfalls wird auf den Abschluss gewartet.
##### get_workflow_status()
Ruft den Status eines Workflows ab (Deployment-Status usw.).
Den Status eines Workflows abrufen (Bereitstellungsstatus usw.).
```python
status = client.get_workflow_status("workflow-id")
@@ -93,7 +98,7 @@ print("Is deployed:", status.is_deployed)
##### validate_workflow()
Überprüft, ob ein Workflow für die Ausführung bereit ist.
Überprüfen, ob ein Workflow für die Ausführung bereit ist.
```python
is_ready = client.validate_workflow("workflow-id")
@@ -107,28 +112,118 @@ if is_ready:
**Rückgabe:** `bool`
##### execute_workflow_sync()
##### get_job_status()
<Callout type="info">
Derzeit ist diese Methode identisch mit `execute_workflow()`, da alle Ausführungen synchron sind. Diese Methode wird für zukünftige Kompatibilität bereitgestellt, wenn asynchrone Ausführung hinzugefügt wird.
</Callout>
Führt einen Workflow aus (derzeit synchron, identisch mit `execute_workflow()`).
Den Status einer asynchronen Job-Ausführung abrufen.
```python
result = client.execute_workflow_sync(
status = client.get_job_status("task-id-from-async-execution")
print("Status:", status["status"]) # 'queued', 'processing', 'completed', 'failed'
if status["status"] == "completed":
print("Output:", status["output"])
```
**Parameter:**
- `task_id` (str): Die Task-ID, die von der asynchronen Ausführung zurückgegeben wurde
**Rückgabe:** `Dict[str, Any]`
**Antwortfelder:**
- `success` (bool): Ob die Anfrage erfolgreich war
- `taskId` (str): Die Task-ID
- `status` (str): Einer der Werte `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (dict): Enthält `startedAt`, `completedAt` und `duration`
- `output` (any, optional): Die Workflow-Ausgabe (wenn abgeschlossen)
- `error` (any, optional): Fehlerdetails (wenn fehlgeschlagen)
- `estimatedDuration` (int, optional): Geschätzte Dauer in Millisekunden (wenn in Bearbeitung/in Warteschlange)
##### execute_with_retry()
Einen Workflow mit automatischer Wiederholung bei Ratenbegrenzungsfehlern unter Verwendung von exponentiellem Backoff ausführen.
```python
result = client.execute_with_retry(
"workflow-id",
input_data={"data": "some input"},
timeout=60.0
input_data={"message": "Hello"},
timeout=30.0,
max_retries=3, # Maximum number of retries
initial_delay=1.0, # Initial delay in seconds
max_delay=30.0, # Maximum delay in seconds
backoff_multiplier=2.0 # Exponential backoff multiplier
)
```
**Parameter:**
- `workflow_id` (str): Die ID des auszuführenden Workflows
- `input_data` (dict, optional): Eingabedaten, die an den Workflow übergeben werden
- `timeout` (float): Timeout für die initiale Anfrage in Sekunden
- `timeout` (float, optional): Timeout in Sekunden
- `stream` (bool, optional): Streaming-Antworten aktivieren
- `selected_outputs` (list, optional): Block-Ausgaben zum Streamen
- `async_execution` (bool, optional): Asynchron ausführen
- `max_retries` (int, optional): Maximale Anzahl von Wiederholungen (Standard: 3)
- `initial_delay` (float, optional): Anfängliche Verzögerung in Sekunden (Standard: 1.0)
- `max_delay` (float, optional): Maximale Verzögerung in Sekunden (Standard: 30.0)
- `backoff_multiplier` (float, optional): Backoff-Multiplikator (Standard: 2.0)
**Rückgabe:** `WorkflowExecutionResult`
**Rückgabewert:** `WorkflowExecutionResult | AsyncExecutionResult`
Die Wiederholungslogik verwendet exponentielles Backoff (1s → 2s → 4s → 8s...) mit ±25% Jitter, um den Thundering-Herd-Effekt zu vermeiden. Wenn die API einen `retry-after` Header bereitstellt, wird dieser stattdessen verwendet.
##### get_rate_limit_info()
Ruft die aktuellen Rate-Limit-Informationen aus der letzten API-Antwort ab.
```python
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
print("Limit:", rate_limit_info.limit)
print("Remaining:", rate_limit_info.remaining)
print("Reset:", datetime.fromtimestamp(rate_limit_info.reset))
```
**Rückgabewert:** `RateLimitInfo | None`
##### get_usage_limits()
Ruft aktuelle Nutzungslimits und Kontingentinformationen für dein Konto ab.
```python
limits = client.get_usage_limits()
print("Sync requests remaining:", limits.rate_limit["sync"]["remaining"])
print("Async requests remaining:", limits.rate_limit["async"]["remaining"])
print("Current period cost:", limits.usage["currentPeriodCost"])
print("Plan:", limits.usage["plan"])
```
**Rückgabewert:** `UsageLimits`
**Antwortstruktur:**
```python
{
"success": bool,
"rateLimit": {
"sync": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"async": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"authType": str # 'api' or 'manual'
},
"usage": {
"currentPeriodCost": float,
"limit": float,
"plan": str # e.g., 'free', 'pro'
}
}
```
##### set_api_key()
@@ -170,6 +265,18 @@ class WorkflowExecutionResult:
total_duration: Optional[float] = None
```
### AsyncExecutionResult
```python
@dataclass
class AsyncExecutionResult:
success: bool
task_id: str
status: str # 'queued'
created_at: str
links: Dict[str, str] # e.g., {"status": "/api/jobs/{taskId}"}
```
### WorkflowStatus
```python
@@ -181,6 +288,27 @@ class WorkflowStatus:
needs_redeployment: bool = False
```
### RateLimitInfo
```python
@dataclass
class RateLimitInfo:
limit: int
remaining: int
reset: int
retry_after: Optional[int] = None
```
### UsageLimits
```python
@dataclass
class UsageLimits:
success: bool
rate_limit: Dict[str, Any]
usage: Dict[str, Any]
```
### SimStudioError
```python
@@ -191,6 +319,13 @@ class SimStudioError(Exception):
self.status = status
```
**Häufige Fehlercodes:**
- `UNAUTHORIZED`: Ungültiger API-Schlüssel
- `TIMEOUT`: Zeitüberschreitung bei der Anfrage
- `RATE_LIMIT_EXCEEDED`: Ratengrenze überschritten
- `USAGE_LIMIT_EXCEEDED`: Nutzungsgrenze überschritten
- `EXECUTION_ERROR`: Workflow-Ausführung fehlgeschlagen
## Beispiele
### Grundlegende Workflow-Ausführung
@@ -252,7 +387,7 @@ Behandeln Sie verschiedene Fehlertypen, die während der Workflow-Ausführung au
from simstudio import SimStudioClient, SimStudioError
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_error_handling():
try:
@@ -279,16 +414,7 @@ def execute_with_error_handling():
Verwenden Sie den Client als Kontextmanager, um die Ressourcenbereinigung automatisch zu handhaben:
```python
from simstudio import SimStudioClient
import os
# Using context manager to automatically close the session
with SimStudioClient(api_key=os.getenv("SIM_API_KEY")) as client:
result = client.execute_workflow("workflow-id")
print("Result:", result)
# Session is automatically closed here
```
---CODE-PLACEHOLDER-ef99d3dd509e04865d5b6b0e0e03d3f8---
### Batch-Workflow-Ausführung
@@ -298,7 +424,7 @@ Führen Sie mehrere Workflows effizient aus:
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_workflows_batch(workflow_data_pairs):
"""Execute multiple workflows with different input data."""
@@ -339,9 +465,233 @@ for result in results:
print(f"Workflow {result['workflow_id']}: {'Success' if result['success'] else 'Failed'}")
```
### Asynchrone Workflow-Ausführung
Führen Sie Workflows asynchron für lang laufende Aufgaben aus:
```python
import os
import time
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_async():
try:
# Start async execution
result = client.execute_workflow(
"workflow-id",
input_data={"data": "large dataset"},
async_execution=True # Execute asynchronously
)
# Check if result is an async execution
if hasattr(result, 'task_id'):
print(f"Task ID: {result.task_id}")
print(f"Status endpoint: {result.links['status']}")
# Poll for completion
status = client.get_job_status(result.task_id)
while status["status"] in ["queued", "processing"]:
print(f"Current status: {status['status']}")
time.sleep(2) # Wait 2 seconds
status = client.get_job_status(result.task_id)
if status["status"] == "completed":
print("Workflow completed!")
print(f"Output: {status['output']}")
print(f"Duration: {status['metadata']['duration']}")
else:
print(f"Workflow failed: {status['error']}")
except Exception as error:
print(f"Error: {error}")
execute_async()
```
### Rate-Limiting und Wiederholungsversuche
Behandle Rate-Limits automatisch mit exponentiellem Backoff:
```python
import os
from simstudio import SimStudioClient, SimStudioError
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_retry_handling():
try:
# Automatically retries on rate limit
result = client.execute_with_retry(
"workflow-id",
input_data={"message": "Process this"},
max_retries=5,
initial_delay=1.0,
max_delay=60.0,
backoff_multiplier=2.0
)
print(f"Success: {result}")
except SimStudioError as error:
if error.code == "RATE_LIMIT_EXCEEDED":
print("Rate limit exceeded after all retries")
# Check rate limit info
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
from datetime import datetime
reset_time = datetime.fromtimestamp(rate_limit_info.reset)
print(f"Rate limit resets at: {reset_time}")
execute_with_retry_handling()
```
### Nutzungsüberwachung
Überwache deine Kontonutzung und -limits:
```python
import os
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def check_usage():
try:
limits = client.get_usage_limits()
print("=== Rate Limits ===")
print("Sync requests:")
print(f" Limit: {limits.rate_limit['sync']['limit']}")
print(f" Remaining: {limits.rate_limit['sync']['remaining']}")
print(f" Resets at: {limits.rate_limit['sync']['resetAt']}")
print(f" Is limited: {limits.rate_limit['sync']['isLimited']}")
print("\nAsync requests:")
print(f" Limit: {limits.rate_limit['async']['limit']}")
print(f" Remaining: {limits.rate_limit['async']['remaining']}")
print(f" Resets at: {limits.rate_limit['async']['resetAt']}")
print(f" Is limited: {limits.rate_limit['async']['isLimited']}")
print("\n=== Usage ===")
print(f"Current period cost: ${limits.usage['currentPeriodCost']:.2f}")
print(f"Limit: ${limits.usage['limit']:.2f}")
print(f"Plan: {limits.usage['plan']}")
percent_used = (limits.usage['currentPeriodCost'] / limits.usage['limit']) * 100
print(f"Usage: {percent_used:.1f}%")
if percent_used > 80:
print("⚠️ Warning: You are approaching your usage limit!")
except Exception as error:
print(f"Error checking usage: {error}")
check_usage()
```
### Streaming-Workflow-Ausführung
Führe Workflows mit Echtzeit-Streaming-Antworten aus:
```python
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_streaming():
"""Execute workflow with streaming enabled."""
try:
# Enable streaming for specific block outputs
result = client.execute_workflow(
"workflow-id",
input_data={"message": "Count to five"},
stream=True,
selected_outputs=["agent1.content"] # Use blockName.attribute format
)
print("Workflow result:", result)
except Exception as error:
print("Error:", error)
execute_with_streaming()
```
Die Streaming-Antwort folgt dem Server-Sent Events (SSE) Format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**Flask-Streaming-Beispiel:**
```python
from flask import Flask, Response, stream_with_context
import requests
import json
import os
app = Flask(__name__)
@app.route('/stream-workflow')
def stream_workflow():
"""Stream workflow execution to the client."""
def generate():
response = requests.post(
'https://sim.ai/api/workflows/WORKFLOW_ID/execute',
headers={
'Content-Type': 'application/json',
'X-API-Key': os.getenv('SIM_API_KEY')
},
json={
'message': 'Generate a story',
'stream': True,
'selectedOutputs': ['agent1.content']
},
stream=True
)
for line in response.iter_lines():
if line:
decoded_line = line.decode('utf-8')
if decoded_line.startswith('data: '):
data = decoded_line[6:] # Remove 'data: ' prefix
if data == '[DONE]':
break
try:
parsed = json.loads(data)
if 'chunk' in parsed:
yield f"data: {json.dumps(parsed)}\n\n"
elif parsed.get('event') == 'done':
yield f"data: {json.dumps(parsed)}\n\n"
print("Execution complete:", parsed.get('metadata'))
except json.JSONDecodeError:
pass
return Response(
stream_with_context(generate()),
mimetype='text/event-stream'
)
if __name__ == '__main__':
app.run(debug=True)
```
### Umgebungskonfiguration
Konfigurieren Sie den Client mit Umgebungsvariablen:
Konfiguriere den Client mit Umgebungsvariablen:
<Tabs items={['Development', 'Production']}>
<Tab value="Development">
@@ -352,7 +702,7 @@ Konfigurieren Sie den Client mit Umgebungsvariablen:
# Development configuration
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY"),
api_key=os.getenv("SIM_API_KEY")
base_url=os.getenv("SIM_BASE_URL", "https://sim.ai")
)
```
@@ -382,19 +732,19 @@ Konfigurieren Sie den Client mit Umgebungsvariablen:
<Steps>
<Step title="Bei Sim anmelden">
Navigieren Sie zu [Sim](https://sim.ai) und melden Sie sich bei Ihrem Konto an.
Navigiere zu [Sim](https://sim.ai) und melde dich bei deinem Konto an.
</Step>
<Step title="Ihren Workflow öffnen">
Navigieren Sie zu dem Workflow, den Sie programmatisch ausführen möchten.
<Step title="Öffne deinen Workflow">
Navigiere zu dem Workflow, den du programmatisch ausführen möchtest.
</Step>
<Step title="Ihren Workflow bereitstellen">
Klicken Sie auf "Deploy", um Ihren Workflow bereitzustellen, falls dies noch nicht geschehen ist.
<Step title="Deploye deinen Workflow">
Klicke auf "Deploy", um deinen Workflow zu deployen, falls dies noch nicht geschehen ist.
</Step>
<Step title="API-Schlüssel erstellen oder auswählen">
Wählen Sie während des Bereitstellungsprozesses einen API-Schlüssel aus oder erstellen Sie einen neuen.
<Step title="Erstelle oder wähle einen API-Schlüssel">
Wähle während des Deployment-Prozesses einen API-Schlüssel aus oder erstelle einen neuen.
</Step>
<Step title="API-Schlüssel kopieren">
Kopieren Sie den API-Schlüssel zur Verwendung in Ihrer Python-Anwendung.
<Step title="Kopiere den API-Schlüssel">
Kopiere den API-Schlüssel zur Verwendung in deiner Python-Anwendung.
</Step>
</Steps>

View File

@@ -7,10 +7,10 @@ import { Card, Cards } from 'fumadocs-ui/components/card'
import { Step, Steps } from 'fumadocs-ui/components/steps'
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
Das offizielle TypeScript/JavaScript SDK für Sim bietet vollständige Typsicherheit und unterstützt sowohl Node.js- als auch Browser-Umgebungen, sodass Sie Workflows programmatisch aus Ihren Node.js-Anwendungen, Webanwendungen und anderen JavaScript-Umgebungen ausführen können. Alle Workflow-Ausführungen sind derzeit synchron.
Das offizielle TypeScript/JavaScript SDK für Sim bietet vollständige Typsicherheit und unterstützt sowohl Node.js- als auch Browser-Umgebungen, sodass Sie Workflows programmatisch aus Ihren Node.js-Anwendungen, Webanwendungen und anderen JavaScript-Umgebungen ausführen können.
<Callout type="info">
Das TypeScript SDK bietet vollständige Typsicherheit und unterstützt sowohl Node.js- als auch Browser-Umgebungen. Alle Workflow-Ausführungen sind derzeit synchron.
Das TypeScript SDK bietet vollständige Typsicherheit, Unterstützung für asynchrone Ausführung, automatische Ratenbegrenzung mit exponentiellem Backoff und Nutzungsverfolgung.
</Callout>
## Installation
@@ -95,8 +95,13 @@ const result = await client.executeWorkflow('workflow-id', {
- `options` (ExecutionOptions, optional):
- `input` (any): Eingabedaten, die an den Workflow übergeben werden
- `timeout` (number): Timeout in Millisekunden (Standard: 30000)
- `stream` (boolean): Streaming-Antworten aktivieren (Standard: false)
- `selectedOutputs` (string[]): Block-Ausgaben, die im `blockName.attribute`Format gestreamt werden sollen (z.B. `["agent1.content"]`)
- `async` (boolean): Asynchron ausführen (Standard: false)
**Rückgabewert:** `Promise<WorkflowExecutionResult>`
**Rückgabe:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
Wenn `async: true`, wird sofort mit einer Task-ID zum Abfragen zurückgegeben. Andernfalls wird auf den Abschluss gewartet.
##### getWorkflowStatus()
@@ -110,7 +115,7 @@ console.log('Is deployed:', status.isDeployed);
**Parameter:**
- `workflowId` (string): Die ID des Workflows
**Rückgabewert:** `Promise<WorkflowStatus>`
**Rückgabe:** `Promise<WorkflowStatus>`
##### validateWorkflow()
@@ -126,34 +131,123 @@ if (isReady) {
**Parameter:**
- `workflowId` (string): Die ID des Workflows
**Rückgabewert:** `Promise<boolean>`
**Rückgabe:** `Promise<boolean>`
##### executeWorkflowSync()
##### getJobStatus()
<Callout type="info">
Derzeit ist diese Methode identisch mit `executeWorkflow()`, da alle Ausführungen synchron sind. Diese Methode wird für zukünftige Kompatibilität bereitgestellt, wenn asynchrone Ausführung hinzugefügt wird.
</Callout>
Einen Workflow ausführen (derzeit synchron, identisch mit `executeWorkflow()`).
Den Status einer asynchronen Job-Ausführung abrufen.
```typescript
const result = await client.executeWorkflowSync('workflow-id', {
input: { data: 'some input' },
timeout: 60000
const status = await client.getJobStatus('task-id-from-async-execution');
console.log('Status:', status.status); // 'queued', 'processing', 'completed', 'failed'
if (status.status === 'completed') {
console.log('Output:', status.output);
}
```
**Parameter:**
- `taskId` (string): Die Task-ID, die von der asynchronen Ausführung zurückgegeben wurde
**Rückgabe:** `Promise<JobStatus>`
**Antwortfelder:**
- `success` (boolean): Ob die Anfrage erfolgreich war
- `taskId` (string): Die Task-ID
- `status` (string): Einer der Werte `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (object): Enthält `startedAt`, `completedAt` und `duration`
- `output` (any, optional): Die Workflow-Ausgabe (wenn abgeschlossen)
- `error` (any, optional): Fehlerdetails (wenn fehlgeschlagen)
- `estimatedDuration` (number, optional): Geschätzte Dauer in Millisekunden (wenn in Bearbeitung/in der Warteschlange)
##### executeWithRetry()
Führt einen Workflow mit automatischer Wiederholung bei Ratenlimitfehlern unter Verwendung von exponentiellem Backoff aus.
```typescript
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Hello' },
timeout: 30000
}, {
maxRetries: 3, // Maximum number of retries
initialDelay: 1000, // Initial delay in ms (1 second)
maxDelay: 30000, // Maximum delay in ms (30 seconds)
backoffMultiplier: 2 // Exponential backoff multiplier
});
```
**Parameter:**
- `workflowId` (string): Die ID des auszuführenden Workflows
- `options` (ExecutionOptions, optional):
- `input` (any): Eingabedaten, die an den Workflow übergeben werden
- `timeout` (number): Timeout für die initiale Anfrage in Millisekunden
- `options` (ExecutionOptions, optional): Gleich wie `executeWorkflow()`
- `retryOptions` (RetryOptions, optional):
- `maxRetries` (number): Maximale Anzahl von Wiederholungen (Standard: 3)
- `initialDelay` (number): Anfängliche Verzögerung in ms (Standard: 1000)
- `maxDelay` (number): Maximale Verzögerung in ms (Standard: 30000)
- `backoffMultiplier` (number): Backoff-Multiplikator (Standard: 2)
**Rückgabewert:** `Promise<WorkflowExecutionResult>`
**Rückgabewert:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
Die Wiederholungslogik verwendet exponentiellen Backoff (1s → 2s → 4s → 8s...) mit ±25% Jitter, um den Thundering-Herd-Effekt zu vermeiden. Wenn die API einen `retry-after`Header bereitstellt, wird dieser stattdessen verwendet.
##### getRateLimitInfo()
Ruft die aktuellen Ratenlimit-Informationen aus der letzten API-Antwort ab.
```typescript
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Limit:', rateLimitInfo.limit);
console.log('Remaining:', rateLimitInfo.remaining);
console.log('Reset:', new Date(rateLimitInfo.reset * 1000));
}
```
**Rückgabewert:** `RateLimitInfo | null`
##### getUsageLimits()
Ruft aktuelle Nutzungslimits und Kontingentinformationen für Ihr Konto ab.
```typescript
const limits = await client.getUsageLimits();
console.log('Sync requests remaining:', limits.rateLimit.sync.remaining);
console.log('Async requests remaining:', limits.rateLimit.async.remaining);
console.log('Current period cost:', limits.usage.currentPeriodCost);
console.log('Plan:', limits.usage.plan);
```
**Rückgabewert:** `Promise<UsageLimits>`
**Antwortstruktur:**
```typescript
{
success: boolean
rateLimit: {
sync: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
async: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
authType: string // 'api' or 'manual'
}
usage: {
currentPeriodCost: number
limit: number
plan: string // e.g., 'free', 'pro'
}
}
```
##### setApiKey()
Den API-Schlüssel aktualisieren.
Aktualisiert den API-Schlüssel.
```typescript
client.setApiKey('new-api-key');
@@ -161,7 +255,7 @@ client.setApiKey('new-api-key');
##### setBaseUrl()
Die Basis-URL aktualisieren.
Aktualisiert die Basis-URL.
```typescript
client.setBaseUrl('https://my-custom-domain.com');
@@ -187,6 +281,20 @@ interface WorkflowExecutionResult {
}
```
### AsyncExecutionResult
```typescript
interface AsyncExecutionResult {
success: boolean;
taskId: string;
status: 'queued';
createdAt: string;
links: {
status: string; // e.g., "/api/jobs/{taskId}"
};
}
```
### WorkflowStatus
```typescript
@@ -198,6 +306,45 @@ interface WorkflowStatus {
}
```
### RateLimitInfo
```typescript
interface RateLimitInfo {
limit: number;
remaining: number;
reset: number;
retryAfter?: number;
}
```
### UsageLimits
```typescript
interface UsageLimits {
success: boolean;
rateLimit: {
sync: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
async: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
authType: string;
};
usage: {
currentPeriodCost: number;
limit: number;
plan: string;
};
}
```
### SimStudioError
```typescript
@@ -207,6 +354,13 @@ class SimStudioError extends Error {
}
```
**Häufige Fehlercodes:**
- `UNAUTHORIZED`: Ungültiger API-Schlüssel
- `TIMEOUT`: Zeitüberschreitung der Anfrage
- `RATE_LIMIT_EXCEEDED`: Ratengrenze überschritten
- `USAGE_LIMIT_EXCEEDED`: Nutzungsgrenze überschritten
- `EXECUTION_ERROR`: Workflow-Ausführung fehlgeschlagen
## Beispiele
### Grundlegende Workflow-Ausführung
@@ -467,16 +621,16 @@ document.getElementById('executeBtn')?.addEventListener('click', executeClientSi
Bei der Verwendung des SDK im Browser sollten Sie darauf achten, keine sensiblen API-Schlüssel offenzulegen. Erwägen Sie die Verwendung eines Backend-Proxys oder öffentlicher API-Schlüssel mit eingeschränkten Berechtigungen.
</Callout>
### React Hook Beispiel
### React Hook-Beispiel
Erstellen Sie einen benutzerdefinierten React Hook für die Workflow-Ausführung:
Erstellen eines benutzerdefinierten React-Hooks für die Workflow-Ausführung:
```typescript
import { useState, useCallback } from 'react';
import { SimStudioClient, WorkflowExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.NEXT_PUBLIC_SIM_API_KEY!
apiKey: process.env.SIM_API_KEY!
});
interface UseWorkflowResult {
@@ -532,7 +686,7 @@ function WorkflowComponent() {
<button onClick={handleExecute} disabled={loading}>
{loading ? 'Executing...' : 'Execute Workflow'}
</button>
{error && <div>Error: {error.message}</div>}
{result && (
<div>
@@ -545,38 +699,267 @@ function WorkflowComponent() {
}
```
## Ihren API-Schlüssel erhalten
### Asynchrone Workflow-Ausführung
Führen Sie Workflows asynchron für lang laufende Aufgaben aus:
```typescript
import { SimStudioClient, AsyncExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeAsync() {
try {
// Start async execution
const result = await client.executeWorkflow('workflow-id', {
input: { data: 'large dataset' },
async: true // Execute asynchronously
});
// Check if result is an async execution
if ('taskId' in result) {
console.log('Task ID:', result.taskId);
console.log('Status endpoint:', result.links.status);
// Poll for completion
let status = await client.getJobStatus(result.taskId);
while (status.status === 'queued' || status.status === 'processing') {
console.log('Current status:', status.status);
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
status = await client.getJobStatus(result.taskId);
}
if (status.status === 'completed') {
console.log('Workflow completed!');
console.log('Output:', status.output);
console.log('Duration:', status.metadata.duration);
} else {
console.error('Workflow failed:', status.error);
}
}
} catch (error) {
console.error('Error:', error);
}
}
executeAsync();
```
### Rate-Limiting und Wiederholungsversuche
Automatische Behandlung von Rate-Limits mit exponentiellem Backoff:
```typescript
import { SimStudioClient, SimStudioError } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithRetryHandling() {
try {
// Automatically retries on rate limit
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Process this' }
}, {
maxRetries: 5,
initialDelay: 1000,
maxDelay: 60000,
backoffMultiplier: 2
});
console.log('Success:', result);
} catch (error) {
if (error instanceof SimStudioError && error.code === 'RATE_LIMIT_EXCEEDED') {
console.error('Rate limit exceeded after all retries');
// Check rate limit info
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Rate limit resets at:', new Date(rateLimitInfo.reset * 1000));
}
}
}
}
```
### Nutzungsüberwachung
Überwachen Sie Ihre Kontonutzung und -limits:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function checkUsage() {
try {
const limits = await client.getUsageLimits();
console.log('=== Rate Limits ===');
console.log('Sync requests:');
console.log(' Limit:', limits.rateLimit.sync.limit);
console.log(' Remaining:', limits.rateLimit.sync.remaining);
console.log(' Resets at:', limits.rateLimit.sync.resetAt);
console.log(' Is limited:', limits.rateLimit.sync.isLimited);
console.log('\nAsync requests:');
console.log(' Limit:', limits.rateLimit.async.limit);
console.log(' Remaining:', limits.rateLimit.async.remaining);
console.log(' Resets at:', limits.rateLimit.async.resetAt);
console.log(' Is limited:', limits.rateLimit.async.isLimited);
console.log('\n=== Usage ===');
console.log('Current period cost:
### Streaming Workflow Execution
Execute workflows with real-time streaming responses:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithStreaming() {
try {
// Streaming für bestimmte Block-Ausgaben aktivieren
const result = await client.executeWorkflow('workflow-id', {
input: { message: 'Count to five' },
stream: true,
selectedOutputs: ['agent1.content'] // Format blockName.attribute verwenden
});
console.log('Workflow-Ergebnis:', result);
} catch (error) {
console.error('Fehler:', error);
}
}
```
The streaming response follows the Server-Sent Events (SSE) format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", zwei"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**React Streaming Example:**
```typescript
import { useState, useEffect } from 'react';
function StreamingWorkflow() {
const [output, setOutput] = useState('');
const [loading, setLoading] = useState(false);
const executeStreaming = async () => {
setLoading(true);
setOutput('');
// WICHTIG: Führen Sie diesen API-Aufruf von Ihrem Backend-Server aus, nicht vom Browser
// Setzen Sie niemals Ihren API-Schlüssel im Client-seitigen Code frei
const response = await fetch('https://sim.ai/api/workflows/WORKFLOW_ID/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.SIM_API_KEY! // Nur serverseitige Umgebungsvariable
},
body: JSON.stringify({
message: 'Generate a story',
stream: true,
selectedOutputs: ['agent1.content']
})
});
const reader = response.body?.getReader();
const decoder = new TextDecoder();
while (reader) {
const { done, value } = await reader.read();
if (done) break;
const chunk = decoder.decode(value);
const lines = chunk.split('\n\n');
for (const line of lines) {
if (line.startsWith('data: ')) {
const data = line.slice(6);
if (data === '[DONE]') {
setLoading(false);
break;
}
try {
const parsed = JSON.parse(data);
if (parsed.chunk) {
setOutput(prev => prev + parsed.chunk);
} else if (parsed.event === 'done') {
console.log('Ausführung abgeschlossen:', parsed.metadata);
}
} catch (e) {
// Ungültiges JSON überspringen
}
}
}
}
};
return (
<div>
<button onClick={executeStreaming} disabled={loading}>
{loading ? 'Generiere...' : 'Streaming starten'}
</button>
<div style={{ whiteSpace: 'pre-wrap' }}>{output}</div>
</div>
);
}
```
## Getting Your API Key
<Steps>
<Step title="Bei Sim anmelden">
Navigieren Sie zu [Sim](https://sim.ai) und melden Sie sich bei Ihrem Konto an.
<Step title="Log in to Sim">
Navigate to [Sim](https://sim.ai) and log in to your account.
</Step>
<Step title="Öffnen Sie Ihren Workflow">
Navigieren Sie zu dem Workflow, den Sie programmatisch ausführen möchten.
<Step title="Open your workflow">
Navigate to the workflow you want to execute programmatically.
</Step>
<Step title="Deployen Sie Ihren Workflow">
Klicken Sie auf "Deploy", um Ihren Workflow zu deployen, falls dies noch nicht geschehen ist.
<Step title="Deploy your workflow">
Click on "Deploy" to deploy your workflow if it hasn't been deployed yet.
</Step>
<Step title="Erstellen oder wählen Sie einen API-Schlüssel">
Wählen Sie während des Deployment-Prozesses einen API-Schlüssel aus oder erstellen Sie einen neuen.
<Step title="Create or select an API key">
During the deployment process, select or create an API key.
</Step>
<Step title="Kopieren Sie den API-Schlüssel">
Kopieren Sie den API-Schlüssel zur Verwendung in Ihrer TypeScript/JavaScript-Anwendung.
<Step title="Copy the API key">
Copy the API key to use in your TypeScript/JavaScript application.
</Step>
</Steps>
<Callout type="warning">
Halten Sie Ihren API-Schlüssel sicher und committen Sie ihn niemals in die Versionskontrolle. Verwenden Sie Umgebungsvariablen oder sicheres Konfigurationsmanagement.
Keep your API key secure and never commit it to version control. Use environment variables or secure configuration management.
</Callout>
## Anforderungen
## Requirements
- Node.js 16+
- TypeScript 5.0+ (für TypeScript-Projekte)
- TypeScript 5.0+ (for TypeScript projects)
## TypeScript-Unterstützung
## TypeScript Support
Das SDK ist in TypeScript geschrieben und bietet vollständige Typsicherheit:
The SDK is written in TypeScript and provides full type safety:
```typescript
import {
@@ -586,22 +969,22 @@ import {
SimStudioError
} from 'simstudio-ts-sdk';
// Type-safe client initialization
// Typsichere Client-Initialisierung
const client: SimStudioClient = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
// Type-safe workflow execution
// Typsichere Workflow-Ausführung
const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-id', {
input: {
message: 'Hello, TypeScript!'
}
});
// Type-safe status checking
// Typsichere Statusprüfung
const status: WorkflowStatus = await client.getWorkflowStatus('workflow-id');
```
## Lizenz
## License
Apache-2.0

View File

@@ -38,14 +38,92 @@ curl -X POST \
Erfolgreiche Antworten geben das serialisierte Ausführungsergebnis vom Executor zurück. Fehler zeigen Validierungs-, Authentifizierungs- oder Workflow-Fehler an.
## Ausgabe-Referenz
## Streaming-Antworten
Aktivieren Sie Echtzeit-Streaming, um Workflow-Ausgaben zu erhalten, während sie zeichen-für-zeichen generiert werden. Dies ist nützlich, um KI-Antworten progressiv für Benutzer anzuzeigen.
### Anfrageparameter
Fügen Sie diese Parameter hinzu, um Streaming zu aktivieren:
- `stream` - Auf `true` setzen, um Server-Sent Events (SSE) Streaming zu aktivieren
- `selectedOutputs` - Array von Block-Ausgaben zum Streamen (z.B. `["agent1.content"]`)
### Block-Ausgabeformat
Verwenden Sie das `blockName.attribute` Format, um anzugeben, welche Block-Ausgaben gestreamt werden sollen:
- Format: `"blockName.attribute"` (z.B. Wenn Sie den Inhalt des Agent 1-Blocks streamen möchten, würden Sie `"agent1.content"` verwenden)
- Blocknamen sind nicht case-sensitive und Leerzeichen werden ignoriert
### Beispielanfrage
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Count to five",
"stream": true,
"selectedOutputs": ["agent1.content"]
}'
```
### Antwortformat
Streaming-Antworten verwenden das Server-Sent Events (SSE) Format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", three"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
Jedes Ereignis enthält:
- **Streaming-Chunks**: `{"blockId": "...", "chunk": "text"}` - Echtzeit-Text während er generiert wird
- **Abschlussereignis**: `{"event": "done", ...}` - Ausführungsmetadaten und vollständige Ergebnisse
- **Terminator**: `[DONE]` - Signalisiert das Ende des Streams
### Streaming mehrerer Blöcke
Wenn `selectedOutputs` mehrere Blöcke enthält, zeigt jeder Chunk an, welcher Block ihn erzeugt hat:
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Process this request",
"stream": true,
"selectedOutputs": ["agent1.content", "agent2.content"]
}'
```
Das Feld `blockId` in jedem Chunk ermöglicht es Ihnen, die Ausgabe zum richtigen UI-Element zu leiten:
```
data: {"blockId":"agent1-uuid","chunk":"Processing..."}
data: {"blockId":"agent2-uuid","chunk":"Analyzing..."}
data: {"blockId":"agent1-uuid","chunk":" complete"}
```
## Ausgabereferenz
| Referenz | Beschreibung |
|-----------|-------------|
| `<api.field>` | Im Eingabeformat definiertes Feld |
| `<api.input>` | Gesamter strukturierter Anfragekörper |
Wenn kein Eingabeformat definiert ist, stellt der Executor das rohe JSON nur unter `<api.input>` bereit.
Wenn kein Eingabeformat definiert ist, stellt der Executor das rohe JSON nur unter `<api.input>` zur Verfügung.
<Callout type="warning">
Ein Workflow kann nur einen API-Trigger enthalten. Veröffentlichen Sie nach Änderungen eine neue Bereitstellung, damit der Endpunkt aktuell bleibt.

View File

@@ -348,7 +348,7 @@ class SimStudioError(Exception):
import os
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def run_workflow():
try:
@@ -386,7 +386,7 @@ Handle different types of errors that may occur during workflow execution:
from simstudio import SimStudioClient, SimStudioError
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY")
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_error_handling():
try:
@@ -432,7 +432,7 @@ Execute multiple workflows efficiently:
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY")
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_workflows_batch(workflow_data_pairs):
"""Execute multiple workflows with different input data."""
@@ -608,7 +608,7 @@ Execute workflows with real-time streaming responses:
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY")
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_streaming():
"""Execute workflow with streaming enabled."""
@@ -659,7 +659,7 @@ def stream_workflow():
'https://sim.ai/api/workflows/WORKFLOW_ID/execute',
headers={
'Content-Type': 'application/json',
'X-API-Key': os.getenv('SIM_API_KEY
'X-API-Key': os.getenv('SIM_API_KEY')
},
json={
'message': 'Generate a story',

View File

@@ -992,4 +992,4 @@ const status: WorkflowStatus = await client.getWorkflowStatus('workflow-id');
## License
Apache-2.0
Apache-2.0

View File

@@ -10,7 +10,7 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
El SDK oficial de Python para Sim te permite ejecutar flujos de trabajo programáticamente desde tus aplicaciones Python utilizando el SDK oficial de Python.
<Callout type="info">
El SDK de Python es compatible con Python 3.8+ y proporciona ejecución sincrónica de flujos de trabajo. Todas las ejecuciones de flujos de trabajo son actualmente sincrónicas.
El SDK de Python es compatible con Python 3.8+ con soporte para ejecución asíncrona, limitación automática de velocidad con retroceso exponencial y seguimiento de uso.
</Callout>
## Instalación
@@ -74,12 +74,17 @@ result = client.execute_workflow(
- `workflow_id` (str): El ID del flujo de trabajo a ejecutar
- `input_data` (dict, opcional): Datos de entrada para pasar al flujo de trabajo
- `timeout` (float, opcional): Tiempo de espera en segundos (predeterminado: 30.0)
- `stream` (bool, opcional): Habilitar respuestas en streaming (predeterminado: False)
- `selected_outputs` (list[str], opcional): Salidas de bloque para transmitir en formato `blockName.attribute` (p. ej., `["agent1.content"]`)
- `async_execution` (bool, opcional): Ejecutar de forma asíncrona (predeterminado: False)
**Devuelve:** `WorkflowExecutionResult`
**Devuelve:** `WorkflowExecutionResult | AsyncExecutionResult`
Cuando `async_execution=True`, devuelve inmediatamente un ID de tarea para sondeo. De lo contrario, espera a que se complete.
##### get_workflow_status()
Obtiene el estado de un flujo de trabajo (estado de implementación, etc.).
Obtener el estado de un flujo de trabajo (estado de implementación, etc.).
```python
status = client.get_workflow_status("workflow-id")
@@ -93,7 +98,7 @@ print("Is deployed:", status.is_deployed)
##### validate_workflow()
Valida que un flujo de trabajo esté listo para su ejecución.
Validar que un flujo de trabajo está listo para su ejecución.
```python
is_ready = client.validate_workflow("workflow-id")
@@ -107,28 +112,118 @@ if is_ready:
**Devuelve:** `bool`
##### execute_workflow_sync()
##### get_job_status()
<Callout type="info">
Actualmente, este método es idéntico a `execute_workflow()` ya que todas las ejecuciones son síncronas. Este método se proporciona para compatibilidad futura cuando se añada la ejecución asíncrona.
</Callout>
Ejecuta un flujo de trabajo (actualmente síncrono, igual que `execute_workflow()`).
Obtener el estado de una ejecución de trabajo asíncrono.
```python
result = client.execute_workflow_sync(
status = client.get_job_status("task-id-from-async-execution")
print("Status:", status["status"]) # 'queued', 'processing', 'completed', 'failed'
if status["status"] == "completed":
print("Output:", status["output"])
```
**Parámetros:**
- `task_id` (str): El ID de tarea devuelto de la ejecución asíncrona
**Devuelve:** `Dict[str, Any]`
**Campos de respuesta:**
- `success` (bool): Si la solicitud fue exitosa
- `taskId` (str): El ID de la tarea
- `status` (str): Uno de `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (dict): Contiene `startedAt`, `completedAt`, y `duration`
- `output` (any, opcional): La salida del flujo de trabajo (cuando se completa)
- `error` (any, opcional): Detalles del error (cuando falla)
- `estimatedDuration` (int, opcional): Duración estimada en milisegundos (cuando está procesando/en cola)
##### execute_with_retry()
Ejecutar un flujo de trabajo con reintento automático en errores de límite de velocidad usando retroceso exponencial.
```python
result = client.execute_with_retry(
"workflow-id",
input_data={"data": "some input"},
timeout=60.0
input_data={"message": "Hello"},
timeout=30.0,
max_retries=3, # Maximum number of retries
initial_delay=1.0, # Initial delay in seconds
max_delay=30.0, # Maximum delay in seconds
backoff_multiplier=2.0 # Exponential backoff multiplier
)
```
**Parámetros:**
- `workflow_id` (str): El ID del flujo de trabajo a ejecutar
- `input_data` (dict, opcional): Datos de entrada para pasar al flujo de trabajo
- `timeout` (float): Tiempo de espera para la solicitud inicial en segundos
- `timeout` (float, opcional): Tiempo de espera en segundos
- `stream` (bool, opcional): Habilitar respuestas en streaming
- `selected_outputs` (list, opcional): Salidas de bloque para transmitir
- `async_execution` (bool, opcional): Ejecutar de forma asíncrona
- `max_retries` (int, opcional): Número máximo de reintentos (predeterminado: 3)
- `initial_delay` (float, opcional): Retraso inicial en segundos (predeterminado: 1.0)
- `max_delay` (float, opcional): Retraso máximo en segundos (predeterminado: 30.0)
- `backoff_multiplier` (float, opcional): Multiplicador de retroceso (predeterminado: 2.0)
**Devuelve:** `WorkflowExecutionResult`
**Devuelve:** `WorkflowExecutionResult | AsyncExecutionResult`
La lógica de reintento utiliza retroceso exponencial (1s → 2s → 4s → 8s...) con fluctuación de ±25% para evitar el efecto de manada. Si la API proporciona un encabezado `retry-after`, se utilizará en su lugar.
##### get_rate_limit_info()
Obtiene la información actual del límite de tasa de la última respuesta de la API.
```python
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
print("Limit:", rate_limit_info.limit)
print("Remaining:", rate_limit_info.remaining)
print("Reset:", datetime.fromtimestamp(rate_limit_info.reset))
```
**Devuelve:** `RateLimitInfo | None`
##### get_usage_limits()
Obtiene los límites de uso actuales y la información de cuota para tu cuenta.
```python
limits = client.get_usage_limits()
print("Sync requests remaining:", limits.rate_limit["sync"]["remaining"])
print("Async requests remaining:", limits.rate_limit["async"]["remaining"])
print("Current period cost:", limits.usage["currentPeriodCost"])
print("Plan:", limits.usage["plan"])
```
**Devuelve:** `UsageLimits`
**Estructura de respuesta:**
```python
{
"success": bool,
"rateLimit": {
"sync": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"async": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"authType": str # 'api' or 'manual'
},
"usage": {
"currentPeriodCost": float,
"limit": float,
"plan": str # e.g., 'free', 'pro'
}
}
```
##### set_api_key()
@@ -170,6 +265,18 @@ class WorkflowExecutionResult:
total_duration: Optional[float] = None
```
### AsyncExecutionResult
```python
@dataclass
class AsyncExecutionResult:
success: bool
task_id: str
status: str # 'queued'
created_at: str
links: Dict[str, str] # e.g., {"status": "/api/jobs/{taskId}"}
```
### WorkflowStatus
```python
@@ -181,6 +288,27 @@ class WorkflowStatus:
needs_redeployment: bool = False
```
### RateLimitInfo
```python
@dataclass
class RateLimitInfo:
limit: int
remaining: int
reset: int
retry_after: Optional[int] = None
```
### UsageLimits
```python
@dataclass
class UsageLimits:
success: bool
rate_limit: Dict[str, Any]
usage: Dict[str, Any]
```
### SimStudioError
```python
@@ -191,6 +319,13 @@ class SimStudioError(Exception):
self.status = status
```
**Códigos de error comunes:**
- `UNAUTHORIZED`: Clave API inválida
- `TIMEOUT`: Tiempo de espera agotado
- `RATE_LIMIT_EXCEEDED`: Límite de tasa excedido
- `USAGE_LIMIT_EXCEEDED`: Límite de uso excedido
- `EXECUTION_ERROR`: Ejecución del flujo de trabajo fallida
## Ejemplos
### Ejecución básica de flujo de trabajo
@@ -205,8 +340,8 @@ class SimStudioError(Exception):
<Step title="Ejecutar el flujo de trabajo">
Ejecuta el flujo de trabajo con tus datos de entrada.
</Step>
<Step title="Gestionar el resultado">
Procesa el resultado de la ejecución y maneja cualquier error.
<Step title="Manejar el resultado">
Procesa el resultado de la ejecución y gestiona cualquier error.
</Step>
</Steps>
@@ -275,9 +410,9 @@ def execute_with_error_handling():
raise
```
### Uso del administrador de contexto
### Uso del gestor de contexto
Usa el cliente como un administrador de contexto para manejar automáticamente la limpieza de recursos:
Usa el cliente como un gestor de contexto para manejar automáticamente la limpieza de recursos:
```python
from simstudio import SimStudioClient
@@ -290,7 +425,7 @@ with SimStudioClient(api_key=os.getenv("SIM_API_KEY")) as client:
# Session is automatically closed here
```
### Ejecución por lotes de flujos de trabajo
### Ejecución de flujos de trabajo por lotes
Ejecuta múltiples flujos de trabajo de manera eficiente:
@@ -298,7 +433,7 @@ Ejecuta múltiples flujos de trabajo de manera eficiente:
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_workflows_batch(workflow_data_pairs):
"""Execute multiple workflows with different input data."""
@@ -339,6 +474,230 @@ for result in results:
print(f"Workflow {result['workflow_id']}: {'Success' if result['success'] else 'Failed'}")
```
### Ejecución asíncrona de flujos de trabajo
Ejecuta flujos de trabajo de forma asíncrona para tareas de larga duración:
```python
import os
import time
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_async():
try:
# Start async execution
result = client.execute_workflow(
"workflow-id",
input_data={"data": "large dataset"},
async_execution=True # Execute asynchronously
)
# Check if result is an async execution
if hasattr(result, 'task_id'):
print(f"Task ID: {result.task_id}")
print(f"Status endpoint: {result.links['status']}")
# Poll for completion
status = client.get_job_status(result.task_id)
while status["status"] in ["queued", "processing"]:
print(f"Current status: {status['status']}")
time.sleep(2) # Wait 2 seconds
status = client.get_job_status(result.task_id)
if status["status"] == "completed":
print("Workflow completed!")
print(f"Output: {status['output']}")
print(f"Duration: {status['metadata']['duration']}")
else:
print(f"Workflow failed: {status['error']}")
except Exception as error:
print(f"Error: {error}")
execute_async()
```
### Límite de tasa y reintentos
Maneja los límites de tasa automáticamente con retroceso exponencial:
```python
import os
from simstudio import SimStudioClient, SimStudioError
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_retry_handling():
try:
# Automatically retries on rate limit
result = client.execute_with_retry(
"workflow-id",
input_data={"message": "Process this"},
max_retries=5,
initial_delay=1.0,
max_delay=60.0,
backoff_multiplier=2.0
)
print(f"Success: {result}")
except SimStudioError as error:
if error.code == "RATE_LIMIT_EXCEEDED":
print("Rate limit exceeded after all retries")
# Check rate limit info
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
from datetime import datetime
reset_time = datetime.fromtimestamp(rate_limit_info.reset)
print(f"Rate limit resets at: {reset_time}")
execute_with_retry_handling()
```
### Monitoreo de uso
Monitorea el uso de tu cuenta y sus límites:
```python
import os
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def check_usage():
try:
limits = client.get_usage_limits()
print("=== Rate Limits ===")
print("Sync requests:")
print(f" Limit: {limits.rate_limit['sync']['limit']}")
print(f" Remaining: {limits.rate_limit['sync']['remaining']}")
print(f" Resets at: {limits.rate_limit['sync']['resetAt']}")
print(f" Is limited: {limits.rate_limit['sync']['isLimited']}")
print("\nAsync requests:")
print(f" Limit: {limits.rate_limit['async']['limit']}")
print(f" Remaining: {limits.rate_limit['async']['remaining']}")
print(f" Resets at: {limits.rate_limit['async']['resetAt']}")
print(f" Is limited: {limits.rate_limit['async']['isLimited']}")
print("\n=== Usage ===")
print(f"Current period cost: ${limits.usage['currentPeriodCost']:.2f}")
print(f"Limit: ${limits.usage['limit']:.2f}")
print(f"Plan: {limits.usage['plan']}")
percent_used = (limits.usage['currentPeriodCost'] / limits.usage['limit']) * 100
print(f"Usage: {percent_used:.1f}%")
if percent_used > 80:
print("⚠️ Warning: You are approaching your usage limit!")
except Exception as error:
print(f"Error checking usage: {error}")
check_usage()
```
### Ejecución de flujo de trabajo en streaming
Ejecuta flujos de trabajo con respuestas en tiempo real:
```python
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_streaming():
"""Execute workflow with streaming enabled."""
try:
# Enable streaming for specific block outputs
result = client.execute_workflow(
"workflow-id",
input_data={"message": "Count to five"},
stream=True,
selected_outputs=["agent1.content"] # Use blockName.attribute format
)
print("Workflow result:", result)
except Exception as error:
print("Error:", error)
execute_with_streaming()
```
La respuesta en streaming sigue el formato de Server-Sent Events (SSE):
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**Ejemplo de streaming con Flask:**
```python
from flask import Flask, Response, stream_with_context
import requests
import json
import os
app = Flask(__name__)
@app.route('/stream-workflow')
def stream_workflow():
"""Stream workflow execution to the client."""
def generate():
response = requests.post(
'https://sim.ai/api/workflows/WORKFLOW_ID/execute',
headers={
'Content-Type': 'application/json',
'X-API-Key': os.getenv('SIM_API_KEY')
},
json={
'message': 'Generate a story',
'stream': True,
'selectedOutputs': ['agent1.content']
},
stream=True
)
for line in response.iter_lines():
if line:
decoded_line = line.decode('utf-8')
if decoded_line.startswith('data: '):
data = decoded_line[6:] # Remove 'data: ' prefix
if data == '[DONE]':
break
try:
parsed = json.loads(data)
if 'chunk' in parsed:
yield f"data: {json.dumps(parsed)}\n\n"
elif parsed.get('event') == 'done':
yield f"data: {json.dumps(parsed)}\n\n"
print("Execution complete:", parsed.get('metadata'))
except json.JSONDecodeError:
pass
return Response(
stream_with_context(generate()),
mimetype='text/event-stream'
)
if __name__ == '__main__':
app.run(debug=True)
```
### Configuración del entorno
Configura el cliente usando variables de entorno:
@@ -352,7 +711,7 @@ Configura el cliente usando variables de entorno:
# Development configuration
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY"),
api_key=os.getenv("SIM_API_KEY")
base_url=os.getenv("SIM_BASE_URL", "https://sim.ai")
)
```

View File

@@ -7,10 +7,10 @@ import { Card, Cards } from 'fumadocs-ui/components/card'
import { Step, Steps } from 'fumadocs-ui/components/steps'
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
El SDK oficial de TypeScript/JavaScript para Sim proporciona seguridad de tipos completa y es compatible tanto con entornos Node.js como con navegadores, lo que te permite ejecutar flujos de trabajo de forma programática desde tus aplicaciones Node.js, aplicaciones web y otros entornos JavaScript. Todas las ejecuciones de flujos de trabajo son actualmente síncronas.
El SDK oficial de TypeScript/JavaScript para Sim proporciona seguridad de tipos completa y es compatible tanto con entornos Node.js como de navegador, lo que te permite ejecutar flujos de trabajo programáticamente desde tus aplicaciones Node.js, aplicaciones web y otros entornos JavaScript.
<Callout type="info">
El SDK de TypeScript proporciona seguridad de tipos completa y es compatible tanto con entornos Node.js como con navegadores. Todas las ejecuciones de flujos de trabajo son actualmente síncronas.
El SDK de TypeScript proporciona seguridad de tipos completa, soporte para ejecución asíncrona, limitación automática de velocidad con retroceso exponencial y seguimiento de uso.
</Callout>
## Instalación
@@ -95,8 +95,13 @@ const result = await client.executeWorkflow('workflow-id', {
- `options` (ExecutionOptions, opcional):
- `input` (any): Datos de entrada para pasar al flujo de trabajo
- `timeout` (number): Tiempo de espera en milisegundos (predeterminado: 30000)
- `stream` (boolean): Habilitar respuestas en streaming (predeterminado: false)
- `selectedOutputs` (string[]): Bloquear salidas para transmitir en formato `blockName.attribute` (por ejemplo, `["agent1.content"]`)
- `async` (boolean): Ejecutar de forma asíncrona (predeterminado: false)
**Devuelve:** `Promise<WorkflowExecutionResult>`
**Devuelve:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
Cuando `async: true`, devuelve inmediatamente un ID de tarea para sondeo. De lo contrario, espera a que se complete.
##### getWorkflowStatus()
@@ -128,32 +133,121 @@ if (isReady) {
**Devuelve:** `Promise<boolean>`
##### executeWorkflowSync()
##### getJobStatus()
<Callout type="info">
Actualmente, este método es idéntico a `executeWorkflow()` ya que todas las ejecuciones son síncronas. Este método se proporciona para compatibilidad futura cuando se añada la ejecución asíncrona.
</Callout>
Ejecutar un flujo de trabajo (actualmente síncrono, igual que `executeWorkflow()`).
Obtener el estado de una ejecución de trabajo asíncrono.
```typescript
const result = await client.executeWorkflowSync('workflow-id', {
input: { data: 'some input' },
timeout: 60000
const status = await client.getJobStatus('task-id-from-async-execution');
console.log('Status:', status.status); // 'queued', 'processing', 'completed', 'failed'
if (status.status === 'completed') {
console.log('Output:', status.output);
}
```
**Parámetros:**
- `taskId` (string): El ID de tarea devuelto de la ejecución asíncrona
**Devuelve:** `Promise<JobStatus>`
**Campos de respuesta:**
- `success` (boolean): Si la solicitud fue exitosa
- `taskId` (string): El ID de la tarea
- `status` (string): Uno de `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (object): Contiene `startedAt`, `completedAt`, y `duration`
- `output` (any, opcional): La salida del flujo de trabajo (cuando se completa)
- `error` (any, opcional): Detalles del error (cuando falla)
- `estimatedDuration` (number, opcional): Duración estimada en milisegundos (cuando está procesando/en cola)
##### executeWithRetry()
Ejecuta un flujo de trabajo con reintento automático en errores de límite de tasa utilizando retroceso exponencial.
```typescript
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Hello' },
timeout: 30000
}, {
maxRetries: 3, // Maximum number of retries
initialDelay: 1000, // Initial delay in ms (1 second)
maxDelay: 30000, // Maximum delay in ms (30 seconds)
backoffMultiplier: 2 // Exponential backoff multiplier
});
```
**Parámetros:**
- `workflowId` (string): El ID del flujo de trabajo a ejecutar
- `options` (ExecutionOptions, opcional):
- `input` (any): Datos de entrada para pasar al flujo de trabajo
- `timeout` (number): Tiempo de espera para la solicitud inicial en milisegundos
- `options` (ExecutionOptions, opcional): Igual que `executeWorkflow()`
- `retryOptions` (RetryOptions, opcional):
- `maxRetries` (number): Número máximo de reintentos (predeterminado: 3)
- `initialDelay` (number): Retraso inicial en ms (predeterminado: 1000)
- `maxDelay` (number): Retraso máximo en ms (predeterminado: 30000)
- `backoffMultiplier` (number): Multiplicador de retroceso (predeterminado: 2)
**Devuelve:** `Promise<WorkflowExecutionResult>`
**Devuelve:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
La lógica de reintento utiliza retroceso exponencial (1s → 2s → 4s → 8s...) con fluctuación de ±25% para evitar el efecto de manada. Si la API proporciona una cabecera `retry-after`, se utilizará en su lugar.
##### getRateLimitInfo()
Obtiene la información actual del límite de tasa de la última respuesta de la API.
```typescript
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Limit:', rateLimitInfo.limit);
console.log('Remaining:', rateLimitInfo.remaining);
console.log('Reset:', new Date(rateLimitInfo.reset * 1000));
}
```
**Devuelve:** `RateLimitInfo | null`
##### getUsageLimits()
Obtiene los límites de uso actuales y la información de cuota para tu cuenta.
```typescript
const limits = await client.getUsageLimits();
console.log('Sync requests remaining:', limits.rateLimit.sync.remaining);
console.log('Async requests remaining:', limits.rateLimit.async.remaining);
console.log('Current period cost:', limits.usage.currentPeriodCost);
console.log('Plan:', limits.usage.plan);
```
**Devuelve:** `Promise<UsageLimits>`
**Estructura de respuesta:**
```typescript
{
success: boolean
rateLimit: {
sync: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
async: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
authType: string // 'api' or 'manual'
}
usage: {
currentPeriodCost: number
limit: number
plan: string // e.g., 'free', 'pro'
}
}
```
##### setApiKey()
Actualizar la clave API.
Actualiza la clave API.
```typescript
client.setApiKey('new-api-key');
@@ -161,7 +255,7 @@ client.setApiKey('new-api-key');
##### setBaseUrl()
Actualizar la URL base.
Actualiza la URL base.
```typescript
client.setBaseUrl('https://my-custom-domain.com');
@@ -187,6 +281,20 @@ interface WorkflowExecutionResult {
}
```
### AsyncExecutionResult
```typescript
interface AsyncExecutionResult {
success: boolean;
taskId: string;
status: 'queued';
createdAt: string;
links: {
status: string; // e.g., "/api/jobs/{taskId}"
};
}
```
### WorkflowStatus
```typescript
@@ -198,6 +306,45 @@ interface WorkflowStatus {
}
```
### RateLimitInfo
```typescript
interface RateLimitInfo {
limit: number;
remaining: number;
reset: number;
retryAfter?: number;
}
```
### UsageLimits
```typescript
interface UsageLimits {
success: boolean;
rateLimit: {
sync: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
async: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
authType: string;
};
usage: {
currentPeriodCost: number;
limit: number;
plan: string;
};
}
```
### SimStudioError
```typescript
@@ -207,6 +354,13 @@ class SimStudioError extends Error {
}
```
**Códigos de error comunes:**
- `UNAUTHORIZED`: Clave API inválida
- `TIMEOUT`: Tiempo de espera agotado
- `RATE_LIMIT_EXCEEDED`: Límite de tasa excedido
- `USAGE_LIMIT_EXCEEDED`: Límite de uso excedido
- `EXECUTION_ERROR`: Ejecución del flujo de trabajo fallida
## Ejemplos
### Ejecución básica de flujo de trabajo
@@ -216,13 +370,13 @@ class SimStudioError extends Error {
Configura el SimStudioClient con tu clave API.
</Step>
<Step title="Validar el flujo de trabajo">
Comprueba si el flujo de trabajo está implementado y listo para su ejecución.
Comprueba si el flujo de trabajo está desplegado y listo para su ejecución.
</Step>
<Step title="Ejecutar el flujo de trabajo">
Ejecuta el flujo de trabajo con tus datos de entrada.
</Step>
<Step title="Gestionar el resultado">
Procesa el resultado de la ejecución y maneja cualquier error.
<Step title="Manejar el resultado">
Procesa el resultado de la ejecución y gestiona cualquier error.
</Step>
</Steps>
@@ -349,7 +503,7 @@ Configura el cliente usando variables de entorno:
### Integración con Express de Node.js
Integración con un servidor Express.js:
Integra con un servidor Express.js:
```typescript
import express from 'express';
@@ -430,7 +584,7 @@ export default async function handler(
### Uso del navegador
Uso en el navegador (con la configuración CORS adecuada):
Uso en el navegador (con configuración CORS adecuada):
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
@@ -469,14 +623,14 @@ document.getElementById('executeBtn')?.addEventListener('click', executeClientSi
### Ejemplo de hook de React
Crea un hook personalizado de React para la ejecución del flujo de trabajo:
Crea un hook personalizado de React para la ejecución de flujos de trabajo:
```typescript
import { useState, useCallback } from 'react';
import { SimStudioClient, WorkflowExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.NEXT_PUBLIC_SIM_API_KEY!
apiKey: process.env.SIM_API_KEY!
});
interface UseWorkflowResult {
@@ -532,7 +686,7 @@ function WorkflowComponent() {
<button onClick={handleExecute} disabled={loading}>
{loading ? 'Executing...' : 'Execute Workflow'}
</button>
{error && <div>Error: {error.message}</div>}
{result && (
<div>
@@ -545,38 +699,267 @@ function WorkflowComponent() {
}
```
## Obtener tu clave API
### Ejecución asíncrona de flujos de trabajo
Ejecuta flujos de trabajo de forma asíncrona para tareas de larga duración:
```typescript
import { SimStudioClient, AsyncExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeAsync() {
try {
// Start async execution
const result = await client.executeWorkflow('workflow-id', {
input: { data: 'large dataset' },
async: true // Execute asynchronously
});
// Check if result is an async execution
if ('taskId' in result) {
console.log('Task ID:', result.taskId);
console.log('Status endpoint:', result.links.status);
// Poll for completion
let status = await client.getJobStatus(result.taskId);
while (status.status === 'queued' || status.status === 'processing') {
console.log('Current status:', status.status);
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
status = await client.getJobStatus(result.taskId);
}
if (status.status === 'completed') {
console.log('Workflow completed!');
console.log('Output:', status.output);
console.log('Duration:', status.metadata.duration);
} else {
console.error('Workflow failed:', status.error);
}
}
} catch (error) {
console.error('Error:', error);
}
}
executeAsync();
```
### Límite de tasa y reintentos
Maneja límites de tasa automáticamente con retroceso exponencial:
```typescript
import { SimStudioClient, SimStudioError } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithRetryHandling() {
try {
// Automatically retries on rate limit
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Process this' }
}, {
maxRetries: 5,
initialDelay: 1000,
maxDelay: 60000,
backoffMultiplier: 2
});
console.log('Success:', result);
} catch (error) {
if (error instanceof SimStudioError && error.code === 'RATE_LIMIT_EXCEEDED') {
console.error('Rate limit exceeded after all retries');
// Check rate limit info
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Rate limit resets at:', new Date(rateLimitInfo.reset * 1000));
}
}
}
}
```
### Monitoreo de uso
Monitorea el uso de tu cuenta y sus límites:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function checkUsage() {
try {
const limits = await client.getUsageLimits();
console.log('=== Rate Limits ===');
console.log('Sync requests:');
console.log(' Limit:', limits.rateLimit.sync.limit);
console.log(' Remaining:', limits.rateLimit.sync.remaining);
console.log(' Resets at:', limits.rateLimit.sync.resetAt);
console.log(' Is limited:', limits.rateLimit.sync.isLimited);
console.log('\nAsync requests:');
console.log(' Limit:', limits.rateLimit.async.limit);
console.log(' Remaining:', limits.rateLimit.async.remaining);
console.log(' Resets at:', limits.rateLimit.async.resetAt);
console.log(' Is limited:', limits.rateLimit.async.isLimited);
console.log('\n=== Usage ===');
console.log('Current period cost:
### Streaming Workflow Execution
Execute workflows with real-time streaming responses:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithStreaming() {
try {
// Habilita streaming para salidas de bloques específicos
const result = await client.executeWorkflow('workflow-id', {
input: { message: 'Count to five' },
stream: true,
selectedOutputs: ['agent1.content'] // Usa el formato blockName.attribute
});
console.log('Resultado del flujo de trabajo:', result);
} catch (error) {
console.error('Error:', error);
}
}
```
The streaming response follows the Server-Sent Events (SSE) format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", dos"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**React Streaming Example:**
```typescript
import { useState, useEffect } from 'react';
function StreamingWorkflow() {
const [output, setOutput] = useState('');
const [loading, setLoading] = useState(false);
const executeStreaming = async () => {
setLoading(true);
setOutput('');
// IMPORTANT: Make this API call from your backend server, not the browser
// Never expose your API key in client-side code
const response = await fetch('https://sim.ai/api/workflows/WORKFLOW_ID/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.SIM_API_KEY! // Server-side environment variable only
},
body: JSON.stringify({
message: 'Generate a story',
stream: true,
selectedOutputs: ['agent1.content']
})
});
const reader = response.body?.getReader();
const decoder = new TextDecoder();
while (reader) {
const { done, value } = await reader.read();
if (done) break;
const chunk = decoder.decode(value);
const lines = chunk.split('\n\n');
for (const line of lines) {
if (line.startsWith('data: ')) {
const data = line.slice(6);
if (data === '[DONE]') {
setLoading(false);
break;
}
try {
const parsed = JSON.parse(data);
if (parsed.chunk) {
setOutput(prev => prev + parsed.chunk);
} else if (parsed.event === 'done') {
console.log('Execution complete:', parsed.metadata);
}
} catch (e) {
// Skip invalid JSON
}
}
}
}
};
return (
<div>
<button onClick={executeStreaming} disabled={loading}>
{loading ? 'Generando...' : 'Iniciar streaming'}
</button>
<div style={{ whiteSpace: 'pre-wrap' }}>{output}</div>
</div>
);
}
```
## Getting Your API Key
<Steps>
<Step title="Inicia sesión en Sim">
Navega a [Sim](https://sim.ai) e inicia sesión en tu cuenta.
<Step title="Log in to Sim">
Navigate to [Sim](https://sim.ai) and log in to your account.
</Step>
<Step title="Abre tu flujo de trabajo">
Navega al flujo de trabajo que quieres ejecutar programáticamente.
<Step title="Open your workflow">
Navigate to the workflow you want to execute programmatically.
</Step>
<Step title="Despliega tu flujo de trabajo">
Haz clic en "Deploy" para desplegar tu flujo de trabajo si aún no ha sido desplegado.
<Step title="Deploy your workflow">
Click on "Deploy" to deploy your workflow if it hasn't been deployed yet.
</Step>
<Step title="Crea o selecciona una clave API">
Durante el proceso de despliegue, selecciona o crea una clave API.
<Step title="Create or select an API key">
During the deployment process, select or create an API key.
</Step>
<Step title="Copia la clave API">
Copia la clave API para usarla en tu aplicación TypeScript/JavaScript.
<Step title="Copy the API key">
Copy the API key to use in your TypeScript/JavaScript application.
</Step>
</Steps>
<Callout type="warning">
Mantén tu clave API segura y nunca la incluyas en el control de versiones. Usa variables de entorno o gestión de configuración segura.
Keep your API key secure and never commit it to version control. Use environment variables or secure configuration management.
</Callout>
## Requisitos
## Requirements
- Node.js 16+
- TypeScript 5.0+ (para proyectos TypeScript)
- TypeScript 5.0+ (for TypeScript projects)
## Soporte para TypeScript
## TypeScript Support
El SDK está escrito en TypeScript y proporciona seguridad de tipos completa:
The SDK is written in TypeScript and provides full type safety:
```typescript
import {
@@ -594,7 +977,7 @@ const client: SimStudioClient = new SimStudioClient({
// Type-safe workflow execution
const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-id', {
input: {
message: 'Hello, TypeScript!'
message: '¡Hola, TypeScript!'
}
});
@@ -602,6 +985,7 @@ const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-i
const status: WorkflowStatus = await client.getWorkflowStatus('workflow-id');
```
## Licencia
## License
Apache-2.0
Apache-2.0

View File

@@ -38,15 +38,93 @@ curl -X POST \
Las respuestas exitosas devuelven el resultado de ejecución serializado del Ejecutor. Los errores muestran fallos de validación, autenticación o flujo de trabajo.
## Respuestas en streaming
Habilita el streaming en tiempo real para recibir la salida del flujo de trabajo a medida que se genera, carácter por carácter. Esto es útil para mostrar las respuestas de IA progresivamente a los usuarios.
### Parámetros de solicitud
Añade estos parámetros para habilitar el streaming:
- `stream` - Establece a `true` para habilitar el streaming de eventos enviados por el servidor (SSE)
- `selectedOutputs` - Array de salidas de bloques para transmitir (p. ej., `["agent1.content"]`)
### Formato de salida de bloque
Usa el formato `blockName.attribute` para especificar qué salidas de bloques transmitir:
- Formato: `"blockName.attribute"` (p. ej., si quieres transmitir el contenido del bloque Agente 1, usarías `"agent1.content"`)
- Los nombres de los bloques no distinguen entre mayúsculas y minúsculas y se ignoran los espacios
### Ejemplo de solicitud
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Count to five",
"stream": true,
"selectedOutputs": ["agent1.content"]
}'
```
### Formato de respuesta
Las respuestas en streaming utilizan el formato de eventos enviados por el servidor (SSE):
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", three"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
Cada evento incluye:
- **Fragmentos de streaming**: `{"blockId": "...", "chunk": "text"}` - Texto en tiempo real a medida que se genera
- **Evento final**: `{"event": "done", ...}` - Metadatos de ejecución y resultados completos
- **Terminador**: `[DONE]` - Señala el fin del stream
### Streaming de múltiples bloques
Cuando `selectedOutputs` incluye múltiples bloques, cada fragmento indica qué bloque lo produjo:
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Process this request",
"stream": true,
"selectedOutputs": ["agent1.content", "agent2.content"]
}'
```
El campo `blockId` en cada fragmento te permite dirigir la salida al elemento de UI correcto:
```
data: {"blockId":"agent1-uuid","chunk":"Processing..."}
data: {"blockId":"agent2-uuid","chunk":"Analyzing..."}
data: {"blockId":"agent1-uuid","chunk":" complete"}
```
## Referencia de salida
| Referencia | Descripción |
|-----------|-------------|
| `<api.field>` | Campo definido en el Formato de Entrada |
| `<api.input>` | Cuerpo completo estructurado de la solicitud |
| `<api.field>` | Campo definido en el formato de entrada |
| `<api.input>` | Cuerpo de solicitud estructurado completo |
Si no se define un Formato de Entrada, el ejecutor expone el JSON sin procesar solo en `<api.input>`.
Si no se define un formato de entrada, el ejecutor expone el JSON sin procesar solo en `<api.input>`.
<Callout type="warning">
Un flujo de trabajo puede contener solo un Disparador de API. Publica una nueva implementación después de realizar cambios para que el punto de conexión se mantenga actualizado.
Un flujo de trabajo puede contener solo un disparador de API. Publica una nueva implementación después de los cambios para que el endpoint se mantenga actualizado.
</Callout>

View File

@@ -10,7 +10,7 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
Le SDK Python officiel pour Sim vous permet d'exécuter des workflows de manière programmatique à partir de vos applications Python en utilisant le SDK Python officiel.
<Callout type="info">
Le SDK Python prend en charge Python 3.8+ et fournit une exécution synchrone des workflows. Toutes les exécutions de workflow sont actuellement synchrones.
Le SDK Python prend en charge Python 3.8+ avec support d'exécution asynchrone, limitation automatique du débit avec backoff exponentiel, et suivi d'utilisation.
</Callout>
## Installation
@@ -71,11 +71,16 @@ result = client.execute_workflow(
```
**Paramètres :**
- `workflow_id` (str) : L'ID du workflow à exécuter
- `workflow_id` (str) : L'identifiant du workflow à exécuter
- `input_data` (dict, facultatif) : Données d'entrée à transmettre au workflow
- `timeout` (float, facultatif) : Délai d'attente en secondes (par défaut : 30.0)
- `timeout` (float, facultatif) : Délai d'expiration en secondes (par défaut : 30.0)
- `stream` (bool, facultatif) : Activer les réponses en streaming (par défaut : False)
- `selected_outputs` (list[str], facultatif) : Sorties de blocs à diffuser au format `blockName.attribute` (par exemple, `["agent1.content"]`)
- `async_execution` (bool, facultatif) : Exécuter de manière asynchrone (par défaut : False)
**Retourne :** `WorkflowExecutionResult`
**Retourne :** `WorkflowExecutionResult | AsyncExecutionResult`
Lorsque `async_execution=True`, retourne immédiatement un identifiant de tâche pour l'interrogation. Sinon, attend la fin de l'exécution.
##### get_workflow_status()
@@ -87,13 +92,13 @@ print("Is deployed:", status.is_deployed)
```
**Paramètres :**
- `workflow_id` (str) : L'ID du workflow
- `workflow_id` (str) : L'identifiant du workflow
**Retourne :** `WorkflowStatus`
##### validate_workflow()
Valide qu'un workflow est prêt pour l'exécution.
Valider qu'un workflow est prêt pour l'exécution.
```python
is_ready = client.validate_workflow("workflow-id")
@@ -107,32 +112,122 @@ if is_ready:
**Retourne :** `bool`
##### execute_workflow_sync()
##### get_job_status()
<Callout type="info">
Actuellement, cette méthode est identique à `execute_workflow()` puisque toutes les exécutions sont synchrones. Cette méthode est fournie pour une compatibilité future lorsque l'exécution asynchrone sera ajoutée.
</Callout>
Exécute un workflow (actuellement synchrone, identique à `execute_workflow()`).
Obtenir le statut d'une exécution de tâche asynchrone.
```python
result = client.execute_workflow_sync(
status = client.get_job_status("task-id-from-async-execution")
print("Status:", status["status"]) # 'queued', 'processing', 'completed', 'failed'
if status["status"] == "completed":
print("Output:", status["output"])
```
**Paramètres :**
- `task_id` (str) : L'identifiant de tâche retourné par l'exécution asynchrone
**Retourne :** `Dict[str, Any]`
**Champs de réponse :**
- `success` (bool) : Si la requête a réussi
- `taskId` (str) : L'identifiant de la tâche
- `status` (str) : L'un des états suivants : `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (dict) : Contient `startedAt`, `completedAt`, et `duration`
- `output` (any, facultatif) : La sortie du workflow (une fois terminé)
- `error` (any, facultatif) : Détails de l'erreur (en cas d'échec)
- `estimatedDuration` (int, facultatif) : Durée estimée en millisecondes (lors du traitement/mise en file d'attente)
##### execute_with_retry()
Exécuter un workflow avec réessai automatique en cas d'erreurs de limitation de débit, en utilisant un backoff exponentiel.
```python
result = client.execute_with_retry(
"workflow-id",
input_data={"data": "some input"},
timeout=60.0
input_data={"message": "Hello"},
timeout=30.0,
max_retries=3, # Maximum number of retries
initial_delay=1.0, # Initial delay in seconds
max_delay=30.0, # Maximum delay in seconds
backoff_multiplier=2.0 # Exponential backoff multiplier
)
```
**Paramètres :**
- `workflow_id` (str) : L'identifiant du workflow à exécuter
- `input_data` (dict, facultatif) : Données d'entrée à transmettre au workflow
- `timeout` (float) : Délai d'attente pour la requête initiale en secondes
- `timeout` (float, facultatif) : Délai d'expiration en secondes
- `stream` (bool, facultatif) : Activer les réponses en streaming
- `selected_outputs` (list, facultatif) : Sorties de blocs à diffuser
- `async_execution` (bool, facultatif) : Exécuter de manière asynchrone
- `max_retries` (int, facultatif) : Nombre maximum de tentatives (par défaut : 3)
- `initial_delay` (float, facultatif) : Délai initial en secondes (par défaut : 1.0)
- `max_delay` (float, facultatif) : Délai maximum en secondes (par défaut : 30.0)
- `backoff_multiplier` (float, facultatif) : Multiplicateur de backoff (par défaut : 2.0)
**Retourne :** `WorkflowExecutionResult`
**Retourne :** `WorkflowExecutionResult | AsyncExecutionResult`
La logique de nouvelle tentative utilise un backoff exponentiel (1s → 2s → 4s → 8s...) avec une variation aléatoire de ±25% pour éviter l'effet de horde. Si l'API fournit un en-tête `retry-after`, celui-ci sera utilisé à la place.
##### get_rate_limit_info()
Obtenir les informations actuelles sur les limites de débit à partir de la dernière réponse de l'API.
```python
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
print("Limit:", rate_limit_info.limit)
print("Remaining:", rate_limit_info.remaining)
print("Reset:", datetime.fromtimestamp(rate_limit_info.reset))
```
**Retourne :** `RateLimitInfo | None`
##### get_usage_limits()
Obtenir les limites d'utilisation actuelles et les informations de quota pour votre compte.
```python
limits = client.get_usage_limits()
print("Sync requests remaining:", limits.rate_limit["sync"]["remaining"])
print("Async requests remaining:", limits.rate_limit["async"]["remaining"])
print("Current period cost:", limits.usage["currentPeriodCost"])
print("Plan:", limits.usage["plan"])
```
**Retourne :** `UsageLimits`
**Structure de la réponse :**
```python
{
"success": bool,
"rateLimit": {
"sync": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"async": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"authType": str # 'api' or 'manual'
},
"usage": {
"currentPeriodCost": float,
"limit": float,
"plan": str # e.g., 'free', 'pro'
}
}
```
##### set_api_key()
Met à jour la clé API.
Mettre à jour la clé API.
```python
client.set_api_key("new-api-key")
@@ -140,7 +235,7 @@ client.set_api_key("new-api-key")
##### set_base_url()
Met à jour l'URL de base.
Mettre à jour l'URL de base.
```python
client.set_base_url("https://my-custom-domain.com")
@@ -148,7 +243,7 @@ client.set_base_url("https://my-custom-domain.com")
##### close()
Ferme la session HTTP sous-jacente.
Fermer la session HTTP sous-jacente.
```python
client.close()
@@ -170,6 +265,18 @@ class WorkflowExecutionResult:
total_duration: Optional[float] = None
```
### AsyncExecutionResult
```python
@dataclass
class AsyncExecutionResult:
success: bool
task_id: str
status: str # 'queued'
created_at: str
links: Dict[str, str] # e.g., {"status": "/api/jobs/{taskId}"}
```
### WorkflowStatus
```python
@@ -181,6 +288,27 @@ class WorkflowStatus:
needs_redeployment: bool = False
```
### RateLimitInfo
```python
@dataclass
class RateLimitInfo:
limit: int
remaining: int
reset: int
retry_after: Optional[int] = None
```
### UsageLimits
```python
@dataclass
class UsageLimits:
success: bool
rate_limit: Dict[str, Any]
usage: Dict[str, Any]
```
### SimStudioError
```python
@@ -191,19 +319,26 @@ class SimStudioError(Exception):
self.status = status
```
**Codes d'erreur courants :**
- `UNAUTHORIZED` : Clé API invalide
- `TIMEOUT` : Délai d'attente de la requête dépassé
- `RATE_LIMIT_EXCEEDED` : Limite de débit dépassée
- `USAGE_LIMIT_EXCEEDED` : Limite d'utilisation dépassée
- `EXECUTION_ERROR` : Échec de l'exécution du workflow
## Exemples
### Exécution de flux de travail basique
### Exécution basique d'un workflow
<Steps>
<Step title="Initialiser le client">
Configurez le SimStudioClient avec votre clé API.
</Step>
<Step title="Valider le flux de travail">
Vérifiez si le flux de travail est déployé et prêt pour l'exécution.
<Step title="Valider le workflow">
Vérifiez si le workflow est déployé et prêt pour l'exécution.
</Step>
<Step title="Exécuter le flux de travail">
Lancez le flux de travail avec vos données d'entrée.
<Step title="Exécuter le workflow">
Lancez le workflow avec vos données d'entrée.
</Step>
<Step title="Gérer le résultat">
Traitez le résultat de l'exécution et gérez les éventuelles erreurs.
@@ -246,13 +381,13 @@ run_workflow()
### Gestion des erreurs
Gérez différents types d'erreurs qui peuvent survenir pendant l'exécution du flux de travail :
Gérez différents types d'erreurs qui peuvent survenir pendant l'exécution du workflow :
```python
from simstudio import SimStudioClient, SimStudioError
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_error_handling():
try:
@@ -290,9 +425,9 @@ with SimStudioClient(api_key=os.getenv("SIM_API_KEY")) as client:
# Session is automatically closed here
```
### Exécution de flux de travail par lots
### Exécution de workflows par lots
Exécutez plusieurs flux de travail efficacement :
Exécutez plusieurs workflows efficacement :
```python
from simstudio import SimStudioClient
@@ -339,6 +474,230 @@ for result in results:
print(f"Workflow {result['workflow_id']}: {'Success' if result['success'] else 'Failed'}")
```
### Exécution asynchrone de workflow
Exécutez des workflows de manière asynchrone pour les tâches de longue durée :
```python
import os
import time
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_async():
try:
# Start async execution
result = client.execute_workflow(
"workflow-id",
input_data={"data": "large dataset"},
async_execution=True # Execute asynchronously
)
# Check if result is an async execution
if hasattr(result, 'task_id'):
print(f"Task ID: {result.task_id}")
print(f"Status endpoint: {result.links['status']}")
# Poll for completion
status = client.get_job_status(result.task_id)
while status["status"] in ["queued", "processing"]:
print(f"Current status: {status['status']}")
time.sleep(2) # Wait 2 seconds
status = client.get_job_status(result.task_id)
if status["status"] == "completed":
print("Workflow completed!")
print(f"Output: {status['output']}")
print(f"Duration: {status['metadata']['duration']}")
else:
print(f"Workflow failed: {status['error']}")
except Exception as error:
print(f"Error: {error}")
execute_async()
```
### Limitation de débit et nouvelle tentative
Gérez les limites de débit automatiquement avec un retrait exponentiel :
```python
import os
from simstudio import SimStudioClient, SimStudioError
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_retry_handling():
try:
# Automatically retries on rate limit
result = client.execute_with_retry(
"workflow-id",
input_data={"message": "Process this"},
max_retries=5,
initial_delay=1.0,
max_delay=60.0,
backoff_multiplier=2.0
)
print(f"Success: {result}")
except SimStudioError as error:
if error.code == "RATE_LIMIT_EXCEEDED":
print("Rate limit exceeded after all retries")
# Check rate limit info
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
from datetime import datetime
reset_time = datetime.fromtimestamp(rate_limit_info.reset)
print(f"Rate limit resets at: {reset_time}")
execute_with_retry_handling()
```
### Surveillance de l'utilisation
Surveillez l'utilisation et les limites de votre compte :
```python
import os
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def check_usage():
try:
limits = client.get_usage_limits()
print("=== Rate Limits ===")
print("Sync requests:")
print(f" Limit: {limits.rate_limit['sync']['limit']}")
print(f" Remaining: {limits.rate_limit['sync']['remaining']}")
print(f" Resets at: {limits.rate_limit['sync']['resetAt']}")
print(f" Is limited: {limits.rate_limit['sync']['isLimited']}")
print("\nAsync requests:")
print(f" Limit: {limits.rate_limit['async']['limit']}")
print(f" Remaining: {limits.rate_limit['async']['remaining']}")
print(f" Resets at: {limits.rate_limit['async']['resetAt']}")
print(f" Is limited: {limits.rate_limit['async']['isLimited']}")
print("\n=== Usage ===")
print(f"Current period cost: ${limits.usage['currentPeriodCost']:.2f}")
print(f"Limit: ${limits.usage['limit']:.2f}")
print(f"Plan: {limits.usage['plan']}")
percent_used = (limits.usage['currentPeriodCost'] / limits.usage['limit']) * 100
print(f"Usage: {percent_used:.1f}%")
if percent_used > 80:
print("⚠️ Warning: You are approaching your usage limit!")
except Exception as error:
print(f"Error checking usage: {error}")
check_usage()
```
### Exécution de workflow en streaming
Exécutez des workflows avec des réponses en streaming en temps réel :
```python
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_streaming():
"""Execute workflow with streaming enabled."""
try:
# Enable streaming for specific block outputs
result = client.execute_workflow(
"workflow-id",
input_data={"message": "Count to five"},
stream=True,
selected_outputs=["agent1.content"] # Use blockName.attribute format
)
print("Workflow result:", result)
except Exception as error:
print("Error:", error)
execute_with_streaming()
```
La réponse en streaming suit le format Server-Sent Events (SSE) :
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**Exemple de streaming avec Flask :**
```python
from flask import Flask, Response, stream_with_context
import requests
import json
import os
app = Flask(__name__)
@app.route('/stream-workflow')
def stream_workflow():
"""Stream workflow execution to the client."""
def generate():
response = requests.post(
'https://sim.ai/api/workflows/WORKFLOW_ID/execute',
headers={
'Content-Type': 'application/json',
'X-API-Key': os.getenv('SIM_API_KEY')
},
json={
'message': 'Generate a story',
'stream': True,
'selectedOutputs': ['agent1.content']
},
stream=True
)
for line in response.iter_lines():
if line:
decoded_line = line.decode('utf-8')
if decoded_line.startswith('data: '):
data = decoded_line[6:] # Remove 'data: ' prefix
if data == '[DONE]':
break
try:
parsed = json.loads(data)
if 'chunk' in parsed:
yield f"data: {json.dumps(parsed)}\n\n"
elif parsed.get('event') == 'done':
yield f"data: {json.dumps(parsed)}\n\n"
print("Execution complete:", parsed.get('metadata'))
except json.JSONDecodeError:
pass
return Response(
stream_with_context(generate()),
mimetype='text/event-stream'
)
if __name__ == '__main__':
app.run(debug=True)
```
### Configuration de l'environnement
Configurez le client en utilisant des variables d'environnement :
@@ -352,7 +711,7 @@ Configurez le client en utilisant des variables d'environnement :
# Development configuration
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY"),
api_key=os.getenv("SIM_API_KEY")
base_url=os.getenv("SIM_BASE_URL", "https://sim.ai")
)
```
@@ -378,17 +737,17 @@ Configurez le client en utilisant des variables d'environnement :
</Tab>
</Tabs>
## Obtenir votre clé API
## Obtention de votre clé API
<Steps>
<Step title="Connectez-vous à Sim">
Accédez à [Sim](https://sim.ai) et connectez-vous à votre compte.
</Step>
<Step title="Ouvrez votre flux de travail">
Naviguez vers le flux de travail que vous souhaitez exécuter par programmation.
<Step title="Ouvrez votre workflow">
Accédez au workflow que vous souhaitez exécuter par programmation.
</Step>
<Step title="Déployez votre flux de travail">
Cliquez sur "Déployer" pour déployer votre flux de travail s'il n'a pas encore été déployé.
<Step title="Déployez votre workflow">
Cliquez sur "Déployer" pour déployer votre workflow s'il n'a pas encore été déployé.
</Step>
<Step title="Créez ou sélectionnez une clé API">
Pendant le processus de déploiement, sélectionnez ou créez une clé API.

View File

@@ -7,10 +7,10 @@ import { Card, Cards } from 'fumadocs-ui/components/card'
import { Step, Steps } from 'fumadocs-ui/components/steps'
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
Le SDK officiel TypeScript/JavaScript pour Sim offre une sécurité de type complète et prend en charge les environnements Node.js et navigateur, vous permettant d'exécuter des workflows de manière programmatique depuis vos applications Node.js, applications web et autres environnements JavaScript. Toutes les exécutions de workflow sont actuellement synchrones.
Le SDK officiel TypeScript/JavaScript pour Sim offre une sécurité de type complète et prend en charge les environnements Node.js et navigateur, vous permettant d'exécuter des workflows par programmation depuis vos applications Node.js, applications web et autres environnements JavaScript.
<Callout type="info">
Le SDK TypeScript offre une sécurité de type complète et prend en charge les environnements Node.js et navigateur. Toutes les exécutions de workflow sont actuellement synchrones.
Le SDK TypeScript offre une sécurité de type complète, la prise en charge de l'exécution asynchrone, une limitation automatique du débit avec backoff exponentiel et le suivi d'utilisation.
</Callout>
## Installation
@@ -91,12 +91,17 @@ const result = await client.executeWorkflow('workflow-id', {
```
**Paramètres :**
- `workflowId` (string) : L'identifiant du workflow à exécuter
- `options` (ExecutionOptions, facultatif) :
- `workflowId` (string) : L'ID du workflow à exécuter
- `options` (ExecutionOptions, optionnel) :
- `input` (any) : Données d'entrée à transmettre au workflow
- `timeout` (number) : Délai d'expiration en millisecondes (par défaut : 30000)
- `stream` (boolean) : Activer les réponses en streaming (par défaut : false)
- `selectedOutputs` (string[]) : Bloquer les sorties à diffuser au format `blockName.attribute` (par exemple, `["agent1.content"]`)
- `async` (boolean) : Exécuter de manière asynchrone (par défaut : false)
**Retourne :** `Promise<WorkflowExecutionResult>`
**Retourne :** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
Lorsque `async: true`, retourne immédiatement avec un ID de tâche pour l'interrogation. Sinon, attend la fin de l'exécution.
##### getWorkflowStatus()
@@ -108,7 +113,7 @@ console.log('Is deployed:', status.isDeployed);
```
**Paramètres :**
- `workflowId` (string) : L'identifiant du workflow
- `workflowId` (string) : L'ID du workflow
**Retourne :** `Promise<WorkflowStatus>`
@@ -124,36 +129,125 @@ if (isReady) {
```
**Paramètres :**
- `workflowId` (string) : L'identifiant du workflow
- `workflowId` (string) : L'ID du workflow
**Retourne :** `Promise<boolean>`
##### executeWorkflowSync()
##### getJobStatus()
<Callout type="info">
Actuellement, cette méthode est identique à `executeWorkflow()` puisque toutes les exécutions sont synchrones. Cette méthode est fournie pour une compatibilité future lorsque l'exécution asynchrone sera ajoutée.
</Callout>
Exécuter un workflow (actuellement synchrone, identique à `executeWorkflow()`).
Obtenir le statut d'une exécution de tâche asynchrone.
```typescript
const result = await client.executeWorkflowSync('workflow-id', {
input: { data: 'some input' },
timeout: 60000
const status = await client.getJobStatus('task-id-from-async-execution');
console.log('Status:', status.status); // 'queued', 'processing', 'completed', 'failed'
if (status.status === 'completed') {
console.log('Output:', status.output);
}
```
**Paramètres :**
- `taskId` (string) : L'ID de tâche retourné par l'exécution asynchrone
**Retourne :** `Promise<JobStatus>`
**Champs de réponse :**
- `success` (boolean) : Indique si la requête a réussi
- `taskId` (string) : L'ID de la tâche
- `status` (string) : L'un des statuts suivants : `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (object) : Contient `startedAt`, `completedAt`, et `duration`
- `output` (any, optionnel) : La sortie du workflow (une fois terminé)
- `error` (any, optionnel) : Détails de l'erreur (en cas d'échec)
- `estimatedDuration` (number, optionnel) : Durée estimée en millisecondes (lorsqu'en traitement/en file d'attente)
##### executeWithRetry()
Exécute un workflow avec une nouvelle tentative automatique en cas d'erreurs de limite de débit en utilisant un backoff exponentiel.
```typescript
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Hello' },
timeout: 30000
}, {
maxRetries: 3, // Maximum number of retries
initialDelay: 1000, // Initial delay in ms (1 second)
maxDelay: 30000, // Maximum delay in ms (30 seconds)
backoffMultiplier: 2 // Exponential backoff multiplier
});
```
**Paramètres :**
- `workflowId` (string) : L'identifiant du workflow à exécuter
- `options` (ExecutionOptions, facultatif) :
- `input` (any) : Données d'entrée à transmettre au workflow
- `timeout` (number) : Délai d'expiration pour la requête initiale en millisecondes
- `options` (ExecutionOptions, facultatif) : Identique à `executeWorkflow()`
- `retryOptions` (RetryOptions, facultatif) :
- `maxRetries` (number) : Nombre maximum de tentatives (par défaut : 3)
- `initialDelay` (number) : Délai initial en ms (par défaut : 1000)
- `maxDelay` (number) : Délai maximum en ms (par défaut : 30000)
- `backoffMultiplier` (number) : Multiplicateur de backoff (par défaut : 2)
**Retourne :** `Promise<WorkflowExecutionResult>`
**Retourne :** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
La logique de nouvelle tentative utilise un backoff exponentiel (1s → 2s → 4s → 8s...) avec une variation aléatoire de ±25 % pour éviter l'effet de rafale. Si l'API fournit un en-tête `retry-after`, celui-ci sera utilisé à la place.
##### getRateLimitInfo()
Obtient les informations actuelles sur les limites de débit à partir de la dernière réponse de l'API.
```typescript
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Limit:', rateLimitInfo.limit);
console.log('Remaining:', rateLimitInfo.remaining);
console.log('Reset:', new Date(rateLimitInfo.reset * 1000));
}
```
**Retourne :** `RateLimitInfo | null`
##### getUsageLimits()
Obtient les limites d'utilisation actuelles et les informations de quota pour votre compte.
```typescript
const limits = await client.getUsageLimits();
console.log('Sync requests remaining:', limits.rateLimit.sync.remaining);
console.log('Async requests remaining:', limits.rateLimit.async.remaining);
console.log('Current period cost:', limits.usage.currentPeriodCost);
console.log('Plan:', limits.usage.plan);
```
**Retourne :** `Promise<UsageLimits>`
**Structure de la réponse :**
```typescript
{
success: boolean
rateLimit: {
sync: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
async: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
authType: string // 'api' or 'manual'
}
usage: {
currentPeriodCost: number
limit: number
plan: string // e.g., 'free', 'pro'
}
}
```
##### setApiKey()
Mettre à jour la clé API.
Met à jour la clé API.
```typescript
client.setApiKey('new-api-key');
@@ -161,7 +255,7 @@ client.setApiKey('new-api-key');
##### setBaseUrl()
Mettre à jour l'URL de base.
Met à jour l'URL de base.
```typescript
client.setBaseUrl('https://my-custom-domain.com');
@@ -187,6 +281,20 @@ interface WorkflowExecutionResult {
}
```
### AsyncExecutionResult
```typescript
interface AsyncExecutionResult {
success: boolean;
taskId: string;
status: 'queued';
createdAt: string;
links: {
status: string; // e.g., "/api/jobs/{taskId}"
};
}
```
### WorkflowStatus
```typescript
@@ -198,6 +306,45 @@ interface WorkflowStatus {
}
```
### RateLimitInfo
```typescript
interface RateLimitInfo {
limit: number;
remaining: number;
reset: number;
retryAfter?: number;
}
```
### UsageLimits
```typescript
interface UsageLimits {
success: boolean;
rateLimit: {
sync: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
async: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
authType: string;
};
usage: {
currentPeriodCost: number;
limit: number;
plan: string;
};
}
```
### SimStudioError
```typescript
@@ -207,9 +354,16 @@ class SimStudioError extends Error {
}
```
**Codes d'erreur courants :**
- `UNAUTHORIZED` : Clé API invalide
- `TIMEOUT` : Délai d'attente de la requête dépassé
- `RATE_LIMIT_EXCEEDED` : Limite de débit dépassée
- `USAGE_LIMIT_EXCEEDED` : Limite d'utilisation dépassée
- `EXECUTION_ERROR` : Échec de l'exécution du workflow
## Exemples
### Exécution de workflow basique
### Exécution basique d'un workflow
<Steps>
<Step title="Initialiser le client">
@@ -469,14 +623,14 @@ document.getElementById('executeBtn')?.addEventListener('click', executeClientSi
### Exemple de hook React
Créez un hook React personnalisé pour l'exécution du workflow :
Créer un hook React personnalisé pour l'exécution de workflow :
```typescript
import { useState, useCallback } from 'react';
import { SimStudioClient, WorkflowExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.NEXT_PUBLIC_SIM_API_KEY!
apiKey: process.env.SIM_API_KEY!
});
interface UseWorkflowResult {
@@ -532,7 +686,7 @@ function WorkflowComponent() {
<button onClick={handleExecute} disabled={loading}>
{loading ? 'Executing...' : 'Execute Workflow'}
</button>
{error && <div>Error: {error.message}</div>}
{result && (
<div>
@@ -545,38 +699,267 @@ function WorkflowComponent() {
}
```
## Obtenir votre clé API
### Exécution asynchrone de workflow
Exécuter des workflows de manière asynchrone pour les tâches de longue durée :
```typescript
import { SimStudioClient, AsyncExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeAsync() {
try {
// Start async execution
const result = await client.executeWorkflow('workflow-id', {
input: { data: 'large dataset' },
async: true // Execute asynchronously
});
// Check if result is an async execution
if ('taskId' in result) {
console.log('Task ID:', result.taskId);
console.log('Status endpoint:', result.links.status);
// Poll for completion
let status = await client.getJobStatus(result.taskId);
while (status.status === 'queued' || status.status === 'processing') {
console.log('Current status:', status.status);
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
status = await client.getJobStatus(result.taskId);
}
if (status.status === 'completed') {
console.log('Workflow completed!');
console.log('Output:', status.output);
console.log('Duration:', status.metadata.duration);
} else {
console.error('Workflow failed:', status.error);
}
}
} catch (error) {
console.error('Error:', error);
}
}
executeAsync();
```
### Limitation de débit et nouvelle tentative
Gérer automatiquement les limites de débit avec backoff exponentiel :
```typescript
import { SimStudioClient, SimStudioError } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithRetryHandling() {
try {
// Automatically retries on rate limit
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Process this' }
}, {
maxRetries: 5,
initialDelay: 1000,
maxDelay: 60000,
backoffMultiplier: 2
});
console.log('Success:', result);
} catch (error) {
if (error instanceof SimStudioError && error.code === 'RATE_LIMIT_EXCEEDED') {
console.error('Rate limit exceeded after all retries');
// Check rate limit info
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Rate limit resets at:', new Date(rateLimitInfo.reset * 1000));
}
}
}
}
```
### Surveillance d'utilisation
Surveiller l'utilisation et les limites de votre compte :
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function checkUsage() {
try {
const limits = await client.getUsageLimits();
console.log('=== Rate Limits ===');
console.log('Sync requests:');
console.log(' Limit:', limits.rateLimit.sync.limit);
console.log(' Remaining:', limits.rateLimit.sync.remaining);
console.log(' Resets at:', limits.rateLimit.sync.resetAt);
console.log(' Is limited:', limits.rateLimit.sync.isLimited);
console.log('\nAsync requests:');
console.log(' Limit:', limits.rateLimit.async.limit);
console.log(' Remaining:', limits.rateLimit.async.remaining);
console.log(' Resets at:', limits.rateLimit.async.resetAt);
console.log(' Is limited:', limits.rateLimit.async.isLimited);
console.log('\n=== Usage ===');
console.log('Current period cost:
### Streaming Workflow Execution
Execute workflows with real-time streaming responses:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithStreaming() {
try {
// Activer le streaming pour des sorties de blocs spécifiques
const result = await client.executeWorkflow('workflow-id', {
input: { message: 'Compter jusqu'à cinq' },
stream: true,
selectedOutputs: ['agent1.content'] // Utiliser le format blockName.attribute
});
console.log('Résultat du workflow :', result);
} catch (error) {
console.error('Erreur :', error);
}
}
```
The streaming response follows the Server-Sent Events (SSE) format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", deux"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**React Streaming Example:**
```typescript
import { useState, useEffect } from 'react';
function StreamingWorkflow() {
const [output, setOutput] = useState('');
const [loading, setLoading] = useState(false);
const executeStreaming = async () => {
setLoading(true);
setOutput('');
// IMPORTANT: Make this API call from your backend server, not the browser
// Never expose your API key in client-side code
const response = await fetch('https://sim.ai/api/workflows/WORKFLOW_ID/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.SIM_API_KEY! // Server-side environment variable only
},
body: JSON.stringify({
message: 'Generate a story',
stream: true,
selectedOutputs: ['agent1.content']
})
});
const reader = response.body?.getReader();
const decoder = new TextDecoder();
while (reader) {
const { done, value } = await reader.read();
if (done) break;
const chunk = decoder.decode(value);
const lines = chunk.split('\n\n');
for (const line of lines) {
if (line.startsWith('data: ')) {
const data = line.slice(6);
if (data === '[DONE]') {
setLoading(false);
break;
}
try {
const parsed = JSON.parse(data);
if (parsed.chunk) {
setOutput(prev => prev + parsed.chunk);
} else if (parsed.event === 'done') {
console.log('Execution complete:', parsed.metadata);
}
} catch (e) {
// Skip invalid JSON
}
}
}
}
};
return (
<div>
<button onClick={executeStreaming} disabled={loading}>
{loading ? 'Génération en cours...' : 'Démarrer le streaming'}
</button>
<div style={{ whiteSpace: 'pre-wrap' }}>{output}</div>
</div>
);
}
```
## Getting Your API Key
<Steps>
<Step title="Connectez-vous à Sim">
Accédez à [Sim](https://sim.ai) et connectez-vous à votre compte.
<Step title="Log in to Sim">
Navigate to [Sim](https://sim.ai) and log in to your account.
</Step>
<Step title="Ouvrez votre workflow">
Accédez au workflow que vous souhaitez exécuter par programmation.
<Step title="Open your workflow">
Navigate to the workflow you want to execute programmatically.
</Step>
<Step title="Déployez votre workflow">
Cliquez sur « Déployer » pour déployer votre workflow s'il n'a pas encore été déployé.
<Step title="Deploy your workflow">
Click on "Deploy" to deploy your workflow if it hasn't been deployed yet.
</Step>
<Step title="Créez ou sélectionnez une clé API">
Pendant le processus de déploiement, sélectionnez ou créez une clé API.
<Step title="Create or select an API key">
During the deployment process, select or create an API key.
</Step>
<Step title="Copiez la clé API">
Copiez la clé API à utiliser dans votre application TypeScript/JavaScript.
<Step title="Copy the API key">
Copy the API key to use in your TypeScript/JavaScript application.
</Step>
</Steps>
<Callout type="warning">
Gardez votre clé API en sécurité et ne la soumettez jamais au contrôle de version. Utilisez des variables d'environnement ou une gestion de configuration sécurisée.
Keep your API key secure and never commit it to version control. Use environment variables or secure configuration management.
</Callout>
## Prérequis
## Requirements
- Node.js 16+
- TypeScript 5.0+ (pour les projets TypeScript)
- TypeScript 5.0+ (for TypeScript projects)
## Support TypeScript
## TypeScript Support
Le SDK est écrit en TypeScript et offre une sécurité de type complète :
The SDK is written in TypeScript and provides full type safety:
```typescript
import {
@@ -594,7 +977,7 @@ const client: SimStudioClient = new SimStudioClient({
// Type-safe workflow execution
const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-id', {
input: {
message: 'Hello, TypeScript!'
message: 'Bonjour, TypeScript !'
}
});
@@ -602,6 +985,7 @@ const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-i
const status: WorkflowStatus = await client.getWorkflowStatus('workflow-id');
```
## Licence
## License
Apache-2.0
Apache-2.0

View File

@@ -38,6 +38,84 @@ curl -X POST \
Les réponses réussies renvoient le résultat d'exécution sérialisé de l'exécuteur. Les erreurs révèlent des problèmes de validation, d'authentification ou d'échec du workflow.
## Réponses en streaming
Activez le streaming en temps réel pour recevoir les résultats du workflow au fur et à mesure qu'ils sont générés, caractère par caractère. Cela est utile pour afficher progressivement les réponses de l'IA aux utilisateurs.
### Paramètres de requête
Ajoutez ces paramètres pour activer le streaming :
- `stream` - Définissez à `true` pour activer le streaming Server-Sent Events (SSE)
- `selectedOutputs` - Tableau des sorties de blocs à diffuser en streaming (par exemple, `["agent1.content"]`)
### Format de sortie de bloc
Utilisez le format `blockName.attribute` pour spécifier quelles sorties de blocs diffuser en streaming :
- Format : `"blockName.attribute"` (par exemple, si vous souhaitez diffuser en streaming le contenu du bloc Agent 1, vous utiliseriez `"agent1.content"`)
- Les noms de blocs ne sont pas sensibles à la casse et les espaces sont ignorés
### Exemple de requête
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Count to five",
"stream": true,
"selectedOutputs": ["agent1.content"]
}'
```
### Format de réponse
Les réponses en streaming utilisent le format Server-Sent Events (SSE) :
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", three"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
Chaque événement comprend :
- **Fragments en streaming** : `{"blockId": "...", "chunk": "text"}` - Texte en temps réel au fur et à mesure qu'il est généré
- **Événement final** : `{"event": "done", ...}` - Métadonnées d'exécution et résultats complets
- **Terminateur** : `[DONE]` - Signale la fin du flux
### Streaming de plusieurs blocs
Lorsque `selectedOutputs` inclut plusieurs blocs, chaque fragment indique quel bloc l'a produit :
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Process this request",
"stream": true,
"selectedOutputs": ["agent1.content", "agent2.content"]
}'
```
Le champ `blockId` dans chaque fragment vous permet d'acheminer la sortie vers l'élément d'interface utilisateur approprié :
```
data: {"blockId":"agent1-uuid","chunk":"Processing..."}
data: {"blockId":"agent2-uuid","chunk":"Analyzing..."}
data: {"blockId":"agent1-uuid","chunk":" complete"}
```
## Référence des sorties
| Référence | Description |

View File

@@ -10,7 +10,7 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
Simの公式Python SDKを使用すると、公式Python SDKを使用してPythonアプリケーションからプログラムでワークフローを実行できます。
<Callout type="info">
Python SDKはPython 3.8以上をサポートし、同期的なワークフロー実行を提供します。現在、すべてのワークフロー実行は同期的です。
Python SDKはPython 3.8以上をサポートし、同期実行、指数バックオフによる自動レート制限、使用状況追跡機能を提供します。
</Callout>
## インストール
@@ -70,12 +70,17 @@ result = client.execute_workflow(
)
```
**パラメータ**
**パラメータ:**
- `workflow_id` (str): 実行するワークフローのID
- `input_data` (dict, オプション): ワークフローに渡す入力データ
- `timeout` (float, オプション): タイムアウト(秒)(デフォルト30.0
- `timeout` (float, オプション): タイムアウト(秒)(デフォルト: 30.0
- `stream` (bool, オプション): ストリーミングレスポンスを有効にする(デフォルト: False
- `selected_outputs` (list[str], オプション): `blockName.attribute`形式でストリーミングするブロック出力(例: `["agent1.content"]`
- `async_execution` (bool, オプション): 非同期実行(デフォルト: False
**戻り値** `WorkflowExecutionResult`
**戻り値:** `WorkflowExecutionResult | AsyncExecutionResult`
`async_execution=True`の場合、ポーリング用のタスクIDをすぐに返します。それ以外の場合は、完了を待ちます。
##### get_workflow_status()
@@ -86,7 +91,7 @@ status = client.get_workflow_status("workflow-id")
print("Is deployed:", status.is_deployed)
```
**パラメータ**
**パラメータ:**
- `workflow_id` (str): ワークフローのID
**戻り値:** `WorkflowStatus`
@@ -107,28 +112,118 @@ if is_ready:
**戻り値:** `bool`
##### execute_workflow_sync()
##### get_job_status()
<Callout type="info">
現在、このメソッドは `execute_workflow()` と同一です。すべての実行は同期的に行われるためです。このメソッドは、将来的に非同期実行が追加された際の互換性のために提供されています。
</Callout>
ワークフローを実行します(現在は同期的、`execute_workflow()` と同じ)。
非同期ジョブ実行のステータスを取得します。
```python
result = client.execute_workflow_sync(
status = client.get_job_status("task-id-from-async-execution")
print("Status:", status["status"]) # 'queued', 'processing', 'completed', 'failed'
if status["status"] == "completed":
print("Output:", status["output"])
```
**パラメータ:**
- `task_id` (str): 非同期実行から返されたタスクID
**戻り値:** `Dict[str, Any]`
**レスポンスフィールド:**
- `success` (bool): リクエストが成功したかどうか
- `taskId` (str): タスクID
- `status` (str): 次のいずれか: `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (dict): `startedAt`, `completedAt`, `duration`を含む
- `output` (any, オプション): ワークフロー出力(完了時)
- `error` (any, オプション): エラー詳細(失敗時)
- `estimatedDuration` (int, オプション): 推定所要時間(ミリ秒)(処理中/キュー時)
##### execute_with_retry()
指数バックオフを使用してレート制限エラーで自動的に再試行するワークフロー実行。
```python
result = client.execute_with_retry(
"workflow-id",
input_data={"data": "some input"},
timeout=60.0
input_data={"message": "Hello"},
timeout=30.0,
max_retries=3, # Maximum number of retries
initial_delay=1.0, # Initial delay in seconds
max_delay=30.0, # Maximum delay in seconds
backoff_multiplier=2.0 # Exponential backoff multiplier
)
```
**パラメータ:**
- `workflow_id` (str): 実行するワークフローのID
- `input_data` (dict, optional): ワークフローに渡す入力データ
- `timeout` (float): 初期リクエストのタイムアウト(秒)
- `input_data` (dict, オプション): ワークフローに渡す入力データ
- `timeout` (float, オプション): タイムアウト(秒)
- `stream` (bool, オプション): ストリーミングレスポンスを有効にする
- `selected_outputs` (list, オプション): ストリーミングするブロック出力
- `async_execution` (bool, オプション): 非同期実行
- `max_retries` (int, オプション): 最大再試行回数(デフォルト: 3
- `initial_delay` (float, オプション): 初期遅延(秒)(デフォルト: 1.0
- `max_delay` (float, オプション): 最大遅延(秒)(デフォルト: 30.0
- `backoff_multiplier` (float, オプション): バックオフ乗数(デフォルト: 2.0
**戻り値:** `WorkflowExecutionResult`
**戻り値:** `WorkflowExecutionResult | AsyncExecutionResult`
リトライロジックは、サンダリングハード問題を防ぐために±25%のジッターを伴う指数バックオフ1秒→2秒→4秒→8秒...を使用します。APIが `retry-after` ヘッダーを提供する場合、代わりにそれが使用されます。
##### get_rate_limit_info()
最後のAPIレスポンスから現在のレート制限情報を取得します。
```python
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
print("Limit:", rate_limit_info.limit)
print("Remaining:", rate_limit_info.remaining)
print("Reset:", datetime.fromtimestamp(rate_limit_info.reset))
```
**戻り値:** `RateLimitInfo | None`
##### get_usage_limits()
アカウントの現在の使用制限とクォータ情報を取得します。
```python
limits = client.get_usage_limits()
print("Sync requests remaining:", limits.rate_limit["sync"]["remaining"])
print("Async requests remaining:", limits.rate_limit["async"]["remaining"])
print("Current period cost:", limits.usage["currentPeriodCost"])
print("Plan:", limits.usage["plan"])
```
**戻り値:** `UsageLimits`
**レスポンス構造:**
```python
{
"success": bool,
"rateLimit": {
"sync": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"async": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"authType": str # 'api' or 'manual'
},
"usage": {
"currentPeriodCost": float,
"limit": float,
"plan": str # e.g., 'free', 'pro'
}
}
```
##### set_api_key()
@@ -170,6 +265,18 @@ class WorkflowExecutionResult:
total_duration: Optional[float] = None
```
### AsyncExecutionResult
```python
@dataclass
class AsyncExecutionResult:
success: bool
task_id: str
status: str # 'queued'
created_at: str
links: Dict[str, str] # e.g., {"status": "/api/jobs/{taskId}"}
```
### WorkflowStatus
```python
@@ -181,6 +288,27 @@ class WorkflowStatus:
needs_redeployment: bool = False
```
### RateLimitInfo
```python
@dataclass
class RateLimitInfo:
limit: int
remaining: int
reset: int
retry_after: Optional[int] = None
```
### UsageLimits
```python
@dataclass
class UsageLimits:
success: bool
rate_limit: Dict[str, Any]
usage: Dict[str, Any]
```
### SimStudioError
```python
@@ -191,6 +319,13 @@ class SimStudioError(Exception):
self.status = status
```
**一般的なエラーコード:**
- `UNAUTHORIZED`: 無効なAPIキー
- `TIMEOUT`: リクエストがタイムアウトしました
- `RATE_LIMIT_EXCEEDED`: レート制限を超えました
- `USAGE_LIMIT_EXCEEDED`: 使用制限を超えました
- `EXECUTION_ERROR`: ワークフローの実行に失敗しました
## 例
### 基本的なワークフロー実行
@@ -277,7 +412,7 @@ def execute_with_error_handling():
### コンテキストマネージャーの使用
リソースのクリーンアップを自動的に処理するためにコンテキストマネージャーとしてクライアントを使用します:
リソースのクリーンアップを自動的に処理するためにクライアントをコンテキストマネージャーとして使用します:
```python
from simstudio import SimStudioClient
@@ -339,6 +474,230 @@ for result in results:
print(f"Workflow {result['workflow_id']}: {'Success' if result['success'] else 'Failed'}")
```
### 非同期ワークフロー実行
長時間実行されるタスクのためにワークフローを非同期で実行します:
```python
import os
import time
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_async():
try:
# Start async execution
result = client.execute_workflow(
"workflow-id",
input_data={"data": "large dataset"},
async_execution=True # Execute asynchronously
)
# Check if result is an async execution
if hasattr(result, 'task_id'):
print(f"Task ID: {result.task_id}")
print(f"Status endpoint: {result.links['status']}")
# Poll for completion
status = client.get_job_status(result.task_id)
while status["status"] in ["queued", "processing"]:
print(f"Current status: {status['status']}")
time.sleep(2) # Wait 2 seconds
status = client.get_job_status(result.task_id)
if status["status"] == "completed":
print("Workflow completed!")
print(f"Output: {status['output']}")
print(f"Duration: {status['metadata']['duration']}")
else:
print(f"Workflow failed: {status['error']}")
except Exception as error:
print(f"Error: {error}")
execute_async()
```
### レート制限とリトライ
指数バックオフを使用して自動的にレート制限を処理します:
```python
import os
from simstudio import SimStudioClient, SimStudioError
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_retry_handling():
try:
# Automatically retries on rate limit
result = client.execute_with_retry(
"workflow-id",
input_data={"message": "Process this"},
max_retries=5,
initial_delay=1.0,
max_delay=60.0,
backoff_multiplier=2.0
)
print(f"Success: {result}")
except SimStudioError as error:
if error.code == "RATE_LIMIT_EXCEEDED":
print("Rate limit exceeded after all retries")
# Check rate limit info
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
from datetime import datetime
reset_time = datetime.fromtimestamp(rate_limit_info.reset)
print(f"Rate limit resets at: {reset_time}")
execute_with_retry_handling()
```
### 使用状況モニタリング
アカウントの使用状況と制限をモニタリングします:
```python
import os
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def check_usage():
try:
limits = client.get_usage_limits()
print("=== Rate Limits ===")
print("Sync requests:")
print(f" Limit: {limits.rate_limit['sync']['limit']}")
print(f" Remaining: {limits.rate_limit['sync']['remaining']}")
print(f" Resets at: {limits.rate_limit['sync']['resetAt']}")
print(f" Is limited: {limits.rate_limit['sync']['isLimited']}")
print("\nAsync requests:")
print(f" Limit: {limits.rate_limit['async']['limit']}")
print(f" Remaining: {limits.rate_limit['async']['remaining']}")
print(f" Resets at: {limits.rate_limit['async']['resetAt']}")
print(f" Is limited: {limits.rate_limit['async']['isLimited']}")
print("\n=== Usage ===")
print(f"Current period cost: ${limits.usage['currentPeriodCost']:.2f}")
print(f"Limit: ${limits.usage['limit']:.2f}")
print(f"Plan: {limits.usage['plan']}")
percent_used = (limits.usage['currentPeriodCost'] / limits.usage['limit']) * 100
print(f"Usage: {percent_used:.1f}%")
if percent_used > 80:
print("⚠️ Warning: You are approaching your usage limit!")
except Exception as error:
print(f"Error checking usage: {error}")
check_usage()
```
### ワークフローの実行ストリーミング
リアルタイムのストリーミングレスポンスでワークフローを実行します:
```python
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_streaming():
"""Execute workflow with streaming enabled."""
try:
# Enable streaming for specific block outputs
result = client.execute_workflow(
"workflow-id",
input_data={"message": "Count to five"},
stream=True,
selected_outputs=["agent1.content"] # Use blockName.attribute format
)
print("Workflow result:", result)
except Exception as error:
print("Error:", error)
execute_with_streaming()
```
ストリーミングレスポンスはServer-Sent EventsSSE形式に従います
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**Flaskストリーミングの例**
```python
from flask import Flask, Response, stream_with_context
import requests
import json
import os
app = Flask(__name__)
@app.route('/stream-workflow')
def stream_workflow():
"""Stream workflow execution to the client."""
def generate():
response = requests.post(
'https://sim.ai/api/workflows/WORKFLOW_ID/execute',
headers={
'Content-Type': 'application/json',
'X-API-Key': os.getenv('SIM_API_KEY')
},
json={
'message': 'Generate a story',
'stream': True,
'selectedOutputs': ['agent1.content']
},
stream=True
)
for line in response.iter_lines():
if line:
decoded_line = line.decode('utf-8')
if decoded_line.startswith('data: '):
data = decoded_line[6:] # Remove 'data: ' prefix
if data == '[DONE]':
break
try:
parsed = json.loads(data)
if 'chunk' in parsed:
yield f"data: {json.dumps(parsed)}\n\n"
elif parsed.get('event') == 'done':
yield f"data: {json.dumps(parsed)}\n\n"
print("Execution complete:", parsed.get('metadata'))
except json.JSONDecodeError:
pass
return Response(
stream_with_context(generate()),
mimetype='text/event-stream'
)
if __name__ == '__main__':
app.run(debug=True)
```
### 環境設定
環境変数を使用してクライアントを設定します:
@@ -352,7 +711,7 @@ for result in results:
# Development configuration
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY"),
api_key=os.getenv("SIM_API_KEY")
base_url=os.getenv("SIM_BASE_URL", "https://sim.ai")
)
```

View File

@@ -7,10 +7,10 @@ import { Card, Cards } from 'fumadocs-ui/components/card'
import { Step, Steps } from 'fumadocs-ui/components/steps'
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
公式TypeScript/JavaScript SDKはSimのために完全な型安全性を提供し、Node.jsとブラウザ環境の両方をサポートしています。これにより、Node.jsアプリケーション、Webアプリケーション、その他のJavaScript環境からプログラムワークフローを実行することができます。現在、すべてのワークフロー実行は同期的に行われます。
Sim用の公式TypeScript/JavaScript SDKは完全な型安全性を提供し、Node.jsとブラウザ環境の両方をサポートしています。これにより、Node.jsアプリケーション、Webアプリケーション、その他のJavaScript環境からプログラムによってワークフローを実行することができます。
<Callout type="info">
TypeScript SDKは完全な型安全性を提供し、Node.jsとブラウザ環境の両方をサポートしています。現在、すべてのワークフロー実行は同期的に行われます。
TypeScript SDKは完全な型安全性、非同期実行サポート、指数バックオフによる自動レート制限、使用状況追跡を提供します。
</Callout>
## インストール
@@ -95,8 +95,13 @@ const result = await client.executeWorkflow('workflow-id', {
- `options` (ExecutionOptions, オプション):
- `input` (any): ワークフローに渡す入力データ
- `timeout` (number): タイムアウト(ミリ秒)(デフォルト: 30000
- `stream` (boolean): ストリーミングレスポンスを有効にする(デフォルト: false
- `selectedOutputs` (string[]): `blockName.attribute`形式でストリーミングするブロック出力(例: `["agent1.content"]`
- `async` (boolean): 非同期実行(デフォルト: false
**戻り値:** `Promise<WorkflowExecutionResult>`
**戻り値:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
`async: true`の場合、ポーリング用のタスクIDをすぐに返します。それ以外の場合は、完了を待ちます。
##### getWorkflowStatus()
@@ -114,7 +119,7 @@ console.log('Is deployed:', status.isDeployed);
##### validateWorkflow()
ワークフローが実行準備ができているか検証します。
ワークフローが実行準備ができているか検証します。
```typescript
const isReady = await client.validateWorkflow('workflow-id');
@@ -128,28 +133,117 @@ if (isReady) {
**戻り値:** `Promise<boolean>`
##### executeWorkflowSync()
##### getJobStatus()
<Callout type="info">
現在、このメソッドは `executeWorkflow()` と同一です。すべての実行は同期的に行われるためです。このメソッドは、将来的に非同期実行が追加された際の互換性のために提供されています。
</Callout>
ワークフローを実行します(現在は同期的、`executeWorkflow()` と同じ)。
非同期ジョブ実行のステータスを取得します。
```typescript
const result = await client.executeWorkflowSync('workflow-id', {
input: { data: 'some input' },
timeout: 60000
const status = await client.getJobStatus('task-id-from-async-execution');
console.log('Status:', status.status); // 'queued', 'processing', 'completed', 'failed'
if (status.status === 'completed') {
console.log('Output:', status.output);
}
```
**パラメータ:**
- `taskId` (string): 非同期実行から返されたタスクID
**戻り値:** `Promise<JobStatus>`
**レスポンスフィールド:**
- `success` (boolean): リクエストが成功したかどうか
- `taskId` (string): タスクID
- `status` (string): 次のいずれか `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (object): `startedAt`, `completedAt`, および `duration` を含む
- `output` (any, オプション): ワークフロー出力(完了時)
- `error` (any, オプション): エラー詳細(失敗時)
- `estimatedDuration` (number, オプション): 推定所要時間(ミリ秒)(処理中/キュー時)
##### executeWithRetry()
レート制限エラー時に指数バックオフを使用して自動的に再試行するワークフロー実行。
```typescript
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Hello' },
timeout: 30000
}, {
maxRetries: 3, // Maximum number of retries
initialDelay: 1000, // Initial delay in ms (1 second)
maxDelay: 30000, // Maximum delay in ms (30 seconds)
backoffMultiplier: 2 // Exponential backoff multiplier
});
```
**パラメータ:**
- `workflowId` (string): 実行するワークフローのID
- `options` (ExecutionOptions, オプション):
- `input` (any): ワークフローに渡す入力データ
- `timeout` (number): 初期リクエストのタイムアウト(ミリ秒
- `options` (ExecutionOptions, オプション): `executeWorkflow()`と同じ
- `retryOptions` (RetryOptions, オプション):
- `maxRetries` (number): 最大再試行回数(デフォルト: 3
- `initialDelay` (number): 初期遅延(ミリ秒)(デフォルト: 1000
- `maxDelay` (number): 最大遅延(ミリ秒)(デフォルト: 30000
- `backoffMultiplier` (number): バックオフ乗数(デフォルト: 2
**戻り値:** `Promise<WorkflowExecutionResult>`
**戻り値:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
再試行ロジックは、サンダリングハード問題を防ぐために±25%のジッターを含む指数バックオフ1秒→2秒→4秒→8秒...を使用します。APIが`retry-after`ヘッダーを提供する場合、代わりにそれが使用されます。
##### getRateLimitInfo()
最後のAPIレスポンスから現在のレート制限情報を取得します。
```typescript
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Limit:', rateLimitInfo.limit);
console.log('Remaining:', rateLimitInfo.remaining);
console.log('Reset:', new Date(rateLimitInfo.reset * 1000));
}
```
**戻り値:** `RateLimitInfo | null`
##### getUsageLimits()
アカウントの現在の使用制限とクォータ情報を取得します。
```typescript
const limits = await client.getUsageLimits();
console.log('Sync requests remaining:', limits.rateLimit.sync.remaining);
console.log('Async requests remaining:', limits.rateLimit.async.remaining);
console.log('Current period cost:', limits.usage.currentPeriodCost);
console.log('Plan:', limits.usage.plan);
```
**戻り値:** `Promise<UsageLimits>`
**レスポンス構造:**
```typescript
{
success: boolean
rateLimit: {
sync: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
async: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
authType: string // 'api' or 'manual'
}
usage: {
currentPeriodCost: number
limit: number
plan: string // e.g., 'free', 'pro'
}
}
```
##### setApiKey()
@@ -167,7 +261,7 @@ client.setApiKey('new-api-key');
client.setBaseUrl('https://my-custom-domain.com');
```
## 型
## 型定義
### WorkflowExecutionResult
@@ -187,6 +281,20 @@ interface WorkflowExecutionResult {
}
```
### AsyncExecutionResult
```typescript
interface AsyncExecutionResult {
success: boolean;
taskId: string;
status: 'queued';
createdAt: string;
links: {
status: string; // e.g., "/api/jobs/{taskId}"
};
}
```
### WorkflowStatus
```typescript
@@ -198,6 +306,45 @@ interface WorkflowStatus {
}
```
### RateLimitInfo
```typescript
interface RateLimitInfo {
limit: number;
remaining: number;
reset: number;
retryAfter?: number;
}
```
### UsageLimits
```typescript
interface UsageLimits {
success: boolean;
rateLimit: {
sync: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
async: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
authType: string;
};
usage: {
currentPeriodCost: number;
limit: number;
plan: string;
};
}
```
### SimStudioError
```typescript
@@ -207,9 +354,16 @@ class SimStudioError extends Error {
}
```
**一般的なエラーコード:**
- `UNAUTHORIZED`: 無効なAPIキー
- `TIMEOUT`: リクエストがタイムアウトしました
- `RATE_LIMIT_EXCEEDED`: レート制限を超えました
- `USAGE_LIMIT_EXCEEDED`: 使用制限を超えました
- `EXECUTION_ERROR`: ワークフローの実行に失敗しました
## 例
### 基本的なワークフロー実行
### 基本的なワークフロー実行
<Steps>
<Step title="クライアントの初期化">
@@ -347,7 +501,7 @@ async function executeWithErrorHandling() {
</Tab>
</Tabs>
### Node.js Expressとの統合
### Node.js Express統合
Express.jsサーバーとの統合
@@ -430,7 +584,7 @@ export default async function handler(
### ブラウザでの使用
ブラウザで使用する場合適切なCORS設定が必要
ブラウザで使用適切なCORS設定が必要
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
@@ -464,7 +618,7 @@ document.getElementById('executeBtn')?.addEventListener('click', executeClientSi
```
<Callout type="warning">
ブラウザでSDKを使用する際は、機密性の高いAPIキーを公開しないよう注意してください。バックエンドプロキシや権限が制限された公開APIキーの使用を検討してください。
ブラウザでSDKを使用する場合、機密性の高いAPIキーを公開しないよう注意してください。バックエンドプロキシや権限が制限された公開APIキーの使用を検討してください。
</Callout>
### Reactフックの例
@@ -476,7 +630,7 @@ import { useState, useCallback } from 'react';
import { SimStudioClient, WorkflowExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.NEXT_PUBLIC_SIM_API_KEY!
apiKey: process.env.SIM_API_KEY!
});
interface UseWorkflowResult {
@@ -532,7 +686,7 @@ function WorkflowComponent() {
<button onClick={handleExecute} disabled={loading}>
{loading ? 'Executing...' : 'Execute Workflow'}
</button>
{error && <div>Error: {error.message}</div>}
{result && (
<div>
@@ -545,38 +699,267 @@ function WorkflowComponent() {
}
```
## APIキーの取得方法
### 非同期ワークフロー実行
長時間実行タスク向けに非同期でワークフローを実行:
```typescript
import { SimStudioClient, AsyncExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeAsync() {
try {
// Start async execution
const result = await client.executeWorkflow('workflow-id', {
input: { data: 'large dataset' },
async: true // Execute asynchronously
});
// Check if result is an async execution
if ('taskId' in result) {
console.log('Task ID:', result.taskId);
console.log('Status endpoint:', result.links.status);
// Poll for completion
let status = await client.getJobStatus(result.taskId);
while (status.status === 'queued' || status.status === 'processing') {
console.log('Current status:', status.status);
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
status = await client.getJobStatus(result.taskId);
}
if (status.status === 'completed') {
console.log('Workflow completed!');
console.log('Output:', status.output);
console.log('Duration:', status.metadata.duration);
} else {
console.error('Workflow failed:', status.error);
}
}
} catch (error) {
console.error('Error:', error);
}
}
executeAsync();
```
### レート制限とリトライ
指数バックオフによるレート制限の自動処理:
```typescript
import { SimStudioClient, SimStudioError } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithRetryHandling() {
try {
// Automatically retries on rate limit
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Process this' }
}, {
maxRetries: 5,
initialDelay: 1000,
maxDelay: 60000,
backoffMultiplier: 2
});
console.log('Success:', result);
} catch (error) {
if (error instanceof SimStudioError && error.code === 'RATE_LIMIT_EXCEEDED') {
console.error('Rate limit exceeded after all retries');
// Check rate limit info
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Rate limit resets at:', new Date(rateLimitInfo.reset * 1000));
}
}
}
}
```
### 使用状況モニタリング
アカウントの使用状況と制限のモニタリング:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function checkUsage() {
try {
const limits = await client.getUsageLimits();
console.log('=== Rate Limits ===');
console.log('Sync requests:');
console.log(' Limit:', limits.rateLimit.sync.limit);
console.log(' Remaining:', limits.rateLimit.sync.remaining);
console.log(' Resets at:', limits.rateLimit.sync.resetAt);
console.log(' Is limited:', limits.rateLimit.sync.isLimited);
console.log('\nAsync requests:');
console.log(' Limit:', limits.rateLimit.async.limit);
console.log(' Remaining:', limits.rateLimit.async.remaining);
console.log(' Resets at:', limits.rateLimit.async.resetAt);
console.log(' Is limited:', limits.rateLimit.async.isLimited);
console.log('\n=== Usage ===');
console.log('Current period cost:
### Streaming Workflow Execution
Execute workflows with real-time streaming responses:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithStreaming() {
try {
// 特定のブロック出力のストリーミングを有効化
const result = await client.executeWorkflow('workflow-id', {
input: { message: 'Count to five' },
stream: true,
selectedOutputs: ['agent1.content'] // blockName.attribute形式を使用
});
console.log('ワークフロー結果:', result);
} catch (error) {
console.error('エラー:', error);
}
}
```
The streaming response follows the Server-Sent Events (SSE) format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**React Streaming Example:**
```typescript
import { useState, useEffect } from 'react';
function StreamingWorkflow() {
const [output, setOutput] = useState('');
const [loading, setLoading] = useState(false);
const executeStreaming = async () => {
setLoading(true);
setOutput('');
// IMPORTANT: Make this API call from your backend server, not the browser
// Never expose your API key in client-side code
const response = await fetch('https://sim.ai/api/workflows/WORKFLOW_ID/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.SIM_API_KEY! // Server-side environment variable only
},
body: JSON.stringify({
message: 'Generate a story',
stream: true,
selectedOutputs: ['agent1.content']
})
});
const reader = response.body?.getReader();
const decoder = new TextDecoder();
while (reader) {
const { done, value } = await reader.read();
if (done) break;
const chunk = decoder.decode(value);
const lines = chunk.split('\n\n');
for (const line of lines) {
if (line.startsWith('data: ')) {
const data = line.slice(6);
if (data === '[DONE]') {
setLoading(false);
break;
}
try {
const parsed = JSON.parse(data);
if (parsed.chunk) {
setOutput(prev => prev + parsed.chunk);
} else if (parsed.event === 'done') {
console.log('Execution complete:', parsed.metadata);
}
} catch (e) {
// Skip invalid JSON
}
}
}
}
};
return (
<div>
<button onClick={executeStreaming} disabled={loading}>
{loading ? 'Generating...' : 'Start Streaming'}
</button>
<div style={{ whiteSpace: 'pre-wrap' }}>{output}</div>
</div>
);
}
```
## Getting Your API Key
<Steps>
<Step title="Simにログイン">
[Sim](https://sim.ai)に移動してアカウントにログインします。
<Step title="Log in to Sim">
Navigate to [Sim](https://sim.ai) and log in to your account.
</Step>
<Step title="ワークフローを開く">
プログラムで実行したいワークフローに移動します。
<Step title="Open your workflow">
Navigate to the workflow you want to execute programmatically.
</Step>
<Step title="ワークフローをデプロイ">
まだデプロイされていない場合は、「デプロイ」をクリックしてワークフローをデプロイします。
<Step title="Deploy your workflow">
Click on "Deploy" to deploy your workflow if it hasn't been deployed yet.
</Step>
<Step title="APIキーを作成または選択">
デプロイ処理中に、APIキーを選択または作成します。
<Step title="Create or select an API key">
During the deployment process, select or create an API key.
</Step>
<Step title="APIキーをコピー">
TypeScript/JavaScriptアプリケーションで使用するAPIキーをコピーします。
<Step title="Copy the API key">
Copy the API key to use in your TypeScript/JavaScript application.
</Step>
</Steps>
<Callout type="warning">
APIキーは安全に保管し、バージョン管理システムにコミットしないでください。環境変数や安全な設定管理を使用してください。
Keep your API key secure and never commit it to version control. Use environment variables or secure configuration management.
</Callout>
## 要件
## Requirements
- Node.js 16以上
- TypeScript 5.0以上(TypeScriptプロジェクトの場合)
- Node.js 16+
- TypeScript 5.0+ (for TypeScript projects)
## TypeScriptサポート
## TypeScript Support
このSDKはTypeScriptで書かれており、完全な型安全性を提供します
The SDK is written in TypeScript and provides full type safety:
```typescript
import {
@@ -602,6 +985,7 @@ const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-i
const status: WorkflowStatus = await client.getWorkflowStatus('workflow-id');
```
## ライセンス
## License
Apache-2.0
Apache-2.0

View File

@@ -38,6 +38,84 @@ curl -X POST \
成功したレスポンスはエグゼキュータからシリアル化された実行結果を返します。エラーは検証、認証、またはワークフローの失敗を表示します。
## ストリーミングレスポンス
リアルタイムストリーミングを有効にすると、ワークフローの出力が生成されるたびに文字単位で受信できます。これはAIの応答をユーザーに段階的に表示するのに役立ちます。
### リクエストパラメータ
ストリーミングを有効にするには、これらのパラメータを追加してください:
- `stream` - Server-Sent Events (SSE)ストリーミングを有効にするには `true` に設定します
- `selectedOutputs` - ストリーミングするブロック出力の配列(例:`["agent1.content"]`
### ブロック出力フォーマット
`blockName.attribute` フォーマットを使用して、ストリーミングするブロック出力を指定します:
- フォーマット:`"blockName.attribute"`Agent 1ブロックの内容をストリーミングしたい場合は、`"agent1.content"` を使用します)
- ブロック名は大文字小文字を区別せず、スペースは無視されます
### リクエスト例
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Count to five",
"stream": true,
"selectedOutputs": ["agent1.content"]
}'
```
### レスポンスフォーマット
ストリーミングレスポンスはServer-Sent Events (SSE)フォーマットを使用します:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", three"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
各イベントには以下が含まれます:
- **ストリーミングチャンク**`{"blockId": "...", "chunk": "text"}` - 生成されるリアルタイムテキスト
- **最終イベント**`{"event": "done", ...}` - 実行メタデータと完全な結果
- **ターミネーター**`[DONE]` - ストリーム終了を示す信号
### 複数ブロックのストリーミング
`selectedOutputs` に複数のブロックが含まれる場合、各チャンクはどのブロックから生成されたかを示します:
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Process this request",
"stream": true,
"selectedOutputs": ["agent1.content", "agent2.content"]
}'
```
各チャンクの `blockId` フィールドを使用して、出力を正しいUI要素にルーティングできます
```
data: {"blockId":"agent1-uuid","chunk":"Processing..."}
data: {"blockId":"agent2-uuid","chunk":"Analyzing..."}
data: {"blockId":"agent1-uuid","chunk":" complete"}
```
## 出力リファレンス
| リファレンス | 説明 |
@@ -45,7 +123,7 @@ curl -X POST \
| `<api.field>` | 入力フォーマットで定義されたフィールド |
| `<api.input>` | 構造化されたリクエスト本文全体 |
入力フォーマットが定義されていない場合、エグゼキュータは生のJSONを `<api.input>` のみ公開します。
入力フォーマットが定義されていない場合、エグゼキュータは `<api.input>` のみ生のJSONを公開します。
<Callout type="warning">
ワークフローには1つのAPIトリガーのみ含めることができます。変更後は新しいデプロイメントを公開して、エンドポイントを最新の状態に保ってください。

View File

@@ -10,7 +10,7 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
官方的 Python SDK 允许您通过 Python 应用程序以编程方式执行工作流。
<Callout type="info">
Python SDK 支持 Python 3.8+并提供同步工作流执行。目前所有工作流执行均为同步模式
Python SDK 支持 Python 3.8+具备异步执行支持、自动速率限制(带指数退避)以及使用情况跟踪功能
</Callout>
## 安装
@@ -72,10 +72,15 @@ result = client.execute_workflow(
**参数:**
- `workflow_id` (str): 要执行的工作流 ID
- `input_data` (dict, 可选): 传递给工作流的输入数据
- `timeout` (float, 可选): 超时时间以秒为单位默认值30.0
- `input_data` (dict, optional): 传递给工作流的输入数据
- `timeout` (float, optional): 超时时间以秒为单位默认值30.0
- `stream` (bool, optional): 启用流式响应默认值False
- `selected_outputs` (list[str], optional): 以 `blockName.attribute` 格式阻止输出流(例如,`["agent1.content"]`
- `async_execution` (bool, optional): 异步执行默认值False
**返回值:** `WorkflowExecutionResult`
**返回值:** `WorkflowExecutionResult | AsyncExecutionResult`
当 `async_execution=True` 时,立即返回任务 ID 以供轮询。否则,等待完成。
##### get_workflow_status()
@@ -103,32 +108,122 @@ if is_ready:
```
**参数:**
- `workflow_id` (str)工作流的 ID
- `workflow_id` (str): 工作流的 ID
**返回值:** `bool`
##### execute_workflow_sync()
##### get_job_status()
<Callout type="info">
当前,此方法与 `execute_workflow()` 相同,因为所有执行都是同步的。提供此方法是为了在将来添加异步执行时保持兼容性。
</Callout>
执行工作流(当前为同步,与 `execute_workflow()` 相同)。
获取异步任务执行的状态。
```python
result = client.execute_workflow_sync(
status = client.get_job_status("task-id-from-async-execution")
print("Status:", status["status"]) # 'queued', 'processing', 'completed', 'failed'
if status["status"] == "completed":
print("Output:", status["output"])
```
**参数:**
- `task_id` (str): 异步执行返回的任务 ID
**返回值:** `Dict[str, Any]`
**响应字段:**
- `success` (bool): 请求是否成功
- `taskId` (str): 任务 ID
- `status` (str): 可能的值包括 `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (dict): 包含 `startedAt`, `completedAt` 和 `duration`
- `output` (any, optional): 工作流输出(完成时)
- `error` (any, optional): 错误详情(失败时)
- `estimatedDuration` (int, optional): 估计持续时间(以毫秒为单位,处理中/排队时)
##### execute_with_retry()
使用指数退避在速率限制错误上自动重试执行工作流。
```python
result = client.execute_with_retry(
"workflow-id",
input_data={"data": "some input"},
timeout=60.0
input_data={"message": "Hello"},
timeout=30.0,
max_retries=3, # Maximum number of retries
initial_delay=1.0, # Initial delay in seconds
max_delay=30.0, # Maximum delay in seconds
backoff_multiplier=2.0 # Exponential backoff multiplier
)
```
**参数:**
- `workflow_id` (str)要执行的工作流 ID
- `input_data` (dict, optional)传递给工作流的输入数据
- `timeout` (float):初始请求的超时时间(以秒为单位)
- `workflow_id` (str): 要执行的工作流 ID
- `input_data` (dict, optional): 传递给工作流的输入数据
- `timeout` (float, optional): 超时时间(以秒为单位)
- `stream` (bool, optional): 启用流式响应
- `selected_outputs` (list, optional): 阻止输出流
- `async_execution` (bool, optional): 异步执行
- `max_retries` (int, optional): 最大重试次数默认值3
- `initial_delay` (float, optional): 初始延迟时间以秒为单位默认值1.0
- `max_delay` (float, optional): 最大延迟时间以秒为单位默认值30.0
- `backoff_multiplier` (float, optional): 退避倍数默认值2.0
**返回值:** `WorkflowExecutionResult`
**返回值:** `WorkflowExecutionResult | AsyncExecutionResult`
重试逻辑使用指数退避1 秒 → 2 秒 → 4 秒 → 8 秒...),并带有 ±25% 的抖动以防止惊群效应。如果 API 提供了 `retry-after` 标头,则会使用该标头。
##### get_rate_limit_info()
从上一次 API 响应中获取当前的速率限制信息。
```python
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
print("Limit:", rate_limit_info.limit)
print("Remaining:", rate_limit_info.remaining)
print("Reset:", datetime.fromtimestamp(rate_limit_info.reset))
```
**返回值:** `RateLimitInfo | None`
##### get_usage_limits()
获取您的账户当前的使用限制和配额信息。
```python
limits = client.get_usage_limits()
print("Sync requests remaining:", limits.rate_limit["sync"]["remaining"])
print("Async requests remaining:", limits.rate_limit["async"]["remaining"])
print("Current period cost:", limits.usage["currentPeriodCost"])
print("Plan:", limits.usage["plan"])
```
**返回值:** `UsageLimits`
**响应结构:**
```python
{
"success": bool,
"rateLimit": {
"sync": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"async": {
"isLimited": bool,
"limit": int,
"remaining": int,
"resetAt": str
},
"authType": str # 'api' or 'manual'
},
"usage": {
"currentPeriodCost": float,
"limit": float,
"plan": str # e.g., 'free', 'pro'
}
}
```
##### set_api_key()
@@ -170,6 +265,18 @@ class WorkflowExecutionResult:
total_duration: Optional[float] = None
```
### AsyncExecutionResult
```python
@dataclass
class AsyncExecutionResult:
success: bool
task_id: str
status: str # 'queued'
created_at: str
links: Dict[str, str] # e.g., {"status": "/api/jobs/{taskId}"}
```
### WorkflowStatus
```python
@@ -181,6 +288,27 @@ class WorkflowStatus:
needs_redeployment: bool = False
```
### RateLimitInfo
```python
@dataclass
class RateLimitInfo:
limit: int
remaining: int
reset: int
retry_after: Optional[int] = None
```
### UsageLimits
```python
@dataclass
class UsageLimits:
success: bool
rate_limit: Dict[str, Any]
usage: Dict[str, Any]
```
### SimStudioError
```python
@@ -191,6 +319,13 @@ class SimStudioError(Exception):
self.status = status
```
**常见错误代码:**
- `UNAUTHORIZED`: 无效的 API 密钥
- `TIMEOUT`: 请求超时
- `RATE_LIMIT_EXCEEDED`: 超出速率限制
- `USAGE_LIMIT_EXCEEDED`: 超出使用限制
- `EXECUTION_ERROR`: 工作流执行失败
## 示例
### 基本工作流执行
@@ -339,6 +474,230 @@ for result in results:
print(f"Workflow {result['workflow_id']}: {'Success' if result['success'] else 'Failed'}")
```
### 异步工作流执行
为长时间运行的任务异步执行工作流:
```python
import os
import time
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_async():
try:
# Start async execution
result = client.execute_workflow(
"workflow-id",
input_data={"data": "large dataset"},
async_execution=True # Execute asynchronously
)
# Check if result is an async execution
if hasattr(result, 'task_id'):
print(f"Task ID: {result.task_id}")
print(f"Status endpoint: {result.links['status']}")
# Poll for completion
status = client.get_job_status(result.task_id)
while status["status"] in ["queued", "processing"]:
print(f"Current status: {status['status']}")
time.sleep(2) # Wait 2 seconds
status = client.get_job_status(result.task_id)
if status["status"] == "completed":
print("Workflow completed!")
print(f"Output: {status['output']}")
print(f"Duration: {status['metadata']['duration']}")
else:
print(f"Workflow failed: {status['error']}")
except Exception as error:
print(f"Error: {error}")
execute_async()
```
### 速率限制与重试
通过指数退避自动处理速率限制:
```python
import os
from simstudio import SimStudioClient, SimStudioError
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_retry_handling():
try:
# Automatically retries on rate limit
result = client.execute_with_retry(
"workflow-id",
input_data={"message": "Process this"},
max_retries=5,
initial_delay=1.0,
max_delay=60.0,
backoff_multiplier=2.0
)
print(f"Success: {result}")
except SimStudioError as error:
if error.code == "RATE_LIMIT_EXCEEDED":
print("Rate limit exceeded after all retries")
# Check rate limit info
rate_limit_info = client.get_rate_limit_info()
if rate_limit_info:
from datetime import datetime
reset_time = datetime.fromtimestamp(rate_limit_info.reset)
print(f"Rate limit resets at: {reset_time}")
execute_with_retry_handling()
```
### 使用监控
监控您的账户使用情况和限制:
```python
import os
from simstudio import SimStudioClient
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def check_usage():
try:
limits = client.get_usage_limits()
print("=== Rate Limits ===")
print("Sync requests:")
print(f" Limit: {limits.rate_limit['sync']['limit']}")
print(f" Remaining: {limits.rate_limit['sync']['remaining']}")
print(f" Resets at: {limits.rate_limit['sync']['resetAt']}")
print(f" Is limited: {limits.rate_limit['sync']['isLimited']}")
print("\nAsync requests:")
print(f" Limit: {limits.rate_limit['async']['limit']}")
print(f" Remaining: {limits.rate_limit['async']['remaining']}")
print(f" Resets at: {limits.rate_limit['async']['resetAt']}")
print(f" Is limited: {limits.rate_limit['async']['isLimited']}")
print("\n=== Usage ===")
print(f"Current period cost: ${limits.usage['currentPeriodCost']:.2f}")
print(f"Limit: ${limits.usage['limit']:.2f}")
print(f"Plan: {limits.usage['plan']}")
percent_used = (limits.usage['currentPeriodCost'] / limits.usage['limit']) * 100
print(f"Usage: {percent_used:.1f}%")
if percent_used > 80:
print("⚠️ Warning: You are approaching your usage limit!")
except Exception as error:
print(f"Error checking usage: {error}")
check_usage()
```
### 流式工作流执行
通过实时流式响应执行工作流:
```python
from simstudio import SimStudioClient
import os
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
def execute_with_streaming():
"""Execute workflow with streaming enabled."""
try:
# Enable streaming for specific block outputs
result = client.execute_workflow(
"workflow-id",
input_data={"message": "Count to five"},
stream=True,
selected_outputs=["agent1.content"] # Use blockName.attribute format
)
print("Workflow result:", result)
except Exception as error:
print("Error:", error)
execute_with_streaming()
```
流式响应遵循服务器发送事件 (SSE) 格式:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**Flask 流式示例:**
```python
from flask import Flask, Response, stream_with_context
import requests
import json
import os
app = Flask(__name__)
@app.route('/stream-workflow')
def stream_workflow():
"""Stream workflow execution to the client."""
def generate():
response = requests.post(
'https://sim.ai/api/workflows/WORKFLOW_ID/execute',
headers={
'Content-Type': 'application/json',
'X-API-Key': os.getenv('SIM_API_KEY')
},
json={
'message': 'Generate a story',
'stream': True,
'selectedOutputs': ['agent1.content']
},
stream=True
)
for line in response.iter_lines():
if line:
decoded_line = line.decode('utf-8')
if decoded_line.startswith('data: '):
data = decoded_line[6:] # Remove 'data: ' prefix
if data == '[DONE]':
break
try:
parsed = json.loads(data)
if 'chunk' in parsed:
yield f"data: {json.dumps(parsed)}\n\n"
elif parsed.get('event') == 'done':
yield f"data: {json.dumps(parsed)}\n\n"
print("Execution complete:", parsed.get('metadata'))
except json.JSONDecodeError:
pass
return Response(
stream_with_context(generate()),
mimetype='text/event-stream'
)
if __name__ == '__main__':
app.run(debug=True)
```
### 环境配置
使用环境变量配置客户端:
@@ -352,7 +711,7 @@ for result in results:
# Development configuration
client = SimStudioClient(
api_key=os.getenv("SIM_API_KEY"),
api_key=os.getenv("SIM_API_KEY")
base_url=os.getenv("SIM_BASE_URL", "https://sim.ai")
)
```
@@ -382,15 +741,15 @@ for result in results:
<Steps>
<Step title="登录 Sim">
访问 [Sim](https://sim.ai) 并登录您的账户。
前往 [Sim](https://sim.ai) 并登录您的账户。
</Step>
<Step title="打开您的工作流">
导航到您想要以编程方式执行的工作流。
前往您想要以编程方式执行的工作流。
</Step>
<Step title="部署您的工作流">
点击“部署”以部署您的工作流(如果尚未部署)
如果尚未部署,请点击“部署”以部署您的工作流。
</Step>
<Step title="创建或选择 API 密钥">
<Step title="创建或选择一个 API 密钥">
在部署过程中,选择或创建一个 API 密钥。
</Step>
<Step title="复制 API 密钥">

View File

@@ -7,10 +7,10 @@ import { Card, Cards } from 'fumadocs-ui/components/card'
import { Step, Steps } from 'fumadocs-ui/components/steps'
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
Sim 的官方 TypeScript/JavaScript SDK 提供完整的类型安全,支持 Node.js 和浏览器环境,允许您从 Node.js 应用程序、Web 应用程序和其他 JavaScript 环境中以编程方式执行工作流。目前,所有工作流执行均为同步。
Sim 的官方 TypeScript/JavaScript SDK 提供完整的类型安全,支持 Node.js 和浏览器环境,允许您从 Node.js 应用程序、Web 应用程序和其他 JavaScript 环境中以编程方式执行工作流。
<Callout type="info">
TypeScript SDK 提供完整的类型安全,支持 Node.js 和浏览器环境。目前,所有工作流执行均为同步
TypeScript SDK 提供完整的类型安全、异步执行支持、带有指数回退的自动速率限制以及使用跟踪
</Callout>
## 安装
@@ -91,12 +91,17 @@ const result = await client.executeWorkflow('workflow-id', {
```
**参数:**
- `workflowId`字符串要执行的工作流的 ID
- `options`ExecutionOptions可选
- `input`任意类型传递给工作流的输入数据
- `timeout`(数字):超时时间以毫秒为单位默认值30000
- `workflowId` (字符串): 要执行的工作流的 ID
- `options` (ExecutionOptions可选):
- `input` (任意类型): 传递给工作流的输入数据
- `timeout` (数字): 超时时间以毫秒为单位默认值30000
- `stream` (布尔值): 启用流式响应默认值false
- `selectedOutputs` (字符串数组): 以 `blockName.attribute` 格式阻止流中的输出(例如,`["agent1.content"]`
- `async` (布尔值): 异步执行默认值false
**返回值:** `Promise<WorkflowExecutionResult>`
**返回值:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
当 `async: true` 时,立即返回一个用于轮询的任务 ID。否则等待完成。
##### getWorkflowStatus()
@@ -108,7 +113,7 @@ console.log('Is deployed:', status.isDeployed);
```
**参数:**
- `workflowId`字符串工作流的 ID
- `workflowId` (字符串): 工作流的 ID
**返回值:** `Promise<WorkflowStatus>`
@@ -124,32 +129,121 @@ if (isReady) {
```
**参数:**
- `workflowId`字符串工作流的 ID
- `workflowId` (字符串): 工作流的 ID
**返回值:** `Promise<boolean>`
##### executeWorkflowSync()
##### getJobStatus()
<Callout type="info">
当前,此方法与 `executeWorkflow()` 相同,因为所有执行都是同步的。提供此方法是为了在将来添加异步执行时保持兼容性。
</Callout>
执行工作流(当前为同步,与 `executeWorkflow()` 相同)。
获取异步任务执行的状态。
```typescript
const result = await client.executeWorkflowSync('workflow-id', {
input: { data: 'some input' },
timeout: 60000
const status = await client.getJobStatus('task-id-from-async-execution');
console.log('Status:', status.status); // 'queued', 'processing', 'completed', 'failed'
if (status.status === 'completed') {
console.log('Output:', status.output);
}
```
**参数:**
- `taskId` (字符串): 异步执行返回的任务 ID
**返回值:** `Promise<JobStatus>`
**响应字段:**
- `success` (布尔值): 请求是否成功
- `taskId` (字符串): 任务 ID
- `status` (字符串): 可能的值包括 `'queued'`, `'processing'`, `'completed'`, `'failed'`, `'cancelled'`
- `metadata` (对象): 包含 `startedAt`, `completedAt` 和 `duration`
- `output` (任意类型,可选): 工作流输出(完成时)
- `error` (任意类型,可选): 错误详情(失败时)
- `estimatedDuration` (数字,可选): 估计持续时间(以毫秒为单位,处理中/排队时)
##### executeWithRetry()
使用指数退避机制,在遇到速率限制错误时自动重试执行工作流。
```typescript
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Hello' },
timeout: 30000
}, {
maxRetries: 3, // Maximum number of retries
initialDelay: 1000, // Initial delay in ms (1 second)
maxDelay: 30000, // Maximum delay in ms (30 seconds)
backoffMultiplier: 2 // Exponential backoff multiplier
});
```
**参数:**
- `workflowId`(字符串):要执行的工作流的 ID
- `options`ExecutionOptions可选
- `input`(任意类型):传递给工作流的输入数据
- `timeout`(数字):初始请求的超时时间(以毫秒为单位
- `options`ExecutionOptions可选与 `executeWorkflow()` 相同
- `retryOptions`RetryOptions可选
- `maxRetries`数字最大重试次数默认值3
- `initialDelay`数字初始延迟时间以毫秒为单位默认值1000
- `maxDelay`数字最大延迟时间以毫秒为单位默认值30000
- `backoffMultiplier`数字退避倍数默认值2
**返回值:** `Promise<WorkflowExecutionResult>`
**返回值:** `Promise<WorkflowExecutionResult | AsyncExecutionResult>`
重试逻辑使用指数退避1秒 → 2秒 → 4秒 → 8秒...),并带有 ±25% 的抖动以防止蜂拥效应。如果 API 提供了 `retry-after` 头,则会使用该头。
##### getRateLimitInfo()
从上一次 API 响应中获取当前速率限制信息。
```typescript
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Limit:', rateLimitInfo.limit);
console.log('Remaining:', rateLimitInfo.remaining);
console.log('Reset:', new Date(rateLimitInfo.reset * 1000));
}
```
**返回值:** `RateLimitInfo | null`
##### getUsageLimits()
获取您的账户当前的使用限制和配额信息。
```typescript
const limits = await client.getUsageLimits();
console.log('Sync requests remaining:', limits.rateLimit.sync.remaining);
console.log('Async requests remaining:', limits.rateLimit.async.remaining);
console.log('Current period cost:', limits.usage.currentPeriodCost);
console.log('Plan:', limits.usage.plan);
```
**返回值:** `Promise<UsageLimits>`
**响应结构:**
```typescript
{
success: boolean
rateLimit: {
sync: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
async: {
isLimited: boolean
limit: number
remaining: number
resetAt: string
}
authType: string // 'api' or 'manual'
}
usage: {
currentPeriodCost: number
limit: number
plan: string // e.g., 'free', 'pro'
}
}
```
##### setApiKey()
@@ -187,6 +281,20 @@ interface WorkflowExecutionResult {
}
```
### AsyncExecutionResult
```typescript
interface AsyncExecutionResult {
success: boolean;
taskId: string;
status: 'queued';
createdAt: string;
links: {
status: string; // e.g., "/api/jobs/{taskId}"
};
}
```
### WorkflowStatus
```typescript
@@ -198,6 +306,45 @@ interface WorkflowStatus {
}
```
### RateLimitInfo
```typescript
interface RateLimitInfo {
limit: number;
remaining: number;
reset: number;
retryAfter?: number;
}
```
### UsageLimits
```typescript
interface UsageLimits {
success: boolean;
rateLimit: {
sync: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
async: {
isLimited: boolean;
limit: number;
remaining: number;
resetAt: string;
};
authType: string;
};
usage: {
currentPeriodCost: number;
limit: number;
plan: string;
};
}
```
### SimStudioError
```typescript
@@ -207,6 +354,13 @@ class SimStudioError extends Error {
}
```
**常见错误代码:**
- `UNAUTHORIZED`: 无效的 API 密钥
- `TIMEOUT`: 请求超时
- `RATE_LIMIT_EXCEEDED`: 超出速率限制
- `USAGE_LIMIT_EXCEEDED`: 超出使用限制
- `EXECUTION_ERROR`: 工作流执行失败
## 示例
### 基本工作流执行
@@ -469,14 +623,14 @@ document.getElementById('executeBtn')?.addEventListener('click', executeClientSi
### React Hook 示例
为工作流执行创建一个自定义 React Hook
为工作流执行创建自定义 React hook
```typescript
import { useState, useCallback } from 'react';
import { SimStudioClient, WorkflowExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.NEXT_PUBLIC_SIM_API_KEY!
apiKey: process.env.SIM_API_KEY!
});
interface UseWorkflowResult {
@@ -532,7 +686,7 @@ function WorkflowComponent() {
<button onClick={handleExecute} disabled={loading}>
{loading ? 'Executing...' : 'Execute Workflow'}
</button>
{error && <div>Error: {error.message}</div>}
{result && (
<div>
@@ -545,38 +699,267 @@ function WorkflowComponent() {
}
```
## 获取您的 API 密钥
### 异步工作流执行
为长时间运行的任务异步执行工作流:
```typescript
import { SimStudioClient, AsyncExecutionResult } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeAsync() {
try {
// Start async execution
const result = await client.executeWorkflow('workflow-id', {
input: { data: 'large dataset' },
async: true // Execute asynchronously
});
// Check if result is an async execution
if ('taskId' in result) {
console.log('Task ID:', result.taskId);
console.log('Status endpoint:', result.links.status);
// Poll for completion
let status = await client.getJobStatus(result.taskId);
while (status.status === 'queued' || status.status === 'processing') {
console.log('Current status:', status.status);
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
status = await client.getJobStatus(result.taskId);
}
if (status.status === 'completed') {
console.log('Workflow completed!');
console.log('Output:', status.output);
console.log('Duration:', status.metadata.duration);
} else {
console.error('Workflow failed:', status.error);
}
}
} catch (error) {
console.error('Error:', error);
}
}
executeAsync();
```
### 速率限制和重试
通过指数退避自动处理速率限制:
```typescript
import { SimStudioClient, SimStudioError } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithRetryHandling() {
try {
// Automatically retries on rate limit
const result = await client.executeWithRetry('workflow-id', {
input: { message: 'Process this' }
}, {
maxRetries: 5,
initialDelay: 1000,
maxDelay: 60000,
backoffMultiplier: 2
});
console.log('Success:', result);
} catch (error) {
if (error instanceof SimStudioError && error.code === 'RATE_LIMIT_EXCEEDED') {
console.error('Rate limit exceeded after all retries');
// Check rate limit info
const rateLimitInfo = client.getRateLimitInfo();
if (rateLimitInfo) {
console.log('Rate limit resets at:', new Date(rateLimitInfo.reset * 1000));
}
}
}
}
```
### 使用监控
监控您的账户使用情况和限制:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function checkUsage() {
try {
const limits = await client.getUsageLimits();
console.log('=== Rate Limits ===');
console.log('Sync requests:');
console.log(' Limit:', limits.rateLimit.sync.limit);
console.log(' Remaining:', limits.rateLimit.sync.remaining);
console.log(' Resets at:', limits.rateLimit.sync.resetAt);
console.log(' Is limited:', limits.rateLimit.sync.isLimited);
console.log('\nAsync requests:');
console.log(' Limit:', limits.rateLimit.async.limit);
console.log(' Remaining:', limits.rateLimit.async.remaining);
console.log(' Resets at:', limits.rateLimit.async.resetAt);
console.log(' Is limited:', limits.rateLimit.async.isLimited);
console.log('\n=== Usage ===');
console.log('Current period cost:
### Streaming Workflow Execution
Execute workflows with real-time streaming responses:
```typescript
import { SimStudioClient } from 'simstudio-ts-sdk';
const client = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
async function executeWithStreaming() {
try {
// 为特定的块输出启用流式传输
const result = await client.executeWorkflow('workflow-id', {
input: { message: 'Count to five' },
stream: true,
selectedOutputs: ['agent1.content'] // 使用 blockName.attribute 格式
});
console.log('工作流结果:', result);
} catch (error) {
console.error('错误:', error);
}
}
```
The streaming response follows the Server-Sent Events (SSE) format:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
**React Streaming Example:**
```typescript
import { useState, useEffect } from 'react';
function StreamingWorkflow() {
const [output, setOutput] = useState('');
const [loading, setLoading] = useState(false);
const executeStreaming = async () => {
setLoading(true);
setOutput('');
// 重要提示:请从您的后端服务器发起此 API 调用,而不是从浏览器发起
// 切勿在客户端代码中暴露您的 API 密钥
const response = await fetch('https://sim.ai/api/workflows/WORKFLOW_ID/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.SIM_API_KEY! // 仅限服务器端环境变量
},
body: JSON.stringify({
message: '生成一个故事',
stream: true,
selectedOutputs: ['agent1.content']
})
});
const reader = response.body?.getReader();
const decoder = new TextDecoder();
while (reader) {
const { done, value } = await reader.read();
if (done) break;
const chunk = decoder.decode(value);
const lines = chunk.split('\n\n');
for (const line of lines) {
if (line.startsWith('data: ')) {
const data = line.slice(6);
if (data === '[DONE]') {
setLoading(false);
break;
}
try {
const parsed = JSON.parse(data);
if (parsed.chunk) {
setOutput(prev => prev + parsed.chunk);
} else if (parsed.event === 'done') {
console.log('执行完成:', parsed.metadata);
}
} catch (e) {
// 跳过无效的 JSON
}
}
}
}
};
return (
<div>
<button onClick={executeStreaming} disabled={loading}>
{loading ? '生成中...' : '开始流式处理'}
</button>
<div style={{ whiteSpace: 'pre-wrap' }}>{output}</div>
</div>
);
}
```
## Getting Your API Key
<Steps>
<Step title="登录 Sim">
访问 [Sim](https://sim.ai) 并登录您的账户。
<Step title="Log in to Sim">
Navigate to [Sim](https://sim.ai) and log in to your account.
</Step>
<Step title="打开您的工作流">
导航到您想要以编程方式执行的工作流。
<Step title="Open your workflow">
Navigate to the workflow you want to execute programmatically.
</Step>
<Step title="部署您的工作流">
如果尚未部署,请点击“部署”以部署您的工作流。
<Step title="Deploy your workflow">
Click on "Deploy" to deploy your workflow if it hasn't been deployed yet.
</Step>
<Step title="创建或选择一个 API 密钥">
在部署过程中,选择或创建一个 API 密钥。
<Step title="Create or select an API key">
During the deployment process, select or create an API key.
</Step>
<Step title="复制 API 密钥">
复制 API 密钥以在您的 TypeScript/JavaScript 应用程序中使用。
<Step title="Copy the API key">
Copy the API key to use in your TypeScript/JavaScript application.
</Step>
</Steps>
<Callout type="warning">
请确保您的 API 密钥安全,切勿将其提交到版本控制中。使用环境变量或安全配置管理。
Keep your API key secure and never commit it to version control. Use environment variables or secure configuration management.
</Callout>
## 要求
## Requirements
- Node.js 16+
- TypeScript 5.0+(适用于 TypeScript 项目)
- TypeScript 5.0+ (for TypeScript projects)
## TypeScript 支持
## TypeScript Support
SDK 是用 TypeScript 编写的,并提供完整的类型安全:
The SDK is written in TypeScript and provides full type safety:
```typescript
import {
@@ -586,22 +969,22 @@ import {
SimStudioError
} from 'simstudio-ts-sdk';
// Type-safe client initialization
// 类型安全的客户端初始化
const client: SimStudioClient = new SimStudioClient({
apiKey: process.env.SIM_API_KEY!
});
// Type-safe workflow execution
// 类型安全的工作流执行
const result: WorkflowExecutionResult = await client.executeWorkflow('workflow-id', {
input: {
message: 'Hello, TypeScript!'
message: '你好,TypeScript'
}
});
// Type-safe status checking
// 类型安全的状态检查
const status: WorkflowStatus = await client.getWorkflowStatus('workflow-id');
```
## 许可证
Apache-2.0
Apache-2.0

View File

@@ -38,6 +38,84 @@ curl -X POST \
成功的响应会返回来自执行器的序列化执行结果。错误会显示验证、认证或工作流失败的信息。
## 流式响应
启用实时流式传输以在生成时逐字符接收工作流输出。这对于向用户逐步显示 AI 响应非常有用。
### 请求参数
添加以下参数以启用流式传输:
- `stream` - 设置为 `true` 以启用服务器发送事件 (SSE) 流式传输
- `selectedOutputs` - 要流式传输的块输出数组(例如,`["agent1.content"]`
### 块输出格式
使用 `blockName.attribute` 格式指定要流式传输的块输出:
- 格式:`"blockName.attribute"`(例如,如果您想流式传输 Agent 1 块的内容,可以使用 `"agent1.content"`
- 块名称不区分大小写,空格会被忽略
### 示例请求
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Count to five",
"stream": true,
"selectedOutputs": ["agent1.content"]
}'
```
### 响应格式
流式响应使用服务器发送事件 (SSE) 格式:
```
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":"One"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", two"}
data: {"blockId":"7b7735b9-19e5-4bd6-818b-46aae2596e9f","chunk":", three"}
data: {"event":"done","success":true,"output":{},"metadata":{"duration":610}}
data: [DONE]
```
每个事件包括:
- **流式块**`{"blockId": "...", "chunk": "text"}` - 实时生成的文本
- **最终事件**`{"event": "done", ...}` - 执行元数据和完整结果
- **终止符**`[DONE]` - 表示流结束
### 多块流式传输
当 `selectedOutputs` 包含多个块时,每个块会指示其来源:
```bash
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{
"message": "Process this request",
"stream": true,
"selectedOutputs": ["agent1.content", "agent2.content"]
}'
```
每个块中的 `blockId` 字段可让您将输出路由到正确的 UI 元素:
```
data: {"blockId":"agent1-uuid","chunk":"Processing..."}
data: {"blockId":"agent2-uuid","chunk":"Analyzing..."}
data: {"blockId":"agent1-uuid","chunk":" complete"}
```
## 输出参考
| 参考 | 描述 |
@@ -48,5 +126,5 @@ curl -X POST \
如果未定义输入格式,执行器仅在 `<api.input>` 处暴露原始 JSON。
<Callout type="warning">
一个工作流只能包含一个 API 触发器。更改后发布新部署,以确保端点保持最新。
一个工作流只能包含一个 API 触发器。更改后发布新部署,以确保端点保持最新。
</Callout>

View File

@@ -2231,8 +2231,8 @@ checksums:
d394ac42b56429e524dc5a771b0610b9:
meta/title: 9da9098244c6c7a0ebcc3009cef66c7b
content/0: 9218a2e190598690d0fc5c27c30f01bb
content/1: 8a3feb937915c3191f1eecb10b94297d
content/2: 99af1bfe8d1629acdb5a9229430af791
content/1: 6c88f52bdb4e4a5668d1b25b5f444f48
content/2: 7e827833339b6b4c6abdf154de7f9a0c
content/3: 391128dee61b5d0d43eba88567aaef42
content/4: 4d132e6346723ecf45c408afeab2757b
content/5: d3df764a69d2926d10aed65ad8693e9f
@@ -2254,79 +2254,155 @@ checksums:
content/21: bd0e851fdde30c0e94c00b60f85d655e
content/22: 837ca74ccf63f23333c54e010faf681c
content/23: 8fb33cfc314b86d35df8ea1b10466f20
content/24: 09e003c28fb1810e9afefe51324265fd
content/25: 07fb2d6b16c75839a32d383f12419ca5
content/26: 9fd0cd99a879360d355d91e9cfb41531
content/27: f6fed8ebf67ba12199b4474a754969ae
content/28: bcee3febe1be079e53aea841e2b08b3b
content/29: f00be560fcd4ff3f53d61c70c249597b
content/30: fa4fa1573c369fcc2eee57d7852caf9c
content/31: fa68c1f8c9ea3dba96b2ea7edb8680d7
content/32: 304e608d459ef53f308e6ea1f6f8b54a
content/33: cb63e267fb16a7aaeea45c4ca29bf697
content/34: f00be560fcd4ff3f53d61c70c249597b
content/35: f7c266db4d07d040f8f788be598476cf
content/36: cd306281b5136831335e6376edb1e822
content/37: afb7b7f27d48deb3154da26135e17fb8
content/38: 179000198c9cd78601b5c862e9c8659f
content/39: 28c37db52f39323e125fcaf0e60911db
content/40: 8de5041c3c93b70619ec1723f657757f
content/41: 07fb2d6b16c75839a32d383f12419ca5
content/42: 65db7855a79ab283c6409e81a7703d19
content/43: 191fb7087315702a36001c69d745ebed
content/44: f6113edfd7a0062af4d88bcf31a73f45
content/45: 1e84fc1eee794c20e3411b3a34a02278
content/46: ec31e300f79185f734d32b1cfaf8a137
content/47: f7ad301d02e8826921644a5268f13f32
content/48: 025d60fdaf93713ccb34abcbc71dfa2b
content/49: 70a9ece41fdad09f3a06ca0efdb92ae9
content/50: 356d67409ae0d82a72d052573314f660
content/51: bb172f1678686d9d49666c516716de24
content/52: 529711647eccfdf031dbb5bc70581986
content/53: 9a84c92505eb468916637fcf2cef70f2
content/54: 225bca3fb37bd38cd645e8a698abbfa9
content/55: 33b9b1e9744318597da4b925b0995be2
content/56: 6afe3b62e6d53c3dcd07149abcab4c05
content/57: b6363faee219321c16d41a9c3f8d3bdd
content/58: 24ef65dd034a2881a978d8d0065fb258
content/59: b8b23ab79a7eb32c6f8d5f49f43c51f6
content/60: be358297e2bbb9ab4689d11d072611d1
content/61: b2eaadc86870d2e64b55c89e0348ef93
content/62: 450265802cb0ba5b435b74b9cac1bf23
content/63: b735ede8764e4b2dfb25967e33ab5143
content/64: 0f881e586a03c4b916456c73fad48358
content/65: 62bbbeca4e0500062f5cdbbc1614dde0
content/66: 55d47e12745c1b0b62c9bdf6e8449730
content/67: 1d873c7ccd87f564e2b30387b40ee9e9
content/68: 3304a33dfb626c6e2267c062e8956a9d
content/69: 77256b36307e9f7293bd00063239c8ee
content/70: ac686382ccbb07d75b0f141af500dfd5
content/71: 38f7308105b0843792c8e2fb93e1895d
content/72: 62f6977928b2f596ed7d54383d1e779d
content/73: 3415d6c5ad1df56b212d69519bdf0fea
content/74: d1a104e667cd2284ab5b3fead4a6ba1d
content/75: a81d7cd4a644a0061dad3a5973b4fe06
content/76: 981447969a71fd038049e9d9f40f4f8c
content/77: 531941216d31cb1947367c3c02127baa
content/78: bf1afa789fdfa5815faaf43574341e90
content/79: 5f2fe55d098d4e4f438af595708b2280
content/80: 41b8f7cf8899a0e92e255a3f845f9584
content/81: 5040bab65fb6bb77862f8098d16afbb5
content/82: a88260a5b5e23da73e4534376adeb193
content/83: e5e2329cdc226186fe9d44767528a4a0
content/84: 1773624e9ac3d5132b505894ef51977e
content/85: d62c9575cc66feec7589fba95c9f7aee
content/86: 7af652c5407ae7e156ab27b21a4f26d3
content/87: 4aa69b29cca745389dea8cd74eba4f83
content/88: 46877074b69519165997fa0968169611
content/89: d8ebc69b18baf83689ba315e7b4946ea
content/90: ecd571818ddf3d31b08b80a25958a662
content/91: 7dcdf2fbf3fce3f94987046506e12a9b
content/24: f8fbd9375113651be0f2498bdacde0ef
content/25: 2c57d87589b65f785e0fbbda60d32e54
content/26: 2541eb37fca67a6d7c5a10f8067127a3
content/27: 9fd0cd99a879360d355d91e9cfb41531
content/28: f6fed8ebf67ba12199b4474a754969ae
content/29: bcee3febe1be079e53aea841e2b08b3b
content/30: f00be560fcd4ff3f53d61c70c249597b
content/31: fa4fa1573c369fcc2eee57d7852caf9c
content/32: fa68c1f8c9ea3dba96b2ea7edb8680d7
content/33: 304e608d459ef53f308e6ea1f6f8b54a
content/34: cb63e267fb16a7aaeea45c4ca29bf697
content/35: f00be560fcd4ff3f53d61c70c249597b
content/36: f7c266db4d07d040f8f788be598476cf
content/37: d93b320646fde160c0fdd1936ee63cfb
content/38: c76e2089a41880dd6feac759ec8867c2
content/39: 0d61b9631788e64d1c1335b08c907107
content/40: 5ec50e6f56bd0a9a55fae14fa02185d9
content/41: 47bdc3ba4908bf1ce3d1a0a8f646b339
content/42: 5e8af7125448a6021a6ea431486dd587
content/43: 15017685691db74889cc6116373e44a5
content/44: 4d4ad5d56e800e5d227a07339300fc7f
content/45: c035728b4b81d006a18ba9ba7b9c638d
content/46: f1c9ad60574d19a5f93c837ab9d88890
content/47: 2c57d87589b65f785e0fbbda60d32e54
content/48: e7019a0e12f7295893c5822356fc0df0
content/49: 5912d8d9df5bbe435579d8eb0677685c
content/50: 4e1da4edce56837c750ce8da4c0e6cf2
content/51: 3d35097bb958e6eddd6976aeb1fe9e41
content/52: 78dce98d48ba070dbe100ee2a94cb17d
content/53: 38ec85acf292485e3dd837a29208fd2c
content/54: 58d582d90c8715f5570f76fed2be508d
content/55: 7d2b7134d447172c502b5f40fc3b38e6
content/56: 4a71171863d7329da6813b94772c0d4e
content/57: 1900d5b89dbca22d7a455bdc3367f0f5
content/58: 45126feb4fc831922a7edabfa2d54e4a
content/59: 65db7855a79ab283c6409e81a7703d19
content/60: 191fb7087315702a36001c69d745ebed
content/61: f6113edfd7a0062af4d88bcf31a73f45
content/62: 1e84fc1eee794c20e3411b3a34a02278
content/63: ec31e300f79185f734d32b1cfaf8a137
content/64: f7ad301d02e8826921644a5268f13f32
content/65: 025d60fdaf93713ccb34abcbc71dfa2b
content/66: 70a9ece41fdad09f3a06ca0efdb92ae9
content/67: 356d67409ae0d82a72d052573314f660
content/68: 5a80933fb21deea17a0a200564f0111b
content/69: 9527ba2ab5ddd8001baaaaf25f1a7acc
content/70: bb172f1678686d9d49666c516716de24
content/71: 529711647eccfdf031dbb5bc70581986
content/72: baa408b1603f35a8e24dd60b88773c72
content/73: c42a9f19d0678d8d1a36cf1f93e4a5ba
content/74: f6180f2341e8a7ae24afb05d7a185340
content/75: 8196e101e443ec2aac13cefd90a6d454
content/76: 9a84c92505eb468916637fcf2cef70f2
content/77: 225bca3fb37bd38cd645e8a698abbfa9
content/78: 7431c09b430effd69de843ee0fbaafe8
content/79: 33b9b1e9744318597da4b925b0995be2
content/80: 6afe3b62e6d53c3dcd07149abcab4c05
content/81: b6363faee219321c16d41a9c3f8d3bdd
content/82: 2449c8e8f55e2bf3f732527352d35c9f
content/83: b8b23ab79a7eb32c6f8d5f49f43c51f6
content/84: be358297e2bbb9ab4689d11d072611d1
content/85: eb774a8a86d778153905b0f6cdcdf517
content/86: 450265802cb0ba5b435b74b9cac1bf23
content/87: b735ede8764e4b2dfb25967e33ab5143
content/88: 0f881e586a03c4b916456c73fad48358
content/89: f51639ab2b7ccac72b850e2064e694e9
content/90: 55d47e12745c1b0b62c9bdf6e8449730
content/91: e6223d6aa9efa444282e58d7d9a99ced
content/92: 3304a33dfb626c6e2267c062e8956a9d
content/93: 77256b36307e9f7293bd00063239c8ee
content/94: ac686382ccbb07d75b0f141af500dfd5
content/95: 5610b6538a29672335b572d6f35d0657
content/96: 62f6977928b2f596ed7d54383d1e779d
content/97: 3415d6c5ad1df56b212d69519bdf0fea
content/98: 6bd60468d8cc072c5fe4214481fa9f60
content/99: a81d7cd4a644a0061dad3a5973b4fe06
content/100: 981447969a71fd038049e9d9f40f4f8c
content/101: 531941216d31cb1947367c3c02127baa
content/102: bf1afa789fdfa5815faaf43574341e90
content/103: 5f2fe55d098d4e4f438af595708b2280
content/104: 41b8f7cf8899a0e92e255a3f845f9584
content/105: 61ddd890032078ffd2da931b1d153b6d
content/106: 7873aa7487bc3e8a4826d65c1760a4a0
content/107: 98182d9aabe14d5bad43a5ee76a75eab
content/108: 2bdb01e4bcb08b1d99f192acf8e2fba7
content/109: 7079d9c00b1e1882c329b7e9b8f74552
content/110: 0f9d65eaf6e8de43c3d5fa7e62bc838d
content/111: 58c8e9d2d0ac37efd958203b8fbc8193
content/112: 7859d36a7a6d0122c0818b28ee29aa3e
content/113: ce185e7b041b8f95ebc11370d3e0aad9
content/114: 701e9bf4fd4d0669da0584eac5bd96e0
content/115: d1bab8ec5a51a9da5464eb47e2a16b50
content/116: da658275cc81a20f9cf7e4c66c7af1e3
content/117: 377d7c99a5df4b72166946573f7210b8
content/118: 3afc03a5ab1dc9db2bfa092b0ac4826a
content/119: 18ddfcaf2be4a6f1d9819407dad9ce7c
content/120: 2f6263b2e95f09f7e4842453f4bf4a0a
content/121: 4603578d6b314b662f45564a34ca430d
content/122: cf4c97eb254d0bd6ea6633344621c2c2
content/123: 7b4640989fab002039936156f857eb21
content/124: 65ca9f08745b47b4cce8ea8247d043bf
content/125: 162b4180611ff0a53b782e4dc8109293
content/126: 6b367a189eb53cb198e3666023def89c
content/127: dbb2125cefcf618849600c1eccae8a64
content/128: 04eedda0da3767b06e6017c559e05414
content/129: 661688450606eb09d8faee1468e88331
content/130: 8ff8367c3246103b3e3e02499e34ae0b
content/131: 44678bda9166f746da1d61b694ced482
content/132: a5e75db27c0a901f4cacf6598f450e6c
content/133: d1bab8ec5a51a9da5464eb47e2a16b50
content/134: da658275cc81a20f9cf7e4c66c7af1e3
content/135: 377d7c99a5df4b72166946573f7210b8
content/136: 3afc03a5ab1dc9db2bfa092b0ac4826a
content/137: 18ddfcaf2be4a6f1d9819407dad9ce7c
content/138: 2f6263b2e95f09f7e4842453f4bf4a0a
content/139: 4603578d6b314b662f45564a34ca430d
content/140: cf4c97eb254d0bd6ea6633344621c2c2
content/141: 7b4640989fab002039936156f857eb21
content/142: 65ca9f08745b47b4cce8ea8247d043bf
content/143: 162b4180611ff0a53b782e4dc8109293
content/144: 6b367a189eb53cb198e3666023def89c
content/145: dbb2125cefcf618849600c1eccae8a64
content/146: 04eedda0da3767b06e6017c559e05414
content/147: 661688450606eb09d8faee1468e88331
content/148: 8ff8367c3246103b3e3e02499e34ae0b
content/149: 44678bda9166f746da1d61b694ced482
content/150: 192a89879084dd7a74a6f44bcecae958
content/151: 41c2bb95317d7c0421817a2b1a68cc09
content/152: 4c95f9fa55f698f220577380dff95011
content/153: 9ef273d776aada1b2cff3452f08ff985
content/154: 100e12673551d4ceb5b906b1b9c65059
content/155: ce253674cd7c49320203cda2bdd3685b
content/156: 8910afcea8c205a28256eb30de6a1f26
content/157: 4d7ad757d2c70fdff7834146d38dddd8
content/158: a88260a5b5e23da73e4534376adeb193
content/159: e5e2329cdc226186fe9d44767528a4a0
content/160: 1773624e9ac3d5132b505894ef51977e
content/161: d62c9575cc66feec7589fba95c9f7aee
content/162: 7af652c5407ae7e156ab27b21a4f26d3
content/163: 4aa69b29cca745389dea8cd74eba4f83
content/164: 46877074b69519165997fa0968169611
content/165: 2e81908c18033109ac82a054b3fafd3d
content/166: ecd571818ddf3d31b08b80a25958a662
content/167: 7dcdf2fbf3fce3f94987046506e12a9b
27578f1315b6f1b7418d5e0d6042722e:
meta/title: 8c555594662512e95f28e20d3880f186
content/0: 9218a2e190598690d0fc5c27c30f01bb
content/1: feca29d7cbb17f461bc8706f142cb475
content/2: 65705e1bef9ddf2674454c20e77af61f
content/2: 9cb58e08402fc80050ad6a62cae3f643
content/3: 391128dee61b5d0d43eba88567aaef42
content/4: fa77bab0a8660a7999bf3104921aac5c
content/5: e8839cfb872185cea76973caaa7f84e0
@@ -2342,67 +2418,107 @@ checksums:
content/15: 64005abb7b5c1c3edef8970a8a7d17b2
content/16: 837ca74ccf63f23333c54e010faf681c
content/17: 626054376e08522e7195a60c34db9af8
content/18: 03c715df3c784e92ce1c0ce6a4dcd2e3
content/19: dcb92b9a1f222393f2e81cdae239885c
content/20: 2f5c7e73763a1884893739283f0d0659
content/21: f6fed8ebf67ba12199b4474a754969ae
content/22: c8f9a1d43885f2b9fe8b64c79d8af8b8
content/23: e1a2ca39583549a731d942082e1fa07c
content/24: 14e077bdb64d87457870efa215384654
content/25: c2e86eaf4b7d1cd53ed8172264337cc9
content/26: 304e608d459ef53f308e6ea1f6f8b54a
content/27: 9d04294f8385211535ed7622d164871f
content/28: e1a2ca39583549a731d942082e1fa07c
content/29: 279c20e11af33abb94993e8ea3e80669
content/30: eec7d8395f8cf305106deb7b25384ecf
content/31: 921824b44c391f8a0cdc5ce4cd283e77
content/32: d5aaccb9399a1255f986b703921594e5
content/33: dba855cc28255e4576026e3da0cdf05b
content/34: 17fdd93c6df75b108e352a62a195bc73
content/35: dcb92b9a1f222393f2e81cdae239885c
content/36: fb6fddfdf4753a36c7878ef60b345822
content/37: 191fb7087315702a36001c69d745ebed
content/38: 1ffef0a4e0d6a6bbca85776c113e1164
content/39: 61caafaf79e863df9525c4baf72c14e1
content/40: ec31e300f79185f734d32b1cfaf8a137
content/41: 65a172d64ffca3b03c6e0ed08f0bd821
content/42: 2db387754d7fb3539bcb986dfaac1c8c
content/43: e118d997ba48a5230ec70a564d436860
content/44: 77268362a748dafad471f31acfd230dc
content/45: b55b3773df2dfba66b6e675db7e2470e
content/46: 70a9ece41fdad09f3a06ca0efdb92ae9
content/47: 646ee615d86faf3b6a8da03115a30efa
content/48: bb172f1678686d9d49666c516716de24
content/49: a025b3b746d72e0f676f58703ee19a47
content/50: 9a84c92505eb468916637fcf2cef70f2
content/51: a4c78d85ed9be63b07b657166510f440
content/52: 33b9b1e9744318597da4b925b0995be2
content/53: 6afe3b62e6d53c3dcd07149abcab4c05
content/54: b6363faee219321c16d41a9c3f8d3bdd
content/55: f939bc99e05d04e1d52bf4b9ec3f1825
content/56: b8b23ab79a7eb32c6f8d5f49f43c51f6
content/57: be358297e2bbb9ab4689d11d072611d1
content/58: d8fcefba15a99bf4a9cf71c985097677
content/59: 7d098f0349c782f389431377ee512e92
content/60: 22b39537f6a104803389469d211154e4
content/61: 5dc147f9fe5e8117dfa6c94808c4ff54
content/62: f29d6bfd74ba3fee0b90180f620b4f47
content/63: 2a59466500b62e57481fe27692a3ed0f
content/64: d3ac9ea2a213cafb1f871dda8f6e6fe0
content/65: 450265802cb0ba5b435b74b9cac1bf23
content/66: b735ede8764e4b2dfb25967e33ab5143
content/67: 0f881e586a03c4b916456c73fad48358
content/68: 3f643fb43f3a022a449ded1e7c4db8bf
content/69: 55d47e12745c1b0b62c9bdf6e8449730
content/70: 166b3975e39841707381880ae4df3984
content/71: 3304a33dfb626c6e2267c062e8956a9d
content/72: a88260a5b5e23da73e4534376adeb193
content/73: cc31ae653c5642b223ec634888de29c6
content/74: 1773624e9ac3d5132b505894ef51977e
content/75: d62c9575cc66feec7589fba95c9f7aee
content/76: 8df5939abc771b5d24c115ef20d42d6f
content/77: ecd571818ddf3d31b08b80a25958a662
content/78: 7dcdf2fbf3fce3f94987046506e12a9b
content/18: 12153919e0229ac0a3699de043eae2a2
content/19: 59ceca96004d0746448717245eb65c5c
content/20: a0ff152e09498effe90572fe5cdfad1b
content/21: 2f5c7e73763a1884893739283f0d0659
content/22: f6fed8ebf67ba12199b4474a754969ae
content/23: c8f9a1d43885f2b9fe8b64c79d8af8b8
content/24: e1a2ca39583549a731d942082e1fa07c
content/25: 14e077bdb64d87457870efa215384654
content/26: c2e86eaf4b7d1cd53ed8172264337cc9
content/27: 304e608d459ef53f308e6ea1f6f8b54a
content/28: 9d04294f8385211535ed7622d164871f
content/29: e1a2ca39583549a731d942082e1fa07c
content/30: 279c20e11af33abb94993e8ea3e80669
content/31: 9e772c161a4b008c2f1db15a967d07ab
content/32: c76e2089a41880dd6feac759ec8867c2
content/33: 5d9a7b1e681cbe8f02def7eefabb0ac5
content/34: b4e0e90d40a60a024f64f80b193dcb48
content/35: b9f46c03c91c1070dd3ca0eba461f29b
content/36: fbecf63d14b56039ba44471f7a8afd4a
content/37: 58701f4ec097582ee105714a9363ccbe
content/38: 4d4ad5d56e800e5d227a07339300fc7f
content/39: 7f2a42a752279d7871064a21d0891b73
content/40: 8462e2271506b0545c62e5f70865a2f4
content/41: 59ceca96004d0746448717245eb65c5c
content/42: e7019a0e12f7295893c5822356fc0df0
content/43: 29d376146cd1149025028c61eb33e7ab
content/44: 4e1da4edce56837c750ce8da4c0e6cf2
content/45: 666a62d9fd54735b2adcad6277b3e07f
content/46: db012cfc3749d025f1dd40b5db1d9d63
content/47: 478fe7c3fbdd5e7d779691c9a09795c9
content/48: 58d582d90c8715f5570f76fed2be508d
content/49: 710baf5cf18c21cc284e70df97b36f40
content/50: 6363bbb118f3f51ca1b1acf3e9ec2f7c
content/51: 1900d5b89dbca22d7a455bdc3367f0f5
content/52: 959f29f44825109bf4bb16129896a8dd
content/53: fb6fddfdf4753a36c7878ef60b345822
content/54: 191fb7087315702a36001c69d745ebed
content/55: 1ffef0a4e0d6a6bbca85776c113e1164
content/56: 61caafaf79e863df9525c4baf72c14e1
content/57: ec31e300f79185f734d32b1cfaf8a137
content/58: 65a172d64ffca3b03c6e0ed08f0bd821
content/59: 2db387754d7fb3539bcb986dfaac1c8c
content/60: e118d997ba48a5230ec70a564d436860
content/61: 77268362a748dafad471f31acfd230dc
content/62: b55b3773df2dfba66b6e675db7e2470e
content/63: 70a9ece41fdad09f3a06ca0efdb92ae9
content/64: 646ee615d86faf3b6a8da03115a30efa
content/65: 5a80933fb21deea17a0a200564f0111b
content/66: a82d5e5fad0fbfd60ca97e5312d11941
content/67: bb172f1678686d9d49666c516716de24
content/68: a025b3b746d72e0f676f58703ee19a47
content/69: baa408b1603f35a8e24dd60b88773c72
content/70: c0cc113d0001826984f9c096c79cd18b
content/71: f6180f2341e8a7ae24afb05d7a185340
content/72: 3d414a5669f152cd296af27b61104858
content/73: 9a84c92505eb468916637fcf2cef70f2
content/74: a4c78d85ed9be63b07b657166510f440
content/75: 7431c09b430effd69de843ee0fbaafe8
content/76: 33b9b1e9744318597da4b925b0995be2
content/77: 6afe3b62e6d53c3dcd07149abcab4c05
content/78: b6363faee219321c16d41a9c3f8d3bdd
content/79: 08410ce9f0ec358b3c7230a56bc66399
content/80: b8b23ab79a7eb32c6f8d5f49f43c51f6
content/81: be358297e2bbb9ab4689d11d072611d1
content/82: 09fea7c0d742a0eefa77e982e848de6c
content/83: 7d098f0349c782f389431377ee512e92
content/84: 22b39537f6a104803389469d211154e4
content/85: d9ec74ab28b264d76f797fdae7c8f3d3
content/86: f29d6bfd74ba3fee0b90180f620b4f47
content/87: 2a59466500b62e57481fe27692a3ed0f
content/88: cbbb123fc3a12bf2ab72dc1bbe373a6e
content/89: 7873aa7487bc3e8a4826d65c1760a4a0
content/90: 98182d9aabe14d5bad43a5ee76a75eab
content/91: 67bfa8ae3e22d9a949f08c79a40b8df5
content/92: 7079d9c00b1e1882c329b7e9b8f74552
content/93: 0f9d65eaf6e8de43c3d5fa7e62bc838d
content/94: bcf0ce93a4493586ad32c20d9d2b285c
content/95: 7859d36a7a6d0122c0818b28ee29aa3e
content/96: ce185e7b041b8f95ebc11370d3e0aad9
content/97: dae96b41f0c029b464f02ac65d3c5796
content/98: 41c2bb95317d7c0421817a2b1a68cc09
content/99: 4c95f9fa55f698f220577380dff95011
content/100: 6695bd47a05f9963134d8a71abb3d298
content/101: 100e12673551d4ceb5b906b1b9c65059
content/102: ce253674cd7c49320203cda2bdd3685b
content/103: 94d4346a735149c2a83f6d2a21b8ab4c
content/104: 3ee4b16b8204ef3b5b7c0322ff636fab
content/105: 450265802cb0ba5b435b74b9cac1bf23
content/106: b735ede8764e4b2dfb25967e33ab5143
content/107: 0f881e586a03c4b916456c73fad48358
content/108: 4570af52d41ecda8d91e6bbe2bc19891
content/109: 55d47e12745c1b0b62c9bdf6e8449730
content/110: 82507d357ec8766f0173b9b1081c4c56
content/111: 3304a33dfb626c6e2267c062e8956a9d
content/112: a88260a5b5e23da73e4534376adeb193
content/113: cc31ae653c5642b223ec634888de29c6
content/114: 1773624e9ac3d5132b505894ef51977e
content/115: d62c9575cc66feec7589fba95c9f7aee
content/116: 8df5939abc771b5d24c115ef20d42d6f
content/117: ecd571818ddf3d31b08b80a25958a662
content/118: 7dcdf2fbf3fce3f94987046506e12a9b
004fe5dc5ca33719cb175f3619fe5208:
meta/title: be754b00d8a2c13c561e314f6f526515
content/0: 7e581dbf3e581d503ac94f7fb7938b1f
@@ -3970,7 +4086,25 @@ checksums:
content/7: e73f4b831f5b77c71d7d86c83abcbf11
content/8: 07e064793f3e0bbcb02c4dc6083b6daa
content/9: a702b191c3f94458bee880d33853e0cb
content/10: ce110ab5da3ff96f8cbf96ce3376fc51
content/11: 83f9b3ab46b0501c8eb3989bec3f4f1b
content/12: e00be80effb71b0acb014f9aa53dfbe1
content/13: 847a381137856ded9faa5994fbc489fb
content/10: c497057cbb9dd53599071f8550f327cd
content/11: cc6e48f85d5c6bfc05f846341f2d5cc9
content/12: 8a80a6a97da9bf375fac565f1caabb49
content/13: 098cc8e062187eb877fe5e172a4aa467
content/14: e452a7cb33d7cf2f7cf1804703edaa20
content/15: 466cfd61b1d0fcd8fc93d867dfd0f3e3
content/16: 377572316021236994f444e88949ef34
content/17: 54852933b2cbe3deb3b1c3059dba6a15
content/18: 9e66b045763abe053a3ba8d2c23e9aa1
content/19: d34f0950591e3beb085e99db64d07d2f
content/20: 8677ef07618f7289b04fef3cce8bf745
content/21: c0e6d2790e369569e7f272a5ec9ae21a
content/22: 93643a0d9d9745f131e4eabf7ead2018
content/23: 89c7da6d2e8fbc25e303a7381e147237
content/24: a8ec63597dc3a3564bc5f0c3a6e5f42c
content/25: 379618989b6cd427b319cfdab523297d
content/26: bc4c2e699a7514771276e90e9aee53ba
content/27: 38e14193b679ef774c3db93d399e700e
content/28: ce110ab5da3ff96f8cbf96ce3376fc51
content/29: 83f9b3ab46b0501c8eb3989bec3f4f1b
content/30: e00be80effb71b0acb014f9aa53dfbe1
content/31: 847a381137856ded9faa5994fbc489fb