Class ChatModel (1.26.1) 

ChatModel(model_id: str, endpoint_name: Optional[str] = None)

ChatModel represents a language model that is capable of chat.

Examples::

chat_model = ChatModel.from_pretrained("chat-bison@001")

chat = chat_model.start_chat(
    context="My name is Ned. You are my personal assistant. My favorite movies are Lord of the Rings and Hobbit.",
    examples=[
        InputOutputTextPair(
            input_text="Who do you work for?",
            output_text="I work for Ned.",
        ),
        InputOutputTextPair(
            input_text="What do I like?",
            output_text="Ned likes watching movies.",
        ),
    ],
    temperature=0.3,
)

chat.send_message("Do you know any cool events this weekend?")

Inheritance

builtins.object > vertexai._model_garden._model_garden_models._ModelGardenModel > vertexai.language_models._language_models._LanguageModel > vertexai.language_models._language_models._ChatModelBase > ChatModel

Methods

ChatModel

ChatModel(model_id: str, endpoint_name: Optional[str] = None)

Creates a LanguageModel.

This constructor should not be called directly. Use LanguageModel.from_pretrained(model_name=...) instead.

from_pretrained

from_pretrained(model_name: str)

Loads a _ModelGardenModel.

Exceptions
Type Description
ValueError If model_name is unknown.
ValueError If model does not support this class.

start_chat

start_chat(
    *,
    context: Optional[str] = None,
    examples: Optional[
        List[vertexai.language_models._language_models.InputOutputTextPair]
    ] = None,
    max_output_tokens: int = 128,
    temperature: float = 0.0,
    top_k: int = 40,
    top_p: float = 0.95,
    message_history: Optional[
        List[vertexai.language_models._language_models.ChatMessage]
    ] = None
)

Starts a chat session with the model.