From f75e25b5f59f7cb8dc88a9e6d14c4fb97816c64d Mon Sep 17 00:00:00 2001 From: "felix.bucsa" <72919584+FelixNicolaeBucsa@users.noreply.github.com> Date: Mon, 12 Aug 2024 10:56:37 +0200 Subject: [PATCH] =?UTF-8?q?fix(docs):=20removed=20Function=20Group=20APIs?= =?UTF-8?q?=20resource=20and=20made=20edits=20to=20tit=E2=80=A6=20(#843)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/apis.mdx | 16 +-- pages/apis/ai-engine/_meta.json | 5 +- pages/apis/ai-engine/chat.mdx | 4 +- pages/apis/ai-engine/function_groups.mdx | 144 ----------------------- pages/apis/ai-engine/functions.mdx | 4 +- 5 files changed, 9 insertions(+), 164 deletions(-) delete mode 100644 pages/apis/ai-engine/function_groups.mdx diff --git a/pages/apis.mdx b/pages/apis.mdx index 8dee05ca2..cf278405a 100644 --- a/pages/apis.mdx +++ b/pages/apis.mdx @@ -46,29 +46,19 @@ import { GuideBox } from "../components/feature-guide-tabs"; - - - -
diff --git a/pages/apis/ai-engine/_meta.json b/pages/apis/ai-engine/_meta.json index 99321108d..89e5e8791 100644 --- a/pages/apis/ai-engine/_meta.json +++ b/pages/apis/ai-engine/_meta.json @@ -1,5 +1,4 @@ { - "chat": "Chat API", - "functions": "Functions API", - "function_groups": "Function Groups API" + "chat": "AI Engine Chat API", + "functions": "Functions API" } diff --git a/pages/apis/ai-engine/chat.mdx b/pages/apis/ai-engine/chat.mdx index 9aa06d942..7254742ab 100644 --- a/pages/apis/ai-engine/chat.mdx +++ b/pages/apis/ai-engine/chat.mdx @@ -3,7 +3,7 @@ import { ApiEndpointRequestResponse, } from "../../../components/api-endpoint"; -# DELTA-V Chat API +# AI Engine Chat API
Most of the endpoints depends on various instances and are considered parameters for the actual endpoint, but these are not meant to be passed directly by the user. @@ -18,7 +18,7 @@ Mind that: to access these APIs, user must be **authenticated** and have the **c - The DeltaV Chat API allows you to interact with the DeltaV backend, allowing you to interact with your agents and more. + The AI Engine Chat API allows you to interact with the DeltaV backend, allowing you to interact with your agents and more. ```bash filename="Endpoints" diff --git a/pages/apis/ai-engine/function_groups.mdx b/pages/apis/ai-engine/function_groups.mdx deleted file mode 100644 index 711685b42..000000000 --- a/pages/apis/ai-engine/function_groups.mdx +++ /dev/null @@ -1,144 +0,0 @@ -import { Row, Col } from "../../../components/mdx"; -import { - ApiEndpointRequestResponse, -} from "../../../components/api-endpoint"; - -# DeltaV Function Groups API - -
- -Most of the endpoints depends on various instances and are considered parameters for the actual endpoint, but these are not meant to be passed directly by the user. - -Instead, these instance-dependent elements are integrated and managed directly by the backend system. We refer to them as `*name_parameter`, where the asterisk (\*) is used to denote a specific instance-dependent parameter that the route relies on. - -Mind that: to access these APIs, user must be **authenticated** and have the **correct permissions**. - -
- -## Overview - - - - The DeltaV Function Groups API allows you to interact with the DeltaV backend, allowing you to interact with your function groups and more. - - - ```bash filename="Endpoints" - POST /v1beta1/function-groups/ - - GET /v1beta1/function-groups/ - - GET /v1beta1/function-groups/:function_group_id/functions/ - - GET /v1beta1/function-groups/public/ - - DELETE /v1beta1/function-groups/:function_group_id/ - ``` - - - -## Create a function group - - - -## Get all function groups of a user - - - -## Get functions of a function group - - - -## Get all public function groups - - - -## Delete a function group - - diff --git a/pages/apis/ai-engine/functions.mdx b/pages/apis/ai-engine/functions.mdx index 05b783137..ea2f52232 100644 --- a/pages/apis/ai-engine/functions.mdx +++ b/pages/apis/ai-engine/functions.mdx @@ -3,7 +3,7 @@ import { ApiEndpointRequestResponse, } from "../../../components/api-endpoint"; -# DeltaV Functions API +# AI Engine Functions API
Most of the endpoints depends on various instances and are considered parameters for the actual endpoint, but these are not meant to be passed directly by the user. @@ -18,7 +18,7 @@ Mind that: to access these APIs, user must be **authenticated** and have the **c - The DeltaV Functions API allows you to interact with the DeltaV backend, allowing you to interact with your functions and more. + The AI Engine Functions API allows you to interact with the DeltaV backend, allowing you to interact with your functions and more. ```bash filename="Endpoints"