Class GitHubModelsStreamingChatModel

java.lang.Object

dev.langchain4j.model.github.GitHubModelsStreamingChatModel

All Implemented Interfaces:

StreamingChatModel

@Deprecated(since="1.10.0",
            forRemoval=true)
public class GitHubModelsStreamingChatModel
extends Object
implements StreamingChatModel

Deprecated, for removal: This API element is subject to removal in a future version.

This module is deprecated and will be removed in a future release. Please use the langchain4j-openai-official module instead.

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	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static GitHubModelsStreamingChatModel.Builder	builder()	Deprecated, for removal: This API element is subject to removal in a future version.
void	chat(ChatRequest request, StreamingChatResponseHandler handler)	Deprecated, for removal: This API element is subject to removal in a future version. This is the main API to interact with the chat model.
List<ChatModelListener>	listeners()	Deprecated, for removal: This API element is subject to removal in a future version.
ModelProvider	provider()	Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

listeners in interface StreamingChatModel

provider

public ModelProvider provider()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

provider in interface StreamingChatModel

builder

public static GitHubModelsStreamingChatModel.Builder builder()

Deprecated, for removal: This API element is subject to removal in a future version.