python-documentai-toolbox icon indicating copy to clipboard operation
python-documentai-toolbox copied to clipboard

Create Unified Index of Toolbox functions in Docs

Open holtskinner opened this issue 1 year ago • 0 comments

Transcript of conversation with Rand Wrobel.

Rand Wrobel, Jan 9, 7:36 PM Is there any index into the functions provided in the DocAI Toolbox in Git?

You, Jan 9, 8:26 PM Yes, this page has the code samples

https://cloud.google.com/document-ai/docs/toolbox

And this is the SDK Reference https://cloud.google.com/python/docs/reference/documentai-toolbox/latest/google.cloud.documentai_toolbox.wrappers.document

The other classes/methods can be found on the left-hand side menu

AHYE8Xj2sMYzvdh

Rand Wrobel, Jan 9, 8:29 PM IS the list of samples comprehensive?

You, Jan 9, 8:31 PM It doesn't include every single function, but it includes the most commonly used ones. Each class has quite a few functions that can be used in different ways, so it didn't make sense to write samples for each individual function on every class.

Rand Wrobel, Jan 9, 8:36 PM Yeah, There is a suggestion to add documentation for a comprehensive index into the functions for consumability, which would not require a sample for each. Incubator is working on a Vertex Search-based asset finder (as a replacement for DocWH) where we would look to include the toolbox contents. Drew and I are tasked by Derek with scoping this for strategic goals.

You, Jan 9, 8:40 PM Ok, makes sense. The Auto-generated docs are intended to be that index into the functions. But if it's not very searchable/consumable as is, I can try to edit the format so that it's easier.

It might be possible to export all of them directly onto one page (like an overview) in addition to the classes.

holtskinner avatar Jan 17 '24 11:01 holtskinner