models Package
Modules
Classes
| Action |
Defines an action. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageAction Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| AggregateOffer |
Defines a list of offers from merchants that are related to the image. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| AggregateRating |
Defines the metrics that indicate how well an item was rated by others. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| CreativeWork |
The most generic kind of creative work, including books, movies, photographs, software programs, etc. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Action, MediaObject, Recipe Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| CropArea |
A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image. All required parameters must be populated in order to send to Azure. |
| Error |
Defines the error that occurred. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ErrorResponse |
The top-level response that represents a failed request. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ErrorResponseException |
Server responsed with exception of type: 'ErrorResponse'. |
| Filters |
A key-value object consisting of filters that may be specified to limit the results returned by the API. Current available filters: site. |
| Identifiable |
Defines the identity of a resource. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Response Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageAction |
Defines an image action. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageEntityAction, ImageModuleAction, ImageRecipesAction, ImageRelatedSearchesAction, ImageShoppingSourcesAction Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageEntityAction |
Defines an entity action. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageInfo |
A JSON object that identities the image to get insights of . It also includes the optional crop area that you use to identify the region of interest in the image. |
| ImageKnowledge |
Defines a visual search API response. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageModuleAction |
Defines an image list action. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageObject |
Defines an image. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageRecipesAction |
Defines an recipe action. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageRelatedSearchesAction |
Defines an related search action. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageShoppingSourcesAction |
Defines a shopping sources action. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageTag |
A visual search tag. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ImageTagRegion |
Defines an image region relevant to the ImageTag. All required parameters must be populated in order to send to Azure. |
| ImagesImageMetadata |
Defines a count of the number of websites where you can shop or perform other actions related to the image. Variables are only populated by the server, and will be ignored when sending a request. |
| ImagesModule |
Defines a list of images. Variables are only populated by the server, and will be ignored when sending a request. |
| Intangible |
A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc. You probably want to use the sub-classes and not this class directly. Known sub-classes are: StructuredValue Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| KnowledgeRequest |
A JSON object containing information about the request, such as filters for the resulting actions. |
| MediaObject |
Defines a media object. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageObject Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| NormalizedQuadrilateral |
Defines a region of an image. The region is a convex quadrilateral defined by coordinates of its top left, top right, bottom left, and bottom right points. The coordinates are fractional values of the original image's width and height in the range 0.0 through 1.0. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Offer |
Defines a merchant's offer. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AggregateOffer Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Organization |
Defines an organization. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Person |
Defines a person. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Point2D |
Defines a 2D point with X and Y coordinates. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| PropertiesItem |
Defines an item. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Rating Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Query |
Defines a search query. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Rating |
Defines a rating. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AggregateRating Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Recipe |
Defines a cooking recipe. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| RecipesModule |
Defines a list of recipes. Variables are only populated by the server, and will be ignored when sending a request. |
| RelatedSearchesModule |
Defines a list of related searches. Variables are only populated by the server, and will be ignored when sending a request. |
| Response |
Defines a response. All schemas that return at the root of the response must inherit from this object. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageKnowledge, ErrorResponse, Thing Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| ResponseBase |
Response base. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Identifiable All required parameters must be populated in order to send to Azure. |
| StructuredValue |
StructuredValue. You probably want to use the sub-classes and not this class directly. Known sub-classes are: Point2D, NormalizedQuadrilateral Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| Thing |
Defines a thing. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageTag, Organization, Offer, CreativeWork, Person, Intangible Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| VisualSearchRequest |
A JSON object that contains information about the image to get insights of. Specify this object only in a knowledgeRequest form data. |
Enums
| Currency |
An enumeration. |
| ErrorCode |
An enumeration. |
| ErrorSubCode |
An enumeration. |
| ItemAvailability |
An enumeration. |
| SafeSearch |
An enumeration. |
Feedback
Submit and view feedback for