Nossa RESTful API permite você enviar um texto, e receber de volta um objeto JSON com todas as informações que você precisa.
\nFizemos a nossa API pensando em facilidade pra você. Nosso objetivo é que com uma simples requisição HTTP, você consiga extrair dados importantes de qualquer texto!
\nAbaixo você terá um breve overview de como implementar nossa API, e depois uma descrição mais abrangente sobre cada detalhe da implementação.
\nVocê vai ver que nossa API é muito fácil de ser implementada!
\nVeja como é fácil e rápido implementar:
\nAPI Key Mais abaixo estão todos os detalhes sobre a API Key.JSON com os dados da análise que você deseja realizar. Ou seja: o seu texto, e as features que você quer executar.POST, passando estes dados.Pronto! No retorno desta requisição estarão todas as informações da sua análise.
\nPara manter extrema simplicidade, utilizamos apenas 1 endpoint! Basta você fazer uma requisição HTTP utilizando o método POST para o endpoint (URL):
https://api.gotit.ai/NLU/v1.5/Analyze\nPara unir o máximo de desenvolvimento e ao mesmo tempo garantir estabilidade, utilizamos o sistema de versioning diretamente na URL do EndPoint. Veja que no exemplo acima, está especificada a versão mais recente atual: v1.5.
Se nenhuma versão for especificada a execução será realizada utilizando a versão mais antiga não obsoleta (atualmente v1.1). Exemplo:
https://api.gotit.ai/NLU/Analyze\n
Se apenas a versão principal for especificada sem a secundária, a execução será realizada utilizando a versão principal especificada e a secundária mais antiga não obsoleta (para a v1: atualmente v1.1). Exemplo:
https://api.gotit.ai/NLU/v1/Analyze\n
Atenção: Atualmente a versão mais atual é a v1.5. Recomendamos que você sempre especifique a versão exata para garantir máxima estabilidade. Também fique atento ao nosso blog, emails e a newsletter da Got It AI. Através deles, te manteremos informados sobre os avanços na nossa tecnologia e novas versões disponíveis!
Não serão aceitas requisições utilizando método GET, ou outro método que não seja POST. Requisições para este endpoint que não utilizem o método POST, receberão como resposta o código de status HTTP 401 Unauthorized, indicando erro de acesso não autorizado.
Todas as requisições devem ser realizadas utilizando o \"protocolo\" HTTPS. Requisições que forem feitas apenas com o protocolo HTTP, sem utilizar conexão segura, receberão como resposta o código de status HTTP 401 Unauthorized, indicando erro de acesso não autorizado.
Toda requisição precisa ser autenticada. Para isso você vai passar sua API Key em cada requisição que fizer. Abaixo explico o que é uma API Key, como você consegue ela, e como você coloca ela na sua requisição.
Para você que é expert, vou dar uma explicação mais direta: você vai utilizar o esquema Basic Authentication do protocolo HTTP, passando sua API Key, no header Authorization da requisição.
A API Key, ou Chave de API é a sua credencial de acesso, como uma senha, exclusivamente utilizada para executar a análise na nossa API.
A sua API Key é diferente da sua senha de acesso no Got It AI. Sua senha de acesso é exclusiva para administrar a sua conta no Got It AI. A sua API Key é uma outra credencial, separada, que é a única credencial que você vai passar para a nossa API, na sua requisição.
Cada API Key é composta por um par de strings, como se fosse \"usuário e senha\". A API Key é composta pelo par:
API Key, como se fosse um usuário/loginAPI Key, como se fosse a senhaExemplo de API Key:
Identifier: 86-jIqiXoug\nSecret: soOW1VchGaSMYIKwE4tr5q5KmjGb4uCvft2CFuSg\nEssa API Key de exemplo será utilizada diversas vezes durante a documentação. Sua API Key será semelhante a ela. Você pode utilizar todos os exemplos desta documentação apenas substituindo a API Key de exemplo pela sua API Key.
Ao se cadastrar no site do Got It AI, você receberá duas credenciais diferentes. A primeira é a senha para administrar a sua conta no nosso site. A segunda será a sua API Key.
Você também poderá criar novas API Keys, ou até mesmo revogar alguma API Key comprometida na área administrativa do nosso site.\nEsta área estará disponível embreve. Aguarde.
Enquanto a área administrativa não está disponível, sinta-se a vontade para entrar em contato com nosso suporte técnico para pedir novas API Keys, ou revogar alguma que esteja comprometida.
Escolhemos utilizar a autenticação com API Keys, por permitir duas coisas muito importantes:
API Key são credenciais diferentes. API Key será utilizada. Se por alguma razão alguém acessar esta credencial, suas informações na conta do Got It AI estarão seguras.API Key !API Key para cada aplicação diferente sua que acesse nossa API. Deste modo, se uma aplicação sua for comprometida, apenas essa API Key estará comprometida, e apenas ela será revogada. Assim, todas as suas outras API Keys e as aplicações que as utilizam estarão seguras, e não sofreram downtime.Para autenticar sua requisição você vai utilizar o header Authorization, na sua requisição HTTP. Este header pode ser utilizado com vários esquemas diferentes, mas para nossa API vamos utilizar o mais simples e fácil deles: o tipo Basic Authentication.
Utilizar o Basic Authentication no header Authorization é muito fácil.\nVocê vai definir o valor do seu header Authorization para Basic <sua API KEY convertida para Base64>.
Ou seja, você vai escrever literalmente Basic , incluindo o espaço no final, mais a sua API Key (Identifier e Secret, concatenados com um : entre eles), convertida para Base64.
API Key de exemplo:
Identifier: 86-jIqiXoug\nSecret: soOW1VchGaSMYIKwE4tr5q5KmjGb4uCvft2CFuSg\nVocê vai juntar o usuário e senha (neste caso Identifier e Secret, respectivamente), utilizando um : (dois pontos) entre os dois. Fica assim:
86-jIqiXoug:soOW1VchGaSMYIKwE4tr5q5KmjGb4uCvft2CFuSg
Agora basta converter essa string para base64. Fica assim:
\n`ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==`\nBasic (incluindo o espaço) com a API Key convertida. Fica assim:`Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==`\nAuthorization com o valor do passo 3 durante a construção da sua requisição. Este header na sua requisição HTTP POST fica assim:`Authorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==`\nPronto! Sua requisição está autenticada!
\nO esquema Basic Authentication padrão funciona com usuário e senha, concatenados utilizando um : (dois pontos) entre eles. Na nossa implementação, o equivalente para o usuário é o API Key Identifier e o equivalente para a senha é o API Key Secret.
Se você não conhece o esquema de Basic Authentication do header Authorization basta pesquisar no Google estes termos. Existem explicações excelentes que com certeza vão tirar qualquer dúvida que você tenha.
Se você não sabe ou tem dúvidas de como implementar no código a construção da requisição HTTP POST, definindo o header Authorization, disponibilizamos excelentes exemplos de código na nossa página da Got It AI - API. E claro: você também sempre pode pesquisar no Google como criar uma requisição POST, e como definir o header Authorization especificamente para sua linguagem de programação. São termos muitos simples, com muito material a respeito deles.
Nossos níveis de serviço atenderão os seguintes determinações mínimas:
\n99,9% de uptime de disponibilidade online.
\nRequisições com o texto até 5mil caracteres, análise em no máximo 5 segundos.
\nRequisições com o texto até 50mil caracteres, análise em no máximo 20 segundos.
\nRequisições com o texto até 100mil caracteres, análise em no máximo 52 segundos.
\nRequisições que não forem atendidas dentro desse SLA não serão consideradas a título de cobrança. Latência de rede não incluída no cálculo.
\nNossa API funciona com a execução de Features. Cada feature executa uma análise diferente, e retorna dados próprios dela. Você especificará no objeto JSON que estiver postando, quais são as features que deseja executar.
Abaixo há alguns exemplos de código em diferentes linguagens, para que você possa começar a usar a nossa API agora mesmo! Basta apenas copiar e colar, inserindo o seu texto e as Features desejadas, e editar as credenciais inserindo a sua própria API Key (trocando #APIKey_Identifier# pela sua API Key Identifier e #APIKey_Secret# com a sua API Key Secret), e pronto!
import json\nimport requests\nimport pprint\nimport base64\n\nurl = 'https://api.gotit.ai/NLU/v1.5/Analyze'\ndata = {\"T\":\"Victor comeu uma pizza deliciosa.\",\"S\":true}\ndata_json = json.dumps(data)\nuserAndPass = base64.b64encode(b\"#APIKey_Identifier#:#APIKey_Secret#\").decode(\"ascii\")\nheaders = {'Content-type': 'application/json', \"Authorization\": \"Basic %s\" % userAndPass}\nresponse = requests.post(url, data=data_json, headers=headers)\npprint.pprint(response.json())\nstatic async Task MainAsync()\n{\n // ... using HttpClient.\n HttpClient client = new HttpClient();\n\n var byteArray = Encoding.ASCII.GetBytes(\"#APIKey_Identifier#:#APIKey_Secret#\");\n client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(byteArray));\n\n var data = new { T = \"Victor comeu uma pizza deliciosa.\", S = true };\n var content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, \"application/json\");\n\n HttpResponseMessage response = await client.PostAsync(\"https://api.gotit.ai/NLU/v1.5/Analyze\", content);\n HttpContent responseContent = response.Content;\n\n // ... Check Status Code \n Console.WriteLine(\"Response StatusCode: \" + (int)response.StatusCode);\n\n // ... Read the string.\n string result = await responseContent.ReadAsStringAsync();\n}\npublic static void main(String[] args) throws ClientProtocolException, IOException, JSONException {\n String url = \"https://api.gotit.ai/NLU/v1.5/Analyze\";\n\n HttpClient client = HttpClientBuilder.create().build();\n HttpPost post = new HttpPost(url);\n\n String authString = \"#APIKey_Identifier#\" + \":\" + \"#APIKey_Secret#\";\n String authStringEnc = new String(Base64.getEncoder().encodeToString(authString.getBytes()));\n\n post.addHeader(\"Content-Type\",\"application/json\");\n post.addHeader(\"Authorization\",\"Basic \" + authStringEnc);\n\n JSONObject data = new JSONObject();\n data.put(\"T\", \"Victor comeu uma pizza deliciosa.\"); \n data.put(\"S\", true); \n\n post.setEntity(new StringEntity(data.toString(), ContentType.APPLICATION_JSON));\n\n HttpResponse response = client.execute(post);\n\n BufferedReader rd = new BufferedReader(new InputStreamReader(response.getEntity().getContent()));\n\n StringBuffer result = new StringBuffer();\n String line = \"\";\n while ((line = rd.readLine()) != null) {\n result.append(line);\n }\n\n System.out.println(result.toString());\n}\n$headers = array(\n \"Content-type: application/json\",\n \"Authorization: Basic \". base64_encode(\"#APIKey_Identifier#:#APIKey_Secret#\")\n);\n\n$data_array = array();\n$data_array [\"T\"] = \"Victor comeu uma pizza deliciosa.\";\n$data_array [\"S\"] = true;\n$data = json_encode($data_array );\n\n$options = array (\n 'http' => array (\n 'header' => $headers,\n 'method' => 'POST',\n 'content' => $data\n )\n);\n$context = stream_context_create ($options);\n$result = file_get_contents ('https://api.gotit.ai/NLU/v1.5/Analyze', false, $context);\n\n$result = json_decode($result, true);\nrequire 'net/http'\nrequire 'uri'\n\nuri = URI.parse(\"https://api.gotit.ai/NLU/v1.5/Analyze\")\nrequest = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')\nrequest.basic_auth(\"#APIKey_Identifier#\", \"#APIKey_Secret#\")\nrequest.body = {T: 'Victor comeu uma pizza deliciosa.', S: true}.to_json\n\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == \"https\") do |http|\nhttp.request(request)\n\nend\nAbaixo estão exemplos de como criar a requisição, e executar features desejadas:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Implementação","slug":"implementacao"},{"content":"EndPoint","slug":"endpoint"},{"content":"Autenticação","slug":"autenticacao"},{"content":"SLA","slug":"sla"},{"content":"Features","slug":"features"},{"content":"Exemplos de Código","slug":"exemplos-de-codigo"}],"owner":"4456678","collectionId":"a7cd816a-547c-4a54-8f92-676a4db3c4c2","publishedId":"RWaHyVMX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-09-12T11:04:20.000Z"},"item":[{"name":"Sentimentos","id":"9d510e9f-6e01-4809-94eb-033cb6b1cc44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw=="}],"body":{"mode":"raw","raw":"{\n \"T\": \"Eu não gostei do hotel. A cama era ruim.\",\n \"S\": true\n}"},"url":"https://api.gotit.ai/NLU/v1.5/Analyze","description":"Para realizar uma análise do sentimento do texto, basta realizar a requisição HTTPS, pelo método POST, enviando no corpo (body) da requisição o objeto JSON de exemplo, passando 2 parametros:
T - Que é o texto em encoding UTF8\n
\nS - Defina o valor deste parametro como true, para a execução da feature de Sentimentos.
Abaixo está um exemplo completo da requisição:
\nPOST /NLU/v1.5/Analyze HTTP/1.1\nHost: api.gotit.ai\nContent-Type: application/json\nAuthorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==\n\n{\n \"T\": \"Eu não gostei do hotel. A cama era ruim.\",\n \"S\": true\n}\nPara realizar uma análise de emoções do texto, basta realizar a requisição HTTPS, pelo método POST, enviando no corpo (body) da requisição o objeto JSON de exemplo, passando 2 parametros:
T - Que é o texto em encoding UTF8\n
\nEM - Defina o valor deste parametro como true, para a execução da feature de Emoções.
Abaixo está um exemplo completo da requisição:
\nPOST /NLU/v1.5/Analyze HTTP/1.1\nHost: api.gotit.ai\nContent-Type: application/json\nAuthorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==\n\n{\n \"T\": \"Eu não gostei do hotel. A cama era ruim.\",\n \"EM\": true\n}\nPara realizar uma análise das entidades do texto, basta realizar a requisição HTTPS, pelo método POST, enviando no corpo (body) da requisição o objeto JSON de exemplo, passando 2 parametros:
T - Que é o texto em encoding UTF8\n
\nE - Defina o valor deste parametro como true, para a execução da feature de Entidades.
Abaixo está um exemplo completo da requisição:
\nPOST /NLU/v1.5/Analyze HTTP/1.1\nHost: api.gotit.ai\nContent-Type: application/json\nAuthorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==\n\n{\n \"T\": \"O Victor comprou um carro novo, em Curitiba\",\n \"E\": true\n}\nPara cada ocorrencia de uma entidade identificada dentro do texto, haverá um registro no retorno, contendo seu tipo, e o texto original no qual a entidade foi identificada. Os possíveis tipos de entidades retornadas atualmente (para a versão 1.5) são:
\nPERSON
LOCATION
ORGANIZATION
DATE
EVENT
CONSUMER_GOOD
OTHER
UNKNOWN
Também é possível realizar a análise das emoções e sentimento de uma entidade. Para isto, basta executar as features de Emoção e/ou Sentimento juntamente com a feature de Entidades, passando os parâmetros E para Entidade, S para Sentimento e EM para Emoções, todos na mesma requisição, além do parâmtro T que define o texto a ser análisado. Mais abaixo estão disponíveis maiores informações sobre como realizar a execução de Multiplas Features.
Você também poderá realizar a análise de várias features para um mesmo texto, em apenas uma requisição. Basta realizar a requisição HTTPS, pelo método POST, enviando no corpo (body) da requisição o objeto JSON de exemplo, o parametro de texto ( T ) como especificado abaixo, e mais os parametros relativos a cada feature que você deseja. No caso, este exemplo utilizará as 2 features disponíveis no momento que são Sentimento e Emoções. Veja o exemplo:
T - Que é o texto em encoding UTF8\n
\nS - Defina o valor deste parametro como true, para a execução da feature de Sentimentos.\n
\nEM - Defina o valor deste parametro como true, para a execução da feature de Emoções.
Abaixo está um exemplo completo da requisição:
\nPOST /NLU/v1.5/Analyze HTTP/1.1\nHost: api.gotit.ai\nContent-Type: application/json\nAuthorization: Basic ODYtaklxaVhvdWc6c29PVzFWY2hHYVNNWUlLd0U0dHI1cTVLbWpHYjR1Q3ZmdDJDRnVTZw==\n\n{\n \"T\": \"Eu não gostei do hotel. A cama era ruim.\",\n \"S\": true,\n \"EM\": true\n}\n