Skip to content

Commit

Permalink
docs(samples): Added LRO code snippet (#220)
Browse files Browse the repository at this point in the history
* docs(samples): Added LRO code snippet

* lint fix

* converted export_agent response to string in test

* Update samples/snippets/long_running_operation.py

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

* changed name of function

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>
  • Loading branch information
galz10 and dandhlee authored Jan 6, 2022
1 parent 612b7eb commit ec75597
Show file tree
Hide file tree
Showing 2 changed files with 105 additions and 0 deletions.
39 changes: 39 additions & 0 deletions Dialogflow-CX/long_running_operation.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


""" DialogFlow CX long running operation code snippet """

## [START dialogflow_cx_long_running_snippet]
from google.cloud.dialogflowcx_v3.services.agents.client import AgentsClient
from google.cloud.dialogflowcx_v3.types.agent import ExportAgentRequest


def export_long_running_agent(project_id, agent_id, location):

api_endpoint = f'{location}-dialogflow.googleapis.com:443'
client_options = {"api_endpoint": api_endpoint}

agents_client = AgentsClient(client_options=client_options)

export_request = ExportAgentRequest()

export_request.name = f'projects/{project_id}/locations/{location}/agents/{agent_id}'

# export_agent returns a long running operation
operation = agents_client.export_agent(request=export_request)

# Returns the result of the operation when the operation is done
return operation.result()
## [END dialogflow_cx_long_running_snippet]
66 changes: 66 additions & 0 deletions Dialogflow-CX/long_running_operation_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Copyright 2021, Google LLC
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
import uuid

from google.cloud.dialogflowcx_v3.services.agents.client import AgentsClient
from google.cloud.dialogflowcx_v3.types.agent import Agent, DeleteAgentRequest

import pytest

from long_running_operation import export_long_running_agent

PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
pytest.AGENT_ID = None
pytest.PARENT = None


def create_agent(project_id, display_name):
parent = "projects/" + project_id + "/locations/global"

agents_client = AgentsClient()

agent = Agent(
display_name=display_name,
default_language_code="en",
time_zone="America/Los_Angeles",
)

response = agents_client.create_agent(request={"agent": agent, "parent": parent})

return response


def delete_agent(name):
agents_client = AgentsClient()
agent = DeleteAgentRequest(name=name)
agents_client.delete_agent(request=agent)


@pytest.fixture(scope="function", autouse=True)
def setup_teardown():
agentName = "temp_agent_" + str(uuid.uuid4())
pytest.PARENT = create_agent(PROJECT_ID, agentName).name
pytest.AGENT_ID = pytest.PARENT.split("/")[5]
print("Created Agent in setUp")

yield

delete_agent(pytest.PARENT)


def test_export_agent():
actualResponse = export_long_running_agent(PROJECT_ID, pytest.AGENT_ID, "global")

assert pytest.AGENT_ID in str(actualResponse)

0 comments on commit ec75597

Please sign in to comment.