diff --git a/src/content/api-reference/authentication.mdx b/src/content/api-reference/authentication.mdx index 13d43cb..18677a6 100644 --- a/src/content/api-reference/authentication.mdx +++ b/src/content/api-reference/authentication.mdx @@ -43,15 +43,44 @@ const client = new XetherClient({ apiKey: process.env.XETHER_API_KEY }); ### API Key Scopes -| Scope | Description | -| ------------------ | ---------------------------------- | -| `datasets:read` | Read dataset metadata and versions | -| `datasets:write` | Create and update datasets | -| `pipelines:read` | Read pipeline definitions | -| `pipelines:write` | Create and update pipelines | -| `executions:read` | Read execution status and logs | -| `executions:write` | Trigger pipeline executions | -| `admin` | Full access (use with caution) | + + + + Scope + Description + + + + + datasets:read + Read dataset metadata and versions + + + datasets:write + Create and update datasets + + + pipelines:read + Read pipeline definitions + + + pipelines:write + Create and update pipelines + + + executions:read + Read execution status and logs + + + executions:write + Trigger pipeline executions + + + admin + Full access (use with caution) + + +
## OAuth 2.0 @@ -104,8 +133,25 @@ curl -X POST https://auth.xether.ai/oauth/token \ ## Errors -| Code | Meaning | -| ----------------------- | -------------------------------- | -| `401 Unauthorized` | Missing or invalid API key | -| `403 Forbidden` | Valid key but insufficient scope | -| `429 Too Many Requests` | Rate limit exceeded | + + + + Code + Meaning + + + + + 401 Unauthorized + Missing or invalid API key + + + 403 Forbidden + Valid key but insufficient scope + + + 429 Too Many Requests + Rate limit exceeded + + +
diff --git a/src/content/api-reference/overview.mdx b/src/content/api-reference/overview.mdx index 1b2c3b6..71bac55 100644 --- a/src/content/api-reference/overview.mdx +++ b/src/content/api-reference/overview.mdx @@ -58,11 +58,28 @@ Errors return a non-2xx status with: ## Rate Limits -| Plan | Requests/minute | -| ---------- | --------------- | -| Free | 60 | -| Pro | 600 | -| Enterprise | Unlimited | + + + + Plan + Requests/minute + + + + + Free + 60 + + + Pro + 600 + + + Enterprise + Unlimited + + +
Rate limit headers are included in every response: @@ -74,12 +91,32 @@ X-RateLimit-Reset: 1705312260 ## Endpoints -| Resource | Description | -| ---------------------------------------------------- | --------------------------------- | -| [Authentication](/docs/api-reference/authentication) | Manage API keys and OAuth tokens | -| [Datasets](/docs/api-reference/datasets) | Create, list, and manage datasets | -| [Pipelines](/docs/api-reference/pipelines) | Define and manage pipelines | -| [Executions](/docs/api-reference/executions) | Trigger and monitor pipeline runs | + + + + Resource + Description + + + + + Authentication + Manage API keys and OAuth tokens + + + Datasets + Create, list, and manage datasets + + + Pipelines + Define and manage pipelines + + + Executions + Trigger and monitor pipeline runs + + +
## SDKs diff --git a/src/content/getting-started/core-concepts.mdx b/src/content/getting-started/core-concepts.mdx index cd2489d..5bbddf6 100644 --- a/src/content/getting-started/core-concepts.mdx +++ b/src/content/getting-started/core-concepts.mdx @@ -43,13 +43,36 @@ Dataset → [Ingest] → [Clean] → [Validate] → [Transform] → [Augment] ### Stage Types -| Stage | Purpose | -| ----------- | ------------------------------------------- | -| `ingest` | Read data from a source (S3, database, API) | -| `clean` | Remove nulls, normalize formats, fix types | -| `validate` | Assert data quality rules | -| `transform` | Reshape, join, aggregate data | -| `augment` | Enrich with external data or ML predictions | + + + + Stage + Purpose + + + + + ingest + Read data from a source (S3, database, API) + + + clean + Remove nulls, normalize formats, fix types + + + validate + Assert data quality rules + + + transform + Reshape, join, aggregate data + + + augment + Enrich with external data or ML predictions + + +
## Versions diff --git a/src/content/integrations/postgresql.mdx b/src/content/integrations/postgresql.mdx index bd7ef85..644db6e 100644 --- a/src/content/integrations/postgresql.mdx +++ b/src/content/integrations/postgresql.mdx @@ -262,25 +262,102 @@ config: ## Data Type Mapping -| PostgreSQL Type | Xether AI Type | Notes | -|-----------------|----------------|-------| -| INTEGER | integer | 32-bit integer | -| BIGINT | long | 64-bit integer | -| SMALLINT | short | 16-bit integer | -| DECIMAL/NUMERIC | decimal | Precision and scale preserved | -| REAL | float | Single precision | -| DOUBLE PRECISION | double | Double precision | -| BOOLEAN | boolean | True/False values | -| VARCHAR/TEXT | string | Variable length string | -| CHAR | string | Fixed length string | -| DATE | date | Date without time | -| TIME | time | Time without date | -| TIMESTAMP | timestamp | Timestamp without timezone | -| TIMESTAMPTZ | timestamp | Timestamp with timezone | -| UUID | string | UUID as string | -| JSON/JSONB | object | JSON-like structure | -| ARRAY | array | Array of values | -| BYTEA | binary | Binary data | + + + + PostgreSQL Type + Xether AI Type + Notes + + + + + INTEGER + integer + 32-bit integer + + + BIGINT + long + 64-bit integer + + + SMALLINT + short + 16-bit integer + + + DECIMAL/NUMERIC + decimal + Precision and scale preserved + + + REAL + float + Single precision + + + DOUBLE PRECISION + double + Double precision + + + BOOLEAN + boolean + True/False values + + + VARCHAR/TEXT + string + Variable length string + + + CHAR + string + Fixed length string + + + DATE + date + Date without time + + + TIME + time + Time without date + + + TIMESTAMP + timestamp + Timestamp without timezone + + + TIMESTAMPTZ + timestamp + Timestamp with timezone + + + UUID + string + UUID as string + + + JSON/JSONB + object + JSON-like structure + + + ARRAY + array + Array of values + + + BYTEA + binary + Binary data + + +
## Schema Evolution diff --git a/src/content/integrations/snowflake.mdx b/src/content/integrations/snowflake.mdx index 75ba90f..3fe41d6 100644 --- a/src/content/integrations/snowflake.mdx +++ b/src/content/integrations/snowflake.mdx @@ -265,20 +265,77 @@ config: ## Data Type Mapping -| Snowflake Type | Xether AI Type | Notes | -|----------------|----------------|-------| -| NUMBER | decimal | Precision and scale preserved | -| INTEGER | integer | 32-bit integer | -| BIGINT | long | 64-bit integer | -| FLOAT | double | Double precision | -| BOOLEAN | boolean | True/False values | -| VARCHAR | string | Variable length string | -| DATE | date | Date without time | -| TIMESTAMP | timestamp | Timestamp with timezone | -| TIMESTAMP_NTZ | timestamp | Timestamp without timezone | -| VARIANT | object | JSON-like structure | -| ARRAY | array | Array of values | -| OBJECT | object | Key-value pairs | + + + + Snowflake Type + Xether AI Type + Notes + + + + + NUMBER + decimal + Precision and scale preserved + + + INTEGER + integer + 32-bit integer + + + BIGINT + long + 64-bit integer + + + FLOAT + double + Double precision + + + BOOLEAN + boolean + True/False values + + + VARCHAR + string + Variable length string + + + DATE + date + Date without time + + + TIMESTAMP + timestamp + Timestamp with timezone + + + TIMESTAMP_NTZ + timestamp + Timestamp without timezone + + + VARIANT + object + JSON-like structure + + + ARRAY + array + Array of values + + + OBJECT + object + Key-value pairs + + +
## Schema Evolution diff --git a/src/content/ml-services/outlier-detection.mdx b/src/content/ml-services/outlier-detection.mdx index 9740cb5..84ddec1 100644 --- a/src/content/ml-services/outlier-detection.mdx +++ b/src/content/ml-services/outlier-detection.mdx @@ -396,12 +396,42 @@ stages: ### Algorithm Selection Guide -| Dataset Size | Dimensions | Recommended Algorithm | Reason | -|--------------|------------|----------------------|---------| -| < 10K rows | < 10 | Z-Score, IQR | Fast, simple | -| 10K-1M rows | 10-50 | Isolation Forest | Efficient, accurate | -| 1M-10M rows | 50-100 | Isolation Forest, LOF | Scalable | -| > 10M rows | > 100 | Autoencoder, Ensemble | Complex patterns | + + + + Dataset Size + Dimensions + Recommended Algorithm + Reason + + + + + < 10K rows + < 10 + Z-Score, IQR + Fast, simple + + + 10K-1M rows + 10-50 + Isolation Forest + Efficient, accurate + + + 1M-10M rows + 50-100 + Isolation Forest, LOF + Scalable + + + > 10M rows + > 100 + Autoencoder, Ensemble + Complex patterns + + +
### Optimization Tips