@prometheus-ags/universal-agent-runtime-sdk
Preparing search index...
UarClient
Class UarClient
Typed client for the Universal Agent Runtime HTTP API.
Index
Constructors
constructor
Properties
chat
embeddings
ingest
knowledge
runs
tools
Constructors
constructor
new
UarClient
(
baseUrl
:
string
,
options
?:
ClientOptions
)
:
UarClient
Parameters
baseUrl
:
string
options
:
ClientOptions
= {}
Returns
UarClient
Properties
Readonly
chat
chat
:
{
complete
:
(
request
:
ChatRequest
,
)
=>
Promise
<
{
choices
:
{
finish_reason
?:
string
|
null
;
index
?:
number
;
message
:
{
content
?:
string
|
null
;
role
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
id
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
stream
:
(
request
:
ChatRequest
,
options
?:
StreamOptions
,
)
=>
AsyncIterable
<
SseEvent
<
JsonValue
>
,
any
,
any
>
;
structured
:
<
T
>
(
request
:
ChatRequest
,
schema
:
ZodType
<
T
>
)
=>
Promise
<
T
>
;
}
= ...
Readonly
embeddings
embeddings
:
{
create
:
(
input
:
string
|
string
[]
,
model
?:
string
,
)
=>
Promise
<
{
data
:
{
embedding
:
number
[]
;
index
?:
number
;
[
key
:
string
]:
unknown
}
[]
;
model
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
= ...
Readonly
ingest
ingest
:
{
content
:
(
request
:
IngestRequest
,
)
=>
Promise
<
{
chunk_count
:
number
;
success
:
boolean
;
[
key
:
string
]:
unknown
}
,
>
;
}
= ...
Readonly
knowledge
knowledge
:
{
create
:
(
input
:
KnowledgeBaseInput
,
)
=>
Promise
<
{
config
?:
Record
<
string
,
unknown
>
;
created_at
:
string
;
description
?:
string
|
null
;
id
:
string
;
name
:
string
;
updated_at
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
delete
:
(
id
:
string
)
=>
Promise
<
void
>
;
deleteDocument
:
(
id
:
string
,
documentId
:
string
)
=>
Promise
<
void
>
;
documents
:
(
id
:
string
,
)
=>
Promise
<
{
id
:
string
;
[
key
:
string
]:
unknown
}
[]
>
;
get
:
(
id
:
string
,
)
=>
Promise
<
{
config
?:
Record
<
string
,
unknown
>
;
created_at
:
string
;
description
?:
string
|
null
;
id
:
string
;
name
:
string
;
updated_at
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
list
:
()
=>
Promise
<
{
config
?:
Record
<
string
,
unknown
>
;
created_at
:
string
;
description
?:
string
|
null
;
id
:
string
;
name
:
string
;
updated_at
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
search
:
(
id
:
string
,
request
:
SearchRequest
,
)
=>
Promise
<
{
results
:
{
content
:
string
;
document_id
?:
string
|
null
;
metadata
?:
unknown
;
score
:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
update
:
(
id
:
string
,
input
:
Partial
<
KnowledgeBaseInput
>
,
)
=>
Promise
<
{
config
?:
Record
<
string
,
unknown
>
;
created_at
:
string
;
description
?:
string
|
null
;
id
:
string
;
name
:
string
;
updated_at
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
= ...
Readonly
runs
runs
:
{
cancel
:
(
runId
:
string
)
=>
Promise
<
{
cancelled
:
boolean
}
>
;
checkpoints
:
(
runId
:
string
,
)
=>
Promise
<
{
checkpoints
:
unknown
[]
;
run_id
:
string
;
[
key
:
string
]:
unknown
}
,
>
;
create
:
(
request
:
CreateRunRequest
,
)
=>
Promise
<
{
resumed_from_run_id
?:
string
;
run_id
:
string
;
stream_url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
resume
:
(
runId
:
string
,
request
:
ResumeRunRequest
,
checkpointId
?:
string
,
)
=>
Promise
<
{
resumed_from_run_id
?:
string
;
run_id
:
string
;
stream_url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
stream
:
(
runId
:
string
,
options
?:
StreamOptions
,
)
=>
AsyncIterable
<
SseEvent
<
JsonValue
>
,
any
,
any
>
;
}
= ...
Readonly
tools
tools
:
{
execute
:
(
name
:
string
,
arguments_
?:
Record
<
string
,
JsonValue
>
,
)
=>
Promise
<
{
duration_ms
:
number
;
error
?:
string
|
null
;
result
?:
unknown
;
success
:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
= ...
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
chat
embeddings
ingest
knowledge
runs
tools
@prometheus-ags/universal-agent-runtime-sdk
Loading...
Typed client for the Universal Agent Runtime HTTP API.