Skip to content

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

Open
@jaliyaudagedara

Description

@jaliyaudagedara

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    ClientThis issue is related to a non-management packageCognitive - Form RecognizerService AttentionWorkflow: This issue is responsible by Azure service team.customer-reportedIssues that are reported by GitHub users external to the Azure organization.needs-team-attentionWorkflow: This issue needs attention from Azure service team or SDK teamquestionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions