Skip to main content
PATCH
/
v1
/
ais
/
{ai_id}
Update AI
curl --request PATCH \
  --url https://api.gbase.ai/v1/ais/{ai_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "discrible": "<string>",
  "ai_type": "default",
  "robot_type": "rag",
  "prompt": "<string>",
  "subject_name": "<string>",
  "ai_model": "<string>",
  "embedding_model_name": "<string>",
  "embedding_dimensions": 2
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "user": {
    "user_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "salt": "<string>",
    "picture": "<string>",
    "locale": "<string>",
    "corporate": false,
    "is_independent": false
  },
  "apis": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "function_call_name": "<string>",
      "openapi_url": "<string>",
      "server_url": "<string>",
      "path": "<string>",
      "method": "<string>",
      "header_authorization": "<unknown>",
      "function_type": "<string>",
      "function_status": "<string>",
      "share_status": "<string>",
      "user_id": "<string>",
      "function_call_description": "<string>",
      "matching_keywords": "<unknown>",
      "llm_sta": true,
      "body": "<unknown>",
      "auth_token_curl": "<unknown>",
      "body_required": "<unknown>",
      "request_explanation": "<string>"
    }
  ],
  "datasets": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "user_id": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "data_status": "init",
      "description": "<string>",
      "metadata": "<unknown>",
      "url_rules": "<unknown>"
    }
  ],
  "questions": [
    {
      "question": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "question_type": "generator"
    }
  ],
  "file_count": 123,
  "faq_count": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discrible": "<string>",
  "subject_name": "<string>",
  "prompt": "<string>",
  "robot_type": "rag",
  "ai_type": "private",
  "ai_model": "file",
  "ai_status": "ready"
}

Path Parameters

​
ai_id
string
required

Body

application/json
​
name
string
​
discrible
string
​
ai_type
enum<string>

An enumeration.

Available options:
default,
demo,
public,
private,
trending
​
robot_type
enum<string>
default:rag

An enumeration.

Available options:
rag,
digital_human,
agent,
catalog_agent,
general_agent
​
prompt
string
​
subject_name
string
​
ai_model
string
​
embedding_model_name
string
​
embedding_dimensions
integer
Required range: x >= 1

Response

Successful Response

​
created_at
string<date-time>
required
​
name
string
required
Maximum string length: 100
​
user
User · object
required
​
apis
AgentFunctionCallApi · object[]
required
​
datasets
Dataset · object[]
required
​
questions
Question · object[]
required
​
file_count
integer
required
​
faq_count
integer
required
​
id
string<uuid>
​
discrible
string | null
​
subject_name
string | null
​
prompt
string | null
​
robot_type
string
default:rag

RAG: rag
DIGITAL_HUMAN: digital_human
AGENT: agent
CATALOG_AGENT: catalog_agent
GENERAL_AGENT: general_agent

Maximum string length: 100
​
ai_type
string
default:private

DEFAULT: default
DEMO: demo
PUBLIC: public
PRIVATE: private
TRENDING: trending

Maximum string length: 20
​
ai_model
string
default:file

FILE: file
WEBSITE: website
DIGITAL_HUMAN: digital_human
AGENT: agent

Maximum string length: 20
​
ai_status
string
default:ready

INIT: init
READY: ready
FROZEN: frozen

Maximum string length: 20