@ngreenberg/aiservices-sdk

Docs viewer: https://unpkg.com/@ngreenberg/aiservices-sdk@latest/docs/index.html

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @ngreenberg/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

AiagentApi

|Method | HTTP request | Description| |------------- | ------------- | -------------| |addIntents | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary | Add summary intents| |aiagentChatAgentAgentIdTranscriptSummaryPost | POST /aiagent/chat/agent/{agentId}/transcript/summary | Get summary for a given conversation transcript| |aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete | DELETE /aiagent/ops/department/{departmentId}/agent/{agentId}/tools | Delete all tools| |aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet | GET /aiagent/ops/department/{departmentId}/agent/{agentId}/tools | Get all tools| |aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost | POST /aiagent/ops/department/{departmentId}/agent/{agentId}/tools | Create a tool| |aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete | DELETE /aiagent/ops/department/{departmentId}/agent/{agentId}/tools/{toolId} | Delete a tool| |aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet | GET /aiagent/ops/department/{departmentId}/agent/{agentId}/tools/{toolId} | Get a tool| |aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut | PUT /aiagent/ops/department/{departmentId}/agent/{agentId}/tools/{toolId} | Update a tool| |createAgent | POST /aiagent/ops/department/{departmentId}/agent | Create Agent| |createDirectory | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory | Create directory| |deleteAgent | DELETE /aiagent/ops/department/{departmentId}/agent/{agentId} | Delete Agent| |deleteAiagentCrawlFilesAgentIdDirectoryId | DELETE /aiagent/ingestion/parse/files/department/{departmentId}/agent/{agentId}/directory/{directoryId} | Delete Files after Crawl| |deleteAiagentCrawlUrlsAgentIdDirectoryId | DELETE /aiagent/ingestion/crawl/urls/department/{departmentId}/agent/{agentId}/directory/{directoryId} | Delete URLs after Crawl| |deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge/{kbId} | Remove eGain Knowledge Source| |deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/files/job/{jobId} | Cancel Upload Job| |deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/urls/job/{jobId} | Cancel Upload Job| |deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Delete Summary Intent| |deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Delete files in bulk| |deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Delete URLs in bulk| |deleteDirectory | DELETE /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Delete directory and its contents| |getAgent | GET /aiagent/ops/department/{departmentId}/agent/{agentId} | Get Agent| |getAgents | GET /aiagent/ops/department/{departmentId}/agent | Get Agents| |getAiagentAdminAnalyticsAgents | GET /aiagent/superadmin/analytics/tenants | Get global tenant analytics| |getAiagentAdminAnalyticsAgentsAdmin | GET /aiagent/superadmin/analytics/agents | Get Agents| |getAiagentAdminAnalyticsConversations | GET /aiagent/superadmin/analytics/conversations | GET global conversations counts| |getAiagentAgentAgentId | GET /aiagent/details/agent/{agentId} | Get AI agent details needed for chat| |getAiagentAgentAgentIdAnalyticsConversations | GET /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/overview | Get conversations analytics| |getAiagentAgentAgentIdAnalyticsConversationsDaily | GET /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/daily | Get daily conversations count| |getAiagentAgentAgentIdAnalyticsConversationsHeatmap | GET /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/heatmap | GET heatmap| |getAiagentAgentAgentIdAnalyticsConversationsIntent | GET /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/intents | Get conversations by intent| |getAiagentAgentAgentIdBranding | GET /aiagent/details/department/{departmentId}/agent/{agentId}/branding | Get branding details of AI Agent| |getAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Get Directory| |getAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryIdStatus | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId}/status | Get directory status| |getAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Get file| |getAiagentDepartmentDepartmentIdAgentAgentIdEscalation | GET /aiagent/details/department/{departmentId}/agent/{agentId}/escalation | GET escalation options| |getAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Get summary intent| |getAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Get Current eGain Knowledge Source| |getConversation | GET /aiagent/details/department/{departmentId}/agent/{agentId}/conversations/sessions/{sessionId} | Get conversation| |getConversationSessions | GET /aiagent/details/department/{departmentId}/agent/{agentId}/conversations/sessions | Get conversation sessions| |getDirectories | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory | Get all directories| |getFiles | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Get files| |getSummaryintents | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary | Get all summary intents| |getUploadDetailsFiles | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/files/job/{jobId} | Retrieve the status of file upload| |getUploadDetailsUrls | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/urls/job/{jobId} | Retrieve the crawl status of url| |getUrls | GET /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Get URLs| |oldAddIntents | POST /aiagent/department/{departmentId}/agent/{agentId}/intentsummary | Add summary intents| |oldCreateAgent | POST /aiagent/department/{departmentId}/agent | Create Agent| |oldCreateDirectory | POST /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory | Create directory| |oldDeleteAgent | DELETE /aiagent/department/{departmentId}/agent/{agentId} | Delete Agent| |oldDeleteAiagentCrawlFilesAgentIdDirectoryId | DELETE /aiagent/crawl/files/{agentId}/{directoryId} | Delete File after Crawl| |oldDeleteAiagentCrawlUrlsAgentIdDirectoryId | DELETE /aiagent/crawl/urls/{agentId}/{directoryId} | Delete URL after Crawl| |oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId | DELETE /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge/{kbId} | Remove eGain Knowledge Source| |oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileid | DELETE /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Remove file| |oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUploadsJobId | DELETE /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/uploads/{jobId} | Cancel Upload Job| |oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsUrlId | DELETE /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Remove URL| |oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdIntentIntentId | DELETE /aiagent/department/{departmentId}/agent/{agentId}/intent/{intentId} | Delete Intent| |oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId | DELETE /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Delete Summary Intent| |oldDeleteAiagentTenantTenantId | DELETE /aiagent/tenant/{tenantId} | Delete Tenant| |oldDeleteDirectory | DELETE /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Delete directory and its contents| |oldGetAgent | GET /aiagent/department/{departmentId}/agent/{agentId} | Get Agent| |oldGetAgents | GET /aiagent/department/{departmentId}/agent | Get Agents| |oldGetAiagentAgentAgentId | GET /aiagent/agent/{agentId} | Get AI agent details needed for chat| |oldGetAiagentAgentAgentIdAnalyticsConversations | GET /aiagent/agent/{agentId}/analytics/conversations/overview | Get conversations analytics| |oldGetAiagentAgentAgentIdAnalyticsConversationsDaily | GET /aiagent/agent/{agentId}/analytics/conversations/daily | Get daily conversations count| |oldGetAiagentAgentAgentIdAnalyticsConversationsHeatmap | GET /aiagent/agent/{agentId}/analytics/conversations/heatmap | GET heatmap| |oldGetAiagentAgentAgentIdAnalyticsConversationsIntent | GET /aiagent/agent/{agentId}/analytics/conversations/intents | Get conversations by intent| |oldGetAiagentAgentAgentIdBranding | GET /aiagent/agent/{agentId}/branding | Get branding details of AI Agent| |oldGetAiagentCrawlFilesAgentIdDirectoryId | GET /aiagent/crawl/files/{agentId}/{directoryId} | GET Files Info| |oldGetAiagentCrawlUrlsAgentIdDirectoryId | GET /aiagent/crawl/urls/{agentId}/{directoryId} | GET URLs Info| |oldGetAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId | GET /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Get Directory| |oldGetAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId | GET /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Get file| |oldGetAiagentDepartmentDepartmentIdAgentAgentIdEscalation | GET /aiagent/department/{departmentId}/agent/{agentId}/escalation | GET escalation options| |oldGetAiagentDepartmentDepartmentIdAgentAgentIdIntentIntentId | GET /aiagent/department/{departmentId}/agent/{agentId}/intent/{intentId} | Get Intent| |oldGetAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId | GET /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Get summary intent| |oldGetAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge | GET /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Get Current eGain Knowledge Source| |oldGetAiagentPortalPortalIdAgent | GET /aiagent/portal/{portalId}/agent | Get Agents Info with Portals| |oldGetAiagentTenantTenantId | GET /aiagent/tenant/{tenantId} | Get SKUs| |oldGetConversation | GET /aiagent/department/{departmentId}/agent/{agentId}/conversations/sessions/{sessionId} | Get conversation| |oldGetConversationSessions | GET /aiagent/department/{departmentId}/agent/{agentId}/conversations/sessions | Get conversation sessions| |oldGetDirectories | GET /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory | Get all directories| |oldGetFiles | GET /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Get files| |oldGetIntents | GET /aiagent/department/{departmentId}/agent/{agentId}/intent | Get intents| |oldGetSummaryintents | GET /aiagent/department/{departmentId}/agent/{agentId}/intentsummary | Get all summary intents| |oldGetUploadDetails | GET /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/uploads/{jobId} | Get Upload| |oldGetUploadStatus | GET /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/uploadstatus | Get Upload Status| |oldGetUrls | GET /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Get URLs| |oldPostAiagentAgentAgentIdAnalytics | POST /aiagent/agent/{agentId}/analytics/events | POST events| |oldPostAiagentAgentAgentIdBranding | POST /aiagent/agent/{agentId}/branding | Save AI Agent Branding| |oldPostAiagentChatAgentassistTenantIdDepartmentIdSessionId | POST /aiagent/chat/agentassist/{tenantId}/{departmentId}/{interactionId} | Intent and search query| |oldPostAiagentCrawlFiles | POST /aiagent/crawl/files/{agentId}/{directoryId} | Files Info in progress| |oldPostAiagentCrawlUrls | POST /aiagent/crawl/urls/{agentId}/{directoryId} | URLs Info in progress| |oldPostAiagentDepartmentDepartmentIdAgentAgentIdEscalation | POST /aiagent/department/{departmentId}/agent/{agentId}/escalation | Update escalation options| |oldPostAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge | POST /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Create eGain Knowledge Source| |oldPostAiagentTenant | POST /aiagent/tenant | Create Tenant with SKUs| |oldPutAiagentAgentAgentIdBranding | PUT /aiagent/agent/{agentId}/branding | Update branding details| |oldPutAiagentDepartmentDepartmentIdAgentAgentId | PUT /aiagent/department/{departmentId}/agent/{agentId} | Update AI Agent| |oldPutAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId | PUT /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Update Directory| |oldPutAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledge | PUT /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Update eGain Knowledge Source| |oldPutAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId | PUT /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Update file| |oldPutAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsUrlId | PUT /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Update URL| |oldPutAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId | PUT /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Update Summary Intent| |oldPutAiagentTenantTenantId | PUT /aiagent/tenant/{tenantId} | Update SKUs| |oldRegenerateSummaryintents | POST /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/regenerate | Regenerate Summary Intents| |oldSyncSpecificUrl | POST /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Sync URL| |oldSyncUrls | POST /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/sync | Sync URLs| |oldUploadFiles | POST /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Upload files| |oldUploadUrls | POST /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Upload URLs| |postAiagentAgentAgentIdBranding | POST /aiagent/details/department/{departmentId}/agent/{agentId}/branding | Save AI Agent Branding| |postAiagentDepartmentDepartmentIdAgentAgentIdEscalation | POST /aiagent/details/department/{departmentId}/agent/{agentId}/escalation | Update escalation options| |postAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Connect eGain Knowledge Source| |postRegisterCallback | POST /aiagent/chat/callback | register callback| |putAiagentAgentAgentIdBranding | PUT /aiagent/details/department/{departmentId}/agent/{agentId}/branding | Update branding details| |putAiagentDepartmentDepartmentIdAgentAgentId | PUT /aiagent/ops/department/{departmentId}/agent/{agentId} | Update AI Agent| |putAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId | PUT /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Update Directory| |putAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledge | PUT /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Update eGain Knowledge Source| |putAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId | PUT /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Update file| |putAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsUrlId | PUT /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Update URL| |putAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId | PUT /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Update Summary Intent| |regenerateSummaryintents | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/regenerate | Regenerate Summary Intents| |syncSpecificUrl | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Sync URL| |syncUrls | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/sync | Sync URLs| |uploadFiles | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Upload files| |uploadUrls | POST /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Crawl URLs|

