mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-03 19:24:57 -05:00
6cb3977dd9
* fix(visibility): updated visibility for non-sensitive tool params from user only to user or llm * update docs * updated docs script
183 lines
7.7 KiB
Plaintext
183 lines
7.7 KiB
Plaintext
---
|
|
title: Google Vault
|
|
description: Search, export, and manage holds/exports for Vault matters
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="google_vault"
|
|
color="#E8F0FE"
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
[Google Vault](https://workspace.google.com/products/vault/) is a core information governance and eDiscovery tool for organizations using Google Workspace. With Google Vault, you can retain, search, and export users' Google Workspace data (such as Gmail, Drive, Groups, and Meet) to support litigation, regulatory compliance, and internal investigations.
|
|
|
|
Vault provides administrators and legal teams with powerful controls to manage the lifecycle of business communications. You can place data on legal hold, create matters to group eDiscovery activities, search message and file content across your organization, and export relevant data for review.
|
|
|
|
Key features of Google Vault include:
|
|
|
|
- **Search & Export**: Search across Gmail, Drive, Groups, and Meet for relevant data and export the results for analysis.
|
|
- **Matters & Holds**: Create matters (cases) and apply legal holds to retain user data beyond standard retention policies.
|
|
- **Retention Rules**: Define retention rules to keep or delete data after a set period to meet business and compliance needs.
|
|
- **Audit & Review**: Monitor Vault activity and enforce compliance with organization-wide policies.
|
|
|
|
In Sim, the Google Vault integration lets your AI agents programmatically manage Vault matters, exports, and holds. This enables automated workflows for legal discovery, compliance archiving, and data retention management in your organization. Agents can initiate new exports, list available holds, manage legal matters, and retrieve exported files directly through your automated processes, ensuring your compliance and information governance needs are met efficiently and securely.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
|
|
## Usage Instructions
|
|
|
|
Connect Google Vault to create exports, list exports, and manage holds within matters.
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
### `google_vault_create_matters_export`
|
|
|
|
Create an export in a matter
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
|
| `exportName` | string | Yes | Name for the export \(avoid special characters\) |
|
|
| `corpus` | string | Yes | Data corpus to export \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
|
|
| `accountEmails` | string | No | Comma-separated list of user emails to scope export \(e.g., "user1@example.com, user2@example.com"\) |
|
|
| `orgUnitId` | string | No | Organization unit ID to scope export \(e.g., "id:03ph8a2z1enx5q0", alternative to emails\) |
|
|
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., "2024-01-01T00:00:00Z"\) |
|
|
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., "2024-12-31T23:59:59Z"\) |
|
|
| `terms` | string | No | Search query terms to filter exported content \(e.g., "from:sender@example.com subject:invoice"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `export` | json | Created export object |
|
|
|
|
### `google_vault_list_matters_export`
|
|
|
|
List exports for a matter
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
|
| `pageSize` | number | No | Number of exports to return per page |
|
|
| `pageToken` | string | No | Token for pagination |
|
|
| `exportId` | string | No | Optional export ID to fetch a specific export \(e.g., "exportId123456"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `exports` | json | Array of export objects |
|
|
| `export` | json | Single export object \(when exportId is provided\) |
|
|
| `nextPageToken` | string | Token for fetching next page of results |
|
|
|
|
### `google_vault_download_export_file`
|
|
|
|
Download a single file from a Google Vault export (GCS object)
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
|
| `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName |
|
|
| `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName |
|
|
| `fileName` | string | No | Optional filename override for the downloaded file |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `file` | file | Downloaded Vault export file stored in execution files |
|
|
|
|
### `google_vault_create_matters_holds`
|
|
|
|
Create a hold in a matter
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
|
| `holdName` | string | Yes | Name for the hold |
|
|
| `corpus` | string | Yes | Data corpus to hold \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) |
|
|
| `accountEmails` | string | No | Comma-separated list of user emails to put on hold \(e.g., "user1@example.com, user2@example.com"\) |
|
|
| `orgUnitId` | string | No | Organization unit ID to put on hold \(e.g., "id:03ph8a2z1enx5q0", alternative to accounts\) |
|
|
| `terms` | string | No | Search terms to filter held content \(e.g., "from:sender@example.com subject:invoice", for MAIL and GROUPS corpus\) |
|
|
| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., "2024-01-01T00:00:00Z", for MAIL and GROUPS corpus\) |
|
|
| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., "2024-12-31T23:59:59Z", for MAIL and GROUPS corpus\) |
|
|
| `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `hold` | json | Created hold object |
|
|
|
|
### `google_vault_list_matters_holds`
|
|
|
|
List holds for a matter
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) |
|
|
| `pageSize` | number | No | Number of holds to return per page |
|
|
| `pageToken` | string | No | Token for pagination |
|
|
| `holdId` | string | No | Optional hold ID to fetch a specific hold \(e.g., "holdId123456"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `holds` | json | Array of hold objects |
|
|
| `hold` | json | Single hold object \(when holdId is provided\) |
|
|
| `nextPageToken` | string | Token for fetching next page of results |
|
|
|
|
### `google_vault_create_matters`
|
|
|
|
Create a new matter in Google Vault
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `name` | string | Yes | Name for the new matter |
|
|
| `description` | string | No | Optional description for the matter |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `matter` | json | Created matter object |
|
|
|
|
### `google_vault_list_matters`
|
|
|
|
List matters, or get a specific matter if matterId is provided
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `pageSize` | number | No | Number of matters to return per page |
|
|
| `pageToken` | string | No | Token for pagination |
|
|
| `matterId` | string | No | Optional matter ID to fetch a specific matter \(e.g., "12345678901234567890"\) |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `matters` | json | Array of matter objects |
|
|
| `matter` | json | Single matter object \(when matterId is provided\) |
|
|
| `nextPageToken` | string | Token for fetching next page of results |
|
|
|
|
|