@ailib-official/ai-protocol 0.8.4

package/dist/v1/providers/writer.json

@@ -0,0 +1,253 @@
+{
+  "$schema": "https://raw.githubusercontent.com/ailib-official/ai-protocol/main/schemas/v1.json",
+  "id": "writer",
+  "protocol_version": "1.5",
+  "name": "Writer",
+  "version": "v1",
+  "status": "stable",
+  "category": "ai_provider",
+  "official_url": "https://dev.writer.com",
+  "support_contact": "https://writer.com/support",
+  "endpoint": {
+    "base_url": "https://api.writer.com",
+    "protocol": "https",
+    "timeout_ms": 10000
+  },
+  "auth": {
+    "type": "bearer",
+    "token_env": "WRITER_API_KEY",
+    "payload_format": "openai_style"
+  },
+  "api_families": [
+    "chat_completions",
+    "completions"
+  ],
+  "default_api_family": "chat_completions",
+  "endpoints": {
+    "chat": {
+      "path": "/v1/chat/completions",
+      "method": "POST",
+      "adapter": "openai"
+    },
+    "completions": {
+      "path": "/v1/completions",
+      "method": "POST",
+      "adapter": "openai"
+    },
+    "embeddings": {
+      "path": "/v1/embeddings",
+      "method": "POST",
+      "adapter": "openai"
+    }
+  },
+  "services": {
+    "list_models": {
+      "path": "/v1/models",
+      "method": "GET",
+      "response_binding": "data"
+    }
+  },
+  "termination": {
+    "source_field": "finish_reason",
+    "mapping": {
+      "stop": "end_turn",
+      "length": "max_tokens",
+      "tool_calls": "tool_use",
+      "content_filter": "refusal"
+    },
+    "notes": [
+      "Follows OpenAI finish_reason semantics",
+      "finish_reason is reported per candidate"
+    ]
+  },
+  "tooling": {
+    "source_model": "openai_tool_calls",
+    "tool_use": {
+      "id_path": "id",
+      "name_path": "function.name",
+      "input_path": "function.arguments",
+      "input_format": "json_string"
+    },
+    "notes": [
+      "Writer follows OpenAI tool calling conventions",
+      "tool_calls.function.arguments is a JSON string"
+    ]
+  },
+  "rate_limit_headers": {
+    "requests_limit": "x-ratelimit-limit-requests",
+    "requests_remaining": "x-ratelimit-remaining-requests",
+    "requests_reset": "x-ratelimit-reset-requests"
+  },
+  "retry_policy": {
+    "strategy": "exponential_backoff",
+    "max_retries": 3,
+    "max_delay_ms": 30000,
+    "min_delay_ms": 1000,
+    "jitter": "full",
+    "retry_on_http_status": [
+      429,
+      500,
+      502,
+      503
+    ],
+    "notes": [
+      "Follows OpenAI retry guidance",
+      "Exponential backoff for rate limits and server errors"
+    ]
+  },
+  "error_classification": {
+    "by_http_status": {
+      "400": "invalid_request",
+      "401": "authentication",
+      "403": "permission_denied",
+      "404": "not_found",
+      "429": "rate_limited",
+      "500": "server_error"
+    },
+    "notes": [
+      "Follows OpenAI error classification",
+      "429 may indicate rate limit or quota exhaustion"
+    ]
+  },
+  "parameter_mappings": {
+    "temperature": "temperature",
+    "max_tokens": "max_tokens",
+    "stream": "stream",
+    "top_p": "top_p",
+    "stop_sequences": "stop",
+    "frequency_penalty": "frequency_penalty",
+    "presence_penalty": "presence_penalty",
+    "logprobs": "logprobs",
+    "top_logprobs": "top_logprobs",
+    "seed": "seed",
+    "tools": "tools",
+    "tool_choice": "tool_choice"
+  },
+  "response_format": "openai_style",
+  "response_paths": {
+    "content": "choices[0].message.content",
+    "tool_calls": "choices[0].message.tool_calls",
+    "usage": "usage",
+    "finish_reason": "choices[0].finish_reason"
+  },
+  "streaming": {
+    "event_format": "data_lines",
+    "decoder": {
+      "format": "sse",
+      "delimiter": "\n\n",
+      "prefix": "data: ",
+      "done_signal": "[DONE]"
+    },
+    "frame_selector": "exists($.choices) || exists($.error) || $.type == 'error'",
+    "candidate": {
+      "candidate_id_path": "$.choices[*].index",
+      "fan_out": true
+    },
+    "event_map": [
+      {
+        "match": "exists($.error) || $.type == 'error'",
+        "emit": "StreamError",
+        "fields": {
+          "type": "$.type",
+          "event_id": "$.event_id",
+          "error": "$.error"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.content)",
+        "emit": "PartialContentDelta",
+        "fields": {
+          "content": "$.choices[*].delta.content"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.tool_calls[*].function.name)",
+        "emit": "ToolCallStarted",
+        "fields": {
+          "tool_call_id": "$.choices[*].delta.tool_calls[*].id",
+          "tool_name": "$.choices[*].delta.tool_calls[*].function.name",
+          "index": "$.choices[*].delta.tool_calls[*].index"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.tool_calls[*].function.arguments)",
+        "emit": "PartialToolCall",
+        "fields": {
+          "arguments": "$.choices[*].delta.tool_calls[*].function.arguments",
+          "index": "$.choices[*].delta.tool_calls[*].index"
+        }
+      },
+      {
+        "match": "exists($.usage)",
+        "emit": "Metadata",
+        "fields": {
+          "usage": "$.usage",
+          "prompt_tokens": "$.usage.prompt_tokens",
+          "completion_tokens": "$.usage.completion_tokens"
+        }
+      },
+      {
+        "match": "exists($.choices[*].finish_reason)",
+        "emit": "FinalCandidate",
+        "fields": {
+          "finish_reason": "$.choices[*].finish_reason",
+          "candidate_index": "$.choices[*].index"
+        }
+      }
+    ],
+    "stop_condition": "$.choices[0].finish_reason != null",
+    "extra_metadata_path": "$.usage",
+    "content_path": "choices[0].delta.content",
+    "tool_call_path": "choices[0].delta.tool_calls"
+  },
+  "features": {
+    "multi_candidate": {
+      "support_type": "native",
+      "param_name": "n"
+    },
+    "response_mapping": {
+      "tool_calls": {
+        "path": "choices[0].message.tool_calls",
+        "fields": {
+          "id": "id",
+          "name": "function.name",
+          "args": "function.arguments"
+        }
+      },
+      "error": {
+        "message_path": "error.message",
+        "code_path": "error.code",
+        "type_path": "error.type",
+        "param_path": "error.param"
+      }
+    }
+  },
+  "capabilities": {
+    "streaming": true,
+    "tools": true,
+    "vision": false,
+    "agentic": true,
+    "parallel_tools": false,
+    "reasoning": false
+  },
+  "experimental_features": [
+    "strict_tools",
+    "enterprise_compliance",
+    "factual_accuracy"
+  ],
+  "availability": {
+    "required": false,
+    "regions": [
+      "global"
+    ],
+    "check": {
+      "method": "GET",
+      "path": "/v1/models",
+      "expected_status": [
+        200,
+        401
+      ],
+      "timeout_ms": 3000
+    }
+  }
+}

