YaoApp / yao-neo-dev

for Neo development app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Neo Dev

Environment variables

Name Required Description Example
OPENAI_TEST_KEY OpenAI API key OpenAI API Key sk-xxxx
all_proxy Proxy for all socks5://127.0.0.1:7890
http_proxy Proxy for HTTP http://127.0.0.1:7890
https_proxy Proxy for HTTPS http://127.0.0.1:7890

Initialization & Start

yao migrate --reset
yao run scripts.demo.Data
yao start

Command Mode Test

Prompt Description
Generate test data Enter the table.data Command mode
创建一组测试数据 进入 table.data 命令交互模式

Reponse Event Stream

{
  "done": true,
  "command": {
    "id": "table.data", // The command id @/neo/table/data.cmd.yml
    "name": "Generate test data for the table", // The command name
    "request": "89c151e1-02bd-467d-8186-540f6cb36e36" // The Request ID
  }
}

Exit the Command Mode

Command execution completed, or calling the exit command, exits command mode.

curl --location --request POST --X POST 'http://localhost:5099/api/__yao/neo?token=Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwic2lkIjoicUhnMDFDRGptOVZUWlZDLWJnUFI1MTY4MzE1MDE5MTQ0MSIsImRhdGEiOnt9LCJhdWQiOiJYaWFuZyBNZXRhZGF0YSBBZG1pbiBQYW5lbCIsImV4cCI6MTY4MzE1Mzc5OCwianRpIjoiMSIsImlhdCI6MTY4MzE1MDE5OCwiaXNzIjoieWFvIiwibmJmIjoxNjgzMTUwMTk4LCJzdWIiOiJVc2VyIFRva2VuIn0.FdL_7OiLL6aMx0zS9ar0yGYmeT1_sAgnF5gncJcruLs' \
--header 'Content-Type: application/json' \
--data '{
    "cmd": "ExitCommandMode"
}'

API Reference

Chat Stream

GET /api/__yao/neo

Query String Parameters

Name Required Description Example
token true JWT token Bearer eyJhbGciOiJ...
content true User input question Bearer eyJhbGciOiJ...
context true Router {"stack":"Table-Page-pet","pathname":"/x/Table/pet"}

Response Status

Status Description
200 Success
4xx Parameter Error
5xx Internal Error

Response Headers

Success:

Name Value
Content-Type text/event-stream;charset=utf-8

Failure:

Name Value
Content-Type application/json; charset=utf-8

Response Event Stream

Text:

{ "text": "Hello" }

Done:

{ "text": "Hello" }

Done With Command:

{
  "done": true,
  "command": {
    "id": "table.data",
    "name": "Generate test data for the table",
    "request": "89c151e1-02bd-467d-8186-540f6cb36e36"
  }
}

Done With Actions:

{
  "done": true,
  "actions": [
    {
      "name": "Back",
      "type": "Common.historyPush",
      "payload": { "pathname": "/x/Form/1" }
    }
  ]
}

Get Chat History

GET /api/__yao/neo/history

Query String Parameters

Name Required Description Example
token true JWT token Bearer eyJhbGciOiJ...

Response Status

Status Description
200 Success
4xx Parameter Error
5xx Internal Error

Response Headers

Name Value
Content-Type application/json; charset=utf-8

Response Data

Success:

[
  {
    "content": "Hello",
    "name": "qHg01CDjm9VTZVC-bgPR51683150191441",
    "role": "user"
  },
  {
    "content": "Hello the world",
    "name": "qHg01CDjm9VTZVC-bgPR51683150191441",
    "role": "assistant"
  }
]

Failure:

{
  "code": 500,
  "message": "Error: Invalid token"
}

Commands

POST /api/__yao/neo

Query String Parameters

Name Required Description Example
token true JWT token Bearer eyJhbGciOiJ...

Request Body

{
  "cmd": "ExitCommandMode"
}
Command Description
ExitCommandMode Exit the Command Mode

Request Headers

Name Value
Content-Type application/json; charset=utf-8

Response Status

Status Description
200 Success
4xx Parameter Error
5xx Internal Error

Response Headers

Name Value
Content-Type application/json; charset=utf-8

Response Data

Success:

{
  "code": 200,
  "message": "success"
}

Failure:

{
  "code": 500,
  "message": "Error: Invalid token"
}

About

for Neo development app

License:MIT License


Languages

Language:JavaScript 56.8%Language:Go 29.6%Language:HTML 13.7%