Skip to content

Commit 5953936

Browse files
authored
Merge pull request #58 from Callgent/blog
Blog
2 parents a9eabcf + 45c5632 commit 5953936

39 files changed

Lines changed: 836 additions & 272 deletions

blog/2024-06-17-generative-ui-home-cooked-software-development/generative-ui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,6 @@ With predefined business services and standard widgets, the `Home-Cooked Softwar
5050

5151
Callgent's core functionality is to do native function-calling to orchestrate business services.
5252

53-
Callgent has server endpoints and client endpoints to adapt various invocation scenarios.
53+
Callgent has server entries and client entries to adapt various invocation scenarios.
5454

55-
Specifically, widget based User Interface, is just one more type of client endpoints, to adapt human interactions.
55+
Specifically, widget based User Interface, is just one more type of client entries, to adapt human interactions.

developer/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Explore the innovative architecture of Callgent, where services and
77
# Concepts and Architecture
88

99
The core of the callgent architecture, is to encapsulate every **service** and **user** behind a `callgent`.
10-
Then build various endpoints into third-party platforms, so that any users and services are naturally connected anywhere in their native ways: webpages, chatting, email, APIs..
10+
Then build various entries into third-party platforms, so that any users and services are naturally connected anywhere in their native ways: webpages, chatting, email, APIs..
1111

1212
Above this, we add a layer of semantic invocations, empowered by large language models (LLMs), to make the callgent able to understand and react to any user/system's intents.
1313

@@ -27,7 +27,7 @@ Each system service, and every user is encapsulated into a `Callgent`.
2727

2828
### Calling Anywhere
2929

30-
Requesting a callgent is done through various `Calling Endpoint`, integrated into third-party platforms. So systems and users are naturally connected anywhere in their native ways: Webpages, chatting, email, APIs..
30+
Requesting a callgent is done through various `Client Entries`, integrated into third-party platforms. So systems and users are naturally connected anywhere in their native ways: Webpages, chatting, email, APIs..
3131

3232
#### User-as-a-Service
3333

docs/advanced-topics/callgent-endpoints/_category_.json renamed to docs/advanced-topics/callgent-entries/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Callgent Endpoints",
2+
"label": "Callgent Entries",
33
"position": 1,
44
"link": {
55
"type": "doc",
6-
"id": "endpoints"
6+
"id": "entries"
77
}
88
}

docs/advanced-topics/callgent-endpoints/client-endpoint.md renamed to docs/advanced-topics/callgent-entries/client-entry.md

File renamed without changes.
Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
# Callgent Endpoints
1+
# Callgent Entries
22

3-
Callgents endpoints are adaptors to collect callgent to external systems or users.
3+
Callgents entries are adaptors to collect callgent to external systems or users.
44

5-
There are three types of endpoints:
5+
There are three types of entries:
66

7-
- [Server Endpoint](./server-endpoint)
7+
- [Server Entry](./server-entry)
88
Responsible for converting requests into the encapsulated target system invocation or user chatting, and retrieving invocation response.
9-
- [Client Endpoint](./client-endpoint)
9+
- [Client Entry](./client-entry)
1010
Responsible for receiving requests into callgent task queue, and responding back to caller when task has any progress.
11-
- [Event Endpoint](./event-endpoint)
11+
- [Event Entry](./event-entry)
1212
Responsible for listening to events from the encapsulated target system or user, and notifying registered event observers on callgent.
1313

14-
## Add a new endpoint to callgent
14+
## Add a new entry to callgent
1515

16-
When you want to connect your callgent to a new external system / user, you need to integrate them by adding a new endpoint.
17-
You can add any number of endpoints to your callgent.
16+
When you want to connect your callgent to a new external system / user, you need to integrate them by adding a new entry.
17+
You can add any number of entries to your callgent.
1818

1919
### choose a callgent
2020

2121
FIXME: list your callgents
2222

23-
### Step 1, choose a type of endpoint
23+
### Step 1, choose a type of entry
2424

25-
Client endpoint to accept tasks from external system, and server endpoint to send tasks to external system / user.
25+
Client entry to accept tasks from external system, and server entry to send tasks to external system / user.
2626

2727
### Step 2, choose an adaptor to the external system
2828

2929
You can also develop your own adaptor to the external system, if needed.
3030

31-
### Step 3, configure the endpoint
31+
### Step 3, configure the entry
3232

33-
### Step 4, initialize the endpoint
33+
### Step 4, initialize the entry

docs/advanced-topics/callgent-endpoints/event-endpoint.md renamed to docs/advanced-topics/callgent-entries/event-entry.md

File renamed without changes.

docs/advanced-topics/callgent-endpoints/server-endpoint.md renamed to docs/advanced-topics/callgent-entries/server-entry.md

File renamed without changes.

docs/advanced-topics/callgent-hub.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,18 @@ Follow the instructions to fill in the API key, then confirm the creation.
3434
On successful creation, you will see a webhook URL on the callgent card. You must set this webhook URL on your canny.io > Settings > API > Webhooks.
3535

3636
:::info
37-
The webhook URL is a event endpoint for canny.io to receive notification events to your callgent.
37+
The webhook URL is an event entry for canny.io to receive notification events to your callgent.
3838
:::
3939

4040
## Using your canny.io callgent
4141

42-
### Client endpoint
42+
### Client entry
4343

4444
Every user interactions on canny.io will go directly into your callgent task queue.
4545

46-
### Server endpoint
46+
### Server entry
4747

48-
You can add any server endpoint to your callgent. So that you can respond to these tasks anywhere, e.g.
48+
You can add any server entry to your callgent. So that you can respond to these tasks anywhere, e.g.
4949

5050
- send to your Slack channels
5151
- as a github issue

docs/advanced-topics/composite-callgent.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 2
33
keywords: [composite callgent, group callgent, Nested Callgents]
4-
description: Learn how to create and manage a Composite Callgent. Discover how to handle complex call requests, utilize nested callgents, and perform map/reduce operations. Simplify your call process with a single call endpoint and efficient callgent orchestration..
4+
description: Learn how to create and manage a Composite Callgent. Discover how to handle complex call requests, utilize nested callgents, and perform map/reduce operations. Simplify your call process with a single call entry and efficient callgent orchestration..
55
---
66

77
# Group of Callgents
@@ -10,12 +10,12 @@ Multiple callgents can naturally be combined to form a new composite callgent, w
1010

1111
## Creating a Composite Callgent
1212

13-
Similar to a regular callgent, which maintains a list of `function entries` to automatically map each request to a function entry, call it, and return the result, a composite callgent maintains a list of callgents. This allows each request to be automatically mapped to a `callgent entry`, called, and the result returned.
13+
Similar to a regular callgent, which maintains a list of `functional endpoints` to automatically map each request to an endpoint, call it, and return the result, a composite callgent maintains a list of callgents. This allows each request to be automatically mapped to a `callgent entry`, called, and the result returned.
1414

1515
:::tip
16-
Callgent entries come in two types: `function entries` and `callgent entries`. These two types of entries can be mixed together.
16+
Callgent entries come in two types: `functional entries` and `callgentive entries`. These two types of entries can be mixed together.
1717

18-
A callgent that contains `callgent entries` is typically referred to as a composite callgent.
18+
A callgent that contains `callgentive entries` is typically referred to as a composite callgent.
1919
:::
2020

2121
## Composite Callgent Invocation Process
@@ -30,15 +30,15 @@ Composite callgents can be nested, forming a call tree. Each node in the call tr
3030

3131
## Multiple Internal Invocations
3232

33-
A callgent automatically maps a single request to an entry for processing and retrieves the response result. Based on the original request, the callgent decides whether to return the response to the caller or continue calling the next entry. This process repeats until the final result is returned to the caller.
33+
A callgent automatically maps a single request to an endpoint for processing and retrieves the response result. Based on the original request, the callgent decides whether to return the response to the caller or continue calling the next endpoint. This process repeats until the final result is returned to the caller.
3434

3535
### Request with Collection Data
3636

3737
If the request contains collection data, the callgent may automatically perform map/reduce operations on the collection and map it to entry calls as needed.
3838

3939
## Advantages of Composite Callgent
4040

41-
Composite Callgent allows multiple callgents to work together while maintaining a single call endpoint, enabling the handling of complex call requests.
41+
Composite Callgent allows multiple callgents to work together while maintaining a single call entry, enabling the handling of complex call requests.
4242

4343
:::info
4444
Composite Callgent allows you to interact with a single callgent to invoke multiple callgents, simplifying the call process.

docs/quick-start/call-the-callgent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Now you may request the callgent for a task, in the following ways.
1616

1717
You may directly send an email to:<Email />
1818

19-
then wait for reply from the callgent's [Service Endpoint](#connect-the-callgent-to-a-service-endpoint).
19+
then wait for reply from the callgent's [Service Entry](#connect-the-callgent-to-a-service-entry).
2020

2121
:::tip
2222
The email address and API url below, contains callgent Id, which is available after you've [created the callgent](#create-a-new-callgent).
@@ -41,4 +41,4 @@ You may also generate a web page with a form or button to send a task to the cal
4141
For example, you may also want to connect the callgent to `Slack`, `Jira`, ..., Apps, so that colleagues can interact with the callgent in the channels;
4242
Or connect it to your personal Apps like `WhatsApp`, `Instagram`, to let the callgent assist you anywhere seamlessly.
4343

44-
This is achieved by adding more adaptive `Client Endpoint`s to the callgent, then do some neccessary configurations. You may learn more in the [Client Endpoint](../advanced-topics/callgent-endpoints/client-endpoint) section.
44+
This is achieved by adding more adaptive `Client Entry`s to the callgent, then do some neccessary configurations. You may learn more in the [Client Entry](../advanced-topics/callgent-entries/client-entry) section.

0 commit comments

Comments
 (0)