package/dist/v1/providers/xai.json

@@ -0,0 +1,238 @@
+{
+  "$schema": "https://raw.githubusercontent.com/ailib-official/ai-protocol/main/schemas/v1.json",
+  "id": "xai",
+  "protocol_version": "1.5",
+  "name": "xAI",
+  "version": "v1",
+  "status": "stable",
+  "category": "ai_provider",
+  "official_url": "https://docs.x.ai",
+  "support_contact": "https://x.ai/support",
+  "endpoint": {
+    "base_url": "https://api.x.ai/v1",
+    "protocol": "https",
+    "timeout_ms": 10000
+  },
+  "auth": {
+    "type": "bearer",
+    "token_env": "XAI_API_KEY",
+    "payload_format": "openai_style"
+  },
+  "api_families": [
+    "chat_completions"
+  ],
+  "default_api_family": "chat_completions",
+  "endpoints": {
+    "chat": {
+      "path": "/chat/completions",
+      "method": "POST",
+      "adapter": "openai"
+    }
+  },
+  "services": {
+    "list_models": {
+      "path": "/models",
+      "method": "GET",
+      "response_binding": "data"
+    }
+  },
+  "termination": {
+    "source_field": "finish_reason",
+    "mapping": {
+      "stop": "end_turn",
+      "length": "max_tokens",
+      "tool_calls": "tool_use",
+      "content_filter": "refusal"
+    },
+    "notes": [
+      "follows OpenAI finish_reason semantics",
+      "finish_reason is reported per candidate"
+    ]
+  },
+  "tooling": {
+    "source_model": "openai_tool_calls",
+    "tool_use": {
+      "id_path": "id",
+      "name_path": "function.name",
+      "input_path": "function.arguments",
+      "input_format": "json_string"
+    },
+    "notes": [
+      "xAI tool_calls.function.arguments is a JSON string; runtimes SHOULD parse it into an object",
+      "Follows OpenAI tool calling conventions"
+    ]
+  },
+  "retry_policy": {
+    "max_retries": 3,
+    "max_delay_ms": 30000,
+    "strategy": "exponential_backoff",
+    "min_delay_ms": 1000,
+    "jitter": "full",
+    "retry_on_http_status": [
+      429,
+      500,
+      502,
+      503
+    ],
+    "notes": [
+      "Follows OpenAI retry guidance",
+      "exponential backoff recommended for rate limit and server errors"
+    ]
+  },
+  "error_classification": {
+    "by_http_status": {
+      "400": "invalid_request",
+      "401": "authentication",
+      "403": "permission_denied",
+      "404": "not_found",
+      "429": "rate_limited",
+      "500": "server_error"
+    },
+    "notes": [
+      "Follows OpenAI error classification",
+      "429 may indicate rate limit or quota exhaustion"
+    ]
+  },
+  "parameter_mappings": {
+    "temperature": "temperature",
+    "max_tokens": "max_tokens",
+    "stream": "stream",
+    "top_p": "top_p",
+    "stop_sequences": "stop",
+    "frequency_penalty": "frequency_penalty",
+    "presence_penalty": "presence_penalty",
+    "logprobs": "logprobs",
+    "top_logprobs": "top_logprobs",
+    "seed": "seed",
+    "tools": "tools",
+    "tool_choice": "tool_choice",
+    "reasoning_effort": "reasoning_effort"
+  },
+  "response_format": "openai_style",
+  "response_paths": {
+    "content": "choices[0].message.content",
+    "tool_calls": "choices[0].message.tool_calls",
+    "usage": "usage",
+    "finish_reason": "choices[0].finish_reason"
+  },
+  "streaming": {
+    "event_format": "data_lines",
+    "decoder": {
+      "format": "sse",
+      "delimiter": "\n\n",
+      "prefix": "data: ",
+      "done_signal": "[DONE]"
+    },
+    "frame_selector": "exists($.choices) || exists($.error) || $.type == 'error'",
+    "candidate": {
+      "candidate_id_path": "$.choices[*].index",
+      "fan_out": true
+    },
+    "event_map": [
+      {
+        "match": "exists($.error) || $.type == 'error'",
+        "emit": "StreamError",
+        "fields": {
+          "type": "$.type",
+          "event_id": "$.event_id",
+          "error": "$.error"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.content)",
+        "emit": "PartialContentDelta",
+        "fields": {
+          "content": "$.choices[*].delta.content"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.tool_calls[*].function.name)",
+        "emit": "ToolCallStarted",
+        "fields": {
+          "tool_call_id": "$.choices[*].delta.tool_calls[*].id",
+          "tool_name": "$.choices[*].delta.tool_calls[*].function.name",
+          "index": "$.choices[*].delta.tool_calls[*].index"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.tool_calls[*].function.arguments)",
+        "emit": "PartialToolCall",
+        "fields": {
+          "arguments": "$.choices[*].delta.tool_calls[*].function.arguments",
+          "index": "$.choices[*].delta.tool_calls[*].index"
+        }
+      },
+      {
+        "match": "exists($.usage)",
+        "emit": "Metadata",
+        "fields": {
+          "usage": "$.usage",
+          "prompt_tokens": "$.usage.prompt_tokens",
+          "completion_tokens": "$.usage.completion_tokens"
+        }
+      },
+      {
+        "match": "exists($.choices[*].finish_reason)",
+        "emit": "FinalCandidate",
+        "fields": {
+          "finish_reason": "$.choices[*].finish_reason",
+          "candidate_index": "$.choices[*].index"
+        }
+      }
+    ],
+    "stop_condition": "$.choices[0].finish_reason != null",
+    "extra_metadata_path": "$.usage",
+    "content_path": "choices[0].delta.content",
+    "tool_call_path": "choices[0].delta.tool_calls"
+  },
+  "features": {
+    "multi_candidate": {
+      "support_type": "native",
+      "param_name": "n"
+    },
+    "response_mapping": {
+      "tool_calls": {
+        "path": "choices[0].message.tool_calls",
+        "fields": {
+          "id": "id",
+          "name": "function.name",
+          "args": "function.arguments"
+        }
+      },
+      "error": {
+        "message_path": "error.message",
+        "code_path": "error.code",
+        "type_path": "error.type",
+        "param_path": "error.param"
+      }
+    }
+  },
+  "capabilities": {
+    "streaming": true,
+    "tools": true,
+    "vision": true,
+    "agentic": true,
+    "parallel_tools": true,
+    "reasoning": true
+  },
+  "experimental_features": [
+    "gork_realtime",
+    "strict_tools",
+    "parallel_tool_calls"
+  ],
+  "availability": {
+    "required": false,
+    "regions": [
+      "global"
+    ],
+    "check": {
+      "method": "GET",
+      "path": "/models",
+      "expected_status": [
+        200,
+        401
+      ],
+      "timeout_ms": 3000
+    }
+  }
+}

