| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="aiplatform_v1beta1.html">Agent Platform API</a> . <a href="aiplatform_v1beta1.vertexExpress.html">vertexExpress</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="aiplatform_v1beta1.vertexExpress.Eligibility.html">Eligibility()</a></code> |
| </p> |
| <p class="firstline">Returns the Eligibility Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#retrieveExpressProject">retrieveExpressProject(getDefaultApiKey=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the project for Vertex AI Express Mode.</p> |
| <p class="toc_element"> |
| <code><a href="#signUp">signUp(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Signs up the user for Vertex AI Express Mode. If the user is already signed up, the existing ExpressProject will be returned.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="retrieveExpressProject">retrieveExpressProject(getDefaultApiKey=None, x__xgafv=None)</code> |
| <pre>Retrieves the project for Vertex AI Express Mode. |
| |
| Args: |
| getDefaultApiKey: boolean, Optional. Whether to return the default API key string in the response. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ExpressModeService.RetrieveExpressProject. |
| "expressProject": { # The project for Vertex AI Express Mode. # The project for Vertex AI Express Mode. |
| "createTime": "A String", # Output only. The time the project was created. |
| "defaultApiKey": "A String", # Output only. The default API key string of the project. |
| "projectId": "A String", # Output only. The ID of the project. |
| "projectNumber": "A String", # Output only. The number of the project. |
| "region": "A String", # Output only. The region of the project. |
| "tier": "A String", # Output only. The tier of the project. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="signUp">signUp(body=None, x__xgafv=None)</code> |
| <pre>Signs up the user for Vertex AI Express Mode. If the user is already signed up, the existing ExpressProject will be returned. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for ExpressModeService.SignUp. |
| "getDefaultApiKey": True or False, # Optional. Whether to return the default API key string in the response. |
| "region": "A String", # Required. The desired region for the express project. |
| "tosAccepted": True or False, # Required. Whether the Terms of Service are accepted. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The project for Vertex AI Express Mode. |
| "createTime": "A String", # Output only. The time the project was created. |
| "defaultApiKey": "A String", # Output only. The default API key string of the project. |
| "projectId": "A String", # Output only. The ID of the project. |
| "projectNumber": "A String", # Output only. The number of the project. |
| "region": "A String", # Output only. The region of the project. |
| "tier": "A String", # Output only. The tier of the project. |
| }</pre> |
| </div> |
| |
| </body></html> |
