specification

Specification Repository

This repository hosts various technical specifications and documentation for reference and implementation guidance.

Chat Completions API

The Chat Completions API Specification provides detailed guidelines for implementing a chat completions API that supports both regular invocations and streaming responses.

Key features:

• JSON and SSE streaming formats
• Request and response format examples
• Error handling guidelines
• Client and server implementation examples
• Strictly follows RPC (Remote Procedure Call) Specification, which is compatible with MCP (Model Context Protocol). Refer to https://spec.modelcontextprotocol.io for details

MCP Workflow and Sampling

The Understanding MCP Sampling is almost like a missing doc from the MCP official site. This doc should well explain MCP Sampling, which DOES NOT mean “Sampling Data” at all!

MCP Sampling is to implement a sampleHandler callback function, which can be called by the MCP Server. Since the callback function is on the client side, the client side can call a LLM via HTTP REST requests, or you can ask a user to approve an action.

Chat Completion Integration (Draft)

• Flux - Reactor - Spring Web Flux
• Flux - Reactor - Java Reactive Concurrency Guide
• LlmClient - Draft Design Spec
• Redis Pub Sub With Reactor

AWS Bedrock Provider Implementation Solution (Draft)

• AWS Bedrock Lambda Proxy
• AWS Bedrock Lambda Proxy - Customer Usage Tracking

Embedding and Vector Storage (Draft)

• Diagnostics Util
• Vector Storage

Cheat Sheet

• Cheat Sheet - Java Stream API
• Cheat Sheet - Apache Lucene 9.8

Other

• Confusing Terminologies

License

This project is licensed under the MIT License - see the LICENSE file for details.

This site is open source. Improve this page.