Skip to content

Commit 69b20ad

Browse files
docs(boxsdkgen): bounding boxes&confidence score (box/box-openapi#619)
1 parent 1d9d377 commit 69b20ad

6 files changed

Lines changed: 14 additions & 14 deletions

File tree

‎.codegen.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "daeb1ea", "specHash": "88cd5aa", "version": "4.16.0" }
1+
{ "engineHash": "daeb1ea", "specHash": "c5a35a6", "version": "4.16.0" }

‎box_sdk_gen/managers/ai.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -486,9 +486,9 @@ def create_ai_extract_structured(
486486
:param fields: The fields to be extracted from the provided items.
487487
For your request to work, you must provide either `metadata_template` or `fields`, but not both., defaults to None
488488
:type fields: Optional[List[CreateAiExtractStructuredFields]], optional
489-
:param include_confidence_score: A flag to indicate whether confidence scores for every extracted field should be returned., defaults to None
489+
:param include_confidence_score: A flag to indicate whether confidence scores for every extracted field should be returned. Estimates the likelihood that an extracted metadata field value is accurate and correct. Displays a numerical and categorical confidence score to help users and automated systems quickly determine extraction reliability., defaults to None
490490
:type include_confidence_score: Optional[bool], optional
491-
:param include_reference: A flag to indicate whether references for every extracted field should be returned., defaults to None
491+
:param include_reference: A flag to indicate whether references for every extracted field should be returned. References and bounding boxes show where the agent extracted the metadata from. They help you check for accuracy and fix any mistakes. References are short, exact quotes from the original document used to verify results. Bounding boxes highlight the specific areas on the page where that text is found., defaults to None
492492
:type include_reference: Optional[bool], optional
493493
:param taxonomy_sources: The taxonomy sources to be used for the structured extraction. They can either be an existing file or a taxonomy.
494494
For your request to work, `fields` must also be provided. `taxonomy_sources` is not supported with `metadata_template`., defaults to None

‎box_sdk_gen/schemas/ai_extract_structured.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,9 @@ def __init__(
153153
:param fields: The fields to be extracted from the provided items.
154154
For your request to work, you must provide either `metadata_template` or `fields`, but not both., defaults to None
155155
:type fields: Optional[List[AiExtractStructuredFieldsField]], optional
156-
:param include_confidence_score: A flag to indicate whether confidence scores for every extracted field should be returned., defaults to None
156+
:param include_confidence_score: A flag to indicate whether confidence scores for every extracted field should be returned. Estimates the likelihood that an extracted metadata field value is accurate and correct. Displays a numerical and categorical confidence score to help users and automated systems quickly determine extraction reliability., defaults to None
157157
:type include_confidence_score: Optional[bool], optional
158-
:param include_reference: A flag to indicate whether references for every extracted field should be returned., defaults to None
158+
:param include_reference: A flag to indicate whether references for every extracted field should be returned. References and bounding boxes show where the agent extracted the metadata from. They help you check for accuracy and fix any mistakes. References are short, exact quotes from the original document used to verify results. Bounding boxes highlight the specific areas on the page where that text is found., defaults to None
159159
:type include_reference: Optional[bool], optional
160160
:param taxonomy_sources: The taxonomy sources to be used for the structured extraction. They can either be an existing file or a taxonomy.
161161
For your request to work, `fields` must also be provided. `taxonomy_sources` is not supported with `metadata_template`., defaults to None

‎box_sdk_gen/schemas/collaboration.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
from box_sdk_gen.internal.base_object import BaseObject
66

7-
from box_sdk_gen.schemas.file import File
7+
from box_sdk_gen.schemas.file_mini import FileMini
88

9-
from box_sdk_gen.schemas.folder import Folder
9+
from box_sdk_gen.schemas.folder_mini import FolderMini
1010

11-
from box_sdk_gen.schemas.web_link import WebLink
11+
from box_sdk_gen.schemas.web_link_mini import WebLinkMini
1212

1313
from box_sdk_gen.schemas.group_mini import GroupMini
1414

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
from typing import Union
22

3-
from box_sdk_gen.schemas.file import File
3+
from box_sdk_gen.schemas.file_mini import FileMini
44

5-
from box_sdk_gen.schemas.folder import Folder
5+
from box_sdk_gen.schemas.folder_mini import FolderMini
66

7-
from box_sdk_gen.schemas.web_link import WebLink
7+
from box_sdk_gen.schemas.web_link_mini import WebLinkMini
88

99
from box_sdk_gen.box.errors import BoxSDKError
1010

11-
CollaborationItem = Union[File, Folder, WebLink]
11+
CollaborationItem = Union[FileMini, FolderMini, WebLinkMini]

‎docs/box_sdk_gen/ai.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,9 @@ client.ai.create_ai_extract_structured([AiItemBase(id=file.id)], fields=[CreateA
188188
- ai_agent `Optional[AiExtractStructuredAgent]`
189189

190190
- include_confidence_score `Optional[bool]`
191-
- A flag to indicate whether confidence scores for every extracted field should be returned.
191+
- A flag to indicate whether confidence scores for every extracted field should be returned. Estimates the likelihood that an extracted metadata field value is accurate and correct. Displays a numerical and categorical confidence score to help users and automated systems quickly determine extraction reliability.
192192
- include_reference `Optional[bool]`
193-
- A flag to indicate whether references for every extracted field should be returned.
193+
- A flag to indicate whether references for every extracted field should be returned. References and bounding boxes show where the agent extracted the metadata from. They help you check for accuracy and fix any mistakes. References are short, exact quotes from the original document used to verify results. Bounding boxes highlight the specific areas on the page where that text is found.
194194
- taxonomy_sources `Optional[List[AiTaxonomySource]]`
195195
- The taxonomy sources to be used for the structured extraction. They can either be an existing file or a taxonomy. For your request to work, `fields` must also be provided. `taxonomy_sources` is not supported with `metadata_template`.
196196
- extra_headers `Optional[Dict[str, Optional[str]]]`

0 commit comments

Comments
 (0)