gen_ai_hub.orchestration.models package

Submodules

• gen_ai_hub.orchestration.models.azure_content_filter module
  • AzureThreshold
    • AzureThreshold.ALLOW_SAFE
    • AzureThreshold.ALLOW_SAFE_LOW
    • AzureThreshold.ALLOW_SAFE_LOW_MEDIUM
    • AzureThreshold.ALLOW_ALL
  • AzureContentFilter
    • AzureContentFilter.__init__()
• gen_ai_hub.orchestration.models.base module
  • JSONSerializable
    • JSONSerializable.to_dict()
• gen_ai_hub.orchestration.models.config module
  • OrchestrationConfig
    • OrchestrationConfig.__init__()
    • OrchestrationConfig.to_dict()
• gen_ai_hub.orchestration.models.content_filter module
  • ContentFilterProvider
    • ContentFilterProvider.AZURE
    • ContentFilterProvider.LLAMA_GUARD_3_8B
  • ContentFilter
    • ContentFilter.__init__()
    • ContentFilter.to_dict()
• gen_ai_hub.orchestration.models.content_filtering module
  • InputFiltering
    • InputFiltering.__init__()
    • InputFiltering.to_dict()
  • OutputFiltering
    • OutputFiltering.__init__()
    • OutputFiltering.to_dict()
  • ContentFiltering
    • ContentFiltering.__init__()
    • ContentFiltering.to_dict()
• gen_ai_hub.orchestration.models.data_masking module
  • DataMaskingProviderName
    • DataMaskingProviderName.SAP_DATA_PRIVACY_INTEGRATION
  • DataMaskingProvider
  • DataMasking
    • DataMasking.__init__()
    • DataMasking.to_dict()
• gen_ai_hub.orchestration.models.document_grounding module
  • GroundingType
    • GroundingType.DOCUMENT_GROUNDING_SERVICE
  • DataRepositoryType
    • DataRepositoryType.VECTOR
    • DataRepositoryType.URL
  • DocumentMetadata
    • DocumentMetadata.__init__()
    • DocumentMetadata.to_dict()
  • GroundingFilterSearch
    • GroundingFilterSearch.__init__()
    • GroundingFilterSearch.to_dict()
  • DocumentGroundingFilter
    • DocumentGroundingFilter.__init__()
    • DocumentGroundingFilter.to_dict()
  • DocumentGrounding
    • DocumentGrounding.__init__()
    • DocumentGrounding.to_dict()
  • GroundingModule
    • GroundingModule.__init__()
    • GroundingModule.to_dict()
• gen_ai_hub.orchestration.models.llama_guard_3_filter module
  • LlamaGuard38bFilter
    • LlamaGuard38bFilter.__init__()
• gen_ai_hub.orchestration.models.llm module
  • LLM
    • LLM.__init__()
    • LLM.to_dict()
• gen_ai_hub.orchestration.models.message module
  • FunctionCall
    • FunctionCall.name
    • FunctionCall.arguments
    • FunctionCall.parse_arguments()
    • FunctionCall.__init__()
  • MessageToolCall
    • MessageToolCall.id
    • MessageToolCall.type
    • MessageToolCall.function
    • MessageToolCall.to_dict()
    • MessageToolCall.__init__()
  • Role
    • Role.USER
    • Role.SYSTEM
    • Role.ASSISTANT
    • Role.TOOL
    • Role.DEVELOPER
  • Message
    • Message.role
    • Message.content
    • Message.refusal
    • Message.tool_calls
    • Message.to_dict()
    • Message.__init__()
  • SystemMessage
    • SystemMessage.__init__()
  • UserMessage
    • UserMessage.__init__()
  • AssistantMessage
    • AssistantMessage.__init__()
  • ToolMessage
    • ToolMessage.__init__()
    • ToolMessage.to_dict()
• gen_ai_hub.orchestration.models.multimodal_items module
  • ImageDetailLevel
    • ImageDetailLevel.AUTO
    • ImageDetailLevel.LOW
    • ImageDetailLevel.HIGH
  • TextPart
    • TextPart.text
    • TextPart.type
    • TextPart.to_dict()
    • TextPart.__init__()
  • ImageUrl
    • ImageUrl.url
    • ImageUrl.detail
    • ImageUrl.__init__()
  • ImagePart
    • ImagePart.image_url
    • ImagePart.type
    • ImagePart.to_dict()
    • ImagePart.__init__()
  • ImageItem
    • ImageItem.__init__()
    • ImageItem.from_file()
    • ImageItem.to_dict()
