npm package: @ngreenberg/egain-aiservices-sdk
Description: OpenAPI client for @ngreenberg/aiservices-sdk
Author: OpenAPI-Generator Contributors
Latest version: 1.0.6

## @ngreenberg/aiservices-sdk

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

This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/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](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))

### 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/aiservices-sdk@1.0.0 --save
```

_unPublished (not recommended):_

```
npm install PATH_TO_GENERATED_PACKAGE --save
```

### Documentation for API Endpoints


<!-- Begin AiagentApi.md -->

# AiagentApi

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addIntents**](#addintents) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary | Add summary intents|
|[**aiagentChatAgentAgentIdTranscriptSummaryPost**](#aiagentchatagentagentidtranscriptsummarypost) | **POST** /aiagent/chat/agent/{agentId}/transcript/summary | Get summary for a given conversation transcript|
|[**aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete**](#aiagentopsdepartmentdepartmentidagentagentidtoolsdelete) | **DELETE** /aiagent/ops/department/{departmentId}/agent/{agentId}/tools | Delete all tools|
|[**aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet**](#aiagentopsdepartmentdepartmentidagentagentidtoolsget) | **GET** /aiagent/ops/department/{departmentId}/agent/{agentId}/tools | Get all tools|
|[**aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost**](#aiagentopsdepartmentdepartmentidagentagentidtoolspost) | **POST** /aiagent/ops/department/{departmentId}/agent/{agentId}/tools | Create a tool|
|[**aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete**](#aiagentopsdepartmentdepartmentidagentagentidtoolstooliddelete) | **DELETE** /aiagent/ops/department/{departmentId}/agent/{agentId}/tools/{toolId} | Delete a tool|
|[**aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet**](#aiagentopsdepartmentdepartmentidagentagentidtoolstoolidget) | **GET** /aiagent/ops/department/{departmentId}/agent/{agentId}/tools/{toolId} | Get a tool|
|[**aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut**](#aiagentopsdepartmentdepartmentidagentagentidtoolstoolidput) | **PUT** /aiagent/ops/department/{departmentId}/agent/{agentId}/tools/{toolId} | Update a tool|
|[**createAgent**](#createagent) | **POST** /aiagent/ops/department/{departmentId}/agent | Create Agent|
|[**createDirectory**](#createdirectory) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory | Create directory|
|[**deleteAgent**](#deleteagent) | **DELETE** /aiagent/ops/department/{departmentId}/agent/{agentId} | Delete Agent|
|[**deleteAiagentCrawlFilesAgentIdDirectoryId**](#deleteaiagentcrawlfilesagentiddirectoryid) | **DELETE** /aiagent/ingestion/parse/files/department/{departmentId}/agent/{agentId}/directory/{directoryId} | Delete Files after Crawl|
|[**deleteAiagentCrawlUrlsAgentIdDirectoryId**](#deleteaiagentcrawlurlsagentiddirectoryid) | **DELETE** /aiagent/ingestion/crawl/urls/department/{departmentId}/agent/{agentId}/directory/{directoryId} | Delete URLs after Crawl|
|[**deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId**](#deleteaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledgekbid) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge/{kbId} | Remove eGain Knowledge Source|
|[**deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId**](#deleteaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefilesjobid) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/files/job/{jobId} | Cancel Upload Job|
|[**deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId**](#deleteaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourceurlsjobid) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/urls/job/{jobId} | Cancel Upload Job|
|[**deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**](#deleteaiagentdepartmentdepartmentidagentagentidintentsummarysummaryintentid) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Delete Summary Intent|
|[**deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles**](#deleteaiagentingestiondepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefiles) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Delete files in bulk|
|[**deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls**](#deleteaiagentingestiondepartmentdepartmentidagentagentiddirectorydirectoryiddatasourceurls) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Delete URLs in bulk|
|[**deleteDirectory**](#deletedirectory) | **DELETE** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Delete directory and its contents|
|[**getAgent**](#getagent) | **GET** /aiagent/ops/department/{departmentId}/agent/{agentId} | Get Agent|
|[**getAgents**](#getagents) | **GET** /aiagent/ops/department/{departmentId}/agent | Get Agents|
|[**getAiagentAdminAnalyticsAgents**](#getaiagentadminanalyticsagents) | **GET** /aiagent/superadmin/analytics/tenants | Get global tenant analytics|
|[**getAiagentAdminAnalyticsAgentsAdmin**](#getaiagentadminanalyticsagentsadmin) | **GET** /aiagent/superadmin/analytics/agents | Get Agents|
|[**getAiagentAdminAnalyticsConversations**](#getaiagentadminanalyticsconversations) | **GET** /aiagent/superadmin/analytics/conversations | GET global conversations counts|
|[**getAiagentAgentAgentId**](#getaiagentagentagentid) | **GET** /aiagent/details/agent/{agentId} | Get AI agent details needed for chat|
|[**getAiagentAgentAgentIdAnalyticsConversations**](#getaiagentagentagentidanalyticsconversations) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/overview | Get conversations analytics|
|[**getAiagentAgentAgentIdAnalyticsConversationsDaily**](#getaiagentagentagentidanalyticsconversationsdaily) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/daily | Get daily conversations count|
|[**getAiagentAgentAgentIdAnalyticsConversationsHeatmap**](#getaiagentagentagentidanalyticsconversationsheatmap) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/heatmap | GET heatmap|
|[**getAiagentAgentAgentIdAnalyticsConversationsIntent**](#getaiagentagentagentidanalyticsconversationsintent) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/analytics/conversations/intents | Get conversations by intent|
|[**getAiagentAgentAgentIdBranding**](#getaiagentagentagentidbranding) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/branding | Get branding details of AI Agent|
|[**getAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId**](#getaiagentdepartmentdepartmentidagentagentiddatasourcedirectorydirectoryid) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Get Directory|
|[**getAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryIdStatus**](#getaiagentdepartmentdepartmentidagentagentiddatasourcedirectorydirectoryidstatus) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId}/status | Get directory status|
|[**getAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId**](#getaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefilesfileid) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Get file|
|[**getAiagentDepartmentDepartmentIdAgentAgentIdEscalation**](#getaiagentdepartmentdepartmentidagentagentidescalation) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/escalation | GET escalation options|
|[**getAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**](#getaiagentdepartmentdepartmentidagentagentidintentsummarysummaryintentid) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Get summary intent|
|[**getAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge**](#getaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledge) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Get Current eGain Knowledge Source|
|[**getConversation**](#getconversation) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/conversations/sessions/{sessionId} | Get conversation|
|[**getConversationSessions**](#getconversationsessions) | **GET** /aiagent/details/department/{departmentId}/agent/{agentId}/conversations/sessions | Get conversation sessions|
|[**getDirectories**](#getdirectories) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory | Get all directories|
|[**getFiles**](#getfiles) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Get files|
|[**getSummaryintents**](#getsummaryintents) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary | Get all summary intents|
|[**getUploadDetailsFiles**](#getuploaddetailsfiles) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/files/job/{jobId} | Retrieve the status of file upload|
|[**getUploadDetailsUrls**](#getuploaddetailsurls) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/urls/job/{jobId} | Retrieve the crawl status of url|
|[**getUrls**](#geturls) | **GET** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Get URLs|
|[**oldAddIntents**](#oldaddintents) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/intentsummary | Add summary intents|
|[**oldCreateAgent**](#oldcreateagent) | **POST** /aiagent/department/{departmentId}/agent | Create Agent|
|[**oldCreateDirectory**](#oldcreatedirectory) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory | Create directory|
|[**oldDeleteAgent**](#olddeleteagent) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId} | Delete Agent|
|[**oldDeleteAiagentCrawlFilesAgentIdDirectoryId**](#olddeleteaiagentcrawlfilesagentiddirectoryid) | **DELETE** /aiagent/crawl/files/{agentId}/{directoryId} | Delete File after Crawl|
|[**oldDeleteAiagentCrawlUrlsAgentIdDirectoryId**](#olddeleteaiagentcrawlurlsagentiddirectoryid) | **DELETE** /aiagent/crawl/urls/{agentId}/{directoryId} | Delete URL after Crawl|
|[**oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId**](#olddeleteaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledgekbid) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge/{kbId} | Remove eGain Knowledge Source|
|[**oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileid**](#olddeleteaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefilesfileid) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Remove file|
|[**oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUploadsJobId**](#olddeleteaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourceuploadsjobid) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/uploads/{jobId} | Cancel Upload Job|
|[**oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsUrlId**](#olddeleteaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourceurlsurlid) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Remove URL|
|[**oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdIntentIntentId**](#olddeleteaiagentdepartmentdepartmentidagentagentidintentintentid) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/intent/{intentId} | Delete Intent|
|[**oldDeleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**](#olddeleteaiagentdepartmentdepartmentidagentagentidintentsummarysummaryintentid) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Delete Summary Intent|
|[**oldDeleteAiagentTenantTenantId**](#olddeleteaiagenttenanttenantid) | **DELETE** /aiagent/tenant/{tenantId} | Delete Tenant|
|[**oldDeleteDirectory**](#olddeletedirectory) | **DELETE** /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Delete directory and its contents|
|[**oldGetAgent**](#oldgetagent) | **GET** /aiagent/department/{departmentId}/agent/{agentId} | Get Agent|
|[**oldGetAgents**](#oldgetagents) | **GET** /aiagent/department/{departmentId}/agent | Get Agents|
|[**oldGetAiagentAgentAgentId**](#oldgetaiagentagentagentid) | **GET** /aiagent/agent/{agentId} | Get AI agent details needed for chat|
|[**oldGetAiagentAgentAgentIdAnalyticsConversations**](#oldgetaiagentagentagentidanalyticsconversations) | **GET** /aiagent/agent/{agentId}/analytics/conversations/overview | Get conversations analytics|
|[**oldGetAiagentAgentAgentIdAnalyticsConversationsDaily**](#oldgetaiagentagentagentidanalyticsconversationsdaily) | **GET** /aiagent/agent/{agentId}/analytics/conversations/daily | Get daily conversations count|
|[**oldGetAiagentAgentAgentIdAnalyticsConversationsHeatmap**](#oldgetaiagentagentagentidanalyticsconversationsheatmap) | **GET** /aiagent/agent/{agentId}/analytics/conversations/heatmap | GET heatmap|
|[**oldGetAiagentAgentAgentIdAnalyticsConversationsIntent**](#oldgetaiagentagentagentidanalyticsconversationsintent) | **GET** /aiagent/agent/{agentId}/analytics/conversations/intents | Get conversations by intent|
|[**oldGetAiagentAgentAgentIdBranding**](#oldgetaiagentagentagentidbranding) | **GET** /aiagent/agent/{agentId}/branding | Get branding details of AI Agent|
|[**oldGetAiagentCrawlFilesAgentIdDirectoryId**](#oldgetaiagentcrawlfilesagentiddirectoryid) | **GET** /aiagent/crawl/files/{agentId}/{directoryId} | GET Files Info|
|[**oldGetAiagentCrawlUrlsAgentIdDirectoryId**](#oldgetaiagentcrawlurlsagentiddirectoryid) | **GET** /aiagent/crawl/urls/{agentId}/{directoryId} | GET URLs Info|
|[**oldGetAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId**](#oldgetaiagentdepartmentdepartmentidagentagentiddatasourcedirectorydirectoryid) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Get Directory|
|[**oldGetAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId**](#oldgetaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefilesfileid) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Get file|
|[**oldGetAiagentDepartmentDepartmentIdAgentAgentIdEscalation**](#oldgetaiagentdepartmentdepartmentidagentagentidescalation) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/escalation | GET escalation options|
|[**oldGetAiagentDepartmentDepartmentIdAgentAgentIdIntentIntentId**](#oldgetaiagentdepartmentdepartmentidagentagentidintentintentid) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/intent/{intentId} | Get Intent|
|[**oldGetAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**](#oldgetaiagentdepartmentdepartmentidagentagentidintentsummarysummaryintentid) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Get summary intent|
|[**oldGetAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge**](#oldgetaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledge) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Get Current eGain Knowledge Source|
|[**oldGetAiagentPortalPortalIdAgent**](#oldgetaiagentportalportalidagent) | **GET** /aiagent/portal/{portalId}/agent | Get Agents Info with Portals|
|[**oldGetAiagentTenantTenantId**](#oldgetaiagenttenanttenantid) | **GET** /aiagent/tenant/{tenantId} | Get SKUs|
|[**oldGetConversation**](#oldgetconversation) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/conversations/sessions/{sessionId} | Get conversation|
|[**oldGetConversationSessions**](#oldgetconversationsessions) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/conversations/sessions | Get conversation sessions|
|[**oldGetDirectories**](#oldgetdirectories) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory | Get all directories|
|[**oldGetFiles**](#oldgetfiles) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Get files|
|[**oldGetIntents**](#oldgetintents) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/intent | Get intents|
|[**oldGetSummaryintents**](#oldgetsummaryintents) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/intentsummary | Get all summary intents|
|[**oldGetUploadDetails**](#oldgetuploaddetails) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/uploads/{jobId} | Get Upload|
|[**oldGetUploadStatus**](#oldgetuploadstatus) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/uploadstatus | Get Upload Status|
|[**oldGetUrls**](#oldgeturls) | **GET** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Get URLs|
|[**oldPostAiagentAgentAgentIdAnalytics**](#oldpostaiagentagentagentidanalytics) | **POST** /aiagent/agent/{agentId}/analytics/events | POST events|
|[**oldPostAiagentAgentAgentIdBranding**](#oldpostaiagentagentagentidbranding) | **POST** /aiagent/agent/{agentId}/branding | Save AI Agent Branding|
|[**oldPostAiagentChatAgentassistTenantIdDepartmentIdSessionId**](#oldpostaiagentchatagentassisttenantiddepartmentidsessionid) | **POST** /aiagent/chat/agentassist/{tenantId}/{departmentId}/{interactionId} | Intent and search query|
|[**oldPostAiagentCrawlFiles**](#oldpostaiagentcrawlfiles) | **POST** /aiagent/crawl/files/{agentId}/{directoryId} | Files Info in progress|
|[**oldPostAiagentCrawlUrls**](#oldpostaiagentcrawlurls) | **POST** /aiagent/crawl/urls/{agentId}/{directoryId} | URLs Info in progress|
|[**oldPostAiagentDepartmentDepartmentIdAgentAgentIdEscalation**](#oldpostaiagentdepartmentdepartmentidagentagentidescalation) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/escalation | Update escalation options|
|[**oldPostAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge**](#oldpostaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledge) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Create eGain Knowledge Source|
|[**oldPostAiagentTenant**](#oldpostaiagenttenant) | **POST** /aiagent/tenant | Create Tenant with SKUs|
|[**oldPutAiagentAgentAgentIdBranding**](#oldputaiagentagentagentidbranding) | **PUT** /aiagent/agent/{agentId}/branding | Update branding details|
|[**oldPutAiagentDepartmentDepartmentIdAgentAgentId**](#oldputaiagentdepartmentdepartmentidagentagentid) | **PUT** /aiagent/department/{departmentId}/agent/{agentId} | Update AI Agent|
|[**oldPutAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId**](#oldputaiagentdepartmentdepartmentidagentagentiddatasourcedirectorydirectoryid) | **PUT** /aiagent/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Update Directory|
|[**oldPutAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledge**](#oldputaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledge) | **PUT** /aiagent/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Update eGain Knowledge Source|
|[**oldPutAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId**](#oldputaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefilesfileid) | **PUT** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Update file|
|[**oldPutAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsUrlId**](#oldputaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourceurlsurlid) | **PUT** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Update URL|
|[**oldPutAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**](#oldputaiagentdepartmentdepartmentidagentagentidintentsummarysummaryintentid) | **PUT** /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Update Summary Intent|
|[**oldPutAiagentTenantTenantId**](#oldputaiagenttenanttenantid) | **PUT** /aiagent/tenant/{tenantId} | Update SKUs|
|[**oldRegenerateSummaryintents**](#oldregeneratesummaryintents) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/intentsummary/regenerate | Regenerate Summary Intents|
|[**oldSyncSpecificUrl**](#oldsyncspecificurl) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Sync URL|
|[**oldSyncUrls**](#oldsyncurls) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/sync | Sync URLs|
|[**oldUploadFiles**](#olduploadfiles) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Upload files|
|[**oldUploadUrls**](#olduploadurls) | **POST** /aiagent/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls | Upload URLs|
|[**postAiagentAgentAgentIdBranding**](#postaiagentagentagentidbranding) | **POST** /aiagent/details/department/{departmentId}/agent/{agentId}/branding | Save AI Agent Branding|
|[**postAiagentDepartmentDepartmentIdAgentAgentIdEscalation**](#postaiagentdepartmentdepartmentidagentagentidescalation) | **POST** /aiagent/details/department/{departmentId}/agent/{agentId}/escalation | Update escalation options|
|[**postAiagentDepartmentDepartmentIdAgentAgentidDatasourceEgainknowledge**](#postaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledge) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Connect eGain Knowledge Source|
|[**postRegisterCallback**](#postregistercallback) | **POST** /aiagent/chat/callback | register callback|
|[**putAiagentAgentAgentIdBranding**](#putaiagentagentagentidbranding) | **PUT** /aiagent/details/department/{departmentId}/agent/{agentId}/branding | Update branding details|
|[**putAiagentDepartmentDepartmentIdAgentAgentId**](#putaiagentdepartmentdepartmentidagentagentid) | **PUT** /aiagent/ops/department/{departmentId}/agent/{agentId} | Update AI Agent|
|[**putAiagentDepartmentDepartmentIdAgentAgentIdDatasourceDirectoryDirectoryId**](#putaiagentdepartmentdepartmentidagentagentiddatasourcedirectorydirectoryid) | **PUT** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/directory/{directoryId} | Update Directory|
|[**putAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledge**](#putaiagentdepartmentdepartmentidagentagentiddatasourceegainknowledge) | **PUT** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/datasource/egainknowledge | Update eGain Knowledge Source|
|[**putAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesFileId**](#putaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourcefilesfileid) | **PUT** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files/{fileId} | Update file|
|[**putAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsUrlId**](#putaiagentdepartmentdepartmentidagentagentiddirectorydirectoryiddatasourceurlsurlid) | **PUT** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Update URL|
|[**putAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**](#putaiagentdepartmentdepartmentidagentagentidintentsummarysummaryintentid) | **PUT** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/{summaryIntentId} | Update Summary Intent|
|[**regenerateSummaryintents**](#regeneratesummaryintents) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/intentsummary/regenerate | Regenerate Summary Intents|
|[**syncSpecificUrl**](#syncspecificurl) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/{urlId} | Sync URL|
|[**syncUrls**](#syncurls) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/urls/sync | Sync URLs|
|[**uploadFiles**](#uploadfiles) | **POST** /aiagent/ingestion/department/{departmentId}/agent/{agentId}/directory/{directoryId}/datasource/files | Upload files|
|[**uploadUrls**](#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

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 \&#39;AI Agent\&#39; where the summary intents got regenerated <br>  |
|**400** | Bad Request |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**406** | Invalid \&#39;Accept-Language\&#39; |  -  |
|**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentChatAgentAgentIdTranscriptSummaryPost**
> AiagentChatAgentAgentIdTranscriptSummaryPost200Response aiagentChatAgentAgentIdTranscriptSummaryPost(aiagentChatAgentAgentIdTranscriptSummaryPostRequest)


### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete**
> MessageResponse aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsDelete()

Deletes all tools associated with a specific agent.

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet**
> GetToolsResponse aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsGet()

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

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost**
> Tool aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsPost(createToolRequest)

Create a new tool for a specific AI agent.

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete**
> MessageResponse aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdDelete()

Deletes a specific tool by its ID.

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet**
> Tool aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdGet()

Retrieves a specific tool by its ID.

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut**
> Tool aiagentOpsDepartmentDepartmentIdAgentAgentIdToolsToolIdPut(updateToolRequest)

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

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createAgent**
> createAgent()

Create AI Agent within a department.

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 <br>  |
|**400** | Bad Request |  -  |
|**403** | Forbidden |  -  |
|**404** | Not Found |  -  |
|**409** | Conflict |  -  |
|**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createDirectory**
> createDirectory()

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

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 <br>  |
|**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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAgent**
> deleteAgent()

Delete specific AI Agent in a department.

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 \&#39;Accept-Language\&#39; |  -  |
|**500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentCrawlFilesAgentIdDirectoryId**
> deleteAiagentCrawlFilesAgentIdDirectoryId()

Delete files after crawl and before training

### Example

```typescript
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&lt;string&gt;** |  | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthAnonymousCustomer](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentCrawlUrlsAgentIdDirectoryId**
> deleteAiagentCrawlUrlsAgentIdDirectoryId()


### Example

```typescript
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&lt;string&gt;** | URLs list to be deleted after crawl and before training | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthAnonymousCustomer](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId**
> deleteAiagentDepartmentDepartmentIdAgentAgentIdDatasourceEgainknowledgeKbId()


### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId**
> deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFilesJobId()


### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 <br>  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId**
> deleteAiagentDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrlsJobId()


### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 <br>  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId**
> deleteAiagentDepartmentDepartmentIdAgentAgentIdIntentsummarySummaryIntentId()

Delete specific summary intent

### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles**
> deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceFiles()

Delete files in bulk after training is done

### Example

```typescript
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&lt;string&gt;** | list of file IDs to be deleted | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthAnonymousCustomer](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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 <br>  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls**
> deleteAiagentIngestionDepartmentDepartmentIdAgentAgentIdDirectoryDirectoryIdDatasourceUrls()

Delete URLs in bulk after training

### Example

```typescript
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&lt;string&gt;** |  | defaults to undefined|


### Return type

void (empty response body)

### Authorization

[oAuthAnonymousCustomer](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteDirectory**
> deleteDirectory()


### Example

```typescript
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](../README.md#oAuthAnonymousCustomer), [oAuthCustomer](../README.md#oAuthCustomer), [oAuthUser](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getAgent**
> Agent getAgent()

Get specific AI Agent in a department.

### Example

```typescript
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|