GoogleAiLanguageModel.ts overview
Since v1.0.0
Exports Grouped by Category
AiModel
model
Signature
declare const model: (
model: (string & {}) | Model,
config?: Omit<Config.Service, "model">
) => AiModel.AiModel<AiLanguageModel.AiLanguageModel, GoogleAiClient>
Since v1.0.0
Constructors
make
Signature
declare const make: (options: {
readonly model: (string & {}) | Model
readonly config?: Omit<Config.Service, "model">
}) => Effect.Effect<AiLanguageModel.AiLanguageModel.Service, never, GoogleAiClient>
Since v1.0.0
Context
Config (class)
Signature
declare class Config
Since v1.0.0
ProviderMetadata (class)
Signature
declare class ProviderMetadata
Since v1.0.0
Layers
layer
Signature
declare const layer: (options: {
readonly model: (string & {}) | Model
readonly config?: Omit<Config.Service, "model">
}) => Layer.Layer<AiLanguageModel.AiLanguageModel, never, GoogleAiClient>
Since v1.0.0
Models
Model (type alias)
Signature
type Model = string
Since v1.0.0
utils
Config (namespace)
Since v1.0.0
Service (interface)
Signature
export interface Service
extends Simplify<
Partial<
Omit<
typeof Generated.GenerateContentRequest.Encoded,
"contents" | "tools" | "toolConfig" | "systemInstruction"
> & {
readonly toolConfig: Partial<{
readonly functionCallingConfig: Omit<typeof Generated.FunctionCallingConfig.Encoded, "mode">
}>
}
>
> {}
Since v1.0.0
ProviderMetadata (namespace)
Since v1.0.0
Service (interface)
Signature
export interface Service {
/**
* Citations to sources for a specific response.
*/
readonly citationSources?: ReadonlyArray<typeof Generated.CitationSource.Encoded> | undefined
/**
* Attribution information for sources that contributed to a grounded answer.
*/
readonly groundingAttributions?: ReadonlyArray<typeof Generated.GroundingAttribution.Encoded> | undefined
/**
* Grounding metadata for the candidate.
*/
readonly groundingMetadata?: ReadonlyArray<typeof Generated.GroundingMetadata.Encoded> | undefined
/**
* The URLs that were retrieved by the URL context retrieval tool.
*/
readonly retrievedUrls?: ReadonlyArray<typeof Generated.UrlMetadata.Encoded> | undefined
/**
* List of ratings for the safety of a response candidate.
*
* There is at most one rating per category.
*/
readonly safetyRatings?: ReadonlyArray<typeof Generated.SafetyRating.Encoded> | undefined
}
Since v1.0.0