Debian Codegraph @

docs/dyn/aiplatform_v1beta1.projects.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="aiplatform_v1beta1.html">Agent Platform API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="aiplatform_v1beta1.projects.locations.html">locations()</a></code>
79 </p>
80 <p class="firstline">Returns the locations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="aiplatform_v1beta1.projects.modelGardenEula.html">modelGardenEula()</a></code>
84 </p>
85 <p class="firstline">Returns the modelGardenEula Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="aiplatform_v1beta1.projects.publishers.html">publishers()</a></code>
89 </p>
90 <p class="firstline">Returns the publishers Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94 <p class="firstline">Close httplib2 connections.</p>
95 <p class="toc_element">
96 <code><a href="#fetchPublisherModelConfig">fetchPublisherModelConfig(name, x__xgafv=None)</a></code></p>
97 <p class="firstline">Fetches the configs of publisher models.</p>
98 <p class="toc_element">
99 <code><a href="#getCacheConfig">getCacheConfig(name, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets a GenAI cache config.</p>
101 <p class="toc_element">
102 <code><a href="#setPublisherModelConfig">setPublisherModelConfig(name, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.</p>
104 <p class="toc_element">
105 <code><a href="#updateCacheConfig">updateCacheConfig(name, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Updates a cache config.</p>
107 <h3>Method Details</h3>
108 <div class="method">
109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111 </div>
112
113 <div class="method">
114 <code class="details" id="fetchPublisherModelConfig">fetchPublisherModelConfig(name, x__xgafv=None)</code>
115 <pre>Fetches the configs of publisher models.
116
117 Args:
118 name: string, Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. (required)
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124 Returns:
125 An object of the form:
126
127 { # This message contains configs of a publisher model.
128 &quot;dataSharingEnabledProvider&quot;: &quot;A String&quot;, # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model&#x27;s publisher matches this provider. Otherwise, the request is rejected.
129 &quot;loggingConfig&quot;: { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config.
130 &quot;bigqueryDestination&quot;: { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging`
131 &quot;outputUri&quot;: &quot;A String&quot;, # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
132 },
133 &quot;enableOtelLogging&quot;: True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.
134 &quot;enabled&quot;: True or False, # If logging is enabled or not.
135 &quot;errorSamplingRate&quot;: 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors).
136 &quot;requestResponseLoggingSchemaVersion&quot;: &quot;A String&quot;, # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are &quot;v1&quot; and &quot;v2&quot;. The current default version is &quot;v1&quot;.
137 &quot;samplingRate&quot;: 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
138 },
139 }</pre>
140 </div>
141
142 <div class="method">
143 <code class="details" id="getCacheConfig">getCacheConfig(name, x__xgafv=None)</code>
144 <pre>Gets a GenAI cache config.
145
146 Args:
147 name: string, Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`. (required)
148 x__xgafv: string, V1 error format.
149 Allowed values
150 1 - v1 error format
151 2 - v2 error format
152
153 Returns:
154 An object of the form:
155
156 { # Config of GenAI caching features. This is a singleton resource.
157 &quot;disableCache&quot;: True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled.
158 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.
159 }</pre>
160 </div>
161
162 <div class="method">
163 <code class="details" id="setPublisherModelConfig">setPublisherModelConfig(name, body=None, x__xgafv=None)</code>
164 <pre>Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.
165
166 Args:
167 name: string, Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. (required)
168 body: object, The request body.
169 The object takes the form of:
170
171 { # Request message for EndpointService.SetPublisherModelConfig.
172 &quot;publisherModelConfig&quot;: { # This message contains configs of a publisher model. # Required. The publisher model config.
173 &quot;dataSharingEnabledProvider&quot;: &quot;A String&quot;, # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model&#x27;s publisher matches this provider. Otherwise, the request is rejected.
174 &quot;loggingConfig&quot;: { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config.
175 &quot;bigqueryDestination&quot;: { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging`
176 &quot;outputUri&quot;: &quot;A String&quot;, # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
177 },
178 &quot;enableOtelLogging&quot;: True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.
179 &quot;enabled&quot;: True or False, # If logging is enabled or not.
180 &quot;errorSamplingRate&quot;: 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors).
181 &quot;requestResponseLoggingSchemaVersion&quot;: &quot;A String&quot;, # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are &quot;v1&quot; and &quot;v2&quot;. The current default version is &quot;v1&quot;.
182 &quot;samplingRate&quot;: 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
183 },
184 },
185 }
186
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192 Returns:
193 An object of the form:
194
195 { # This resource represents a long-running operation that is the result of a network API call.
196 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
197 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
198 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
199 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
200 {
201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202 },
203 ],
204 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
205 },
206 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
207 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
208 },
209 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
210 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
211 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
212 },
213 }</pre>
214 </div>
215
216 <div class="method">
217 <code class="details" id="updateCacheConfig">updateCacheConfig(name, body=None, x__xgafv=None)</code>
218 <pre>Updates a cache config.
219
220 Args:
221 name: string, Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. (required)
222 body: object, The request body.
223 The object takes the form of:
224
225 { # Config of GenAI caching features. This is a singleton resource.
226 &quot;disableCache&quot;: True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled.
227 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.
228 }
229
230 x__xgafv: string, V1 error format.
231 Allowed values
232 1 - v1 error format
233 2 - v2 error format
234
235 Returns:
236 An object of the form:
237
238 { # This resource represents a long-running operation that is the result of a network API call.
239 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
240 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
241 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
242 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
243 {
244 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
245 },
246 ],
247 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
248 },
249 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
251 },
252 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
253 &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
254 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
255 },
256 }</pre>
257 </div>
258
259 </body></html>