• gen_ai_hub.orchestration.models.response module
  • ToolCallChunk
    • ToolCallChunk.index
    • ToolCallChunk.id
    • ToolCallChunk.type
    • ToolCallChunk.function
    • ToolCallChunk.__init__()
  • ChatDelta
    • ChatDelta.content
    • ChatDelta.role
    • ChatDelta.refusal
    • ChatDelta.tool_calls
    • ChatDelta.__init__()
  • LLMUsage
    • LLMUsage.completion_tokens
    • LLMUsage.prompt_tokens
    • LLMUsage.total_tokens
    • LLMUsage.__init__()
  • LLMChoice
    • LLMChoice.index
    • LLMChoice.message
    • LLMChoice.finish_reason
    • LLMChoice.logprobs
    • LLMChoice.index
    • LLMChoice.message
    • LLMChoice.finish_reason
    • LLMChoice.logprobs
    • LLMChoice.__init__()
  • LLMChoiceStreaming
    • LLMChoiceStreaming.index
    • LLMChoiceStreaming.delta
    • LLMChoiceStreaming.finish_reason
    • LLMChoiceStreaming.logprobs
    • LLMChoiceStreaming.index
    • LLMChoiceStreaming.delta
    • LLMChoiceStreaming.finish_reason
    • LLMChoiceStreaming.logprobs
    • LLMChoiceStreaming.__init__()
  • BaseLLMResult
    • BaseLLMResult.id
    • BaseLLMResult.object
    • BaseLLMResult.created
    • BaseLLMResult.model
    • BaseLLMResult.id
    • BaseLLMResult.object
    • BaseLLMResult.created
    • BaseLLMResult.model
    • BaseLLMResult.__init__()
  • LLMResult
    • LLMResult.id
    • LLMResult.object
    • LLMResult.created
    • LLMResult.model
    • LLMResult.choices
    • LLMResult.usage
    • LLMResult.system_fingerprint
    • LLMResult.choices
    • LLMResult.usage
    • LLMResult.system_fingerprint
    • LLMResult.__init__()
  • LLMResultStreaming
    • LLMResultStreaming.id
    • LLMResultStreaming.object
    • LLMResultStreaming.created
    • LLMResultStreaming.model
    • LLMResultStreaming.choices
    • LLMResultStreaming.usage
    • LLMResultStreaming.system_fingerprint
    • LLMResultStreaming.choices
    • LLMResultStreaming.usage
    • LLMResultStreaming.system_fingerprint
    • LLMResultStreaming.__init__()
  • GenericModuleResult
    • GenericModuleResult.message
    • GenericModuleResult.__init__()
    • GenericModuleResult.data
  • BaseModuleResults
    • BaseModuleResults.input_filtering
    • BaseModuleResults.output_filtering
    • BaseModuleResults.input_masking
    • BaseModuleResults.grounding
    • BaseModuleResults.input_translation
    • BaseModuleResults.output_translation
    • BaseModuleResults.__init__()
    • BaseModuleResults.input_filtering
    • BaseModuleResults.output_filtering
    • BaseModuleResults.input_masking
    • BaseModuleResults.grounding
    • BaseModuleResults.input_translation
    • BaseModuleResults.output_translation
  • ModuleResults
    • ModuleResults.templating
    • ModuleResults.llm
    • ModuleResults.input_filtering
    • ModuleResults.output_filtering
    • ModuleResults.input_masking
    • ModuleResults.output_unmasking
    • ModuleResults.__init__()
    • ModuleResults.llm
    • ModuleResults.templating
    • ModuleResults.output_unmasking
  • ModuleResultsStreaming
    • ModuleResultsStreaming.llm
    • ModuleResultsStreaming.templating
    • ModuleResultsStreaming.input_filtering
    • ModuleResultsStreaming.output_filtering
    • ModuleResultsStreaming.input_masking
    • ModuleResultsStreaming.output_unmasking
    • ModuleResultsStreaming.__init__()
    • ModuleResultsStreaming.llm
    • ModuleResultsStreaming.templating
    • ModuleResultsStreaming.output_unmasking
  • OrchestrationResponse
    • OrchestrationResponse.request_id
    • OrchestrationResponse.module_results
    • OrchestrationResponse.orchestration_result
    • OrchestrationResponse.__init__()
    • OrchestrationResponse.request_id
    • OrchestrationResponse.module_results
    • OrchestrationResponse.orchestration_result
    • OrchestrationResponse.content
  • OrchestrationResponseStreaming
    • OrchestrationResponseStreaming.request_id
    • OrchestrationResponseStreaming.module_results
    • OrchestrationResponseStreaming.orchestration_result
    • OrchestrationResponseStreaming.__init__()
    • OrchestrationResponseStreaming.request_id
    • OrchestrationResponseStreaming.module_results
    • OrchestrationResponseStreaming.orchestration_result
  • OrchestrationResponseWithRetries
    • OrchestrationResponseWithRetries.retries
    • OrchestrationResponseWithRetries.__init__()
    • OrchestrationResponseWithRetries.retries
