Class GitHubModelsStreamingChatModel

java.lang.Object

dev.langchain4j.model.github.GitHubModelsStreamingChatModel

All Implemented Interfaces:

StreamingChatModel

public class GitHubModelsStreamingChatModel
extends Object
implements StreamingChatModel

Represents a language model, hosted on GitHub Models, that has a chat completion interface, such as gpt-4o.

Mandatory parameters for initialization are: gitHubToken (the GitHub Token used for authentication) and modelName (the name of the model to use). You can also provide your own ChatCompletionsClient and ChatCompletionsAsyncClient instance, if you need more flexibility.

The list of models, as well as the documentation and a playground to test them, can be found at https://github.com/marketplace/models

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubModelsStreamingChatModel.Builder

Method Summary

Modifier and Type	Method	Description
static GitHubModelsStreamingChatModel.Builder	builder()
void	chat(ChatRequest request, StreamingChatResponseHandler handler)	This is the main API to interact with the chat model.
List<ChatModelListener>	listeners()
ModelProvider	provider()

Methods inherited from class Object

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

Methods inherited from interface StreamingChatModel

chat, chat, defaultRequestParameters, doChat, supportedCapabilities

Method Details

chat

public void chat(ChatRequest request,
 StreamingChatResponseHandler handler)

Description copied from interface: StreamingChatModel

This is the main API to interact with the chat model.

Specified by:

chat in interface StreamingChatModel

Parameters:

request - a ChatRequest, containing all the inputs to the LLM

handler - a StreamingChatResponseHandler that will handle streaming response from the LLM

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface StreamingChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface StreamingChatModel

builder

public static GitHubModelsStreamingChatModel.Builder builder()