claude-1.0.0: Servant bindings to Anthropic's Claude API
Safe HaskellNone
LanguageHaskell2010

Claude.V1.Messages.Batches

Description

/v1/messages/batches

This module provides types for the Claude Message Batches API. Batches allow asynchronous processing of multiple messages at once.

Synopsis

Request types

data CreateBatch Source #

Request body for creating a batch

Constructors

CreateBatch 

Fields

Instances

Instances details
FromJSON CreateBatch Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON CreateBatch Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic CreateBatch Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep CreateBatch 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep CreateBatch = D1 ('MetaData "CreateBatch" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "CreateBatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector BatchRequest))))
Show CreateBatch Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep CreateBatch Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep CreateBatch = D1 ('MetaData "CreateBatch" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "CreateBatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "requests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector BatchRequest))))

_CreateBatch :: CreateBatch Source #

Default CreateBatch

data BatchRequest Source #

A single request within a batch

Constructors

BatchRequest 

Fields

Instances

Instances details
FromJSON BatchRequest Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON BatchRequest Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic BatchRequest Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep BatchRequest 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchRequest = D1 ('MetaData "BatchRequest" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "BatchRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "custom_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "params") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CreateMessage)))
Show BatchRequest Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchRequest Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchRequest = D1 ('MetaData "BatchRequest" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "BatchRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "custom_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "params") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CreateMessage)))

Response types

data BatchObject Source #

A batch object returned from the API

Instances

Instances details
FromJSON BatchObject Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON BatchObject Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic BatchObject Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Show BatchObject Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchObject Source # 
Instance details

Defined in Claude.V1.Messages.Batches

data ProcessingStatus Source #

Processing status of a batch

Constructors

In_Progress 
Canceling 
Ended 

Instances

Instances details
FromJSON ProcessingStatus Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON ProcessingStatus Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic ProcessingStatus Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep ProcessingStatus 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep ProcessingStatus = D1 ('MetaData "ProcessingStatus" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "In_Progress" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Canceling" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ended" 'PrefixI 'False) (U1 :: Type -> Type)))
Show ProcessingStatus Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Eq ProcessingStatus Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep ProcessingStatus Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep ProcessingStatus = D1 ('MetaData "ProcessingStatus" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "In_Progress" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Canceling" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ended" 'PrefixI 'False) (U1 :: Type -> Type)))

data RequestCounts Source #

Counts of requests in various states

Instances

Instances details
FromJSON RequestCounts Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON RequestCounts Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic RequestCounts Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep RequestCounts 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep RequestCounts = D1 ('MetaData "RequestCounts" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "RequestCounts" 'PrefixI 'True) ((S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "succeeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "errored") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "canceled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "expired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))))
Show RequestCounts Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep RequestCounts Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep RequestCounts = D1 ('MetaData "RequestCounts" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "RequestCounts" 'PrefixI 'True) ((S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "succeeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "errored") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "canceled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "expired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))))

data BatchResult Source #

A single result from a batch

Constructors

BatchResult 

Instances

Instances details
FromJSON BatchResult Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON BatchResult Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic BatchResult Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep BatchResult 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchResult = D1 ('MetaData "BatchResult" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "BatchResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "custom_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BatchResultType)))
Show BatchResult Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchResult Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchResult = D1 ('MetaData "BatchResult" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "BatchResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "custom_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BatchResultType)))

data BatchResultType Source #

Type of result for a batch request

Constructors

Succeeded 
Errored 

Fields

Canceled 
Expired 

Instances

Instances details
FromJSON BatchResultType Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON BatchResultType Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic BatchResultType Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep BatchResultType 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchResultType = D1 ('MetaData "BatchResultType" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) ((C1 ('MetaCons "Succeeded" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageResponse)) :+: C1 ('MetaCons "Errored" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Error))) :+: (C1 ('MetaCons "Canceled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type)))
Show BatchResultType Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchResultType Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep BatchResultType = D1 ('MetaData "BatchResultType" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) ((C1 ('MetaCons "Succeeded" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageResponse)) :+: C1 ('MetaCons "Errored" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Error))) :+: (C1 ('MetaCons "Canceled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type)))

data ListBatchesResponse Source #

Pagination response for listing batches

Instances

Instances details
FromJSON ListBatchesResponse Source # 
Instance details

Defined in Claude.V1.Messages.Batches

ToJSON ListBatchesResponse Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Generic ListBatchesResponse Source # 
Instance details

Defined in Claude.V1.Messages.Batches

Associated Types

type Rep ListBatchesResponse 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep ListBatchesResponse = D1 ('MetaData "ListBatchesResponse" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "ListBatchesResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector BatchObject)) :*: S1 ('MetaSel ('Just "has_more") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "first_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "last_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))
Show ListBatchesResponse Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep ListBatchesResponse Source # 
Instance details

Defined in Claude.V1.Messages.Batches

type Rep ListBatchesResponse = D1 ('MetaData "ListBatchesResponse" "Claude.V1.Messages.Batches" "claude-1.0.0-1j0Plg9n3EjAvfVKcV8Pl0" 'False) (C1 ('MetaCons "ListBatchesResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "data_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector BatchObject)) :*: S1 ('MetaSel ('Just "has_more") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "first_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "last_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Servant

type API = "messages" :> ("batches" :> ((ReqBody '[JSON] CreateBatch :> Post '[JSON] BatchObject) :<|> ((Capture "batch_id" Text :> Get '[JSON] BatchObject) :<|> ((QueryParam "limit" Natural :> (QueryParam "before_id" Text :> (QueryParam "after_id" Text :> Get '[JSON] ListBatchesResponse))) :<|> (Capture "batch_id" Text :> ("cancel" :> Post '[JSON] BatchObject)))))) Source #

Servant API for /v1/messages/batches