Skip to main content

CrystalDocs builds documentation for every shard, on request. The announcement: Documentation for every shard, on CrystalBits.

CrystalDocs

    Browse DocsCrystalShardsAbout

    github.com/krthr/ai-sdk

    main

    Types

    • AI
      • Google
        • ConvertToGoogleMessagesResult
        • EmbeddingConfig
        • FileData
        • FileDataPart
        • FinishReason
        • FunctionCall
        • FunctionCallPart
        • FunctionResponse
        • FunctionResponsePart
        • GoogleError
        • GoogleErrorData
        • GoogleErrorInfo
        • GoogleGenerativeAIContent
        • GoogleGenerativeAIContentPart
        • GoogleGenerativeAIEmbeddingModel
        • GoogleGenerativeAIImageModel
        • GoogleGenerativeAILanguageModel
        • GoogleGenerativeAIPrompt
        • GoogleGenerativeAIProvider
        • GoogleGenerativeAISystemInstruction
        • GoogleSSEStreamIterator
        • ImageConfig
        • ImageModelId
        • ImageProviderOptions
        • ImageSettings
        • InlineData
        • InlineDataPart
        • LanguageModelConfig
        • LanguageModelProviderOptions
        • LatLng
        • PrepareToolsResult
        • ProviderSettings
        • ResponseImageConfig
        • RetrievalConfig
        • SafetySetting
        • SystemInstructionPart
        • TextContentPart
        • ThinkingConfig
        • Tool
        • Tools
          • CodeExecution
          • EnterpriseWebSearch
          • FileSearch
          • GoogleMaps
          • GoogleSearch
          • UrlContext
          • VertexRagStore
        • UnifiedFinishReason
        • UsageMetadata
      • OpenAI
        • ChatAssistantMessage
        • ChatContentPart
        • ChatContentPartAudio
        • ChatContentPartFile
        • ChatContentPartImage
        • ChatContentPartText
        • ChatDeveloperMessage
        • ChatFileData
        • ChatFileId
        • ChatImageUrl
        • ChatInputAudio
        • ChatMessage
        • ChatSystemMessage
        • ChatToolCall
        • ChatToolCallFunction
        • ChatToolMessage
        • ChatUserMessage
        • CodeConverter
        • CompletionTokensDetails
        • ConvertMessagesResult
        • LogprobsConverter
        • OpenAIChatAnnotation
        • OpenAIChatChunk
        • OpenAIChatChunkChoice
        • OpenAIChatChunkDelta
        • OpenAIChatChunkToolCall
        • OpenAIChatChunkToolCallFunction
        • OpenAIChatCompletionTokensDetails
        • OpenAIChatFunctionDefinition
        • OpenAIChatFunctionTool
        • OpenAIChatLanguageModel
        • OpenAIChatLogprob
        • OpenAIChatLogprobs
        • OpenAIChatModelId
        • OpenAIChatPrompt
        • OpenAIChatPromptTokensDetails
        • OpenAIChatProviderOptions
        • OpenAIChatResponse
        • OpenAIChatResponseChoice
        • OpenAIChatResponseMessage
        • OpenAIChatResponseToolCall
        • OpenAIChatResponseToolCallFunction
        • OpenAIChatSSEStreamIterator
        • OpenAIChatToolChoice
        • OpenAIChatToolChoiceFunction
        • OpenAIChatToolChoiceFunctionName
        • OpenAIChatTopLogprob
        • OpenAIChatUrlCitation
        • OpenAIChatUsage
        • OpenAIConfig
        • OpenAIEmbeddingData
        • OpenAIEmbeddingModel
        • OpenAIEmbeddingModelId
        • OpenAIEmbeddingProviderOptions
        • OpenAIEmbeddingResponse
        • OpenAIEmbeddingUsage
        • OpenAIError
        • OpenAIErrorData
        • OpenAIErrorInfo
        • OpenAIImageData
        • OpenAIImageInputTokensDetails
        • OpenAIImageMetadata
        • OpenAIImageModel
        • OpenAIImageModelId
        • OpenAIImageResponse
        • OpenAIImageUsage
        • OpenAILanguageModelCapabilities
        • OpenAIProvider
        • OpenAISpeechFormat
        • OpenAISpeechModel
        • OpenAISpeechModelConfig
        • OpenAISpeechModelId
        • OpenAISpeechProviderOptions
        • OpenAISpeechRequest
        • OpenAISpeechVoice
        • OpenAITranscriptionModel
        • OpenAITranscriptionModelConfig
        • OpenAITranscriptionModelId
        • OpenAITranscriptionProviderOptions
        • OpenAITranscriptionResponse
        • OpenAITranscriptionSegment
        • OpenAITranscriptionWord
        • PrepareToolsResult
        • PromptTokensDetails
        • ProviderSettings
        • Responses
          • ActiveReasoningState
          • ApplyPatchCall
          • ApplyPatchCallOutput
          • ApplyPatchOperation
          • AssistantMessage
          • FunctionCall
          • FunctionCallOutput
          • IncludeValue
          • InputFile
          • InputImage
          • InputText
          • InputTokensDetails
          • ItemReference
          • LocalShellAction
          • LocalShellCall
          • LocalShellCallOutput
          • Logprob
          • LogprobsValue
          • McpApprovalResponse
          • OngoingToolCall
          • OpenAIResponsesLanguageModel
          • OpenAIResponsesSSEStreamIterator
          • OutputTokensDetails
          • PrepareToolsResult
          • PromptCacheRetention
          • ProviderOptions
          • Reasoning
          • ReasoningProviderMetadata
          • ReasoningSummary
          • ResponsesInput
          • ResponsesInputItem
          • ResponsesProviderMetadata
          • ResponsesToolChoice
          • ResponsesUsage
          • ServiceTier
          • ShellAction
          • ShellCall
          • ShellCallOutput
          • ShellCommandResult
          • ShellOutcome
          • SourceDocumentProviderMetadata
            • ContainerFileCitation
            • FileCitation
            • FilePath
          • SystemMessage
          • SystemMessageMode
          • TextProviderMetadata
          • TextVerbosity
          • TopLogprob
          • Truncation
          • UserContentPart
          • UserMessage
        • SystemMessageMode
        • TimestampGranularity
        • Tools
          • AllowedToolsFilter
          • ApplyPatch
          • CodeInterpreter
          • ContainerConfig
          • FileSearch
          • FileSearchFilter
          • FileSearchRanking
          • ImageGeneration
          • ImageMask
          • LocalShell
          • Mcp
          • NeverApprovalConfig
          • RequireApprovalFilter
          • Shell
          • UserLocation
          • WebSearch
          • WebSearchFilters
          • WebSearchPreview
        • URLOptions
      • Provider
        • AISDKError
        • APICallError
        • EmbeddingModel
          • CallOptions
          • Embedding
          • Result
          • ResultResponse
          • Usage
          • V3
        • EmptyResponseBodyError
        • Errors
        • ImageModel
          • CallOptions
          • File
          • FileType
          • FileTypeConverter
          • ImageData
          • ProviderMetadata
          • Result
          • ResultResponse
          • Usage
          • V3
        • InvalidArgumentError
        • InvalidPromptError
        • InvalidResponseDataError
        • JSONParseError
        • JSONValue
        • LanguageModel
          • AssistantContentPart
          • AssistantMessage
          • CallOptions
          • Content
          • DataContent
          • EmptyStreamIterator
          • ErrorPart
          • File
          • FilePart
          • FinishPart
          • FinishReason
          • FunctionTool
          • GenerateResult
          • GenerateResultRequest
          • GenerateResultResponse
          • InputTokens
          • Message
          • OutputTokens
          • Prompt
          • ProviderTool
          • RawPart
          • Reasoning
          • ReasoningDeltaPart
          • ReasoningEndPart
          • ReasoningPart
          • ReasoningStartPart
          • ResponseFormat
          • ResponseFormatType
          • ResponseFormatTypeConverter
          • ResponseMetadata
          • ResponseMetadataPart
          • Source
          • SourceType
          • SourceTypeConverter
          • StreamPart
          • StreamResult
          • StreamStartPart
          • SystemMessage
          • Text
          • TextDeltaPart
          • TextEndPart
          • TextPart
          • TextStartPart
          • Tool
          • ToolApprovalRequest
          • ToolApprovalResponsePart
          • ToolCall
          • ToolCallPart
          • ToolChoice
          • ToolChoiceType
          • ToolChoiceTypeConverter
          • ToolContentPart
          • ToolInputDeltaPart
          • ToolInputEndPart
          • ToolInputStartPart
          • ToolMessage
          • ToolResult
          • ToolResultOutput
          • ToolResultOutputType
          • ToolResultOutputTypeConverter
          • ToolResultPart
          • UnifiedFinishReason
          • UnifiedFinishReasonConverter
          • Usage
          • UserContentPart
          • UserMessage
          • V3
        • LoadAPIKeyError
        • LoadSettingError
        • ModelType
        • NoContentGeneratedError
        • NoSuchModelError
        • Provider
          • V3
        • RerankingModel
          • CallOptions
          • Documents
          • DocumentsType
          • DocumentsTypeConverter
          • ProviderMetadata
          • RankedDocument
          • Result
          • ResultResponse
          • V3
        • Shared
          • Headers
          • ProviderMetadata
          • ProviderOptions
          • Warning
          • WarningType
          • WarningTypeConverter
        • SpeechModel
          • AudioData
          • CallOptions
          • ProviderMetadata
          • Result
          • ResultRequest
          • ResultResponse
          • V3
        • TooManyEmbeddingValuesForCallError
        • TranscriptionModel
          • AudioData
          • CallOptions
          • ProviderMetadata
          • Result
          • ResultRequest
          • ResultResponse
          • Segment
          • V3
        • TypeValidationError
        • UnsupportedFunctionalityError
      • ProviderUtils
    module

    AI::Provider::RerankingModel

    Constants

    SPECIFICATION_VERSION = "v3"

    The specification version for Reranking Model V3.

    Nested types

    • AI::Provider::RerankingModel::CallOptions
    • AI::Provider::RerankingModel::Documents
    • AI::Provider::RerankingModel::DocumentsType
    • AI::Provider::RerankingModel::DocumentsTypeConverter
    • AI::Provider::RerankingModel::ProviderMetadata
    • AI::Provider::RerankingModel::RankedDocument
    • AI::Provider::RerankingModel::Result
    • AI::Provider::RerankingModel::ResultResponse
    • AI::Provider::RerankingModel::V3

    Advertisement

    Crystal jobs from CrystalGigs

    • Your posting here

      Reach Crystal developers on CrystalGigsFirst party

    CrystalDocs.org - Crystal Shard Documentation Hosting

    The CrystalBits newsletter

    Crystal tutorials, release news and community writing. One email when there is something new, never a stream.

    You will get one confirmation email to check the address is yours. Unsubscribe any time.

    GitHubCrystalShardsCrystalGigsCrystalBitsCrystal Language

    The Bushido Collective builds and maintains this site. ยท Licensed under the Apache License 2.0