GET

workspaces

{workspaceId}

redactions

{redactionId}

review

Get redaction review

curl --request GET \
  --url https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review

const options = {method: 'GET'};

fetch('https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "codec": {
    "rasterMode": {
      "kind": "auto"
    }
  },
  "context": {
    "countries": [
      "<string>"
    ],
    "languages": [],
    "metadata": {
      "audience": [],
      "purpose": "<string>",
      "tags": []
    }
  },
  "report": {
    "parts": [
      {
        "entities": [
          {
            "audit": [
              {
                "confidence": 123,
                "hash": "<string>",
                "kind": {
                  "detail": {
                    "location": {
                      "coord": {
                        "range": {
                          "end": 1,
                          "start": 1
                        },
                        "kind": "decoded",
                        "source": [
                          {
                            "range": {
                              "end": 1,
                              "start": 1
                            },
                            "part": "<string>"
                          }
                        ]
                      },
                      "page": 1
                    },
                    "pattern": {
                      "contextual": true,
                      "name": "<string>",
                      "regex": "<string>",
                      "validator": "<string>"
                    }
                  },
                  "kind": "pattern"
                },
                "parents": [
                  "<string>"
                ],
                "source": "<string>",
                "timestamp": "<string>"
              }
            ],
            "confidence": 123,
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "location": {
              "coord": {
                "range": {
                  "end": 1,
                  "start": 1
                },
                "kind": "decoded",
                "source": [
                  {
                    "range": {
                      "end": 1,
                      "start": 1
                    },
                    "part": "<string>"
                  }
                ]
              },
              "page": 1
            },
            "coref": "<string>",
            "language": "<string>",
            "recognized_range": {
              "end": 1,
              "start": 1
            }
          }
        ],
        "id": [
          "<string>"
        ],
        "modality": "text"
      }
    ],
    "usage": {
      "entries": [
        {
          "duration": 1,
          "id": {
            "name": "<string>",
            "version": "<string>"
          },
          "count": 1,
          "model": {
            "model": "<string>",
            "tokens": {
              "input": 1,
              "output": 1,
              "total": 1
            },
            "version": "<string>"
          }
        }
      ]
    }
  },
  "usage": {
    "entries": [
      {
        "duration": 1,
        "id": {
          "name": "<string>",
          "version": "<string>"
        },
        "count": 1,
        "model": {
          "model": "<string>",
          "tokens": {
            "input": 1,
            "output": 1,
            "total": 1
          },
          "version": "<string>"
        }
      }
    ]
  },
  "recognition": [
    {
      "custom": [
        {
          "id": "<string>",
          "localizations": {},
          "tags": [
            "<string>"
          ],
          "category": "<string>"
        }
      ],
      "matchers": [
        {
          "kind": "pattern",
          "pattern": "<string>",
          "label": "<string>",
          "name": "<string>",
          "confidence": 0.6000000238418579
        }
      ]
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

Path Parameters

workspaceId

string<uuid>

required

Workspace identifier.

redactionId

string

required

Opaque identifier of the redaction.

Pattern: ^redaction_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

What detection found in one document.

Wraps elide's Report [blocked] with the things elide does not model: the recognition [DocumentContext] the entities were scored against, how the document decoded, and what the pass cost.

Reviewer edits are not here. They are the caller's own input, applied to the report before anonymize (EditSet::apply [blocked]), so an audit carries what analysis found as amended rather than the amendments themselves.

Serialization

[Serialize] but deliberately not Deserialize: a serialized report tags entity groups by modality name, so rebuilding one needs the registry Engine [blocked] holds. Read an audit back with Engine::deserialize_audit [blocked].

Schema

Generate under the serialize contract (SchemaSettings::for_serialize [blocked]). usage is skip_serializing_if, and only that contract marks it optional — schema_for! defaults to deserialize and declares it required, so a generated client would reject responses this crate really emits.

What detection found in one document.

Wraps elide's Report [blocked] with the things elide does not model: the recognition [DocumentContext] the entities were scored against, how the document decoded, and what the pass cost.

Serialization

Schema

codec

object

required

How this document was decoded when it was analyzed.

Carried back so anonymize decodes identically: the entity offsets below are stored against the first decode, and a differently-rendered second one would not line up.

Show child attributes

context

object

required

What the caller asserted when this document was analyzed: languages, jurisdictions, document tags.

Carried back so Engine::anonymize [blocked] compiles against the same vocabulary analyze used, and re-decodes under the same codec configuration, without the caller re-passing it.

Show child attributes

report

object

required

The detections: elide's own report, every document and the parts nested in one, each entity carrying its provenance chain.

Edit it through Report [blocked]'s own API — include_part [blocked], suppress_part [blocked], part_entities [blocked] — for the decisions elide models.

Show child attributes

usage

object

required

What the analyze pass cost: one entry per recognizer and enricher that ran, each self-identifying by the name the deployment configured it under.

Carried here rather than read off the report: elide derives usage during analysis and drops it when a report is rebuilt from the wire, so a host that bills on model spend would lose it on the round trip.

Show child attributes

recognition

object[]

The vocabularies this request introduced: labels elide does not ship, and how they were found.

Carried back for the same reason context [blocked] is. Anonymize compiles its catalog afresh, and a custom label missing from it resolves to nothing — the entity would be detected and then silently not redacted.

Show child attributes

Get redaction review

curl --request GET \
  --url https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review

const options = {method: 'GET'};

fetch('https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceId}/redactions/{redactionId}/review")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "codec": {
    "rasterMode": {
      "kind": "auto"
    }
  },
  "context": {
    "countries": [
      "<string>"
    ],
    "languages": [],
    "metadata": {
      "audience": [],
      "purpose": "<string>",
      "tags": []
    }
  },
  "report": {
    "parts": [
      {
        "entities": [
          {
            "audit": [
              {
                "confidence": 123,
                "hash": "<string>",
                "kind": {
                  "detail": {
                    "location": {
                      "coord": {
                        "range": {
                          "end": 1,
                          "start": 1
                        },
                        "kind": "decoded",
                        "source": [
                          {
                            "range": {
                              "end": 1,
                              "start": 1
                            },
                            "part": "<string>"
                          }
                        ]
                      },
                      "page": 1
                    },
                    "pattern": {
                      "contextual": true,
                      "name": "<string>",
                      "regex": "<string>",
                      "validator": "<string>"
                    }
                  },
                  "kind": "pattern"
                },
                "parents": [
                  "<string>"
                ],
                "source": "<string>",
                "timestamp": "<string>"
              }
            ],
            "confidence": 123,
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "location": {
              "coord": {
                "range": {
                  "end": 1,
                  "start": 1
                },
                "kind": "decoded",
                "source": [
                  {
                    "range": {
                      "end": 1,
                      "start": 1
                    },
                    "part": "<string>"
                  }
                ]
              },
              "page": 1
            },
            "coref": "<string>",
            "language": "<string>",
            "recognized_range": {
              "end": 1,
              "start": 1
            }
          }
        ],
        "id": [
          "<string>"
        ],
        "modality": "text"
      }
    ],
    "usage": {
      "entries": [
        {
          "duration": 1,
          "id": {
            "name": "<string>",
            "version": "<string>"
          },
          "count": 1,
          "model": {
            "model": "<string>",
            "tokens": {
              "input": 1,
              "output": 1,
              "total": 1
            },
            "version": "<string>"
          }
        }
      ]
    }
  },
  "usage": {
    "entries": [
      {
        "duration": 1,
        "id": {
          "name": "<string>",
          "version": "<string>"
        },
        "count": 1,
        "model": {
          "model": "<string>",
          "tokens": {
            "input": 1,
            "output": 1,
            "total": 1
          },
          "version": "<string>"
        }
      }
    ]
  },
  "recognition": [
    {
      "custom": [
        {
          "id": "<string>",
          "localizations": {},
          "tags": [
            "<string>"
          ],
          "category": "<string>"
        }
      ],
      "matchers": [
        {
          "kind": "pattern",
          "pattern": "<string>",
          "label": "<string>",
          "name": "<string>",
          "confidence": 0.6000000238418579
        }
      ]
    }
  ]
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

API Reference

Endpoints

Get redaction review

Path Parameters

Response

Serialization

Schema

Serialization

Schema