Enterprise Tools
Last updated：2024-02-20
Enterprise Tools
Here, you can manage the Tools you have created.
Create Tool
You can create a Tool and access external data through the Tool.
Authentication
Here, you can configure the authentication method for the Tool.
- Developer Authentication: The Tool is authenticated by the developer of the Tool. Tools authenticated by the developer can be added and integrated into the Bot by other organizations.
- Integrator Authentication: The Tool is authenticated by the administrator of the organization that needs to integrate the Tool. After the authentication is passed, the Tool can be added to the organization.
At the same time, you can also configure whether the Tool is "charged". If you choose "in-site payment", you can set a credit charge value. If the Bot of another organization calls this Tool, then each time the Tool is called, the organization will pay you that number of credits.
Params Config
You can configure the plugin parameters in the JSON configuration area.
{
"openapi": "3.0.0",
"servers": [
{
"url": "Requested domain name, must be in URL format. e.g. https://restapi.amap.com"
}
],
"paths": {
"/api/custom/path": {
"get": {
"operationId": "Required. Name of API, can be composed of English and underscores, no spaces are allowed. e.g. getAdCode, get_Ad_Code"
"description": "Required. Clear description of the API's function, the LLM will determine the timing of calling the API. 200 characters limited."
"parameters": [
{
"name": "Required. Name of parameter field. e.g. key",
"in": "Position of parameter. Supported: path/query (parameters appended after the url)/header (custom request headers used in the request)/cookie",
"description":"Required. Clear description of parameters' meaning. 200 characters limited."
"required": true,
"schema": {
"type": "Type of field. Supported: integer/number/string/boolean",
"default": "Default value of parameter
. e.g. e1a791daabb6b8d2bc8cb22633e37"
}
}
],
"responses": {
"200": {
"description": "Description of responses",
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Authentication failed"
}
}
}
},
"post": {
"operationId": "Required. Name of API, can be composed of English and underscores, no spaces are allowed. e.g. createUser",
"description":"Required. Clear description of the API's function, the LLM will determine the timing of calling the API. 200 characters limited."
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"responses": {
"200": {
"description": "User created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "Reference. e.g. #/components/schemas/User"
}
}
}
},
"400": {
"description": "Invalid request"
}
}
}
,
"components": {
"schemas": {
"User": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
}
},
"required": ["name", "email"]
}
}
}
}
}
{
"openapi": "3.0.0",
"servers": [
{
"url": "Requested domain name, must be in URL format. e.g. https://restapi.amap.com"
}
],
"paths": {
"/api/custom/path": {
"get": {
"operationId": "Required. Name of API, can be composed of English and underscores, no spaces are allowed. e.g. getAdCode, get_Ad_Code"
"description": "Required. Clear description of the API's function, the LLM will determine the timing of calling the API. 200 characters limited."
"parameters": [
{
"name": "Required. Name of parameter field. e.g. key",
"in": "Position of parameter. Supported: path/query (parameters appended after the url)/header (custom request headers used in the request)/cookie",
"description":"Required. Clear description of parameters' meaning. 200 characters limited."
"required": true,
"schema": {
"type": "Type of field. Supported: integer/number/string/boolean",
"default": "Default value of parameter
. e.g. e1a791daabb6b8d2bc8cb22633e37"
}
}
],
"responses": {
"200": {
"description": "Description of responses",
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Authentication failed"
}
}
}
},
"post": {
"operationId": "Required. Name of API, can be composed of English and underscores, no spaces are allowed. e.g. createUser",
"description":"Required. Clear description of the API's function, the LLM will determine the timing of calling the API. 200 characters limited."
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"responses": {
"200": {
"description": "User created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "Reference. e.g. #/components/schemas/User"
}
}
}
},
"400": {
"description": "Invalid request"
}
}
}
,
"components": {
"schemas": {
"User": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
}
},
"required": ["name", "email"]
}
}
}
}
}
This code block in the floating window
Example: Google Search
This tool can perform Google searches according to user requests and obtain search results.
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://www.googleapis.com"
}
],
"paths": {
"/customsearch/v1": {
"get": {
"description": "A wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query.",
"operationId": "GoogleSearch",
"parameters": [
{
"name": "q",
"in": "query",
"description": "Queried questions.",
"required": true,
"schema": {
"type": "string",
"default": "question"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Authentication failed"
}
}
}
}
}
}
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://www.googleapis.com"
}
],
"paths": {
"/customsearch/v1": {
"get": {
"description": "A wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query.",
"operationId": "GoogleSearch",
"parameters": [
{
"name": "q",
"in": "query",
"description": "Queried questions.",
"required": true,
"schema": {
"type": "string",
"default": "question"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"*/*": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Authentication failed"
}
}
}
}
}
}
This code block in the floating window
Example: WeatherWhiz
This tool can query the weather info of a specific location.
{
"openapi": "3.0.2",
"info": {
"title": "WeatherWhiz",
"description": "Get weather information for a given location and time option.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://redantai.pythonanywhere.com/"
}
],
"paths": {
"/weather/": {
"get": {
"operationId": "getWeatherByLocation",
"description": "Get weather information for a given location and time option.）",
"parameters": [
{
"in": "query",
"name": "location",
"schema": {
"type": "string"
},
"required": true,
"description": "The location for which to get the weather information"
},
{
"in": "query",
"name": "time",
"schema": {
"type": "string"
},
"required": true,
"description": "The time option for the weather forecast ('current', 'minutely', 'hourly', 'daily')"
}
],
"responses": {
"200": {
"description": "A JSON object containing weather information for the specified location and time option"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Invalid input. Please provide a valid location and time option."
}
}
}
}
}
}
}
}
}
}
}
{
"openapi": "3.0.2",
"info": {
"title": "WeatherWhiz",
"description": "Get weather information for a given location and time option.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://redantai.pythonanywhere.com/"
}
],
"paths": {
"/weather/": {
"get": {
"operationId": "getWeatherByLocation",
"description": "Get weather information for a given location and time option.）",
"parameters": [
{
"in": "query",
"name": "location",
"schema": {
"type": "string"
},
"required": true,
"description": "The location for which to get the weather information"
},
{
"in": "query",
"name": "time",
"schema": {
"type": "string"
},
"required": true,
"description": "The time option for the weather forecast ('current', 'minutely', 'hourly', 'daily')"
}
],
"responses": {
"200": {
"description": "A JSON object containing weather information for the specified location and time option"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Invalid input. Please provide a valid location and time option."
}
}
}
}
}
}
}
}
}
}
}
This code block in the floating window
Example: PortfoliosLab
This tool can call the services of PortfoliosLab, and query stock market data of stocks, ETFs, and funds through the company name.
{
"openapi": "3.0.0",
"info": {
"title": "PortfoliosLab API",
"description": "API to get financial information about ETFs.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://portfolioslab.com/api"
}
],
"paths": {
"/symbol/{symbol}": {
"get": {
"operationId": "getSymbol",
"summary": "Get information about a specific symbol.",
"description": "Get information about a specific symbol.Retrieves detailed information about the ETF, stock, mutual fund, index, or crypto currency specified by its symbol name.",
"parameters": [
{
"in": "path",
"name": "symbol",
"schema": {
"type": "string"
},
"required": true,
"description": "The symbol name (e.g., VTI, AAPL, BTC-USD)."
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Symbol"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Symbol": {
"type": "object",
"properties": {
"cusip": {
"type": "string",
"example": "922908769"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2022-06-07T07:56:40.798Z"
},
"description": {
"type": "string",
"example": "VTI is an exchange-traded fund (ETF) that tracks the performance of the CRSP US Total Market Index. ..."
},
"type": {
"type": "string",
"example": "ETF"
},
"indicators": {
"$ref": "#/components/schemas/Indicators"
},
"full_name": {
"type": "string",
"example": "Vanguard Total Stock Market ETF"
},
"name": {
"type": "string",
"example": "VTI"
},
"alternatives": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SPY",
"VT",
"VOO",
"ITOT",
"SPHD",
"SPTM",
"VWO",
"VXUS"
]
},
"currency": {
"type": "string",
"example": "USD"
},
"exchange": {
"type": "string",
"nullable": true
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2023-05-03T10:32:37.717737"
},
"isin": {
"type": "string",
"example": "US9229087690"
},
"info": {
"$ref": "#/components/schemas/Info"
}
}
},
"Indicators": {
"type": "object",
"properties": {
"return5Y": {
"type": "number",
"format": "float",
"example": 0.1033,
"description": "The 5-year annualized return of the symbol."
},
"return10Y": {
"type": "number",
"format": "float",
"example": 0.1139,
"description": "The 10-year annualized return of the symbol."
},
"maxDrawdown": {
"type": "number",
"format": "float",
"example": -0.5545,
"description": "The maximum drawdown of the symbol."
},
"return1Y": {
"type": "number",
"format": "float",
"example": 0.0015,
"description": "The 1-year annualized return of the symbol."
},
"dividendYield": {
"type": "number",
"format": "float",
"example": 0.0195,
"description": "The dividend yield of the symbol."
},
"volatility10Y": {
"type": "number",
"format": "float",
"example": 0.1786,
"description": "The 10-year annualized volatility of the symbol."
},
"volatility1Y": {
"type": "number",
"format": "float",
"example": 0.2298,
"description": "The 1-year annualized volatility of the symbol."
},
"returnYTD": {
"type": "number",
"format": "float",
"example": 0.0696,
"description": "The year-to-date return of the symbol."
},
"volatility5Y": {
"type": "number",
"format": "float",
"example": 0.219,
"description": "The 5-year annualized volatility of the symbol."
},
"sharpe": {
"type": "number",
"format": "float",
"example": 0.0063,
"description": "The Sharpe ratio of the symbol."
},
"ulcerIndex": {
"type": "number",
"format": "float",
"example": 0.0861,
"description": "The Ulcer Index of the symbol."
},
"calmar": {
"type": "number",
"format": "float",
"example": 0.0087,
"description": "The Calmar ratio of the symbol."
},
"omega": {
"type": "number",
"format": "float",
"example": 1.0023,
"description": "The Omega ratio of the symbol."
},
"sortino": {
"type": "number",
"format": "float",
"example": 0.0198,
"description": "The Sortino ratio of the symbol."
}
}
},
"Info": {
"type": "object",
"properties": {
"asset_class": {
"type": "string",
"example": "Equity"
},
"inception": {
"type": "string",
"format": "date",
"example": "2001-05-24"
},
"asset_class_style": {
"type": "string",
"example": "Blend"
},
"issuer": {
"type": "string",
"example": "Vanguard"
},
"structure": {
"type": "string",
"example": "ETF"
},
"asset_class_size": {
"type": "string",
"example": "Large-Cap"
},
"home_page": {
"type": "string",
"example": "https://advisors.vanguard.com/investments/products/VTI"
},
"issuer_slug": {
"type": "string",
"example": "vanguard"
},
"expense_ratio": {
"type": "string",
"example": "0.03"
},
"region_general": {
"type": "string",
"example": "North America"
},
"asset_class_slug": {
"type": "string",
"example": "equity"
},
"index_tracked": {
"type": "string",
"example": "CRSP US Total Market Index"
},
"region_specific": {
"type": "string",
"example": "U.S."
},
"category": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Large Cap Growth Equities"
]
},
"category_slug": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"large-cap-growth-equities"
]
}
}
}
}
}
}
{
"openapi": "3.0.0",
"info": {
"title": "PortfoliosLab API",
"description": "API to get financial information about ETFs.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://portfolioslab.com/api"
}
],
"paths": {
"/symbol/{symbol}": {
"get": {
"operationId": "getSymbol",
"summary": "Get information about a specific symbol.",
"description": "Get information about a specific symbol.Retrieves detailed information about the ETF, stock, mutual fund, index, or crypto currency specified by its symbol name.",
"parameters": [
{
"in": "path",
"name": "symbol",
"schema": {
"type": "string"
},
"required": true,
"description": "The symbol name (e.g., VTI, AAPL, BTC-USD)."
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Symbol"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Symbol": {
"type": "object",
"properties": {
"cusip": {
"type": "string",
"example": "922908769"
},
"created": {
"type": "string",
"format": "date-time",
"example": "2022-06-07T07:56:40.798Z"
},
"description": {
"type": "string",
"example": "VTI is an exchange-traded fund (ETF) that tracks the performance of the CRSP US Total Market Index. ..."
},
"type": {
"type": "string",
"example": "ETF"
},
"indicators": {
"$ref": "#/components/schemas/Indicators"
},
"full_name": {
"type": "string",
"example": "Vanguard Total Stock Market ETF"
},
"name": {
"type": "string",
"example": "VTI"
},
"alternatives": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"SPY",
"VT",
"VOO",
"ITOT",
"SPHD",
"SPTM",
"VWO",
"VXUS"
]
},
"currency": {
"type": "string",
"example": "USD"
},
"exchange": {
"type": "string",
"nullable": true
},
"updated": {
"type": "string",
"format": "date-time",
"example": "2023-05-03T10:32:37.717737"
},
"isin": {
"type": "string",
"example": "US9229087690"
},
"info": {
"$ref": "#/components/schemas/Info"
}
}
},
"Indicators": {
"type": "object",
"properties": {
"return5Y": {
"type": "number",
"format": "float",
"example": 0.1033,
"description": "The 5-year annualized return of the symbol."
},
"return10Y": {
"type": "number",
"format": "float",
"example": 0.1139,
"description": "The 10-year annualized return of the symbol."
},
"maxDrawdown": {
"type": "number",
"format": "float",
"example": -0.5545,
"description": "The maximum drawdown of the symbol."
},
"return1Y": {
"type": "number",
"format": "float",
"example": 0.0015,
"description": "The 1-year annualized return of the symbol."
},
"dividendYield": {
"type": "number",
"format": "float",
"example": 0.0195,
"description": "The dividend yield of the symbol."
},
"volatility10Y": {
"type": "number",
"format": "float",
"example": 0.1786,
"description": "The 10-year annualized volatility of the symbol."
},
"volatility1Y": {
"type": "number",
"format": "float",
"example": 0.2298,
"description": "The 1-year annualized volatility of the symbol."
},
"returnYTD": {
"type": "number",
"format": "float",
"example": 0.0696,
"description": "The year-to-date return of the symbol."
},
"volatility5Y": {
"type": "number",
"format": "float",
"example": 0.219,
"description": "The 5-year annualized volatility of the symbol."
},
"sharpe": {
"type": "number",
"format": "float",
"example": 0.0063,
"description": "The Sharpe ratio of the symbol."
},
"ulcerIndex": {
"type": "number",
"format": "float",
"example": 0.0861,
"description": "The Ulcer Index of the symbol."
},
"calmar": {
"type": "number",
"format": "float",
"example": 0.0087,
"description": "The Calmar ratio of the symbol."
},
"omega": {
"type": "number",
"format": "float",
"example": 1.0023,
"description": "The Omega ratio of the symbol."
},
"sortino": {
"type": "number",
"format": "float",
"example": 0.0198,
"description": "The Sortino ratio of the symbol."
}
}
},
"Info": {
"type": "object",
"properties": {
"asset_class": {
"type": "string",
"example": "Equity"
},
"inception": {
"type": "string",
"format": "date",
"example": "2001-05-24"
},
"asset_class_style": {
"type": "string",
"example": "Blend"
},
"issuer": {
"type": "string",
"example": "Vanguard"
},
"structure": {
"type": "string",
"example": "ETF"
},
"asset_class_size": {
"type": "string",
"example": "Large-Cap"
},
"home_page": {
"type": "string",
"example": "https://advisors.vanguard.com/investments/products/VTI"
},
"issuer_slug": {
"type": "string",
"example": "vanguard"
},
"expense_ratio": {
"type": "string",
"example": "0.03"
},
"region_general": {
"type": "string",
"example": "North America"
},
"asset_class_slug": {
"type": "string",
"example": "equity"
},
"index_tracked": {
"type": "string",
"example": "CRSP US Total Market Index"
},
"region_specific": {
"type": "string",
"example": "U.S."
},
"category": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Large Cap Growth Equities"
]
},
"category_slug": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"large-cap-growth-equities"
]
}
}
}
}
}
}
This code block in the floating window