oci 2.126.4__py3-none-any.whl → 2.128.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- oci/__init__.py +2 -2
- oci/access_governance_cp/access_governance_cp_client.py +8 -8
- oci/adm/application_dependency_management_client.py +36 -36
- oci/ai_anomaly_detection/anomaly_detection_client.py +36 -36
- oci/ai_document/ai_service_document_client.py +22 -22
- oci/ai_language/ai_service_language_client.py +44 -44
- oci/ai_speech/ai_service_speech_client.py +10 -10
- oci/ai_vision/ai_service_vision_client.py +25 -25
- oci/analytics/analytics_client.py +23 -23
- oci/announcements_service/announcement_client.py +4 -4
- oci/announcements_service/announcement_subscription_client.py +9 -9
- oci/announcements_service/announcements_preferences_client.py +4 -4
- oci/apigateway/api_gateway_client.py +21 -21
- oci/apigateway/deployment_client.py +6 -6
- oci/apigateway/gateway_client.py +6 -6
- oci/apigateway/subscribers_client.py +6 -6
- oci/apigateway/usage_plans_client.py +6 -6
- oci/apigateway/work_requests_client.py +5 -5
- oci/apm_config/config_client.py +8 -8
- oci/apm_control_plane/apm_domain_client.py +14 -14
- oci/apm_synthetics/apm_synthetic_client.py +28 -28
- oci/apm_traces/attributes_client.py +8 -8
- oci/apm_traces/query_client.py +2 -2
- oci/apm_traces/trace_client.py +4 -4
- oci/appmgmt_control/appmgmt_control_client.py +8 -8
- oci/artifacts/artifacts_client.py +32 -32
- oci/audit/audit_client.py +3 -3
- oci/autoscaling/auto_scaling_client.py +11 -11
- oci/bastion/bastion_client.py +15 -15
- oci/bds/bds_client.py +66 -66
- oci/blockchain/blockchain_platform_client.py +27 -27
- oci/budget/budget_client.py +10 -10
- oci/capacity_management/capacity_management_client.py +494 -38
- oci/capacity_management/models/__init__.py +4 -2
- oci/capacity_management/models/create_occ_capacity_request_details.py +32 -1
- oci/capacity_management/models/metadata_details.py +7 -3
- oci/capacity_management/models/occ_availability_catalog.py +2 -2
- oci/capacity_management/models/occ_availability_catalog_summary.py +2 -2
- oci/capacity_management/models/occ_availability_summary.py +99 -40
- oci/capacity_management/models/occ_capacity_request.py +47 -0
- oci/capacity_management/models/occ_capacity_request_base_details.py +96 -32
- oci/capacity_management/models/occ_capacity_request_summary.py +31 -0
- oci/capacity_management/models/occ_overview_collection.py +72 -0
- oci/capacity_management/models/occ_overview_summary.py +413 -0
- oci/certificates/certificates_client.py +5 -5
- oci/certificates_management/certificates_management_client.py +32 -32
- oci/cims/incident_client.py +8 -8
- oci/cims/user_client.py +1 -1
- oci/cloud_bridge/common_client.py +5 -5
- oci/cloud_bridge/discovery_client.py +14 -14
- oci/cloud_bridge/inventory_client.py +16 -16
- oci/cloud_bridge/ocb_agent_svc_client.py +23 -23
- oci/cloud_guard/cloud_guard_client.py +155 -155
- oci/cloud_migrations/migration_client.py +43 -43
- oci/cluster_placement_groups/cluster_placement_groups_cp_client.py +13 -13
- oci/compute_cloud_at_customer/compute_cloud_at_customer_client.py +12 -12
- oci/compute_instance_agent/compute_instance_agent_client.py +6 -6
- oci/compute_instance_agent/plugin_client.py +2 -2
- oci/compute_instance_agent/pluginconfig_client.py +1 -1
- oci/container_engine/container_engine_client.py +44 -44
- oci/container_instances/container_instance_client.py +18 -18
- oci/core/blockstorage_client.py +60 -60
- oci/core/compute_client.py +99 -99
- oci/core/compute_management_client.py +32 -32
- oci/core/virtual_network_client.py +247 -247
- oci/dashboard_service/dashboard_client.py +6 -6
- oci/dashboard_service/dashboard_group_client.py +6 -6
- oci/data_catalog/data_catalog_client.py +149 -149
- oci/data_flow/data_flow_client.py +42 -42
- oci/data_integration/data_integration_client.py +163 -163
- oci/data_labeling_service/data_labeling_management_client.py +17 -17
- oci/data_labeling_service_dataplane/data_labeling_client.py +15 -15
- oci/data_safe/data_safe_client.py +278 -278
- oci/data_science/data_science_client.py +91 -91
- oci/database/database_client.py +447 -333
- oci/database/models/__init__.py +6 -0
- oci/database/models/autonomous_database_peer_collection.py +72 -0
- oci/database/models/autonomous_database_peer_summary.py +107 -0
- oci/database/models/create_autonomous_database_base.py +4 -0
- oci/database/models/create_cross_tenancy_disaster_recovery_details.py +512 -0
- oci/database/models/database_connection_credentials_by_details.py +7 -3
- oci/database/models/database_ssl_connection_credentials.py +7 -3
- oci/database/models/enable_database_management_details.py +7 -3
- oci/database/models/enable_pluggable_database_management_details.py +7 -3
- oci/database/models/modify_database_management_details.py +7 -3
- oci/database/models/modify_pluggable_database_management_details.py +7 -3
- oci/database_management/db_management_client.py +478 -206
- oci/database_management/diagnosability_client.py +4 -4
- oci/database_management/managed_my_sql_databases_client.py +7 -7
- oci/database_management/models/__init__.py +10 -0
- oci/database_management/models/basic_named_credential_content.py +7 -3
- oci/database_management/models/basic_preferred_credential.py +7 -3
- oci/database_management/models/data_points.py +103 -0
- oci/database_management/models/database_connection_credentials_by_details.py +7 -3
- oci/database_management/models/database_password_credential_details.py +7 -3
- oci/database_management/models/database_secret_credential_details.py +7 -3
- oci/database_management/models/database_ssl_connection_credentials.py +7 -3
- oci/database_management/models/database_usage_metrics.py +183 -0
- oci/database_management/models/dataguard_performance_metrics.py +72 -0
- oci/database_management/models/peer_database_metrics.py +72 -0
- oci/database_management/models/performance_metrics.py +165 -0
- oci/database_management/models/performance_metrics_data.py +387 -0
- oci/database_management/models/preferred_credential_summary.py +7 -3
- oci/database_management/models/test_basic_preferred_credential_details.py +7 -3
- oci/database_management/models/update_basic_preferred_credential_details.py +7 -3
- oci/database_management/perfhub_client.py +1 -1
- oci/database_management/sql_tuning_client.py +17 -17
- oci/database_migration/database_migration_client.py +41 -41
- oci/database_tools/database_tools_client.py +23 -23
- oci/demand_signal/__init__.py +14 -0
- oci/demand_signal/models/__init__.py +48 -0
- oci/demand_signal/models/change_occ_demand_signal_compartment_details.py +76 -0
- oci/demand_signal/models/create_occ_demand_signal_details.py +251 -0
- oci/demand_signal/models/occ_demand_signal.py +501 -0
- oci/demand_signal/models/occ_demand_signal_collection.py +72 -0
- oci/demand_signal/models/occ_demand_signal_data.py +134 -0
- oci/demand_signal/models/occ_demand_signal_summary.py +430 -0
- oci/demand_signal/models/occ_demand_signal_value.py +134 -0
- oci/demand_signal/models/patch_insert_instruction.py +171 -0
- oci/demand_signal/models/patch_insert_multiple_instruction.py +171 -0
- oci/demand_signal/models/patch_instruction.py +192 -0
- oci/demand_signal/models/patch_merge_instruction.py +97 -0
- oci/demand_signal/models/patch_move_instruction.py +147 -0
- oci/demand_signal/models/patch_occ_demand_signal_details.py +72 -0
- oci/demand_signal/models/patch_prohibit_instruction.py +100 -0
- oci/demand_signal/models/patch_remove_instruction.py +59 -0
- oci/demand_signal/models/patch_replace_instruction.py +92 -0
- oci/demand_signal/models/patch_require_instruction.py +99 -0
- oci/demand_signal/models/update_occ_demand_signal_details.py +185 -0
- oci/demand_signal/occ_demand_signal_client.py +953 -0
- oci/demand_signal/occ_demand_signal_client_composite_operations.py +176 -0
- oci/desktops/desktop_service_client.py +21 -21
- oci/devops/devops_client.py +89 -89
- oci/disaster_recovery/disaster_recovery_client.py +29 -29
- oci/dns/dns_client.py +52 -52
- oci/dts/appliance_export_job_client.py +6 -6
- oci/dts/shipping_vendors_client.py +1 -1
- oci/dts/transfer_appliance_client.py +8 -8
- oci/dts/transfer_appliance_entitlement_client.py +3 -3
- oci/dts/transfer_device_client.py +5 -5
- oci/dts/transfer_job_client.py +6 -6
- oci/dts/transfer_package_client.py +7 -7
- oci/em_warehouse/em_data_lake_client.py +13 -13
- oci/em_warehouse/em_warehouse_client.py +13 -13
- oci/email/email_client.py +31 -31
- oci/email_data_plane/email_dp_client.py +1 -1
- oci/events/events_client.py +6 -6
- oci/file_storage/file_storage_client.py +50 -50
- oci/fleet_software_update/fleet_software_update_client.py +44 -44
- oci/functions/functions_invoke_client.py +1 -1
- oci/functions/functions_management_client.py +16 -16
- oci/fusion_apps/data_masking_activity_client.py +3 -3
- oci/fusion_apps/fusion_applications_client.py +39 -39
- oci/fusion_apps/fusion_environment_client.py +15 -15
- oci/fusion_apps/fusion_environment_family_client.py +8 -8
- oci/fusion_apps/refresh_activity_client.py +4 -4
- oci/fusion_apps/scheduled_activity_client.py +2 -2
- oci/fusion_apps/service_attachment_client.py +2 -2
- oci/generative_ai/generative_ai_client.py +22 -22
- oci/generative_ai/models/__init__.py +4 -0
- oci/generative_ai/models/chat_model_metrics.py +113 -0
- oci/generative_ai/models/create_dedicated_ai_cluster_details.py +8 -0
- oci/generative_ai/models/dedicated_ai_cluster.py +17 -5
- oci/generative_ai/models/lora_training_config.py +186 -0
- oci/generative_ai/models/model_metrics.py +11 -3
- oci/generative_ai/models/t_few_training_config.py +1 -1
- oci/generative_ai/models/text_generation_model_metrics.py +1 -1
- oci/generative_ai/models/training_config.py +11 -3
- oci/generative_ai/models/vanilla_training_config.py +1 -1
- oci/generative_ai_inference/generative_ai_inference_client.py +13 -17
- oci/generative_ai_inference/models/__init__.py +23 -1
- oci/generative_ai_inference/models/assistant_message.py +89 -0
- oci/generative_ai_inference/models/base_chat_request.py +3 -3
- oci/generative_ai_inference/models/base_chat_response.py +3 -3
- oci/generative_ai_inference/models/chat_details.py +3 -3
- oci/generative_ai_inference/models/chat_result.py +2 -2
- oci/generative_ai_inference/models/choice.py +1 -1
- oci/generative_ai_inference/models/citation.py +9 -9
- oci/generative_ai_inference/models/cohere_chat_bot_message.py +113 -0
- oci/generative_ai_inference/models/cohere_chat_request.py +353 -30
- oci/generative_ai_inference/models/cohere_chat_response.py +166 -16
- oci/generative_ai_inference/models/cohere_llm_inference_response.py +1 -1
- oci/generative_ai_inference/models/cohere_message.py +49 -43
- oci/generative_ai_inference/models/cohere_parameter_definition.py +134 -0
- oci/generative_ai_inference/models/cohere_system_message.py +82 -0
- oci/generative_ai_inference/models/cohere_tool.py +134 -0
- oci/generative_ai_inference/models/cohere_tool_call.py +103 -0
- oci/generative_ai_inference/models/cohere_tool_message.py +82 -0
- oci/generative_ai_inference/models/cohere_tool_result.py +99 -0
- oci/generative_ai_inference/models/cohere_user_message.py +82 -0
- oci/generative_ai_inference/models/embed_text_details.py +4 -4
- oci/generative_ai_inference/models/generate_text_details.py +2 -2
- oci/generative_ai_inference/models/generic_chat_request.py +16 -10
- oci/generative_ai_inference/models/generic_chat_response.py +3 -3
- oci/generative_ai_inference/models/llama_llm_inference_request.py +2 -2
- oci/generative_ai_inference/models/llama_llm_inference_response.py +1 -1
- oci/generative_ai_inference/models/llm_inference_response.py +3 -11
- oci/generative_ai_inference/models/logprobs.py +3 -1
- oci/generative_ai_inference/models/message.py +50 -5
- oci/generative_ai_inference/models/on_demand_serving_mode.py +2 -2
- oci/generative_ai_inference/models/serving_mode.py +3 -3
- oci/generative_ai_inference/models/summarize_text_details.py +2 -2
- oci/generative_ai_inference/models/system_message.py +89 -0
- oci/generative_ai_inference/models/text_content.py +1 -1
- oci/generative_ai_inference/models/user_message.py +89 -0
- oci/generic_artifacts_content/generic_artifacts_content_client.py +3 -3
- oci/globally_distributed_database/sharded_database_service_client.py +29 -29
- oci/golden_gate/golden_gate_client.py +2420 -1399
- oci/golden_gate/golden_gate_client_composite_operations.py +274 -0
- oci/golden_gate/models/__init__.py +20 -0
- oci/golden_gate/models/add_resource_lock_details.py +124 -0
- oci/golden_gate/models/amazon_kinesis_connection.py +8 -1
- oci/golden_gate/models/amazon_kinesis_connection_summary.py +8 -1
- oci/golden_gate/models/amazon_redshift_connection.py +8 -1
- oci/golden_gate/models/amazon_redshift_connection_summary.py +8 -1
- oci/golden_gate/models/amazon_s3_connection.py +8 -1
- oci/golden_gate/models/amazon_s3_connection_summary.py +8 -1
- oci/golden_gate/models/azure_data_lake_storage_connection.py +8 -1
- oci/golden_gate/models/azure_data_lake_storage_connection_summary.py +8 -1
- oci/golden_gate/models/azure_synapse_connection.py +8 -1
- oci/golden_gate/models/azure_synapse_connection_summary.py +8 -1
- oci/golden_gate/models/certificate.py +2 -2
- oci/golden_gate/models/connection.py +42 -3
- oci/golden_gate/models/connection_summary.py +44 -5
- oci/golden_gate/models/create_amazon_kinesis_connection_details.py +8 -1
- oci/golden_gate/models/create_amazon_redshift_connection_details.py +8 -1
- oci/golden_gate/models/create_amazon_s3_connection_details.py +8 -1
- oci/golden_gate/models/create_azure_data_lake_storage_connection_details.py +8 -1
- oci/golden_gate/models/create_azure_synapse_connection_details.py +8 -1
- oci/golden_gate/models/create_certificate_details.py +2 -2
- oci/golden_gate/models/create_connection_details.py +42 -3
- oci/golden_gate/models/create_db2_connection_details.py +474 -0
- oci/golden_gate/models/create_deployment_backup_details.py +33 -2
- oci/golden_gate/models/create_deployment_details.py +37 -2
- oci/golden_gate/models/create_elasticsearch_connection_details.py +8 -1
- oci/golden_gate/models/create_generic_connection_details.py +8 -1
- oci/golden_gate/models/create_golden_gate_connection_details.py +8 -1
- oci/golden_gate/models/create_google_big_query_connection_details.py +8 -1
- oci/golden_gate/models/create_google_cloud_storage_connection_details.py +8 -1
- oci/golden_gate/models/create_hdfs_connection_details.py +8 -1
- oci/golden_gate/models/create_java_message_service_connection_details.py +8 -1
- oci/golden_gate/models/create_kafka_connection_details.py +8 -1
- oci/golden_gate/models/create_kafka_schema_registry_connection_details.py +8 -1
- oci/golden_gate/models/create_microsoft_sqlserver_connection_details.py +8 -1
- oci/golden_gate/models/create_mongo_db_connection_details.py +8 -1
- oci/golden_gate/models/create_mysql_connection_details.py +8 -1
- oci/golden_gate/models/create_oci_object_storage_connection_details.py +8 -1
- oci/golden_gate/models/create_ogg_deployment_details.py +4 -4
- oci/golden_gate/models/create_oracle_connection_details.py +41 -1
- oci/golden_gate/models/create_oracle_nosql_connection_details.py +8 -1
- oci/golden_gate/models/create_postgresql_connection_details.py +47 -5
- oci/golden_gate/models/create_redis_connection_details.py +46 -4
- oci/golden_gate/models/create_snowflake_connection_details.py +8 -1
- oci/golden_gate/models/db2_connection.py +431 -0
- oci/golden_gate/models/db2_connection_summary.py +399 -0
- oci/golden_gate/models/deployment.py +37 -2
- oci/golden_gate/models/deployment_backup.py +112 -2
- oci/golden_gate/models/deployment_backup_summary.py +112 -2
- oci/golden_gate/models/deployment_summary.py +39 -4
- oci/golden_gate/models/deployment_type_summary.py +7 -3
- oci/golden_gate/models/elasticsearch_connection.py +8 -1
- oci/golden_gate/models/elasticsearch_connection_summary.py +8 -1
- oci/golden_gate/models/generate_library_url_details.py +101 -0
- oci/golden_gate/models/generate_log_reader_component_library_url_details.py +51 -0
- oci/golden_gate/models/generic_connection.py +8 -1
- oci/golden_gate/models/generic_connection_summary.py +8 -1
- oci/golden_gate/models/golden_gate_connection.py +8 -1
- oci/golden_gate/models/golden_gate_connection_summary.py +8 -1
- oci/golden_gate/models/google_big_query_connection.py +8 -1
- oci/golden_gate/models/google_big_query_connection_summary.py +8 -1
- oci/golden_gate/models/google_cloud_storage_connection.py +8 -1
- oci/golden_gate/models/google_cloud_storage_connection_summary.py +8 -1
- oci/golden_gate/models/hdfs_connection.py +8 -1
- oci/golden_gate/models/hdfs_connection_summary.py +8 -1
- oci/golden_gate/models/java_message_service_connection.py +8 -1
- oci/golden_gate/models/java_message_service_connection_summary.py +8 -1
- oci/golden_gate/models/kafka_connection.py +8 -1
- oci/golden_gate/models/kafka_connection_summary.py +8 -1
- oci/golden_gate/models/kafka_schema_registry_connection.py +8 -1
- oci/golden_gate/models/kafka_schema_registry_connection_summary.py +8 -1
- oci/golden_gate/models/library_url.py +72 -0
- oci/golden_gate/models/microsoft_sqlserver_connection.py +8 -1
- oci/golden_gate/models/microsoft_sqlserver_connection_summary.py +8 -1
- oci/golden_gate/models/mongo_db_connection.py +8 -1
- oci/golden_gate/models/mongo_db_connection_summary.py +8 -1
- oci/golden_gate/models/mysql_connection.py +19 -4
- oci/golden_gate/models/mysql_connection_summary.py +8 -1
- oci/golden_gate/models/oci_object_storage_connection.py +8 -1
- oci/golden_gate/models/oci_object_storage_connection_summary.py +8 -1
- oci/golden_gate/models/ogg_deployment.py +2 -2
- oci/golden_gate/models/oracle_connection.py +64 -4
- oci/golden_gate/models/oracle_connection_summary.py +41 -1
- oci/golden_gate/models/oracle_nosql_connection.py +8 -1
- oci/golden_gate/models/oracle_nosql_connection_summary.py +8 -1
- oci/golden_gate/models/postgresql_connection.py +56 -6
- oci/golden_gate/models/postgresql_connection_summary.py +45 -3
- oci/golden_gate/models/redis_connection.py +52 -6
- oci/golden_gate/models/redis_connection_summary.py +45 -3
- oci/golden_gate/models/remove_resource_lock_details.py +91 -0
- oci/golden_gate/models/resource_lock.py +185 -0
- oci/golden_gate/models/snowflake_connection.py +8 -1
- oci/golden_gate/models/snowflake_connection_summary.py +8 -1
- oci/golden_gate/models/update_amazon_kinesis_connection_details.py +1 -1
- oci/golden_gate/models/update_amazon_redshift_connection_details.py +1 -1
- oci/golden_gate/models/update_amazon_s3_connection_details.py +1 -1
- oci/golden_gate/models/update_azure_data_lake_storage_connection_details.py +1 -1
- oci/golden_gate/models/update_azure_synapse_connection_details.py +1 -1
- oci/golden_gate/models/update_connection_details.py +11 -3
- oci/golden_gate/models/update_db2_connection_details.py +429 -0
- oci/golden_gate/models/update_deployment_details.py +43 -0
- oci/golden_gate/models/update_elasticsearch_connection_details.py +1 -1
- oci/golden_gate/models/update_generic_connection_details.py +1 -1
- oci/golden_gate/models/update_golden_gate_connection_details.py +1 -1
- oci/golden_gate/models/update_google_big_query_connection_details.py +1 -1
- oci/golden_gate/models/update_google_cloud_storage_connection_details.py +1 -1
- oci/golden_gate/models/update_hdfs_connection_details.py +1 -1
- oci/golden_gate/models/update_java_message_service_connection_details.py +1 -1
- oci/golden_gate/models/update_kafka_connection_details.py +1 -1
- oci/golden_gate/models/update_kafka_schema_registry_connection_details.py +1 -1
- oci/golden_gate/models/update_microsoft_sqlserver_connection_details.py +1 -1
- oci/golden_gate/models/update_mongo_db_connection_details.py +1 -1
- oci/golden_gate/models/update_mysql_connection_details.py +1 -1
- oci/golden_gate/models/update_oci_object_storage_connection_details.py +1 -1
- oci/golden_gate/models/update_ogg_deployment_details.py +4 -4
- oci/golden_gate/models/update_oracle_connection_details.py +34 -1
- oci/golden_gate/models/update_oracle_nosql_connection_details.py +1 -1
- oci/golden_gate/models/update_postgresql_connection_details.py +38 -3
- oci/golden_gate/models/update_redis_connection_details.py +38 -3
- oci/golden_gate/models/update_snowflake_connection_details.py +1 -1
- oci/golden_gate/models/work_request.py +7 -3
- oci/governance_rules_control_plane/governance_rule_client.py +15 -15
- oci/governance_rules_control_plane/work_request_client.py +5 -5
- oci/healthchecks/health_checks_client.py +17 -17
- oci/identity/identity_client.py +145 -145
- oci/identity_data_plane/dataplane_client.py +2 -2
- oci/identity_domains/identity_domains_client.py +300 -300
- oci/integration/integration_instance_client.py +15 -15
- oci/jms/java_management_service_client.py +66 -66
- oci/jms_java_downloads/java_download_client.py +52 -51
- oci/jms_java_downloads/models/create_java_download_report_details.py +80 -6
- oci/jms_java_downloads/models/create_java_license_acceptance_record_details.py +76 -2
- oci/jms_java_downloads/models/java_download_count_aggregation.py +2 -2
- oci/jms_java_downloads/models/java_download_record.py +2 -2
- oci/jms_java_downloads/models/java_download_record_summary.py +2 -2
- oci/jms_java_downloads/models/java_download_report.py +174 -2
- oci/jms_java_downloads/models/java_download_report_summary.py +174 -2
- oci/jms_java_downloads/models/java_download_token.py +24 -8
- oci/jms_java_downloads/models/java_download_token_summary.py +24 -8
- oci/jms_java_downloads/models/java_license_acceptance_record.py +4 -4
- oci/jms_java_downloads/models/java_license_acceptance_record_summary.py +4 -4
- oci/jms_java_downloads/models/request_summarized_java_download_counts_details.py +2 -2
- oci/jms_java_downloads/models/update_java_license_acceptance_record_details.py +76 -2
- oci/key_management/ekm_client.py +5 -5
- oci/key_management/kms_crypto_client.py +6 -6
- oci/key_management/kms_hsm_cluster_client.py +12 -12
- oci/key_management/kms_management_client.py +21 -21
- oci/key_management/kms_vault_client.py +14 -14
- oci/license_manager/license_manager_client.py +18 -18
- oci/limits/limits_client.py +4 -4
- oci/limits/quotas_client.py +7 -7
- oci/load_balancer/load_balancer_client.py +61 -61
- oci/lockbox/lockbox_client.py +24 -24
- oci/log_analytics/log_analytics_client.py +193 -193
- oci/logging/logging_management_client.py +30 -30
- oci/loggingingestion/logging_client.py +1 -1
- oci/loggingsearch/log_search_client.py +1 -1
- oci/management_agent/management_agent_client.py +28 -28
- oci/management_dashboard/dashx_apis_client.py +14 -14
- oci/marketplace/account_client.py +2 -2
- oci/marketplace/marketplace_client.py +30 -30
- oci/marketplace_private_offer/attachment_client.py +5 -5
- oci/marketplace_private_offer/offer_client.py +6 -6
- oci/marketplace_publisher/attachment_client.py +5 -5
- oci/marketplace_publisher/marketplace_publisher_client.py +71 -71
- oci/marketplace_publisher/offer_client.py +6 -6
- oci/media_services/media_services_client.py +60 -60
- oci/media_services/media_stream_client.py +2 -2
- oci/monitoring/monitoring_client.py +18 -18
- oci/mysql/channels_client.py +7 -7
- oci/mysql/db_backups_client.py +6 -6
- oci/mysql/db_system_client.py +17 -17
- oci/mysql/mysqlaas_client.py +7 -7
- oci/mysql/replicas_client.py +5 -5
- oci/mysql/work_requests_client.py +4 -4
- oci/network_firewall/network_firewall_client.py +80 -80
- oci/network_load_balancer/network_load_balancer_client.py +34 -34
- oci/nosql/nosql_client.py +24 -24
- oci/object_storage/object_storage_client.py +50 -50
- oci/oce/oce_instance_client.py +10 -10
- oci/oci_control_center/occ_metrics_client.py +3 -3
- oci/ocvp/cluster_client.py +5 -5
- oci/ocvp/esxi_host_client.py +8 -8
- oci/ocvp/sddc_client.py +14 -14
- oci/ocvp/work_request_client.py +4 -4
- oci/oda/management_client.py +59 -59
- oci/oda/oda_client.py +17 -17
- oci/oda/odapackage_client.py +7 -7
- oci/onesubscription/billing_schedule_client.py +1 -1
- oci/onesubscription/commitment_client.py +2 -2
- oci/onesubscription/computed_usage_client.py +3 -3
- oci/onesubscription/invoice_summary_client.py +2 -2
- oci/onesubscription/organization_subscription_client.py +1 -1
- oci/onesubscription/ratecard_client.py +1 -1
- oci/onesubscription/subscribed_service_client.py +2 -2
- oci/onesubscription/subscription_client.py +1 -1
- oci/ons/notification_control_plane_client.py +6 -6
- oci/ons/notification_data_plane_client.py +10 -10
- oci/opa/opa_instance_client.py +13 -13
- oci/opensearch/opensearch_cluster_backup_client.py +4 -4
- oci/opensearch/opensearch_cluster_client.py +14 -14
- oci/operator_access_control/access_requests_client.py +10 -10
- oci/operator_access_control/operator_actions_client.py +2 -2
- oci/operator_access_control/operator_control_assignment_client.py +8 -8
- oci/operator_access_control/operator_control_client.py +6 -6
- oci/opsi/operations_insights_client.py +175 -175
- oci/optimizer/optimizer_client.py +26 -26
- oci/os_management/event_client.py +8 -8
- oci/os_management/os_management_client.py +69 -69
- oci/os_management_hub/event_client.py +8 -8
- oci/os_management_hub/lifecycle_environment_client.py +12 -12
- oci/os_management_hub/managed_instance_client.py +31 -31
- oci/os_management_hub/managed_instance_group_client.py +25 -25
- oci/os_management_hub/management_station_client.py +10 -10
- oci/os_management_hub/onboarding_client.py +6 -6
- oci/os_management_hub/reporting_managed_instance_client.py +3 -3
- oci/os_management_hub/scheduled_job_client.py +7 -7
- oci/os_management_hub/software_source_client.py +27 -27
- oci/os_management_hub/work_request_client.py +4 -4
- oci/osp_gateway/address_rule_service_client.py +1 -1
- oci/osp_gateway/address_service_client.py +2 -2
- oci/osp_gateway/invoice_service_client.py +5 -5
- oci/osp_gateway/subscription_service_client.py +5 -5
- oci/osub_billing_schedule/billing_schedule_client.py +1 -1
- oci/osub_organization_subscription/organization_subscription_client.py +1 -1
- oci/osub_subscription/commitment_client.py +2 -2
- oci/osub_subscription/ratecard_client.py +1 -1
- oci/osub_subscription/subscription_client.py +1 -1
- oci/osub_usage/computed_usage_client.py +3 -3
- oci/psql/postgresql_client.py +33 -33
- oci/queue/queue_admin_client.py +11 -11
- oci/queue/queue_client.py +8 -8
- oci/recovery/database_recovery_client.py +25 -25
- oci/redis/redis_cluster_client.py +11 -11
- oci/resource_manager/resource_manager_client.py +52 -52
- oci/resource_scheduler/schedule_client.py +26 -26
- oci/resource_search/resource_search_client.py +3 -3
- oci/rover/rover_bundle_client.py +8 -8
- oci/rover/rover_cluster_client.py +8 -8
- oci/rover/rover_entitlement_client.py +6 -6
- oci/rover/rover_node_client.py +15 -15
- oci/rover/shape_client.py +1 -1
- oci/rover/work_requests_client.py +5 -5
- oci/sch/connector_plugins_client.py +2 -2
- oci/sch/service_connector_client.py +12 -12
- oci/secrets/secrets_client.py +3 -3
- oci/service_catalog/service_catalog_client.py +26 -26
- oci/service_manager_proxy/service_manager_proxy_client.py +2 -2
- oci/service_mesh/service_mesh_client.py +48 -48
- oci/stack_monitoring/stack_monitoring_client.py +64 -64
- oci/streaming/stream_admin_client.py +18 -18
- oci/streaming/stream_client.py +8 -8
- oci/tenant_manager_control_plane/domain_client.py +5 -5
- oci/tenant_manager_control_plane/domain_governance_client.py +5 -5
- oci/tenant_manager_control_plane/governance_client.py +2 -2
- oci/tenant_manager_control_plane/link_client.py +3 -3
- oci/tenant_manager_control_plane/orders_client.py +2 -2
- oci/tenant_manager_control_plane/organization_client.py +10 -10
- oci/tenant_manager_control_plane/recipient_invitation_client.py +5 -5
- oci/tenant_manager_control_plane/sender_invitation_client.py +5 -5
- oci/tenant_manager_control_plane/subscription_client.py +11 -11
- oci/tenant_manager_control_plane/work_request_client.py +4 -4
- oci/threat_intelligence/threatintel_client.py +5 -5
- oci/usage/resources_client.py +2 -2
- oci/usage/rewards_client.py +6 -6
- oci/usage/usagelimits_client.py +1 -1
- oci/usage_api/usageapi_client.py +33 -33
- oci/vault/vaults_client.py +13 -13
- oci/vbs_inst/vbs_instance_client.py +10 -10
- oci/version.py +1 -1
- oci/visual_builder/vb_instance_client.py +13 -13
- oci/vn_monitoring/vn_monitoring_client.py +12 -12
- oci/vulnerability_scanning/vulnerability_scanning_client.py +58 -58
- oci/waa/waa_client.py +13 -13
- oci/waa/work_request_client.py +4 -4
- oci/waas/redirect_client.py +6 -6
- oci/waas/waas_client.py +66 -66
- oci/waf/waf_client.py +24 -24
- oci/work_requests/work_request_client.py +4 -4
- {oci-2.126.4.dist-info → oci-2.128.0.dist-info}/METADATA +1 -1
- {oci-2.126.4.dist-info → oci-2.128.0.dist-info}/RECORD +494 -439
- {oci-2.126.4.dist-info → oci-2.128.0.dist-info}/LICENSE.txt +0 -0
- {oci-2.126.4.dist-info → oci-2.128.0.dist-info}/THIRD_PARTY_LICENSES.txt +0 -0
- {oci-2.126.4.dist-info → oci-2.128.0.dist-info}/WHEEL +0 -0
- {oci-2.126.4.dist-info → oci-2.128.0.dist-info}/top_level.txt +0 -0
@@ -15,6 +15,22 @@ class CohereChatRequest(BaseChatRequest):
|
|
15
15
|
Details for the chat request for Cohere models.
|
16
16
|
"""
|
17
17
|
|
18
|
+
#: A constant which can be used with the prompt_truncation property of a CohereChatRequest.
|
19
|
+
#: This constant has a value of "OFF"
|
20
|
+
PROMPT_TRUNCATION_OFF = "OFF"
|
21
|
+
|
22
|
+
#: A constant which can be used with the prompt_truncation property of a CohereChatRequest.
|
23
|
+
#: This constant has a value of "AUTO_PRESERVE_ORDER"
|
24
|
+
PROMPT_TRUNCATION_AUTO_PRESERVE_ORDER = "AUTO_PRESERVE_ORDER"
|
25
|
+
|
26
|
+
#: A constant which can be used with the citation_quality property of a CohereChatRequest.
|
27
|
+
#: This constant has a value of "ACCURATE"
|
28
|
+
CITATION_QUALITY_ACCURATE = "ACCURATE"
|
29
|
+
|
30
|
+
#: A constant which can be used with the citation_quality property of a CohereChatRequest.
|
31
|
+
#: This constant has a value of "FAST"
|
32
|
+
CITATION_QUALITY_FAST = "FAST"
|
33
|
+
|
18
34
|
def __init__(self, **kwargs):
|
19
35
|
"""
|
20
36
|
Initializes a new CohereChatRequest object with values from keyword arguments. The default value of the :py:attr:`~oci.generative_ai_inference.models.CohereChatRequest.api_format` attribute
|
@@ -66,6 +82,11 @@ class CohereChatRequest(BaseChatRequest):
|
|
66
82
|
The value to assign to the top_p property of this CohereChatRequest.
|
67
83
|
:type top_p: float
|
68
84
|
|
85
|
+
:param prompt_truncation:
|
86
|
+
The value to assign to the prompt_truncation property of this CohereChatRequest.
|
87
|
+
Allowed values for this property are: "OFF", "AUTO_PRESERVE_ORDER"
|
88
|
+
:type prompt_truncation: str
|
89
|
+
|
69
90
|
:param frequency_penalty:
|
70
91
|
The value to assign to the frequency_penalty property of this CohereChatRequest.
|
71
92
|
:type frequency_penalty: float
|
@@ -74,6 +95,39 @@ class CohereChatRequest(BaseChatRequest):
|
|
74
95
|
The value to assign to the presence_penalty property of this CohereChatRequest.
|
75
96
|
:type presence_penalty: float
|
76
97
|
|
98
|
+
:param seed:
|
99
|
+
The value to assign to the seed property of this CohereChatRequest.
|
100
|
+
:type seed: int
|
101
|
+
|
102
|
+
:param is_echo:
|
103
|
+
The value to assign to the is_echo property of this CohereChatRequest.
|
104
|
+
:type is_echo: bool
|
105
|
+
|
106
|
+
:param tools:
|
107
|
+
The value to assign to the tools property of this CohereChatRequest.
|
108
|
+
:type tools: list[oci.generative_ai_inference.models.CohereTool]
|
109
|
+
|
110
|
+
:param tool_results:
|
111
|
+
The value to assign to the tool_results property of this CohereChatRequest.
|
112
|
+
:type tool_results: list[oci.generative_ai_inference.models.CohereToolResult]
|
113
|
+
|
114
|
+
:param is_force_single_step:
|
115
|
+
The value to assign to the is_force_single_step property of this CohereChatRequest.
|
116
|
+
:type is_force_single_step: bool
|
117
|
+
|
118
|
+
:param stop_sequences:
|
119
|
+
The value to assign to the stop_sequences property of this CohereChatRequest.
|
120
|
+
:type stop_sequences: list[str]
|
121
|
+
|
122
|
+
:param is_raw_prompting:
|
123
|
+
The value to assign to the is_raw_prompting property of this CohereChatRequest.
|
124
|
+
:type is_raw_prompting: bool
|
125
|
+
|
126
|
+
:param citation_quality:
|
127
|
+
The value to assign to the citation_quality property of this CohereChatRequest.
|
128
|
+
Allowed values for this property are: "ACCURATE", "FAST"
|
129
|
+
:type citation_quality: str
|
130
|
+
|
77
131
|
"""
|
78
132
|
self.swagger_types = {
|
79
133
|
'api_format': 'str',
|
@@ -87,8 +141,17 @@ class CohereChatRequest(BaseChatRequest):
|
|
87
141
|
'temperature': 'float',
|
88
142
|
'top_k': 'int',
|
89
143
|
'top_p': 'float',
|
144
|
+
'prompt_truncation': 'str',
|
90
145
|
'frequency_penalty': 'float',
|
91
|
-
'presence_penalty': 'float'
|
146
|
+
'presence_penalty': 'float',
|
147
|
+
'seed': 'int',
|
148
|
+
'is_echo': 'bool',
|
149
|
+
'tools': 'list[CohereTool]',
|
150
|
+
'tool_results': 'list[CohereToolResult]',
|
151
|
+
'is_force_single_step': 'bool',
|
152
|
+
'stop_sequences': 'list[str]',
|
153
|
+
'is_raw_prompting': 'bool',
|
154
|
+
'citation_quality': 'str'
|
92
155
|
}
|
93
156
|
|
94
157
|
self.attribute_map = {
|
@@ -103,8 +166,17 @@ class CohereChatRequest(BaseChatRequest):
|
|
103
166
|
'temperature': 'temperature',
|
104
167
|
'top_k': 'topK',
|
105
168
|
'top_p': 'topP',
|
169
|
+
'prompt_truncation': 'promptTruncation',
|
106
170
|
'frequency_penalty': 'frequencyPenalty',
|
107
|
-
'presence_penalty': 'presencePenalty'
|
171
|
+
'presence_penalty': 'presencePenalty',
|
172
|
+
'seed': 'seed',
|
173
|
+
'is_echo': 'isEcho',
|
174
|
+
'tools': 'tools',
|
175
|
+
'tool_results': 'toolResults',
|
176
|
+
'is_force_single_step': 'isForceSingleStep',
|
177
|
+
'stop_sequences': 'stopSequences',
|
178
|
+
'is_raw_prompting': 'isRawPrompting',
|
179
|
+
'citation_quality': 'citationQuality'
|
108
180
|
}
|
109
181
|
|
110
182
|
self._api_format = None
|
@@ -118,15 +190,24 @@ class CohereChatRequest(BaseChatRequest):
|
|
118
190
|
self._temperature = None
|
119
191
|
self._top_k = None
|
120
192
|
self._top_p = None
|
193
|
+
self._prompt_truncation = None
|
121
194
|
self._frequency_penalty = None
|
122
195
|
self._presence_penalty = None
|
196
|
+
self._seed = None
|
197
|
+
self._is_echo = None
|
198
|
+
self._tools = None
|
199
|
+
self._tool_results = None
|
200
|
+
self._is_force_single_step = None
|
201
|
+
self._stop_sequences = None
|
202
|
+
self._is_raw_prompting = None
|
203
|
+
self._citation_quality = None
|
123
204
|
self._api_format = 'COHERE'
|
124
205
|
|
125
206
|
@property
|
126
207
|
def message(self):
|
127
208
|
"""
|
128
209
|
**[Required]** Gets the message of this CohereChatRequest.
|
129
|
-
|
210
|
+
The text that the user inputs for the model to respond to.
|
130
211
|
|
131
212
|
|
132
213
|
:return: The message of this CohereChatRequest.
|
@@ -138,7 +219,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
138
219
|
def message(self, message):
|
139
220
|
"""
|
140
221
|
Sets the message of this CohereChatRequest.
|
141
|
-
|
222
|
+
The text that the user inputs for the model to respond to.
|
142
223
|
|
143
224
|
|
144
225
|
:param message: The message of this CohereChatRequest.
|
@@ -150,7 +231,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
150
231
|
def chat_history(self):
|
151
232
|
"""
|
152
233
|
Gets the chat_history of this CohereChatRequest.
|
153
|
-
|
234
|
+
The list of previous messages between the user and the model. The chat history gives the model context for responding to the user's inputs.
|
154
235
|
|
155
236
|
|
156
237
|
:return: The chat_history of this CohereChatRequest.
|
@@ -162,7 +243,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
162
243
|
def chat_history(self, chat_history):
|
163
244
|
"""
|
164
245
|
Sets the chat_history of this CohereChatRequest.
|
165
|
-
|
246
|
+
The list of previous messages between the user and the model. The chat history gives the model context for responding to the user's inputs.
|
166
247
|
|
167
248
|
|
168
249
|
:param chat_history: The chat_history of this CohereChatRequest.
|
@@ -174,10 +255,14 @@ class CohereChatRequest(BaseChatRequest):
|
|
174
255
|
def documents(self):
|
175
256
|
"""
|
176
257
|
Gets the documents of this CohereChatRequest.
|
177
|
-
list of relevant documents that the model can
|
178
|
-
Some
|
179
|
-
|
180
|
-
|
258
|
+
A list of relevant documents that the model can refer to for generating grounded responses to the user's requests.
|
259
|
+
Some example keys that you can add to the dictionary are \"text\", \"author\", and \"date\". Keep the total word count of the strings in the dictionary to 300 words or less.
|
260
|
+
|
261
|
+
Example:
|
262
|
+
`[
|
263
|
+
{ \"title\": \"Tall penguins\", \"snippet\": \"Emperor penguins are the tallest.\" },
|
264
|
+
{ \"title\": \"Penguin habitats\", \"snippet\": \"Emperor penguins only live in Antarctica.\" }
|
265
|
+
]`
|
181
266
|
|
182
267
|
|
183
268
|
:return: The documents of this CohereChatRequest.
|
@@ -189,10 +274,14 @@ class CohereChatRequest(BaseChatRequest):
|
|
189
274
|
def documents(self, documents):
|
190
275
|
"""
|
191
276
|
Sets the documents of this CohereChatRequest.
|
192
|
-
list of relevant documents that the model can
|
193
|
-
Some
|
194
|
-
|
195
|
-
|
277
|
+
A list of relevant documents that the model can refer to for generating grounded responses to the user's requests.
|
278
|
+
Some example keys that you can add to the dictionary are \"text\", \"author\", and \"date\". Keep the total word count of the strings in the dictionary to 300 words or less.
|
279
|
+
|
280
|
+
Example:
|
281
|
+
`[
|
282
|
+
{ \"title\": \"Tall penguins\", \"snippet\": \"Emperor penguins are the tallest.\" },
|
283
|
+
{ \"title\": \"Penguin habitats\", \"snippet\": \"Emperor penguins only live in Antarctica.\" }
|
284
|
+
]`
|
196
285
|
|
197
286
|
|
198
287
|
:param documents: The documents of this CohereChatRequest.
|
@@ -204,7 +293,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
204
293
|
def is_search_queries_only(self):
|
205
294
|
"""
|
206
295
|
Gets the is_search_queries_only of this CohereChatRequest.
|
207
|
-
When true, the response
|
296
|
+
When set to true, the response contains only a list of generated search queries without the search results and the model will not respond to the user's message.
|
208
297
|
|
209
298
|
|
210
299
|
:return: The is_search_queries_only of this CohereChatRequest.
|
@@ -216,7 +305,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
216
305
|
def is_search_queries_only(self, is_search_queries_only):
|
217
306
|
"""
|
218
307
|
Sets the is_search_queries_only of this CohereChatRequest.
|
219
|
-
When true, the response
|
308
|
+
When set to true, the response contains only a list of generated search queries without the search results and the model will not respond to the user's message.
|
220
309
|
|
221
310
|
|
222
311
|
:param is_search_queries_only: The is_search_queries_only of this CohereChatRequest.
|
@@ -228,7 +317,9 @@ class CohereChatRequest(BaseChatRequest):
|
|
228
317
|
def preamble_override(self):
|
229
318
|
"""
|
230
319
|
Gets the preamble_override of this CohereChatRequest.
|
231
|
-
|
320
|
+
If specified, the default Cohere preamble is replaced with the provided preamble. A preamble is an initial guideline message that can change the model's overall chat behavior and conversation style. Default preambles vary for different models.
|
321
|
+
|
322
|
+
Example: `You are a travel advisor. Answer with a pirate tone.`
|
232
323
|
|
233
324
|
|
234
325
|
:return: The preamble_override of this CohereChatRequest.
|
@@ -240,7 +331,9 @@ class CohereChatRequest(BaseChatRequest):
|
|
240
331
|
def preamble_override(self, preamble_override):
|
241
332
|
"""
|
242
333
|
Sets the preamble_override of this CohereChatRequest.
|
243
|
-
|
334
|
+
If specified, the default Cohere preamble is replaced with the provided preamble. A preamble is an initial guideline message that can change the model's overall chat behavior and conversation style. Default preambles vary for different models.
|
335
|
+
|
336
|
+
Example: `You are a travel advisor. Answer with a pirate tone.`
|
244
337
|
|
245
338
|
|
246
339
|
:param preamble_override: The preamble_override of this CohereChatRequest.
|
@@ -252,7 +345,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
252
345
|
def is_stream(self):
|
253
346
|
"""
|
254
347
|
Gets the is_stream of this CohereChatRequest.
|
255
|
-
Whether to stream
|
348
|
+
Whether to stream the partial progress of the model's response. When set to true, as tokens become available, they are sent as data-only server-sent events.
|
256
349
|
|
257
350
|
|
258
351
|
:return: The is_stream of this CohereChatRequest.
|
@@ -264,7 +357,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
264
357
|
def is_stream(self, is_stream):
|
265
358
|
"""
|
266
359
|
Sets the is_stream of this CohereChatRequest.
|
267
|
-
Whether to stream
|
360
|
+
Whether to stream the partial progress of the model's response. When set to true, as tokens become available, they are sent as data-only server-sent events.
|
268
361
|
|
269
362
|
|
270
363
|
:param is_stream: The is_stream of this CohereChatRequest.
|
@@ -276,7 +369,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
276
369
|
def max_tokens(self):
|
277
370
|
"""
|
278
371
|
Gets the max_tokens of this CohereChatRequest.
|
279
|
-
The maximum number of tokens
|
372
|
+
The maximum number of output tokens that the model will generate for the response.
|
280
373
|
|
281
374
|
|
282
375
|
:return: The max_tokens of this CohereChatRequest.
|
@@ -288,7 +381,7 @@ class CohereChatRequest(BaseChatRequest):
|
|
288
381
|
def max_tokens(self, max_tokens):
|
289
382
|
"""
|
290
383
|
Sets the max_tokens of this CohereChatRequest.
|
291
|
-
The maximum number of tokens
|
384
|
+
The maximum number of output tokens that the model will generate for the response.
|
292
385
|
|
293
386
|
|
294
387
|
:param max_tokens: The max_tokens of this CohereChatRequest.
|
@@ -300,8 +393,8 @@ class CohereChatRequest(BaseChatRequest):
|
|
300
393
|
def temperature(self):
|
301
394
|
"""
|
302
395
|
Gets the temperature of this CohereChatRequest.
|
303
|
-
A number that sets the randomness of the generated output. A lower temperature means
|
304
|
-
Use lower numbers for tasks
|
396
|
+
A number that sets the randomness of the generated output. A lower temperature means less random generations.
|
397
|
+
Use lower numbers for tasks such as question answering or summarizing. High temperatures can generate hallucinations or factually incorrect information. Start with temperatures lower than 1.0 and increase the temperature for more creative outputs, as you regenerate the prompts to refine the outputs.
|
305
398
|
|
306
399
|
|
307
400
|
:return: The temperature of this CohereChatRequest.
|
@@ -313,8 +406,8 @@ class CohereChatRequest(BaseChatRequest):
|
|
313
406
|
def temperature(self, temperature):
|
314
407
|
"""
|
315
408
|
Sets the temperature of this CohereChatRequest.
|
316
|
-
A number that sets the randomness of the generated output. A lower temperature means
|
317
|
-
Use lower numbers for tasks
|
409
|
+
A number that sets the randomness of the generated output. A lower temperature means less random generations.
|
410
|
+
Use lower numbers for tasks such as question answering or summarizing. High temperatures can generate hallucinations or factually incorrect information. Start with temperatures lower than 1.0 and increase the temperature for more creative outputs, as you regenerate the prompts to refine the outputs.
|
318
411
|
|
319
412
|
|
320
413
|
:param temperature: The temperature of this CohereChatRequest.
|
@@ -326,9 +419,9 @@ class CohereChatRequest(BaseChatRequest):
|
|
326
419
|
def top_k(self):
|
327
420
|
"""
|
328
421
|
Gets the top_k of this CohereChatRequest.
|
329
|
-
|
422
|
+
A sampling method in which the model chooses the next token randomly from the top k most likely tokens. A higher value for k generates more random output, which makes the output text sound more natural. The default value for k is 0 which disables this method and considers all tokens. To set a number for the likely tokens, choose an integer between 1 and 500.
|
330
423
|
|
331
|
-
If also using top p, then the model considers only the top tokens whose probabilities add up to p percent and ignores the rest of the k tokens. For example, if k is 20
|
424
|
+
If also using top p, then the model considers only the top tokens whose probabilities add up to p percent and ignores the rest of the k tokens. For example, if k is 20 but only the probabilities of the top 10 add up to the value of p, then only the top 10 tokens are chosen.
|
332
425
|
|
333
426
|
|
334
427
|
:return: The top_k of this CohereChatRequest.
|
@@ -340,9 +433,9 @@ class CohereChatRequest(BaseChatRequest):
|
|
340
433
|
def top_k(self, top_k):
|
341
434
|
"""
|
342
435
|
Sets the top_k of this CohereChatRequest.
|
343
|
-
|
436
|
+
A sampling method in which the model chooses the next token randomly from the top k most likely tokens. A higher value for k generates more random output, which makes the output text sound more natural. The default value for k is 0 which disables this method and considers all tokens. To set a number for the likely tokens, choose an integer between 1 and 500.
|
344
437
|
|
345
|
-
If also using top p, then the model considers only the top tokens whose probabilities add up to p percent and ignores the rest of the k tokens. For example, if k is 20
|
438
|
+
If also using top p, then the model considers only the top tokens whose probabilities add up to p percent and ignores the rest of the k tokens. For example, if k is 20 but only the probabilities of the top 10 add up to the value of p, then only the top 10 tokens are chosen.
|
346
439
|
|
347
440
|
|
348
441
|
:param top_k: The top_k of this CohereChatRequest.
|
@@ -378,6 +471,37 @@ class CohereChatRequest(BaseChatRequest):
|
|
378
471
|
"""
|
379
472
|
self._top_p = top_p
|
380
473
|
|
474
|
+
@property
|
475
|
+
def prompt_truncation(self):
|
476
|
+
"""
|
477
|
+
Gets the prompt_truncation of this CohereChatRequest.
|
478
|
+
Defaults to OFF. Dictates how the prompt will be constructed. With `prompt_truncation` set to AUTO_PRESERVE_ORDER, some elements from `chat_history` and `documents` will be dropped to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved. With `prompt_truncation` set to OFF, no elements will be dropped.
|
479
|
+
|
480
|
+
Allowed values for this property are: "OFF", "AUTO_PRESERVE_ORDER"
|
481
|
+
|
482
|
+
|
483
|
+
:return: The prompt_truncation of this CohereChatRequest.
|
484
|
+
:rtype: str
|
485
|
+
"""
|
486
|
+
return self._prompt_truncation
|
487
|
+
|
488
|
+
@prompt_truncation.setter
|
489
|
+
def prompt_truncation(self, prompt_truncation):
|
490
|
+
"""
|
491
|
+
Sets the prompt_truncation of this CohereChatRequest.
|
492
|
+
Defaults to OFF. Dictates how the prompt will be constructed. With `prompt_truncation` set to AUTO_PRESERVE_ORDER, some elements from `chat_history` and `documents` will be dropped to construct a prompt that fits within the model's context length limit. During this process the order of the documents and chat history will be preserved. With `prompt_truncation` set to OFF, no elements will be dropped.
|
493
|
+
|
494
|
+
|
495
|
+
:param prompt_truncation: The prompt_truncation of this CohereChatRequest.
|
496
|
+
:type: str
|
497
|
+
"""
|
498
|
+
allowed_values = ["OFF", "AUTO_PRESERVE_ORDER"]
|
499
|
+
if not value_allowed_none_or_none_sentinel(prompt_truncation, allowed_values):
|
500
|
+
raise ValueError(
|
501
|
+
f"Invalid value for `prompt_truncation`, must be None or one of {allowed_values}"
|
502
|
+
)
|
503
|
+
self._prompt_truncation = prompt_truncation
|
504
|
+
|
381
505
|
@property
|
382
506
|
def frequency_penalty(self):
|
383
507
|
"""
|
@@ -430,6 +554,205 @@ class CohereChatRequest(BaseChatRequest):
|
|
430
554
|
"""
|
431
555
|
self._presence_penalty = presence_penalty
|
432
556
|
|
557
|
+
@property
|
558
|
+
def seed(self):
|
559
|
+
"""
|
560
|
+
Gets the seed of this CohereChatRequest.
|
561
|
+
If specified, the backend will make a best effort to sample tokens deterministically, such that repeated requests with the same seed and parameters should return the same result. However, determinism cannot be totally guaranteed.
|
562
|
+
|
563
|
+
|
564
|
+
:return: The seed of this CohereChatRequest.
|
565
|
+
:rtype: int
|
566
|
+
"""
|
567
|
+
return self._seed
|
568
|
+
|
569
|
+
@seed.setter
|
570
|
+
def seed(self, seed):
|
571
|
+
"""
|
572
|
+
Sets the seed of this CohereChatRequest.
|
573
|
+
If specified, the backend will make a best effort to sample tokens deterministically, such that repeated requests with the same seed and parameters should return the same result. However, determinism cannot be totally guaranteed.
|
574
|
+
|
575
|
+
|
576
|
+
:param seed: The seed of this CohereChatRequest.
|
577
|
+
:type: int
|
578
|
+
"""
|
579
|
+
self._seed = seed
|
580
|
+
|
581
|
+
@property
|
582
|
+
def is_echo(self):
|
583
|
+
"""
|
584
|
+
Gets the is_echo of this CohereChatRequest.
|
585
|
+
Returns the full prompt that was sent to the model when True.
|
586
|
+
|
587
|
+
|
588
|
+
:return: The is_echo of this CohereChatRequest.
|
589
|
+
:rtype: bool
|
590
|
+
"""
|
591
|
+
return self._is_echo
|
592
|
+
|
593
|
+
@is_echo.setter
|
594
|
+
def is_echo(self, is_echo):
|
595
|
+
"""
|
596
|
+
Sets the is_echo of this CohereChatRequest.
|
597
|
+
Returns the full prompt that was sent to the model when True.
|
598
|
+
|
599
|
+
|
600
|
+
:param is_echo: The is_echo of this CohereChatRequest.
|
601
|
+
:type: bool
|
602
|
+
"""
|
603
|
+
self._is_echo = is_echo
|
604
|
+
|
605
|
+
@property
|
606
|
+
def tools(self):
|
607
|
+
"""
|
608
|
+
Gets the tools of this CohereChatRequest.
|
609
|
+
A list of available tools (functions) that the model may suggest invoking before producing a text response.
|
610
|
+
|
611
|
+
|
612
|
+
:return: The tools of this CohereChatRequest.
|
613
|
+
:rtype: list[oci.generative_ai_inference.models.CohereTool]
|
614
|
+
"""
|
615
|
+
return self._tools
|
616
|
+
|
617
|
+
@tools.setter
|
618
|
+
def tools(self, tools):
|
619
|
+
"""
|
620
|
+
Sets the tools of this CohereChatRequest.
|
621
|
+
A list of available tools (functions) that the model may suggest invoking before producing a text response.
|
622
|
+
|
623
|
+
|
624
|
+
:param tools: The tools of this CohereChatRequest.
|
625
|
+
:type: list[oci.generative_ai_inference.models.CohereTool]
|
626
|
+
"""
|
627
|
+
self._tools = tools
|
628
|
+
|
629
|
+
@property
|
630
|
+
def tool_results(self):
|
631
|
+
"""
|
632
|
+
Gets the tool_results of this CohereChatRequest.
|
633
|
+
A list of results from invoking tools recommended by the model in the previous chat turn.
|
634
|
+
|
635
|
+
|
636
|
+
:return: The tool_results of this CohereChatRequest.
|
637
|
+
:rtype: list[oci.generative_ai_inference.models.CohereToolResult]
|
638
|
+
"""
|
639
|
+
return self._tool_results
|
640
|
+
|
641
|
+
@tool_results.setter
|
642
|
+
def tool_results(self, tool_results):
|
643
|
+
"""
|
644
|
+
Sets the tool_results of this CohereChatRequest.
|
645
|
+
A list of results from invoking tools recommended by the model in the previous chat turn.
|
646
|
+
|
647
|
+
|
648
|
+
:param tool_results: The tool_results of this CohereChatRequest.
|
649
|
+
:type: list[oci.generative_ai_inference.models.CohereToolResult]
|
650
|
+
"""
|
651
|
+
self._tool_results = tool_results
|
652
|
+
|
653
|
+
@property
|
654
|
+
def is_force_single_step(self):
|
655
|
+
"""
|
656
|
+
Gets the is_force_single_step of this CohereChatRequest.
|
657
|
+
When enabled, the model will issue (potentially multiple) tool calls in a single step, before it receives the tool responses and directly answers the user's original message.
|
658
|
+
|
659
|
+
|
660
|
+
:return: The is_force_single_step of this CohereChatRequest.
|
661
|
+
:rtype: bool
|
662
|
+
"""
|
663
|
+
return self._is_force_single_step
|
664
|
+
|
665
|
+
@is_force_single_step.setter
|
666
|
+
def is_force_single_step(self, is_force_single_step):
|
667
|
+
"""
|
668
|
+
Sets the is_force_single_step of this CohereChatRequest.
|
669
|
+
When enabled, the model will issue (potentially multiple) tool calls in a single step, before it receives the tool responses and directly answers the user's original message.
|
670
|
+
|
671
|
+
|
672
|
+
:param is_force_single_step: The is_force_single_step of this CohereChatRequest.
|
673
|
+
:type: bool
|
674
|
+
"""
|
675
|
+
self._is_force_single_step = is_force_single_step
|
676
|
+
|
677
|
+
@property
|
678
|
+
def stop_sequences(self):
|
679
|
+
"""
|
680
|
+
Gets the stop_sequences of this CohereChatRequest.
|
681
|
+
Stop the model generation when it reaches a stop sequence defined in this parameter.
|
682
|
+
|
683
|
+
|
684
|
+
:return: The stop_sequences of this CohereChatRequest.
|
685
|
+
:rtype: list[str]
|
686
|
+
"""
|
687
|
+
return self._stop_sequences
|
688
|
+
|
689
|
+
@stop_sequences.setter
|
690
|
+
def stop_sequences(self, stop_sequences):
|
691
|
+
"""
|
692
|
+
Sets the stop_sequences of this CohereChatRequest.
|
693
|
+
Stop the model generation when it reaches a stop sequence defined in this parameter.
|
694
|
+
|
695
|
+
|
696
|
+
:param stop_sequences: The stop_sequences of this CohereChatRequest.
|
697
|
+
:type: list[str]
|
698
|
+
"""
|
699
|
+
self._stop_sequences = stop_sequences
|
700
|
+
|
701
|
+
@property
|
702
|
+
def is_raw_prompting(self):
|
703
|
+
"""
|
704
|
+
Gets the is_raw_prompting of this CohereChatRequest.
|
705
|
+
When enabled, the user\u2019s `message` will be sent to the model without any preprocessing.
|
706
|
+
|
707
|
+
|
708
|
+
:return: The is_raw_prompting of this CohereChatRequest.
|
709
|
+
:rtype: bool
|
710
|
+
"""
|
711
|
+
return self._is_raw_prompting
|
712
|
+
|
713
|
+
@is_raw_prompting.setter
|
714
|
+
def is_raw_prompting(self, is_raw_prompting):
|
715
|
+
"""
|
716
|
+
Sets the is_raw_prompting of this CohereChatRequest.
|
717
|
+
When enabled, the user\u2019s `message` will be sent to the model without any preprocessing.
|
718
|
+
|
719
|
+
|
720
|
+
:param is_raw_prompting: The is_raw_prompting of this CohereChatRequest.
|
721
|
+
:type: bool
|
722
|
+
"""
|
723
|
+
self._is_raw_prompting = is_raw_prompting
|
724
|
+
|
725
|
+
@property
|
726
|
+
def citation_quality(self):
|
727
|
+
"""
|
728
|
+
Gets the citation_quality of this CohereChatRequest.
|
729
|
+
When FAST is selected, citations are generated at the same time as the text output and the request will be completed sooner. May result in less accurate citations.
|
730
|
+
|
731
|
+
Allowed values for this property are: "ACCURATE", "FAST"
|
732
|
+
|
733
|
+
|
734
|
+
:return: The citation_quality of this CohereChatRequest.
|
735
|
+
:rtype: str
|
736
|
+
"""
|
737
|
+
return self._citation_quality
|
738
|
+
|
739
|
+
@citation_quality.setter
|
740
|
+
def citation_quality(self, citation_quality):
|
741
|
+
"""
|
742
|
+
Sets the citation_quality of this CohereChatRequest.
|
743
|
+
When FAST is selected, citations are generated at the same time as the text output and the request will be completed sooner. May result in less accurate citations.
|
744
|
+
|
745
|
+
|
746
|
+
:param citation_quality: The citation_quality of this CohereChatRequest.
|
747
|
+
:type: str
|
748
|
+
"""
|
749
|
+
allowed_values = ["ACCURATE", "FAST"]
|
750
|
+
if not value_allowed_none_or_none_sentinel(citation_quality, allowed_values):
|
751
|
+
raise ValueError(
|
752
|
+
f"Invalid value for `citation_quality`, must be None or one of {allowed_values}"
|
753
|
+
)
|
754
|
+
self._citation_quality = citation_quality
|
755
|
+
|
433
756
|
def __repr__(self):
|
434
757
|
return formatted_flat_dict(self)
|
435
758
|
|