Projects

Projects are organizational containers that group related work together, including Data Connectors, taxonomies, and sensitivity detection settings. Think of a Project as a workspace for a specific initiative.

Example Use Cases

A project is typically named after the AI application or initiative it feeds:

Support Chatbot for Product Docs, curating the current manuals and FAQs a customer-facing chatbot answers from, with PII detection enabled
Sales Agent Brain, equipping an account agent with signed contracts, pricing sheets, and renewal terms
Contract Analysis 2024, processing legal contracts for the annual review

Project Components

Component	Description	Required
Name	Unique identifier for the project	Yes
Description	Optional notes about the project purpose	No
Data Connectors	One or more connected data repositories	At least one
Data Slice	Optional filtered subset of data	No (defaults to “All Data”)
Taxonomies	One or more tag hierarchies to apply	No
Sensitive Data Detection	Enable PII/PHI/PCI scanning	No

Project Structure

Sensitivity Detection Options

When creating a project, you can enable automatic sensitive data detection:

Type	Full Name	Examples
PII	Personal Identifiable Information	Names, emails, addresses, phone numbers, SSN
PHI	Protected Health Information	Medical records, diagnoses, prescriptions, insurance IDs
PCI	Payment Card Industry Data	Credit card numbers, bank accounts, payment details

Enable sensitivity detection to automatically flag documents containing protected information. This is especially useful for compliance workflows in healthcare, finance, and legal industries.

Workflow Example

Create a Project

Give your project a descriptive name and optional description.

Connect Data Sources

Link one or more Data Connectors to bring in your documents.

Define Scope with Data Slices

Optionally filter to specific documents using a Data Slice.

Attach Taxonomies

Select which tag hierarchies to apply for metadata extraction.

Enable Sensitivity Detection

Turn on PII, PHI, or PCI scanning if needed for compliance.

Python SDK

Create Project
List & Get
Update & Delete

from unstructured import UnstructuredClient

client = UnstructuredClient(
    base_url="https://unstructured.your-company.com/rest/unstructured",
    username="your-username",
    password="your-password",
)

# Create a project grouping connectors, taxonomies, and detection settings
project = client.projects.create(
    name="Contract Analysis 2024",
    description="Processing legal contracts for the 2024 review",
    data_source=["my-s3-bucket"],
    taxonomy=["contract-analysis"],
    sensitive_data=True,  # Enable PII/PHI/PCI scanning
)

# List all projects
projects = client.projects.list()

# Get a single project
project = client.projects.get("your-project-id")

# Review detected sensitive data for a project
sensitive = client.projects.get_sensitive_data("your-project-id")

# Update a project
client.projects.update(
    "your-project-id",
    description="Updated scope: includes Q1 2025 contracts",
)

# Delete a project
client.projects.delete("your-project-id")

API Reference

Create Project

Create a new project

List Projects

List all your projects

Get Project

Retrieve a single project

Get Sensitive Data

Review detected sensitive data

Getting Started

Core Concepts

Cookbooks

Integrations

Example Use Cases

Project Components

Project Structure

Sensitivity Detection Options

Workflow Example

Python SDK

API Reference

Create Project

List Projects

Get Project

Get Sensitive Data

​Example Use Cases

​Project Components

​Project Structure

​Sensitivity Detection Options

​Workflow Example

​Python SDK

​API Reference

Create Project

List Projects

Get Project

Get Sensitive Data

Example Use Cases

Project Components

Project Structure

Sensitivity Detection Options

Workflow Example

Python SDK

API Reference