AnthropicClient
Constructors
Signature
declare const make: (options: {
readonly anthropicVersion?: string;
readonly apiKey?: Redacted.Redacted;
readonly apiUrl?: string;
readonly organizationId?: Redacted.Redacted;
readonly projectId?: Redacted.Redacted;
readonly transformClient?: (client: HttpClient.HttpClient) => HttpClient.HttpClient;
}) => Effect.Effect<Service, never, HttpClient.HttpClient | Scope.Scope>;Context
AnthropicClient
Added in v1.0.0
Source
Signature
declare class AnthropicClient extends any {
constructor();
}Layers
Signature
declare function layer(options: {
readonly anthropicVersion?: string;
readonly apiKey?: Redacted<string>;
readonly apiUrl?: string;
readonly transformClient?: (client: HttpClient) => HttpClient;
}): Layer<AnthropicClient, never, HttpClient>;layerConfig
Added in v1.0.0
Source
Signature
declare function layerConfig(options: {
readonly anthropicVersion?: Config<string | undefined>;
readonly apiKey?: Config<Redacted<string> | undefined>;
readonly apiUrl?: Config<string | undefined>;
readonly transformClient?: (client: HttpClient) => HttpClient;
}): Layer<AnthropicClient, ConfigError, HttpClient>;Models
MessageStreamEvent type
Added in v1.0.0
Source
Signature
type MessageStreamEvent = typeof MessageStreamEvent.Type;Signature
interface Service {
readonly client: Client;
readonly createMessage: (options: {
readonly params?: any;
readonly payload: {
[key: string]: any;
};
}) => Effect<BetaMessage, AiError>;
readonly createMessageStream: (options: {
readonly params?: any;
readonly payload: Omit<typeof Generated.BetaCreateMessageParams.Encoded, "stream">;
}) => Stream<unknown, AiError>;
readonly streamRequest: <A, I, R>(
request: HttpClientRequest,
schema: any,
) => Stream<A, AiError, R>;
}Schemas
CitationsDelta
Added in v1.0.0
Source
Signature
declare class CitationsDelta extends ReadonlySide<{
readonly citation: Union<readonly Array<Constraint>>;
readonly type: Literal<"citations_delta">;
}, "Type"> {
constructor(...args: [props: ReadonlyMakeIn<{
readonly citation: Union<readonly Array<Constraint>>;
readonly type: Literal<"citations_delta">;
}>, options?: MakeOptions]);
}ContentBlockDeltaEvent
Added in v1.0.0
Source
Signature
declare class ContentBlockDeltaEvent extends ReadonlySide<{
readonly delta: Union<readonly Array<Constraint>>;
readonly index: Int;
readonly type: Literal<"content_block_delta">;
}, "Type"> {
constructor(...args: [props: ReadonlyMakeIn<{
readonly delta: Union<readonly Array<Constraint>>;
readonly index: Int;
readonly type: Literal<"content_block_delta">;
}>, options?: MakeOptions]);
}ContentBlockStartEvent
Added in v1.0.0
Source
Signature
declare class ContentBlockStartEvent extends ReadonlySide<Fields, "Type"> {
[key: string]: unknown;
[key: number]: unknown;
[key: symbol]: unknown;
constructor(...args: [props?: ReadonlyMakeIn<Fields>, options?: MakeOptions]);
}ContentBlockStopEvent
Added in v1.0.0
Source
Signature
declare class ContentBlockStopEvent extends ReadonlySide<
{
readonly index: Int;
readonly type: Literal<"content_block_stop">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly index: Int;
readonly type: Literal<"content_block_stop">;
}>,
options?: MakeOptions,
]
);
}ErrorEvent
Added in v1.0.0
Source
Signature
declare class ErrorEvent extends ReadonlySide<
{
readonly error: Struct<{
readonly message: String;
readonly type: Literal<"invalid_request_error">;
}>;
readonly type: Literal<"error">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly error: Struct<{
readonly message: String;
readonly type: Literal<"invalid_request_error">;
}>;
readonly type: Literal<"error">;
}>,
options?: MakeOptions,
]
);
}InputJsonContentBlockDelta
Added in v1.0.0
Source
Signature
declare class InputJsonContentBlockDelta extends ReadonlySide<
{
readonly partial_json: String;
readonly type: Literal<"input_json_delta">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly partial_json: String;
readonly type: Literal<"input_json_delta">;
}>,
options?: MakeOptions,
]
);
}MessageDelta
Added in v1.0.0
Source
Signature
declare class MessageDelta extends {
[key: string]: any;
} {
[key: string]: any;
constructor(...args: [props?: {
[key: string]: any;
}, options?: MakeOptions]);
}MessageDeltaEvent
Added in v1.0.0
Source
Signature
declare class MessageDeltaEvent extends ReadonlySide<
{
readonly delta: typeof MessageDelta;
readonly type: Literal<"message_delta">;
readonly usage: typeof MessageDeltaUsage;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly delta: typeof MessageDelta;
readonly type: Literal<"message_delta">;
readonly usage: typeof MessageDeltaUsage;
}>,
options?: MakeOptions,
]
);
}MessageDeltaUsage
Added in v1.0.0
Source
Signature
declare class MessageDeltaUsage extends {
[key: string]: any;
} {
[key: string]: any;
constructor(...args: [props?: {
[key: string]: any;
}, options?: MakeOptions]);
}MessageStartEvent
Added in v1.0.0
Source
Signature
declare class MessageStartEvent extends ReadonlySide<
{
readonly message: typeof BetaMessage;
readonly type: Literal<"message_start">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly message: typeof BetaMessage;
readonly type: Literal<"message_start">;
}>,
options?: MakeOptions,
]
);
}MessageStopEvent
Added in v1.0.0
Source
Signature
declare class MessageStopEvent extends ReadonlySide<
{
readonly type: Literal<"message_stop">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly type: Literal<"message_stop">;
}>,
options?: MakeOptions,
]
);
}MessageStreamEvent
Added in v1.0.0
Source
Signature
declare const MessageStreamEvent: Union<readonly Array<Constraint>>Signature
declare class PingEvent extends ReadonlySide<
{
readonly type: Literal<"ping">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly type: Literal<"ping">;
}>,
options?: MakeOptions,
]
);
}ServerToolUsage
Added in v1.0.0
Source
Signature
declare class ServerToolUsage extends {
[key: string]: any;
} {
[key: string]: any;
constructor(...args: [props?: {
[key: string]: any;
}, options?: MakeOptions]);
}SignatureContentBlockDelta
Added in v1.0.0
Source
Signature
declare class SignatureContentBlockDelta extends ReadonlySide<
{
readonly signature: String;
readonly type: Literal<"signature_delta">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly signature: String;
readonly type: Literal<"signature_delta">;
}>,
options?: MakeOptions,
]
);
}TextContentBlockDelta
Added in v1.0.0
Source
Signature
declare class TextContentBlockDelta extends ReadonlySide<
{
readonly text: String;
readonly type: Literal<"text_delta">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly text: String;
readonly type: Literal<"text_delta">;
}>,
options?: MakeOptions,
]
);
}ThinkingContentBlockDelta
Added in v1.0.0
Source
Signature
declare class ThinkingContentBlockDelta extends ReadonlySide<
{
readonly thinking: String;
readonly type: Literal<"thinking_delta">;
},
"Type"
> {
constructor(
...args: [
props: ReadonlyMakeIn<{
readonly thinking: String;
readonly type: Literal<"thinking_delta">;
}>,
options?: MakeOptions,
]
);
}
Represents the interface that the
AnthropicClientservice provides.This service abstracts the complexity of communicating with Anthropic's API, providing both high-level text generation methods and low-level HTTP access for advanced use cases.