eval-studio-client 1.2.5__py3-none-any.whl → 1.3.0a1__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.
- eval_studio_client/api/__init__.py +65 -0
- eval_studio_client/api/api/__init__.py +3 -0
- eval_studio_client/api/api/dashboard_report_service_api.py +292 -0
- eval_studio_client/api/api/dashboard_service_api.py +16 -16
- eval_studio_client/api/api/dashboard_test_case_annotation_service_api.py +611 -0
- eval_studio_client/api/api/document_service_api.py +16 -16
- eval_studio_client/api/api/evaluation_service_api.py +12 -12
- eval_studio_client/api/api/evaluator_service_api.py +16 -16
- eval_studio_client/api/api/leaderboard_report_service_api.py +304 -17
- eval_studio_client/api/api/leaderboard_service_api.py +554 -16
- eval_studio_client/api/api/leaderboard_test_case_annotation_service_api.py +611 -0
- eval_studio_client/api/api/model_service_api.py +16 -16
- eval_studio_client/api/api/operation_service_api.py +821 -17
- eval_studio_client/api/api/perturbator_service_api.py +22 -22
- eval_studio_client/api/api/test_case_service_api.py +300 -16
- eval_studio_client/api/api/test_class_service_api.py +16 -16
- eval_studio_client/api/api/test_service_api.py +285 -16
- eval_studio_client/api/api/workflow_node_service_api.py +16 -16
- eval_studio_client/api/api/workflow_service_api.py +16 -16
- eval_studio_client/api/docs/AdversarialInputsServiceTestAdversarialInputsRobustnessRequest.md +2 -1
- eval_studio_client/api/docs/DashboardReportServiceApi.md +75 -0
- eval_studio_client/api/docs/DashboardServiceApi.md +5 -5
- eval_studio_client/api/docs/DashboardTestCaseAnnotationServiceApi.md +149 -0
- eval_studio_client/api/docs/DocumentServiceApi.md +5 -5
- eval_studio_client/api/docs/EvaluationServiceApi.md +4 -4
- eval_studio_client/api/docs/EvaluatorServiceApi.md +5 -5
- eval_studio_client/api/docs/LeaderboardReportServiceApi.md +75 -5
- eval_studio_client/api/docs/LeaderboardServiceApi.md +141 -5
- eval_studio_client/api/docs/LeaderboardTestCaseAnnotationServiceApi.md +149 -0
- eval_studio_client/api/docs/ModelServiceApi.md +5 -5
- eval_studio_client/api/docs/OperationServiceApi.md +215 -8
- eval_studio_client/api/docs/PerturbatorServiceApi.md +7 -7
- eval_studio_client/api/docs/RequiredTheDashboardTestCaseAnnotationToUpdate.md +35 -0
- eval_studio_client/api/docs/RequiredTheLeaderboardTestCaseAnnotationToUpdate.md +35 -0
- eval_studio_client/api/docs/RequiredTheLeaderboardToUpdate.md +1 -0
- eval_studio_client/api/docs/RequiredTheOperationToFinalize.md +1 -0
- eval_studio_client/api/docs/RequiredTheOperationToUpdate.md +1 -0
- eval_studio_client/api/docs/TestCaseServiceApi.md +75 -5
- eval_studio_client/api/docs/TestCaseServiceAppendTestCasesRequest.md +30 -0
- eval_studio_client/api/docs/TestClassServiceApi.md +5 -5
- eval_studio_client/api/docs/TestServiceApi.md +73 -5
- eval_studio_client/api/docs/V1ActualOutputMeta.md +30 -0
- eval_studio_client/api/docs/V1ActualOutputMetaDiff.md +36 -0
- eval_studio_client/api/docs/V1AgentChatActivityDiagram.md +31 -0
- eval_studio_client/api/docs/V1AgentChatActivityDiagramEdge.md +32 -0
- eval_studio_client/api/docs/V1AgentChatActivityDiagramNode.md +32 -0
- eval_studio_client/api/docs/V1AgentChatActivityDiagramRow.md +30 -0
- eval_studio_client/api/docs/V1AgentChatScriptUsage.md +33 -0
- eval_studio_client/api/docs/V1AgentChatScriptsBarChart.md +30 -0
- eval_studio_client/api/docs/V1AgentChatToolUsage.md +33 -0
- eval_studio_client/api/docs/V1AgentChatToolsBarChart.md +30 -0
- eval_studio_client/api/docs/V1AllMetricScores.md +29 -0
- eval_studio_client/api/docs/V1AppendTestCasesResponse.md +29 -0
- eval_studio_client/api/docs/V1BatchCreateLeaderboardsWithoutCacheRequest.md +31 -0
- eval_studio_client/api/docs/V1BatchCreateLeaderboardsWithoutCacheResponse.md +29 -0
- eval_studio_client/api/docs/V1BatchMarkOperationSeenByCreatorResponse.md +29 -0
- eval_studio_client/api/docs/V1CmpLeaderboardReportsRequest.md +33 -0
- eval_studio_client/api/docs/V1CmpLeaderboardReportsResponse.md +29 -0
- eval_studio_client/api/docs/V1ComparisonItem.md +36 -0
- eval_studio_client/api/docs/V1ComparisonMetricScore.md +30 -0
- eval_studio_client/api/docs/V1ComparisonResult.md +31 -0
- eval_studio_client/api/docs/V1ComparisonSummary.md +31 -0
- eval_studio_client/api/docs/V1CreateEvaluationRequest.md +1 -0
- eval_studio_client/api/docs/V1CreateTestFromTestCasesRequest.md +32 -0
- eval_studio_client/api/docs/V1CreateTestFromTestCasesResponse.md +29 -0
- eval_studio_client/api/docs/V1DashboardReport.md +31 -0
- eval_studio_client/api/docs/V1DashboardReportResult.md +39 -0
- eval_studio_client/api/docs/V1DashboardTestCaseAnnotation.md +36 -0
- eval_studio_client/api/docs/V1DataFragment.md +31 -0
- eval_studio_client/api/docs/V1DeepCompareLeaderboardsRequest.md +33 -0
- eval_studio_client/api/docs/V1DeepCompareLeaderboardsResponse.md +29 -0
- eval_studio_client/api/docs/V1DiffItem.md +36 -0
- eval_studio_client/api/docs/V1EvaluationType.md +12 -0
- eval_studio_client/api/docs/V1FlippedMetric.md +31 -0
- eval_studio_client/api/docs/V1GetDashboardReportResponse.md +29 -0
- eval_studio_client/api/docs/V1HumanDecision.md +12 -0
- eval_studio_client/api/docs/V1Info.md +1 -0
- eval_studio_client/api/docs/V1Leaderboard.md +1 -0
- eval_studio_client/api/docs/V1LeaderboardCmpReport.md +30 -0
- eval_studio_client/api/docs/V1LeaderboardComparisonItem.md +31 -0
- eval_studio_client/api/docs/V1LeaderboardInfo.md +30 -0
- eval_studio_client/api/docs/V1LeaderboardReportActualOutputMeta.md +6 -3
- eval_studio_client/api/docs/V1LeaderboardReportResult.md +11 -8
- eval_studio_client/api/docs/V1LeaderboardReportResultView.md +12 -0
- eval_studio_client/api/docs/V1LeaderboardTestCaseAnnotation.md +36 -0
- eval_studio_client/api/docs/V1ListDashboardTestCaseAnnotationsResponse.md +29 -0
- eval_studio_client/api/docs/V1ListLeaderboardTestCaseAnnotationsResponse.md +29 -0
- eval_studio_client/api/docs/V1ListOperationsResponse.md +1 -0
- eval_studio_client/api/docs/V1ListUnseenOperationsResponse.md +30 -0
- eval_studio_client/api/docs/V1MarkOperationSeenByCreatorResponse.md +29 -0
- eval_studio_client/api/docs/V1Metric.md +30 -0
- eval_studio_client/api/docs/V1MetricAverage.md +36 -0
- eval_studio_client/api/docs/V1MetricMeta.md +40 -0
- eval_studio_client/api/docs/V1MetricScore.md +1 -1
- eval_studio_client/api/docs/V1MetricScores.md +1 -1
- eval_studio_client/api/docs/V1ModelType.md +1 -1
- eval_studio_client/api/docs/V1ModelsComparisons.md +32 -0
- eval_studio_client/api/docs/V1ModelsComparisonsMetrics.md +33 -0
- eval_studio_client/api/docs/V1ModelsOverview.md +34 -0
- eval_studio_client/api/docs/V1Operation.md +1 -0
- eval_studio_client/api/docs/V1OperationView.md +12 -0
- eval_studio_client/api/docs/V1RetrievedContextDiff.md +36 -0
- eval_studio_client/api/docs/V1Stats.md +2 -0
- eval_studio_client/api/docs/V1TechnicalMetrics.md +30 -0
- eval_studio_client/api/docs/V1TechnicalMetricsDetail.md +33 -0
- eval_studio_client/api/docs/V1TestCaseLeaderboardItem.md +31 -0
- eval_studio_client/api/docs/V1TestCaseRelationshipInfo.md +31 -0
- eval_studio_client/api/docs/V1TestCaseResult.md +48 -0
- eval_studio_client/api/docs/V1TextSimilarityMetric.md +12 -0
- eval_studio_client/api/docs/V1UpdateDashboardTestCaseAnnotationResponse.md +29 -0
- eval_studio_client/api/docs/V1UpdateLeaderboardTestCaseAnnotationResponse.md +29 -0
- eval_studio_client/api/docs/WorkflowNodeServiceApi.md +5 -5
- eval_studio_client/api/docs/WorkflowServiceApi.md +5 -5
- eval_studio_client/api/models/__init__.py +62 -0
- eval_studio_client/api/models/adversarial_inputs_service_test_adversarial_inputs_robustness_request.py +17 -2
- eval_studio_client/api/models/required_the_dashboard_test_case_annotation_to_update.py +108 -0
- eval_studio_client/api/models/required_the_leaderboard_test_case_annotation_to_update.py +108 -0
- eval_studio_client/api/models/required_the_leaderboard_to_update.py +5 -2
- eval_studio_client/api/models/required_the_operation_to_finalize.py +6 -2
- eval_studio_client/api/models/required_the_operation_to_update.py +6 -2
- eval_studio_client/api/models/test_case_service_append_test_cases_request.py +89 -0
- eval_studio_client/api/models/v1_actual_output_meta.py +97 -0
- eval_studio_client/api/models/v1_actual_output_meta_diff.py +101 -0
- eval_studio_client/api/models/v1_agent_chat_activity_diagram.py +109 -0
- eval_studio_client/api/models/v1_agent_chat_activity_diagram_edge.py +97 -0
- eval_studio_client/api/models/v1_agent_chat_activity_diagram_node.py +97 -0
- eval_studio_client/api/models/v1_agent_chat_activity_diagram_row.py +97 -0
- eval_studio_client/api/models/v1_agent_chat_script_usage.py +101 -0
- eval_studio_client/api/models/v1_agent_chat_scripts_bar_chart.py +102 -0
- eval_studio_client/api/models/v1_agent_chat_tool_usage.py +101 -0
- eval_studio_client/api/models/v1_agent_chat_tools_bar_chart.py +102 -0
- eval_studio_client/api/models/v1_all_metric_scores.py +87 -0
- eval_studio_client/api/models/v1_append_test_cases_response.py +95 -0
- eval_studio_client/api/models/v1_batch_create_leaderboards_without_cache_request.py +99 -0
- eval_studio_client/api/models/v1_batch_create_leaderboards_without_cache_response.py +91 -0
- eval_studio_client/api/models/v1_batch_mark_operation_seen_by_creator_response.py +95 -0
- eval_studio_client/api/models/v1_cmp_leaderboard_reports_request.py +96 -0
- eval_studio_client/api/models/v1_cmp_leaderboard_reports_response.py +91 -0
- eval_studio_client/api/models/v1_comparison_item.py +130 -0
- eval_studio_client/api/models/v1_comparison_metric_score.py +89 -0
- eval_studio_client/api/models/v1_comparison_result.py +120 -0
- eval_studio_client/api/models/v1_comparison_summary.py +91 -0
- eval_studio_client/api/models/v1_create_evaluation_request.py +5 -2
- eval_studio_client/api/models/v1_create_test_from_test_cases_request.py +93 -0
- eval_studio_client/api/models/v1_create_test_from_test_cases_response.py +91 -0
- eval_studio_client/api/models/v1_dashboard_report.py +109 -0
- eval_studio_client/api/models/v1_dashboard_report_result.py +139 -0
- eval_studio_client/api/models/v1_dashboard_test_case_annotation.py +112 -0
- eval_studio_client/api/models/v1_data_fragment.py +91 -0
- eval_studio_client/api/models/v1_deep_compare_leaderboards_request.py +96 -0
- eval_studio_client/api/models/v1_deep_compare_leaderboards_response.py +91 -0
- eval_studio_client/api/models/v1_diff_item.py +137 -0
- eval_studio_client/api/models/v1_evaluation_type.py +39 -0
- eval_studio_client/api/models/v1_flipped_metric.py +91 -0
- eval_studio_client/api/models/v1_get_dashboard_report_response.py +91 -0
- eval_studio_client/api/models/v1_human_decision.py +38 -0
- eval_studio_client/api/models/v1_info.py +4 -2
- eval_studio_client/api/models/v1_leaderboard.py +5 -2
- eval_studio_client/api/models/v1_leaderboard_cmp_report.py +93 -0
- eval_studio_client/api/models/v1_leaderboard_comparison_item.py +91 -0
- eval_studio_client/api/models/v1_leaderboard_info.py +97 -0
- eval_studio_client/api/models/v1_leaderboard_report_actual_output_meta.py +23 -9
- eval_studio_client/api/models/v1_leaderboard_report_result.py +21 -10
- eval_studio_client/api/models/v1_leaderboard_report_result_view.py +38 -0
- eval_studio_client/api/models/v1_leaderboard_test_case_annotation.py +112 -0
- eval_studio_client/api/models/v1_list_dashboard_test_case_annotations_response.py +95 -0
- eval_studio_client/api/models/v1_list_leaderboard_test_case_annotations_response.py +95 -0
- eval_studio_client/api/models/v1_list_operations_response.py +5 -3
- eval_studio_client/api/models/v1_list_unseen_operations_response.py +97 -0
- eval_studio_client/api/models/v1_mark_operation_seen_by_creator_response.py +91 -0
- eval_studio_client/api/models/v1_metric.py +89 -0
- eval_studio_client/api/models/v1_metric_average.py +101 -0
- eval_studio_client/api/models/v1_metric_meta.py +109 -0
- eval_studio_client/api/models/v1_metric_score.py +6 -1
- eval_studio_client/api/models/v1_metric_scores.py +1 -1
- eval_studio_client/api/models/v1_model_type.py +2 -1
- eval_studio_client/api/models/v1_models_comparisons.py +93 -0
- eval_studio_client/api/models/v1_models_comparisons_metrics.py +103 -0
- eval_studio_client/api/models/v1_models_overview.py +97 -0
- eval_studio_client/api/models/v1_operation.py +6 -2
- eval_studio_client/api/models/v1_operation_view.py +38 -0
- eval_studio_client/api/models/v1_retrieved_context_diff.py +101 -0
- eval_studio_client/api/models/v1_stats.py +16 -2
- eval_studio_client/api/models/v1_technical_metrics.py +96 -0
- eval_studio_client/api/models/v1_technical_metrics_detail.py +95 -0
- eval_studio_client/api/models/v1_test_case_leaderboard_item.py +91 -0
- eval_studio_client/api/models/v1_test_case_relationship_info.py +91 -0
- eval_studio_client/api/models/v1_test_case_result.py +157 -0
- eval_studio_client/api/models/v1_text_similarity_metric.py +39 -0
- eval_studio_client/api/models/v1_update_dashboard_test_case_annotation_response.py +91 -0
- eval_studio_client/api/models/v1_update_leaderboard_test_case_annotation_response.py +91 -0
- eval_studio_client/api/models/v1_workflow_node_type.py +1 -0
- eval_studio_client/api/models/v1_workflow_type.py +1 -0
- eval_studio_client/api/test/test_adversarial_inputs_service_test_adversarial_inputs_robustness_request.py +6 -0
- eval_studio_client/api/test/test_dashboard_report_service_api.py +37 -0
- eval_studio_client/api/test/test_dashboard_test_case_annotation_service_api.py +43 -0
- eval_studio_client/api/test/test_leaderboard_report_service_api.py +6 -0
- eval_studio_client/api/test/test_leaderboard_service_api.py +12 -0
- eval_studio_client/api/test/test_leaderboard_test_case_annotation_service_api.py +43 -0
- eval_studio_client/api/test/test_operation_service_api.py +18 -0
- eval_studio_client/api/test/test_required_the_dashboard_test_case_annotation_to_update.py +57 -0
- eval_studio_client/api/test/test_required_the_leaderboard_test_case_annotation_to_update.py +57 -0
- eval_studio_client/api/test/test_required_the_leaderboard_to_update.py +2 -1
- eval_studio_client/api/test/test_required_the_operation_to_finalize.py +2 -1
- eval_studio_client/api/test/test_required_the_operation_to_update.py +2 -1
- eval_studio_client/api/test/test_test_case_service_api.py +6 -0
- eval_studio_client/api/test/test_test_case_service_append_test_cases_request.py +52 -0
- eval_studio_client/api/test/test_test_service_api.py +6 -0
- eval_studio_client/api/test/test_v1_abort_operation_response.py +2 -1
- eval_studio_client/api/test/test_v1_actual_output_meta.py +61 -0
- eval_studio_client/api/test/test_v1_actual_output_meta_diff.py +66 -0
- eval_studio_client/api/test/test_v1_agent_chat_activity_diagram.py +65 -0
- eval_studio_client/api/test/test_v1_agent_chat_activity_diagram_edge.py +53 -0
- eval_studio_client/api/test/test_v1_agent_chat_activity_diagram_node.py +53 -0
- eval_studio_client/api/test/test_v1_agent_chat_activity_diagram_row.py +56 -0
- eval_studio_client/api/test/test_v1_agent_chat_script_usage.py +54 -0
- eval_studio_client/api/test/test_v1_agent_chat_scripts_bar_chart.py +57 -0
- eval_studio_client/api/test/test_v1_agent_chat_tool_usage.py +54 -0
- eval_studio_client/api/test/test_v1_agent_chat_tools_bar_chart.py +57 -0
- eval_studio_client/api/test/test_v1_all_metric_scores.py +53 -0
- eval_studio_client/api/test/test_v1_append_test_cases_response.py +74 -0
- eval_studio_client/api/test/test_v1_batch_create_leaderboards_request.py +2 -1
- eval_studio_client/api/test/test_v1_batch_create_leaderboards_response.py +2 -1
- eval_studio_client/api/test/test_v1_batch_create_leaderboards_without_cache_request.py +120 -0
- eval_studio_client/api/test/test_v1_batch_create_leaderboards_without_cache_response.py +72 -0
- eval_studio_client/api/test/test_v1_batch_delete_leaderboards_response.py +2 -1
- eval_studio_client/api/test/test_v1_batch_get_leaderboards_response.py +2 -1
- eval_studio_client/api/test/test_v1_batch_get_operations_response.py +2 -1
- eval_studio_client/api/test/test_v1_batch_import_leaderboard_response.py +2 -1
- eval_studio_client/api/test/test_v1_batch_mark_operation_seen_by_creator_response.py +74 -0
- eval_studio_client/api/test/test_v1_cmp_leaderboard_reports_request.py +55 -0
- eval_studio_client/api/test/test_v1_cmp_leaderboard_reports_response.py +255 -0
- eval_studio_client/api/test/test_v1_comparison_item.py +233 -0
- eval_studio_client/api/test/test_v1_comparison_metric_score.py +52 -0
- eval_studio_client/api/test/test_v1_comparison_result.py +258 -0
- eval_studio_client/api/test/test_v1_comparison_summary.py +53 -0
- eval_studio_client/api/test/test_v1_create_evaluation_request.py +2 -1
- eval_studio_client/api/test/test_v1_create_leaderboard_request.py +2 -1
- eval_studio_client/api/test/test_v1_create_leaderboard_response.py +2 -1
- eval_studio_client/api/test/test_v1_create_leaderboard_without_cache_response.py +2 -1
- eval_studio_client/api/test/test_v1_create_test_from_test_cases_request.py +54 -0
- eval_studio_client/api/test/test_v1_create_test_from_test_cases_response.py +68 -0
- eval_studio_client/api/test/test_v1_dashboard_report.py +142 -0
- eval_studio_client/api/test/test_v1_dashboard_report_result.py +72 -0
- eval_studio_client/api/test/test_v1_dashboard_test_case_annotation.py +58 -0
- eval_studio_client/api/test/test_v1_data_fragment.py +57 -0
- eval_studio_client/api/test/test_v1_deep_compare_leaderboards_request.py +55 -0
- eval_studio_client/api/test/test_v1_deep_compare_leaderboards_response.py +255 -0
- eval_studio_client/api/test/test_v1_delete_leaderboard_response.py +2 -1
- eval_studio_client/api/test/test_v1_diff_item.py +226 -0
- eval_studio_client/api/test/test_v1_evaluation_type.py +33 -0
- eval_studio_client/api/test/test_v1_finalize_operation_response.py +2 -1
- eval_studio_client/api/test/test_v1_flipped_metric.py +53 -0
- eval_studio_client/api/test/test_v1_generate_test_cases_response.py +2 -1
- eval_studio_client/api/test/test_v1_get_dashboard_report_response.py +143 -0
- eval_studio_client/api/test/test_v1_get_info_response.py +4 -1
- eval_studio_client/api/test/test_v1_get_leaderboard_report_response.py +39 -2
- eval_studio_client/api/test/test_v1_get_leaderboard_response.py +2 -1
- eval_studio_client/api/test/test_v1_get_operation_response.py +2 -1
- eval_studio_client/api/test/test_v1_get_stats_response.py +3 -1
- eval_studio_client/api/test/test_v1_human_decision.py +33 -0
- eval_studio_client/api/test/test_v1_import_leaderboard_response.py +2 -1
- eval_studio_client/api/test/test_v1_import_test_cases_from_library_response.py +2 -1
- eval_studio_client/api/test/test_v1_info.py +4 -1
- eval_studio_client/api/test/test_v1_leaderboard.py +2 -1
- eval_studio_client/api/test/test_v1_leaderboard_cmp_report.py +254 -0
- eval_studio_client/api/test/test_v1_leaderboard_comparison_item.py +53 -0
- eval_studio_client/api/test/test_v1_leaderboard_info.py +57 -0
- eval_studio_client/api/test/test_v1_leaderboard_report.py +39 -2
- eval_studio_client/api/test/test_v1_leaderboard_report_actual_output_meta.py +33 -1
- eval_studio_client/api/test/test_v1_leaderboard_report_result.py +39 -2
- eval_studio_client/api/test/test_v1_leaderboard_report_result_view.py +33 -0
- eval_studio_client/api/test/test_v1_leaderboard_test_case_annotation.py +58 -0
- eval_studio_client/api/test/test_v1_list_dashboard_test_case_annotations_response.py +61 -0
- eval_studio_client/api/test/test_v1_list_leaderboard_test_case_annotations_response.py +61 -0
- eval_studio_client/api/test/test_v1_list_leaderboards_response.py +2 -1
- eval_studio_client/api/test/test_v1_list_most_recent_leaderboards_response.py +2 -1
- eval_studio_client/api/test/test_v1_list_operations_response.py +4 -2
- eval_studio_client/api/test/test_v1_list_unseen_operations_response.py +75 -0
- eval_studio_client/api/test/test_v1_mark_operation_seen_by_creator_response.py +72 -0
- eval_studio_client/api/test/test_v1_metric.py +52 -0
- eval_studio_client/api/test/test_v1_metric_average.py +58 -0
- eval_studio_client/api/test/test_v1_metric_meta.py +66 -0
- eval_studio_client/api/test/test_v1_models_comparisons.py +54 -0
- eval_studio_client/api/test/test_v1_models_comparisons_metrics.py +65 -0
- eval_studio_client/api/test/test_v1_models_overview.py +60 -0
- eval_studio_client/api/test/test_v1_operation.py +2 -1
- eval_studio_client/api/test/test_v1_operation_view.py +33 -0
- eval_studio_client/api/test/test_v1_process_workflow_node_response.py +2 -1
- eval_studio_client/api/test/test_v1_retrieved_context_diff.py +66 -0
- eval_studio_client/api/test/test_v1_stats.py +3 -1
- eval_studio_client/api/test/test_v1_technical_metrics.py +62 -0
- eval_studio_client/api/test/test_v1_technical_metrics_detail.py +55 -0
- eval_studio_client/api/test/test_v1_test_case_leaderboard_item.py +53 -0
- eval_studio_client/api/test/test_v1_test_case_relationship_info.py +53 -0
- eval_studio_client/api/test/test_v1_test_case_result.py +106 -0
- eval_studio_client/api/test/test_v1_text_similarity_metric.py +33 -0
- eval_studio_client/api/test/test_v1_update_dashboard_test_case_annotation_response.py +59 -0
- eval_studio_client/api/test/test_v1_update_leaderboard_response.py +2 -1
- eval_studio_client/api/test/test_v1_update_leaderboard_test_case_annotation_response.py +59 -0
- eval_studio_client/api/test/test_v1_update_operation_response.py +2 -1
- eval_studio_client/gen/openapiv2/eval_studio.swagger.json +2340 -210
- eval_studio_client/models.py +18 -6
- {eval_studio_client-1.2.5.dist-info → eval_studio_client-1.3.0a1.dist-info}/METADATA +2 -2
- {eval_studio_client-1.2.5.dist-info → eval_studio_client-1.3.0a1.dist-info}/RECORD +306 -111
- {eval_studio_client-1.2.5.dist-info → eval_studio_client-1.3.0a1.dist-info}/WHEEL +0 -0
|
@@ -1639,7 +1639,7 @@ class WorkflowServiceApi:
|
|
|
1639
1639
|
@validate_call
|
|
1640
1640
|
def workflow_service_get_workflow(
|
|
1641
1641
|
self,
|
|
1642
|
-
|
|
1642
|
+
name_13: Annotated[str, Field(strict=True, description="Required. The name of the Workflow to retrieve.")],
|
|
1643
1643
|
_request_timeout: Union[
|
|
1644
1644
|
None,
|
|
1645
1645
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1656,8 +1656,8 @@ class WorkflowServiceApi:
|
|
|
1656
1656
|
"""GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
|
|
1657
1657
|
|
|
1658
1658
|
|
|
1659
|
-
:param
|
|
1660
|
-
:type
|
|
1659
|
+
:param name_13: Required. The name of the Workflow to retrieve. (required)
|
|
1660
|
+
:type name_13: str
|
|
1661
1661
|
:param _request_timeout: timeout setting for this request. If one
|
|
1662
1662
|
number provided, it will be total request
|
|
1663
1663
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1681,7 +1681,7 @@ class WorkflowServiceApi:
|
|
|
1681
1681
|
""" # noqa: E501
|
|
1682
1682
|
|
|
1683
1683
|
_param = self._workflow_service_get_workflow_serialize(
|
|
1684
|
-
|
|
1684
|
+
name_13=name_13,
|
|
1685
1685
|
_request_auth=_request_auth,
|
|
1686
1686
|
_content_type=_content_type,
|
|
1687
1687
|
_headers=_headers,
|
|
@@ -1705,7 +1705,7 @@ class WorkflowServiceApi:
|
|
|
1705
1705
|
@validate_call
|
|
1706
1706
|
def workflow_service_get_workflow_with_http_info(
|
|
1707
1707
|
self,
|
|
1708
|
-
|
|
1708
|
+
name_13: Annotated[str, Field(strict=True, description="Required. The name of the Workflow to retrieve.")],
|
|
1709
1709
|
_request_timeout: Union[
|
|
1710
1710
|
None,
|
|
1711
1711
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1722,8 +1722,8 @@ class WorkflowServiceApi:
|
|
|
1722
1722
|
"""GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
|
|
1723
1723
|
|
|
1724
1724
|
|
|
1725
|
-
:param
|
|
1726
|
-
:type
|
|
1725
|
+
:param name_13: Required. The name of the Workflow to retrieve. (required)
|
|
1726
|
+
:type name_13: str
|
|
1727
1727
|
:param _request_timeout: timeout setting for this request. If one
|
|
1728
1728
|
number provided, it will be total request
|
|
1729
1729
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1747,7 +1747,7 @@ class WorkflowServiceApi:
|
|
|
1747
1747
|
""" # noqa: E501
|
|
1748
1748
|
|
|
1749
1749
|
_param = self._workflow_service_get_workflow_serialize(
|
|
1750
|
-
|
|
1750
|
+
name_13=name_13,
|
|
1751
1751
|
_request_auth=_request_auth,
|
|
1752
1752
|
_content_type=_content_type,
|
|
1753
1753
|
_headers=_headers,
|
|
@@ -1771,7 +1771,7 @@ class WorkflowServiceApi:
|
|
|
1771
1771
|
@validate_call
|
|
1772
1772
|
def workflow_service_get_workflow_without_preload_content(
|
|
1773
1773
|
self,
|
|
1774
|
-
|
|
1774
|
+
name_13: Annotated[str, Field(strict=True, description="Required. The name of the Workflow to retrieve.")],
|
|
1775
1775
|
_request_timeout: Union[
|
|
1776
1776
|
None,
|
|
1777
1777
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1788,8 +1788,8 @@ class WorkflowServiceApi:
|
|
|
1788
1788
|
"""GetWorkflow retrieves a Workflow by name. Deleted Workflow is returned without error, it has a delete_time and deleter fields set.
|
|
1789
1789
|
|
|
1790
1790
|
|
|
1791
|
-
:param
|
|
1792
|
-
:type
|
|
1791
|
+
:param name_13: Required. The name of the Workflow to retrieve. (required)
|
|
1792
|
+
:type name_13: str
|
|
1793
1793
|
:param _request_timeout: timeout setting for this request. If one
|
|
1794
1794
|
number provided, it will be total request
|
|
1795
1795
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1813,7 +1813,7 @@ class WorkflowServiceApi:
|
|
|
1813
1813
|
""" # noqa: E501
|
|
1814
1814
|
|
|
1815
1815
|
_param = self._workflow_service_get_workflow_serialize(
|
|
1816
|
-
|
|
1816
|
+
name_13=name_13,
|
|
1817
1817
|
_request_auth=_request_auth,
|
|
1818
1818
|
_content_type=_content_type,
|
|
1819
1819
|
_headers=_headers,
|
|
@@ -1832,7 +1832,7 @@ class WorkflowServiceApi:
|
|
|
1832
1832
|
|
|
1833
1833
|
def _workflow_service_get_workflow_serialize(
|
|
1834
1834
|
self,
|
|
1835
|
-
|
|
1835
|
+
name_13,
|
|
1836
1836
|
_request_auth,
|
|
1837
1837
|
_content_type,
|
|
1838
1838
|
_headers,
|
|
@@ -1852,8 +1852,8 @@ class WorkflowServiceApi:
|
|
|
1852
1852
|
_body_params: Optional[bytes] = None
|
|
1853
1853
|
|
|
1854
1854
|
# process the path parameters
|
|
1855
|
-
if
|
|
1856
|
-
_path_params['
|
|
1855
|
+
if name_13 is not None:
|
|
1856
|
+
_path_params['name_13'] = name_13
|
|
1857
1857
|
# process the query parameters
|
|
1858
1858
|
# process the header parameters
|
|
1859
1859
|
# process the form parameters
|
|
@@ -1874,7 +1874,7 @@ class WorkflowServiceApi:
|
|
|
1874
1874
|
|
|
1875
1875
|
return self.api_client.param_serialize(
|
|
1876
1876
|
method='GET',
|
|
1877
|
-
resource_path='/v1/{
|
|
1877
|
+
resource_path='/v1/{name_13}',
|
|
1878
1878
|
path_params=_path_params,
|
|
1879
1879
|
query_params=_query_params,
|
|
1880
1880
|
header_params=_header_params,
|
eval_studio_client/api/docs/AdversarialInputsServiceTestAdversarialInputsRobustnessRequest.md
CHANGED
|
@@ -21,7 +21,8 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**model_parameters** | **str** | Optional. Parameters overrides for the Model host in JSON format. | [optional]
|
|
22
22
|
**default_h2ogpte_model** | [**V1Model**](V1Model.md) | | [optional]
|
|
23
23
|
**baseline_eval** | **str** | Required. Baseline evaluation name. | [optional]
|
|
24
|
-
**baseline_metrics** | [**Dict[str, V1MetricScores]**](V1MetricScores.md) | Required. Map of baseline metrics from the evaluator to the metric scores for the evaluator. | [optional]
|
|
24
|
+
**baseline_metrics** | [**Dict[str, V1MetricScores]**](V1MetricScores.md) | Required. Map of baseline metrics from the evaluator to the average metric scores for the evaluator. | [optional]
|
|
25
|
+
**all_baseline_metrics_scores** | [**Dict[str, V1AllMetricScores]**](V1AllMetricScores.md) | Required. Map of baseline metric to all and every test case metric score. | [optional]
|
|
25
26
|
|
|
26
27
|
## Example
|
|
27
28
|
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# eval_studio_client.api.DashboardReportServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**dashboard_report_service_get_dashboard_report**](DashboardReportServiceApi.md#dashboard_report_service_get_dashboard_report) | **GET** /v1/{name} |
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **dashboard_report_service_get_dashboard_report**
|
|
11
|
+
> V1GetDashboardReportResponse dashboard_report_service_get_dashboard_report(name)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
```python
|
|
19
|
+
import eval_studio_client.api
|
|
20
|
+
from eval_studio_client.api.models.v1_get_dashboard_report_response import V1GetDashboardReportResponse
|
|
21
|
+
from eval_studio_client.api.rest import ApiException
|
|
22
|
+
from pprint import pprint
|
|
23
|
+
|
|
24
|
+
# Defining the host is optional and defaults to http://localhost
|
|
25
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
26
|
+
configuration = eval_studio_client.api.Configuration(
|
|
27
|
+
host = "http://localhost"
|
|
28
|
+
)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
# Enter a context with an instance of the API client
|
|
32
|
+
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
33
|
+
# Create an instance of the API class
|
|
34
|
+
api_instance = eval_studio_client.api.DashboardReportServiceApi(api_client)
|
|
35
|
+
name = 'name_example' # str | Required. The name of the Dashboard to retrieve.
|
|
36
|
+
|
|
37
|
+
try:
|
|
38
|
+
api_response = api_instance.dashboard_report_service_get_dashboard_report(name)
|
|
39
|
+
print("The response of DashboardReportServiceApi->dashboard_report_service_get_dashboard_report:\n")
|
|
40
|
+
pprint(api_response)
|
|
41
|
+
except Exception as e:
|
|
42
|
+
print("Exception when calling DashboardReportServiceApi->dashboard_report_service_get_dashboard_report: %s\n" % e)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
Name | Type | Description | Notes
|
|
51
|
+
------------- | ------------- | ------------- | -------------
|
|
52
|
+
**name** | **str**| Required. The name of the Dashboard to retrieve. |
|
|
53
|
+
|
|
54
|
+
### Return type
|
|
55
|
+
|
|
56
|
+
[**V1GetDashboardReportResponse**](V1GetDashboardReportResponse.md)
|
|
57
|
+
|
|
58
|
+
### Authorization
|
|
59
|
+
|
|
60
|
+
No authorization required
|
|
61
|
+
|
|
62
|
+
### HTTP request headers
|
|
63
|
+
|
|
64
|
+
- **Content-Type**: Not defined
|
|
65
|
+
- **Accept**: application/json
|
|
66
|
+
|
|
67
|
+
### HTTP response details
|
|
68
|
+
|
|
69
|
+
| Status code | Description | Response headers |
|
|
70
|
+
|-------------|-------------|------------------|
|
|
71
|
+
**200** | A successful response. | - |
|
|
72
|
+
**0** | An unexpected error response. | - |
|
|
73
|
+
|
|
74
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
75
|
+
|
|
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**dashboard_service_batch_get_dashboards**](DashboardServiceApi.md#dashboard_service_batch_get_dashboards) | **GET** /v1/dashboards:batchGet |
|
|
9
9
|
[**dashboard_service_create_dashboard**](DashboardServiceApi.md#dashboard_service_create_dashboard) | **POST** /v1/dashboards |
|
|
10
10
|
[**dashboard_service_delete_dashboard**](DashboardServiceApi.md#dashboard_service_delete_dashboard) | **DELETE** /v1/{name} |
|
|
11
|
-
[**dashboard_service_get_dashboard**](DashboardServiceApi.md#dashboard_service_get_dashboard) | **GET** /v1/{
|
|
11
|
+
[**dashboard_service_get_dashboard**](DashboardServiceApi.md#dashboard_service_get_dashboard) | **GET** /v1/{name_1} |
|
|
12
12
|
[**dashboard_service_grant_dashboard_access**](DashboardServiceApi.md#dashboard_service_grant_dashboard_access) | **POST** /v1/{name}:grantAccess | GrantDashboardAccess grants access to a Dashboard to a subject with a specified role.
|
|
13
13
|
[**dashboard_service_list_dashboard_access**](DashboardServiceApi.md#dashboard_service_list_dashboard_access) | **GET** /v1/{name}:listAccess | ListDashboardAccess lists access to a Dashboard.
|
|
14
14
|
[**dashboard_service_list_dashboards**](DashboardServiceApi.md#dashboard_service_list_dashboards) | **GET** /v1/dashboards |
|
|
@@ -285,7 +285,7 @@ No authorization required
|
|
|
285
285
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
286
286
|
|
|
287
287
|
# **dashboard_service_get_dashboard**
|
|
288
|
-
> V1GetDashboardResponse dashboard_service_get_dashboard(
|
|
288
|
+
> V1GetDashboardResponse dashboard_service_get_dashboard(name_1)
|
|
289
289
|
|
|
290
290
|
|
|
291
291
|
|
|
@@ -309,10 +309,10 @@ configuration = eval_studio_client.api.Configuration(
|
|
|
309
309
|
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
310
310
|
# Create an instance of the API class
|
|
311
311
|
api_instance = eval_studio_client.api.DashboardServiceApi(api_client)
|
|
312
|
-
|
|
312
|
+
name_1 = 'name_1_example' # str | Required. The name of the Dashboard to retrieve.
|
|
313
313
|
|
|
314
314
|
try:
|
|
315
|
-
api_response = api_instance.dashboard_service_get_dashboard(
|
|
315
|
+
api_response = api_instance.dashboard_service_get_dashboard(name_1)
|
|
316
316
|
print("The response of DashboardServiceApi->dashboard_service_get_dashboard:\n")
|
|
317
317
|
pprint(api_response)
|
|
318
318
|
except Exception as e:
|
|
@@ -326,7 +326,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
|
326
326
|
|
|
327
327
|
Name | Type | Description | Notes
|
|
328
328
|
------------- | ------------- | ------------- | -------------
|
|
329
|
-
**
|
|
329
|
+
**name_1** | **str**| Required. The name of the Dashboard to retrieve. |
|
|
330
330
|
|
|
331
331
|
### Return type
|
|
332
332
|
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
# eval_studio_client.api.DashboardTestCaseAnnotationServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**dashboard_test_case_annotation_service_list_dashboard_test_case_annotations**](DashboardTestCaseAnnotationServiceApi.md#dashboard_test_case_annotation_service_list_dashboard_test_case_annotations) | **GET** /v1/{parent}/annotations |
|
|
8
|
+
[**dashboard_test_case_annotation_service_update_dashboard_test_case_annotation**](DashboardTestCaseAnnotationServiceApi.md#dashboard_test_case_annotation_service_update_dashboard_test_case_annotation) | **POST** /v1/{dashboardTestCaseAnnotation.name} |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# **dashboard_test_case_annotation_service_list_dashboard_test_case_annotations**
|
|
12
|
+
> V1ListDashboardTestCaseAnnotationsResponse dashboard_test_case_annotation_service_list_dashboard_test_case_annotations(parent)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
import eval_studio_client.api
|
|
21
|
+
from eval_studio_client.api.models.v1_list_dashboard_test_case_annotations_response import V1ListDashboardTestCaseAnnotationsResponse
|
|
22
|
+
from eval_studio_client.api.rest import ApiException
|
|
23
|
+
from pprint import pprint
|
|
24
|
+
|
|
25
|
+
# Defining the host is optional and defaults to http://localhost
|
|
26
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
27
|
+
configuration = eval_studio_client.api.Configuration(
|
|
28
|
+
host = "http://localhost"
|
|
29
|
+
)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
# Enter a context with an instance of the API client
|
|
33
|
+
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
34
|
+
# Create an instance of the API class
|
|
35
|
+
api_instance = eval_studio_client.api.DashboardTestCaseAnnotationServiceApi(api_client)
|
|
36
|
+
parent = 'parent_example' # str | Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`. Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-` See https://google.aip.dev/159 for more details on collection identifiers.
|
|
37
|
+
|
|
38
|
+
try:
|
|
39
|
+
api_response = api_instance.dashboard_test_case_annotation_service_list_dashboard_test_case_annotations(parent)
|
|
40
|
+
print("The response of DashboardTestCaseAnnotationServiceApi->dashboard_test_case_annotation_service_list_dashboard_test_case_annotations:\n")
|
|
41
|
+
pprint(api_response)
|
|
42
|
+
except Exception as e:
|
|
43
|
+
print("Exception when calling DashboardTestCaseAnnotationServiceApi->dashboard_test_case_annotation_service_list_dashboard_test_case_annotations: %s\n" % e)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
Name | Type | Description | Notes
|
|
52
|
+
------------- | ------------- | ------------- | -------------
|
|
53
|
+
**parent** | **str**| Required. The parent resource name. Format: `dashboards/{dashboard}/testCases/{test_case}`. Wildcard support: Use the special value `-` for test_case to list annotations across all test cases within the specified dashboard: `dashboards/{dashboard}/testCases/-` See https://google.aip.dev/159 for more details on collection identifiers. |
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**V1ListDashboardTestCaseAnnotationsResponse**](V1ListDashboardTestCaseAnnotationsResponse.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
No authorization required
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
### HTTP response details
|
|
69
|
+
|
|
70
|
+
| Status code | Description | Response headers |
|
|
71
|
+
|-------------|-------------|------------------|
|
|
72
|
+
**200** | A successful response. | - |
|
|
73
|
+
**0** | An unexpected error response. | - |
|
|
74
|
+
|
|
75
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
76
|
+
|
|
77
|
+
# **dashboard_test_case_annotation_service_update_dashboard_test_case_annotation**
|
|
78
|
+
> V1UpdateDashboardTestCaseAnnotationResponse dashboard_test_case_annotation_service_update_dashboard_test_case_annotation(dashboard_test_case_annotation_name, dashboard_test_case_annotation, update_mask=update_mask, allow_missing=allow_missing)
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
```python
|
|
86
|
+
import eval_studio_client.api
|
|
87
|
+
from eval_studio_client.api.models.required_the_dashboard_test_case_annotation_to_update import RequiredTheDashboardTestCaseAnnotationToUpdate
|
|
88
|
+
from eval_studio_client.api.models.v1_update_dashboard_test_case_annotation_response import V1UpdateDashboardTestCaseAnnotationResponse
|
|
89
|
+
from eval_studio_client.api.rest import ApiException
|
|
90
|
+
from pprint import pprint
|
|
91
|
+
|
|
92
|
+
# Defining the host is optional and defaults to http://localhost
|
|
93
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
94
|
+
configuration = eval_studio_client.api.Configuration(
|
|
95
|
+
host = "http://localhost"
|
|
96
|
+
)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
# Enter a context with an instance of the API client
|
|
100
|
+
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
101
|
+
# Create an instance of the API class
|
|
102
|
+
api_instance = eval_studio_client.api.DashboardTestCaseAnnotationServiceApi(api_client)
|
|
103
|
+
dashboard_test_case_annotation_name = 'dashboard_test_case_annotation_name_example' # str | Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\"
|
|
104
|
+
dashboard_test_case_annotation = eval_studio_client.api.RequiredTheDashboardTestCaseAnnotationToUpdate() # RequiredTheDashboardTestCaseAnnotationToUpdate | Required. The DashboardTestCaseAnnotation to update.
|
|
105
|
+
update_mask = 'update_mask_example' # str | Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated: - value (optional)
|
|
106
|
+
allow_missing = True # bool | Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found. (optional)
|
|
107
|
+
|
|
108
|
+
try:
|
|
109
|
+
api_response = api_instance.dashboard_test_case_annotation_service_update_dashboard_test_case_annotation(dashboard_test_case_annotation_name, dashboard_test_case_annotation, update_mask=update_mask, allow_missing=allow_missing)
|
|
110
|
+
print("The response of DashboardTestCaseAnnotationServiceApi->dashboard_test_case_annotation_service_update_dashboard_test_case_annotation:\n")
|
|
111
|
+
pprint(api_response)
|
|
112
|
+
except Exception as e:
|
|
113
|
+
print("Exception when calling DashboardTestCaseAnnotationServiceApi->dashboard_test_case_annotation_service_update_dashboard_test_case_annotation: %s\n" % e)
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Parameters
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
Name | Type | Description | Notes
|
|
122
|
+
------------- | ------------- | ------------- | -------------
|
|
123
|
+
**dashboard_test_case_annotation_name** | **str**| Output only. Name of the DashboardTestCaseAnnotation resource. e.g.: \"dashboards/<UUID>/testCases/<UUID>/annotations/<UUID>\" |
|
|
124
|
+
**dashboard_test_case_annotation** | [**RequiredTheDashboardTestCaseAnnotationToUpdate**](RequiredTheDashboardTestCaseAnnotationToUpdate.md)| Required. The DashboardTestCaseAnnotation to update. |
|
|
125
|
+
**update_mask** | **str**| Optional. The list of fields to update. If empty, all modifiable fields will be updated. The following fields can be updated: - value | [optional]
|
|
126
|
+
**allow_missing** | **bool**| Optional. If true, the request is allowed to create a new DashboardTestCaseAnnotation if it is not found. | [optional]
|
|
127
|
+
|
|
128
|
+
### Return type
|
|
129
|
+
|
|
130
|
+
[**V1UpdateDashboardTestCaseAnnotationResponse**](V1UpdateDashboardTestCaseAnnotationResponse.md)
|
|
131
|
+
|
|
132
|
+
### Authorization
|
|
133
|
+
|
|
134
|
+
No authorization required
|
|
135
|
+
|
|
136
|
+
### HTTP request headers
|
|
137
|
+
|
|
138
|
+
- **Content-Type**: application/json
|
|
139
|
+
- **Accept**: application/json
|
|
140
|
+
|
|
141
|
+
### HTTP response details
|
|
142
|
+
|
|
143
|
+
| Status code | Description | Response headers |
|
|
144
|
+
|-------------|-------------|------------------|
|
|
145
|
+
**200** | A successful response. | - |
|
|
146
|
+
**0** | An unexpected error response. | - |
|
|
147
|
+
|
|
148
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
149
|
+
|
|
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**document_service_batch_get_documents**](DocumentServiceApi.md#document_service_batch_get_documents) | **GET** /v1/documents:batchGet |
|
|
9
9
|
[**document_service_create_document**](DocumentServiceApi.md#document_service_create_document) | **POST** /v1/documents |
|
|
10
10
|
[**document_service_delete_document**](DocumentServiceApi.md#document_service_delete_document) | **DELETE** /v1/{name_1} |
|
|
11
|
-
[**document_service_get_document**](DocumentServiceApi.md#document_service_get_document) | **GET** /v1/{
|
|
11
|
+
[**document_service_get_document**](DocumentServiceApi.md#document_service_get_document) | **GET** /v1/{name_2} |
|
|
12
12
|
[**document_service_list_documents**](DocumentServiceApi.md#document_service_list_documents) | **GET** /v1/documents |
|
|
13
13
|
[**document_service_update_document**](DocumentServiceApi.md#document_service_update_document) | **PATCH** /v1/{document.name} |
|
|
14
14
|
|
|
@@ -280,7 +280,7 @@ No authorization required
|
|
|
280
280
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
281
281
|
|
|
282
282
|
# **document_service_get_document**
|
|
283
|
-
> V1GetDocumentResponse document_service_get_document(
|
|
283
|
+
> V1GetDocumentResponse document_service_get_document(name_2)
|
|
284
284
|
|
|
285
285
|
|
|
286
286
|
|
|
@@ -304,10 +304,10 @@ configuration = eval_studio_client.api.Configuration(
|
|
|
304
304
|
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
305
305
|
# Create an instance of the API class
|
|
306
306
|
api_instance = eval_studio_client.api.DocumentServiceApi(api_client)
|
|
307
|
-
|
|
307
|
+
name_2 = 'name_2_example' # str | Required. The name of the Document to retrieve.
|
|
308
308
|
|
|
309
309
|
try:
|
|
310
|
-
api_response = api_instance.document_service_get_document(
|
|
310
|
+
api_response = api_instance.document_service_get_document(name_2)
|
|
311
311
|
print("The response of DocumentServiceApi->document_service_get_document:\n")
|
|
312
312
|
pprint(api_response)
|
|
313
313
|
except Exception as e:
|
|
@@ -321,7 +321,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
|
321
321
|
|
|
322
322
|
Name | Type | Description | Notes
|
|
323
323
|
------------- | ------------- | ------------- | -------------
|
|
324
|
-
**
|
|
324
|
+
**name_2** | **str**| Required. The name of the Document to retrieve. |
|
|
325
325
|
|
|
326
326
|
### Return type
|
|
327
327
|
|
|
@@ -180,7 +180,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
|
180
180
|
model_description = 'model_description_example' # str | Optional. Arbitrary description of the Model. (optional)
|
|
181
181
|
model_url = 'model_url_example' # str | Optional. Immutable. Absolute URL to the Model. (optional)
|
|
182
182
|
model_api_key = 'model_api_key_example' # str | Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. (optional)
|
|
183
|
-
model_type = 'MODEL_TYPE_UNSPECIFIED' # str | Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. (optional) (default to 'MODEL_TYPE_UNSPECIFIED')
|
|
183
|
+
model_type = 'MODEL_TYPE_UNSPECIFIED' # str | Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. - MODEL_TYPE_ANTHROPIC_CLAUDE: Anthropic Claude chat. (optional) (default to 'MODEL_TYPE_UNSPECIFIED')
|
|
184
184
|
model_parameters = 'model_parameters_example' # str | Optional. Model specific parameters in JSON format. (optional)
|
|
185
185
|
model_demo = True # bool | Output only. Whether the Model is a demo resource or not. Demo resources are read only. (optional)
|
|
186
186
|
retries = 56 # int | Optional. The number of retries to attempt when querying the model for available LLM models. Defaults to 5. (optional)
|
|
@@ -211,7 +211,7 @@ Name | Type | Description | Notes
|
|
|
211
211
|
**model_description** | **str**| Optional. Arbitrary description of the Model. | [optional]
|
|
212
212
|
**model_url** | **str**| Optional. Immutable. Absolute URL to the Model. | [optional]
|
|
213
213
|
**model_api_key** | **str**| Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. | [optional]
|
|
214
|
-
**model_type** | **str**| Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. | [optional] [default to 'MODEL_TYPE_UNSPECIFIED']
|
|
214
|
+
**model_type** | **str**| Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. - MODEL_TYPE_ANTHROPIC_CLAUDE: Anthropic Claude chat. | [optional] [default to 'MODEL_TYPE_UNSPECIFIED']
|
|
215
215
|
**model_parameters** | **str**| Optional. Model specific parameters in JSON format. | [optional]
|
|
216
216
|
**model_demo** | **bool**| Output only. Whether the Model is a demo resource or not. Demo resources are read only. | [optional]
|
|
217
217
|
**retries** | **int**| Optional. The number of retries to attempt when querying the model for available LLM models. Defaults to 5. | [optional]
|
|
@@ -274,7 +274,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
|
274
274
|
model_description = 'model_description_example' # str | Optional. Arbitrary description of the Model. (optional)
|
|
275
275
|
model_url = 'model_url_example' # str | Optional. Immutable. Absolute URL to the Model. (optional)
|
|
276
276
|
model_api_key = 'model_api_key_example' # str | Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. (optional)
|
|
277
|
-
model_type = 'MODEL_TYPE_UNSPECIFIED' # str | Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. (optional) (default to 'MODEL_TYPE_UNSPECIFIED')
|
|
277
|
+
model_type = 'MODEL_TYPE_UNSPECIFIED' # str | Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. - MODEL_TYPE_ANTHROPIC_CLAUDE: Anthropic Claude chat. (optional) (default to 'MODEL_TYPE_UNSPECIFIED')
|
|
278
278
|
model_parameters = 'model_parameters_example' # str | Optional. Model specific parameters in JSON format. (optional)
|
|
279
279
|
model_demo = True # bool | Output only. Whether the Model is a demo resource or not. Demo resources are read only. (optional)
|
|
280
280
|
|
|
@@ -304,7 +304,7 @@ Name | Type | Description | Notes
|
|
|
304
304
|
**model_description** | **str**| Optional. Arbitrary description of the Model. | [optional]
|
|
305
305
|
**model_url** | **str**| Optional. Immutable. Absolute URL to the Model. | [optional]
|
|
306
306
|
**model_api_key** | **str**| Optional. API key used to access the Model. Not set for read calls (i.e. get, list) by public clients (front-end). Set only for internal (server-to-worker) communication. | [optional]
|
|
307
|
-
**model_type** | **str**| Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. | [optional] [default to 'MODEL_TYPE_UNSPECIFIED']
|
|
307
|
+
**model_type** | **str**| Immutable. Type of this Model. - MODEL_TYPE_UNSPECIFIED: Unspecified type. - MODEL_TYPE_H2OGPTE_RAG: h2oGPTe RAG. - MODEL_TYPE_OPENAI_RAG: OpenAI Assistant RAG. - MODEL_TYPE_H2OGPTE_LLM: h2oGPTe LLM. - MODEL_TYPE_H2OGPT_LLM: h2oGPT LLM. - MODEL_TYPE_OPENAI_CHAT: OpenAI chat. - MODEL_TYPE_AZURE_OPENAI_CHAT: Microsoft Azure hosted OpenAI Chat. - MODEL_TYPE_OPENAI_API_CHAT: OpenAI API chat. - MODEL_TYPE_H2OLLMOPS: H2O LLMOps. - MODEL_TYPE_OLLAMA: Ollama. - MODEL_TYPE_AMAZON_BEDROCK: Amazon Bedrock. - MODEL_TYPE_ANTHROPIC_CLAUDE: Anthropic Claude chat. | [optional] [default to 'MODEL_TYPE_UNSPECIFIED']
|
|
308
308
|
**model_parameters** | **str**| Optional. Model specific parameters in JSON format. | [optional]
|
|
309
309
|
**model_demo** | **bool**| Output only. Whether the Model is a demo resource or not. Demo resources are read only. | [optional]
|
|
310
310
|
|
|
@@ -7,7 +7,7 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**evaluator_service_batch_delete_evaluators**](EvaluatorServiceApi.md#evaluator_service_batch_delete_evaluators) | **POST** /v1/evaluators:batchDelete |
|
|
8
8
|
[**evaluator_service_create_evaluator**](EvaluatorServiceApi.md#evaluator_service_create_evaluator) | **POST** /v1/evaluators |
|
|
9
9
|
[**evaluator_service_delete_evaluator**](EvaluatorServiceApi.md#evaluator_service_delete_evaluator) | **DELETE** /v1/{name_2} |
|
|
10
|
-
[**evaluator_service_get_evaluator**](EvaluatorServiceApi.md#evaluator_service_get_evaluator) | **GET** /v1/{
|
|
10
|
+
[**evaluator_service_get_evaluator**](EvaluatorServiceApi.md#evaluator_service_get_evaluator) | **GET** /v1/{name_3} |
|
|
11
11
|
[**evaluator_service_list_evaluators**](EvaluatorServiceApi.md#evaluator_service_list_evaluators) | **GET** /v1/evaluators |
|
|
12
12
|
|
|
13
13
|
|
|
@@ -212,7 +212,7 @@ No authorization required
|
|
|
212
212
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
213
213
|
|
|
214
214
|
# **evaluator_service_get_evaluator**
|
|
215
|
-
> V1GetEvaluatorResponse evaluator_service_get_evaluator(
|
|
215
|
+
> V1GetEvaluatorResponse evaluator_service_get_evaluator(name_3)
|
|
216
216
|
|
|
217
217
|
|
|
218
218
|
|
|
@@ -236,10 +236,10 @@ configuration = eval_studio_client.api.Configuration(
|
|
|
236
236
|
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
237
237
|
# Create an instance of the API class
|
|
238
238
|
api_instance = eval_studio_client.api.EvaluatorServiceApi(api_client)
|
|
239
|
-
|
|
239
|
+
name_3 = 'name_3_example' # str | Required. The name of the Evaluator to retrieve.
|
|
240
240
|
|
|
241
241
|
try:
|
|
242
|
-
api_response = api_instance.evaluator_service_get_evaluator(
|
|
242
|
+
api_response = api_instance.evaluator_service_get_evaluator(name_3)
|
|
243
243
|
print("The response of EvaluatorServiceApi->evaluator_service_get_evaluator:\n")
|
|
244
244
|
pprint(api_response)
|
|
245
245
|
except Exception as e:
|
|
@@ -253,7 +253,7 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
|
253
253
|
|
|
254
254
|
Name | Type | Description | Notes
|
|
255
255
|
------------- | ------------- | ------------- | -------------
|
|
256
|
-
**
|
|
256
|
+
**name_3** | **str**| Required. The name of the Evaluator to retrieve. |
|
|
257
257
|
|
|
258
258
|
### Return type
|
|
259
259
|
|
|
@@ -4,11 +4,79 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
7
|
+
[**leaderboard_report_service_cmp_leaderboard_reports**](LeaderboardReportServiceApi.md#leaderboard_report_service_cmp_leaderboard_reports) | **POST** /v1/leaderboardReports:compare |
|
|
8
|
+
[**leaderboard_report_service_get_leaderboard_report**](LeaderboardReportServiceApi.md#leaderboard_report_service_get_leaderboard_report) | **GET** /v1/{name_4} |
|
|
8
9
|
|
|
9
10
|
|
|
11
|
+
# **leaderboard_report_service_cmp_leaderboard_reports**
|
|
12
|
+
> V1CmpLeaderboardReportsResponse leaderboard_report_service_cmp_leaderboard_reports(body)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
```python
|
|
20
|
+
import eval_studio_client.api
|
|
21
|
+
from eval_studio_client.api.models.v1_cmp_leaderboard_reports_request import V1CmpLeaderboardReportsRequest
|
|
22
|
+
from eval_studio_client.api.models.v1_cmp_leaderboard_reports_response import V1CmpLeaderboardReportsResponse
|
|
23
|
+
from eval_studio_client.api.rest import ApiException
|
|
24
|
+
from pprint import pprint
|
|
25
|
+
|
|
26
|
+
# Defining the host is optional and defaults to http://localhost
|
|
27
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
28
|
+
configuration = eval_studio_client.api.Configuration(
|
|
29
|
+
host = "http://localhost"
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
# Enter a context with an instance of the API client
|
|
34
|
+
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
35
|
+
# Create an instance of the API class
|
|
36
|
+
api_instance = eval_studio_client.api.LeaderboardReportServiceApi(api_client)
|
|
37
|
+
body = eval_studio_client.api.V1CmpLeaderboardReportsRequest() # V1CmpLeaderboardReportsRequest |
|
|
38
|
+
|
|
39
|
+
try:
|
|
40
|
+
api_response = api_instance.leaderboard_report_service_cmp_leaderboard_reports(body)
|
|
41
|
+
print("The response of LeaderboardReportServiceApi->leaderboard_report_service_cmp_leaderboard_reports:\n")
|
|
42
|
+
pprint(api_response)
|
|
43
|
+
except Exception as e:
|
|
44
|
+
print("Exception when calling LeaderboardReportServiceApi->leaderboard_report_service_cmp_leaderboard_reports: %s\n" % e)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Parameters
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
Name | Type | Description | Notes
|
|
53
|
+
------------- | ------------- | ------------- | -------------
|
|
54
|
+
**body** | [**V1CmpLeaderboardReportsRequest**](V1CmpLeaderboardReportsRequest.md)| |
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
[**V1CmpLeaderboardReportsResponse**](V1CmpLeaderboardReportsResponse.md)
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
No authorization required
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: application/json
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
### HTTP response details
|
|
70
|
+
|
|
71
|
+
| Status code | Description | Response headers |
|
|
72
|
+
|-------------|-------------|------------------|
|
|
73
|
+
**200** | A successful response. | - |
|
|
74
|
+
**0** | An unexpected error response. | - |
|
|
75
|
+
|
|
76
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
77
|
+
|
|
10
78
|
# **leaderboard_report_service_get_leaderboard_report**
|
|
11
|
-
> V1GetLeaderboardReportResponse leaderboard_report_service_get_leaderboard_report(
|
|
79
|
+
> V1GetLeaderboardReportResponse leaderboard_report_service_get_leaderboard_report(name_4, view=view)
|
|
12
80
|
|
|
13
81
|
|
|
14
82
|
|
|
@@ -32,10 +100,11 @@ configuration = eval_studio_client.api.Configuration(
|
|
|
32
100
|
with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
33
101
|
# Create an instance of the API class
|
|
34
102
|
api_instance = eval_studio_client.api.LeaderboardReportServiceApi(api_client)
|
|
35
|
-
|
|
103
|
+
name_4 = 'name_4_example' # str | Required. The name of the Leaderboard to retrieve.
|
|
104
|
+
view = 'LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED' # str | Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL. - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields. - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated. - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields. (optional) (default to 'LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED')
|
|
36
105
|
|
|
37
106
|
try:
|
|
38
|
-
api_response = api_instance.leaderboard_report_service_get_leaderboard_report(
|
|
107
|
+
api_response = api_instance.leaderboard_report_service_get_leaderboard_report(name_4, view=view)
|
|
39
108
|
print("The response of LeaderboardReportServiceApi->leaderboard_report_service_get_leaderboard_report:\n")
|
|
40
109
|
pprint(api_response)
|
|
41
110
|
except Exception as e:
|
|
@@ -49,7 +118,8 @@ with eval_studio_client.api.ApiClient(configuration) as api_client:
|
|
|
49
118
|
|
|
50
119
|
Name | Type | Description | Notes
|
|
51
120
|
------------- | ------------- | ------------- | -------------
|
|
52
|
-
**
|
|
121
|
+
**name_4** | **str**| Required. The name of the Leaderboard to retrieve. |
|
|
122
|
+
**view** | **str**| Optional. The view of the leaderboard report results to return. Defaults to LEADERBOARD_REPORT_RESULT_VIEW_FULL. - LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED: Default value. The basic view with essential fields. - LEADERBOARD_REPORT_RESULT_VIEW_FULL: Full view with all fields populated. - LEADERBOARD_REPORT_RESULT_VIEW_SUMMARY: Summary view with only key fields. | [optional] [default to 'LEADERBOARD_REPORT_RESULT_VIEW_UNSPECIFIED']
|
|
53
123
|
|
|
54
124
|
### Return type
|
|
55
125
|
|