Skip to content

Commit 5fbcb9b

Browse files
changsongdloferris
authored and
dandhlee
committed
docs: add code snippets for async api (GoogleCloudPlatform#18)
* docs: add code snippets for async api * fix lint and add storage to requirements * iterator type annotation * fix typo and test * remove typing * add None return type Co-authored-by: Lo Ferris <50979514+loferris@users.noreply.github.com>
1 parent cc0fc32 commit 5fbcb9b

5 files changed

Lines changed: 251 additions & 0 deletions

File tree

‎optimization/snippets/async_api.py‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# [START cloudoptimization_async_api]
16+
17+
from google.api_core.exceptions import GoogleAPICallError
18+
from google.cloud import optimization_v1
19+
20+
# TODO(developer): Uncomment these variables before running the sample.
21+
# project_id= 'YOUR_PROJECT_ID'
22+
# request_file_name = 'YOUR_REQUEST_FILE_NAME'
23+
# request_model_gcs_path = 'gs://YOUR_PROJECT/YOUR_BUCKET/YOUR_REQUEST_MODEL_PATH'
24+
# model_solution_gcs_path = 'gs://YOUR_PROJECT/YOUR_BUCKET/YOUR_SOLUCTION_PATH'
25+
26+
27+
def call_async_api(project_id: str, request_model_gcs_path: str, model_solution_gcs_path_prefix: str) -> None:
28+
"""Call the async api for fleet routing."""
29+
# Use the default credentials for the environment to authenticate the client.
30+
fleet_routing_client = optimization_v1.FleetRoutingClient()
31+
request_file_name = "resources/async_request.json"
32+
33+
with open(request_file_name, 'r') as f:
34+
fleet_routing_request = optimization_v1.BatchOptimizeToursRequest.from_json(f.read())
35+
fleet_routing_request.parent = f"projects/{project_id}"
36+
for idx, mc in enumerate(fleet_routing_request.model_configs):
37+
mc.input_config.gcs_source.uri = request_model_gcs_path
38+
model_solution_gcs_path = f'{model_solution_gcs_path_prefix}_{idx}'
39+
mc.output_config.gcs_destination.uri = model_solution_gcs_path
40+
41+
# The timeout argument for the gRPC call is independent from the `timeout`
42+
# field in the request's OptimizeToursRequest message(s).
43+
operation = fleet_routing_client.batch_optimize_tours(fleet_routing_request)
44+
print(operation.operation.name)
45+
46+
try:
47+
# Block to wait for the job to finish.
48+
result = operation.result()
49+
print(result)
50+
# Do you stuff.
51+
except GoogleAPICallError:
52+
print(operation.operation.error)
53+
54+
55+
# [END cloudoptimization_async_api]

‎optimization/snippets/async_api_test.py‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import uuid
16+
17+
import google.auth
18+
from google.cloud import storage
19+
import pytest
20+
from samples.snippets import async_api
21+
22+
23+
# TODO(developer): Replace the variables in the file before use.
24+
# A sample request model can be found at resources/async_request_model.json.
25+
TEST_UUID = uuid.uuid4()
26+
BUCKET = f'optimization-ai-{TEST_UUID}'
27+
OUTPUT_PREFIX = f'code_snippets_test_output_{TEST_UUID}'
28+
INPUT_URI = "gs://cloud-samples-data/optimization-ai/async_request_model.json"
29+
BATCH_OUTPUT_URI_PREFIX = "gs://{}/{}/".format(BUCKET, OUTPUT_PREFIX)
30+
31+
32+
@pytest.fixture(autouse=True)
33+
def setup_teardown() -> None:
34+
"""Create a temporary bucket to store optimization output."""
35+
storage_client = storage.Client()
36+
bucket = storage_client.create_bucket(BUCKET)
37+
38+
yield
39+
40+
bucket.delete(force=True)
41+
42+
43+
def test_call_async_api(capsys: pytest.LogCaptureFixture) -> None:
44+
_, project_id = google.auth.default()
45+
async_api.call_async_api(project_id, INPUT_URI, BATCH_OUTPUT_URI_PREFIX)
46+
out, _ = capsys.readouterr()
47+
48+
assert "operations" in out

‎optimization/snippets/requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
google-cloud-optimization==0.1.0
2+
google-cloud-storage==2.2.1

‎optimization/snippets/resources/async_request.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"parent": "projects/${YOUR_GCP_PROJECT_ID}",
3+
"model_configs":[
4+
{
5+
"input_config":{
6+
"gcs_source":{
7+
"uri":"${REQUEST_MODEL_GCS_PATH}"
8+
},
9+
"data_format":"JSON"
10+
},
11+
"output_config":{
12+
"gcs_destination":{
13+
"uri":"${MODEL_SOLUTION_GCS_PATH}"
14+
},
15+
"data_format":"JSON"
16+
}
17+
},
18+
{
19+
"input_config":{
20+
"gcs_source":{
21+
"uri":"${REQUEST_MODEL_GCS_PATH}"
22+
},
23+
"data_format":"JSON"
24+
},
25+
"output_config":{
26+
"gcs_destination":{
27+
"uri":"${MODEL_SOLUTION_GCS_PATH}"
28+
},
29+
"data_format":"JSON"
30+
}
31+
}
32+
]
33+
}

