Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions packages/@azure/cognitiveservices-imagesearch/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#git
.git
.gitignore
#gulp
gulpfile.js
#documentation
doc/
docs/
#dependencies
node_modules/
#samples
sample/
samples/
#tests
test/
tests/
coverage/
#tools and scripts
tools/
scripts/
#IDE settings
*.sln
.vscode/
.idea
.editorconfig
.ntvs_analysis.*
#build tools
.travis.yml
.jenkins.yml
.codeclimate.yml
appveyor.yml
# Nuget packages #
.nuget/
packages/
packages.config
21 changes: 21 additions & 0 deletions packages/@azure/cognitiveservices-imagesearch/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
122 changes: 122 additions & 0 deletions packages/@azure/cognitiveservices-imagesearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# An isomorphic javascript sdk for - ImageSearchAPIClient
This project provides an isomorphic javascript package. Right now it supports:
- node.js version 6.x.x or higher
- browser javascript

## How to Install

- nodejs
```
npm install @azure/cognitiveservices-imagesearch
```
- browser
```html
<script type="text/javascript" src="@azure/cognitiveservices-imagesearch/dist/cognitiveservices-imagesearch.js"></script>
```

## How to use

### nodejs - Authentication, client creation and search images as an example written in TypeScript.

```ts
import * as msRest from "ms-rest-js";
import { ImageSearchAPIClient, ImageSearchAPIModels, ImageSearchAPIMappers } from "@azure/cognitiveservices-imagesearch";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

const token = "<access_token>";
const creds = new msRest.TokenCredentials(token);
const client = new ImageSearchAPIClient(creds, subscriptionId);
const query = "testquery";
const acceptLanguage = "testacceptLanguage";
const userAgent = "testuserAgent";
const clientId = "testclientId";
const clientIp = "testclientIp";
const location = "westus";
const aspect = "All";
const color = "ColorOnly";
const countryCode = "testcountryCode";
const count = 1;
const freshness = "Day";
const height = 1;
const id = "testid";
const imageContent = "Face";
const imageType = "AnimatedGif";
const license = "All";
const market = "testmarket";
const maxFileSize = 1;
const maxHeight = 1;
const maxWidth = 1;
const minFileSize = 1;
const minHeight = 1;
const minWidth = 1;
const offset = 1;
const safeSearch = "Off";
const size = "All";
const setLang = "testsetLang";
const width = 1;
client.images.search(query, acceptLanguage, userAgent, clientId, clientIp, location, aspect, color, countryCode, count, freshness, height, id, imageContent, imageType, license, market, maxFileSize, maxHeight, maxWidth, minFileSize, minHeight, minWidth, offset, safeSearch, size, setLang, width).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.error(err);
});
```

### browser - Authentication, client creation and search images as an example written in javascript.

- index.html
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/cognitiveservices-imagesearch sample</title>
<script type="text/javascript" src="./node_modules/ms-rest-js/dist/msRest.browser.js"></script>
<script type="text/javascript" src="./dist/cognitiveservices-imagesearch.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const token = "<access_token>";
const creds = new msRest.TokenCredentials(token);
const client = new Azure.CognitiveservicesImagesearch.ImageSearchAPIClient(creds, subscriptionId);
const query = "testquery";
const acceptLanguage = "testacceptLanguage";
const userAgent = "testuserAgent";
const clientId = "testclientId";
const clientIp = "testclientIp";
const location = "westus";
const aspect = "All";
const color = "ColorOnly";
const countryCode = "testcountryCode";
const count = 1;
const freshness = "Day";
const height = 1;
const id = "testid";
const imageContent = "Face";
const imageType = "AnimatedGif";
const license = "All";
const market = "testmarket";
const maxFileSize = 1;
const maxHeight = 1;
const maxWidth = 1;
const minFileSize = 1;
const minHeight = 1;
const minWidth = 1;
const offset = 1;
const safeSearch = "Off";
const size = "All";
const setLang = "testsetLang";
const width = 1;
client.images.search(query, acceptLanguage, userAgent, clientId, clientIp, location, aspect, color, countryCode, count, freshness, height, id, imageContent, imageType, license, market, maxFileSize, maxHeight, maxWidth, minFileSize, minHeight, minWidth, offset, safeSearch, size, setLang, width).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.error(err);
});
</script>
</head>
<body>
</body>
</html>
```

# Related projects
- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

import * as Models from "./models";
import * as Mappers from "./models/mappers";
import * as operations from "./operations";
import { ImageSearchAPIClientContext } from "./imageSearchAPIClientContext";

class ImageSearchAPIClient extends ImageSearchAPIClientContext {
// Operation groups
images: operations.ImagesOperations;

/**
* Initializes a new instance of the ImageSearchAPIClient class.
* @param credentials Subscription credentials which uniquely identify client subscription.
* @param [options] The parameter options
*/
constructor(credentials: msRest.ServiceClientCredentials, options?: Models.ImageSearchAPIClientOptions) {
super(credentials, options);
this.images = new operations.ImagesOperations(this);
}
}

// Operation Specifications

export {
ImageSearchAPIClient,
ImageSearchAPIClientContext,
Models as ImageSearchAPIModels,
Mappers as ImageSearchAPIMappers
};
export * from "./operations";
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

import * as msRest from "ms-rest-js";
import * as Models from "./models";

const packageName = "@azure/cognitiveservices-imagesearch";
const packageVersion = "1.0.0";

export class ImageSearchAPIClientContext extends msRest.ServiceClient {
credentials: msRest.ServiceClientCredentials;

/**
* Initializes a new instance of the ImageSearchAPIClientContext class.
* @param credentials Subscription credentials which uniquely identify client subscription.
* @param [options] The parameter options
*/
constructor(credentials: msRest.ServiceClientCredentials, options?: Models.ImageSearchAPIClientOptions) {
if (credentials === null || credentials === undefined) {
throw new Error('\'credentials\' cannot be null.');
}

if (!options) {
options = {};
}

super(credentials, options);

this.baseUri = options.baseUri || this.baseUri || "https://api.cognitive.microsoft.com";
this.requestContentType = "application/json; charset=utf-8";
this.credentials = credentials;

this.addUserAgentInfo(`${packageName}/${packageVersion}`);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

export {
discriminators,
Images,
SearchResultsAnswer,
Answer,
Response,
Identifiable,
ResponseBase,
ImageObject,
MediaObject,
CreativeWork,
Thing,
ImagesImageMetadata,
AggregateOffer,
Offer,
Organization,
AggregateRating,
Rating,
PropertiesItem,
Query,
PivotSuggestions,
ErrorResponse,
ErrorModel,
ImageInsights,
ImageInsightsImageCaption,
RelatedCollectionsModule,
ImageGallery,
CollectionPage,
WebPage,
ImagesModule,
RelatedSearchesModule,
RecipesModule,
Recipe,
RecognizedEntitiesModule,
RecognizedEntityGroup,
RecognizedEntityRegion,
NormalizedRectangle,
StructuredValue,
Intangible,
RecognizedEntity,
ImageTagsModule,
InsightsTag,
TrendingImages,
TrendingImagesCategory,
TrendingImagesTile,
Person
} from "../models/mappers";

Loading