Skip to content

Structured output

Symbol kindCount
Associated Type1
Case50
Class1
Enumeration9
Function2
Initializer19
Instance Method7
Instance Property160
Protocol1
Structure17
Type Method29
Type Property2
KindSymbolDeclarationSource
Associated TypeOutputassociatedtype Output : Decodable, SendableSources/SwiftAISDK/CoreObjectSchema.swift
CaseAIObjectGenerationFailureKind.decodingcase decodingSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectGenerationFailureKind.noJSONcase noJSONSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectGenerationFailureKind.repairFailedcase repairFailedSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectGenerationFailureKind.schemaValidationcase schemaValidationSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectGenerationSessionStatus.errorcase errorSources/SwiftAISDK/AIObjectGenerationSession.swift
CaseAIObjectGenerationSessionStatus.readycase readySources/SwiftAISDK/AIObjectGenerationSession.swift
CaseAIObjectGenerationSessionStatus.streamingcase streamingSources/SwiftAISDK/AIObjectGenerationSession.swift
CaseAIObjectGenerationSessionStatus.submittedcase submittedSources/SwiftAISDK/AIObjectGenerationSession.swift
CaseAIObjectOutputStrategy.arraycase arraySources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectOutputStrategy.enumerationcase enumerationSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectOutputStrategy.jsoncase jsonSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIObjectOutputStrategy.objectcase objectSources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIOutputKind.arraycase arraySources/SwiftAISDK/Output.swift
CaseAIOutputKind.choicecase choiceSources/SwiftAISDK/Output.swift
CaseAIOutputKind.jsoncase jsonSources/SwiftAISDK/Output.swift
CaseAIOutputKind.objectcase objectSources/SwiftAISDK/Output.swift
CaseAIOutputKind.textcase textSources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.finish(reason:usage:)case finish(reason: String?, usage: TokenUsage?)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.metadata(_:)case metadata([String : JSONValue])Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.output(_:)case output(AIOutputGenerationResult<Output>)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.partialOutput(_:)case partialOutput(Partial)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.raw(_:)case raw(LanguageStreamPart)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.responseMetadata(_:)case responseMetadata(AIResponseMetadata)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.source(_:)case source(AISource)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.textDelta(_:)case textDelta(String)Sources/SwiftAISDK/Output.swift
CaseAIOutputStreamPart.warning(_:)case warning(AIWarning)Sources/SwiftAISDK/Output.swift
CaseAIParsePartialJSONState.failedParsecase failedParseSources/SwiftAISDK/AIObjectPartialJSON.swift
CaseAIParsePartialJSONState.repairedParsecase repairedParseSources/SwiftAISDK/AIObjectPartialJSON.swift
CaseAIParsePartialJSONState.successfulParsecase successfulParseSources/SwiftAISDK/AIObjectPartialJSON.swift
CaseAIParsePartialJSONState.undefinedInputcase undefinedInputSources/SwiftAISDK/AIObjectPartialJSON.swift
CaseAIResultContentPart.custom(_:providerMetadata:)case custom(JSONValue, providerMetadata: [String : JSONValue] = [:])Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.file(_:)case file(AIStreamFile)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.reasoning(_:providerMetadata:)case reasoning(String, providerMetadata: [String : JSONValue] = [:])Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.reasoningFile(_:)case reasoningFile(AIStreamFile)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.source(_:)case source(AISource)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.text(_:providerMetadata:)case text(String, providerMetadata: [String : JSONValue] = [:])Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.toolApprovalRequest(_:)case toolApprovalRequest(AIToolApprovalRequest)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.toolApprovalResponse(_:)case toolApprovalResponse(AIToolApprovalResponse)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.toolCall(_:)case toolCall(AIToolCall)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseAIResultContentPart.toolResult(_:)case toolResult(AIToolResult)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.finish(reason:usage:)case finish(reason: String?, usage: TokenUsage?)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.metadata(_:)case metadata([String : JSONValue])Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.object(_:)case object(ObjectGenerationResult<Object>)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.partial(_:)case partial(Object)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.partialObject(_:)case partialObject(JSONValue)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.raw(_:)case raw(LanguageStreamPart)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.responseMetadata(_:)case responseMetadata(AIResponseMetadata)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.source(_:)case source(AISource)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.textDelta(_:)case textDelta(String)Sources/SwiftAISDK/CoreTextObjectResults.swift
CaseObjectStreamPart.warning(_:)case warning(AIWarning)Sources/SwiftAISDK/CoreTextObjectResults.swift
ClassAIObjectGenerationSession@MainActor final class AIObjectGenerationSession<Output, Partial> where Output : Sendable, Partial : SendableSources/SwiftAISDK/AIObjectGenerationSession.swift
EnumerationAIObjectGenerationFailureKindenum AIObjectGenerationFailureKindSources/SwiftAISDK/CoreTextObjectResults.swift
EnumerationAIObjectGenerationSessionStatusenum AIObjectGenerationSessionStatusSources/SwiftAISDK/AIObjectGenerationSession.swift
EnumerationAIObjectOutputStrategyenum AIObjectOutputStrategySources/SwiftAISDK/CoreTextObjectResults.swift
EnumerationAIOutputKindenum AIOutputKindSources/SwiftAISDK/Output.swift
EnumerationAIOutputStreamPartenum AIOutputStreamPart<Output, Partial> where Output : Sendable, Partial : SendableSources/SwiftAISDK/Output.swift
EnumerationAIParsePartialJSONStateenum AIParsePartialJSONStateSources/SwiftAISDK/AIObjectPartialJSON.swift
EnumerationAIResultContentPartenum AIResultContentPartSources/SwiftAISDK/CoreTextObjectResults.swift
EnumerationObjectStreamPartenum ObjectStreamPart<Object> where Object : SendableSources/SwiftAISDK/CoreTextObjectResults.swift
EnumerationOutputenum OutputSources/SwiftAISDK/Output.swift
FunctionfixJson(_:)func fixJson(_ input: String) -> StringSources/SwiftAISDK/AIObjectPartialJSON.swift
FunctionparsePartialJSON(_:)func parsePartialJSON(_ jsonText: String?) -> AIParsePartialJSONResultSources/SwiftAISDK/AIObjectPartialJSON.swift
Initializerinit(_:name:description:as:)init(_ jsonSchema: JSONValue, name: String? = nil, description: String? = nil, as type: Output.Type = Output.self)Sources/SwiftAISDK/CoreObjectSchema.swift
Initializerinit(callID:object:text:rawObject:reasoning:finishReason:usage:warnings:providerMetadata:responseMetadata:)init(callID: String, object: Output, text: String, rawObject: JSONValue, reasoning: String, finishReason: String?, usage: TokenUsage?, warnings: [AIWarning], providerMetadata: [String : JSONValue], responseMetadata: AIResponseMetadata)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(callID:operationID:providerID:modelID:outputKind:request:schema:schemaName:schemaDescription:maxRetries:)init(callID: String, operationID: String, providerID: String, modelID: String?, outputKind: String, request: LanguageModelRequest, schema: JSONValue?, schemaName: String?, schemaDescription: String?, maxRetries: Int)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(callID:providerID:modelID:text:errorDescription:finishReason:usage:warnings:providerMetadata:responseMetadata:)init(callID: String, providerID: String, modelID: String?, text: String, errorDescription: String, finishReason: String?, usage: TokenUsage?, warnings: [AIWarning], providerMetadata: [String : JSONValue], responseMetadata: AIResponseMetadata)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(callID:stepNumber:providerID:modelID:request:)init(callID: String, stepNumber: Int, providerID: String, modelID: String?, request: LanguageModelRequest)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(callID:stepNumber:providerID:modelID:text:reasoning:finishReason:usage:warnings:providerMetadata:responseMetadata:)init(callID: String, stepNumber: Int, providerID: String, modelID: String?, text: String, reasoning: String, finishReason: String?, usage: TokenUsage?, warnings: [AIWarning], providerMetadata: [String : JSONValue], responseMetadata: AIResponseMetadata)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(isEnabled:schemaPrefix:schemaSuffix:)init(isEnabled: Bool = true, schemaPrefix: String? = nil, schemaSuffix: String? = nil)Sources/SwiftAISDK/CoreObjectSchema.swift
Initializerinit(model:output:initialPartialObject:initialObject:onError:onFinish:)@MainActor init(model: any LanguageModel, output: AIOutput<Output, Partial>, initialPartialObject: Partial? = nil, initialObject: Output? = nil, onError: (@MainActor @Sendable (any Error) -> Void)? = nil, onFinish: (@MainActor @Sendable (AIObjectGenerationSessionFinishEvent<Output>) -> Void)? = nil)Sources/SwiftAISDK/AIObjectGenerationSession.swift
Initializerinit(object:result:error:)init(object: Output?, result: AIOutputGenerationResult<Output>?, error: (any Error)? = nil)Sources/SwiftAISDK/AIObjectGenerationSession.swift
Initializerinit(object:text:rawObject:reasoning:finishReason:usage:warnings:providerMetadata:responseMetadata:textResult:)init(object: Object, text: String, rawObject: JSONValue, reasoning: String = "", finishReason: String? = nil, usage: TokenUsage? = nil, warnings: [AIWarning] = [], providerMetadata: [String : JSONValue] = [:], responseMetadata: AIResponseMetadata = AIResponseMetadata(), textResult: TextGenerationResult)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(objectResult:)init(objectResult: ObjectGenerationResult<Output>)Sources/SwiftAISDK/Output.swift
Initializerinit(onStart:onStepStart:onStepFinish:onFinish:onError:)init(onStart: (@Sendable (AIObjectGenerationStartEvent) async -> Void)? = nil, onStepStart: (@Sendable (AIObjectGenerationStepStartEvent) async -> Void)? = nil, onStepFinish: (@Sendable (AIObjectGenerationStepFinishEvent) async -> Void)? = nil, onFinish: (@Sendable (AIObjectGenerationFinishEvent<Output>) async -> Void)? = nil, onError: (@Sendable (AIObjectGenerationErrorEvent) async -> Void)? = nil)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(output:text:rawOutput:reasoning:finishReason:usage:warnings:providerMetadata:responseMetadata:textResult:)init(output: Output, text: String, rawOutput: JSONValue, reasoning: String = "", finishReason: String? = nil, usage: TokenUsage? = nil, warnings: [AIWarning] = [], providerMetadata: [String : JSONValue] = [:], responseMetadata: AIResponseMetadata = AIResponseMetadata(), textResult: TextGenerationResult)Sources/SwiftAISDK/Output.swift
Initializerinit(provider:strategy:kind:message:path:text:repairAttempted:finishReason:usage:warnings:providerMetadata:responseMetadata:)init(provider: String, strategy: AIObjectOutputStrategy, kind: AIObjectGenerationFailureKind, message: String, path: String? = nil, text: String, repairAttempted: Bool = false, finishReason: String? = nil, usage: TokenUsage? = nil, warnings: [AIWarning] = [], providerMetadata: [String : JSONValue] = [:], responseMetadata: AIResponseMetadata = AIResponseMetadata())Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:timeoutNanoseconds:retryPolicy:telemetry:jsonInstruction:repairText:)init(temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil)Sources/SwiftAISDK/AIObjectGenerationSession.swift
Initializerinit(text:content:reasoning:finishReason:usage:files:toolCalls:toolResults:toolApprovalRequests:toolApprovalResponses:steps:sources:responseMessages:providerMetadata:rawValue:warnings:requestMetadata:responseMetadata:)init(text: String, content: [AIResultContentPart] = [], reasoning: String = "", finishReason: String? = nil, usage: TokenUsage? = nil, files: [AIStreamFile] = [], toolCalls: [AIToolCall] = [], toolResults: [AIToolResult] = [], toolApprovalRequests: [AIToolApprovalRequest] = [], toolApprovalResponses: [AIToolApprovalResponse] = [], steps: [AIToolStep] = [], sources: [AISource] = [], responseMessages: [AIMessage] = [], providerMetadata: [String : JSONValue] = [:], rawValue: JSONValue, warnings: [AIWarning] = [], requestMetadata: AIRequestMetadata = AIRequestMetadata(), responseMetadata: AIResponseMetadata = AIResponseMetadata())Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(text:errorMessage:)init(text: String, errorMessage: String)Sources/SwiftAISDK/CoreTextObjectResults.swift
Initializerinit(textResult:)init(textResult: TextGenerationResult)Sources/SwiftAISDK/Output.swift
Initializerinit(value:state:)init(value: JSONValue?, state: AIParsePartialJSONState)Sources/SwiftAISDK/AIObjectPartialJSON.swift
Instance Methodclear()@MainActor func clear()Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance MethodclearError()@MainActor func clearError()Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance MethodlanguageModelRequest(messages:abortSignal:)func languageModelRequest(messages: [AIMessage], abortSignal: AIAbortSignal? = nil) -> LanguageModelRequestSources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Methodstop(reason:)@MainActor func stop(reason: String? = "stopped")Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Methodsubmit(_:options:)@discardableResult @MainActor func submit(_ prompt: String, options: AIObjectGenerationSessionRequestOptions = AIObjectGenerationSessionRequestOptions()) -> Task<Void, Never>Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Methodsubmit(messages:options:)@discardableResult @MainActor func submit(messages: [AIMessage], options: AIObjectGenerationSessionRequestOptions = AIObjectGenerationSessionRequestOptions()) -> Task<Void, Never>Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Methodsubmit(request:timeoutNanoseconds:retryPolicy:telemetry:jsonInstruction:repairText:)@discardableResult @MainActor func submit(request: LanguageModelRequest, timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> Task<Void, Never>Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertycallIDvar callID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertycallIDvar callID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertycallIDvar callID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertycallIDvar callID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertycallIDvar callID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertycontentvar content: [AIResultContentPart]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertydescriptionvar description: String? { get }Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertydescriptionvar description: String? { get }Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertydescriptionvar description: String?Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertydescriptionvar description: String { get }Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertydescriptionvar description: String?Sources/SwiftAISDK/Output.swift
Instance Propertyerrorvar error: (any Error)?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyerror@Published @MainActor var error: (any Error)? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyerrorDescriptionvar errorDescription: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyerrorMessagevar errorMessage: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyextraBodyvar extraBody: [String : JSONValue]Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyfilesvar files: [AIStreamFile]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinalStepvar finalStep: AIToolStep? { get }Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReason@Published @MainActor var finishReason: String? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyfinishReasonvar finishReason: String?Sources/SwiftAISDK/Output.swift
Instance PropertyfrequencyPenaltyvar frequencyPenalty: Double?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyheadersvar headers: [String : String]Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyisEnabledvar isEnabled: BoolSources/SwiftAISDK/CoreObjectSchema.swift
Instance PropertyisLoading@MainActor var isLoading: Bool { get }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyjsonInstructionvar jsonInstruction: AIJSONInstruction?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyjsonSchemavar jsonSchema: JSONValue { get }Sources/SwiftAISDK/CoreObjectSchema.swift
Instance PropertyjsonSchemavar jsonSchema: JSONValueSources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertykindvar kind: AIObjectGenerationFailureKindSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertykindvar kind: AIOutputKindSources/SwiftAISDK/Output.swift
Instance PropertymaxOutputTokensvar maxOutputTokens: Int?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertymaxRetriesvar maxRetries: IntSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertymessagevar message: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertymetadata@Published @MainActor var metadata: [String : JSONValue] { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertymodel@MainActor var model: any LanguageModelSources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertymodelIDvar modelID: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertymodelIDvar modelID: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertymodelIDvar modelID: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertymodelIDvar modelID: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertynamevar name: String? { get }Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertynamevar name: String? { get }Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertynamevar name: String?Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertynamevar name: String?Sources/SwiftAISDK/Output.swift
Instance Propertyobjectvar object: Output?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyobject@Published @MainActor var object: Output? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyobjectvar object: ObjectSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyobjectvar object: OutputSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyonError@MainActor var onError: (@MainActor @Sendable (any Error) -> Void)?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyonErrorvar onError: (@Sendable (AIObjectGenerationErrorEvent) async -> Void)?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyonFinish@MainActor var onFinish: (@MainActor @Sendable (AIObjectGenerationSessionFinishEvent<Output>) -> Void)?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyonFinishvar onFinish: (@Sendable (AIObjectGenerationFinishEvent<Output>) async -> Void)?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyonStartvar onStart: (@Sendable (AIObjectGenerationStartEvent) async -> Void)?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyonStepFinishvar onStepFinish: (@Sendable (AIObjectGenerationStepFinishEvent) async -> Void)?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyonStepStartvar onStepStart: (@Sendable (AIObjectGenerationStepStartEvent) async -> Void)?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyoperationIDvar operationID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyoutput@MainActor var output: AIOutput<Output, Partial>Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyoutputvar output: OutputSources/SwiftAISDK/Output.swift
Instance PropertyoutputKindvar outputKind: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertypartialObject@Published @MainActor var partialObject: Partial? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertypathvar path: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertypresencePenaltyvar presencePenalty: Double?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyprovidervar provider: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderIDvar providerID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderIDvar providerID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderIDvar providerID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderIDvar providerID: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyproviderMetadatavar providerMetadata: [String : JSONValue]Sources/SwiftAISDK/Output.swift
Instance PropertyproviderOptionsvar providerOptions: [String : JSONValue]Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyrawObjectvar rawObject: JSONValueSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyrawObjectvar rawObject: JSONValueSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyrawOutputvar rawOutput: JSONValueSources/SwiftAISDK/Output.swift
Instance PropertyrawValuevar rawValue: JSONValueSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyreasoningvar reasoning: String?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyreasoningvar reasoning: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyreasoningvar reasoning: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyreasoningvar reasoning: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyreasoningvar reasoning: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyreasoningvar reasoning: StringSources/SwiftAISDK/Output.swift
Instance PropertyreasoningTextvar reasoningText: String { get }Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyrepairAttemptedvar repairAttempted: BoolSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyrepairTextvar repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyrequestvar request: LanguageModelRequestSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyrequestvar request: LanguageModelRequestSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyrequestMetadatavar requestMetadata: AIRequestMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMessagesvar responseMessages: [AIMessage]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadata@Published @MainActor var responseMetadata: AIResponseMetadata? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyresponseMetadatavar responseMetadata: AIResponseMetadataSources/SwiftAISDK/Output.swift
Instance Propertyresultvar result: AIOutputGenerationResult<Output>?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyresult@Published @MainActor var result: AIOutputGenerationResult<Output>? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertyretryPolicyvar retryPolicy: AIRetryPolicySources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyschemavar schema: JSONValue?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyschemavar schema: JSONValue?Sources/SwiftAISDK/Output.swift
Instance PropertyschemaDescriptionvar schemaDescription: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyschemaNamevar schemaName: String?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertyschemaPrefixvar schemaPrefix: String?Sources/SwiftAISDK/CoreObjectSchema.swift
Instance PropertyschemaSuffixvar schemaSuffix: String?Sources/SwiftAISDK/CoreObjectSchema.swift
Instance Propertyseedvar seed: Int?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertysources@Published @MainActor var sources: [AISource] { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertysourcesvar sources: [AISource]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertystatevar state: AIParsePartialJSONStateSources/SwiftAISDK/AIObjectPartialJSON.swift
Instance Propertystatus@Published @MainActor var status: AIObjectGenerationSessionStatus { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertystepNumbervar stepNumber: IntSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertystepNumbervar stepNumber: IntSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertystepsvar steps: [AIToolStep]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertystopSequencesvar stopSequences: [String]Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertystrategyvar strategy: AIObjectOutputStrategySources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytelemetryvar telemetry: Telemetry.Options?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertytemperaturevar temperature: Double?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertytext@Published @MainActor var text: String { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertytextvar text: StringSources/SwiftAISDK/Output.swift
Instance PropertytextResultvar textResult: TextGenerationResultSources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertytextResultvar textResult: TextGenerationResultSources/SwiftAISDK/Output.swift
Instance PropertytimeoutNanosecondsvar timeoutNanoseconds: UInt64?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertytoolApprovalRequestsvar toolApprovalRequests: [AIToolApprovalRequest]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertytoolApprovalResponsesvar toolApprovalResponses: [AIToolApprovalResponse]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertytoolCallsvar toolCalls: [AIToolCall]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertytoolResultsvar toolResults: [AIToolResult]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance PropertytopKvar topK: Int?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance PropertytopPvar topP: Double?Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyusage@Published @MainActor var usage: TokenUsage? { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertyusagevar usage: TokenUsage?Sources/SwiftAISDK/Output.swift
Instance Propertyvaluevar value: JSONValue?Sources/SwiftAISDK/AIObjectPartialJSON.swift
Instance Propertywarnings@Published @MainActor var warnings: [AIWarning] { get set }Sources/SwiftAISDK/AIObjectGenerationSession.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/CoreTextObjectResults.swift
Instance Propertywarningsvar warnings: [AIWarning]Sources/SwiftAISDK/Output.swift
ProtocolAIObjectSchemaprotocol AIObjectSchema : SendableSources/SwiftAISDK/CoreObjectSchema.swift
StructureAIJSONInstructionstruct AIJSONInstructionSources/SwiftAISDK/CoreObjectSchema.swift
StructureAIJSONSchemastruct AIJSONSchema<Output> where Output : Decodable, Output : SendableSources/SwiftAISDK/CoreObjectSchema.swift
StructureAIObjectGenerationCallbacksstruct AIObjectGenerationCallbacks<Output> where Output : SendableSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectGenerationErrorstruct AIObjectGenerationErrorSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectGenerationErrorEventstruct AIObjectGenerationErrorEventSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectGenerationFinishEventstruct AIObjectGenerationFinishEvent<Output> where Output : SendableSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectGenerationSessionFinishEventstruct AIObjectGenerationSessionFinishEvent<Output> where Output : SendableSources/SwiftAISDK/AIObjectGenerationSession.swift
StructureAIObjectGenerationSessionRequestOptionsstruct AIObjectGenerationSessionRequestOptionsSources/SwiftAISDK/AIObjectGenerationSession.swift
StructureAIObjectGenerationStartEventstruct AIObjectGenerationStartEventSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectGenerationStepFinishEventstruct AIObjectGenerationStepFinishEventSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectGenerationStepStartEventstruct AIObjectGenerationStepStartEventSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIObjectRepairContextstruct AIObjectRepairContextSources/SwiftAISDK/CoreTextObjectResults.swift
StructureAIOutputstruct AIOutput<FinalOutput, PartialOutput> where FinalOutput : Sendable, PartialOutput : SendableSources/SwiftAISDK/Output.swift
StructureAIOutputGenerationResultstruct AIOutputGenerationResult<Output> where Output : SendableSources/SwiftAISDK/Output.swift
StructureAIParsePartialJSONResultstruct AIParsePartialJSONResultSources/SwiftAISDK/AIObjectPartialJSON.swift
StructureObjectGenerationResultstruct ObjectGenerationResult<Object> where Object : SendableSources/SwiftAISDK/CoreTextObjectResults.swift
StructureTextGenerationResultstruct TextGenerationResultSources/SwiftAISDK/CoreTextObjectResults.swift
Type Methodarray(element:minItems:maxItems:name:description:)static func array<ElementSchema>(element: ElementSchema, minItems: Int? = nil, maxItems: Int? = nil, name: String? = nil, description: String? = nil) -> AIOutput<[ElementSchema.Output], [ElementSchema.Output]> where ElementSchema : AIObjectSchemaSources/SwiftAISDK/Output.swift
Type Methodarray(element:minItems:maxItems:name:description:as:)static func array<Element>(element: JSONValue, minItems: Int? = nil, maxItems: Int? = nil, name: String? = nil, description: String? = nil, as type: Element.Type = Element.self) -> AIOutput<[Element], [Element]> where Element : Decodable, Element : SendableSources/SwiftAISDK/Output.swift
Type Methodarray(element:name:description:)static func array<ElementSchema>(element: ElementSchema, name: String? = nil, description: String? = nil) -> AIOutput<[ElementSchema.Output], [ElementSchema.Output]> where ElementSchema : AIObjectSchemaSources/SwiftAISDK/Output.swift
Type Methodarray(element:name:description:as:)static func array<Element>(element: JSONValue, name: String? = nil, description: String? = nil, as type: Element.Type = Element.self) -> AIOutput<[Element], [Element]> where Element : Decodable, Element : SendableSources/SwiftAISDK/Output.swift
Type Methodchoice(options:name:description:)static func choice(options: [String], name: String? = nil, description: String? = nil) -> AIOutput<String, String>Sources/SwiftAISDK/Output.swift
Type MethodgenerateEnum(model:prompt:values:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateEnum(model: any LanguageModel, prompt: String, values: [String], temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<String>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<String>Sources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateEnum(model:request:values:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateEnum(model: any LanguageModel, request: LanguageModelRequest, values: [String], schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<String>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<String>Sources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateJSON(model:prompt:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateJSON(model: any LanguageModel, prompt: String, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<JSONValue>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<JSONValue>Sources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateJSON(model:request:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateJSON(model: any LanguageModel, request: LanguageModelRequest, schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<JSONValue>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<JSONValue>Sources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObject(model:prompt:as:schema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObject<Object>(model: any LanguageModel, prompt: String, as type: Object.Type = Object.self, schema: JSONValue? = nil, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Object>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<Object> where Object : Decodable, Object : SendableSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObject(model:prompt:schema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObject<Schema>(model: any LanguageModel, prompt: String, schema: Schema, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Schema.Output>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<Schema.Output> where Schema : AIObjectSchemaSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObject(model:request:as:schema:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObject<Object>(model: any LanguageModel, request: LanguageModelRequest, as type: Object.Type = Object.self, schema: JSONValue? = nil, schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Object>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<Object> where Object : Decodable, Object : SendableSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObject(model:request:schema:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObject<Schema>(model: any LanguageModel, request: LanguageModelRequest, schema: Schema, schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Schema.Output>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<Schema.Output> where Schema : AIObjectSchemaSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObjectArray(model:prompt:as:elementSchema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObjectArray<Element>(model: any LanguageModel, prompt: String, as type: Element.Type = Element.self, elementSchema: JSONValue, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[Element]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<[Element]> where Element : Decodable, Element : SendableSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObjectArray(model:prompt:elementSchema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObjectArray<ElementSchema>(model: any LanguageModel, prompt: String, elementSchema: ElementSchema, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[ElementSchema.Output]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<[ElementSchema.Output]> where ElementSchema : AIObjectSchemaSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObjectArray(model:request:as:elementSchema:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObjectArray<Element>(model: any LanguageModel, request: LanguageModelRequest, as type: Element.Type = Element.self, elementSchema: JSONValue, schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[Element]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<[Element]> where Element : Decodable, Element : SendableSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type MethodgenerateObjectArray(model:request:elementSchema:schemaName:schemaDescription:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func generateObjectArray<ElementSchema>(model: any LanguageModel, request: LanguageModelRequest, elementSchema: ElementSchema, schemaName: String? = nil, schemaDescription: String? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[ElementSchema.Output]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) async throws -> ObjectGenerationResult<[ElementSchema.Output]> where ElementSchema : AIObjectSchemaSources/SwiftAISDK/AIFacadeGenerateObject.swift
Type Methodjson(name:description:)static func json(name: String? = nil, description: String? = nil) -> AIOutput<JSONValue, JSONValue>Sources/SwiftAISDK/Output.swift
Type Methodobject(schema:name:description:)static func object<Schema>(schema: Schema, name: String? = nil, description: String? = nil) -> AIOutput<Schema.Output, JSONValue> where Schema : AIObjectSchemaSources/SwiftAISDK/Output.swift
Type Methodobject(schema:name:description:as:)static func object<Object>(schema: JSONValue? = nil, name: String? = nil, description: String? = nil, as type: Object.Type = Object.self) -> AIOutput<Object, JSONValue> where Object : Decodable, Object : SendableSources/SwiftAISDK/Output.swift
Type MethodstreamObject(model:prompt:as:schema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObject<Object>(model: any LanguageModel, prompt: String, as type: Object.Type = Object.self, schema: JSONValue? = nil, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Object>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<Object>, any Error> where Object : Decodable, Object : SendableSources/SwiftAISDK/AIFacadeStreamObjectSchema.swift
Type MethodstreamObject(model:prompt:schema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObject<Schema>(model: any LanguageModel, prompt: String, schema: Schema, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Schema.Output>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<Schema.Output>, any Error> where Schema : AIObjectSchemaSources/SwiftAISDK/AIFacadeStreamObjectSchema.swift
Type MethodstreamObject(model:request:as:schema:schemaName:schemaDescription:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObject<Object>(model: any LanguageModel, request: LanguageModelRequest, as type: Object.Type = Object.self, schema: JSONValue? = nil, schemaName: String? = nil, schemaDescription: String? = nil, timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Object>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<Object>, any Error> where Object : Decodable, Object : SendableSources/SwiftAISDK/AIFacadeStreamObject.swift
Type MethodstreamObject(model:request:schema:schemaName:schemaDescription:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObject<Schema>(model: any LanguageModel, request: LanguageModelRequest, schema: Schema, schemaName: String? = nil, schemaDescription: String? = nil, timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<Schema.Output>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<Schema.Output>, any Error> where Schema : AIObjectSchemaSources/SwiftAISDK/AIFacadeStreamObjectSchema.swift
Type MethodstreamObjectArray(model:prompt:as:elementSchema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObjectArray<Element>(model: any LanguageModel, prompt: String, as type: Element.Type = Element.self, elementSchema: JSONValue, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[Element]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<[Element]>, any Error> where Element : Decodable, Element : SendableSources/SwiftAISDK/AIFacadeStreamObjectArray.swift
Type MethodstreamObjectArray(model:prompt:elementSchema:schemaName:schemaDescription:temperature:topP:topK:presencePenalty:frequencyPenalty:seed:maxOutputTokens:stopSequences:reasoning:providerOptions:extraBody:headers:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObjectArray<ElementSchema>(model: any LanguageModel, prompt: String, elementSchema: ElementSchema, schemaName: String? = nil, schemaDescription: String? = nil, temperature: Double? = nil, topP: Double? = nil, topK: Int? = nil, presencePenalty: Double? = nil, frequencyPenalty: Double? = nil, seed: Int? = nil, maxOutputTokens: Int? = nil, stopSequences: [String] = [], reasoning: String? = nil, providerOptions: [String : JSONValue] = [:], extraBody: [String : JSONValue] = [:], headers: [String : String] = [:], timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[ElementSchema.Output]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<[ElementSchema.Output]>, any Error> where ElementSchema : AIObjectSchemaSources/SwiftAISDK/AIFacadeStreamObjectArray.swift
Type MethodstreamObjectArray(model:request:as:elementSchema:schemaName:schemaDescription:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObjectArray<Element>(model: any LanguageModel, request: LanguageModelRequest, as type: Element.Type = Element.self, elementSchema: JSONValue, schemaName: String? = nil, schemaDescription: String? = nil, timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[Element]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<[Element]>, any Error> where Element : Decodable, Element : SendableSources/SwiftAISDK/AIFacadeStreamObjectArray.swift
Type MethodstreamObjectArray(model:request:elementSchema:schemaName:schemaDescription:timeoutNanoseconds:retryPolicy:telemetry:callbacks:jsonInstruction:repairText:)static func streamObjectArray<ElementSchema>(model: any LanguageModel, request: LanguageModelRequest, elementSchema: ElementSchema, schemaName: String? = nil, schemaDescription: String? = nil, timeoutNanoseconds: UInt64? = nil, retryPolicy: AIRetryPolicy = .default, telemetry: Telemetry.Options? = nil, callbacks: AIObjectGenerationCallbacks<[ElementSchema.Output]>? = nil, jsonInstruction: AIJSONInstruction? = nil, repairText: (@Sendable (AIObjectRepairContext) async throws -> String?)? = nil) -> AsyncThrowingStream<ObjectStreamPart<[ElementSchema.Output]>, any Error> where ElementSchema : AIObjectSchemaSources/SwiftAISDK/AIFacadeStreamObjectArray.swift
Type Methodtext()static func text() -> AIOutput<String, String>Sources/SwiftAISDK/Output.swift
Type Propertyautomaticstatic let automatic: AIJSONInstructionSources/SwiftAISDK/CoreObjectSchema.swift
Type Propertydisabledstatic let disabled: AIJSONInstructionSources/SwiftAISDK/CoreObjectSchema.swift