BeeBee.AI
BeeBee.AI · Acciones GPT
Earnings Call Transcript Plugin
A plugin that allows the user ask questions about earning using ChatGPT. If you do not know the user's username, ask them first before making queries to the plugin. Otherwise, use the username "global".
GET /ecall_qa/queryByEIDGet the answer to a query about an Earning Calls Transcript. Use this to find data that could not be found in summaries.GET /ecall_qa/chat_report_file_sGet the answer to a query about a Financial Report. Use this to find data that could not be found in summaries.GET /company/report_file_listSearch financial reports by Company IDGET /company/search_ecallSearch earning call transcripts by Company IDGET /company/searchSearch Company IDs by keywordsGET /company/top_companyGet the top companies for 3 different categories, Competitive companies, Controversial Companies, and Influencial CEOs
Esquema original API
{
"openapi": "3.0.1",
"info": {
"title": "Earnings Call Transcript Plugin",
"description": "A plugin that allows the user ask questions about earning using ChatGPT. If you do not know the user's username, ask them first before making queries to the plugin. Otherwise, use the username \"global\".",
"version": "v1"
},
"servers": [
{
"url": "https://beebeeplugin.azurewebsites.net"
}
],
"paths": {
"/ecall_qa/queryByEID": {
"get": {
"operationId": "queryByEID",
"summary": "Get the answer to a query about an Earning Calls Transcript. Use this to find data that could not be found in summaries.",
"parameters": [
{
"in": "query",
"name": "eid",
"schema": {
"type": "integer"
},
"required": true,
"description": "The ID of the earnings call transcript that the query will be about"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"required": true,
"description": "A query regarding an earnings call transcript"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/queryByEIDResponse"
}
}
}
}
}
}
},
"/ecall_qa/chat_report_file_s": {
"get": {
"operationId": "queryByFinancialReport",
"summary": "Get the answer to a query about a Financial Report. Use this to find data that could not be found in summaries.",
"parameters": [
{
"in": "query",
"name": "fid",
"schema": {
"type": "integer"
},
"required": true,
"description": "The ID of the Financial Report that the query will be about"
},
{
"in": "query",
"name": "q",
"schema": {
"type": "string"
},
"required": true,
"description": "A query regarding a financial report"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/queryByFinancialReportsResponse"
}
}
}
}
}
}
},
"/company/report_file_list": {
"get": {
"operationId": "searchFinancialReports",
"summary": "Search financial reports by Company ID",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Company ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"description": "Number of pages to be displayed. Best use is 1.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of results per page.",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/serachFinancialReportsResponse"
}
}
}
}
}
}
},
"/company/search_ecall": {
"get": {
"operationId": "searchEarningCall",
"summary": "Search earning call transcripts by Company ID",
"parameters": [
{
"name": "cid",
"in": "query",
"description": "Company ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "abstract",
"in": "query",
"description": "Whether to return summarized results.",
"required": true,
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
},
{
"name": "page",
"in": "query",
"description": "Number of pages to be displayed. Best use is 1.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of results per page.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "year",
"in": "query",
"description": "The year from which the financial document was from",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "quarter",
"in": "query",
"description": "The specified quarter related to the financial document",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchEarningCallResponse"
}
}
}
}
}
}
},
"/company/search": {
"get": {
"operationId": "searchCompany",
"summary": "Search Company IDs by keywords",
"parameters": [
{
"name": "keywords",
"in": "query",
"description": "Search keywords. Stock codes can be used here.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Number of pages to be displayed. Reccomended value is 1.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "pageSize",
"in": "query",
"description": "Number of results per page.",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/searchCompanyResponse"
}
}
}
}
}
}
},
"/company/top_company": {
"get": {
"operationId": "getTopCompanies",
"summary": "Get the top companies for 3 different categories, Competitive companies, Controversial Companies, and Influencial CEOs",
"parameters": [
{
"name": "listid",
"in": "query",
"description": "Chooese 1 for competitive companites, 2 for controversial companies, 3 for influential CEOs. Do not pick any integer other than these three",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "num",
"in": "query",
"description": "Number of top companies to query for. Default value is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getTopCompaniesResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"serachFinancialReportsResponse": {
"type": "object",
"properties": {
"EXTRA_INFORMATION_TO_GPT": {
"type": "string",
"description": "A short paragraph describing important instructions to the model that must be followed."
},
"code": {
"type": "integer",
"description": "0 indicates a successful response, every other value means an invalid response"
},
"message": {
"type": "string",
"description": "A small message describing the result"
},
"data": {
"type": "array",
"items": {
"type": "object",
"description": "A financial report object containing financial report data.",
"properties": {
"id": {
"type": "integer",
"description": "The ID of this financial report"
},
"cid": {
"type": "integer",
"description": "The company id this financial report is associated with"
},
"company_name": {
"type": "string",
"description": "The name of the company this financial report is from"
},
"year": {
"type": "integer",
"description": "The year this financial report is from."
},
"quarter": {
"type": "integer",
"description": "The fiscal quarter this financial report is from"
},
"file_ext": {
"type": "string",
"description": "The file extension of the financial report"
},
"type": {
"type": "string",
"description": "The type of financial report, like 10-K, 10-Q"
},
"filing_date": {
"type": "string",
"description": "The date this report was filed."
},
"reporting_date": {
"type": "string",
"description": "The date this report was reported."
},
"url": {
"type": "string",
"description": "The URL to the source earning call transcript."
}
}
},
"description": "A list of financial report objects, each containing fincancial report data"
}
}
},
"queryByFinancialReportsResponse": {
"type": "object",
"properties": {
"EXTRA_INFORMATION_TO_GPT": {
"type": "string",
"description": "A short paragraph describing important instructions to the model that must be followed."
},
"code": {
"type": "integer",
"description": "0 indicates a successful response, every other value means an invalid response"
},
"message": {
"type": "string",
"description": "A small message describing the result"
},
"data": {
"type": "object",
"description": "Object containing response data",
"properties": {
"answer": {
"type": "string",
"description": "The answer to a query"
}
}
}
}
},
"queryByEIDResponse": {
"type": "object",
"properties": {
"EXTRA_INFORMATION_TO_GPT": {
"type": "string",
"description": "A short paragraph describing important instructions to the model that must be followed."
},
"code": {
"type": "integer",
"description": "0 indicates a successful response, every other value means an invalid response"
},
"message": {
"type": "string",
"description": "A small message describing the result"
},
"data": {
"type": "object",
"description": "Object containing response data",
"properties": {
"answer": {
"type": "string",
"description": "The answer to a query"
},
"ectqa_remain": {
"type": "string",
"description": "Remaining answers, can be ignored"
}
}
}
}
},
"searchEarningCallResponse": {
"type": "object",
"properties": {
"EXTRA_INFORMATION_TO_GPT": {
"type": "string",
"description": "A short paragraph describing important instructions to the model that must be followed."
},
"code": {
"type": "integer",
"description": "0 indicates a successful response, every other value means an invalid response"
},
"message": {
"type": "string",
"description": "A small message describing the result"
},
"data": {
"type": "array",
"items": {
"type": "object",
"description": "An object containing ECT data.",
"properties": {
"id": {
"type": "integer",
"description": "The EID of this earnings call transcript"
},
"cid": {
"type": "integer",
"description": "The CID this earnings call transcript is associated with"
},
"date": {
"type": "string",
"description": "The date this transcript was created"
},
"title": {
"type": "string",
"description": "The title of the earning call transcript"
},
"abstract": {
"type": "string",
"description": "A summary of the earning call transcript"
},
"url": {
"type": "string",
"description": "The URL to the source earning call transcript."
}
}
},
"description": "A list of ECT objects, each containing ECT data"
}
}
},
"searchCompanyResponse": {
"type": "object",
"properties": {
"EXTRA_INFORMATION_TO_GPT": {
"type": "string",
"description": "A short paragraph describing important instructions to the model that must be followed."
},
"code": {
"type": "integer",
"description": "0 indicates a successful response, every other value means an invalid response"
},
"message": {
"type": "string",
"description": "A small message describing the result"
},
"data": {
"type": "array",
"items": {
"type": "object",
"description": "Object containing company data",
"properties": {
"id": {
"type": "integer",
"description": "The CID of the company"
},
"company_name": {
"type": "string",
"description": "The name of the company"
},
"code": {
"type": "string",
"description": "stock code"
},
"type": {
"type": "string",
"description": "Values can be 1. US stocks; 2. Chinese concept stocks"
},
"initial": {
"type": "string",
"description": "The first letter of the company pinyin"
}
}
},
"description": "A list of Company objects, each containing company data."
}
}
},
"getTopCompaniesResponse": {
"type": "object",
"properties": {
"EXTRA_INFORMATION_TO_GPT": {
"type": "string",
"description": "A short paragraph describing important instructions to the model that must be followed."
},
"code": {
"type": "integer",
"description": "0 indicates a successful response, every other value means an invalid response"
},
"message": {
"type": "string",
"description": "A small message describing the result"
},
"data": {
"type": "array",
"items": {
"type": "object",
"description": "Object containing company data",
"properties": {
"ranking": {
"type": "integer",
"description": "The company's ranking in the category selected"
},
"cid": {
"type": "integer",
"description": "The company's company ID"
},
"ceo": {
"type": "string",
"description": "The name of the CEO for the company"
},
"ranking_inc": {
"type": "integer",
"description": "How many places the ranking for the company has risen in the past day"
},
"total_score": {
"type": "string",
"description": "A score made by an AI describing how well the company scores in totality. This is returned if competitive companies are asked for"
},
"score": {
"type": "string",
"description": "A score made by an AI describing how well the company scores in the category selected"
},
"conflict_value": {
"type": "integer",
"description": "A rating describing how controversial a company is"
},
"praise": {
"type": "integer",
"description": "The number of users who have voted to praise this company on BeeBee.ai"
},
"comment": {
"type": "integer",
"description": "The number of users who have commented on this company on BeeBee.ai"
}
}
},
"description": "A list of Company objects, each containing company data."
}
}
}
}
}
}