Skip to content

Cognitive Services docstrings state that uploads can be used, but library doesn't actually support it #6933

@yuhui

Description

@yuhui

Expected result

The Cognitive Services docstrings state that uploads can be sent to the endpoint.

E.g.

def analyze_image(
self, url, visual_features=None, details=None, language="en", custom_headers=None, raw=False, **operation_config):
"""This operation extracts a rich set of visual features based on the
image content.
Two input methods are supported -- (1) Uploading an image or (2)
specifying an image URL. Within your request, there is an optional
parameter to allow you to choose which features to return. By default,
image categories are returned in the response.

Note this line:

Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.

Actual result

In reality, the code doesn't actually support uploads. E.g. for the analyze_image() function, only a publicly reachable url of an image can be used.

Next steps

Update the docstrings to reflect how the library's functions should be used in reality.

Metadata

Metadata

Assignees

Labels

ClientThis issue points to a problem in the data-plane of the library.Cognitive - Computer VisionService AttentionWorkflow: This issue is responsible by Azure service team.bugThis issue requires a change to an existing behavior in the product in order to be resolved.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 team

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions