-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathapi_error_codes.html
More file actions
179 lines (177 loc) · 17.2 KB
/
Copy pathapi_error_codes.html
File metadata and controls
179 lines (177 loc) · 17.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Reinforcement Learning: API Error Codes</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Reinforcement Learning
 <span id="projectnumber">1.1</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('api_error_codes.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">API Error Codes </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>All RL Inference API functions return error codes.</p>
<p>Following is the list of all error defintions: </p><div class="fragment"><div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(1, invalid_argument, <span class="stringliteral">"Invalid Argument: "</span>)</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(2, background_queue_overflow, "Background queue overflow. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(3, eventhub_http_generic, "http error while connecting to event hub. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(4, http_bad_status_code, "http request returned a bad status code")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(5, action_not_found, "No actions found in action collection")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(6, background_thread_start, "Unable to start background thread. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(7, not_initialized, "")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(8, eventhub_generate_SAS_hash, "")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(9, create_fn_exception, "Create function failed.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(10, type_not_registered, "Type not registered with class factory")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(11, http_uri_not_provided, "URL parameter was not passed in via configuration")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(12, last_modified_not_found, "Last-Modified http header not found in response")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(13, last_modified_invalid, "Unable to parse Last-Modified http header as date-time")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(14, bad_content_length, "Content-Length header not set or set to zero")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(15, exception_during_http_req, "http request exception. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(</div>
<div class="line"> 16, model_export_frequency_not_provided, "Export frequency of model not specified in configuration.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(17, bad_time_interval, "Bad time interval <span class="keywordtype">string</span>. Format should be hh:mm:ss")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(18, data_callback_exception, "Background data callback threw an exception. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(19, data_callback_not_set, "Data callback handler not set")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(20, json_no_actions_found, "Context json did not have actions (_multi array empty or not found)")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(21, json_parse_error, "Unable to parse JSON. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(22, exploration_error, "Exploration error code: ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(23, action_out_of_bounds, "Action <span class="keywordtype">id</span> out of bounds.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(24, model_update_error, "Error updating model: ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(25, model_rank_error, "Error while ranking actions using model: ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(26, pdf_sampling_error, "")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(27, eh_connstr_parse_error, "Unable to parse event hub connection <span class="keywordtype">string</span>.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(28, unhandled_background_error_occurred,</div>
<div class="line"> "A background thread encountered an error but there was no error handler registered. Register an error handler to "</div>
<div class="line"> "see the error code and message.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(29, thread_unresponsive_timeout, "A background thread exceeded the watchdog timer.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(</div>
<div class="line"> 30, incorrect_buffer_preamble_size, "Buffer preamble is pre-allocated and does not match the size requested.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(31, serialize_unknown_outcome_type, "Unable to serialize unknown outcome type.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(32, preamble_error, "Unable to read or write the preamble.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(33, file_open_error, "Unable to open file.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(34, json_no_slots_found, "Context json did not have slots (_slots array empty or not found)")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(35, file_read_error, "Unable to read from file.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(36, file_stats_error, "Unable to read file statistics e.g. modified date time.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(37, not_supported, "Not supported")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(38, protocol_not_supported, "Protocol version is not supported")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(39, external_error, "Opaque error in external code. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(40, unsupported_learning_mode, "Unsupported learning mode")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(41, http_client_init_error, "Cannot initialize http client")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(42, content_encoding_error, "Content encoding should be set to IDENTITY")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(43, compression_error, "Compression error")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(44, slot_index_out_of_bounds_error, "Slot index out of bounds")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(45, bad_context_size, "Input context is not the right size. ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(46, inference_configuration_error, "Unable to configure model inference: ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(47, serialize_error, "Unknown error while serializing.")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(48, extension_error, "Error from extension: ")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(49, baseline_actions_not_defined, "Baseline Actions must be defined in apprentice mode")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(50, http_api_key_not_provided, "Http api key must be provided")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(51, http_model_uri_not_provided, "Model Blob URI parameter was not passed in via configuration")</div>
<div class="line"><a class="code" href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a>(52, static_model_load_error, "Static model passed in C<span class="preprocessor"># layer is not loading properly")</span></div>
<div class="line"><span class="preprocessor">ERROR_CODE_DEFINITION(53, http_oauth_authentication_error, "</span>http request failed to authenticate")</div>
<div class="line">ERROR_CODE_DEFINITION(</div>
<div class="line"> 54, http_oauth_unexpected_error, "http request failed with an unexpected error while retrieving a token")</div>
<div class="ttc" id="aerr__constants_8h_html_a7ee931acdd46e901d29cd566edf03b48"><div class="ttname"><a href="err__constants_8h.html#a7ee931acdd46e901d29cd566edf03b48">ERROR_CODE_DEFINITION</a></div><div class="ttdeci">#define ERROR_CODE_DEFINITION(code, name, message)</div><div class="ttdoc">[Error Generator]</div><div class="ttdef"><b>Definition:</b> err_constants.h:11</div></div>
</div><!-- fragment --><p> Where each error defintion is surfaced in C++ by the follwing: </p><div class="fragment"><div class="line"><span class="preprocessor">#define ERROR_CODE_DEFINITION(code, name, message) \</span></div>
<div class="line"><span class="preprocessor"> namespace reinforcement_learning \</span></div>
<div class="line"><span class="preprocessor"> { \</span></div>
<div class="line"><span class="preprocessor"> namespace error_code \</span></div>
<div class="line"><span class="preprocessor"> { \</span></div>
<div class="line"><span class="preprocessor"> const int name = code; \</span></div>
<div class="line"><span class="preprocessor"> char const* const name##_s = message; \</span></div>
<div class="line"><span class="preprocessor"> } \</span></div>
<div class="line"><span class="preprocessor"> }</span></div>
</div><!-- fragment --></div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>