For programmatic tool calling (PTC), the container field contains information about the code execution container, which can be reused across turns by passing its id in subsequent requests.

Constructors

MessageResponse
Fields id :: Text type_ :: Text role :: Role content :: Vector ContentBlock model :: Text stop_reason :: Maybe StopReason stop_sequence :: Maybe Text usage :: Usage container :: Maybe ContainerInfo

Instances

Instances details

FromJSON MessageResponse Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser MessageResponse #

parseJSONList :: Value -> Parser [MessageResponse] #

omittedField :: Maybe MessageResponse #

ToJSON MessageResponse Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: MessageResponse -> Value #

toEncoding :: MessageResponse -> Encoding #

toJSONList :: [MessageResponse] -> Value #

toEncodingList :: [MessageResponse] -> Encoding #

omitField :: MessageResponse -> Bool #

Generic MessageResponse Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep MessageResponse

Instance details

Defined in Claude.V1.Messages

Methods

from :: MessageResponse -> Rep MessageResponse x #

to :: Rep MessageResponse x -> MessageResponse #

Show MessageResponse Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> MessageResponse -> ShowS #

show :: MessageResponse -> String #

showList :: [MessageResponse] -> ShowS #

type Rep MessageResponse Source #

Instance details

Defined in Claude.V1.Messages

data MessageStreamEvent Source #

Streaming events for /v1/messages

Constructors

Message_Start
Fields message :: MessageResponse
Content_Block_Start
Fields index :: Natural content_block :: ContentBlock
Content_Block_Delta
Fields index :: Natural delta :: ContentBlockDelta
Content_Block_Stop
Fields index :: Natural
Message_Delta
Fields message_delta :: MessageDelta usage :: StreamUsage
Message_Stop
Ping
Error
Fields error :: Value

Instances

Instances details

FromJSON MessageStreamEvent Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser MessageStreamEvent #

parseJSONList :: Value -> Parser [MessageStreamEvent] #

omittedField :: Maybe MessageStreamEvent #

ToJSON MessageStreamEvent Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: MessageStreamEvent -> Value #

toEncoding :: MessageStreamEvent -> Encoding #

toJSONList :: [MessageStreamEvent] -> Value #

toEncodingList :: [MessageStreamEvent] -> Encoding #

omitField :: MessageStreamEvent -> Bool #

Generic MessageStreamEvent Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep MessageStreamEvent

Instance details

Defined in Claude.V1.Messages

Methods

from :: MessageStreamEvent -> Rep MessageStreamEvent x #

to :: Rep MessageStreamEvent x -> MessageStreamEvent #

Show MessageStreamEvent Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> MessageStreamEvent -> ShowS #

show :: MessageStreamEvent -> String #

showList :: [MessageStreamEvent] -> ShowS #

type Rep MessageStreamEvent Source #

Instance details

Defined in Claude.V1.Messages

Structured outputs

data OutputFormat Source #

Output format specification for structured outputs

Use with the structured-outputs-2025-11-13 beta header.

Example:

let outputFormat = jsonSchemaFormat $ Aeson.object
        [ "type" .= ("object" :: Text)
        , "properties" .= Aeson.object
            [ "name" .= Aeson.object ["type" .= ("string" :: Text)]
            , "age" .= Aeson.object ["type" .= ("integer" :: Text)]
            ]
        , "required" .= (["name", "age"] :: [Text])
        , "additionalProperties" .= False
        ]

Constructors

OutputFormat
Fields type_ :: Text Currently only "json_schema" is supported schema :: Value JSON Schema for the output

Instances

Instances details

FromJSON OutputFormat Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser OutputFormat #

parseJSONList :: Value -> Parser [OutputFormat] #

omittedField :: Maybe OutputFormat #

ToJSON OutputFormat Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: OutputFormat -> Value #

toEncoding :: OutputFormat -> Encoding #

toJSONList :: [OutputFormat] -> Value #

toEncodingList :: [OutputFormat] -> Encoding #

omitField :: OutputFormat -> Bool #

Generic OutputFormat Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep OutputFormat

Instance details

Defined in Claude.V1.Messages

