polly3d/mockai

MockAI is a mock server for OpenAI's API. It allows you to simulate Chat Completions API responses for development and testing purposes.

MockAI

MockAI is a mock server for OpenAI's API. It allows you to simulate API responses for development and testing purposes.

Features

• Supports the following endpoint.

  • /v1/completions
  • /v1/chat/completions
  • /v1/images/generations

• Allows you to specify the type of mock response: echo, random, or fixed.

• Supports both single responses and streaming responses.

• Reads random responses from a text file.

Getting Started

1. Install dependencies:

npm install

2. Set env

Open .env file and set your environment.

SERVER_PORT=5002
MOCK_TYPE=random
MOCK_FILE_PATH=data/contents.txt
MOCK_FILE_SEPERATER="@@@@"

3. Start server:

npm start

Environment Variables

• SERVER_PORT: The port the server listens on.
• DEFAULT_MOCK_TYPE: The default type of mock response.
• MOCK_FILE_PATH: The path to the text file of random responses.
• MOCK_FILE_SEPERATER: Random contents seperater. As there may be instances of line breaks or code outputs, it is not advisable to separate with line breaks.

Contributing

Contributions are welcome! Please submit a pull request or create an issue to get started.

mockai's Issues

Implement Network Latency Simulation

Overview

The purpose of this issue is to implement network latency simulation in the MockAI server to enhance testing capabilities by mimicking real-world network conditions.

Goals

• Introduce a way to simulate minimum and maximum network delays.
• Ensure that all API endpoints can receive and process the delay parameters.
• Test the functionality to ensure it accurately reflects the specified network latencies.

Tasks

• Update the README.md to include documentation on how to use the network latency simulation.
• Modify the chat.js, embeddings.js, image.js, and text.js files to process the new minMsDelay and maxMsDelay parameters.
• Implement a function to randomly generate delay times within the specified range.

Expected Impact

This feature will allow developers to better understand how their applications behave under various network conditions, leading to more robust and resilient systems.

Unable to Push Branches - Requesting Clarification on Contribution Guidelines

Issue Description

Hello! First off, I want to express how much I appreciate the project. The tools and features you have developed are very useful and I am keen to contribute. However, I have encountered a permission issue when trying to push branches.

Steps to Reproduce

1. Attempted to push a new branch with the following command:

   git push origin feature/branch-name

2. Received the following error:

   remote: Permission to polly3d/mockai.git denied to [your_username].
   fatal: unable to access 'https://github.com/polly3d/mockai.git/': The requested URL returned error: 403

Questions

• Are external contributors allowed to push branches directly or should we fork the repository?
• Are there any specific contribution guidelines or protocols that I should follow?

Thank you for your attention to this matter.

help: please add LICENSE to your github repo

Please add license of your choice that describes the permission of usage. Thanks. <3