addIntents

addIntents(addIntentsRequest)

Add summary intents to a specific AI Agent.

Example

import {
    AiagentApi,
    Configuration,
    AddIntentsRequest
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let departmentId: string; // (default to undefined)
let addIntentsRequest: AddIntentsRequest; //

const { status, data } = await apiInstance.addIntents(
    agentId,
    departmentId,
    addIntentsRequest
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | addIntentsRequest | AddIntentsRequest| | | | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | departmentId | [string] | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |201 | Summary intents added successfully | * Location - Location of 'AI Agent' where the summary intents got regenerated | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |406 | Invalid 'Accept-Language' | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentChatAgentAgentIdTranscriptSummaryPost

AiagentChatAgentAgentIdTranscriptSummaryPost200Response aiagentChatAgentAgentIdTranscriptSummaryPost(aiagentChatAgentAgentIdTranscriptSummaryPostRequest)

Example

import {
    AiagentApi,
    Configuration,
    AiagentChatAgentAgentIdTranscriptSummaryPostRequest
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: string; // (default to undefined)
let aiagentChatAgentAgentIdTranscriptSummaryPostRequest: AiagentChatAgentAgentIdTranscriptSummaryPostRequest; //

const { status, data } = await apiInstance.aiagentChatAgentAgentIdTranscriptSummaryPost(
    agentId,
    aiagentChatAgentAgentIdTranscriptSummaryPostRequest
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | aiagentChatAgentAgentIdTranscriptSummaryPostRequest | AiagentChatAgentAgentIdTranscriptSummaryPostRequest| | | | agentId | [string] | | defaults to undefined|

Return type

AiagentChatAgentAgentIdTranscriptSummaryPost200Response

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |200 | Success | - | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete

MessageResponse aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete()

Deletes all tools associated with a specific agent.

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: string; //The unique identifier of the department. (default to undefined)
let agentId: string; //The unique identifier of the agent. (default to undefined)

const { status, data } = await apiInstance.aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete(
    departmentId,
    agentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | departmentId | [string] | The unique identifier of the department. | defaults to undefined| | agentId | [string] | The unique identifier of the agent. | defaults to undefined|

Return type

MessageResponse

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |200 | All tools were deleted successfully. | - | |404 | Not found | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet

GetToolsResponse aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet()

Retrieves a list of all tools associated with a specific agent.

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: string; //The unique identifier of the department. (default to undefined)
let agentId: string; //The unique identifier of the agent. (default to undefined)

const { status, data } = await apiInstance.aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet(
    departmentId,
    agentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | departmentId | [string] | The unique identifier of the department. | defaults to undefined| | agentId | [string] | The unique identifier of the agent. | defaults to undefined|

Return type

GetToolsResponse

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |200 | A list of tools was retrieved successfully. | - | |404 | Not found | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost

Tool aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost(createToolRequest)

Create a new tool for a specific AI agent.

Example

import {
    AiagentApi,
    Configuration,
    CreateToolRequest
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: string; //The unique identifier of the department. (default to undefined)
let agentId: string; //The unique identifier of the agent. (default to undefined)
let createToolRequest: CreateToolRequest; //Tool object that needs to be added to the agent.

const { status, data } = await apiInstance.aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost(
    departmentId,
    agentId,
    createToolRequest
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | createToolRequest | CreateToolRequest| Tool object that needs to be added to the agent. | | | departmentId | [string] | The unique identifier of the department. | defaults to undefined| | agentId | [string] | The unique identifier of the agent. | defaults to undefined|

Return type

Tool

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |201 | Tool created successfully. | - | |400 | Bad Request | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete

MessageResponse aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete()

Deletes a specific tool by its ID.

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: string; //The unique identifier of the department. (default to undefined)
let agentId: string; //The unique identifier of the agent. (default to undefined)
let toolId: string; //The unique identifier of the tool. (default to undefined)

const { status, data } = await apiInstance.aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete(
    departmentId,
    agentId,
    toolId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | departmentId | [string] | The unique identifier of the department. | defaults to undefined| | agentId | [string] | The unique identifier of the agent. | defaults to undefined| | toolId | [string] | The unique identifier of the tool. | defaults to undefined|

Return type

MessageResponse

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |200 | Tool deleted successfully. | - | |404 | Not found | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet

Tool aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet()

Retrieves a specific tool by its ID.

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: string; //The unique identifier of the department. (default to undefined)
let agentId: string; //The unique identifier of the agent. (default to undefined)
let toolId: string; //The unique identifier of the tool. (default to undefined)

const { status, data } = await apiInstance.aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet(
    departmentId,
    agentId,
    toolId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | departmentId | [string] | The unique identifier of the department. | defaults to undefined| | agentId | [string] | The unique identifier of the agent. | defaults to undefined| | toolId | [string] | The unique identifier of the tool. | defaults to undefined|

Return type

Tool

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |200 | Tool retrieved successfully. | - | |404 | Not found | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut

Tool aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut(updateToolRequest)

Updates an existing tool for a specific agent by its ID.

Example

import {
    AiagentApi,
    Configuration,
    UpdateToolRequest
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: string; //The unique identifier of the department. (default to undefined)
let agentId: string; //The unique identifier of the agent. (default to undefined)
let toolId: string; //The unique identifier of the tool. (default to undefined)
let updateToolRequest: UpdateToolRequest; //Tool object with updated fields.

const { status, data } = await apiInstance.aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut(
    departmentId,
    agentId,
    toolId,
    updateToolRequest
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | updateToolRequest | UpdateToolRequest| Tool object with updated fields. | | | departmentId | [string] | The unique identifier of the department. | defaults to undefined| | agentId | [string] | The unique identifier of the agent. | defaults to undefined| | toolId | [string] | The unique identifier of the tool. | defaults to undefined|

Return type

Tool

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |200 | Tool updated successfully. | - | |400 | Bad Request | - | |404 | Not found | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createAgent

createAgent()

Create AI Agent within a department.

Example

import {
    AiagentApi,
    Configuration,
    CreateAgentRequest
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: number; //Unique identifier of a department (default to undefined)
let createAgentRequest: CreateAgentRequest; // (optional)

const { status, data } = await apiInstance.createAgent(
    departmentId,
    createAgentRequest
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | createAgentRequest | CreateAgentRequest| | | | departmentId | [number] | Unique identifier of a department | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |201 | Agent created successfully | * Location - Location of the newly created agent | |400 | Bad Request | - | |403 | Forbidden | - | |404 | Not Found | - | |409 | Conflict | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createDirectory

createDirectory()

Create a directory in a specific AI Agent within a department.

Example

import {
    AiagentApi,
    Configuration,
    CreateDirectoryRequest
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let departmentId: string; // (default to undefined)
let createDirectoryRequest: CreateDirectoryRequest; //Please note that if the existing directory is already URL, we cannot update that value, we can only change the name of the description of the directory (optional)

const { status, data } = await apiInstance.createDirectory(
    agentId,
    departmentId,
    createDirectoryRequest
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | createDirectoryRequest | CreateDirectoryRequest| Please note that if the existing directory is already URL, we cannot update that value, we can only change the name of the description of the directory | | | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | departmentId | [string] | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |201 | Directory created successfully | * Location - Location of the directory | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |404 | Not found | - | |406 | Invalid 'Accept-Language' | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAgent

deleteAgent()

Delete specific AI Agent in a department.

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: number; //Unique identifier of a department (default to undefined)
let agentId: number; //Unique Identifier of AI agent (default to undefined)

const { status, data } = await apiInstance.deleteAgent(
    departmentId,
    agentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | departmentId | [number] | Unique identifier of a department | defaults to undefined| | agentId | [number] | Unique Identifier of AI agent | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Agent deleted successfully | - | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |404 | Not found | - | |406 | Invalid 'Accept-Language' | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentCrawlFilesAgentIdDirectoryId

deleteAiagentCrawlFilesAgentIdDirectoryId()

Delete files after crawl and before training

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let departmentId: string; // (default to undefined)
let fileIds: Array<string>; // (default to undefined)

const { status, data } = await apiInstance.deleteAiagentCrawlFilesAgentIdDirectoryId(
    agentId,
    directoryId,
    departmentId,
    fileIds
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | departmentId | [string] | | defaults to undefined| | fileIds | Array<string> | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |202 | Accepted | - | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |404 | Not Found | - | |408 | Request Timeout | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentCrawlUrlsAgentIdDirectoryId

deleteAiagentCrawlUrlsAgentIdDirectoryId()

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let departmentId: string; // (default to undefined)
let urls: Array<string>; //URLs list to be deleted after crawl and before training (default to undefined)

const { status, data } = await apiInstance.deleteAiagentCrawlUrlsAgentIdDirectoryId(
    agentId,
    directoryId,
    departmentId,
    urls
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | departmentId | [string] | | defaults to undefined| | urls | Array<string> | URLs list to be deleted after crawl and before training | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |202 | Accepted | - | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |404 | Not Found | - | |408 | Request Timeout | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId

deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId()

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let kbId: string; //ID of eGain Knowledge Source (default to undefined)
let departmentId: string; // (default to undefined)

const { status, data } = await apiInstance.deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId(
    agentId,
    kbId,
    departmentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | kbId | [string] | ID of eGain Knowledge Source | defaults to undefined| | departmentId | [string] | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Removed eGain Knowledge Source | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId

deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId()

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: string; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let jobId: string; //Job task ID it can be either upload or sync (default to undefined)
let departmentId: string; // (default to undefined)

const { status, data } = await apiInstance.deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId(
    agentId,
    directoryId,
    jobId,
    departmentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [string] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | jobId | [string] | Job task ID it can be either upload or sync | defaults to undefined| | departmentId | [string] | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Upload Job deleted | * location - location of job |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId

deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId()

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: string; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let jobId: string; //Job task ID it can be either upload or sync (default to undefined)
let departmentId: string; // (default to undefined)

const { status, data } = await apiInstance.deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId(
    agentId,
    directoryId,
    jobId,
    departmentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [string] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | jobId | [string] | Job task ID it can be either upload or sync | defaults to undefined| | departmentId | [string] | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Upload Job deleted | * location - location of job |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId

deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId()

Delete specific summary intent

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let summaryIntentId: number; //ID of a summary intent (default to undefined)
let departmentId: string; // (default to undefined)

const { status, data } = await apiInstance.deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId(
    agentId,
    summaryIntentId,
    departmentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | summaryIntentId | [number] | ID of a summary intent | defaults to undefined| | departmentId | [string] | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Sucessfully deleted the summary intent | - | |400 | Bad Request | - | |401 | Unauthorized | - | |403 | Forbidden | - | |404 | Not found | - | |406 | Invalid &#39;Accept-Language&#39; | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles

deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles()

Delete files in bulk after training is done

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: string; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let departmentId: string; // (default to undefined)
let fileIds: Array<string>; //list of file IDs to be deleted (default to undefined)

const { status, data } = await apiInstance.deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles(
    agentId,
    directoryId,
    departmentId,
    fileIds
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [string] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | departmentId | [string] | | defaults to undefined| | fileIds | Array<string> | list of file IDs to be deleted | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |202 | Accepted | * Location - location of AI Agent |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls

deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls()

Delete URLs in bulk after training

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: string; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let departmentId: string; // (default to undefined)
let urlIds: Array<string>; // (default to undefined)

const { status, data } = await apiInstance.deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls(
    agentId,
    directoryId,
    departmentId,
    urlIds
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [string] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | departmentId | [string] | | defaults to undefined| | urlIds | Array<string> | | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Deleted | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteDirectory

deleteDirectory()

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let agentId: number; //Unique Identifier of AI agent (default to undefined)
let directoryId: string; //Unique identifier of a directory (default to undefined)
let departmentId: string; //ID of the department (default to undefined)

const { status, data } = await apiInstance.deleteDirectory(
    agentId,
    directoryId,
    departmentId
);

Parameters

|Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | agentId | [number] | Unique Identifier of AI agent | defaults to undefined| | directoryId | [string] | Unique identifier of a directory | defaults to undefined| | departmentId | [string] | ID of the department | defaults to undefined|

Return type

void (empty response body)

Authorization

oAuthAnonymousCustomer, oAuthCustomer, oAuthUser

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

| Status code | Description | Response headers | |-------------|-------------|------------------| |204 | Directory and its contents deleted successfully. | - | |400 | Bad Request | - | |401 | Unauthorized | - | |404 | Bad Request | - | |406 | Invalid &#39;Accept-Language&#39; | - | |500 | Internal Server Error | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAgent

Agent getAgent()

Get specific AI Agent in a department.

Example

import {
    AiagentApi,
    Configuration
} from '@ngreenberg/aiservices-sdk';

const configuration = new Configuration();
const apiInstance = new AiagentApi(configuration);

let departmentId: number; //Unique identifier of a department (default to undefined)
let agentId: number; //Unique Identifier of AI agent (default to undefined)

const { status, data } = await apiInstance.getAgent(
    departmentId,
    agentId
);

Parameters

|Name | Type | Description | Notes|