Skip to content

Middleware

Symbol kindCount
Case2
Enumeration1
Function19
Initializer13
Instance Property53
Structure13
KindSymbolDeclarationSource
CaseAILanguageModelCallType.generatecase generateSources/SwiftAISDK/MiddlewareTypes.swift
CaseAILanguageModelCallType.streamcase streamSources/SwiftAISDK/MiddlewareTypes.swift
EnumerationAILanguageModelCallTypeenum AILanguageModelCallTypeSources/SwiftAISDK/MiddlewareTypes.swift
FunctionaddToolInputExamplesMiddleware(prefix:remove:format:)func addToolInputExamplesMiddleware(prefix: String = "Input Examples:", remove: Bool = true, format: (@Sendable (AIToolInputExampleFormatContext) -> String)? = nil) -> AILanguageModelMiddlewareSources/SwiftAISDK/ToolInputExamplesMiddleware.swift
FunctiondefaultEmbeddingSettingsMiddleware(settings:)func defaultEmbeddingSettingsMiddleware(settings: AIDefaultEmbeddingModelSettings) -> AIEmbeddingModelMiddlewareSources/SwiftAISDK/DefaultSettingsMiddleware.swift
FunctiondefaultInstructionsMiddleware(instructions:)func defaultInstructionsMiddleware(instructions: String) -> AILanguageModelMiddlewareSources/SwiftAISDK/DefaultSettingsMiddleware.swift
FunctiondefaultInstructionsMiddleware(instructions:)func defaultInstructionsMiddleware(instructions: [AIMessage]) -> AILanguageModelMiddlewareSources/SwiftAISDK/DefaultSettingsMiddleware.swift
FunctiondefaultSettingsMiddleware(settings:)func defaultSettingsMiddleware(settings: AIDefaultLanguageModelSettings) -> AILanguageModelMiddlewareSources/SwiftAISDK/DefaultSettingsMiddleware.swift
FunctionextractJsonMiddleware(transform:)func extractJsonMiddleware(transform: (@Sendable (String) -> String)? = nil) -> AILanguageModelMiddlewareSources/SwiftAISDK/ExtractionMiddleware.swift
FunctionextractJSONMiddleware(transform:)func extractJSONMiddleware(transform: (@Sendable (String) -> String)? = nil) -> AILanguageModelMiddlewareSources/SwiftAISDK/ExtractionMiddleware.swift
FunctionextractReasoningMiddleware(tagName:separator:startWithReasoning:)func extractReasoningMiddleware(tagName: String, separator: String = "\n", startWithReasoning: Bool = false) -> AILanguageModelMiddlewareSources/SwiftAISDK/ExtractionMiddleware.swift
FunctionsimulateStreamingMiddleware()func simulateStreamingMiddleware() -> AILanguageModelMiddlewareSources/SwiftAISDK/ExtractionMiddleware.swift
FunctionwrapEmbeddingModel(_:middleware:modelID:providerID:)func wrapEmbeddingModel(_ model: any EmbeddingModel, middleware: AIEmbeddingModelMiddleware, modelID: String? = nil, providerID: String? = nil) -> any EmbeddingModelSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapEmbeddingModel(_:middleware:modelID:providerID:)func wrapEmbeddingModel(_ model: any EmbeddingModel, middleware: [AIEmbeddingModelMiddleware], modelID: String? = nil, providerID: String? = nil) -> any EmbeddingModelSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapImageModel(_:middleware:modelID:providerID:)func wrapImageModel(_ model: any ImageModel, middleware: AIImageModelMiddleware, modelID: String? = nil, providerID: String? = nil) -> any ImageModelSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapImageModel(_:middleware:modelID:providerID:)func wrapImageModel(_ model: any ImageModel, middleware: [AIImageModelMiddleware], modelID: String? = nil, providerID: String? = nil) -> any ImageModelSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapLanguageModel(_:middleware:modelID:providerID:)func wrapLanguageModel(_ model: any LanguageModel, middleware: AILanguageModelMiddleware, modelID: String? = nil, providerID: String? = nil) -> any LanguageModelSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapLanguageModel(_:middleware:modelID:providerID:)func wrapLanguageModel(_ model: any LanguageModel, middleware: [AILanguageModelMiddleware], modelID: String? = nil, providerID: String? = nil) -> any LanguageModelSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapProvider(_:languageModelMiddleware:imageModelMiddleware:embeddingModelMiddleware:)func wrapProvider(_ provider: any AIProvider, languageModelMiddleware: AILanguageModelMiddleware, imageModelMiddleware: [AIImageModelMiddleware] = [], embeddingModelMiddleware: [AIEmbeddingModelMiddleware] = []) -> any AIProviderSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapProvider(_:languageModelMiddleware:imageModelMiddleware:embeddingModelMiddleware:)func wrapProvider(_ provider: any AIProvider, languageModelMiddleware: [AILanguageModelMiddleware], imageModelMiddleware: [AIImageModelMiddleware] = [], embeddingModelMiddleware: [AIEmbeddingModelMiddleware] = []) -> any AIProviderSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapProvider(_:languageModelMiddleware:imageModelMiddleware:embeddingModelMiddleware:)func wrapProvider(_ provider: any AIProvider, languageModelMiddleware: [AILanguageModelMiddleware] = [], imageModelMiddleware: AIImageModelMiddleware, embeddingModelMiddleware: [AIEmbeddingModelMiddleware] = []) -> any AIProviderSources/SwiftAISDK/MiddlewareWrapping.swift
FunctionwrapProvider(_:languageModelMiddleware:imageModelMiddleware:embeddingModelMiddleware:)func wrapProvider(_ provider: any AIProvider, languageModelMiddleware: [AILanguageModelMiddleware] = [], imageModelMiddleware: [AIImageModelMiddleware] = [], embeddingModelMiddleware: AIEmbeddingModelMiddleware) -> any AIProviderSources/SwiftAISDK/MiddlewareWrapping.swift
Initializerinit(doEmbed:request:model:)init(doEmbed: @escaping @Sendable () async throws -> EmbeddingResult, request: EmbeddingRequest, model: any EmbeddingModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(doGenerate:doStream:request:model:)init(doGenerate: @escaping @Sendable () async throws -> TextGenerationResult, doStream: @escaping @Sendable () -> AsyncThrowingStream<LanguageStreamPart, any Error>, request: LanguageModelRequest, model: any LanguageModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(doGenerate:doStream:request:model:)init(doGenerate: @escaping @Sendable () async throws -> TextGenerationResult, doStream: @escaping @Sendable () -> AsyncThrowingStream<LanguageStreamPart, any Error>, request: LanguageModelRequest, model: any LanguageModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(doGenerate:request:model:)init(doGenerate: @escaping @Sendable () async throws -> ImageGenerationResult, request: ImageGenerationRequest, model: any ImageModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(example:index:)init(example: JSONValue, index: Int)Sources/SwiftAISDK/ToolInputExamplesMiddleware.swift
Initializerinit(overrideProviderID:overrideModelID:transformRequest:wrapEmbed:)init(overrideProviderID: (@Sendable (any EmbeddingModel) -> String)? = nil, overrideModelID: (@Sendable (any EmbeddingModel) -> String)? = nil, transformRequest: (@Sendable (AIEmbeddingModelTransformContext) async throws -> EmbeddingRequest)? = nil, wrapEmbed: (@Sendable (AIEmbeddingModelEmbedContext) async throws -> EmbeddingResult)? = nil)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(overrideProviderID:overrideModelID:transformRequest:wrapGenerate:)init(overrideProviderID: (@Sendable (any ImageModel) -> String)? = nil, overrideModelID: (@Sendable (any ImageModel) -> String)? = nil, transformRequest: (@Sendable (AIImageModelTransformContext) async throws -> ImageGenerationRequest)? = nil, wrapGenerate: (@Sendable (AIImageModelGenerateContext) async throws -> ImageGenerationResult)? = nil)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(overrideProviderID:overrideModelID:transformRequest:wrapGenerate:wrapStream:)init(overrideProviderID: (@Sendable (any LanguageModel) -> String)? = nil, overrideModelID: (@Sendable (any LanguageModel) -> String)? = nil, transformRequest: (@Sendable (AILanguageModelTransformContext) async throws -> LanguageModelRequest)? = nil, wrapGenerate: (@Sendable (AILanguageModelGenerateContext) async throws -> TextGenerationResult)? = nil, wrapStream: (@Sendable (AILanguageModelStreamContext) -> AsyncThrowingStream<LanguageStreamPart, any Error>)? = nil)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(providerOptions:headers:)init(providerOptions: [String : JSONValue] = [:], headers: [String : String] = [:])Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Initializerinit(request:model:)init(request: ImageGenerationRequest, model: any ImageModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(request:model:)init(request: EmbeddingRequest, model: any EmbeddingModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Initializerinit(temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:responseFormat:reasoning:tools:toolChoice:providerOptions:extraBody:headers:)init(temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String]? = nil, responseFormat: AIResponseFormat? = nil, reasoning: String? = nil, tools: [String : JSONValue] = [:], toolChoice: JSONValue? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:])Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Initializerinit(type:request:model:)init(type: AILanguageModelCallType, request: LanguageModelRequest, model: any LanguageModel)Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertydoEmbedvar doEmbed: @Sendable () async throws -> EmbeddingResultSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertydoGeneratevar doGenerate: @Sendable () async throws -> TextGenerationResultSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertydoGeneratevar doGenerate: @Sendable () async throws -> TextGenerationResultSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertydoGeneratevar doGenerate: @Sendable () async throws -> ImageGenerationResultSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertydoStreamvar doStream: @Sendable () -> AsyncThrowingStream<LanguageStreamPart, any Error>Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertydoStreamvar doStream: @Sendable () -> AsyncThrowingStream<LanguageStreamPart, any Error>Sources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyexamplevar example: JSONValueSources/SwiftAISDK/ToolInputExamplesMiddleware.swift
Instance PropertyextraBodyvar extraBody: [String : JSONValue]Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertyfrequencyPenaltyvar frequencyPenalty: Double?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertyheadersvar headers: [String : String]Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertyheadersvar headers: [String : String]Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertyindexvar index: IntSources/SwiftAISDK/ToolInputExamplesMiddleware.swift
Instance PropertymaxOutputTokensvar maxOutputTokens: Int?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertymodelvar model: any LanguageModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertymodelvar model: any LanguageModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertymodelvar model: any LanguageModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertymodelvar model: any ImageModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertymodelvar model: any ImageModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertymodelvar model: any EmbeddingModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertymodelvar model: any EmbeddingModelSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyoverrideModelIDvar overrideModelID: (@Sendable (any LanguageModel) -> String)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyoverrideModelIDvar overrideModelID: (@Sendable (any ImageModel) -> String)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyoverrideModelIDvar overrideModelID: (@Sendable (any EmbeddingModel) -> String)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyoverrideProviderIDvar overrideProviderID: (@Sendable (any LanguageModel) -> String)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyoverrideProviderIDvar overrideProviderID: (@Sendable (any ImageModel) -> String)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyoverrideProviderIDvar overrideProviderID: (@Sendable (any EmbeddingModel) -> String)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertypresencePenaltyvar presencePenalty: Double?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertyproviderOptionsvar providerOptions: [String : JSONValue]Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertyproviderOptionsvar providerOptions: [String : JSONValue]Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertyreasoningvar reasoning: String?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertyrequestvar request: LanguageModelRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyrequestvar request: LanguageModelRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyrequestvar request: LanguageModelRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyrequestvar request: ImageGenerationRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyrequestvar request: ImageGenerationRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyrequestvar request: EmbeddingRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertyrequestvar request: EmbeddingRequestSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertyresponseFormatvar responseFormat: AIResponseFormat?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertyseedvar seed: Int?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertystopSequencesvar stopSequences: [String]?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertytemperaturevar temperature: Double?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertytoolChoicevar toolChoice: JSONValue?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance Propertytoolsvar tools: [String : JSONValue]Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertytopKvar topK: Int?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertytopPvar topP: Double?Sources/SwiftAISDK/DefaultSettingsMiddleware.swift
Instance PropertytransformRequestvar transformRequest: (@Sendable (AILanguageModelTransformContext) async throws -> LanguageModelRequest)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertytransformRequestvar transformRequest: (@Sendable (AIImageModelTransformContext) async throws -> ImageGenerationRequest)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertytransformRequestvar transformRequest: (@Sendable (AIEmbeddingModelTransformContext) async throws -> EmbeddingRequest)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance Propertytypevar type: AILanguageModelCallTypeSources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertywrapEmbedvar wrapEmbed: (@Sendable (AIEmbeddingModelEmbedContext) async throws -> EmbeddingResult)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertywrapGeneratevar wrapGenerate: (@Sendable (AILanguageModelGenerateContext) async throws -> TextGenerationResult)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertywrapGeneratevar wrapGenerate: (@Sendable (AIImageModelGenerateContext) async throws -> ImageGenerationResult)?Sources/SwiftAISDK/MiddlewareTypes.swift
Instance PropertywrapStreamvar wrapStream: (@Sendable (AILanguageModelStreamContext) -> AsyncThrowingStream<LanguageStreamPart, any Error>)?Sources/SwiftAISDK/MiddlewareTypes.swift
StructureAIDefaultEmbeddingModelSettingsstruct AIDefaultEmbeddingModelSettingsSources/SwiftAISDK/DefaultSettingsMiddleware.swift
StructureAIDefaultLanguageModelSettingsstruct AIDefaultLanguageModelSettingsSources/SwiftAISDK/DefaultSettingsMiddleware.swift
StructureAIEmbeddingModelEmbedContextstruct AIEmbeddingModelEmbedContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAIEmbeddingModelMiddlewarestruct AIEmbeddingModelMiddlewareSources/SwiftAISDK/MiddlewareTypes.swift
StructureAIEmbeddingModelTransformContextstruct AIEmbeddingModelTransformContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAIImageModelGenerateContextstruct AIImageModelGenerateContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAIImageModelMiddlewarestruct AIImageModelMiddlewareSources/SwiftAISDK/MiddlewareTypes.swift
StructureAIImageModelTransformContextstruct AIImageModelTransformContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAILanguageModelGenerateContextstruct AILanguageModelGenerateContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAILanguageModelMiddlewarestruct AILanguageModelMiddlewareSources/SwiftAISDK/MiddlewareTypes.swift
StructureAILanguageModelStreamContextstruct AILanguageModelStreamContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAILanguageModelTransformContextstruct AILanguageModelTransformContextSources/SwiftAISDK/MiddlewareTypes.swift
StructureAIToolInputExampleFormatContextstruct AIToolInputExampleFormatContextSources/SwiftAISDK/ToolInputExamplesMiddleware.swift