• 消息
  • 托管智能体
  • 管理
Search...
⌘K
CLI、SDK 和库
概览
ant CLI
快速入门身份验证选项使用 CLI脚本与自动化
客户端 SDK
中间件PythonTypeScriptC#GoJavaPHPRuby
库与集成
Apple Foundation ModelsOpenAI SDK 兼容性
Log in
Go
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

Solutions

  • AI agents
  • Code modernization
  • Coding
  • Customer support
  • Education
  • Financial services
  • Government
  • Life sciences

Partners

  • Amazon Bedrock
  • Google Cloud's Vertex AI

Learn

  • Blog
  • Courses
  • Use cases
  • Connectors
  • Customer stories
  • Engineering at Anthropic
  • Events
  • Powered by Claude
  • Service partners
  • Startups program

Company

  • Anthropic
  • Careers
  • Economic Futures
  • Research
  • News
  • Responsible Scaling Policy
  • Security and compliance
  • Transparency

Learn

  • Blog
  • Courses
  • Use cases
  • Connectors
  • Customer stories
  • Engineering at Anthropic
  • Events
  • Powered by Claude
  • Service partners
  • Startups program

Help and security

  • Availability
  • Status
  • Support
  • Discord

Terms and policies

  • Privacy policy
  • Responsible disclosure policy
  • Terms of service: Commercial
  • Terms of service: Consumer
  • Usage policy
CLI、SDK 和库/客户端 SDK

Go SDK

安装和配置 Anthropic Go SDK,支持基于上下文的取消操作和函数式选项

Anthropic Go 库为使用 Go 编写的应用程序提供了便捷访问 Anthropic REST API 的方式。

有关包含代码示例的 API 功能文档,请参阅 API 参考。本页面介绍 Go 特定的 SDK 功能和配置。

安装

import (
	"github.com/anthropics/anthropic-sdk-go" // imported as anthropic
)

使用 go get 安装:

go get github.com/anthropics/anthropic-sdk-go

要求

此库需要 Go 1.23 或更高版本。

用法

package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"), // defaults to os.LookupEnv("ANTHROPIC_API_KEY")
	)
	message, err := client.Messages.New(context.TODO(), anthropic.MessageNewParams{
		MaxTokens: 1024,
		Messages: []anthropic.MessageParam{
			anthropic.NewUserMessage(anthropic.NewTextBlock("What is a quaternion?")),
		},
		Model: anthropic.ModelClaudeOpus4_8,
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", message.Content)
}

有关包括 Workload Identity Federation(工作负载身份联合)在内的身份验证选项,请参阅身份验证。

请求字段

anthropic 库对请求字段使用 Go 1.24+ encoding/json 版本中的 omitzero 语义。

必需的基本类型字段(int64、string 等)带有 `json:"...,required"` 标签。这些字段始终会被序列化,即使是零值。

可选的基本类型被包装在 param.Opt[T] 中。这些字段可以使用提供的构造函数进行设置,如 anthropic.String(string)、anthropic.Int(int64) 等。

任何 param.Opt[T]、map、slice、struct 或字符串枚举都使用 `json:"...,omitzero"` 标签。其零值被视为省略。

param.IsOmitted(any) 函数可以确认任何 omitzero 字段是否存在。

p := anthropic.ExampleParams{
	ID:   "id_xxx",                // required property
	Name: anthropic.String("..."), // optional property

	Point: anthropic.Point{
		X: 0,                // required field will serialize as 0
		Y: anthropic.Int(1), // optional field will serialize as 1
		// ... 省略的非必需字段将不会被序列化
	},

	Origin: anthropic.Origin{}, // the zero value of [Origin] is considered omitted
}

要发送 null 而不是 param.Opt[T],请使用 param.Null[T]()。 要发送 null 而不是结构体 T,请使用 param.NullStruct[T]()。

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

请求结构体包含一个 .SetExtraFields(map[string]any) 方法,可以在请求正文中发送不符合规范的字段。额外字段会覆盖任何具有匹配键的结构体字段。

出于安全原因,请仅对受信任的数据使用 SetExtraFields。

要发送自定义值而不是结构体,请使用泛型函数 param.Override(例如 param.Override[anthropic.FooParams](12))。

// 当 API 指定了某个类型,
// 但您想发送其他内容时,请使用 [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// 发送数字而非对象
custom := param.Override[anthropic.FooParams](12)

请求联合类型

联合类型(unions)表示为一个结构体,其中每个变体的字段都以 "Of" 为前缀,只有一个字段可以为非零值。非零字段将被序列化。

联合类型的子属性可以通过联合结构体上的方法访问。如果存在,这些方法会返回指向底层数据的可变指针。

// 只能有一个字段为非零值,使用 param.IsOmitted() 检查字段是否已设置
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline"`
	OfDog *Dog `json:",omitzero,inline"`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", ZipCode: 0},
		},
	},
}

