Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Azure.AI.DocumentIntelligence: stringIndexType missing in ClassifyDocumentOptions and AnalyzeDocumentOptions #47694

Open
jaliyaudagedara opened this issue Jan 2, 2025 · 2 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@jaliyaudagedara
Copy link

jaliyaudagedara commented Jan 2, 2025

Library name and version

Azure.AI.DocumentIntelligence 1.0.0

Describe the bug

DocumentIntelligenceClient exposes the following methods where we can pass stringIndexType.

ClassifyDocumentAsync:

public virtual async Task<Operation<BinaryData>> ClassifyDocumentAsync(WaitUntil waitUntil, string classifierId, RequestContent content, string stringIndexType = null, string split = null, string pages = null, RequestContext context = null)

AnalyzeDocumentAsync
public virtual async Task<Operation<BinaryData>> AnalyzeDocumentAsync(WaitUntil waitUntil, string modelId, RequestContent content, string pages = null, string locale = null, string stringIndexType = null, IEnumerable<DocumentAnalysisFeature> features = null, IEnumerable<string> queryFields = null, string outputContentFormat = null, IEnumerable<AnalyzeOutputOption> output = null, RequestContext context = null)

And there are overloads for these methods that accepts ClassifyDocumentOptions and AnalyzeDocumentOptions respectively. In these options stringIndexType is missing.

Expected behavior

stringIndexType should be exposed as properties in ClassifyDocumentOptions and AnalyzeDocumentOptions, so consumers can configure those options when calling the overloads that accepts ClassifyDocumentOptions and AnalyzeDocumentOptions and not have to call above methods just because when they need to pass stringIndexType.

P.S: Should we make above methods that accepts several number of parameters internal and allow consumers to use methods that accepts options only. I saw a comment recommending the consumers to use methods that accepts Options.

Actual behavior

stringIndexType is missing in ClassifyDocumentOptions and AnalyzeDocumentOptions.

Reproduction Steps

N/A

Environment

N/A

@github-actions github-actions bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jan 2, 2025
@jaliyaudagedara
Copy link
Author

jaliyaudagedara commented Jan 2, 2025

@kinelski FYI, tagging you, since you wrote most of the code!

@jsquire jsquire added Client This issue points to a problem in the data-plane of the library. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Cognitive - Form Recognizer and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Jan 2, 2025
@jsquire
Copy link
Member

jsquire commented Jan 2, 2025

Thank you for your feedback. Tagging and routing to the team member best able to assist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Development

No branches or pull requests

3 participants