Dfcx-scrapi

Enhancements
API Call Counter
We've introduced a new API Call Counter feature that allows you to inspect the total number of API calls made by any Class in DFCX SCRAPI. This is helpful for debugging and understanding quotas and rate limits on your project. You can access the new API counter by inspecting the following methods on any class:

- `get_api_calls_details()`
- `get_api_calls_count()`

Additionally you can inspect the parameter `api_calls_dict` to get information about the API calls for that class.

Example:
py
from dfcx_scrapi.core.intents import Intents

i = Intents()
my_agent = <SAMPLE_AGENT_ID>

my_intents = list_intents(my_agent)

print(i.get_api_calls_details())
print(i.get_api_calls_count())
print(i.api_calls_dict)


Language Code Additions
We've updated language code parameters across several classes and methods to enable support for multilingual agents.

Test Cases Conversation Turns
We added some additional logic to allow user's to export Test Case full conversation turns when performing a list/get on test cases.

Bug Fixes
- fixed an issue with delete page that wasn't allowing the user to force delete a page when requested
- fixed an issue with DialogflowConversation class that was relying on the `QueryResult.diagnostic_info` field, causing NO_MATCH results to raise a `NoneType` error when using the `reply` method in that class

What's Changed
* add force for delete page by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/124
* Bump pyyaml from 5.3.1 to 5.4 by dependabot in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/125
* Feature/api call counter by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/133
* add include_conversation_turns to the list_test_cases by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/132
* feat: add language code arg to several methods by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/134
* fix: deprecate reliance on diag_info by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/136

New Contributors
* dependabot made their first contribution in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/125

**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.6.3...1.7.0

Bug Fixes
* Fixed an issue in [scrapi_base.ScrapiBase._set_region()](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/core/scrapi_base.py#L75) that was causing the `quota_project_id` to not be set properly
* Slight refactor of [conversation.py](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/core/conversation.py)
- Users can now instantiate the class without providing `agent_id` if needed for use case
- backward compatibility setup to allow `config` arg to take precedence if provided

What's Changed
* Fix/set region by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/120


**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.6.2...1.6.3

Bug Fixes

What's Changed
* correct arg assignment for copy entity method by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/118


**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.6.1...1.6.2

Bug Fixes
- [KeyError in route_groups_to_dataframe for special pages](https://github.com/GoogleCloudPlatform/dfcx-scrapi/issues/110)
- [APPEND behavior in build_response method on webhook_util](https://github.com/GoogleCloudPlatform/dfcx-scrapi/issues/112)
- [Intent builder adds a space before TP parts that start with an apostrophe when adding a new TP](https://github.com/GoogleCloudPlatform/dfcx-scrapi/issues/114)

What's Changed
* Bug/misc by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/113

**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.6.0...1.6.1

New Features
Github Actions - PyLint
Way overdue, but we finally have [automated linting](https://github.com/GoogleCloudPlatform/dfcx-scrapi/actions/workflows/linter.yml) for feature branches and PRs to `main`!
This should help expedite the review process and generally provide some good code hygiene across all PRs.

Builders
Added [7 new Builder Classes](https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/107)!

These will help round out the Builder classes and provide all of the functional building blocks for Flows, Pages, Transition Routes, and Fulfillments.

Happy Building! 😄 🏗️

Enhancements
- [Pages.get_pages_map](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/core/pages.py#L80) now generates the Page Display Names and IDs for the reserved "special" pages in Dialogflow CX (i.e. `END_SESSION`, `START_PAGE`, and `END_FLOW`)
- Added [Pages.delete_page](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/core/pages.py#L228)
- Added [Flows.create_flow](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/core/flows.py#L229)
- Updates to [CopyUtil](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/tools/copy_util.py) to support Route Groups

Notebooks
- [copy_paste_pages.ipynb](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/examples/copy_paste_series/copy_paste_pages.ipynb) updated to include recent changes to `CopyUtil`

Bug Fixes
- Fixed a bug in `ScrapiBase.parse_resource_path` that was causing Page IDs to not be parsed correctly
- Fixed missing `__init__.py` file in `agent_assist` folder
- Fixed issue causing some resource create methods to not honor the incoming kwargs or proto object provided
- This affected the `create_x` methods in `agents`, `entity_types` and `intents`
- Fixed an issue in [CopyUtil](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/tools/copy_util.py) where some copy functions would fail due to missing Flow resources in Flows map.
- Fixed a bug in `conversation.py` where a new match type for `KNOWLEDGE_CONNECTOR` was not being handled

Misc
- Lots of refactor and linting across all files
- Updates to copyright dates
- Fixed typo in `nlu_util` ValueError message

---

What's Changed
* update regex for page validation by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/92
* Small Enhancement to Pages Map by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/90
* Adding init file in the agent assist folder by hkhaitan1 in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/89
* Patch/create flow by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/96
* Feature/workflows by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/100
* Patch/workflows update by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/101
* Patch/core create refactor by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/88
* Feature/copy util update by SeanScripts in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/97
* Adding a new match type for knowledge connector by mejindal in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/102
* Feature/builders by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/107
* remove typo by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/109

New Contributors
* mejindal made their first contribution in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/102

**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.5.1...1.6.0

Bug Fixes
* Fixed import typo in NLU Analysis notebook 😁

**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.5.0...1.5.1