Skip to main content

​
Input Schema

schema When making a request to a document, your input and output data will be in JSON format. The structure of this data is defined by the document’s input and output schema. The input schema specifies the format and types of data that the document expects, while the output schema defines the format and types of data that the document will return after processing. You can find the input and output schema for each document on the Logic Dashboard. Click on your document, then click on the Integration tab. The input and output schema will be displayed in the Input Schema and Output Schema sections, respectively. For this example, we will be using the Redact PII document. This document is designed to redact personally identifiable information (PII) from a given text input.

​
Input Schema

The input should be a JSON object with the following structure: 
{
  "content": {
    "type": "string",
    "description": "The text content from which PII should be redacted."
  }
}
For this document, the input schema requires a content field. The content field is a string that contains the PII to be redacted. The document will process this text and identify any PII present, such as names, email addresses, phone numbers, etc. It will remove them from the text and return them in a separate array.
The input schema will differ depending on your document.

​
Input Example

{
  "content": "Steve emailed me at my personal address: mary@yahoo.com."
}
In this case, the input is a string containing text. When writing your document, you can also use images and other files as inputs, either as a URL or base64-encoded string.
⌘I