@ailib-official/ai-protocol 0.8.4

package/v1/providers/zhipu.yaml

@@ -0,0 +1,171 @@
+$schema: "https://raw.githubusercontent.com/ailib-official/ai-protocol/main/schemas/v1.json"
+
+id: zhipu
+protocol_version: "1.5"
+
+name: 智谱 AI (Zhipu/GLM)
+version: "v1"
+status: stable
+category: ai_provider
+official_url: "https://open.bigmodel.cn/dev/api"
+support_contact: "https://www.zhipuai.cn/contact"
+
+endpoint:
+  base_url: "https://open.bigmodel.cn/api/paas/v4"
+  protocol: https
+  timeout_ms: 60000
+
+auth:
+  type: bearer
+  token_env: "ZHIPU_API_KEY"
+
+payload_format: "openai_style"
+
+# OpenAI-compatible API
+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"
+    sensitive: "refusal"
+  notes:
+    - "OpenAI-compatible finish_reason."
+    - "GLM (General Language Model) is Zhipu's flagship model series."
+    - "Founded by Tsinghua University researchers."
+
+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."
+    - "Also supports web_search and code_interpreter tools."
+
+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: true
+  reasoning: false
+
+availability:
+  required: false
+  regions:
+    - cn
+  check:
+    method: GET
+    path: "/models"
+    expected_status: [200, 401]
+    timeout_ms: 5000
+
+experimental_features:
+  - "web_search"
+  - "code_interpreter"
+  - "knowledge_retrieval"