sync with upstream

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# These are supported funding model platforms
+github: tmc

.github/workflows/ci.yaml

@@ -12,18 +12,18 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: stable
+          go-version: '1.22'
           # Cache is managed by golangci-lint
           # https://github.com/actions/setup-go#caching-dependency-files-and-build-outputs
           cache: false
-      - uses: actions/checkout@v3
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3.7.0
+        uses: golangci/golangci-lint-action@v4
         with:
           args: --timeout=4m
-          version: v1.55.1
+          version: v1.57.2
   build-examples:
     runs-on: ubuntu-latest
     steps:
@@ -36,31 +36,15 @@ jobs:
         run: make build-examples
   build-test:
     runs-on: ubuntu-latest
-    services:
-      postgres:
-        image: pgvector/pgvector:pg16
-        env:
-          POSTGRES_PASSWORD: postgres
-          POSTGRES_HOST_AUTH_METHOD: trust
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - 5432:5432
     steps:
       - uses: actions/setup-go@v4
         with:
           go-version: stable
       - uses: actions/checkout@v3
       - name: Build
         run: go build -v ./...
-      - name: Create pgvector extension
-        run: PGPASSWORD=postgres psql -h localhost -U postgres -c 'CREATE EXTENSION vector'
       - name: Test
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
           GENAI_API_KEY: ${{ secrets.GENAI_API_KEY }}
-          PGVECTOR_CONNECTION_STRING: postgresql://postgres:postgres@localhost:5432
         run: go test -v ./...

.golangci.yaml

@@ -28,8 +28,12 @@ linters:
     - nolintlint # see https://github.com/golangci/golangci-lint/issues/3228.
     - depguard # disabling temporarily
     - ireturn # disabling temporarily
+    - perfsprint
+    - musttag
 
 linters-settings:
+  cyclop:
+    max-complexity: 12
   funlen:
     lines: 90
   depguard:
@@ -46,5 +50,5 @@ linters-settings:
           - "**/*_test.go"
           - "**/mock/**/*.go"
 run:
-  skip-dirs:
+  exclude-dirs:
     - 'exp'

Makefile

@@ -26,9 +26,14 @@ lint-all:
 lint-deps:
 	@command -v golangci-lint >/dev/null 2>&1 || { \
 		echo >&2 "golangci-lint not found. Installing..."; \
-		go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.1; \
+		go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.57.1; \
 	}
 
+.PHONY: docs
+docs:
+	@echo "Generating documentation..."
+	$(MAKE) -C docs build
+
 .PHONY: test-race
 test-race:
 	go run test -race ./...

README.md

