Package dev.langchain4j.model.github

Class GitHubModelsChatModel

java.lang.Object

dev.langchain4j.model.github.GitHubModelsChatModel

All Implemented Interfaces:

ChatLanguageModel

public class GitHubModelsChatModel
extends Object
implements ChatLanguageModel

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 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	GitHubModelsChatModel.Builder

Method Summary

Modifier and Type	Method	Description
static GitHubModelsChatModel.Builder	builder()
ChatResponse	chat(ChatRequest chatRequest)	This is the main API to interact with the chat model.
List<ChatModelListener>	listeners()
ModelProvider	provider()

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.chat.ChatLanguageModel

chat, chat, chat, defaultRequestParameters, doChat, supportedCapabilities

Method Details

chat

public ChatResponse chat(ChatRequest chatRequest)

Description copied from interface: ChatLanguageModel

This is the main API to interact with the chat model. A temporary default implementation of this method is necessary until all ChatLanguageModel implementations adopt it. It should be removed once that occurs.

Specified by:

chat in interface ChatLanguageModel

Parameters:

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

Returns:

a ChatResponse, containing all the outputs from the LLM

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface ChatLanguageModel

provider

public ModelProvider provider()

Specified by:

provider in interface ChatLanguageModel

builder

public static GitHubModelsChatModel.Builder builder()