gemini

Documentation

Index

• Constants
• type ChatSession
  • func NewChatSession(ctx context.Context, modelBuilder *GenerativeModelBuilder, apiKey string) (*ChatSession, error)
  • func (c *ChatSession) ClearHistory()
  • func (c *ChatSession) Close() error
  • func (c *ChatSession) CopyModelBuilder() *GenerativeModelBuilder
  • func (c *ChatSession) GetHistory() []*genai.Content
  • func (c *ChatSession) ListModels() []string
  • func (c *ChatSession) ModelInfo() (string, error)
  • func (c *ChatSession) SendMessage(input string) (*genai.GenerateContentResponse, error)
  • func (c *ChatSession) SendMessageStream(input string) *genai.GenerateContentResponseIterator
  • func (c *ChatSession) SetHistory(content []*genai.Content)
  • func (c *ChatSession) SetModel(modelBuilder *GenerativeModelBuilder)
• type GenerativeModelBuilder
  • func NewGenerativeModelBuilder() *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithCachedContentName(cachedContentName string) *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithGenerationConfig(generationConfig genai.GenerationConfig) *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithName(modelName string) *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithSafetySettings(safetySettings []*genai.SafetySetting) *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithSystemInstruction(systemInstruction *genai.Content) *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithToolConfig(toolConfig *genai.ToolConfig) *GenerativeModelBuilder
  • func (b *GenerativeModelBuilder) WithTools(tools []*genai.Tool) *GenerativeModelBuilder
• type SerializableContent
  • func NewSerializableContent(c *genai.Content) *SerializableContent
  • func (c *SerializableContent) ToContent() *genai.Content
• type SystemInstruction
  • func (si SystemInstruction) ToContent() *genai.Content

Constants

const DefaultModel = "gemini-1.5-flash"

Types

type ChatSession

type ChatSession struct {
	// contains filtered or unexported fields
}

ChatSession represents a gemini powered chat session.

func NewChatSession

func NewChatSession(
	ctx context.Context, modelBuilder *GenerativeModelBuilder, apiKey string,
) (*ChatSession, error)

NewChatSession returns a new ChatSession.

func (*ChatSession) ClearHistory

func (c *ChatSession) ClearHistory()

ClearHistory clears the chat session history.

func (*ChatSession) Close

func (c *ChatSession) Close() error

Close closes the chat session.

func (*ChatSession) CopyModelBuilder

func (c *ChatSession) CopyModelBuilder() *GenerativeModelBuilder

CopyModelBuilder returns a copy builder for the chat generative model.

func (*ChatSession) GetHistory

func (c *ChatSession) GetHistory() []*genai.Content

GetHistory returns the chat session history.

func (*ChatSession) ListModels

func (c *ChatSession) ListModels() []string

ListModels returns a list of the supported generative model names.

func (*ChatSession) ModelInfo

func (c *ChatSession) ModelInfo() (string, error)

ModelInfo returns information about the chat generative model in JSON format.

func (*ChatSession) SendMessage

func (c *ChatSession) SendMessage(input string) (*genai.GenerateContentResponse, error)

SendMessage sends a request to the model as part of a chat session.

func (*ChatSession) SendMessageStream

func (c *ChatSession) SendMessageStream(input string) *genai.GenerateContentResponseIterator

SendMessageStream is like SendMessage, but with a streaming request.

func (*ChatSession) SetHistory

func (c *ChatSession) SetHistory(content []*genai.Content)

SetHistory sets the chat session history.

func (*ChatSession) SetModel

func (c *ChatSession) SetModel(modelBuilder *GenerativeModelBuilder)

SetModel sets a new generative model configured with the builder and starts a new chat session. It preserves the history of the previous chat session.

type GenerativeModelBuilder

type GenerativeModelBuilder struct {
	// contains filtered or unexported fields
}

GenerativeModelBuilder implements the builder pattern for genai.GenerativeModel.

func NewGenerativeModelBuilder

func NewGenerativeModelBuilder() *GenerativeModelBuilder

NewGenerativeModelBuilder returns a new GenerativeModelBuilder with empty default values.

func (*GenerativeModelBuilder) WithCachedContentName

func (b *GenerativeModelBuilder) WithCachedContentName(
	cachedContentName string,
) *GenerativeModelBuilder

WithCachedContentName sets the name of the genai.CachedContent to use.

func (*GenerativeModelBuilder) WithGenerationConfig

func (b *GenerativeModelBuilder) WithGenerationConfig(
	generationConfig genai.GenerationConfig,
) *GenerativeModelBuilder

WithGenerationConfig sets the generation config.

func (*GenerativeModelBuilder) WithName

func (b *GenerativeModelBuilder) WithName(
	modelName string,
) *GenerativeModelBuilder

WithName sets the model name.

func (*GenerativeModelBuilder) WithSafetySettings

func (b *GenerativeModelBuilder) WithSafetySettings(
	safetySettings []*genai.SafetySetting,
) *GenerativeModelBuilder

WithSafetySettings sets the safety settings.

func (*GenerativeModelBuilder) WithSystemInstruction

func (b *GenerativeModelBuilder) WithSystemInstruction(
	systemInstruction *genai.Content,
) *GenerativeModelBuilder

WithSystemInstruction sets the system instruction.

func (*GenerativeModelBuilder) WithToolConfig

func (b *GenerativeModelBuilder) WithToolConfig(
	toolConfig *genai.ToolConfig,
) *GenerativeModelBuilder

WithToolConfig sets the tool config.

func (*GenerativeModelBuilder) WithTools

func (b *GenerativeModelBuilder) WithTools(
	tools []*genai.Tool,
) *GenerativeModelBuilder

WithTools sets the tools.

type SerializableContent

type SerializableContent struct {
	// Ordered parts that constitute a single message.
	Parts []string
	// The producer of the content. Must be either 'user' or 'model'.
	Role string
}

SerializableContent is the data type containing multipart text message content. It is a serializable equivalent of genai.Content, where message content parts are represented as strings.

func NewSerializableContent

func NewSerializableContent(c *genai.Content) *SerializableContent

NewSerializableContent instantiates and returns a new SerializableContent from the given genai.Content. It will panic if the content type is not supported.

func (*SerializableContent) ToContent

func (c *SerializableContent) ToContent() *genai.Content

ToContent converts the SerializableContent into a genai.Content.

type SystemInstruction

type SystemInstruction string

SystemInstruction represents a serializable system prompt, a more forceful instruction to the language model. The model will prioritize adhering to system instructions over regular prompts.

func (SystemInstruction) ToContent

func (si SystemInstruction) ToContent() *genai.Content

ToContent converts the SystemInstruction to genai.Content.