/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AgentGetConversationResponse, AgentSendMessageRequest, AgentSendMessageResponse, AgentUploadFileRequest, AgentUploadFileResponse } from '../models/index'; export interface AgentServiceClearConversationRequest { contextType?: string; contextId?: string; } export interface AgentServiceGetConversationRequest { contextType?: string; contextId?: string; } export interface AgentServiceSendMessageRequest { agentSendMessageRequest: AgentSendMessageRequest; } export interface AgentServiceUploadFileRequest { agentUploadFileRequest: AgentUploadFileRequest; } /** * AgentApi - interface * * @export * @interface AgentApiInterface */ export interface AgentApiInterface { /** * Creates request options for agentServiceClearConversation without sending the request * @param {string} [contextType] - AGENT_CONTEXT_TYPE_LINK_ANALYTICS: Building a link\'s analytics dashboard. context_id is the LINK id, not a dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under AGENT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. - AGENT_CONTEXT_TYPE_LEAD_SCORE: A conversation about one visit and the lead score it produced. The context id is the EVENT id, not the link id: two visits to the same link are two different subjects, and sharing a thread between them lets one visitor\'s details bleed into answers about another. - AGENT_CONTEXT_TYPE_WORKSPACE: The workspace-wide assistant, with no resource selected. The context id is the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped agents have is available from it. One conversation per workspace, so it survives navigation. * @param {string} [contextId] * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceClearConversationRequestOpts(requestParameters: AgentServiceClearConversationRequest): Promise; /** * Clear the conversation history for a specific context. * @summary Clear agent conversation * @param {string} [contextType] - AGENT_CONTEXT_TYPE_LINK_ANALYTICS: Building a link\'s analytics dashboard. context_id is the LINK id, not a dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under AGENT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. - AGENT_CONTEXT_TYPE_LEAD_SCORE: A conversation about one visit and the lead score it produced. The context id is the EVENT id, not the link id: two visits to the same link are two different subjects, and sharing a thread between them lets one visitor\'s details bleed into answers about another. - AGENT_CONTEXT_TYPE_WORKSPACE: The workspace-wide assistant, with no resource selected. The context id is the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped agents have is available from it. One conversation per workspace, so it survives navigation. * @param {string} [contextId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceClearConversationRaw(requestParameters: AgentServiceClearConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Clear the conversation history for a specific context. * Clear agent conversation */ agentServiceClearConversation(requestParameters: AgentServiceClearConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for agentServiceGetConversation without sending the request * @param {string} [contextType] - AGENT_CONTEXT_TYPE_LINK_ANALYTICS: Building a link\'s analytics dashboard. context_id is the LINK id, not a dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under AGENT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. - AGENT_CONTEXT_TYPE_LEAD_SCORE: A conversation about one visit and the lead score it produced. The context id is the EVENT id, not the link id: two visits to the same link are two different subjects, and sharing a thread between them lets one visitor\'s details bleed into answers about another. - AGENT_CONTEXT_TYPE_WORKSPACE: The workspace-wide assistant, with no resource selected. The context id is the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped agents have is available from it. One conversation per workspace, so it survives navigation. * @param {string} [contextId] * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceGetConversationRequestOpts(requestParameters: AgentServiceGetConversationRequest): Promise; /** * Get the display-ready chat history for a specific context. * @summary Get agent conversation * @param {string} [contextType] - AGENT_CONTEXT_TYPE_LINK_ANALYTICS: Building a link\'s analytics dashboard. context_id is the LINK id, not a dashboard id — the dashboard does not exist yet while the user and the assistant are still agreeing on what it should show. Once it exists, editing it happens under AGENT_CONTEXT_TYPE_ANALYTICS_DASHBOARD instead. - AGENT_CONTEXT_TYPE_LEAD_SCORE: A conversation about one visit and the lead score it produced. The context id is the EVENT id, not the link id: two visits to the same link are two different subjects, and sharing a thread between them lets one visitor\'s details bleed into answers about another. - AGENT_CONTEXT_TYPE_WORKSPACE: The workspace-wide assistant, with no resource selected. The context id is the WORKSPACE id: this thread is not about any one link, dashboard or design, and every capability the resource-scoped agents have is available from it. One conversation per workspace, so it survives navigation. * @param {string} [contextId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceGetConversationRaw(requestParameters: AgentServiceGetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the display-ready chat history for a specific context. * Get agent conversation */ agentServiceGetConversation(requestParameters: AgentServiceGetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for agentServiceSendMessage without sending the request * @param {AgentSendMessageRequest} agentSendMessageRequest * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceSendMessageRequestOpts(requestParameters: AgentServiceSendMessageRequest): Promise; /** * Send a message to the agent. The context type determines which specialized sub-agent handles the request. * @summary Send agent message * @param {AgentSendMessageRequest} agentSendMessageRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceSendMessageRaw(requestParameters: AgentServiceSendMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Send a message to the agent. The context type determines which specialized sub-agent handles the request. * Send agent message */ agentServiceSendMessage(requestParameters: AgentServiceSendMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for agentServiceUploadFile without sending the request * @param {AgentUploadFileRequest} agentUploadFileRequest * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceUploadFileRequestOpts(requestParameters: AgentServiceUploadFileRequest): Promise; /** * Upload a file to attach to the next agent message. Returns a temporary file ID. Files expire after 5 minutes. Max 20MB. * @summary Upload file for agent chat * @param {AgentUploadFileRequest} agentUploadFileRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AgentApiInterface */ agentServiceUploadFileRaw(requestParameters: AgentServiceUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Upload a file to attach to the next agent message. Returns a temporary file ID. Files expire after 5 minutes. Max 20MB. * Upload file for agent chat */ agentServiceUploadFile(requestParameters: AgentServiceUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class AgentApi extends runtime.BaseAPI implements AgentApiInterface { /** * Creates request options for agentServiceClearConversation without sending the request */ agentServiceClearConversationRequestOpts(requestParameters: AgentServiceClearConversationRequest): Promise; /** * Clear the conversation history for a specific context. * Clear agent conversation */ agentServiceClearConversationRaw(requestParameters: AgentServiceClearConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Clear the conversation history for a specific context. * Clear agent conversation */ agentServiceClearConversation(requestParameters?: AgentServiceClearConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for agentServiceGetConversation without sending the request */ agentServiceGetConversationRequestOpts(requestParameters: AgentServiceGetConversationRequest): Promise; /** * Get the display-ready chat history for a specific context. * Get agent conversation */ agentServiceGetConversationRaw(requestParameters: AgentServiceGetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the display-ready chat history for a specific context. * Get agent conversation */ agentServiceGetConversation(requestParameters?: AgentServiceGetConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for agentServiceSendMessage without sending the request */ agentServiceSendMessageRequestOpts(requestParameters: AgentServiceSendMessageRequest): Promise; /** * Send a message to the agent. The context type determines which specialized sub-agent handles the request. * Send agent message */ agentServiceSendMessageRaw(requestParameters: AgentServiceSendMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Send a message to the agent. The context type determines which specialized sub-agent handles the request. * Send agent message */ agentServiceSendMessage(requestParameters: AgentServiceSendMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for agentServiceUploadFile without sending the request */ agentServiceUploadFileRequestOpts(requestParameters: AgentServiceUploadFileRequest): Promise; /** * Upload a file to attach to the next agent message. Returns a temporary file ID. Files expire after 5 minutes. Max 20MB. * Upload file for agent chat */ agentServiceUploadFileRaw(requestParameters: AgentServiceUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Upload a file to attach to the next agent message. Returns a temporary file ID. Files expire after 5 minutes. Max 20MB. * Upload file for agent chat */ agentServiceUploadFile(requestParameters: AgentServiceUploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }