# 取消公開來源擷取

Canonical URL: https://sosoapi.ai/zh-hant/docs/mcp/research-evidence-cancel

`sosoapi_research_evidence_cancel`

以原 mutation_id 取消來源讀取，首次回應前亦可提出取消。早到的取消會阻止之後開始讀取；已完成結果與取消競爭以持久狀態為準。

## Profiles 及連接方式

Profiles: full

Transports: stdio, http

Profile 只影響工具可見性，不會授予權限。HTTP 不提供本機檔案上傳。SOSOAPI_OUTPUT_SCHEMAS=1 會宣告輸出 schema；兩種模式均會回傳 structured results。

## 權限及改動

MCP annotations 只提供工具發現提示，並非存取控制保證；實際呼叫仍須通過登入、角色、資源及能力檢查。

```json
{
  "readOnlyHint": false,
  "destructiveHint": true,
  "idempotentHint": true,
  "openWorldHint": true
}
```

`/research-api/evidence/cancel` — agent:research; committed cancellation fence; late reader output is discarded

## 輸入欄位

```json
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "mutation_id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "workspace_id",
    "mutation_id"
  ],
  "additionalProperties": false
}
```

## 結構化輸出

此 schema 描述成功工具結果的 structuredContent。MCP envelope 亦包括 content，失敗時可能設定 isError；請勿將文字收據或已接受的請求視為平台終態。權限及重試規則請參閱對應的 API 操作。

```json
{
  "type": "object",
  "properties": {
    "retrieval": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "workspace_id": {
          "type": "string",
          "format": "uuid"
        },
        "mutation_id": {
          "type": "string",
          "format": "uuid"
        },
        "state": {
          "type": "string",
          "enum": [
            "pending",
            "running",
            "completed",
            "cancelled",
            "unconfirmed",
            "expired"
          ]
        },
        "kind": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "url_text",
                "published_captions"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": "string",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
          "format": "date-time"
        },
        "settled_at": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ]
        },
        "valid_until": {
          "type": "string",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
          "format": "date-time"
        },
        "result": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "url_text",
                    "published_captions"
                  ]
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "ready",
                    "partial",
                    "blocked",
                    "unsupported",
                    "empty",
                    "rate_limited",
                    "unavailable",
                    "cancelled"
                  ]
                },
                "text": {
                  "type": "string",
                  "maxLength": 20000
                },
                "title": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "segments": {
                  "maxItems": 1000,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "start_ms": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "end_ms": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 9007199254740991
                      },
                      "text": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 20000
                      }
                    },
                    "required": [
                      "start_ms",
                      "end_ms",
                      "text"
                    ],
                    "additionalProperties": false
                  }
                },
                "provenance": {
                  "type": "object",
                  "properties": {
                    "source_url": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 2048,
                          "format": "uri"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "retrieved_at": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "mime_type": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "text/html",
                            "application/xhtml+xml",
                            "text/plain",
                            "text/vtt",
                            "application/x-subrip",
                            "application/srt",
                            "text/srt"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "parser_version": {
                      "type": "string",
                      "const": "research-public-retrieval/v1"
                    },
                    "content_kind": {
                      "type": "string",
                      "enum": [
                        "document_text",
                        "metadata_only",
                        "published_caption_file",
                        "none"
                      ]
                    },
                    "caption_format": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "webvtt",
                            "subrip"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "language": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 35,
                          "pattern": "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "language_source": {
                      "type": "string",
                      "enum": [
                        "publisher_declared",
                        "unknown"
                      ]
                    },
                    "platform_native_verified": {
                      "type": "boolean",
                      "const": false
                    }
                  },
                  "required": [
                    "source_url",
                    "retrieved_at",
                    "mime_type",
                    "parser_version",
                    "content_kind",
                    "caption_format",
                    "language",
                    "language_source",
                    "platform_native_verified"
                  ],
                  "additionalProperties": false
                },
                "reason": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "unsafe_url",
                        "unsupported_source",
                        "unsupported_media",
                        "unsupported_content",
                        "access_denied",
                        "login_required",
                        "no_text",
                        "metadata_only",
                        "no_captions",
                        "invalid_captions",
                        "not_found",
                        "rate_limited",
                        "response_too_large",
                        "text_limited",
                        "nodes_limited",
                        "cues_limited",
                        "invalid_cues",
                        "language_mismatch",
                        "source_partial",
                        "timeout",
                        "cancelled",
                        "egress_unavailable",
                        "unavailable"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "warnings": {
                  "maxItems": 10,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "unsafe_url",
                      "unsupported_source",
                      "unsupported_media",
                      "unsupported_content",
                      "access_denied",
                      "login_required",
                      "no_text",
                      "metadata_only",
                      "no_captions",
                      "invalid_captions",
                      "not_found",
                      "rate_limited",
                      "response_too_large",
                      "text_limited",
                      "nodes_limited",
                      "cues_limited",
                      "invalid_cues",
                      "language_mismatch",
                      "source_partial",
                      "timeout",
                      "cancelled",
                      "egress_unavailable",
                      "unavailable"
                    ]
                  }
                },
                "retry_after_seconds": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 86400
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "kind",
                "status",
                "text",
                "title",
                "description",
                "segments",
                "provenance",
                "reason",
                "warnings",
                "retry_after_seconds"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        },
        "evidence": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "evidence_id": {
                  "type": "string",
                  "format": "uuid"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "evidence_id",
                "revision"
              ],
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "workspace_id",
        "mutation_id",
        "state",
        "kind",
        "created_at",
        "settled_at",
        "valid_until",
        "result",
        "evidence"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "retrieval"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}
```

## 工具呼叫範例

以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。

```json
{
  "name": "sosoapi_research_evidence_cancel",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "mutation_id": "40000000-0000-4000-8000-000000000001"
  }
}
```

structuredContent

```json
{
  "retrieval": {
    "id": "30000000-0000-4000-8000-000000000007",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "mutation_id": "40000000-0000-4000-8000-000000000001",
    "state": "cancelled",
    "kind": "url_text",
    "created_at": "2099-01-15T09:00:00Z",
    "settled_at": "2099-01-15T09:00:01Z",
    "valid_until": "2099-01-16T09:00:00Z",
    "evidence": null,
    "result": null
  }
}
```

## 對應 API 操作

- [/research-api/evidence/cancel](https://sosoapi.ai/zh-hant/docs/api/research-api-evidence-cancel)
