Package org.springframework.ai.moonshot.api

Class MoonshotApi

java.lang.Object

org.springframework.ai.moonshot.api.MoonshotApi

public class MoonshotApi
extends Object

Single-class, Java Client library for Moonshot platform. Provides implementation for the Chat Completion APIs.

Implements Synchronous and Streaming chat completion.

Author:

Geng Rong, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MoonshotApi.ChatCompletion	Represents a chat completion response returned by model, based on the provided input.
static final record	MoonshotApi.ChatCompletionChunk	Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
static enum	MoonshotApi.ChatCompletionFinishReason	The reason the model stopped generating tokens.
static final record	MoonshotApi.ChatCompletionMessage	Message comprising the conversation.
static final record	MoonshotApi.ChatCompletionRequest	Creates a model response for the given chat conversation.
static enum	MoonshotApi.ChatModel	Moonshot Chat Completion Models: MOONSHOT_V1_8K - moonshot-v1-8k MOONSHOT_V1_32K - moonshot-v1-32k MOONSHOT_V1_128K - moonshot-v1-128k
static final record	MoonshotApi.FunctionTool	Represents a tool the model may call.
static final record	MoonshotApi.Usage	Usage statistics.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHAT_MODEL

Constructor Summary

Constructors

Constructor	Description
MoonshotApi(String moonshotApiKey)	Create a new client api with DEFAULT_BASE_URL
MoonshotApi(String baseUrl, String moonshotApiKey)	Create a new client api.
MoonshotApi(String baseUrl, String moonshotApiKey, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new client api.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<MoonshotApi.ChatCompletion>	chatCompletionEntity(MoonshotApi.ChatCompletionRequest chatRequest)	Creates a model response for the given chat conversation.
reactor.core.publisher.Flux<MoonshotApi.ChatCompletionChunk>	chatCompletionStream(MoonshotApi.ChatCompletionRequest chatRequest)	Creates a streaming chat response for the given chat conversation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CHAT_MODEL

public static final String DEFAULT_CHAT_MODEL

Constructor Details

MoonshotApi

public MoonshotApi(String moonshotApiKey)

Create a new client api with DEFAULT_BASE_URL

Parameters:

moonshotApiKey - Moonshot api Key.

MoonshotApi

public MoonshotApi(String baseUrl,
 String moonshotApiKey)

Create a new client api.

Parameters:

baseUrl - api base URL.

moonshotApiKey - Moonshot api Key.

MoonshotApi

public MoonshotApi(String baseUrl,
 String moonshotApiKey,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new client api.

Parameters:

baseUrl - api base URL.

moonshotApiKey - Moonshot api Key.

restClientBuilder - RestClient builder.

responseErrorHandler - Response error handler.

Method Details

chatCompletionEntity

public org.springframework.http.ResponseEntity<MoonshotApi.ChatCompletion> chatCompletionEntity(MoonshotApi.ChatCompletionRequest chatRequest)

Creates a model response for the given chat conversation.

Parameters:

chatRequest - The chat completion request.

Returns:

Entity response with MoonshotApi.ChatCompletion as a body and HTTP status code and headers.

chatCompletionStream

public reactor.core.publisher.Flux<MoonshotApi.ChatCompletionChunk> chatCompletionStream(MoonshotApi.ChatCompletionRequest chatRequest)

Creates a streaming chat response for the given chat conversation.

Parameters:

chatRequest - The chat completion request. Must have the stream property set to true.

Returns:

Returns a Flux stream from chat completion chunks.