type Rep OutputFormat = D1 ('MetaData "OutputFormat" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "OutputFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))

Methods

from :: OutputFormat -> Rep OutputFormat x #

to :: Rep OutputFormat x -> OutputFormat #

Show OutputFormat Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> OutputFormat -> ShowS #

show :: OutputFormat -> String #

showList :: [OutputFormat] -> ShowS #

Eq OutputFormat Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: OutputFormat -> OutputFormat -> Bool #

(/=) :: OutputFormat -> OutputFormat -> Bool #

type Rep OutputFormat Source #

Instance details

Defined in Claude.V1.Messages

type Rep OutputFormat = D1 ('MetaData "OutputFormat" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "OutputFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))

jsonSchemaFormat :: Value -> OutputFormat Source #

Create a JSON schema output format

This is the primary way to use structured outputs.

Content types

data Content Source #

Content block in a message (for requests)

For programmatic tool calling (PTC), replay assistant messages using:

Content_Tool_Use with optional caller field
Content_Server_Tool_Use for code execution invocations

Constructors

Content_Text
Fields text :: Text cache_control :: Maybe CacheControl
Content_Image
Fields source :: ImageSource cache_control :: Maybe CacheControl
Content_Tool_Use
Fields id :: Text name :: Text input :: Value caller :: Maybe ToolCaller
Content_Server_Tool_Use
Fields id :: Text name :: Text input :: Value
Content_Tool_Result
Fields tool_use_id :: Text content :: Maybe Text is_error :: Maybe Bool

Instances

Instances details

FromJSON Content Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser Content #

parseJSONList :: Value -> Parser [Content] #

omittedField :: Maybe Content #

ToJSON Content Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: Content -> Value #

toEncoding :: Content -> Encoding #

toJSONList :: [Content] -> Value #

toEncodingList :: [Content] -> Encoding #

omitField :: Content -> Bool #

Generic Content Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep Content

Instance details

Defined in Claude.V1.Messages

Methods

from :: Content -> Rep Content x #

to :: Rep Content x -> Content #

Show Content Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> Content -> ShowS #

show :: Content -> String #

showList :: [Content] -> ShowS #

type Rep Content Source #

Instance details

Defined in Claude.V1.Messages

data ContentBlock Source #

Content block in a response

Extended to support:

server_tool_use: Server-initiated tool use (e.g., tool search, code execution)
tool_search_tool_result: Results from server-side tool search
code_execution_tool_result: Results from code execution (PTC)

For programmatic tool calling, ContentBlock_Tool_Use includes an optional caller field indicating whether the tool was called directly by Claude or programmatically by code execution.

Constructors

ContentBlock_Text
Fields text :: Text
ContentBlock_Tool_Use
Fields id :: Text name :: Text input :: Value caller :: Maybe ToolCaller
ContentBlock_Server_Tool_Use
Fields id :: Text name :: Text input :: Value
ContentBlock_Tool_Search_Tool_Result
Fields tool_use_id :: Text tool_search_content :: ToolSearchToolResultContent
ContentBlock_Code_Execution_Tool_Result
Fields tool_use_id :: Text code_execution_content :: CodeExecutionToolResultContent
ContentBlock_Unknown
Fields type_ :: Text raw :: Value

Instances

Instances details

FromJSON ContentBlock Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ContentBlock #

parseJSONList :: Value -> Parser [ContentBlock] #

omittedField :: Maybe ContentBlock #

ToJSON ContentBlock Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ContentBlock -> Value #

toEncoding :: ContentBlock -> Encoding #

toJSONList :: [ContentBlock] -> Value #

toEncodingList :: [ContentBlock] -> Encoding #

omitField :: ContentBlock -> Bool #

Generic ContentBlock Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ContentBlock

Instance details

Defined in Claude.V1.Messages

Methods

from :: ContentBlock -> Rep ContentBlock x #

to :: Rep ContentBlock x -> ContentBlock #

Show ContentBlock Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ContentBlock -> ShowS #

show :: ContentBlock -> String #

showList :: [ContentBlock] -> ShowS #

type Rep ContentBlock Source #

Instance details

Defined in Claude.V1.Messages

data TextContent Source #

Text content block

Constructors

TextContent
Fields text :: Text

Instances

Instances details

FromJSON TextContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser TextContent #

parseJSONList :: Value -> Parser [TextContent] #

omittedField :: Maybe TextContent #

ToJSON TextContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: TextContent -> Value #

toEncoding :: TextContent -> Encoding #

toJSONList :: [TextContent] -> Value #

toEncodingList :: [TextContent] -> Encoding #

omitField :: TextContent -> Bool #

Generic TextContent Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep TextContent
Instance details Defined in Claude.V1.Messages type Rep TextContent = D1 ('MetaData "TextContent" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "TextContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: TextContent -> Rep TextContent x #

to :: Rep TextContent x -> TextContent #

Show TextContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> TextContent -> ShowS #

show :: TextContent -> String #

showList :: [TextContent] -> ShowS #

type Rep TextContent Source #

Instance details

Defined in Claude.V1.Messages

type Rep TextContent = D1 ('MetaData "TextContent" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "TextContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ImageSource Source #

Image source for vision capabilities

Constructors

ImageSource
Fields type_ :: Text "base64" media_type :: Text "imagejpeg", "imagepng", etc. data_ :: Text Base64 encoded image data

Instances

Instances details

FromJSON ImageSource Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ImageSource #

parseJSONList :: Value -> Parser [ImageSource] #

omittedField :: Maybe ImageSource #

ToJSON ImageSource Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ImageSource -> Value #

toEncoding :: ImageSource -> Encoding #

toJSONList :: [ImageSource] -> Value #

toEncodingList :: [ImageSource] -> Encoding #

omitField :: ImageSource -> Bool #

Generic ImageSource Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ImageSource

Instance details

Defined in Claude.V1.Messages

type Rep ImageSource = D1 ('MetaData "ImageSource" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ImageSource" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "media_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Methods

from :: ImageSource -> Rep ImageSource x #

to :: Rep ImageSource x -> ImageSource #

Show ImageSource Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ImageSource -> ShowS #

show :: ImageSource -> String #

showList :: [ImageSource] -> ShowS #

type Rep ImageSource Source #

Instance details

Defined in Claude.V1.Messages

type Rep ImageSource = D1 ('MetaData "ImageSource" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ImageSource" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "media_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data ToolUseContent Source #

Tool use content block (in assistant messages)

Constructors

ToolUseContent
Fields id :: Text name :: Text input :: Value

Instances

Instances details

FromJSON ToolUseContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ToolUseContent #

parseJSONList :: Value -> Parser [ToolUseContent] #

omittedField :: Maybe ToolUseContent #

ToJSON ToolUseContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ToolUseContent -> Value #

toEncoding :: ToolUseContent -> Encoding #

toJSONList :: [ToolUseContent] -> Value #

toEncodingList :: [ToolUseContent] -> Encoding #

omitField :: ToolUseContent -> Bool #

Generic ToolUseContent Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ToolUseContent

Instance details

Defined in Claude.V1.Messages

type Rep ToolUseContent = D1 ('MetaData "ToolUseContent" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolUseContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

Methods

from :: ToolUseContent -> Rep ToolUseContent x #

to :: Rep ToolUseContent x -> ToolUseContent #

Show ToolUseContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ToolUseContent -> ShowS #

show :: ToolUseContent -> String #

showList :: [ToolUseContent] -> ShowS #

type Rep ToolUseContent Source #

Instance details

Defined in Claude.V1.Messages

type Rep ToolUseContent = D1 ('MetaData "ToolUseContent" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolUseContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

data ToolResultContent Source #

Tool result content (in user messages, following tool use)

Constructors

ToolResultContent
Fields tool_use_id :: Text content :: Maybe Text is_error :: Maybe Bool

Instances

Instances details

FromJSON ToolResultContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ToolResultContent #

parseJSONList :: Value -> Parser [ToolResultContent] #

omittedField :: Maybe ToolResultContent #

ToJSON ToolResultContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ToolResultContent -> Value #

toEncoding :: ToolResultContent -> Encoding #

toJSONList :: [ToolResultContent] -> Value #

toEncodingList :: [ToolResultContent] -> Encoding #

omitField :: ToolResultContent -> Bool #

Generic ToolResultContent Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ToolResultContent

Instance details

Defined in Claude.V1.Messages

type Rep ToolResultContent = D1 ('MetaData "ToolResultContent" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolResultContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "tool_use_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "is_error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: ToolResultContent -> Rep ToolResultContent x #

to :: Rep ToolResultContent x -> ToolResultContent #

Show ToolResultContent Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ToolResultContent -> ShowS #

show :: ToolResultContent -> String #

showList :: [ToolResultContent] -> ShowS #

type Rep ToolResultContent Source #

Instance details

Defined in Claude.V1.Messages

type Rep ToolResultContent = D1 ('MetaData "ToolResultContent" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolResultContent" 'PrefixI 'True) (S1 ('MetaSel ('Just "tool_use_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "is_error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Message types

data Message Source #

A message in the conversation

The optional cache_control field allows setting cache breakpoints at the message level (in addition to content-level caching).

Constructors

Message
Fields role :: Role content :: Vector Content cache_control :: Maybe CacheControl

Instances

Instances details

FromJSON Message Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser Message #

parseJSONList :: Value -> Parser [Message] #

omittedField :: Maybe Message #

ToJSON Message Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: Message -> Value #

toEncoding :: Message -> Encoding #

toJSONList :: [Message] -> Value #

toEncodingList :: [Message] -> Encoding #

omitField :: Message -> Bool #

Generic Message Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep Message

Instance details

Defined in Claude.V1.Messages

type Rep Message = D1 ('MetaData "Message" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) (S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Role) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Content)) :*: S1 ('MetaSel ('Just "cache_control") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CacheControl)))))

Methods

from :: Message -> Rep Message x #

to :: Rep Message x -> Message #

Show Message Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> Message -> ShowS #

show :: Message -> String #

showList :: [Message] -> ShowS #

type Rep Message Source #

Instance details

Defined in Claude.V1.Messages

type Rep Message = D1 ('MetaData "Message" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) (S1 ('MetaSel ('Just "role") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Role) :*: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Content)) :*: S1 ('MetaSel ('Just "cache_control") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CacheControl)))))

data Role Source #

Role of a message participant

Constructors

User
Assistant

Instances

Instances details

FromJSON Role Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser Role #

parseJSONList :: Value -> Parser [Role] #

omittedField :: Maybe Role #

ToJSON Role Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: Role -> Value #

toEncoding :: Role -> Encoding #

toJSONList :: [Role] -> Value #

toEncodingList :: [Role] -> Encoding #

omitField :: Role -> Bool #

Generic Role Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep Role
Instance details Defined in Claude.V1.Messages type Rep Role = D1 ('MetaData "Role" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Assistant" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Role -> Rep Role x #

to :: Rep Role x -> Role #

Show Role Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> Role -> ShowS #

show :: Role -> String #

showList :: [Role] -> ShowS #

Eq Role Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: Role -> Role -> Bool #

(/=) :: Role -> Role -> Bool #

type Rep Role Source #

Instance details

Defined in Claude.V1.Messages

type Rep Role = D1 ('MetaData "Role" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Assistant" 'PrefixI 'False) (U1 :: Type -> Type))

Response types

data StopReason Source #

Reason why the model stopped generating

Constructors

End_Turn
Max_Tokens
Stop_Sequence
Tool_Use
Refusal	Model refused the request for safety reasons (structured outputs only)

Instances

Instances details

FromJSON StopReason Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser StopReason #

parseJSONList :: Value -> Parser [StopReason] #

omittedField :: Maybe StopReason #

ToJSON StopReason Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: StopReason -> Value #

toEncoding :: StopReason -> Encoding #

toJSONList :: [StopReason] -> Value #

toEncodingList :: [StopReason] -> Encoding #

omitField :: StopReason -> Bool #

Generic StopReason Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep StopReason

Instance details

Defined in Claude.V1.Messages

type Rep StopReason = D1 ('MetaData "StopReason" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) ((C1 ('MetaCons "End_Turn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Max_Tokens" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Stop_Sequence" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Tool_Use" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Refusal" 'PrefixI 'False) (U1 :: Type -> Type))))

Methods

from :: StopReason -> Rep StopReason x #

to :: Rep StopReason x -> StopReason #

Show StopReason Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> StopReason -> ShowS #

show :: StopReason -> String #

showList :: [StopReason] -> ShowS #

Eq StopReason Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: StopReason -> StopReason -> Bool #

(/=) :: StopReason -> StopReason -> Bool #

type Rep StopReason Source #

Instance details

Defined in Claude.V1.Messages

type Rep StopReason = D1 ('MetaData "StopReason" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) ((C1 ('MetaCons "End_Turn" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Max_Tokens" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Stop_Sequence" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Tool_Use" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Refusal" 'PrefixI 'False) (U1 :: Type -> Type))))

data Usage Source #

Token usage information

Constructors

Usage
Fields input_tokens :: Natural output_tokens :: Natural cache_creation_input_tokens :: Maybe Natural cache_read_input_tokens :: Maybe Natural server_tool_use :: Maybe ServerToolUseUsage

Instances

Instances details

FromJSON Usage Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser Usage #

parseJSONList :: Value -> Parser [Usage] #

omittedField :: Maybe Usage #

ToJSON Usage Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: Usage -> Value #

toEncoding :: Usage -> Encoding #

toJSONList :: [Usage] -> Value #

toEncodingList :: [Usage] -> Encoding #

omitField :: Usage -> Bool #

Generic Usage Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep Usage

Instance details

Defined in Claude.V1.Messages

type Rep Usage = D1 ('MetaData "Usage" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "output_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "cache_creation_input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "cache_read_input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "server_tool_use") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ServerToolUseUsage))))))

Methods

from :: Usage -> Rep Usage x #

to :: Rep Usage x -> Usage #

Show Usage Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> Usage -> ShowS #

show :: Usage -> String #

showList :: [Usage] -> ShowS #

type Rep Usage Source #

Instance details

Defined in Claude.V1.Messages

type Rep Usage = D1 ('MetaData "Usage" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Usage" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "output_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "cache_creation_input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "cache_read_input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "server_tool_use") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ServerToolUseUsage))))))

data ServerToolUseUsage Source #

Server tool use usage information (e.g., tool search requests, web search requests)

Constructors

ServerToolUseUsage
Fields web_search_requests :: Maybe Natural tool_search_requests :: Maybe Natural

Instances

Instances details

FromJSON ServerToolUseUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ServerToolUseUsage #

parseJSONList :: Value -> Parser [ServerToolUseUsage] #

omittedField :: Maybe ServerToolUseUsage #

ToJSON ServerToolUseUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ServerToolUseUsage -> Value #

toEncoding :: ServerToolUseUsage -> Encoding #

toJSONList :: [ServerToolUseUsage] -> Value #

toEncodingList :: [ServerToolUseUsage] -> Encoding #

omitField :: ServerToolUseUsage -> Bool #

Generic ServerToolUseUsage Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ServerToolUseUsage

Instance details

Defined in Claude.V1.Messages

type Rep ServerToolUseUsage = D1 ('MetaData "ServerToolUseUsage" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ServerToolUseUsage" 'PrefixI 'True) (S1 ('MetaSel ('Just "web_search_requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "tool_search_requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))))

Methods

from :: ServerToolUseUsage -> Rep ServerToolUseUsage x #

to :: Rep ServerToolUseUsage x -> ServerToolUseUsage #

Show ServerToolUseUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ServerToolUseUsage -> ShowS #

show :: ServerToolUseUsage -> String #

showList :: [ServerToolUseUsage] -> ShowS #

Eq ServerToolUseUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: ServerToolUseUsage -> ServerToolUseUsage -> Bool #

(/=) :: ServerToolUseUsage -> ServerToolUseUsage -> Bool #

type Rep ServerToolUseUsage Source #

Instance details

Defined in Claude.V1.Messages

type Rep ServerToolUseUsage = D1 ('MetaData "ServerToolUseUsage" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ServerToolUseUsage" 'PrefixI 'True) (S1 ('MetaSel ('Just "web_search_requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "tool_search_requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))))

Tool search response types

data ToolReference Source #

A reference to a tool found by tool search

Constructors

ToolReference
Fields tool_name :: Text

Instances

Instances details

FromJSON ToolReference Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ToolReference #

parseJSONList :: Value -> Parser [ToolReference] #

omittedField :: Maybe ToolReference #

ToJSON ToolReference Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ToolReference -> Value #

toEncoding :: ToolReference -> Encoding #

toJSONList :: [ToolReference] -> Value #

toEncodingList :: [ToolReference] -> Encoding #

omitField :: ToolReference -> Bool #

Generic ToolReference Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ToolReference
Instance details Defined in Claude.V1.Messages type Rep ToolReference = D1 ('MetaData "ToolReference" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolReference" 'PrefixI 'True) (S1 ('MetaSel ('Just "tool_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: ToolReference -> Rep ToolReference x #

to :: Rep ToolReference x -> ToolReference #

Show ToolReference Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ToolReference -> ShowS #

show :: ToolReference -> String #

showList :: [ToolReference] -> ShowS #

Eq ToolReference Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: ToolReference -> ToolReference -> Bool #

(/=) :: ToolReference -> ToolReference -> Bool #

type Rep ToolReference Source #

Instance details

Defined in Claude.V1.Messages

type Rep ToolReference = D1 ('MetaData "ToolReference" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolReference" 'PrefixI 'True) (S1 ('MetaSel ('Just "tool_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ToolSearchToolResultContent Source #

Content of a tool search tool result

This can be either successful search results with tool references, an error, or an unknown type for forward compatibility.

Constructors

ToolSearchResult
Fields tool_references :: Vector ToolReference
ToolSearchError
Fields error_code :: Text
ToolSearchResultContent_Unknown Value

Instances

Instances details

FromJSON ToolSearchToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods parseJSON :: Value -> Parser ToolSearchToolResultContent # parseJSONList :: Value -> Parser [ToolSearchToolResultContent] # omittedField :: Maybe ToolSearchToolResultContent #
ToJSON ToolSearchToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods toJSON :: ToolSearchToolResultContent -> Value # toEncoding :: ToolSearchToolResultContent -> Encoding # toJSONList :: [ToolSearchToolResultContent] -> Value # toEncodingList :: [ToolSearchToolResultContent] -> Encoding # omitField :: ToolSearchToolResultContent -> Bool #
Show ToolSearchToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods showsPrec :: Int -> ToolSearchToolResultContent -> ShowS # show :: ToolSearchToolResultContent -> String # showList :: [ToolSearchToolResultContent] -> ShowS #
Eq ToolSearchToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods (==) :: ToolSearchToolResultContent -> ToolSearchToolResultContent -> Bool # (/=) :: ToolSearchToolResultContent -> ToolSearchToolResultContent -> Bool #

Programmatic tool calling (PTC) types

data ContainerInfo Source #

Container information for programmatic tool calling (PTC)

When using code execution, Claude runs code in a container. The container can be reused across multiple turns by passing its id in subsequent requests.

Constructors

ContainerInfo
Fields id :: Text expires_at :: UTCTime

Instances

Instances details

FromJSON ContainerInfo Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ContainerInfo #

parseJSONList :: Value -> Parser [ContainerInfo] #

omittedField :: Maybe ContainerInfo #

ToJSON ContainerInfo Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ContainerInfo -> Value #

toEncoding :: ContainerInfo -> Encoding #

toJSONList :: [ContainerInfo] -> Value #

toEncodingList :: [ContainerInfo] -> Encoding #

omitField :: ContainerInfo -> Bool #

Generic ContainerInfo Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ContainerInfo

Instance details

Defined in Claude.V1.Messages

type Rep ContainerInfo = D1 ('MetaData "ContainerInfo" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ContainerInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Methods

from :: ContainerInfo -> Rep ContainerInfo x #

to :: Rep ContainerInfo x -> ContainerInfo #

Show ContainerInfo Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ContainerInfo -> ShowS #

show :: ContainerInfo -> String #

showList :: [ContainerInfo] -> ShowS #

Eq ContainerInfo Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: ContainerInfo -> ContainerInfo -> Bool #

(/=) :: ContainerInfo -> ContainerInfo -> Bool #

type Rep ContainerInfo Source #

Instance details

Defined in Claude.V1.Messages

type Rep ContainerInfo = D1 ('MetaData "ContainerInfo" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ContainerInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

data ToolCaller Source #

Identifies who called a tool (for programmatic tool calling)

ToolCaller_Direct: Claude called the tool directly
ToolCaller_CodeExecution: Code execution called the tool programmatically
ToolCaller_Unknown: Unknown caller type (forward compatibility)

Constructors

ToolCaller_Direct
ToolCaller_CodeExecution
Fields tool_id :: Text
ToolCaller_Unknown Value

Instances

Instances details

FromJSON ToolCaller Source #
Instance details Defined in Claude.V1.Messages Methods parseJSON :: Value -> Parser ToolCaller # parseJSONList :: Value -> Parser [ToolCaller] # omittedField :: Maybe ToolCaller #
ToJSON ToolCaller Source #
Instance details Defined in Claude.V1.Messages Methods toJSON :: ToolCaller -> Value # toEncoding :: ToolCaller -> Encoding # toJSONList :: [ToolCaller] -> Value # toEncodingList :: [ToolCaller] -> Encoding # omitField :: ToolCaller -> Bool #
Show ToolCaller Source #
Instance details Defined in Claude.V1.Messages Methods showsPrec :: Int -> ToolCaller -> ShowS # show :: ToolCaller -> String # showList :: [ToolCaller] -> ShowS #
Eq ToolCaller Source #
Instance details Defined in Claude.V1.Messages Methods (==) :: ToolCaller -> ToolCaller -> Bool # (/=) :: ToolCaller -> ToolCaller -> Bool #

data CodeExecutionResult Source #

Result from code execution

Contains stdout, stderr, return code, and any additional content (e.g., generated files, images).

Constructors

CodeExecutionResult
Fields stdout :: Text stderr :: Text return_code :: Int content :: Vector Value

Instances

Instances details

FromJSON CodeExecutionResult Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser CodeExecutionResult #

parseJSONList :: Value -> Parser [CodeExecutionResult] #

omittedField :: Maybe CodeExecutionResult #

ToJSON CodeExecutionResult Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: CodeExecutionResult -> Value #

toEncoding :: CodeExecutionResult -> Encoding #

toJSONList :: [CodeExecutionResult] -> Value #

toEncodingList :: [CodeExecutionResult] -> Encoding #

omitField :: CodeExecutionResult -> Bool #

Generic CodeExecutionResult Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep CodeExecutionResult

Instance details

Defined in Claude.V1.Messages

type Rep CodeExecutionResult = D1 ('MetaData "CodeExecutionResult" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "CodeExecutionResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stdout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "stderr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "return_code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Value)))))

Methods

from :: CodeExecutionResult -> Rep CodeExecutionResult x #

to :: Rep CodeExecutionResult x -> CodeExecutionResult #

Show CodeExecutionResult Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> CodeExecutionResult -> ShowS #

show :: CodeExecutionResult -> String #

showList :: [CodeExecutionResult] -> ShowS #

Eq CodeExecutionResult Source #

Instance details

Defined in Claude.V1.Messages

Methods

(==) :: CodeExecutionResult -> CodeExecutionResult -> Bool #

(/=) :: CodeExecutionResult -> CodeExecutionResult -> Bool #

type Rep CodeExecutionResult Source #

Instance details

Defined in Claude.V1.Messages

type Rep CodeExecutionResult = D1 ('MetaData "CodeExecutionResult" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "CodeExecutionResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stdout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "stderr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "return_code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Value)))))

data CodeExecutionToolResultContent Source #

Content of a code execution tool result

CodeExecutionResultContent: Successful execution with stdout/stderr
CodeExecutionToolResultContent_Unknown: Unknown content type (forward compatibility)

Constructors

CodeExecutionResultContent CodeExecutionResult
CodeExecutionToolResultContent_Unknown Value

Instances

Instances details

FromJSON CodeExecutionToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods parseJSON :: Value -> Parser CodeExecutionToolResultContent # parseJSONList :: Value -> Parser [CodeExecutionToolResultContent] # omittedField :: Maybe CodeExecutionToolResultContent #
ToJSON CodeExecutionToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods toJSON :: CodeExecutionToolResultContent -> Value # toEncoding :: CodeExecutionToolResultContent -> Encoding # toJSONList :: [CodeExecutionToolResultContent] -> Value # toEncodingList :: [CodeExecutionToolResultContent] -> Encoding # omitField :: CodeExecutionToolResultContent -> Bool #
Show CodeExecutionToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods showsPrec :: Int -> CodeExecutionToolResultContent -> ShowS # show :: CodeExecutionToolResultContent -> String # showList :: [CodeExecutionToolResultContent] -> ShowS #
Eq CodeExecutionToolResultContent Source #
Instance details Defined in Claude.V1.Messages Methods (==) :: CodeExecutionToolResultContent -> CodeExecutionToolResultContent -> Bool # (/=) :: CodeExecutionToolResultContent -> CodeExecutionToolResultContent -> Bool #

contentBlockToContent :: ContentBlock -> Maybe Content Source #

Convert a response ContentBlock to a request Content for replaying

This is useful for programmatic tool calling (PTC) where you need to replay assistant messages in subsequent requests.

Returns Nothing for content blocks that don't need to be replayed:

Tool types (re-exported from Claude.V1.Tool)

data Tool Source #

A tool that can be used by Claude

Tools allow Claude to call external functions. When Claude decides to use a tool, it will return a tool_use content block with the tool name and input arguments.

Set strict = Just True to enable strict schema validation (structured outputs). This requires the structured-outputs-2025-11-13 beta header.

Constructors

Tool
Fields name :: Text description :: Maybe Text input_schema :: InputSchema strict :: Maybe Bool Enable strict schema validation for tool inputs (structured outputs beta)

Instances

Instances details

FromJSON Tool Source #

Instance details

Defined in Claude.V1.Tool

Methods

parseJSON :: Value -> Parser Tool #

parseJSONList :: Value -> Parser [Tool] #

omittedField :: Maybe Tool #

ToJSON Tool Source #

Instance details

Defined in Claude.V1.Tool

Methods

toJSON :: Tool -> Value #

toEncoding :: Tool -> Encoding #

toJSONList :: [Tool] -> Value #

toEncodingList :: [Tool] -> Encoding #

omitField :: Tool -> Bool #

Generic Tool Source #

Instance details

Defined in Claude.V1.Tool

Associated Types

type Rep Tool

Instance details

Defined in Claude.V1.Tool

type Rep Tool = D1 ('MetaData "Tool" "Claude.V1.Tool" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Tool" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "input_schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputSchema) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: Tool -> Rep Tool x #

to :: Rep Tool x -> Tool #

Show Tool Source #

Instance details

Defined in Claude.V1.Tool

Methods

showsPrec :: Int -> Tool -> ShowS #

show :: Tool -> String #

showList :: [Tool] -> ShowS #

Eq Tool Source #

Instance details

Defined in Claude.V1.Tool

Methods

(==) :: Tool -> Tool -> Bool #

(/=) :: Tool -> Tool -> Bool #

type Rep Tool Source #

Instance details

Defined in Claude.V1.Tool

type Rep Tool = D1 ('MetaData "Tool" "Claude.V1.Tool" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Tool" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "input_schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputSchema) :*: S1 ('MetaSel ('Just "strict") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data ToolChoice Source #

Controls which tool the model should use

Constructors

ToolChoice_Auto	Let Claude decide whether to use tools
ToolChoice_Any	Force Claude to use one of the provided tools
ToolChoice_Tool	Force Claude to use a specific tool
Fields name :: Text

Instances

Instances details

FromJSON ToolChoice Source #

Instance details

Defined in Claude.V1.Tool

Methods

parseJSON :: Value -> Parser ToolChoice #

parseJSONList :: Value -> Parser [ToolChoice] #

omittedField :: Maybe ToolChoice #

ToJSON ToolChoice Source #

Instance details

Defined in Claude.V1.Tool

Methods

toJSON :: ToolChoice -> Value #

toEncoding :: ToolChoice -> Encoding #

toJSONList :: [ToolChoice] -> Value #

toEncodingList :: [ToolChoice] -> Encoding #

omitField :: ToolChoice -> Bool #

Generic ToolChoice Source #

Instance details

Defined in Claude.V1.Tool

Associated Types

type Rep ToolChoice

Instance details

Defined in Claude.V1.Tool

type Rep ToolChoice = D1 ('MetaData "ToolChoice" "Claude.V1.Tool" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolChoice_Auto" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ToolChoice_Any" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToolChoice_Tool" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Methods

from :: ToolChoice -> Rep ToolChoice x #

to :: Rep ToolChoice x -> ToolChoice #

Show ToolChoice Source #

Instance details

Defined in Claude.V1.Tool

Methods

showsPrec :: Int -> ToolChoice -> ShowS #

show :: ToolChoice -> String #

showList :: [ToolChoice] -> ShowS #

type Rep ToolChoice Source #

Instance details

Defined in Claude.V1.Tool

type Rep ToolChoice = D1 ('MetaData "ToolChoice" "Claude.V1.Tool" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "ToolChoice_Auto" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ToolChoice_Any" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ToolChoice_Tool" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data InputSchema Source #

Tool input schema (JSON Schema)

The schema follows JSON Schema format. At minimum, specify type_ as "object". For strict mode (structured outputs), set additionalProperties = Just False.

Constructors

InputSchema
Fields type_ :: Text properties :: Maybe Value required :: Maybe (Vector Text) additionalProperties :: Maybe Bool For strict mode, must be `Just False`

Instances

Instances details

FromJSON InputSchema Source #

Instance details

Defined in Claude.V1.Tool

Methods

parseJSON :: Value -> Parser InputSchema #

parseJSONList :: Value -> Parser [InputSchema] #

omittedField :: Maybe InputSchema #

ToJSON InputSchema Source #

Instance details

Defined in Claude.V1.Tool

Methods

toJSON :: InputSchema -> Value #

toEncoding :: InputSchema -> Encoding #

toJSONList :: [InputSchema] -> Value #

toEncodingList :: [InputSchema] -> Encoding #

omitField :: InputSchema -> Bool #

Generic InputSchema Source #

Instance details

Defined in Claude.V1.Tool

Associated Types

type Rep InputSchema

Instance details

Defined in Claude.V1.Tool

type Rep InputSchema = D1 ('MetaData "InputSchema" "Claude.V1.Tool" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "InputSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text))) :*: S1 ('MetaSel ('Just "additionalProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: InputSchema -> Rep InputSchema x #

to :: Rep InputSchema x -> InputSchema #

Show InputSchema Source #

Instance details

Defined in Claude.V1.Tool

Methods

showsPrec :: Int -> InputSchema -> ShowS #

show :: InputSchema -> String #

showList :: [InputSchema] -> ShowS #

Eq InputSchema Source #

Instance details

Defined in Claude.V1.Tool

Methods

(==) :: InputSchema -> InputSchema -> Bool #

(/=) :: InputSchema -> InputSchema -> Bool #

type Rep InputSchema Source #

Instance details

Defined in Claude.V1.Tool

type Rep InputSchema = D1 ('MetaData "InputSchema" "Claude.V1.Tool" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "InputSchema" 'PrefixI 'True) ((S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value))) :*: (S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text))) :*: S1 ('MetaSel ('Just "additionalProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data ToolDefinition Source #

A tool definition for the tools array

The tools array in Claude API requests is heterogeneous:

Function tools: regular tools with name, description, and input schema
Tool search tools: server-side tool search configuration
Code execution tool: for programmatic tool calling (PTC)

Use inlineTool or deferredTool to wrap a Tool, or toolSearchRegex/toolSearchBm25 to add tool search capability. Use codeExecutionTool for PTC.

Constructors

ToolDef_Function
Fields tool :: Tool defer_loading :: Maybe Bool allowed_callers :: Maybe (Vector Text)
ToolDef_SearchTool ToolSearchTool
ToolDef_CodeExecutionTool
Fields name :: Text type_ :: Text

Instances

Instances details

FromJSON ToolDefinition Source #
Instance details Defined in Claude.V1.Tool Methods parseJSON :: Value -> Parser ToolDefinition # parseJSONList :: Value -> Parser [ToolDefinition] # omittedField :: Maybe ToolDefinition #
ToJSON ToolDefinition Source #
Instance details Defined in Claude.V1.Tool Methods toJSON :: ToolDefinition -> Value # toEncoding :: ToolDefinition -> Encoding # toJSONList :: [ToolDefinition] -> Value # toEncodingList :: [ToolDefinition] -> Encoding # omitField :: ToolDefinition -> Bool #
Show ToolDefinition Source #
Instance details Defined in Claude.V1.Tool Methods showsPrec :: Int -> ToolDefinition -> ShowS # show :: ToolDefinition -> String # showList :: [ToolDefinition] -> ShowS #
Eq ToolDefinition Source #
Instance details Defined in Claude.V1.Tool Methods (==) :: ToolDefinition -> ToolDefinition -> Bool # (/=) :: ToolDefinition -> ToolDefinition -> Bool #

data ToolSearchTool Source #

Tool search tool configuration

Used to enable server-side tool search, which allows Claude to efficiently search through large numbers of tools using regex or BM25 matching.

Constructors

ToolSearchTool
Fields name :: Text type_ :: ToolSearchToolType

Instances

Instances details

FromJSON ToolSearchTool Source #
Instance details Defined in Claude.V1.Tool Methods parseJSON :: Value -> Parser ToolSearchTool # parseJSONList :: Value -> Parser [ToolSearchTool] # omittedField :: Maybe ToolSearchTool #
ToJSON ToolSearchTool Source #
Instance details Defined in Claude.V1.Tool Methods toJSON :: ToolSearchTool -> Value # toEncoding :: ToolSearchTool -> Encoding # toJSONList :: [ToolSearchTool] -> Value # toEncodingList :: [ToolSearchTool] -> Encoding # omitField :: ToolSearchTool -> Bool #
Show ToolSearchTool Source #
Instance details Defined in Claude.V1.Tool Methods showsPrec :: Int -> ToolSearchTool -> ShowS # show :: ToolSearchTool -> String # showList :: [ToolSearchTool] -> ShowS #
Eq ToolSearchTool Source #
Instance details Defined in Claude.V1.Tool Methods (==) :: ToolSearchTool -> ToolSearchTool -> Bool # (/=) :: ToolSearchTool -> ToolSearchTool -> Bool #

data ToolSearchToolType Source #

Tool search tool type variants (for server-side tool search)

Constructors

ToolSearchTool_Regex_20251119
ToolSearchTool_Bm25_20251119

Instances

Instances details

FromJSON ToolSearchToolType Source #
Instance details Defined in Claude.V1.Tool Methods parseJSON :: Value -> Parser ToolSearchToolType # parseJSONList :: Value -> Parser [ToolSearchToolType] # omittedField :: Maybe ToolSearchToolType #
ToJSON ToolSearchToolType Source #
Instance details Defined in Claude.V1.Tool Methods toJSON :: ToolSearchToolType -> Value # toEncoding :: ToolSearchToolType -> Encoding # toJSONList :: [ToolSearchToolType] -> Value # toEncodingList :: [ToolSearchToolType] -> Encoding # omitField :: ToolSearchToolType -> Bool #
Show ToolSearchToolType Source #
Instance details Defined in Claude.V1.Tool Methods showsPrec :: Int -> ToolSearchToolType -> ShowS # show :: ToolSearchToolType -> String # showList :: [ToolSearchToolType] -> ShowS #
Eq ToolSearchToolType Source #
Instance details Defined in Claude.V1.Tool Methods (==) :: ToolSearchToolType -> ToolSearchToolType -> Bool # (/=) :: ToolSearchToolType -> ToolSearchToolType -> Bool #

functionTool Source #

Arguments

:: Text	Tool name (must match [a-zA-Z0-9_-]+)
-> Maybe Text	Description of what the tool does
-> Value	JSON Schema for the input parameters
-> Tool

Create a function tool with a name, description, and JSON schema for parameters

This is the primary way to define tools for Claude. To enable strict schema validation, use strictFunctionTool instead.

strictFunctionTool Source #

Arguments

:: Text	Tool name (must match [a-zA-Z0-9_-]+)
-> Maybe Text	Description of what the tool does
-> Value	JSON Schema for the input parameters
-> Tool

Create a function tool with strict schema validation enabled

This is like functionTool but enables strict mode for structured outputs. Automatically sets additionalProperties = False as required by the API. Requires the structured-outputs-2025-11-13 beta header.

inlineTool :: Tool -> ToolDefinition Source #

Wrap a tool for inline (non-deferred) loading

deferredTool :: Tool -> ToolDefinition Source #

Wrap a tool for deferred loading (used with tool search)

toolSearchRegex :: ToolDefinition Source #

Tool search using regex matching

Requires anthropic-beta: advanced-tool-use-2025-11-20 header.

toolSearchBm25 :: ToolDefinition Source #

Tool search using BM25 matching

Requires anthropic-beta: advanced-tool-use-2025-11-20 header.

codeExecutionTool :: ToolDefinition Source #

Code execution tool for programmatic tool calling (PTC)

Requires anthropic-beta: advanced-tool-use-2025-11-20 header. When included in the tools array, Claude can write and execute code to call other tools programmatically.

allowedCallersCodeExecution :: Vector Text Source #

Allowed callers for code execution (PTC)

Use with allowCallers to mark a function tool as callable by code execution.

allowCallers :: Vector Text -> ToolDefinition -> ToolDefinition Source #

Set allowed_callers on a function tool definition

Only affects ToolDef_Function; other tool types are returned unchanged.

Example:

allowCallers allowedCallersCodeExecution (inlineTool myTool)

toolChoiceAuto :: ToolChoice Source #

Convenience: auto tool choice (let Claude decide)

toolChoiceAny :: ToolChoice Source #

Convenience: any tool choice (force tool use)

toolChoiceTool :: Text -> ToolChoice Source #

Convenience: specific tool choice

Streaming types

data ContentBlockDelta Source #

Content block delta in streaming

Constructors

Delta_Text_Delta
Fields text :: Text
Delta_Input_Json_Delta
Fields partial_json :: Text

Instances

Instances details

FromJSON ContentBlockDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser ContentBlockDelta #

parseJSONList :: Value -> Parser [ContentBlockDelta] #

omittedField :: Maybe ContentBlockDelta #

ToJSON ContentBlockDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: ContentBlockDelta -> Value #

toEncoding :: ContentBlockDelta -> Encoding #

toJSONList :: [ContentBlockDelta] -> Value #

toEncodingList :: [ContentBlockDelta] -> Encoding #

omitField :: ContentBlockDelta -> Bool #

Generic ContentBlockDelta Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep ContentBlockDelta

Instance details

Defined in Claude.V1.Messages

type Rep ContentBlockDelta = D1 ('MetaData "ContentBlockDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Delta_Text_Delta" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Delta_Input_Json_Delta" 'PrefixI 'True) (S1 ('MetaSel ('Just "partial_json") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: ContentBlockDelta -> Rep ContentBlockDelta x #

to :: Rep ContentBlockDelta x -> ContentBlockDelta #

Show ContentBlockDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> ContentBlockDelta -> ShowS #

show :: ContentBlockDelta -> String #

showList :: [ContentBlockDelta] -> ShowS #

type Rep ContentBlockDelta Source #

Instance details

Defined in Claude.V1.Messages

type Rep ContentBlockDelta = D1 ('MetaData "ContentBlockDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "Delta_Text_Delta" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Delta_Input_Json_Delta" 'PrefixI 'True) (S1 ('MetaSel ('Just "partial_json") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data TextDelta Source #

Text delta in streaming

Constructors

TextDelta
Fields text :: Text

Instances

Instances details

FromJSON TextDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser TextDelta #

parseJSONList :: Value -> Parser [TextDelta] #

omittedField :: Maybe TextDelta #

ToJSON TextDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: TextDelta -> Value #

toEncoding :: TextDelta -> Encoding #

toJSONList :: [TextDelta] -> Value #

toEncodingList :: [TextDelta] -> Encoding #

omitField :: TextDelta -> Bool #

Generic TextDelta Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep TextDelta
Instance details Defined in Claude.V1.Messages type Rep TextDelta = D1 ('MetaData "TextDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "TextDelta" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: TextDelta -> Rep TextDelta x #

to :: Rep TextDelta x -> TextDelta #

Show TextDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> TextDelta -> ShowS #

show :: TextDelta -> String #

showList :: [TextDelta] -> ShowS #

type Rep TextDelta Source #

Instance details

Defined in Claude.V1.Messages

type Rep TextDelta = D1 ('MetaData "TextDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "TextDelta" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data InputJsonDelta Source #

Input JSON delta in streaming (for tool use)

Constructors

InputJsonDelta
Fields partial_json :: Text

Instances

Instances details

FromJSON InputJsonDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser InputJsonDelta #

parseJSONList :: Value -> Parser [InputJsonDelta] #

omittedField :: Maybe InputJsonDelta #

ToJSON InputJsonDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: InputJsonDelta -> Value #

toEncoding :: InputJsonDelta -> Encoding #

toJSONList :: [InputJsonDelta] -> Value #

toEncodingList :: [InputJsonDelta] -> Encoding #

omitField :: InputJsonDelta -> Bool #

Generic InputJsonDelta Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep InputJsonDelta
Instance details Defined in Claude.V1.Messages type Rep InputJsonDelta = D1 ('MetaData "InputJsonDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "InputJsonDelta" 'PrefixI 'True) (S1 ('MetaSel ('Just "partial_json") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: InputJsonDelta -> Rep InputJsonDelta x #

to :: Rep InputJsonDelta x -> InputJsonDelta #

Show InputJsonDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> InputJsonDelta -> ShowS #

show :: InputJsonDelta -> String #

showList :: [InputJsonDelta] -> ShowS #

type Rep InputJsonDelta Source #

Instance details

Defined in Claude.V1.Messages

type Rep InputJsonDelta = D1 ('MetaData "InputJsonDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "InputJsonDelta" 'PrefixI 'True) (S1 ('MetaSel ('Just "partial_json") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data MessageDelta Source #

Message delta in streaming (for stop_reason, etc.)

Constructors

MessageDelta
Fields stop_reason :: Maybe StopReason stop_sequence :: Maybe Text

Instances

Instances details

FromJSON MessageDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser MessageDelta #

parseJSONList :: Value -> Parser [MessageDelta] #

omittedField :: Maybe MessageDelta #

ToJSON MessageDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: MessageDelta -> Value #

toEncoding :: MessageDelta -> Encoding #

toJSONList :: [MessageDelta] -> Value #

toEncodingList :: [MessageDelta] -> Encoding #

omitField :: MessageDelta -> Bool #

Generic MessageDelta Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep MessageDelta

Instance details

Defined in Claude.V1.Messages

type Rep MessageDelta = D1 ('MetaData "MessageDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "MessageDelta" 'PrefixI 'True) (S1 ('MetaSel ('Just "stop_reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StopReason)) :*: S1 ('MetaSel ('Just "stop_sequence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

Methods

from :: MessageDelta -> Rep MessageDelta x #

to :: Rep MessageDelta x -> MessageDelta #

Show MessageDelta Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> MessageDelta -> ShowS #

show :: MessageDelta -> String #

showList :: [MessageDelta] -> ShowS #

type Rep MessageDelta Source #

Instance details

Defined in Claude.V1.Messages

type Rep MessageDelta = D1 ('MetaData "MessageDelta" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "MessageDelta" 'PrefixI 'True) (S1 ('MetaSel ('Just "stop_reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StopReason)) :*: S1 ('MetaSel ('Just "stop_sequence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

data StreamUsage Source #

Usage in streaming message_delta events

Constructors

StreamUsage
Fields output_tokens :: Natural

Instances

Instances details

FromJSON StreamUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser StreamUsage #

parseJSONList :: Value -> Parser [StreamUsage] #

omittedField :: Maybe StreamUsage #

ToJSON StreamUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: StreamUsage -> Value #

toEncoding :: StreamUsage -> Encoding #

toJSONList :: [StreamUsage] -> Value #

toEncodingList :: [StreamUsage] -> Encoding #

omitField :: StreamUsage -> Bool #

Generic StreamUsage Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep StreamUsage
Instance details Defined in Claude.V1.Messages type Rep StreamUsage = D1 ('MetaData "StreamUsage" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "StreamUsage" 'PrefixI 'True) (S1 ('MetaSel ('Just "output_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Methods

from :: StreamUsage -> Rep StreamUsage x #

to :: Rep StreamUsage x -> StreamUsage #

Show StreamUsage Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> StreamUsage -> ShowS #

show :: StreamUsage -> String #

showList :: [StreamUsage] -> ShowS #

type Rep StreamUsage Source #

Instance details

Defined in Claude.V1.Messages

type Rep StreamUsage = D1 ('MetaData "StreamUsage" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "StreamUsage" 'PrefixI 'True) (S1 ('MetaSel ('Just "output_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Token counting

data CountTokensRequest Source #

Request body for /v1/messages/count_tokens

Note: This differs from CreateMessage - it doesn't include max_tokens and other generation parameters.

Constructors

CountTokensRequest
Fields model :: Text messages :: Vector Message system :: Maybe Text tools :: Maybe (Vector ToolDefinition) tool_choice :: Maybe ToolChoice

Instances

Instances details

FromJSON CountTokensRequest Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser CountTokensRequest #

parseJSONList :: Value -> Parser [CountTokensRequest] #

omittedField :: Maybe CountTokensRequest #

ToJSON CountTokensRequest Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: CountTokensRequest -> Value #

toEncoding :: CountTokensRequest -> Encoding #

toJSONList :: [CountTokensRequest] -> Value #

toEncodingList :: [CountTokensRequest] -> Encoding #

omitField :: CountTokensRequest -> Bool #

Generic CountTokensRequest Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep CountTokensRequest

Instance details

Defined in Claude.V1.Messages

type Rep CountTokensRequest = D1 ('MetaData "CountTokensRequest" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "CountTokensRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Message))) :*: (S1 ('MetaSel ('Just "system") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector ToolDefinition))) :*: S1 ('MetaSel ('Just "tool_choice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolChoice))))))

Methods

from :: CountTokensRequest -> Rep CountTokensRequest x #

to :: Rep CountTokensRequest x -> CountTokensRequest #

Show CountTokensRequest Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> CountTokensRequest -> ShowS #

show :: CountTokensRequest -> String #

showList :: [CountTokensRequest] -> ShowS #

type Rep CountTokensRequest Source #

Instance details

Defined in Claude.V1.Messages

type Rep CountTokensRequest = D1 ('MetaData "CountTokensRequest" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "CountTokensRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Message))) :*: (S1 ('MetaSel ('Just "system") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector ToolDefinition))) :*: S1 ('MetaSel ('Just "tool_choice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ToolChoice))))))

_CountTokensRequest :: CountTokensRequest Source #

Default CountTokensRequest

data TokenCount Source #

Response from the token counting endpoint

Constructors

TokenCount
Fields input_tokens :: Natural

Instances

Instances details

FromJSON TokenCount Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser TokenCount #

parseJSONList :: Value -> Parser [TokenCount] #

omittedField :: Maybe TokenCount #

ToJSON TokenCount Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: TokenCount -> Value #

toEncoding :: TokenCount -> Encoding #

toJSONList :: [TokenCount] -> Value #

toEncodingList :: [TokenCount] -> Encoding #

omitField :: TokenCount -> Bool #

Generic TokenCount Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep TokenCount
Instance details Defined in Claude.V1.Messages type Rep TokenCount = D1 ('MetaData "TokenCount" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "TokenCount" 'PrefixI 'True) (S1 ('MetaSel ('Just "input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Methods

from :: TokenCount -> Rep TokenCount x #

to :: Rep TokenCount x -> TokenCount #

Show TokenCount Source #

Instance details

Defined in Claude.V1.Messages

Methods

showsPrec :: Int -> TokenCount -> ShowS #

show :: TokenCount -> String #

showList :: [TokenCount] -> ShowS #

type Rep TokenCount Source #

Instance details

Defined in Claude.V1.Messages

type Rep TokenCount = D1 ('MetaData "TokenCount" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "TokenCount" 'PrefixI 'True) (S1 ('MetaSel ('Just "input_tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

Prompt caching

data CacheControl Source #

Cache control for prompt caching

Constructors

CacheControl
Fields type_ :: Text Currently only "ephemeral" is supported

Instances

Instances details

FromJSON CacheControl Source #

Instance details

Defined in Claude.V1.Messages

Methods

parseJSON :: Value -> Parser CacheControl #

parseJSONList :: Value -> Parser [CacheControl] #

omittedField :: Maybe CacheControl #

ToJSON CacheControl Source #

Instance details

Defined in Claude.V1.Messages

Methods

toJSON :: CacheControl -> Value #

toEncoding :: CacheControl -> Encoding #

toJSONList :: [CacheControl] -> Value #

toEncodingList :: [CacheControl] -> Encoding #

omitField :: CacheControl -> Bool #

Generic CacheControl Source #

Instance details

Defined in Claude.V1.Messages

Associated Types

type Rep CacheControl
Instance details Defined in Claude.V1.Messages type Rep CacheControl = D1 ('MetaData "CacheControl" "Claude.V1.Messages" "claude-1.0.1-EgYZW4derSS3e7Da0dFQBO" 'False) (C1 ('MetaCons "CacheControl" 'PrefixI 'True) (S1 ('MetaSel ('Just "type_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))