Class default

Base client for the platform API Classes that extend PlatformBaseClient have intentins of only working in platform context

PlatformBaseClient

Param: client

The axios instance to use for the client

Example

// if sdk is used in the forge app that is running in the platform context
const utils = new ComponentUtils()
// this won't work outside of platform context because client needs authtorization to communicate with the API.

Hierarchy (View Summary)

default
- default

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Inherited from default.constructor
- Defined in v0.10/api/platformBaseClient.ts:24

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

addParticipant

addParticipant(
conversationUUID: string,
data: ParticipantAddPayload,
): Promise<AxiosResponse<any, any>>
Parameters
- conversationUUID: string
- data: ParticipantAddPayload
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/kortex.ts:142

archiveConversation

archiveConversation(uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:134

createAgent

createAgent(data: AgentCreatePayload): Promise<AxiosResponse<Agent, any>>
Parameters
- data: AgentCreatePayload
Returns Promise<AxiosResponse<Agent, any>>
- Defined in v0.10/api/kortex.ts:41

createConversation

createConversation(
data: ConversationCreatePayload,
): Promise<AxiosResponse<Conversation, any>>
Parameters
- data: ConversationCreatePayload
Returns Promise<AxiosResponse<Conversation, any>>
- Defined in v0.10/api/kortex.ts:114

createKnowledgeBase

createKnowledgeBase(
data: KnowledgeBaseCreatePayload,
): Promise<AxiosResponse<KnowledgeBase, any>>
Parameters
- data: KnowledgeBaseCreatePayload
Returns Promise<AxiosResponse<KnowledgeBase, any>>
- Defined in v0.10/api/kortex.ts:67

createUserAccess

createUserAccess(
data: UserAccessCreatePayload,
): Promise<AxiosResponse<UserAccess, any>>
Parameters
- data: UserAccessCreatePayload
Returns Promise<AxiosResponse<UserAccess, any>>
- Defined in v0.10/api/kortex.ts:179

deleteAgent

deleteAgent(uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:57

deleteConversation

deleteConversation(uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:130

deleteDocument

deleteDocument(kbUUID: string, uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- kbUUID: string
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:104

deleteKnowledgeBase

deleteKnowledgeBase(uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:83

deleteUserAccess

deleteUserAccess(uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:195

getAgent

getAgent(uuid: string): Promise<AxiosResponse<Agent, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<Agent, any>>
- Defined in v0.10/api/kortex.ts:49

getConversation

getConversation(uuid: string): Promise<AxiosResponse<Conversation, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<Conversation, any>>
- Defined in v0.10/api/kortex.ts:122

getDocument

getDocument(kbUUID: string, uuid: string): Promise<AxiosResponse<Document, any>>
Parameters
- kbUUID: string
- uuid: string
Returns Promise<AxiosResponse<Document, any>>
- Defined in v0.10/api/kortex.ts:100

getKnowledgeBase

getKnowledgeBase(uuid: string): Promise<AxiosResponse<KnowledgeBase, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<KnowledgeBase, any>>
- Defined in v0.10/api/kortex.ts:75

getMyAccess

getMyAccess(): Promise<AxiosResponse<MyAccess, any>>
Returns Promise<AxiosResponse<MyAccess, any>>
- Defined in v0.10/api/kortex.ts:207

getTier

getTier(): Promise<AxiosResponse<Tier, any>>
Returns Promise<AxiosResponse<Tier, any>>
- Defined in v0.10/api/kortex.ts:219

getUserAccess

getUserAccess(uuid: string): Promise<AxiosResponse<UserAccess, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<UserAccess, any>>
- Defined in v0.10/api/kortex.ts:187

getUserMonthlyUsage

getUserMonthlyUsage(
uuid: string,
params?: { month?: string },
): Promise<AxiosResponse<UserMonthlyUsage, any>>
Parameters
- uuid: string
- Optionalparams: { month?: string }
Returns Promise<AxiosResponse<UserMonthlyUsage, any>>
- Defined in v0.10/api/kortex.ts:199

getUserUsageBreakdown

getUserUsageBreakdown(
uuid: string,
): Promise<AxiosResponse<UserUsageBreakdown, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<UserUsageBreakdown, any>>
- Defined in v0.10/api/kortex.ts:203

injectMessage

injectMessage(
conversationUUID: string,
data: InjectMessagePayload,
): Promise<AxiosResponse<Message, any>>
Parameters
- conversationUUID: string
- data: InjectMessagePayload
Returns Promise<AxiosResponse<Message, any>>
- Defined in v0.10/api/kortex.ts:167

listAgentKnowledgeBases

listAgentKnowledgeBases(
agentUUID: string,
): Promise<AxiosResponse<KnowledgeBase[], any>>
Parameters
- agentUUID: string
Returns Promise<AxiosResponse<KnowledgeBase[], any>>
- Defined in v0.10/api/kortex.ts:61

listAgents

listAgents(
params?: PaginationParams,
): Promise<AxiosResponse<PagedResponse<Agent>, any>>
Parameters
- Optionalparams: PaginationParams
Returns Promise<AxiosResponse<PagedResponse<Agent>, any>>
- Defined in v0.10/api/kortex.ts:45

listConversations

listConversations(
params?: PaginationParams & { all_users?: boolean; archived?: boolean },
): Promise<AxiosResponse<PagedResponse<Conversation>, any>>
Parameters
- Optionalparams: PaginationParams & { all_users?: boolean; archived?: boolean }
Returns Promise<AxiosResponse<PagedResponse<Conversation>, any>>
- Defined in v0.10/api/kortex.ts:118

listDocuments

listDocuments(
kbUUID: string,
params?: PaginationParams,
): Promise<AxiosResponse<PagedResponse<Document>, any>>
Parameters
- kbUUID: string
- Optionalparams: PaginationParams
Returns Promise<AxiosResponse<PagedResponse<Document>, any>>
- Defined in v0.10/api/kortex.ts:89

listKnowledgeBases

listKnowledgeBases(
params?: PaginationParams,
): Promise<AxiosResponse<PagedResponse<KnowledgeBase>, any>>
Parameters
- Optionalparams: PaginationParams
Returns Promise<AxiosResponse<PagedResponse<KnowledgeBase>, any>>
- Defined in v0.10/api/kortex.ts:71

listMessages

listMessages(
conversationUUID: string,
params?: PaginationParams,
): Promise<AxiosResponse<PagedResponse<Message>, any>>
Parameters
- conversationUUID: string
- Optionalparams: PaginationParams
Returns Promise<AxiosResponse<PagedResponse<Message>, any>>
- Defined in v0.10/api/kortex.ts:163

listUsage

listUsage(
params?: PaginationParams & { month?: string },
): Promise<AxiosResponse<PagedResponse<AggregatedUsage>, any>>
Parameters
- Optionalparams: PaginationParams & { month?: string }
Returns Promise<AxiosResponse<PagedResponse<AggregatedUsage>, any>>
- Defined in v0.10/api/kortex.ts:213

listUserAccess

listUserAccess(
params?: PaginationParams,
): Promise<AxiosResponse<PagedResponse<UserAccess>, any>>
Parameters
- Optionalparams: PaginationParams
Returns Promise<AxiosResponse<PagedResponse<UserAccess>, any>>
- Defined in v0.10/api/kortex.ts:183

ocr

ocr(data: OCRPayload): Promise<AxiosResponse<OCRResult, any>>
Parameters
- data: OCRPayload
Returns Promise<AxiosResponse<OCRResult, any>>
- Defined in v0.10/api/kortex.ts:173

removeParticipant

removeParticipant(
conversationUUID: string,
agentUUID: string,
): Promise<AxiosResponse<void, any>>
Parameters
- conversationUUID: string
- agentUUID: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:146

retryDocument

retryDocument(kbUUID: string, uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- kbUUID: string
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:108

sendMessage

sendMessage(
conversationUUID: string,
data: SendMessagePayload,
): Promise<AxiosResponse<Message, any>>
Parameters
- conversationUUID: string
- data: SendMessagePayload
Returns Promise<AxiosResponse<Message, any>>
- Defined in v0.10/api/kortex.ts:152

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

streamMessage

streamMessage(
conversationUUID: string,
data: SendMessagePayload,
): Promise<AxiosResponse<ReadableStream<any>, any>>
Parameters
- conversationUUID: string
- data: SendMessagePayload
Returns Promise<AxiosResponse<ReadableStream<any>, any>>
- Defined in v0.10/api/kortex.ts:156

unarchiveConversation

unarchiveConversation(uuid: string): Promise<AxiosResponse<void, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<void, any>>
- Defined in v0.10/api/kortex.ts:138

updateAgent

updateAgent(
uuid: string,
data: AgentUpdatePayload,
): Promise<AxiosResponse<Agent, any>>
Parameters
- uuid: string
- data: AgentUpdatePayload
Returns Promise<AxiosResponse<Agent, any>>
- Defined in v0.10/api/kortex.ts:53

updateConversation

updateConversation(
uuid: string,
data: ConversationUpdatePayload,
): Promise<AxiosResponse<Conversation, any>>
Parameters
- uuid: string
- data: ConversationUpdatePayload
Returns Promise<AxiosResponse<Conversation, any>>
- Defined in v0.10/api/kortex.ts:126

updateKnowledgeBase

updateKnowledgeBase(
uuid: string,
data: KnowledgeBaseUpdatePayload,
): Promise<AxiosResponse<KnowledgeBase, any>>
Parameters
- uuid: string
- data: KnowledgeBaseUpdatePayload
Returns Promise<AxiosResponse<KnowledgeBase, any>>
- Defined in v0.10/api/kortex.ts:79

updateUserAccess

updateUserAccess(
uuid: string,
data: UserAccessUpdatePayload,
): Promise<AxiosResponse<UserAccess, any>>
Parameters
- uuid: string
- data: UserAccessUpdatePayload
Returns Promise<AxiosResponse<UserAccess, any>>
- Defined in v0.10/api/kortex.ts:191

uploadDocument

uploadDocument(
kbUUID: string,
formData: FormData,
): Promise<AxiosResponse<Document, any>>
Parameters
- kbUUID: string
- formData: FormData
Returns Promise<AxiosResponse<Document, any>>
- Defined in v0.10/api/kortex.ts:93

Class default

Param: client

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

addParticipant

Parameters

Returns Promise<AxiosResponse<any, any>>

archiveConversation

Parameters

Returns Promise<AxiosResponse<void, any>>

createAgent

Parameters

Returns Promise<AxiosResponse<Agent, any>>

createConversation

Parameters

Returns Promise<AxiosResponse<Conversation, any>>

createKnowledgeBase

Parameters

Returns Promise<AxiosResponse<KnowledgeBase, any>>

createUserAccess

Parameters

Returns Promise<AxiosResponse<UserAccess, any>>

deleteAgent

Parameters

Returns Promise<AxiosResponse<void, any>>

deleteConversation

Parameters

Returns Promise<AxiosResponse<void, any>>

deleteDocument

Parameters

Returns Promise<AxiosResponse<void, any>>

deleteKnowledgeBase

Parameters

Returns Promise<AxiosResponse<void, any>>

deleteUserAccess

Parameters

Returns Promise<AxiosResponse<void, any>>

getAgent

Parameters

Returns Promise<AxiosResponse<Agent, any>>

getConversation

Parameters

Returns Promise<AxiosResponse<Conversation, any>>

getDocument

Parameters

Returns Promise<AxiosResponse<Document, any>>

getKnowledgeBase

Parameters

Returns Promise<AxiosResponse<KnowledgeBase, any>>

getMyAccess

Returns Promise<AxiosResponse<MyAccess, any>>

getTier

Returns Promise<AxiosResponse<Tier, any>>

getUserAccess

Parameters

Returns Promise<AxiosResponse<UserAccess, any>>

getUserMonthlyUsage

Parameters

Returns Promise<AxiosResponse<UserMonthlyUsage, any>>

getUserUsageBreakdown

Parameters

Returns Promise<AxiosResponse<UserUsageBreakdown, any>>

injectMessage

Parameters

Returns Promise<AxiosResponse<Message, any>>

listAgentKnowledgeBases

`Protected`env

`Protected`host

`Protected`token