(dataSources)

​
Overview

Operations related to data sources. A data source is a blob of text that can be made available to an agent’s general info tools to provide more context to the agent when generating its responses.

​
Available Operations

​
list

Fetch metadata about all data sources, not including their text.

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dataSources.list({});

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dataSourcesList } from "syllable-sdk/funcs/dataSourcesList.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dataSourcesList(syllableSDK, {});

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.DataSourcesListRequestTRUEThe request object to use for the request.
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.ListResponseDataSourceMetadataResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.HTTPValidationError422application/json
errors.SDKError4XX, 5XX*/*

​
create

Create a new data source.

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dataSources.create({
    name: "Rain",
    description: "Information about rain.",
    labels: [
      "Weather Info",
    ],
    chunk: false,
    chunkDelimiter: "",
    text: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dataSourcesCreate } from "syllable-sdk/funcs/dataSourcesCreate.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dataSourcesCreate(syllableSDK, {
    name: "Rain",
    description: "Information about rain.",
    labels: [
      "Weather Info",
    ],
    chunk: false,
    chunkDelimiter: "",
    text: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestcomponents.DataSourceCreateRequestTRUEThe request object to use for the request.
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.DataSourceDetailResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.HTTPValidationError422application/json
errors.SDKError4XX, 5XX*/*

​
update

Update an existing data source.

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dataSources.update({
    name: "Rain",
    description: "Information about rain.",
    labels: [
      "Weather Info",
    ],
    chunk: false,
    chunkDelimiter: "",
    id: 1,
    editComments: "Added new info",
    text: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dataSourcesUpdate } from "syllable-sdk/funcs/dataSourcesUpdate.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dataSourcesUpdate(syllableSDK, {
    name: "Rain",
    description: "Information about rain.",
    labels: [
      "Weather Info",
    ],
    chunk: false,
    chunkDelimiter: "",
    id: 1,
    editComments: "Added new info",
    text: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestcomponents.DataSourceUpdateRequestTRUEThe request object to use for the request.
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.DataSourceDetailResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.HTTPValidationError422application/json
errors.SDKError4XX, 5XX*/*

​
getById

Fetch a given data source, including its text.

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dataSources.getById({
    dataSourceId: 931598,
  });

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dataSourcesGetById } from "syllable-sdk/funcs/dataSourcesGetById.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dataSourcesGetById(syllableSDK, {
    dataSourceId: 931598,
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.DataSourcesGetByIdRequestTRUEThe request object to use for the request.
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise<components.DataSourceDetailResponse>

​
Errors

Error TypeStatus CodeContent Type
errors.HTTPValidationError422application/json
errors.SDKError4XX, 5XX*/*

​
delete

Delete a given data source.

​
Example Usage

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.dataSources.delete({
    dataSourceId: 545907,
    reason: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

​
Standalone function

The standalone function version of this method:

import { SyllableSDKCore } from "syllable-sdk/core.js";
import { dataSourcesDelete } from "syllable-sdk/funcs/dataSourcesDelete.js";

// Use `SyllableSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const syllableSDK = new SyllableSDKCore({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const res = await dataSourcesDelete(syllableSDK, {
    dataSourceId: 545907,
    reason: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

​
Parameters

ParameterTypeRequiredDescription
requestoperations.DataSourcesDeleteRequestTRUEThe request object to use for the request.
optionsRequestOptionsFALSEUsed to set various options for making HTTP requests.
options.fetchOptionsRequestInitFALSEOptions that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfigFALSEEnables retrying HTTP requests under certain failure conditions.

​
Response

Promise\ANY>

​
Errors

Error TypeStatus CodeContent Type
errors.HTTPValidationError422application/json
errors.SDKError4XX, 5XX*/*
PromptsCustomMessages