Dfcx-scrapi

Bug Fix
- Fixed typo in local agent file

**Full Changelog**: https://github.com/GoogleCloudPlatform/dfcx-scrapi/compare/1.8.0...1.8.1

New Features
Offline Agent Parsing 📵
We're excited to announce a new feature we're calling "Offline Agent Parsing"!
So what does it do? 🤔

TLDR
The Offline Agent Parsing feature pulls your entire agent file offline and returns a Python object ✨jam packed ✨ with all of the key Agent Resources and most commonly sought after bits of information from your agent.

It's Fast! ⚡️
We can process any agent size, from 1 Flow to 100 Flows, in blazing fast time! 🔥

It's Cheap! (On the API!) 💰
We make all the magic happen in just 2 API calls, no matter the agent size! 🪄

It's Convenient! 🙏🏼
We already know you need that map and DataFrame. We gotcha! 😎

Some examples of what you'll get when you use the feature:
- All of the major agent resources in List format (i.e. Intents, Entity Types, Flows, Pages, etc.)
- All of the common resource maps (i.e. intents_map, flows_map, pages_map, etc.)
- A full graph representation of your agent, for additional downstream parsing
- Handy DataFrames for identifying gaps in your agent design
- Total Counts of all common resources (i.e. Total Intents, Total Training Phrases, etc.)
- ...and much more!

For a detail output of available, see the [AgentData](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/agent_extract/types.py#L181) class.

Motivation
The motivation behind this class comes from many of our customers that are building really, REALLY big Dialogflow CX agents!

Using the standard APIs can become a costly hinderance in terms of time it takes to retrieve the online data from your Agent.
If you have 50 Flows and you want to get all of the Pages in your agent, that's _a minimum_ of 51 API calls!
Additionally, you have to beware of API Quota limits.
Run your script too fast, and you'll hit a 429 Quota Exhausted error!

With Offline Agent Parsing, we take all of the heavy lifting _offline_ and we do it all with _**just a single API call.**_


Batch NLU Evaluation 📊
Another great feature that we're releasing is the [NLU Evaluation](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/src/dfcx_scrapi/tools/nlu_evals.py) framework!

This framework allows you to batch / bulk test your Dialogflow CX NLU model against your evaluation datasets.
This is especially helpful for teams that do a lot of NLU tuning in Dialogflow CX.

See the new [Sample Eval Notebook](https://github.com/GoogleCloudPlatform/dfcx-scrapi/blob/main/examples/nlu_analysis_series/nlu_evaluation_testing.ipynb) for some pointers on getting started!

Bug Fixes
- Fixed a bug where `location_id` was reverted to `location` in `agents.py`

Misc
- Fixed some docs in various places
- Fixed pylint deprecation error for builtins
- Added optimization for `__convert_tr_target_page` in `CopyUtil`

What's Changed
* Misc/improvement by MRyderOC in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/137
* fix: revert change to location_id arg by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/139
* Feature/agent checking by SeanScripts in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/104
* Feat/nlu evals by kmaphoenix in https://github.com/GoogleCloudPlatform/dfcx-scrapi/pull/143


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

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