Skip to content

Commit b012f16

Browse files
parth-sumoJV0812
andauthored
CONN-5158: Added ChatGPT Compliance Source (#5789)
* CONN-5158: Added ChatGPT Compliance Source * Formatting according to Beta release --------- Co-authored-by: Jagadisha V <[email protected]>
1 parent 4fcfcff commit b012f16

File tree

6 files changed

+157
-0
lines changed

6 files changed

+157
-0
lines changed

cid-redirects.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2914,6 +2914,7 @@
29142914
"/cid/21039": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/vectra-source",
29152915
"/cid/21059": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/onelogin-source",
29162916
"/cid/27061": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/github-copilot-source",
2917+
"/cid/26011": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/chatgpt-compliance-source",
29172918
"/cid/21041": "/docs/integrations/google/cloud-security-command-center",
29182919
"/cid/21097": "/docs/integrations/saas-cloud/confluent-cloud",
29192920
"/cid/21040": "/docs/manage/manage-subscription/create-and-manage-orgs/create-manage-orgs-service-providers",
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
id: chatgpt-compliance-source
3+
title: ChatGPT Compliance Source (Beta)
4+
sidebar_label: ChatGPT Compliance (Beta)
5+
tags:
6+
- cloud-to-cloud
7+
- chatgpt-compliance
8+
description: Learn to collect the conversations from ChatGPT Compliance platform.
9+
---
10+
11+
<head>
12+
<meta name="robots" content="noindex" />
13+
</head>
14+
15+
<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>
16+
17+
import useBaseUrl from '@docusaurus/useBaseUrl';
18+
19+
<img src={useBaseUrl('img/send-data/chatgpt-compliance.png')} alt="ChatGPT-Compliance-icon" width="40" />
20+
21+
OpenAI provides advanced AI solutions for enterprises, offering secure, compliant, and customizable conversational AI capabilities to improve the productivity while meeting organizational governance and regulatory needs.
22+
23+
The ChatGPT Compliance API enables enterprise customers to access structured conversation logs and metadata, integrating with eDiscovery, DLP, or SIEM systems to support auditing, compliance, and security requirements.
24+
25+
## Data collected
26+
27+
| Source | Description | Polling interval |
28+
| :-- | :-- | :-- |
29+
| Conversations | Log of user interactions with ChatGPT, including exchanged messages and metadata, used for compliance review and auditing. | 1 hour |
30+
31+
## Setup
32+
33+
### Vendor configuration
34+
35+
You are required to provide the **Workspace ID** and **API Key** to configure the ChatGPT Compliance source.
36+
37+
- Follow the below steps to collect the **Workspace ID**:
38+
1. In the OpenAI platform sidebar, go to **Settings - Workspace Settings (or General Settings)**.
39+
1. Your **Workspace ID** can be found in the **About / Workspace Info** section.
40+
41+
- Follow the below steps to collect the **API Key**:
42+
1. Sign in to the [OpenAI API Platform Portal](https://platform.openai.com/).
43+
:::note
44+
Be sure to create the API key within the same organization as your ChatGPT Enterprise workspace.
45+
:::
46+
1. Navigate to **API Keys** > **+ Create new secret key**.
47+
1. On the pop-up window, enter the following details:
48+
- Under **Owned by**, select **You**.
49+
- Enter the name of the API key.
50+
- Select the default project.
51+
- Under **Permissions**, select **All**.
52+
1. Click **Create secret key**.
53+
1. Copy and save the key.
54+
:::note
55+
The API key is only visible once, so be sure to copy it securely. This API key will be required when you set up the ChatGPT Enterprise instance on the Sumo Logic platform.
56+
:::
57+
1. Send an email to `[email protected]` requesting access to the Compliance API. Include the last 4 characters of the API key, the name of the key, who created it, and the requested scope (read).
58+
1. OpenAI team will verify the key and grant the requested Compliance API scopes.
59+
60+
### Source configuration
61+
62+
When you create a ChatGPT Compliance Source, you add it to a Hosted Collector. Before creating the source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector).
63+
64+
To configure a ChatGPT Compliance Source, follow the steps below:
65+
1. [**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic main menu select **Data Management**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**.<br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**.
66+
1. On the Collection page, click **Add Source** next to a Hosted Collector.
67+
1. Search for and select **ChatGPT Compliance**.
68+
1. Enter a **Name** for the Source. The description is optional.
69+
1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`.
70+
1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value.
71+
* <img src={useBaseUrl('img/reuse/green-check-circle.png')} alt="green check circle.png" width="20"/> A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
72+
* <img src={useBaseUrl('img/reuse/orange-exclamation-point.png')} alt="orange exclamation point.png" width="20"/> An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
73+
1. **Workspace ID**. Name of the workspace ID collected from the [ChatGPT platform](#vendor-configuration).
74+
1. **API Key**. Enter the API Key generated from the [ChatGPT platform](#vendor-configuration).
75+
1. **Polling Interval**. The polling interval is set for 1 hour by default and can be configured to a maximum of 24 hours. You can adjust it based on your needs. This sets how often the source checks for new data.
76+
1. When you are finished configuring the Source, click **Save**.
77+
78+
## JSON schema
79+
80+
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details.
81+
82+
| Parameter | Type | Value | Required | Description |
83+
|:--|:--|:--|:--|:--|
84+
| schemaRef | JSON Object | `{"type":"ChatGPT Compliance"}` | Yes | Define the specific schema type. |
85+
| sourceType | String | `"Universal"` | Yes | Type of source. |
86+
| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. |
87+
88+
### Configuration Object
89+
90+
| Parameter | Type | Required | Default | Description | Example |
91+
|:--|:--|:--|:--|:--|:--|
92+
| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` |
93+
| description | String | No | `null` | Type a description of the source. | `"Testing source"` |
94+
| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` |
95+
| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.| `{"_siemForward": false, "fieldA": "valueA"}` |
96+
| workspaceId | String | Yes | `null` | Name of your workspace ID. | ABCD-SAMPLE-WORKSPACE-ID |
97+
| apiKey | String | Yes | `null` | API Key of the account. | sk-proj-XXXXXXXXXXXXXXX |
98+
| pollingInterval | Integer | Yes | `1 hour` | Time interval (in hours) after which the source will check for new data. | 1h |
99+
100+
### JSON example
101+
102+
```json reference
103+
https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/chatgpt-compliance/example.json
104+
```
105+
106+
### Terraform example
107+
108+
```sh reference
109+
https://github.com/SumoLogic/sumologic-documentation/blob/main/static/files/c2c/chatgpt-compliance/example.tf
110+
```
111+
112+
## Limitations
113+
- Updates to conversations after a prolonged gap may cause re-ingestion and potential duplication.
114+
- As ChatGPT continues to evolve, updates may alter conversation data or API behavior, potentially impacting integration consistency.
115+
116+
## FAQ
117+
118+
:::info
119+
Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources.
120+
:::

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,6 +445,7 @@ module.exports = {
445445
'send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-cloud-source',
446446
'send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-inventory-source',
447447
'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cato-networks-source',
448+
//'send-data/hosted-collectors/cloud-to-cloud-integration-framework/chatgpt-compliance-source',
448449
'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-amp-source',
449450
'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-meraki-source',
450451
'send-data/hosted-collectors/cloud-to-cloud-integration-framework/cisco-vulnerability-management-source',
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"api.version": "v1",
3+
"source": {
4+
"config": {
5+
"name": "ChatGPT Compliance",
6+
"workspaceID": "ABCD-SAMPLE-WORKSPACE-ID",
7+
"apiKey": "sk-proj-XXXXXXXXX",
8+
"pollingIntervalHour": "1h"
9+
},
10+
"schemaRef": {
11+
"type": "ChatGPT Compliance"
12+
},
13+
"sourceType": "Universal"
14+
}
15+
}
16+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
resource "sumologic_cloud_to_cloud_source" "chatgpt-compliance-source" {
2+
collector_id = sumologic_collector.collector.id
3+
4+
schema_ref = {
5+
type = "ChatGPT Compliance"
6+
}
7+
8+
config = jsonencode({
9+
name = "ChatGPT Compliance"
10+
workspaceID = "ABCD-SAMPLE-WORKSPACE-ID"
11+
apiKey = "sk-proj-XXXXXXXXX"
12+
pollingIntervalHour = "1h"
13+
})
14+
}
15+
16+
resource "sumologic_collector" "collector" {
17+
name = "my-collector"
18+
description = "Just testing this"
19+
}
39.5 KB
Loading

0 commit comments

Comments
 (0)