apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-07-17 09:11:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

More API doc hacking

Browse source
This commit is contained in:
Cyber MacGeddon 2024-12-28 16:09:10 +00:00
parent 5c00b8e71b
commit 9549878a9a
4 changed files with 165 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/apis/api-document-load.md
View file

@ -0,0 +1,3 @@
Coming soon

7
docs/apis/api-embeddings.md
View file

@ -19,8 +19,7 @@ The request contains the following fields:
## REST service
The REST service accepts a request object containing the question field.
The response is a JSON object containing the `answer` field. Interim
responses are not provided.
The response is a JSON object containing the `answer` field.
e.g.
@ -41,7 +40,7 @@ Response:
## Websocket
Agent requests have a `request` object containing the `text` field.
Embeddings requests have a `request` object containing the `text` field.
Responses have a `response` object containing `vectors` field.
e.g.
@ -82,7 +81,7 @@ Responses:
## Pulsar
The Pulsar schema for the Agent API is defined in Python code here:
The Pulsar schema for the Embeddings API is defined in Python code here:
https://github.com/trustgraph-ai/trustgraph/blob/master/trustgraph-base/trustgraph/schema/models.py

154
docs/apis/api-graph-embeddings.md
View file

File diff suppressed because one or more lines are too long

11
docs/apis/api-text-completion.md
View file

@ -1,5 +1,9 @@
# TrustGraph Embeddings API
# TrustGraph Text Completion API
This is a low-level interface to the LLM service. For a higher-level
interface with template management, consider the
[Prompt API](api-prompt.md).
## Request/response
@ -21,8 +25,7 @@ The request contains the following fields:
## REST service
The REST service accepts a request object containing the question field.
The response is a JSON object containing the `answer` field. Interim
responses are not provided.
The response is a JSON object containing the `answer` field.
e.g.
@ -44,7 +47,7 @@ Response:
## Websocket
Agent requests have a `request` object containing the `system` and
Requests have a `request` object containing the `system` and
`prompt` fields.
Responses have a `response` object containing `response` field.