// 修改字段
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}

反序列化参数

param.SetJSON 需要 SDK v1.20.0 或更高版本。

参数类型(以 Param 结尾的类型,如 MessageNewParams 或 ToolUnionParam)仅设计用于传出请求。它们可以正确地序列化为 JSON,但不完全支持往返反序列化。如果您将原始 JSON 反序列化到参数结构体中,即使底层 JSON 有效,类型化的联合字段(如 OfBashTool20250124)也将为 nil。

如果您需要从原始 JSON 重建参数(例如,来自数据库、中间件或之前的请求),请调用 UnmarshalJSON 来填充非联合字段,然后使用 param.SetJSON 附加原始字节以实现正确的重新序列化:

// 序列化参数(例如,用于存储或转发)
b, err := json.Marshal(original)
if err != nil {
	panic(err)
}

// 稍后,从存储的 JSON 重建参数
var params anthropic.MessageNewParams
if err := params.UnmarshalJSON(b); err != nil {
	panic(err)
}
param.SetJSON(b, &params)

// params.Model 和其他标量字段由 UnmarshalJSON 填充。
// params.Tools[0].OfBashTool20250124 为 nil(联合类型的限制),
// 但原始 JSON 被保留。当 params 再次被编组
// 用于 API 调用时,工具会正确序列化。
b2, _ := json.Marshal(params)
fmt.Println(string(b) == string(b2)) // true

对于此用例,param.SetJSON(自 v1.20.0 起可用)优于更通用的 param.Override[T](any),因为它不需要显式指定类型参数,并且使往返意图更加明确。

响应对象

响应结构体中的所有字段都是普通值类型(不是指针或包装器)。响应结构体还包含一个特殊的 JSON 字段,其中包含每个属性的元数据。

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owners      respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

要处理可选数据,请使用 JSON 字段上的 .Valid() 方法。当字段存在、非 null 且成功反序列化时,.Valid() 返回 true。

如果 .Valid() 为 false,则相应字段将为其零值。

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// 访问常规字段

res.Owners // 1
res.Name   // ""
res.Age    // 0

// 可选字段检查

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// 原始 JSON 值

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

这些 .JSON 结构体还包含一个 ExtraFields map,其中包含 json 响应中未在结构体中指定的任何属性。这对于 SDK 中尚未提供的 API 功能非常有用。

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()

响应联合类型

在响应中,联合类型表示为一个扁平化的结构体,其中包含来自每个对象变体的所有可能字段。要将其转换为某个变体,请使用 .AsFooVariant() 方法,或者使用 .AsAny() 方法(如果存在)。

如果响应值联合类型包含基本类型值,基本类型字段将与属性并列,但以 Of 为前缀,并带有 json:"...,inline" 标签。

type AnimalUnion struct {
	// 来自变体 [Dog]、[Cat]
	Owner Person `json:"owner"`
	// 来自变体 [Dog]
	DogBreed string `json:"dog_breed"`
	// 来自变体 [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// 如果是 animal 变体
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// 根据变体进行分支
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}

