SAP Cloud SDK for AI (Python) - generative
- Introduction
- Examples
- Native Client Integrations
- Langchain Integration
- SAP RPT-1 Models
- Using New Models Before Official SDK Support
- Streaming
- Prompt Registry
- Prerequisite
- Prompt Template Management
- Orchestration Config Management
- Orchestration Service [Deprecated]
- Orchestration Service V2 API
- Document Grounding
- Async examples
- Async Amazon native
- Async Function to Stream Amazon Model Response
- Async Function to Test Amazon Titan Embedding
- Async Google Genai native example
- Async Google GenAI Chat Example
- Async Google GenAI Stream Generate Content Example
- Langchain examples
- Async Chat Streaming Example
- Chat Converse Model Example
- Async Gemini Model Invocation Example
- Async Gemini Streaming Example
- Generative AI Custom Evaluation
- Setup
- One Time Creation of Secrets
- Helper function to list available models in the region
- Helper function to see available System Defined Metrics
- Defining the Evaluation Config
- Helper function to generate Evaluation Config
- Running the evaluate function:
- Wait till each of the run is completed:
- Debugging
- Viewing the Aggregate Results
- Viewing the Completion Response
- Viewing the Metric Evaluation response
- Release Notes
- API Reference
GenAIHubProxyClientGenAIHubProxyClient.add_foundation_model_scenario()GenAIHubProxyClient.for_profile()GenAIHubProxyClient.init_client()GenAIHubProxyClient.set_default_values()GenAIHubProxyClient.get_additional_headers()GenAIHubProxyClient.get_ai_core_token()GenAIHubProxyClient.get_deployments()GenAIHubProxyClient.get_request_header()GenAIHubProxyClient.model_post_init()GenAIHubProxyClient.select_deployment()GenAIHubProxyClient.set_headers_addition()GenAIHubProxyClient.update_deployments()GenAIHubProxyClient.AI_CLIENT_TYPE_VALGenAIHubProxyClient.ai_core_clientGenAIHubProxyClient.auth_urlGenAIHubProxyClient.base_urlGenAIHubProxyClient.client_idGenAIHubProxyClient.client_secretGenAIHubProxyClient.default_valuesGenAIHubProxyClient.deployment_classGenAIHubProxyClient.deploymentsGenAIHubProxyClient.foundational_model_scenariosGenAIHubProxyClient.model_configGenAIHubProxyClient.on_invalid_deploymentsGenAIHubProxyClient.request_headerGenAIHubProxyClient.resource_group
- Subpackages
- gen_ai_hub.document_grounding package
- Subpackages
- gen_ai_hub.document_grounding.clients package
- Submodules
- gen_ai_hub.document_grounding.clients.pipeline_api_client module
PipelineAPIClientPipelineAPIClient.__init__()PipelineAPIClient.create_pipeline()PipelineAPIClient.delete_pipeline_by_id()PipelineAPIClient.get_execution_document_by_id()PipelineAPIClient.get_execution_documents()PipelineAPIClient.get_pipeline_by_id()PipelineAPIClient.get_pipeline_document_by_id()PipelineAPIClient.get_pipeline_documents()PipelineAPIClient.get_pipeline_execution_by_id()PipelineAPIClient.get_pipeline_executions()PipelineAPIClient.get_pipeline_status()PipelineAPIClient.get_pipelines()PipelineAPIClient.search_pipelines()PipelineAPIClient.trigger_pipeline()
- gen_ai_hub.document_grounding.clients.retrieval_api_client module
- gen_ai_hub.document_grounding.clients.vector_api_client module
VectorAPIClientVectorAPIClient.__init__()VectorAPIClient.create_collection()VectorAPIClient.create_documents()VectorAPIClient.delete_collection()VectorAPIClient.delete_document()VectorAPIClient.get_collection_by_id()VectorAPIClient.get_collection_creation_status()VectorAPIClient.get_collection_deletion_status()VectorAPIClient.get_collections()VectorAPIClient.get_document_by_id()VectorAPIClient.get_documents()VectorAPIClient.search()VectorAPIClient.update_documents()
- gen_ai_hub.document_grounding.models package
- Submodules
- gen_ai_hub.document_grounding.models.pipeline module
BasePipelineResponseCommonConfigurationDataRepositoryMetadataItemDocumentDocumentStatusDocumentsStatusResponseGetPipelineExecutionsResponseGetPipelineStatusResponseGetPipelinesResponseMSSharePointConfigurationMSSharePointConfigurationGetResponseMSSharePointPipelineCreateRequestMSSharePointPipelineGetResponseManualPipelineTriggerMetaDataPipelineExecutionPipelineExecutionStatusPipelineIdResponseS3PipelineCreateRequestS3PipelineGetResponseSFTPPipelineCreateRequestSFTPPipelineGetResponseSearchPipelineDataSearchPipelineRequestSearchPipelinesResponseSharePointConfigSharePointSite
- gen_ai_hub.document_grounding.models.retrieval module
DataRepositoriesDataRepositoryDataRepositoryWithDocumentsRetrievalChunkRetrievalDataRepositorySearchResultRetrievalDocumentRetrievalDocumentKeyValueListPairRetrievalKeyValueListPairRetrievalPerFilterSearchResultRetrievalPerFilterSearchResultErrorRetrievalPerFilterSearchResultWithErrorRetrievalSearchConfigurationRetrievalSearchDocumentKeyValueListPairRetrievalSearchFilterRetrievalSearchFilter.chunkMetadataRetrievalSearchFilter.dataRepositoriesRetrievalSearchFilter.dataRepositoryMetadataRetrievalSearchFilter.dataRepositoryTypeRetrievalSearchFilter.documentMetadataRetrievalSearchFilter.idRetrievalSearchFilter.model_configRetrievalSearchFilter.searchConfiguration
RetrievalSearchInputRetrievalSearchResults
- gen_ai_hub.document_grounding.models.vector module
BaseDocumentCollectionCollectionCreateRequestCollectionCreatedResponseCollectionDeletedResponseCollectionPendingResponseCollectionsListResponseDocumentDocumentOutputDocumentWithoutChunksDocumentsChunkDocumentsCreateRequestDocumentsListResponseDocumentsResponseDocumentsUpdateRequestEmbeddingConfigTextOnlyBaseChunkTextSearchRequestVectorChunkVectorKeyValueListPairVectorPerFilterSearchResultVectorSearchConfigurationVectorSearchDocumentKeyValueListPairVectorSearchFilterVectorSearchResults
- gen_ai_hub.document_grounding.clients package
- Submodules
- gen_ai_hub.document_grounding.client module
- Subpackages
- gen_ai_hub.evaluations package
- Subpackages
- gen_ai_hub.evaluations.exceptions package
- Submodules
- gen_ai_hub.evaluations.exceptions.error_codes module
ErrorCodeErrorCode.ARTIFACT_CREATION_FAILUREErrorCode.CONFIGURATION_CREATION_FAILUREErrorCode.EMPTY_FIELD_NAME_ERRORErrorCode.EMPTY_FILE_DATA_ERRORErrorCode.EMPTY_METRIC_ERRORErrorCode.EMPTY_METRIC_NAME_ERRORErrorCode.EMPTY_TEMPLATE_LIST_ERRORErrorCode.EMPTY_TEMPLATE_LIST_URL_ERRORErrorCode.EXECUTION_CREATION_FAILUREErrorCode.FILE_UPLOAD_ERRORErrorCode.GENERIC_ERRORErrorCode.GET_OBJECT_STORE_SECRET_ERRORErrorCode.INVALID_ARTIFACT_URL_ERRORErrorCode.INVALID_CUSTOM_METRIC_ERRORErrorCode.INVALID_DATASET_DATA_ERRORErrorCode.INVALID_DEPLOYMENT_STATUSErrorCode.INVALID_FILE_PATH_ERRORErrorCode.INVALID_FILTER_TYPE_ERRORErrorCode.INVALID_GROUNDING_CONFIGURATIONErrorCode.INVALID_JSON_DECODING_ERRORErrorCode.INVALID_METRIC_MAPPING_ERRORErrorCode.INVALID_OBJECT_STORE_SECRET_ERRORErrorCode.INVALID_ORCHESTRATION_CONFIG_ERRORErrorCode.INVALID_ORCHESTRATION_URL_ERRORErrorCode.INVALID_PARAMETER_VALUE_ERRORErrorCode.INVALID_S3_CLIENT_ERRORErrorCode.INVALID_TEMPLATE_MODULE_CONFIG_ERRORErrorCode.INVALID_TEMPLATE_REFERENCE_KEYErrorCode.METRIC_CONFIG_ERRORErrorCode.METRIC_SERVER_RESOLVE_ERRORErrorCode.MISSING_DEFAULT_OBJECT_STORE_SECRET_ERRORErrorCode.MISSING_ORCHESTRATION_URL_ERRORErrorCode.MISSING_USER_PROMPT_ERRORErrorCode.MODEL_NOT_ALLOWED_ERRORErrorCode.MORE_THAN_ONE_USER_PROMPT_PROVIDED_ERRORErrorCode.ORCHESTRATION_URL_VALIDATION_ERRORErrorCode.PROMPT_TEMPLATE_GET_ERRORErrorCode.READ_FILE_DATA_FROM_ARTIFACT_ERRORErrorCode.REGISTER_PROMPT_TEMPLATE_ERRORErrorCode.UNSUPPORTED_FILE_TYPE_ERRORErrorCode.UNSUPPORTED_FILTER_TYPE_ERRORErrorCode.UNSUPPORTED_LANGUAGE_MATCH_ERRORErrorCode.UNSUPPORTED_METRIC_ERROR
- gen_ai_hub.evaluations.helpers package
- gen_ai_hub.evaluations.models package
- Submodules
- gen_ai_hub.evaluations.models.artifact_source module
- gen_ai_hub.evaluations.models.dataset_config module
- gen_ai_hub.evaluations.models.evaluation_config module
- gen_ai_hub.evaluations.models.evaluation_run module
- gen_ai_hub.evaluations.models.metric_config module
- gen_ai_hub.evaluations.utils package
- Submodules
- gen_ai_hub.evaluations.utils.aicore_utils module
build_s3_file_key()call_orchestration_service_with_v2_config()create_deployment_by_configuration_id()create_llm_orchestration_deployment_url()fetch_configuration_by_id()fetch_deployment_config()fetch_orchestration_config_from_registry()find_configuration_id_by_name()generate_random_id()get_all_configurations()get_running_deployments_by_configuration_id()list_available_llm_models()read_data_from_artifact()register_aicore_artifact()register_aicore_configuration()register_aicore_execution()resolve_artifact_path()resolve_metric_identifiers()resolve_metric_names()upload_evaluation_dataset_data()upload_file_to_aws_s3()wait_for_target_status()
- gen_ai_hub.evaluations.utils.config_data_utils module
- gen_ai_hub.evaluations.utils.file_utils module
- gen_ai_hub.evaluations.utils.gen_utils module
build_model_versions_map()check_if_content_filter_provider_supported()check_if_metric_is_defined()count_user_prompts_from_template_list()create_custom_metric_name()create_model_versions_map_from_configuration_param_bindings()create_model_versions_map_from_custom_metric_config()create_model_versions_map_from_orch_configs()extract_dataset_columns()extract_metrics_variables()flatten_prompt_configuration()get_accumulated_config_data()get_custom_metric_ids_from_input()get_defaults()get_filter_config()get_grounding_config_from_orch_config()get_grounding_output_param_key()get_mapped_value_if_exists()get_prompt_variables_from_orch_config()get_template_list_from_orch_config()handle_json_schema_match()handle_language_match()handle_missing_dependent_variables_in_dataset()handle_reference_missing_rows()has_filter_key()is_value_in_json()list_prompt_variables()parse_model_filter_list()populate_dataset_data_if_data_missing()populate_dataset_data_if_individual_metric_reference_provided()populate_dataset_data_if_single_reference_provided()populate_dataset_data_if_single_schema_provided()remove_filter_metrics_if_provider_not_supported()resolve_orchestration_config_v2()select_model_details_randomly()set_model_details_from_run_configs()update_artifact_dict()update_test_orch_config()update_variable_mapping()validate_all_metrics_mapping()validate_individual_custom_metrics()validate_individual_metrics()validate_language_code_and_data_population()validate_metric_name()validate_metrics()validate_prompts_in_templating_module()validate_variable_mapping_of_metrics()validate_variable_mapping_of_prompts()
- gen_ai_hub.evaluations.utils.language_match_utils module
- gen_ai_hub.evaluations.utils.metric_client_utils module
- gen_ai_hub.evaluations.utils.orch_config_utils module
get_model_name()get_prompt_templating_config()get_template_key()get_template_list_from_orch_config()to_comparable()validate_if_all_grounding_input_params_present_in_prompt_variables()validate_if_content_inside_template_is_empty_in_templating_module_config()validate_if_grounding_output_present_in_prompt_variables()validate_if_image_url_is_provided_in_content_type_inside_templating_module_config()validate_if_template_list_is_empty()validate_if_template_list_is_empty_in_templating_module_config()validate_mandatory_modules()validate_model_name()validate_model_name_in_llm_module_config()validate_orch_config_mandatory_modules()validate_orchestration_params_from_evaluation_config()validate_template_ref_absent_in_config()
- gen_ai_hub.evaluations.utils.oss_secret_utils module
- gen_ai_hub.evaluations.utils.validation_utils module
extract_deployment_id()fetch_and_validate_orchestration_config()validate_config_data_collection()validate_filtered_models()validate_input_config()validate_merged_config_data()validate_orchestration_configuration()validate_orchestration_url()validate_orchestration_url_across_configs()validate_variable_mapping_with_input_config()
- gen_ai_hub.evaluations.exceptions package
- Submodules
- gen_ai_hub.evaluations.client module
EvaluationClientEvaluationClient.from_env()EvaluationClient.__init__()EvaluationClient.create_or_update_object_store_secret()EvaluationClient.evaluate()EvaluationClient.get_system_supported_metrics()EvaluationClient.list_available_models()EvaluationClient.resolve_orchestration_deployment_url()EvaluationClient.setup()EvaluationClient.validate_secret_type()
- gen_ai_hub.evaluations.constants module
- gen_ai_hub.evaluations.credentials module
- Subpackages
- gen_ai_hub.orchestration package
- Subpackages
- gen_ai_hub.orchestration.models package
- Submodules
- gen_ai_hub.orchestration.models.azure_content_filter module
- gen_ai_hub.orchestration.models.base module
- gen_ai_hub.orchestration.models.config module
- gen_ai_hub.orchestration.models.content_filter module
- gen_ai_hub.orchestration.models.content_filtering module
- gen_ai_hub.orchestration.models.data_masking module
- gen_ai_hub.orchestration.models.document_grounding module
- gen_ai_hub.orchestration.models.llama_guard_3_filter module
- gen_ai_hub.orchestration.models.llm module
- gen_ai_hub.orchestration.models.message module
- gen_ai_hub.orchestration.models.multimodal_items module
- gen_ai_hub.orchestration.models.response module
- gen_ai_hub.orchestration.models.response_format module
- gen_ai_hub.orchestration.models.sap_data_privacy_integration module
MaskingMethodProfileEntityProfileEntity.__new__()ProfileEntity.ADDRESSProfileEntity.CREDIT_CARD_NUMBERProfileEntity.DRIVING_LICENSEProfileEntity.EMAILProfileEntity.GENDERProfileEntity.IBANProfileEntity.LOCATIONProfileEntity.NATIONALITYProfileEntity.NATIONAL_IDProfileEntity.ORGProfileEntity.PASSPORTProfileEntity.PERSONProfileEntity.PHONEProfileEntity.POLITICAL_GROUPProfileEntity.PRONOUNS_GENDERProfileEntity.RELIGIOUS_GROUPProfileEntity.SAP_IDS_INTERNALProfileEntity.SAP_IDS_PUBLICProfileEntity.SENSITIVE_DATAProfileEntity.SEXUAL_ORIENTATIONProfileEntity.SSNProfileEntity.TRADE_UNIONProfileEntity.UNIVERSITYProfileEntity.URLProfileEntity.USERNAME_PASSWORD
SAPDataPrivacyIntegration
- gen_ai_hub.orchestration.models.template module
- gen_ai_hub.orchestration.models.template_ref module
- gen_ai_hub.orchestration.models.tools module
- gen_ai_hub.orchestration.models package
- Submodules
- gen_ai_hub.orchestration.exceptions module
- gen_ai_hub.orchestration.service module
OrchestrationRequestOrchestrationServiceOrchestrationService.__init__()OrchestrationService.aclose_http_connection()OrchestrationService.arun()OrchestrationService.arun_with_retries()OrchestrationService.astream()OrchestrationService.close_http_connection()OrchestrationService.handle_retry()OrchestrationService.run()OrchestrationService.run_with_retries()OrchestrationService.stream()
cache_if_not_none()discover_orchestration_api_url()get_orchestration_api_url()
- gen_ai_hub.orchestration.sse_client module
- gen_ai_hub.orchestration.utils module
- Subpackages
- gen_ai_hub.orchestration_v2 package
- Subpackages
- gen_ai_hub.orchestration_v2.models package
- Submodules
- gen_ai_hub.orchestration_v2.models.azure_content_filter module
- gen_ai_hub.orchestration_v2.models.base module
- gen_ai_hub.orchestration_v2.models.config module
CompletionRequestConfigurationReferenceByIdConfigRefCompletionRequestConfigurationReferenceByNameScenarioVersionConfigRefCompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef.model_configCompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef.nameCompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef.scenarioCompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef.version
ModuleConfigOrchestrationConfig
- gen_ai_hub.orchestration_v2.models.content_filter module
- gen_ai_hub.orchestration_v2.models.content_filtering module
- gen_ai_hub.orchestration_v2.models.data_masking module
DPICustomEntityDPIMethodConstantDPIMethodFabricatedDataDPIStandardEntityDataMaskingProviderNameMaskGroundingInputMaskingMethodMaskingModuleConfigMaskingProviderConfigProfileEntityProfileEntity.__new__()ProfileEntity.ADDRESSProfileEntity.CREDIT_CARD_NUMBERProfileEntity.DRIVING_LICENSEProfileEntity.EMAILProfileEntity.ETHNICITYProfileEntity.GENDERProfileEntity.IBANProfileEntity.LOCATIONProfileEntity.NATIONALITYProfileEntity.NATIONAL_IDProfileEntity.ORGProfileEntity.PASSPORTProfileEntity.PERSONProfileEntity.PHONEProfileEntity.POLITICAL_GROUPProfileEntity.PRONOUNS_GENDERProfileEntity.RELIGIOUS_GROUPProfileEntity.SAP_IDS_INTERNALProfileEntity.SAP_IDS_PUBLICProfileEntity.SENSITIVE_DATAProfileEntity.SEXUAL_ORIENTATIONProfileEntity.SSNProfileEntity.TRADE_UNIONProfileEntity.UNIVERSITYProfileEntity.URLProfileEntity.USERNAME_PASSWORD
- gen_ai_hub.orchestration_v2.models.document_grounding module
DataRepositoryTypeDocumentGroundingConfigDocumentGroundingFilterDocumentGroundingFilter.chunk_metadataDocumentGroundingFilter.data_repositoriesDocumentGroundingFilter.data_repository_metadataDocumentGroundingFilter.data_repository_typeDocumentGroundingFilter.document_metadataDocumentGroundingFilter.idDocumentGroundingFilter.model_configDocumentGroundingFilter.search_config
DocumentGroundingPlaceholdersDocumentMetadataKeyValueListPairsGroundingModuleConfigGroundingSearchConfigGroundingTypeKeyValueListPair
- gen_ai_hub.orchestration_v2.models.embeddings module
- gen_ai_hub.orchestration_v2.models.llama_guard_3_filter module
LlamaGuard38bFilterLlamaGuard38bFilter.child_exploitationLlamaGuard38bFilter.code_interpreter_abuseLlamaGuard38bFilter.defamationLlamaGuard38bFilter.electionsLlamaGuard38bFilter.hateLlamaGuard38bFilter.indiscriminate_weaponsLlamaGuard38bFilter.intellectual_propertyLlamaGuard38bFilter.model_configLlamaGuard38bFilter.non_violent_crimesLlamaGuard38bFilter.privacyLlamaGuard38bFilter.self_harmLlamaGuard38bFilter.sex_crimesLlamaGuard38bFilter.sexual_contentLlamaGuard38bFilter.specialized_adviceLlamaGuard38bFilter.violent_crimes
- gen_ai_hub.orchestration_v2.models.llm_model_details module
- gen_ai_hub.orchestration_v2.models.message module
- gen_ai_hub.orchestration_v2.models.multimodal_items module
- gen_ai_hub.orchestration_v2.models.orchestration_request module
- gen_ai_hub.orchestration_v2.models.response module
ChatCompletionTokenLogprobChoiceLogprobsCitationCompletionPostResponseCompletionTokensDetailsErrorResponseErrorResponseStreamingGenericModuleResultLLMChoiceLLMModuleResultModuleResultsOrchestrationResponseWithRetriesPromptTokensDetailsSAPAPIErrorSAPAPIErrorStreamingStreamCompletionPostResponseStreamDeltaStreamFunctionObjectStreamLLMChoiceStreamLLMModuleResultStreamModuleResultsStreamToolCallTokenUsageTopLogprob
- gen_ai_hub.orchestration_v2.models.response_format module
- gen_ai_hub.orchestration_v2.models.streaming module
- gen_ai_hub.orchestration_v2.models.template module
- gen_ai_hub.orchestration_v2.models.template_ref module
- gen_ai_hub.orchestration_v2.models.tools module
- gen_ai_hub.orchestration_v2.models.translation module
- gen_ai_hub.orchestration_v2.models package
- Submodules
- gen_ai_hub.orchestration_v2.exceptions module
- gen_ai_hub.orchestration_v2.service module
OrchestrationServiceOrchestrationService.__init__()OrchestrationService.aclose_http_connection()OrchestrationService.aembed()OrchestrationService.arun()OrchestrationService.arun_with_retries()OrchestrationService.astream()OrchestrationService.close_http_connection()OrchestrationService.embed()OrchestrationService.handle_retry()OrchestrationService.run()OrchestrationService.run_with_retries()OrchestrationService.stream()
cache_if_not_none()discover_orchestration_api_url()get_orchestration_api_url()
- gen_ai_hub.orchestration_v2.sse_client module
- gen_ai_hub.orchestration_v2.utils module
- Subpackages
- gen_ai_hub.prompt_registry package
- Subpackages
- gen_ai_hub.prompt_registry.models package
- Submodules
- gen_ai_hub.prompt_registry.models.orchestration_config module
OrchestrationConfigDeleteResponseOrchestrationConfigGetResponseOrchestrationConfigGetResponse.model_dump()OrchestrationConfigGetResponse.creation_timestampOrchestrationConfigGetResponse.idOrchestrationConfigGetResponse.is_version_headOrchestrationConfigGetResponse.managed_byOrchestrationConfigGetResponse.model_configOrchestrationConfigGetResponse.nameOrchestrationConfigGetResponse.resource_group_idOrchestrationConfigGetResponse.scenarioOrchestrationConfigGetResponse.specOrchestrationConfigGetResponse.version
OrchestrationConfigListResponseOrchestrationConfigPostRequestOrchestrationConfigPostResponse
- gen_ai_hub.prompt_registry.models.prompt_template module
PromptTemplatePromptTemplateDeleteResponsePromptTemplateGetResponsePromptTemplateGetResponse.creation_timestampPromptTemplateGetResponse.idPromptTemplateGetResponse.is_version_headPromptTemplateGetResponse.managed_byPromptTemplateGetResponse.model_configPromptTemplateGetResponse.namePromptTemplateGetResponse.scenarioPromptTemplateGetResponse.specPromptTemplateGetResponse.version
PromptTemplateListResponsePromptTemplatePostRequestPromptTemplatePostResponsePromptTemplateSpecPromptTemplateSubstitutionRequestPromptTemplateSubstitutionResponse
- gen_ai_hub.prompt_registry.models package
- Submodules
- gen_ai_hub.prompt_registry.client module
OrchestrationConfigClientOrchestrationConfigClient.create_orchestration_config()OrchestrationConfigClient.delete_orchestration_config_by_id()OrchestrationConfigClient.export_orchestration_config()OrchestrationConfigClient.get_orchestration_config_by_id()OrchestrationConfigClient.get_orchestration_config_history()OrchestrationConfigClient.get_orchestration_configs()OrchestrationConfigClient.import_orchestration_config()
PromptRegistryClientPromptTemplateClientPromptTemplateClient.create_prompt_template()PromptTemplateClient.delete_prompt_template_by_id()PromptTemplateClient.export_prompt_template()PromptTemplateClient.fill_prompt_template()PromptTemplateClient.fill_prompt_template_by_id()PromptTemplateClient.get_prompt_template_by_id()PromptTemplateClient.get_prompt_template_history()PromptTemplateClient.get_prompt_templates()PromptTemplateClient.import_prompt_template()
- Subpackages
- gen_ai_hub.proxy package
GenAIHubProxyClientGenAIHubProxyClient.add_foundation_model_scenario()GenAIHubProxyClient.for_profile()GenAIHubProxyClient.init_client()GenAIHubProxyClient.set_default_values()GenAIHubProxyClient.get_additional_headers()GenAIHubProxyClient.get_ai_core_token()GenAIHubProxyClient.get_deployments()GenAIHubProxyClient.get_request_header()GenAIHubProxyClient.model_post_init()GenAIHubProxyClient.select_deployment()GenAIHubProxyClient.set_headers_addition()GenAIHubProxyClient.update_deployments()GenAIHubProxyClient.AI_CLIENT_TYPE_VALGenAIHubProxyClient.ai_core_clientGenAIHubProxyClient.auth_urlGenAIHubProxyClient.base_urlGenAIHubProxyClient.client_idGenAIHubProxyClient.client_secretGenAIHubProxyClient.default_valuesGenAIHubProxyClient.deployment_classGenAIHubProxyClient.deploymentsGenAIHubProxyClient.foundational_model_scenariosGenAIHubProxyClient.model_configGenAIHubProxyClient.on_invalid_deploymentsGenAIHubProxyClient.request_headerGenAIHubProxyClient.resource_group
get_proxy_client()get_proxy_version()set_proxy_version()- Subpackages
- gen_ai_hub.proxy.core package
- gen_ai_hub.proxy.gen_ai_hub_proxy package
GenAIHubProxyClientGenAIHubProxyClient.add_foundation_model_scenario()GenAIHubProxyClient.for_profile()GenAIHubProxyClient.init_client()GenAIHubProxyClient.set_default_values()GenAIHubProxyClient.get_additional_headers()GenAIHubProxyClient.get_ai_core_token()GenAIHubProxyClient.get_deployments()GenAIHubProxyClient.get_request_header()GenAIHubProxyClient.model_post_init()GenAIHubProxyClient.select_deployment()GenAIHubProxyClient.set_headers_addition()GenAIHubProxyClient.update_deployments()GenAIHubProxyClient.AI_CLIENT_TYPE_VALGenAIHubProxyClient.ai_core_clientGenAIHubProxyClient.auth_urlGenAIHubProxyClient.base_urlGenAIHubProxyClient.client_idGenAIHubProxyClient.client_secretGenAIHubProxyClient.default_valuesGenAIHubProxyClient.deployment_classGenAIHubProxyClient.deploymentsGenAIHubProxyClient.foundational_model_scenariosGenAIHubProxyClient.model_configGenAIHubProxyClient.on_invalid_deploymentsGenAIHubProxyClient.request_headerGenAIHubProxyClient.resource_group
temporary_headers_addition()- Submodules
- gen_ai_hub.proxy.gen_ai_hub_proxy.client module
DeploymentDeployment.get_model_identification_kwargs()Deployment.additional_request_body_kwargs()Deployment.additonal_parametersDeployment.config_idDeployment.config_nameDeployment.created_atDeployment.custom_prediction_suffixDeployment.deployment_idDeployment.model_configDeployment.model_nameDeployment.prediction_urlDeployment.prediction_urlsDeployment.url
FoundationalModelScenarioGenAIHubProxyClientGenAIHubProxyClient.add_foundation_model_scenario()GenAIHubProxyClient.for_profile()GenAIHubProxyClient.init_client()GenAIHubProxyClient.set_default_values()GenAIHubProxyClient.get_additional_headers()GenAIHubProxyClient.get_ai_core_token()GenAIHubProxyClient.get_deployments()GenAIHubProxyClient.get_request_header()GenAIHubProxyClient.model_post_init()GenAIHubProxyClient.select_deployment()GenAIHubProxyClient.set_headers_addition()GenAIHubProxyClient.update_deployments()GenAIHubProxyClient.AI_CLIENT_TYPE_VALGenAIHubProxyClient.ai_core_clientGenAIHubProxyClient.auth_urlGenAIHubProxyClient.base_urlGenAIHubProxyClient.client_idGenAIHubProxyClient.client_secretGenAIHubProxyClient.default_valuesGenAIHubProxyClient.deployment_classGenAIHubProxyClient.deploymentsGenAIHubProxyClient.foundational_model_scenariosGenAIHubProxyClient.model_configGenAIHubProxyClient.on_invalid_deploymentsGenAIHubProxyClient.request_headerGenAIHubProxyClient.resource_group
GenAIHubRestClientInvalidDeploymentBehaviorcamel_to_snake()config_parameters()temporary_headers_addition()
- gen_ai_hub.proxy.langchain package
ChatBedrockChatGoogleGenerativeAIChatOpenAIGoogleGenerativeAIEmbeddingsOpenAIOpenAIEmbeddingsinit_embedding_model()init_llm()- Submodules
- gen_ai_hub.proxy.langchain.amazon module
AICoreBedrockBaseModelBedrockEmbeddingsChatBedrockChatBedrock.__init__()ChatBedrock.aws_access_key_idChatBedrock.aws_secret_access_keyChatBedrock.aws_session_tokenChatBedrock.base_model_idChatBedrock.bedrock_api_keyChatBedrock.bedrock_clientChatBedrock.beta_use_converse_apiChatBedrock.cacheChatBedrock.callbacksChatBedrock.clientChatBedrock.configChatBedrock.credentials_profile_nameChatBedrock.custom_get_token_idsChatBedrock.disable_streamingChatBedrock.endpoint_urlChatBedrock.guardrailsChatBedrock.max_tokensChatBedrock.metadataChatBedrock.model_configChatBedrock.model_idChatBedrock.model_kwargsChatBedrock.nameChatBedrock.output_versionChatBedrock.profileChatBedrock.providerChatBedrock.provider_stop_reason_key_mapChatBedrock.provider_stop_sequence_key_name_mapChatBedrock.rate_limiterChatBedrock.region_nameChatBedrock.service_tierChatBedrock.stop_sequencesChatBedrock.streamingChatBedrock.system_prompt_with_toolsChatBedrock.tagsChatBedrock.temperatureChatBedrock.verbose
ChatBedrockConverseinit_chat_converse_model()init_chat_model()init_embedding_model()
- gen_ai_hub.proxy.langchain.base module
- gen_ai_hub.proxy.langchain.google_genai module
ChatGoogleGenerativeAIChatGoogleGenerativeAI.additional_headersChatGoogleGenerativeAI.base_urlChatGoogleGenerativeAI.cacheChatGoogleGenerativeAI.cached_contentChatGoogleGenerativeAI.callbacksChatGoogleGenerativeAI.clientChatGoogleGenerativeAI.client_argsChatGoogleGenerativeAI.convert_system_message_to_humanChatGoogleGenerativeAI.credentialsChatGoogleGenerativeAI.custom_get_token_idsChatGoogleGenerativeAI.default_metadataChatGoogleGenerativeAI.disable_streamingChatGoogleGenerativeAI.google_api_keyChatGoogleGenerativeAI.image_configChatGoogleGenerativeAI.include_thoughtsChatGoogleGenerativeAI.labelsChatGoogleGenerativeAI.locationChatGoogleGenerativeAI.max_output_tokensChatGoogleGenerativeAI.max_retriesChatGoogleGenerativeAI.media_resolutionChatGoogleGenerativeAI.metadataChatGoogleGenerativeAI.modelChatGoogleGenerativeAI.model_configChatGoogleGenerativeAI.model_kwargsChatGoogleGenerativeAI.nChatGoogleGenerativeAI.nameChatGoogleGenerativeAI.output_versionChatGoogleGenerativeAI.profileChatGoogleGenerativeAI.projectChatGoogleGenerativeAI.rate_limiterChatGoogleGenerativeAI.response_mime_typeChatGoogleGenerativeAI.response_modalitiesChatGoogleGenerativeAI.response_schemaChatGoogleGenerativeAI.safety_settingsChatGoogleGenerativeAI.seedChatGoogleGenerativeAI.stopChatGoogleGenerativeAI.streamingChatGoogleGenerativeAI.tagsChatGoogleGenerativeAI.temperatureChatGoogleGenerativeAI.thinking_budgetChatGoogleGenerativeAI.thinking_levelChatGoogleGenerativeAI.timeoutChatGoogleGenerativeAI.top_kChatGoogleGenerativeAI.top_pChatGoogleGenerativeAI.verboseChatGoogleGenerativeAI.vertexai
GoogleGenerativeAIEmbeddingsGoogleGenerativeAIEmbeddings.additional_headersGoogleGenerativeAIEmbeddings.base_urlGoogleGenerativeAIEmbeddings.clientGoogleGenerativeAIEmbeddings.client_argsGoogleGenerativeAIEmbeddings.credentialsGoogleGenerativeAIEmbeddings.google_api_keyGoogleGenerativeAIEmbeddings.locationGoogleGenerativeAIEmbeddings.modelGoogleGenerativeAIEmbeddings.model_configGoogleGenerativeAIEmbeddings.output_dimensionalityGoogleGenerativeAIEmbeddings.projectGoogleGenerativeAIEmbeddings.request_optionsGoogleGenerativeAIEmbeddings.task_typeGoogleGenerativeAIEmbeddings.vertexai
init_chat_model()init_embedding_model()
- gen_ai_hub.proxy.langchain.init_models module
- gen_ai_hub.proxy.langchain.openai module
ChatOpenAIChatOpenAI.validate_environment()ChatOpenAI.__new__()ChatOpenAI.__init__()ChatOpenAI.async_clientChatOpenAI.cacheChatOpenAI.callbacksChatOpenAI.clientChatOpenAI.config_idChatOpenAI.config_nameChatOpenAI.context_managementChatOpenAI.custom_get_token_idsChatOpenAI.default_headersChatOpenAI.default_queryChatOpenAI.deployment_idChatOpenAI.disable_streamingChatOpenAI.disabled_paramsChatOpenAI.extra_bodyChatOpenAI.frequency_penaltyChatOpenAI.http_async_clientChatOpenAI.http_clientChatOpenAI.includeChatOpenAI.include_response_headersChatOpenAI.logit_biasChatOpenAI.logprobsChatOpenAI.max_retriesChatOpenAI.max_tokensChatOpenAI.metadataChatOpenAI.model_configChatOpenAI.model_kwargsChatOpenAI.model_nameChatOpenAI.nChatOpenAI.nameChatOpenAI.openai_api_baseChatOpenAI.openai_api_keyChatOpenAI.openai_api_versionChatOpenAI.openai_organizationChatOpenAI.openai_proxyChatOpenAI.output_versionChatOpenAI.presence_penaltyChatOpenAI.profileChatOpenAI.proxy_model_nameChatOpenAI.rate_limiterChatOpenAI.reasoningChatOpenAI.reasoning_effortChatOpenAI.request_timeoutChatOpenAI.root_async_clientChatOpenAI.root_clientChatOpenAI.seedChatOpenAI.service_tierChatOpenAI.stopChatOpenAI.storeChatOpenAI.stream_usageChatOpenAI.streamingChatOpenAI.tagsChatOpenAI.temperatureChatOpenAI.tiktoken_model_nameChatOpenAI.top_logprobsChatOpenAI.top_pChatOpenAI.truncationChatOpenAI.use_previous_response_idChatOpenAI.use_responses_apiChatOpenAI.verboseChatOpenAI.verbosity
OpenAIOpenAI.validate_environment()OpenAI.__new__()OpenAI.__init__()OpenAI.allowed_specialOpenAI.async_clientOpenAI.batch_sizeOpenAI.best_ofOpenAI.cacheOpenAI.callbacksOpenAI.clientOpenAI.config_idOpenAI.config_nameOpenAI.custom_get_token_idsOpenAI.default_headersOpenAI.default_queryOpenAI.deployment_idOpenAI.disallowed_specialOpenAI.extra_bodyOpenAI.frequency_penaltyOpenAI.http_async_clientOpenAI.http_clientOpenAI.logit_biasOpenAI.logprobsOpenAI.max_retriesOpenAI.max_tokensOpenAI.metadataOpenAI.model_configOpenAI.model_kwargsOpenAI.model_nameOpenAI.nOpenAI.nameOpenAI.openai_api_baseOpenAI.openai_api_keyOpenAI.openai_api_versionOpenAI.openai_organizationOpenAI.openai_proxyOpenAI.presence_penaltyOpenAI.proxy_model_nameOpenAI.request_timeoutOpenAI.seedOpenAI.streamingOpenAI.tagsOpenAI.temperatureOpenAI.tiktoken_model_nameOpenAI.top_pOpenAI.verbose
OpenAIEmbeddingsOpenAIEmbeddings.validate_environment()OpenAIEmbeddings.__init__()OpenAIEmbeddings.allowed_specialOpenAIEmbeddings.async_clientOpenAIEmbeddings.check_embedding_ctx_lengthOpenAIEmbeddings.chunk_sizeOpenAIEmbeddings.clientOpenAIEmbeddings.config_idOpenAIEmbeddings.config_nameOpenAIEmbeddings.default_headersOpenAIEmbeddings.default_queryOpenAIEmbeddings.deploymentOpenAIEmbeddings.deployment_idOpenAIEmbeddings.dimensionsOpenAIEmbeddings.disallowed_specialOpenAIEmbeddings.embedding_ctx_lengthOpenAIEmbeddings.headersOpenAIEmbeddings.http_async_clientOpenAIEmbeddings.http_clientOpenAIEmbeddings.input_typeOpenAIEmbeddings.max_retriesOpenAIEmbeddings.modelOpenAIEmbeddings.model_configOpenAIEmbeddings.model_kwargsOpenAIEmbeddings.openai_api_baseOpenAIEmbeddings.openai_api_keyOpenAIEmbeddings.openai_api_typeOpenAIEmbeddings.openai_api_versionOpenAIEmbeddings.openai_organizationOpenAIEmbeddings.openai_proxyOpenAIEmbeddings.proxy_model_nameOpenAIEmbeddings.request_timeoutOpenAIEmbeddings.retry_max_secondsOpenAIEmbeddings.retry_min_secondsOpenAIEmbeddings.show_progress_barOpenAIEmbeddings.skip_emptyOpenAIEmbeddings.tiktoken_enabledOpenAIEmbeddings.tiktoken_model_name
ProxyOpenAIget_client_params()init_chat_model()init_embedding_model()
- gen_ai_hub.proxy.native package
- Subpackages
- gen_ai_hub.proxy.native.amazon package
- gen_ai_hub.proxy.native.google_genai package
- gen_ai_hub.proxy.native.openai package
- gen_ai_hub.proxy.native.sap package
- Subpackages
- gen_ai_hub.document_grounding package