Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielsantoslima/buscame-api
:gear: Api que irá realizar o processamento de imagens e a busca por produtos utilizando a linguagem Kotlin e I.A.
https://github.com/gabrielsantoslima/buscame-api
api custom-search-google google-cloud-platform ibm-watson kotlin language-translation products
Last synced: about 10 hours ago
JSON representation
:gear: Api que irá realizar o processamento de imagens e a busca por produtos utilizando a linguagem Kotlin e I.A.
- Host: GitHub
- URL: https://github.com/gabrielsantoslima/buscame-api
- Owner: gabrielSantosLima
- Created: 2020-09-09T13:52:20.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-21T19:09:39.000Z (almost 4 years ago)
- Last Synced: 2023-03-09T23:46:00.918Z (over 1 year ago)
- Topics: api, custom-search-google, google-cloud-platform, ibm-watson, kotlin, language-translation, products
- Language: Kotlin
- Homepage:
- Size: 199 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Buscame API
Api que irá realizar o processamento e busca de produtos utilizando Kotlin e IA
## Tópicos
- Sobre
- Introdução
- Autores
- Instalação
- Objetivos
- Rotas
## Sobre
### Introdução
A API de busca irá permitir buscar produtos por texto ou imagem utilizando os serviços em nuvem do [IBM Watson](https://cloud.ibm.com/) e da [plataforma em nuvem da Google](https://console.cloud.google.com/?hl=pt-BR). Os serviços utizados foram:
- Para a pesquisa por produtos: [Custom Search API](https://developers.google.com/custom-search/v1/overview)
- Para a análise de imagens: [Visual Recognition](https://www.ibm.com/br-pt/cloud/watson-visual-recognition)
- Para a tradução dos termos: [Language Translator](https://www.ibm.com/watson/services/language-translator/)
### Autores
## Instalação
**Obs: Em ambiente de desenvolvimento**
- Clonar o projeto `git clone https://github.com/gabrielSantosLima/buscame-api`
- Criar credenciais em todos os serviços utilizados na API
- [Custom Search API](https://cloud.google.com/docs/authentication/api-keys?hl=pt-BR&visit_id=637441536431321652-2520210197&rd=1)
- [Visual Recognition e Language Translator](https://cloud.ibm.com/docs/watson?topic=watson-iam)
- Criar arquivo no diretório `src/main/resources/credentials.properties` com a seguinte estrutura:
```
#Visual Recognitions
VG_APIKEY=
#Custom Search API
CS_APIKEY=
CS_CONTEXTKEY=254b1bad154db7c85 # chave para teste do contexto de busca do robô de busca
#Language Translate
LT_APIKEY=
#Services URL
VG_URL=https://api.us-south.visual-recognition.watson.cloud.ibm.com
LT_URL=https://api.us-south.language-translator.watson.cloud.ibm.com
CS_URL=https://www.googleapis.com/customsearch/v1
```
- Executar projeto
## Funcionalidades
- Pesquisar produtos por imagem
- Pesquisar produtos por texto
- Aplicar alguns filtros de busca
- Por preço
- Por site
- Por marca
- Busca paginada
## Rotas
### POST
- `/api/search/text?text=`: busca por texto.
- `/api/search/image-analyse`: analisar uma imagem passando esta imagem do tipo `ByteArray` no corpo da requisição.
- `/api/search/image`: busca por imagem passando esta imagem do tipo `ByteArray` no corpo da requisição.
### Parâmetros (busca por texto e imagem)
- `brandName`: filtro de marca.
- `url`: filtro de url de site.
- `price`: filtro de preço.
- `page`: número da página de busca.
### Exemplo de Resultado (pesquisa por texto e imagem )
```json
[
{
"id": "30337640",
"term": "gato ",
"title": "Moletom 284 Gato | Netshoes",
"price": 229.99,
"description": "Moletom 284 Gato | Netshoes",
"url": "https://www.netshoes.com.br/moletom-284-gato-off+white-E97-0265-205",
"image": "https://static.netshoes.com.br/produtos/moletom-284-gato/05/E97-0265-205/E97-0265-205_zoom1.jpg?ims=544x"
}
]
```
### Exemplo de Resultado (analisar imagem)
```json
[
"cat",
"feline",
"carnivore",
"mammal",
"animal",
"tabby cat",
"domestic cat",
"wildcat",
"ash grey color"
]
```
