|
| 1 | +# revengai.ConfidenceApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.reveng.ai* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_analysis_tag_score**](ConfidenceApi.md#get_analysis_tag_score) | **POST** /v2/confidence/analysis/{analysis_id}/tag_score | Calculate Tag Confidence Score for an Analysis |
| 8 | + |
| 9 | + |
| 10 | +# **get_analysis_tag_score** |
| 11 | +> BaseResponseListTagOriginBoxPlotConfidence get_analysis_tag_score(analysis_id, tag_confidence_body) |
| 12 | +
|
| 13 | +Calculate Tag Confidence Score for an Analysis |
| 14 | + |
| 15 | +Accepts a analysis ID and a list of tags, returns the confidence score for each tag in the list |
| 16 | + |
| 17 | +### Example |
| 18 | + |
| 19 | +* Api Key Authentication (APIKey): |
| 20 | + |
| 21 | +```python |
| 22 | +import revengai |
| 23 | +from revengai.models.base_response_list_tag_origin_box_plot_confidence import BaseResponseListTagOriginBoxPlotConfidence |
| 24 | +from revengai.models.tag_confidence_body import TagConfidenceBody |
| 25 | +from revengai.rest import ApiException |
| 26 | +from pprint import pprint |
| 27 | + |
| 28 | +# Defining the host is optional and defaults to https://api.reveng.ai |
| 29 | +# See configuration.py for a list of all supported configuration parameters. |
| 30 | +configuration = revengai.Configuration( |
| 31 | + host = "https://api.reveng.ai" |
| 32 | +) |
| 33 | + |
| 34 | +# The client must configure the authentication and authorization parameters |
| 35 | +# in accordance with the API server security policy. |
| 36 | +# Examples for each auth method are provided below, use the example that |
| 37 | +# satisfies your auth use case. |
| 38 | + |
| 39 | +# Configure API key authorization: APIKey |
| 40 | +configuration.api_key['APIKey'] = os.environ["API_KEY"] |
| 41 | + |
| 42 | +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 43 | +# configuration.api_key_prefix['APIKey'] = 'Bearer' |
| 44 | + |
| 45 | +# Enter a context with an instance of the API client |
| 46 | +with revengai.ApiClient(configuration) as api_client: |
| 47 | + # Create an instance of the API class |
| 48 | + api_instance = revengai.ConfidenceApi(api_client) |
| 49 | + analysis_id = 56 # int | The analysis to calculate the tag scores for |
| 50 | + tag_confidence_body = revengai.TagConfidenceBody() # TagConfidenceBody | |
| 51 | + |
| 52 | + try: |
| 53 | + # Calculate Tag Confidence Score for an Analysis |
| 54 | + api_response = api_instance.get_analysis_tag_score(analysis_id, tag_confidence_body) |
| 55 | + print("The response of ConfidenceApi->get_analysis_tag_score:\n") |
| 56 | + pprint(api_response) |
| 57 | + except Exception as e: |
| 58 | + print("Exception when calling ConfidenceApi->get_analysis_tag_score: %s\n" % e) |
| 59 | +``` |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | +### Parameters |
| 64 | + |
| 65 | + |
| 66 | +Name | Type | Description | Notes |
| 67 | +------------- | ------------- | ------------- | ------------- |
| 68 | + **analysis_id** | **int**| The analysis to calculate the tag scores for | |
| 69 | + **tag_confidence_body** | [**TagConfidenceBody**](TagConfidenceBody.md)| | |
| 70 | + |
| 71 | +### Return type |
| 72 | + |
| 73 | +[**BaseResponseListTagOriginBoxPlotConfidence**](BaseResponseListTagOriginBoxPlotConfidence.md) |
| 74 | + |
| 75 | +### Authorization |
| 76 | + |
| 77 | +[APIKey](../README.md#APIKey) |
| 78 | + |
| 79 | +### HTTP request headers |
| 80 | + |
| 81 | + - **Content-Type**: application/json |
| 82 | + - **Accept**: application/json |
| 83 | + |
| 84 | +### HTTP response details |
| 85 | + |
| 86 | +| Status code | Description | Response headers | |
| 87 | +|-------------|-------------|------------------| |
| 88 | +**200** | Successful Response | - | |
| 89 | +**422** | Invalid request parameters | - | |
| 90 | + |
| 91 | +[[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) |
| 92 | + |
0 commit comments