‎optimization/snippets/resources/async_request_model.json‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
{
2+
"parent":"${YOUR_GCP_PROJECT_ID}",
3+
"allowLargeDeadlineDespiteInterruptionRisk":true,
4+
"model":{
5+
"shipments":[
6+
{
7+
"deliveries":[
8+
{
9+
"arrivalLocation":{
10+
"latitude":48.880941999999997,
11+
"longitude":2.3238660000000002
12+
},
13+
"duration":"250s",
14+
"timeWindows":[
15+
{
16+
"endTime":"1970-01-01T01:06:40Z",
17+
"startTime":"1970-01-01T00:50:00Z"
18+
}
19+
]
20+
}
21+
],
22+
"loadDemands": {
23+
"weight": {
24+
"amount": "10"
25+
}
26+
},
27+
"pickups":[
28+
{
29+
"arrivalLocation":{
30+
"latitude":48.874507000000001,
31+
"longitude":2.3036099999999999
32+
},
33+
"duration":"150s",
34+
"timeWindows":[
35+
{
36+
"endTime":"1970-01-01T00:33:20Z",
37+
"startTime":"1970-01-01T00:16:40Z"
38+
}
39+
]
40+
}
41+
]
42+
},
43+
{
44+
"deliveries":[
45+
{
46+
"arrivalLocation":{
47+
"latitude":48.880940000000002,
48+
"longitude":2.3238439999999998
49+
},
50+
"duration":"251s",
51+
"timeWindows":[
52+
{
53+
"endTime":"1970-01-01T01:06:41Z",
54+
"startTime":"1970-01-01T00:50:01Z"
55+
}
56+
]
57+
}
58+
],
59+
"loadDemands": {
60+
"weight": {
61+
"amount": "20"
62+
}
63+
},
64+
"pickups":[
65+
{
66+
"arrivalLocation":{
67+
"latitude":48.880943000000002,
68+
"longitude":2.3238669999999999
69+
},
70+
"duration":"151s",
71+
"timeWindows":[
72+
{
73+
"endTime":"1970-01-01T00:33:21Z",
74+
"startTime":"1970-01-01T00:16:41Z"
75+
}
76+
]
77+
}
78+
]
79+
}
80+
],
81+
"vehicles":[
82+
{
83+
"loadLimits": {
84+
"weight": {
85+
"maxLoad": 50
86+
}
87+
},
88+
"endLocation":{
89+
"latitude":48.863109999999999,
90+
"longitude":2.341205
91+
},
92+
"startLocation":{
93+
"latitude":48.863101999999998,
94+
"longitude":2.3412039999999998
95+
}
96+
},
97+
{
98+
"loadLimits": {
99+
"weight": {
100+
"maxLoad": 60
101+
}
102+
},
103+
"endLocation":{
104+
"latitude":48.863120000000002,
105+
"longitude":2.341215
106+
},
107+
"startLocation":{
108+
"latitude":48.863112000000001,
109+
"longitude":2.3412139999999999
110+
}
111+
}
112+
]
113+
}
114+
}

0 commit comments

Comments
 (0)