Python
import os
from scale_gp import SGPClient
client = SGPClient(
api_key=os.environ.get("SGP_API_KEY"), # This is the default and can be omitted
)
knowledge_base_data_source = client.knowledge_base_data_sources.create(
account_id="account_id",
data_source_config={
"aws_account_id": "aws_account_id",
"aws_region": "aws_region",
"s3_bucket": "s3_bucket",
"source": "S3",
},
name="name",
)
print(knowledge_base_data_source.id)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/sgp-go"
"github.com/stainless-sdks/sgp-go/option"
)
func main() {
client := sgp.NewClient(
option.WithAPIKey("My API Key"),
)
knowledgeBaseDataSource, err := client.KnowledgeBaseDataSources.New(context.TODO(), sgp.KnowledgeBaseDataSourceNewParams{
AccountID: sgp.F("account_id"),
DataSourceConfig: sgp.F[sgp.KnowledgeBaseDataSourceNewParamsDataSourceConfigUnion](sgp.S3DataSourceConfigParam{
AwsAccountID: sgp.F("aws_account_id"),
AwsRegion: sgp.F("aws_region"),
S3Bucket: sgp.F("s3_bucket"),
Source: sgp.F(sgp.S3DataSourceConfigSourceS3),
}),
Name: sgp.F("name"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", knowledgeBaseDataSource.ID)
}
curl --request POST \
--url https://api.egp.scale.com/v4/knowledge-base-data-sources \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"aws_region": "<string>",
"aws_account_id": "<string>",
"s3_prefix": ""
},
"account_id": "<string>",
"description": "<string>",
"data_source_auth_config": {
"source": "SharePoint",
"client_secret": "<string>",
"encrypted": false
},
"tagging_information": {
"type": "all",
"tags_to_apply": {}
}
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
data_source_config: {
source: 'S3',
s3_bucket: '<string>',
aws_region: '<string>',
aws_account_id: '<string>',
s3_prefix: ''
},
account_id: '<string>',
description: '<string>',
data_source_auth_config: {source: 'SharePoint', client_secret: '<string>', encrypted: false},
tagging_information: {type: 'all', tags_to_apply: {}}
})
};
fetch('https://api.egp.scale.com/v4/knowledge-base-data-sources', 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.egp.scale.com/v4/knowledge-base-data-sources",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'data_source_config' => [
'source' => 'S3',
's3_bucket' => '<string>',
'aws_region' => '<string>',
'aws_account_id' => '<string>',
's3_prefix' => ''
],
'account_id' => '<string>',
'description' => '<string>',
'data_source_auth_config' => [
'source' => 'SharePoint',
'client_secret' => '<string>',
'encrypted' => false
],
'tagging_information' => [
'type' => 'all',
'tags_to_apply' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/knowledge-base-data-sources")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"data_source_config\": {\n \"source\": \"S3\",\n \"s3_bucket\": \"<string>\",\n \"aws_region\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"s3_prefix\": \"\"\n },\n \"account_id\": \"<string>\",\n \"description\": \"<string>\",\n \"data_source_auth_config\": {\n \"source\": \"SharePoint\",\n \"client_secret\": \"<string>\",\n \"encrypted\": false\n },\n \"tagging_information\": {\n \"type\": \"all\",\n \"tags_to_apply\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v4/knowledge-base-data-sources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"data_source_config\": {\n \"source\": \"S3\",\n \"s3_bucket\": \"<string>\",\n \"aws_region\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"s3_prefix\": \"\"\n },\n \"account_id\": \"<string>\",\n \"description\": \"<string>\",\n \"data_source_auth_config\": {\n \"source\": \"SharePoint\",\n \"client_secret\": \"<string>\",\n \"encrypted\": false\n },\n \"tagging_information\": {\n \"type\": \"all\",\n \"tags_to_apply\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"aws_region": "<string>",
"aws_account_id": "<string>",
"s3_prefix": ""
},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"account_id": "<string>",
"description": "<string>",
"tagging_information": {
"type": "all",
"tags_to_apply": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Knowledge Base Data Sources
Create Knowledge Base Data Source
Description
Creates a knowledge base data source
Details
This API can be used to create a knowledge base data source. To use this API, review the request schema and pass in all fields that are required to create a knowledge base data source.
POST
/
v4
/
knowledge-base-data-sources
Python
import os
from scale_gp import SGPClient
client = SGPClient(
api_key=os.environ.get("SGP_API_KEY"), # This is the default and can be omitted
)
knowledge_base_data_source = client.knowledge_base_data_sources.create(
account_id="account_id",
data_source_config={
"aws_account_id": "aws_account_id",
"aws_region": "aws_region",
"s3_bucket": "s3_bucket",
"source": "S3",
},
name="name",
)
print(knowledge_base_data_source.id)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/sgp-go"
"github.com/stainless-sdks/sgp-go/option"
)
func main() {
client := sgp.NewClient(
option.WithAPIKey("My API Key"),
)
knowledgeBaseDataSource, err := client.KnowledgeBaseDataSources.New(context.TODO(), sgp.KnowledgeBaseDataSourceNewParams{
AccountID: sgp.F("account_id"),
DataSourceConfig: sgp.F[sgp.KnowledgeBaseDataSourceNewParamsDataSourceConfigUnion](sgp.S3DataSourceConfigParam{
AwsAccountID: sgp.F("aws_account_id"),
AwsRegion: sgp.F("aws_region"),
S3Bucket: sgp.F("s3_bucket"),
Source: sgp.F(sgp.S3DataSourceConfigSourceS3),
}),
Name: sgp.F("name"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", knowledgeBaseDataSource.ID)
}
curl --request POST \
--url https://api.egp.scale.com/v4/knowledge-base-data-sources \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"aws_region": "<string>",
"aws_account_id": "<string>",
"s3_prefix": ""
},
"account_id": "<string>",
"description": "<string>",
"data_source_auth_config": {
"source": "SharePoint",
"client_secret": "<string>",
"encrypted": false
},
"tagging_information": {
"type": "all",
"tags_to_apply": {}
}
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
data_source_config: {
source: 'S3',
s3_bucket: '<string>',
aws_region: '<string>',
aws_account_id: '<string>',
s3_prefix: ''
},
account_id: '<string>',
description: '<string>',
data_source_auth_config: {source: 'SharePoint', client_secret: '<string>', encrypted: false},
tagging_information: {type: 'all', tags_to_apply: {}}
})
};
fetch('https://api.egp.scale.com/v4/knowledge-base-data-sources', 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.egp.scale.com/v4/knowledge-base-data-sources",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'data_source_config' => [
'source' => 'S3',
's3_bucket' => '<string>',
'aws_region' => '<string>',
'aws_account_id' => '<string>',
's3_prefix' => ''
],
'account_id' => '<string>',
'description' => '<string>',
'data_source_auth_config' => [
'source' => 'SharePoint',
'client_secret' => '<string>',
'encrypted' => false
],
'tagging_information' => [
'type' => 'all',
'tags_to_apply' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.egp.scale.com/v4/knowledge-base-data-sources")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"data_source_config\": {\n \"source\": \"S3\",\n \"s3_bucket\": \"<string>\",\n \"aws_region\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"s3_prefix\": \"\"\n },\n \"account_id\": \"<string>\",\n \"description\": \"<string>\",\n \"data_source_auth_config\": {\n \"source\": \"SharePoint\",\n \"client_secret\": \"<string>\",\n \"encrypted\": false\n },\n \"tagging_information\": {\n \"type\": \"all\",\n \"tags_to_apply\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.egp.scale.com/v4/knowledge-base-data-sources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"data_source_config\": {\n \"source\": \"S3\",\n \"s3_bucket\": \"<string>\",\n \"aws_region\": \"<string>\",\n \"aws_account_id\": \"<string>\",\n \"s3_prefix\": \"\"\n },\n \"account_id\": \"<string>\",\n \"description\": \"<string>\",\n \"data_source_auth_config\": {\n \"source\": \"SharePoint\",\n \"client_secret\": \"<string>\",\n \"encrypted\": false\n },\n \"tagging_information\": {\n \"type\": \"all\",\n \"tags_to_apply\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"data_source_config": {
"source": "S3",
"s3_bucket": "<string>",
"aws_region": "<string>",
"aws_account_id": "<string>",
"s3_prefix": ""
},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"account_id": "<string>",
"description": "<string>",
"tagging_information": {
"type": "all",
"tags_to_apply": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
- S3 DataSource Config
- SharePoint DataSource Config
- SharePoint Page DataSource Config
- Google Drive DataSource Config
- Azure Blob Storage DataSource Config
- Google Cloud Storage DataSource Config
- Confluence DataSource Config
- Slack DataSource Config
- Snowflake DataSource Config
- Databricks DataSource Config
- SQL Database DataSource Config
- MongoDB DataSource Config
- BigQuery DataSource Config
Show child attributes
Show child attributes
The ID of the account that owns the given entity.
- SharePoint DataSource Auth Config
- SharePoint Page DataSource Auth Config
- Azure DataSource Auth Config
- Google Cloud Storage DataSource Auth Config
- Google Drive DataSource Auth Config
- S3 DataSource Auth Config
- Confluence DataSource Auth Config
- Slack DataSource Auth Config
- Snowflake DataSource Auth Config
- Databricks DataSource Auth Config
- SQL Database DataSource Auth Config
- MongoDB DataSource Auth Config
- BigQuery DataSource Auth Config
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful Response
- S3 DataSource Config
- SharePoint DataSource Config
- SharePoint Page DataSource Config
- Google Drive DataSource Config
- Azure Blob Storage DataSource Config
- Google Cloud Storage DataSource Config
- Confluence DataSource Config
- Slack DataSource Config
- Snowflake DataSource Config
- Databricks DataSource Config
- SQL Database DataSource Config
- MongoDB DataSource Config
- BigQuery DataSource Config
Show child attributes
Show child attributes
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The date and time when the entity was last updated in ISO format.
The user who originally created the entity.
The type of identity that created the entity.
Available options:
user, service_account The ID of the account that owns the given entity.
Show child attributes
Show child attributes