package/dist/v1/providers/yi.json

@@ -0,0 +1,205 @@
+{
+  "$schema": "https://raw.githubusercontent.com/ailib-official/ai-protocol/main/schemas/v1.json",
+  "id": "yi",
+  "protocol_version": "1.5",
+  "name": "零一万物 (Yi/01.AI)",
+  "version": "v1",
+  "status": "stable",
+  "category": "ai_provider",
+  "official_url": "https://platform.lingyiwanwu.com/docs",
+  "support_contact": "https://www.01.ai/contact",
+  "endpoint": {
+    "base_url": "https://api.lingyiwanwu.com/v1",
+    "protocol": "https",
+    "timeout_ms": 60000
+  },
+  "auth": {
+    "type": "bearer",
+    "token_env": "YI_API_KEY"
+  },
+  "payload_format": "openai_style",
+  "api_families": [
+    "chat_completions"
+  ],
+  "default_api_family": "chat_completions",
+  "endpoints": {
+    "chat": {
+      "path": "/chat/completions",
+      "method": "POST",
+      "adapter": "openai"
+    }
+  },
+  "services": {
+    "list_models": {
+      "path": "/models",
+      "method": "GET",
+      "response_binding": "data"
+    }
+  },
+  "termination": {
+    "source_field": "finish_reason",
+    "mapping": {
+      "stop": "end_turn",
+      "length": "max_tokens",
+      "tool_calls": "tool_use"
+    },
+    "notes": [
+      "OpenAI-compatible finish_reason.",
+      "Yi is founded by Kai-Fu Lee, known for open-source Yi series models."
+    ]
+  },
+  "tooling": {
+    "source_model": "openai_tool_calls",
+    "tool_use": {
+      "id_path": "id",
+      "name_path": "function.name",
+      "input_path": "function.arguments",
+      "input_format": "json_string"
+    },
+    "notes": [
+      "Supports OpenAI-compatible function calling."
+    ]
+  },
+  "retry_policy": {
+    "strategy": "exponential_backoff",
+    "max_retries": 3,
+    "min_delay_ms": 1000,
+    "max_delay_ms": 30000,
+    "jitter": "full",
+    "retry_on_http_status": [
+      429,
+      500,
+      502,
+      503
+    ]
+  },
+  "error_classification": {
+    "by_http_status": {
+      "400": "invalid_request",
+      "401": "authentication",
+      "403": "permission_denied",
+      "404": "not_found",
+      "429": "rate_limited",
+      "500": "server_error",
+      "503": "overloaded"
+    }
+  },
+  "parameter_mappings": {
+    "temperature": "temperature",
+    "max_tokens": "max_tokens",
+    "stream": "stream",
+    "top_p": "top_p",
+    "stop_sequences": "stop",
+    "tools": "tools",
+    "tool_choice": "tool_choice"
+  },
+  "response_format": "openai_style",
+  "response_paths": {
+    "content": "choices[0].message.content",
+    "tool_calls": "choices[0].message.tool_calls",
+    "usage": "usage",
+    "finish_reason": "choices[0].finish_reason"
+  },
+  "streaming": {
+    "event_format": "data_lines",
+    "decoder": {
+      "format": "sse",
+      "delimiter": "\n\n",
+      "prefix": "data: ",
+      "done_signal": "[DONE]"
+    },
+    "content_path": "choices[0].delta.content",
+    "tool_call_path": "choices[0].delta.tool_calls",
+    "usage_path": "usage",
+    "frame_selector": "exists($.choices) || exists($.error)",
+    "event_map": [
+      {
+        "match": "exists($.choices[*].delta.content)",
+        "emit": "PartialContentDelta",
+        "fields": {
+          "content": "$.choices[*].delta.content"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.tool_calls[*].function.name)",
+        "emit": "ToolCallStarted",
+        "fields": {
+          "tool_call_id": "$.choices[*].delta.tool_calls[*].id",
+          "tool_name": "$.choices[*].delta.tool_calls[*].function.name",
+          "index": "$.choices[*].delta.tool_calls[*].index"
+        }
+      },
+      {
+        "match": "exists($.choices[*].delta.tool_calls[*].function.arguments)",
+        "emit": "PartialToolCall",
+        "fields": {
+          "arguments": "$.choices[*].delta.tool_calls[*].function.arguments",
+          "index": "$.choices[*].delta.tool_calls[*].index"
+        }
+      },
+      {
+        "match": "exists($.usage)",
+        "emit": "Metadata",
+        "fields": {
+          "usage": "$.usage"
+        }
+      },
+      {
+        "match": "exists($.choices[*].finish_reason)",
+        "emit": "FinalCandidate",
+        "fields": {
+          "finish_reason": "$.choices[*].finish_reason"
+        }
+      }
+    ],
+    "stop_condition": "$.choices[0].finish_reason != null"
+  },
+  "features": {
+    "multi_candidate": {
+      "support_type": "native",
+      "param_name": "n"
+    },
+    "response_mapping": {
+      "tool_calls": {
+        "path": "choices[0].message.tool_calls",
+        "fields": {
+          "id": "id",
+          "name": "function.name",
+          "args": "function.arguments"
+        }
+      },
+      "error": {
+        "message_path": "error.message",
+        "code_path": "error.code"
+      }
+    }
+  },
+  "capabilities": {
+    "streaming": true,
+    "tools": true,
+    "vision": true,
+    "agentic": true,
+    "parallel_tools": false,
+    "reasoning": false
+  },
+  "availability": {
+    "required": false,
+    "regions": [
+      "cn",
+      "global"
+    ],
+    "check": {
+      "method": "GET",
+      "path": "/models",
+      "expected_status": [
+        200,
+        401
+      ],
+      "timeout_ms": 5000
+    }
+  },
+  "experimental_features": [
+    "open_source_models",
+    "bilingual"
+  ]
+}