错误处理

当 API 返回非成功状态码时,SDK 会返回类型为 *anthropic.Error 的错误。它包含请求的 StatusCode、*http.Request 和 *http.Response 值,以及错误正文的 JSON(与 SDK 中的其他响应对象类似)。该错误还包含来自响应标头的 RequestID,这在向 Anthropic 支持团队进行故障排查时非常有用。

要处理错误,请使用 errors.As 模式:

_, err := client.Messages.New(context.TODO(), anthropic.MessageNewParams{
	MaxTokens: 1024,
	Messages: []anthropic.MessageParam{{
		Content: []anthropic.ContentBlockParamUnion{{
			OfText: &anthropic.TextBlockParam{
				Text: "What is a quaternion?",
			},
		}},
		Role: anthropic.MessageParamRoleUser,
	}},
	Model: anthropic.ModelClaudeOpus4_8,
})
if err != nil {
	var apierr *anthropic.Error
	if errors.As(err, &apierr) {
		println("Request ID:", apierr.RequestID)
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // POST "/v1/messages": 400 Bad Request (Request-ID: req_xxx) { ... }
}

当发生其他错误时,它们会以未包装的形式返回;例如,如果 HTTP 传输失败,您可能会收到包装了 *net.OpError 的 *url.Error。

重试

某些错误默认会自动重试 2 次,并采用短暂的指数退避策略。SDK 默认会重试所有连接错误、408 Request Timeout、409 Conflict、429 Rate Limit 以及 >=500 的内部错误。

您可以使用 WithMaxRetries 选项来配置或禁用此功能:

// 为所有请求配置默认值:
client := anthropic.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// 按请求覆盖:
// ...
	client.Messages.New(
		context.TODO(),
		anthropic.MessageNewParams{
			MaxTokens: 1024,
			Messages: []anthropic.MessageParam{{
				Content: []anthropic.ContentBlockParamUnion{{
					OfText: &anthropic.TextBlockParam{
						Text: "What is a quaternion?",
					},
				}},
				Role: anthropic.MessageParamRoleUser,
			}},
			Model: anthropic.ModelClaudeOpus4_8,
		},
		option.WithMaxRetries(5),
	)

超时

非流式传输的 Messages 请求默认在 10 分钟后超时;其他请求没有默认超时。使用 context 为请求生命周期配置超时。

请注意,如果请求被重试,context 超时不会重新开始计时。要设置每次重试的超时,请使用 option.WithRequestTimeout()。

// 这设置了请求的超时时间,包括所有重试。
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
// ...
	client.Messages.New(
		ctx,
		anthropic.MessageNewParams{
			MaxTokens: 1024,
			Messages: []anthropic.MessageParam{{
				Content: []anthropic.ContentBlockParamUnion{{
					OfText: &anthropic.TextBlockParam{
						Text: "What is a quaternion?",
					},
				}},
				Role: anthropic.MessageParamRoleUser,
			}},
			Model: anthropic.ModelClaudeOpus4_8,
		},
		// 这设置了每次重试的超时时间
		option.WithRequestTimeout(20*time.Second),
	)

长时间运行的请求

对于运行时间较长的请求,请考虑使用流式传输 Messages API。

避免在不使用流式传输的情况下设置较大的 MaxTokens 值,因为某些网络可能会在一段时间后断开空闲连接,这可能导致请求失败或超时,而无法收到来自 Anthropic 的响应。

如果非流式传输请求预计超过大约 10 分钟,此 SDK 也会返回错误。调用 .Messages.NewStreaming() 或设置自定义超时可禁用此错误。

文件上传

在 multipart 请求中对应文件上传的请求参数类型为 io.Reader。默认情况下,io.Reader 的内容将作为 multipart 表单部分发送,文件名为 "anonymous_file",content-type 为 "application/octet-stream",因此推荐的方法是使用 anthropic.File(reader io.Reader, filename string, contentType string) 辅助函数指定自定义 content-type,该函数会使用适当的文件名和 content-type 包装任何 io.Reader。

// 来自文件系统的文件
file, err := os.Open("/path/to/file.json")
anthropic.BetaFileUploadParams{
	File: anthropic.File(file, "custom-name.json", "application/json"),
}

// 来自字符串的文件
anthropic.BetaFileUploadParams{
	File: anthropic.File(strings.NewReader("my file contents"), "custom-name.json", "application/json"),
}

文件名和 content-type 也可以通过在 io.Reader 的运行时类型上实现 Name() string 或 ContentType() string 来自定义。请注意,os.File 实现了 Name() string,因此通过 os.Open 返回的文件将使用磁盘上的文件名发送。

分页

此库为处理分页列表端点提供了一些便利功能。

您可以使用 .ListAutoPaging() 方法遍历所有页面中的项目:

iter := client.Messages.Batches.ListAutoPaging(context.TODO(), anthropic.MessageBatchListParams{
	Limit: anthropic.Int(20),
})
// 根据需要自动获取更多页面。
for iter.Next() {
	messageBatch := iter.Current()
	fmt.Printf("%+v\n", messageBatch)
}
if err := iter.Err(); err != nil {
	panic(err.Error())
}

或者,您可以使用简单的 .List() 方法获取单个页面,并接收带有额外辅助方法(如 .GetNextPage())的标准响应对象:

page, err := client.Messages.Batches.List(context.TODO(), anthropic.MessageBatchListParams{
	Limit: anthropic.Int(20),
})
for page != nil {
	for _, batch := range page.Data {
		fmt.Printf("%+v\n", batch)
	}
	page, err = page.GetNextPage()
}
if err != nil {
	panic(err.Error())
}

RequestOptions

此库使用函数式选项模式。option 包中定义的函数返回一个 RequestOption,它是一个修改 RequestConfig 的闭包。这些选项可以提供给客户端或单个请求。例如:

client := anthropic.NewClient(
	// 为客户端发出的每个请求添加一个请求头
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Messages.New(context.TODO(), // ...,
	// 覆盖该请求头
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// 使用 sjson 语法向请求体添加一个未记录的字段
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

请求选项 option.WithDebugLog(nil) 在调试时可能会有所帮助。

请参阅请求选项的完整列表。

HTTP 客户端自定义

有关请求中间件(option.WithMiddleware)和替换默认 http.Client(option.WithHTTPClient)的信息,请参阅 SDK 中间件。

平台集成

有关包含代码示例的详细平台设置指南,请参阅:

  • Amazon Bedrock
  • Amazon Bedrock(旧版)
  • Vertex AI
  • AWS 上的 Claude Platform

Go SDK 支持以下平台:

  • Bedrock: import "github.com/anthropics/anthropic-sdk-go/bedrock"。对于 Messages-API Bedrock 端点(通过 SSE 流式传输),请使用 bedrock.NewMantleClient;或者使用 bedrock.WithLoadDefaultConfig(ctx) / bedrock.WithConfig(cfg)(bedrock-runtime 路径)。导入 bedrock 包会在全局范围内(通过包的 init())向 SDK 的流式传输层注册一个用于 application/vnd.amazon.eventstream 的解码器。无论您使用 bedrock-runtime 的 WithConfig/WithLoadDefaultConfig 路径还是 NewMantleClient,这都适用。
  • Vertex AI: import "github.com/anthropics/anthropic-sdk-go/vertex"。使用 vertex.WithGoogleAuth(ctx, region, projectID) 或 vertex.WithCredentials(ctx, region, projectID, creds)。
  • Go SDK 目前不支持。有关支持的 SDK,请参阅 。

对于新项目,请使用 bedrock.NewMantleClient;bedrock.WithLoadDefaultConfig/WithConfig 仍保留用于使用 Bedrock InvokeModel API 的现有应用程序。

高级用法

访问原始响应数据(例如响应标头)

您可以使用 option.WithResponseInto() 请求选项访问原始 HTTP 响应数据。当您需要检查响应标头、状态码或其他详细信息时,这非常有用。

// 创建一个变量来存储 HTTP 响应
var response *http.Response
message, err := client.Messages.New(
	context.TODO(),
	anthropic.MessageNewParams{
		MaxTokens: 1024,
		Messages: []anthropic.MessageParam{{
			Content: []anthropic.ContentBlockParamUnion{{
				OfText: &anthropic.TextBlockParam{
					Text: "What is a quaternion?",
				},
			}},
			Role: anthropic.MessageParamRoleUser,
		}},
		Model: anthropic.ModelClaudeOpus4_8,
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// 处理错误
}
fmt.Printf("%+v\n", message)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)

发起自定义/未记录的请求

此库提供了类型化支持,便于访问已记录的 API。如果您需要访问未记录的端点、参数或响应属性,仍然可以使用此库。

未记录的端点

要向未记录的端点发起请求,您可以使用 client.Get、client.Post 和其他 HTTP 动词。发起这些请求时,客户端上的 RequestOptions(如重试)将被遵循。

var (
	// params 可以是 io.Reader、[]byte、可被 encoding/json 序列化的对象,
	// 或本库中定义的 "...Params" 结构体。
	params map[string]any

	// result 可以是 []byte、*http.Response、可被 encoding/json 反序列化的对象,
	// 或本库中定义的模型。
	result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
	// ...
}

未记录的请求参数

要使用未记录的参数发起请求,您可以使用 option.WithQuerySet() 或 option.WithJSONSet() 方法。

params := FooNewParams{
	ID: "id_xxxx",
	Data: FooNewParamsData{
		FirstName: anthropic.String("John"),
	},
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))

未记录的响应属性

要访问未记录的响应属性,您可以使用 result.JSON.RawJSON() 以字符串形式访问响应的原始 JSON,或者使用 result.JSON.Foo.Raw() 获取结果中特定字段的原始 JSON。

响应结构体中不存在的任何字段都会被保存,并可以通过 result.JSON.ExtraFields 访问,它是一个 map[string]respjson.Field。

语义化版本控制

此包通常遵循 SemVer 约定,但某些向后不兼容的更改可能会作为次要版本发布:

  1. 对库内部的更改,这些更改在技术上是公开的,但并非旨在或记录为供外部使用。
  2. 预计在实践中不会影响绝大多数用户的更改。

我们非常重视向后兼容性,以确保您可以获得顺畅的升级体验。

欢迎您提供反馈;如有问题、错误或建议,请提交 issue。

其他资源

  • GitHub 仓库
  • Go 包文档
  • API 参考
  • 流式传输 Messages

Was this page helpful?

  • 安装
  • 要求
  • 用法
  • 请求字段
  • 请求联合类型
  • 反序列化参数
  • 响应对象
  • 响应联合类型
  • 错误处理
  • 重试
  • 超时
  • 长时间运行的请求
  • 文件上传
  • 分页
  • RequestOptions
  • HTTP 客户端自定义
  • 平台集成
  • 高级用法
  • 访问原始响应数据(例如响应标头)
  • 发起自定义/未记录的请求
  • 语义化版本控制
  • 其他资源

Foundry:
Microsoft Foundry 中的 Claude
  • AWS 上的 Claude Platform: import anthropicaws "github.com/anthropics/anthropic-sdk-go/aws"。使用 anthropicaws.NewClient(ctx, cfg) 和 anthropicaws.ClientConfig 值来构造客户端;在配置中设置 WorkspaceID 或设置 ANTHROPIC_AWS_WORKSPACE_ID 环境变量。当同时导入 github.com/aws/aws-sdk-go-v2/aws 时,anthropicaws 导入别名可避免名称冲突。目前处于测试阶段。