AI API Design
Prompt
You are tasked with designing an API for artificial intelligence applications. This involves planning the architecture, endpoints, data handling, and usage scenarios. Consider the following steps and incorporate best practices in API development. # Steps 1. **Define API Purpose**: Clearly define what specific tasks the AI API will handle (e.g., image processing, language translation, data analysis). 2. **Design API Endpoints**: List and describe the key endpoints. Outline the methods (GET, POST, PUT, DELETE) and expected inputs/outputs. 3. **Authentication and Security**: Decide on a method for authenticating users (e.g., API keys, OAuth) and ensure secure data transmission (e.g., HTTPS). 4. **Data Format**: Define the data formats used for input and output (typically JSON) and detail how different data types are handled. 5. **Error Handling**: Implement standard error responses and document how errors are reported. 6. **Scalability and Performance**: Plan for scalability, including load balancing and performance monitoring. 7. **Documentation**: Develop comprehensive API documentation for users, including example requests and responses. # Output Format The output should be a detailed document outlining each aspect of the API design, complete with endpoint diagrams and pseudo-code examples. Ensure clarity and detail so that a developer could implement the API from your description. # Examples - **Purpose Example**: "The API will support real-time language translation with text inputs and outputs in JSON format." - **Endpoint Example**: "POST /translate - Accepts a JSON payload with { 'text': 'string', 'target_language': 'string' } and returns { 'translated_text': 'string' }" - **Error Handling**: "Return JSON { 'error_code': '400', 'message': 'Invalid language code' } for unsupported languages." # Notes - Consider edge cases such as rate limiting and user quotas. - Ensure compatibility with major programming languages for ease of integration.
Related Coding Prompts
Write Code
As a seasoned programmer, your task is to write code in [programming language] to [perform action]. The code should be efficient, well-structured, and optimized for performance. Make sure to follow best practices and industry standards while implementing the necessary algorithms and logic to achieve the desired functionality. Test the code thoroughly to ensure it functions as intended and meets all requirements. Additionally, document the code properly for future reference and maintenance.
Debug Code
Act as a seasoned programmer with over 20 years of commercial experience. Analyze the provided [piece of code] that is causing a specific [error]. Your task involves diagnosing the root cause of the error, understanding the context and functionality intended by the code, and proposing a solution to fix the issue. Your analysis should include a step-by-step walkthrough of the code, identification of any bugs or logical mistakes, and a detailed explanation of how to resolve them. Additionally, suggest any improvements or optimizations to enhance the performance, readability, or maintainability of the code based on your extensive experience. Ensure that your solution adheres to best practices in software development and is compatible with the current development environment where the code is being executed.
Do Code Review
As a seasoned programmer with over 20 years of commercial experience, your task is to perform a comprehensive code review on the provided [piece of code]. Your review should meticulously evaluate the code's efficiency, readability, and maintainability. You are expected to identify any potential bugs, security vulnerabilities, or performance issues and suggest specific improvements or optimizations. Additionally, assess the code's adherence to industry standards and best practices. Your feedback should be constructive and detailed, offering clear explanations and recommendations for changes. Where applicable, provide examples or references to support your suggestions. Your goal is to ensure that the code not only functions as intended but also meets high standards of quality and can be easily managed and scaled in the future. This review is an opportunity to mentor and guide less experienced developers, so your insights should be both educational and actionable.