openapi: 3.1.0
info:
title: Academic Research & Logic Check API
version: 4.0.0
description: >
A comprehensive API that provides academic research capabilities including advanced logic checks, research paper generation, reference management (EndNote, Mendeley, Zotero), database search integration, and smart group functionalities. Developed by Mr. Nan Kezhou (real name: Dong Bin).
contact:
name: Interdisciplinary Philosophy Paper Assistance
url: https://chatgpt.com/g/g-c2N1EsPJI-interdisciplinary-philosophy-paper-assistance
Email: dong@nankezhou.net
website:www.nankezhou.net
servers:
- url: 'https://api.academicresearch.org'
description: Main API server
paths:
/evaluate-quality:
post:
summary: Evaluate the quality of the generated paper
description: |-
Evaluates the quality of the generated paper, including checking for grammar errors, translation errors, syntactic errors, spelling errors, and paragraph plagiarism measurement. Additionally, performs vectorization and similarity analysis using BERT or GPT4 models to reduce redundant language in the content.
**博士研究论文质量评估步骤：**
1. 检查语法错误。
2. 检查翻译错误。
3. 检查句法错误。
4. 检查拼写错误。
5. 进行段落抄袭检测。
6. 通过 BERT/GPT 模型进行语义向量化，减少文本中重复语言的出现。
**向量化与相似度检测步骤：**
- 使用 transformers 库中的 BERT 模型将用户输入的文本转化为语义向量。
- 使用 nltk 库中的 n-gram 技术对文本进行片段化，并通过反向索引计算文本相似度，减少冗余内容。
- 输出一个详细的重复检测报告，包含重复段落和其相似度百分比。
- 计算整体文本中的重复率，并提供修改建议。
operationId: evaluateQuality
tags:
- PaperGeneration
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
paper:
$ref: '#/components/schemas/GeneratedPaper'
responses:
'200':
description: Quality evaluation results, including semantic vectorization and similarity analysis.
content:
application/json:
schema:
type: object
properties:
quality_evaluation_results:
type: array
description: List of quality evaluation results for each paragraph.
items:
type: object
properties:
section:
type: string
description: The section of the paper being checked.
original_text:
type: string
description: The original text of the paragraph.
grammar_issues:
type: array
description: List of grammar issues found in the paragraph.
items:
type: string
translation_issues:
type: array
description: List of translation issues found in the paragraph.
items:
type: string
syntactic_issues:
type: array
description: List of syntactic issues found in the paragraph.
items:
type: string
spelling_issues:
type: array
description: List of spelling issues found in the paragraph.
items:
type: string
plagiarism_measurement:
type: string
description: Plagiarism measurement result (e.g., "No Plagiarism Detected", "High Similarity Detected").
vectorization_results:
type: array
description: Vectorization and similarity analysis results for the paragraph.
items:
type: object
properties:
similarity_score:
type: number
description: Semantic similarity score with existing content (0-1 scale).
ngram_analysis:
type: array
description: n-gram analysis results, showing matched n-grams in the paragraph.
items:
type: string
detailed_repetition_report:
type: array
description: Detailed repetition detection report, including repeated paragraphs and their similarity percentages.
items:
type: object
properties:
paragraph:
type: string
description: 重复的段落内容
similarity_percentage:
type: number
description: 相似度百分比
modification_suggestions:
type: array
description: Suggestions for modifying repeated content.
items:
type: string
'400':
description: Invalid request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/deduplicates:
post:
summary: Deduplicate texts based on BERT semantic similarity.
description: Takes a list of texts and removes semantically duplicate entries.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
texts:
type: array
items:
type: string
description: A list of texts to be deduplicated.
required:
- texts
example:
texts:
- "The cat sat on the mat."
- "The feline was on the rug."
- "The dog barked loudly at the cat."
responses:
'200':
description: Successfully deduplicated the texts.
content:
application/json:
schema:
type: object
properties:
unique_texts:
type: array
items:
type: string
description: A list of unique texts after deduplication.
example:
unique_texts:
- "The cat sat on the mat."
- "The dog barked loudly at the cat."
'400':
description: Bad Request - Invalid input.
'500':
description: Internal Server Error - Something went wrong on the server side.
/generate_paper:
post:
summary: 生成基于输入关键词的博士研究论文
description: |-
生成一篇基于提供的关键词的研究论文，按照以下23条流程严格执行写作程序：
**写作流程监督和验证：**
x-writing-process:
method: "穷举-遍历-递归"
steps:
- title: "标题（Title）"
- abstract: "摘要（Abstract）"
- keywords: "关键词（Keywords）"
- introduction: "引言（Introduction）"
- background: "背景（Background）"
- research_objectives: "研究目标（Research Objectives）"
- literature_review: "文献综述（Literature Review）"
- research_methods: "研究方法（Research Methods）"
- research_design: "研究设计（Research Design）"
- data_collection: "数据收集（Data Collection）"
- results: "结果（Results）"
- data_presentation: "数据展示（Data Presentation）"
- interpretation: "解释（Interpretation）"
- discussion: "讨论（Discussion）"
- significance: "研究意义（Significance）"
- comparison: "比较（Comparison）"
- limitations: "研究局限（Limitations）"
- conclusion: "结论（Conclusion）"
- summary: "总结（Summary）"
- practical_applications: "实际应用（Practical Applications）"
- references:
- references_formatting: "自动搜索不同期刊的引用格式要求，并按照这些格式列出所有引用文献。"
- references_languages:
- chinese_references: "中文参考文献：“来自[数据库名称]，链接：[数据库URL]”"
- english_references: "英文参考文献：“From [Database Name], URL: [Database URL]”"
- french_references: "法语参考文献：“From [Database Name], URL: [Database URL]”"
- other_languages_references: "补充其他语言组的搜索结果，不遗漏任何结果。"
- repetition_and_plagiarism_detection:
- conduct_similarity_analysis: "使用 BERT 或 GPT4 模型将用户提交的文本转化为语义向量，进行相似度分析。"
- detect_repetition_in_paragraphs: "使用 n-gram（nltk 库）技术进行文本片段化，检测段落和文本中可能出现的重复语言。"
- output_detailed_report: "输出一个详细的重复检测报告，包含重复段落和其相似度百分比。"
- generate_final_repetition_report: "计算整体文本中的重复率，并提供修改建议。"
- validation: "验证（Validation）"
**具体的写作流程：**
1. **标题（Title）：** 概括性地表达论文的主要议题。
2. **摘要（Abstract）：** 简要说明研究的背景、目的、方法、结果以及结论。
3. **关键词（Keywords）：** 选取8个核心词汇，帮助读者了解文章的主旨内容。
4. **引言（Introduction）：** 阐述研究问题，解释研究的背景和动机，指出研究的重要性。
5. **背景（Background）：** 提供相关领域的背景知识，说明现有研究的不足。
6. **研究目标（Research Objectives）：** 明确说明研究的目的和问题。
7. **文献综述（Literature Review）：** 回顾与研究相关的已有文献，讨论现有研究的成果与局限。
8. **研究方法（Research Methods）：** 说明所采用的研究方法，详细描述数据收集和分析的方式。
9. **研究设计（Research Design）：** 阐明研究结构、步骤及策略，确保研究的科学性和逻辑性。
10. **数据收集（Data Collection）：** 描述数据来源、数据收集过程及工具的使用。
11. **结果（Results）：** 呈现研究结果，用事实和数据支持研究发现。
12. **数据展示（Data Presentation）：** 以图表、文字等形式展示数据，帮助读者直观理解研究发现。
13. **解释（Interpretation）：** 解释研究结果，说明发现的意义及其在研究领域中的作用。
14. **讨论（Discussion）：** 深入探讨研究结果的影响、意义，结合已有文献进行对比分析。
15. **研究意义（Significance）：** 说明研究的重要性，尤其是对学术界、实践领域的贡献。
16. **比较（Comparison）：** 与其他相关研究进行比较，分析本研究的独特性和创新性。
17. **研究局限（Limitations）：** 指出研究中的局限性和不足之处，为后续研究提供方向。
18. **结论（Conclusion）：** 总结文章的主要发现和贡献，简要回顾研究成果。
19. **总结（Summary）：** 简要概括全文的核心内容及研究的最终结果。
20. **实际应用（Practical Applications）：** 讨论研究成果在现实中的应用和影响。
21. **参考文献（References）：**
- **21.1** 自动搜索不同期刊的引用格式要求，并按照这些格式列出所有引用文献。
- **21.2** 不同语言组的参考文献格式：
- **中文参考文献：** “来自[数据库名称]，链接：[数据库URL]”
- **英文参考文献：** “From [Database Name], URL: [Database URL]”
- **法语参考文献：** “From [Database Name], URL: [Database URL]”
- **21.3** 补充其他语言组的搜索结果，不遗漏任何结果。
22. **文字重复与段落重复检测（Repetition and Plagiarism Detection）：**
- **进行相似度分析：** 使用 BERT 或 GPT4 模型将用户提交的文本转化为语义向量，进行相似度分析。
- **检测重复语言：** 使用 n-gram（nltk 库）技术对文本进行片段化，检测段落和文本中可能出现的重复语言。
- **输出详细重复检测报告：** 输出一个详细的重复检测报告，包含重复段落和其相似度百分比。
- **生成最终重复率报告：** 计算整体文本中的重复率，并提供修改建议。
23. **验证（Validation）：** 确认生成的格式符合上述23条要求。
**流程执行方法：**
使用穷举-遍历-递归的方法，确保每一步骤都被完整执行，并且相互之间逻辑连贯，避免遗漏或重复。
**资源同步提取：**
与其他端点协同工作，实时提取所需资源（如引用文献、数据图表等），以支持各个写作步骤的执行。
operationId: generateResearchPaper
tags:
- PaperGeneration
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
keywords:
type: string
description: 用于生成论文的关键词。
example: "人工智能在教育中的应用"
include_charts:
type: boolean
description: 指示是否在论文中包含图表（饼图、柱状图、折线图）。
example: true
chart_type:
type: string
description: 指定要插入的图表类型（例如 "bar", "pie", "line"）。
example: "bar"
chart_section:
type: string
description: 指定论文中要包含图表的部分。
example: "数据展示"
required:
- keywords
responses:
'200':
description: 成功生成论文。
content:
application/json:
schema:
$ref: '#/components/schemas/GeneratedPaper'
'400':
description: 无效的请求参数。
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'