• gen_ai_hub.orchestration.models.response_format module
  • ResponseFormatType
    • ResponseFormatType.TEXT
    • ResponseFormatType.JSON_OBJECT
    • ResponseFormatType.JSON_SCHEMA
  • ResponseFormatText
    • ResponseFormatText.to_dict()
  • ResponseFormatJsonObject
    • ResponseFormatJsonObject.to_dict()
  • ResponseFormatJsonSchema
    • ResponseFormatJsonSchema.__init__()
    • ResponseFormatJsonSchema.to_dict()
  • ResponseFormatFactory
    • ResponseFormatFactory.create_response_format_object()
  • Validator
    • Validator.validate_name()
• gen_ai_hub.orchestration.models.sap_data_privacy_integration module
  • MaskingMethod
    • MaskingMethod.ANONYMIZATION
    • MaskingMethod.PSEUDONYMIZATION
  • ProfileEntity
    • ProfileEntity.PERSON
    • ProfileEntity.ORG
    • ProfileEntity.UNIVERSITY
    • ProfileEntity.LOCATION
    • ProfileEntity.EMAIL
    • ProfileEntity.PHONE
    • ProfileEntity.ADDRESS
    • ProfileEntity.SAP_IDS_INTERNAL
    • ProfileEntity.SAP_IDS_PUBLIC
    • ProfileEntity.URL
    • ProfileEntity.USERNAME_PASSWORD
    • ProfileEntity.NATIONAL_ID
    • ProfileEntity.IBAN
    • ProfileEntity.SSN
    • ProfileEntity.CREDIT_CARD_NUMBER
    • ProfileEntity.PASSPORT
    • ProfileEntity.DRIVING_LICENSE
    • ProfileEntity.NATIONALITY
    • ProfileEntity.RELIGIOUS_GROUP
    • ProfileEntity.POLITICAL_GROUP
    • ProfileEntity.PRONOUNS_GENDER
    • ProfileEntity.GENDER
    • ProfileEntity.SEXUAL_ORIENTATION
    • ProfileEntity.TRADE_UNION
    • ProfileEntity.SENSITIVE_DATA
  • SAPDataPrivacyIntegration
    • SAPDataPrivacyIntegration.__init__()
    • SAPDataPrivacyIntegration.to_dict()
• gen_ai_hub.orchestration.models.template module
  • TemplateValue
    • TemplateValue.name
    • TemplateValue.value
  • Template
    • Template.__init__()
    • Template.to_dict()
• gen_ai_hub.orchestration.models.template_ref module
  • TemplateRef
    • TemplateRef.__init__()
    • TemplateRef.from_id()
    • TemplateRef.from_tuple()
    • TemplateRef.to_dict()
• gen_ai_hub.orchestration.models.tools module
  • python_type_to_json_type()
  • ChatCompletionTool
    • ChatCompletionTool.__init__()
    • ChatCompletionTool.to_dict()
  • FunctionTool
    • FunctionTool.__init__()
    • FunctionTool.to_dict()
    • FunctionTool.execute()
    • FunctionTool.aexecute()
    • FunctionTool.from_function()
  • function_tool()