@@ -62,3 +62,10 @@ Here are some links to blog posts and articles on using Langchain Go:
 - [Using Ollama with LangChainGo](https://eli.thegreenplace.net/2023/using-ollama-with-langchaingo/) - Nov 2023
 - [Creating a simple ChatGPT clone with Go](https://sausheong.com/creating-a-simple-chatgpt-clone-with-go-c40b4bec9267?sk=53a2bcf4ce3b0cfae1a4c26897c0deb0) - Aug 2023
 - [Creating a ChatGPT Clone that Runs on Your Laptop with Go](https://sausheong.com/creating-a-chatgpt-clone-that-runs-on-your-laptop-with-go-bf9d41f1cf88?sk=05dc67b60fdac6effb1aca84dd2d654e) - Aug 2023
+
+
+# Contributors
+
+<a href="https://github.com/tmc/langchaingo/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=tmc/langchaingo" />
+</a>

agents/conversational.go

@@ -40,7 +40,7 @@ type ConversationalAgent struct {
 
 var _ Agent = (*ConversationalAgent)(nil)
 
-func NewConversationalAgent(llm llms.Model, tools []tools.Tool, opts ...CreationOption) *ConversationalAgent {
+func NewConversationalAgent(llm llms.Model, tools []tools.Tool, opts ...Option) *ConversationalAgent {
 	options := conversationalDefaultOptions()
 	for _, opt := range opts {
 		opt(&options)

agents/executor.go

@@ -26,18 +26,18 @@ type Executor struct {
 }
 
 var (
-	_ chains.Chain           = Executor{}
-	_ callbacks.HandlerHaver = Executor{}
+	_ chains.Chain           = &Executor{}
+	_ callbacks.HandlerHaver = &Executor{}
 )
 
 // NewExecutor creates a new agent executor with an agent and the tools the agent can use.
-func NewExecutor(agent Agent, tools []tools.Tool, opts ...CreationOption) Executor {
+func NewExecutor(agent Agent, tools []tools.Tool, opts ...Option) *Executor {
 	options := executorDefaultOptions()
 	for _, opt := range opts {
 		opt(&options)
 	}
 
-	return Executor{
+	return &Executor{
 		Agent:                   agent,
 		Tools:                   tools,
 		Memory:                  options.memory,
@@ -48,7 +48,7 @@ func NewExecutor(agent Agent, tools []tools.Tool, opts ...CreationOption) Execut
 	}
 }
 
-func (e Executor) Call(ctx context.Context, inputValues map[string]any, _ ...chains.ChainCallOption) (map[string]any, error) { //nolint:lll
+func (e *Executor) Call(ctx context.Context, inputValues map[string]any, _ ...chains.ChainCallOption) (map[string]any, error) { //nolint:lll
 	inputs, err := inputsToString(inputValues)
 	if err != nil {
 		return nil, err
@@ -81,7 +81,7 @@ func (e Executor) Call(ctx context.Context, inputValues map[string]any, _ ...cha
 	), ErrNotFinished
 }
 
-func (e Executor) doIteration( // nolint
+func (e *Executor) doIteration( // nolint
 	ctx context.Context,
 	steps []schema.AgentStep,
 	nameToTool map[string]tools.Tool,
@@ -123,7 +123,7 @@ func (e Executor) doIteration( // nolint
 	return steps, nil, nil
 }
 
-func (e Executor) doAction(
+func (e *Executor) doAction(
 	ctx context.Context,
 	steps []schema.AgentStep,
 	nameToTool map[string]tools.Tool,
@@ -152,7 +152,7 @@ func (e Executor) doAction(
 	}), nil
 }
 
-func (e Executor) getReturn(finish *schema.AgentFinish, steps []schema.AgentStep) map[string]any {
+func (e *Executor) getReturn(finish *schema.AgentFinish, steps []schema.AgentStep) map[string]any {
 	if e.ReturnIntermediateSteps {
 		finish.ReturnValues[_intermediateStepsOutputKey] = steps
 	}
@@ -162,20 +162,20 @@ func (e Executor) getReturn(finish *schema.AgentFinish, steps []schema.AgentStep
 
 // GetInputKeys gets the input keys the agent of the executor expects.
 // Often "input".
-func (e Executor) GetInputKeys() []string {
+func (e *Executor) GetInputKeys() []string {
 	return e.Agent.GetInputKeys()
 }
 
 // GetOutputKeys gets the output keys the agent of the executor returns.
-func (e Executor) GetOutputKeys() []string {
+func (e *Executor) GetOutputKeys() []string {
 	return e.Agent.GetOutputKeys()
 }
 
-func (e Executor) GetMemory() schema.Memory { //nolint:ireturn
+func (e *Executor) GetMemory() schema.Memory { //nolint:ireturn
 	return e.Memory
 }
 
-func (e Executor) GetCallbackHandler() callbacks.Handler { //nolint:ireturn
+func (e *Executor) GetCallbackHandler() callbacks.Handler { //nolint:ireturn
 	return e.CallbacksHandler
 }
 

agents/initialize.go

@@ -19,23 +19,24 @@ const (
 	ConversationalReactDescription AgentType = "conversationalReactDescription"
 )
 
+// Deprecated: This may be removed in the future; please use NewExecutor instead.
 // Initialize is a function that creates a new executor with the specified LLM
 // model, tools, agent type, and options. It returns an Executor or an error
 // if there is any issues during the creation process.
 func Initialize(
 	llm llms.Model,
 	tools []tools.Tool,
 	agentType AgentType,
-	opts ...CreationOption,
-) (Executor, error) {
+	opts ...Option,
+) (*Executor, error) {
 	var agent Agent
 	switch agentType {
 	case ZeroShotReactDescription:
 		agent = NewOneShotAgent(llm, tools, opts...)
 	case ConversationalReactDescription:
 		agent = NewConversationalAgent(llm, tools, opts...)
 	default:
-		return Executor{}, ErrUnknownAgentType
+		return &Executor{}, ErrUnknownAgentType
 	}
 	return NewExecutor(agent, tools, opts...), nil
 }

agents/mrkl.go

@@ -41,7 +41,7 @@ var _ Agent = (*OneShotZeroAgent)(nil)
 // NewOneShotAgent creates a new OneShotZeroAgent with the given LLM model, tools,
 // and options. It returns a pointer to the created agent. The opts parameter
 // represents the options for the agent.
-func NewOneShotAgent(llm llms.Model, tools []tools.Tool, opts ...CreationOption) *OneShotZeroAgent {
+func NewOneShotAgent(llm llms.Model, tools []tools.Tool, opts ...Option) *OneShotZeroAgent {
 	options := mrklDefaultOptions()
 	for _, opt := range opts {
 		opt(&options)

agents/mrkl_prompt.go

@@ -9,8 +9,8 @@ import (
 )
 
 const (
-	_defaultMrklPrefix = `Today is {{.today}} and you can use tools to get new information.
-Answer the following questions as best you can using the following tools:
+	_defaultMrklPrefix = `Today is {{.today}}.
+Answer the following questions as best you can. You have access to the following tools:
 
 {{.tool_descriptions}}`
 

agents/openai_functions_agent.go

@@ -33,7 +33,7 @@ type OpenAIFunctionsAgent struct {
 var _ Agent = (*OpenAIFunctionsAgent)(nil)
 
 // NewOpenAIFunctionsAgent creates a new OpenAIFunctionsAgent.
-func NewOpenAIFunctionsAgent(llm llms.Model, tools []tools.Tool, opts ...CreationOption) *OpenAIFunctionsAgent {
+func NewOpenAIFunctionsAgent(llm llms.Model, tools []tools.Tool, opts ...Option) *OpenAIFunctionsAgent {
 	options := openAIFunctionsDefaultOptions()
 	for _, opt := range opts {
 		opt(&options)
@@ -132,7 +132,7 @@ func (o *OpenAIFunctionsAgent) GetOutputKeys() []string {
 	return []string{o.OutputKey}
 }
 
-func createOpenAIFunctionPrompt(opts CreationOptions) prompts.ChatPromptTemplate {
+func createOpenAIFunctionPrompt(opts Options) prompts.ChatPromptTemplate {
 	messageFormatters := []prompts.MessageFormatter{prompts.NewSystemMessagePromptTemplate(opts.systemMessage, nil)}
 	messageFormatters = append(messageFormatters, opts.extraMessages...)
 	messageFormatters = append(messageFormatters, prompts.NewHumanMessagePromptTemplate("{{.input}}", []string{"input"}))