@agentshelf/external-agents-sdk / ExternalAgentClient

Interface: ExternalAgentClient

Methods

clearStoredSession()

clearStoredSession(): Promise<void>;

Returns

Promise<void>

---

createConversation()

createConversation(input?): Promise<ExternalAgentConversation>;

Parameters

Parameter	Type
input?	CreateConversationInput

Returns

Promise<ExternalAgentConversation>

---

ensure()

ensure(input?): Promise<ExternalAgentEnsureResult>;

Parameters

Parameter	Type
input?	ExternalAgentEnsureInput

Returns

Promise<ExternalAgentEnsureResult>

---

ensureWorkspace()

ensureWorkspace(input?): Promise<EnsureWorkspaceResult>;

Parameters

Parameter	Type
input?	EnsureWorkspaceInput

Returns

Promise<EnsureWorkspaceResult>

---

getArtifact()

getArtifact(artifactRef): Promise<GetArtifactResult>;

Parameters

Parameter	Type
artifactRef	ArtifactRef

Returns

Promise<GetArtifactResult>

---

getConversationMessages()

getConversationMessages(conversationRef): Promise<ConversationMessagesResult>;

Parameters

Parameter	Type
conversationRef	ConversationRef

Returns

Promise<ConversationMessagesResult>

---

getEffectivePolicy()

getEffectivePolicy(): Promise<PublicExternalAgentPolicy>;

Returns

Promise<PublicExternalAgentPolicy>

---

getFile()

getFile(fileRef): Promise<RuntimeFile>;

Parameters

Parameter	Type
fileRef	FileRef

Returns

Promise<RuntimeFile>

---

getStoredSession()

getStoredSession(): Promise<
  | PublicStoredExternalAgentSession
| null>;

Returns

Promise< | PublicStoredExternalAgentSession | null>

---

getWorkspaceRuntimeStatus()

getWorkspaceRuntimeStatus(input?): Promise<WorkspaceRuntimeStatus>;

Parameters

Parameter	Type
input?	WorkspaceRuntimeStatusInput

Returns

Promise<WorkspaceRuntimeStatus>

---

listConversations()

listConversations(): Promise<ListConversationsResult>;

Returns

Promise<ListConversationsResult>

---

listFiles()

listFiles(): Promise<ListFilesResult>;

Returns

Promise<ListFilesResult>

---

prepare()

prepare(input?): Promise<ExternalAgentPrepareResult>;

Parameters

Parameter	Type
input?	ExternalAgentPrepareInput

Returns

Promise<ExternalAgentPrepareResult>

---

respondToInteraction()

respondToInteraction(input): Promise<RuntimeInteraction>;

Parameters

Parameter	Type
input	RespondToInteractionInput

Returns

Promise<RuntimeInteraction>

---

revokeSession()

revokeSession(): Promise<RevokeSessionResult>;

Returns

Promise<RevokeSessionResult>

---

streamMessage()

streamMessage(input): Promise<RuntimeEventStream>;

Parameters

Parameter	Type
input	StreamMessageInput

Returns

Promise<RuntimeEventStream>

---

uploadFile()

uploadFile(input): Promise<RuntimeFile>;

Parameters

Parameter	Type
input	UploadFileInput

Returns

Promise<RuntimeFile>

---

waitForWorkspaceRuntime()

waitForWorkspaceRuntime(input?): Promise<WorkspaceRuntimeStatus>;

Parameters

Parameter	Type
input?	WaitForWorkspaceRuntimeInput

Returns

Promise<WorkspaceRuntimeStatus>