Debian Codegraph @

docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="discoveryengine_v1.html">Discovery Engine API</a> . <a href="discoveryengine_v1.projects.html">projects</a> . <a href="discoveryengine_v1.projects.locations.html">locations</a> . <a href="discoveryengine_v1.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.html">dataStores</a> . <a href="discoveryengine_v1.projects.locations.collections.dataStores.customModels.html">customModels</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#list">list(dataStore, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets a list of all the custom models.</p>
83 <h3>Method Details</h3>
84 <div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87 </div>
88
89 <div class="method">
90 <code class="details" id="list">list(dataStore, x__xgafv=None)</code>
91 <pre>Gets a list of all the custom models.
92
93 Args:
94 dataStore: string, Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. (required)
95 x__xgafv: string, V1 error format.
96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
99
100 Returns:
101 An object of the form:
102
103 { # Response message for SearchTuningService.ListCustomModels method.
104 &quot;models&quot;: [ # List of custom tuning models.
105 { # Metadata that describes a custom tuned model.
106 &quot;createTime&quot;: &quot;A String&quot;, # Deprecated: Timestamp the Model was created at.
107 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the model.
108 &quot;errorMessage&quot;: &quot;A String&quot;, # Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
109 &quot;metrics&quot;: { # The metrics of the trained model.
110 &quot;a_key&quot;: 3.14,
111 },
112 &quot;modelState&quot;: &quot;A String&quot;, # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
113 &quot;modelVersion&quot;: &quot;A String&quot;, # The version of the model.
114 &quot;name&quot;: &quot;A String&quot;, # Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.
115 &quot;trainingStartTime&quot;: &quot;A String&quot;, # Timestamp the model training was initiated.
116 },
117 ],
118 }</pre>
119 </div>
120
121 </body></html>