2.0info: 2.0.0 ML Datalake Service description: ML Datalake Service x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: ml_datalake_service contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ml_datalake_service/queries/getResult: post: description: Retorna resultados de predição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modelId – ticket properties: modelId: type: string description: Identificador do modelo ticket: type: string description: Código para consulta da execução responses: 200: description: Ok schema: type: object required: – jsonModelResult properties: jsonModelResult: type: string description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna resultados de predição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: modelId description: Identificador do modelo in: query required: true type: string – name: ticket description: Código para consulta da execução in: query required: true type: string responses: 200: description: Ok schema: type: object required: – jsonModelResult properties: jsonModelResult: type: string description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/squareMeterValuePrediction: post: description: Predição de valor por metro quadrado\n### Resources:\n- res://senior.com.br/platform/ml_datalake_service/mega-price-prediction\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – enterpriseNature – privateArea – zip – districtName properties: enterpriseNature: type: string description: Tipo do empreendimento privateArea: type: string description: Tamanho da área privada zip: type: string description: CEP districtName: type: string description: Bairro responses: 200: description: Ok schema: type: object required: – enterpriseNature – privateArea – zip – districtName – modelResponse properties: enterpriseNature: type: string description: Tipo do empreendimento privateArea: type: string description: Tamanho da área privada zip: type: string description: CEP districtName: type: string description: Bairro modelResponse: type: string description: Retorno do modelo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Usuário sem permissão default: description: Error response schema: #/definitions/genericError get: description: Predição de valor por metro quadrado\n### Resources:\n- res://senior.com.br/platform/ml_datalake_service/mega-price-prediction\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: enterpriseNature description: Tipo do empreendimento in: query required: true type: string – name: privateArea description: Tamanho da área privada in: query required: true type: string – name: zip description: CEP in: query required: true type: string – name: districtName description: Bairro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – enterpriseNature – privateArea – zip – districtName – modelResponse properties: enterpriseNature: type: string description: Tipo do empreendimento privateArea: type: string description: Tamanho da área privada zip: type: string description: CEP districtName: type: string description: Bairro modelResponse: type: string description: Retorno do modelo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Usuário sem permissão default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/jobClassification: post: description: Classificação de cargos HCM\n### Resources:\n- res://senior.com.br/platform/ml_datalake_service/hcm-job-title-classification\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – jobTitleDescription properties: jobTitleDescription: type: string description: Título do cargo responses: 200: description: Ok schema: type: object required: – jobTitleDescription – modelResponse properties: jobTitleDescription: type: string description: Título do cargo modelResponse: type: string description: Retorno do modelo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Usuário sem permissão default: description: Error response schema: #/definitions/genericError get: description: Classificação de cargos HCM\n### Resources:\n- res://senior.com.br/platform/ml_datalake_service/hcm-job-title-classification\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: jobTitleDescription description: Título do cargo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – jobTitleDescription – modelResponse properties: jobTitleDescription: type: string description: Título do cargo modelResponse: type: string description: Retorno do modelo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Usuário sem permissão default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/matcherRequestReady: post: description: Método para verificar se requisição ao Matcher Aderência foi finalizada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – requestId properties: requestId: type: string description: Id da requisição responses: 200: description: Ok schema: type: object required: – requestDone properties: requestDone: type: boolean description: Indica se requisição foi finalizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Método para verificar se requisição ao Matcher Aderência foi finalizada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: requestId description: Id da requisição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – requestDone properties: requestDone: type: boolean description: Indica se requisição foi finalizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/getMatcherAdherenceResults: post: description: Método para retornar os resultados da requisição ao Matcher Aderência tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – requestId properties: requestId: type: string description: Id da requisição responses: 200: description: Ok schema: type: object required: – results properties: results: type: string description: Resultado da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Método para retornar os resultados da requisição ao Matcher Aderência tags: – Queries x-senior-visibility: PUBLIC parameters: – name: requestId description: Id da requisição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – results properties: results: type: string description: Resultado da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/amlGetPredictionDataId: post: description: Método retorna um id para os dados de inferência assíncrona tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – predictionDataId properties: predictionDataId: type: string description: Id da requisição para inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Método retorna um id para os dados de inferência assíncrona tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – predictionDataId properties: predictionDataId: type: string description: Id da requisição para inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/exportAmlTrainingJob: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/exportAmlPredictionJob: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/exportMatcherAdherenceRequests: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/registerAsyncModel: post: description: Realiza chamada assíncrona ao modelo desejado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modelId – jsonModel properties: modelId: type: string description: Identificador do modelo jsonModel: type: string description: Json de entrada do modelo responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Código para consulta da execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/execModel: post: description: Executa predição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modelId – jsonModel properties: modelId: type: string description: Identificador do modelo jsonModel: type: string description: Json de entrada do modelo responses: 200: description: Ok schema: type: object required: – jsonModelResult properties: jsonModelResult: type: string description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/matcherAdherence: post: description: Predição do Matcher Aderência de cargos e candidatos. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – vaga – candidato properties: vaga: type: string format: byte description: JSON com a lista de vagas candidato: type: string format: byte description: JSON com a lista de candidatos responses: 200: description: Ok schema: type: object required: – requestId properties: requestId: type: string description: Id da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/matcherAdherenceDone: post: description: Método chamado por função Lambda quando termina a requisição ao Matcher Aderência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – requestId – status properties: tenantName: type: string description: Nome do tenant userName: type: string description: Nome do usuário requestId: type: string description: Id da requisição status: type: string allOf: – #/definitions/matcherAdherenceStatus description: Status da requisição errorMessage: type: string description: Mensagem de erro results: type: string description: Resultado da requisição responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/startMatcherPrediction: post: description: Método para iniciar a predição do Matcher misto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId – predictionDataId – vacancy properties: modelId: type: string description: Identificador do modelo predictionDataId: type: string description: Identificador dos dados para Inferência vacancy: type: string format: byte description: JSON com a lista de vagas numberCandidates: type: integer format: int64 description: Número de candidatos para retornar o resultado responses: 200: description: Ok schema: type: object required: – predictionJobName properties: predictionJobName: type: string description: Identificador da Inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/matcherCandidateTags: post: description: Lista de tags a partir de uma lista de candidatos. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – candidato properties: candidato: type: string format: byte description: JSON com a lista de candidatos responses: 200: description: Ok schema: type: object required: – tagsByCandidates properties: tagsByCandidates: type: string format: byte description: Lista de retorno com os candidatos e suas repectivas tags 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlCreateModel: post: description: Método para criar um modelo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelName – targetColumnName – onlyBatchPrediction properties: modelName: type: string description: Nome do modelo modelDescription: type: string description: Descrição do modelo targetColumnName: type: string description: Nome da coluna target projectName: type: string description: Nome de projeto, se necessário tratamento específico default: automl onlyBatchPrediction: type: boolean description: Opção indica se o modelo trata somente predições em lote responses: 200: description: Ok schema: type: object required: – modelId properties: modelId: type: string description: Identificador do modelo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlRequestUpload: post: description: Método para obter URL para upload dos dados (de treinamento ou inferência) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId – amlJobType properties: modelId: type: string description: Identificador do modelo amlJobType: type: string allOf: – #/definitions/amlJobType description: Tipo de tarefa (treinamento ou inferência) predictionDataId: type: string description: Identificador dos dados para predição responses: 200: description: Ok schema: type: object required: – dataUrl properties: dataUrl: type: string description: URL para upload dos dados dataPart: type: string description: Identificador de parte dos dados de inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlCompleteUpload: post: description: Método para notificar que upload foi finalizado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId – amlJobType properties: modelId: type: string description: Identificador do modelo amlJobType: type: string allOf: – #/definitions/amlJobType description: Tipo de tarefa (treinamento ou inferência) predictionDataId: type: string description: Identificador dos dados para predição dataPart: type: string description: Identificador de parte dos dados de inferência responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlGetDataset: post: description: Retorna url dos dados de treinamento ou inferência tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId – amlJobType properties: modelId: type: string description: Id do modelo amlJobType: type: string allOf: – #/definitions/amlJobType description: Tipo de tarefa (treinamento ou inferência) predictionDataId: type: string description: Identificador dos dados de inferência dataPart: type: string description: Identificador de parte dos dados de inferência responses: 200: description: Ok schema: type: object required: – datasetUrl properties: datasetUrl: type: string description: URL para arquivo .csv com os dados de treinamento ou inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlTrain: post: description: Executa pipeline de treino e teste tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId properties: modelId: type: string description: Identificador do modelo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlTrainingDone: post: description: Método chamado por função Lambda quando termina o treinamento do modelo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName – modelName – userName – status properties: tenantName: type: string description: Nome do tenant modelName: type: string description: Nome do modelo userName: type: string description: Nome do usuário status: type: string allOf: – #/definitions/amlModelTrainingStatus description: Status errorMessage: type: string description: Mensagem de erro metricsS3Path: type: string description: Caminho no s3 para arquivo .csv com métricas de teste responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlGetMetrics: post: description: Retorna url das métricas do modelo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId properties: modelId: type: string description: Identificador do modelo responses: 200: description: Ok schema: type: object required: – metricsUrl properties: metricsUrl: type: string description: URL para arquivo .csv com as métricas do modelo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlPredictNoWait: post: description: Executa predição/inferência assíncrona tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId – idColumn properties: modelId: type: string description: Identificador do modelo idColumn: type: boolean description: Identificador da coluna de IDs responses: 200: description: Ok schema: type: object required: – predictionJobName properties: predictionJobName: type: string description: Nome da chamada de inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlPredictNoWaitDone: post: description: Método chamado por função Lambda quando termina a chamada de inferência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName – predictionJobName – userName – predictionStatus properties: tenantName: type: string description: Nome do tenant predictionJobName: type: string description: Nome da chamada de inferência (nome do transform job retornado pelo evento na aws) userName: type: string description: Nome do usuário predictionStatus: type: string allOf: – #/definitions/amlModelPredictionStatus description: Status errorMessage: type: string description: Mensagem de erro resultsS3Path: type: string description: Caminho s3 para arquivo .csv com resultados de inferência responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlPredictWait: post: description: Executa predição/inferência síncrona tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – modelId – inputPayload properties: modelId: type: string description: Identificador do modelo inputPayload: type: string format: byte description: Payload responses: 200: description: Ok schema: type: object required: – resultsResponse properties: resultsResponse: type: string format: byte description: JSON com resultados de inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/amlGetResults: post: description: Retorna url dos resultados da inferência tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – predictionJobName properties: predictionJobName: type: string description: Nome do job de inferência responses: 200: description: Ok schema: type: object required: – resultsUrl properties: resultsUrl: type: string description: URL para arquivo .csv com resultados de inferência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/importAmlTrainingJob: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/importAmlPredictionJob: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/actions/importMatcherAdherenceRequests: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/matcherAdherenceReady: post: description: Notifica que a execução do matcher aderência foi finalizada. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – requestId – status properties: requestId: type: string description: Id da requisição status: type: string allOf: – #/definitions/matcherAdherenceStatus description: Status da requisição errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/amlModelTrainingDone: post: description: Notifica que o treinamento do modelo foi finalizado. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – modelName – status properties: modelName: type: string description: Nome do modelo status: type: string allOf: – #/definitions/amlModelTrainingStatus description: Status do treinamento do modelo errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/amlModelInferenceDone: post: description: Notifica que a inferência do modelo foi finalizada. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – predictionJobName – status properties: predictionJobName: type: string description: Nome da chamada da inferência status: type: string allOf: – #/definitions/amlModelPredictionStatus description: Status da inferência do modelo errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/importAmlTrainingJobEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/exportAmlTrainingJobEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/importAmlPredictionJobEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/exportAmlPredictionJobEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/importMatcherAdherenceRequestsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/events/exportMatcherAdherenceRequestsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/amlTrainingJob: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/amlTrainingJob responses: 200: description: The created resource schema: #/definitions/amlTrainingJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/amlTrainingJob responses: 200: description: The created resource schema: #/definitions/amlTrainingJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/amlTrainingJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/amlTrainingJob/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAmlTrainingJob responses: 200: description: Ok schema: #/definitions/editAmlTrainingJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/amlTrainingJob responses: 200: description: Ok schema: #/definitions/amlTrainingJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/amlTrainingJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/amlTrainingJob/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/amlTrainingJob responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/amlPredictionJob: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/amlPredictionJob responses: 200: description: The created resource schema: #/definitions/amlPredictionJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/amlPredictionJob responses: 200: description: The created resource schema: #/definitions/amlPredictionJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/amlPredictionJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/amlPredictionJob/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAmlPredictionJob responses: 200: description: Ok schema: #/definitions/editAmlPredictionJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/amlPredictionJob responses: 200: description: Ok schema: #/definitions/amlPredictionJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/amlPredictionJob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/amlPredictionJob/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/amlPredictionJob responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/matcherAdherenceRequests: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/matcherAdherenceRequests responses: 200: description: The created resource schema: #/definitions/matcherAdherenceRequests 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/matcherAdherenceRequests responses: 200: description: The created resource schema: #/definitions/matcherAdherenceRequests 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/matcherAdherenceRequests 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/matcherAdherenceRequests/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editMatcherAdherenceRequests responses: 200: description: Ok schema: #/definitions/editMatcherAdherenceRequests 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/matcherAdherenceRequests responses: 200: description: Ok schema: #/definitions/matcherAdherenceRequests 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/matcherAdherenceRequests 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ml_datalake_service/entities/matcherAdherenceRequests/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/matcherAdherenceRequests responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: amlModelTrainingStatus: type: string enum: – No_Training_Data – Waiting – Training – Ready – Failed description: Status do treinamento do modelo: * `No_Training_Data` – Sem dados de treinamento * `Waiting` – Aguardando * `Training` – Treinando * `Ready` – Disponível * `Failed` – Falha por alguma razão amlModelPredictionStatus: type: string enum: – No_Prediction_Data – Waiting – Executing – Completed – Cancelled – Error – Failed – Invalid description: Status da execução de inferência: * `No_Prediction_Data` – Sem dados de inferência * `Waiting` – Aguardando * `Executing` – Executando * `Completed` – Completo * `Cancelled` – Cancelado * `Error` – Erro de execução * `Failed` – Falha por causa dos parâmetros * `Invalid` – Inválido amlJobType: type: string enum: – Training – Inference description: Tipo de tarefa: * `Training` – Treinamento * `Inference` – Inferência amlPredictorType: type: string enum: – Tabular – Image – Text description: Tipo do modelo preditor: * `Tabular` – Dados tabulares * `Image` – Imagem * `Text` – Texto amlPredictionJobType: type: string enum: – Wait – No_Wait description: Tipo de inferência: * `Wait` – Síncrono * `No_Wait` – Assíncrono matcherAdherenceStatus: type: string enum: – Executing – Completed – Failed description: Status da requisição ao Matcher Aderência: * `Executing` – Executando * `Completed` – Finalizado * `Failed` – Falha por alguma razão userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim amlTrainingJob: description: Modelos treinados do AutoML type: object required: – modelName – predictorType – targetColumnName – amlModelTrainingStatus – onlyBatchPrediction properties: id: type: string format: uuid description: PK modelName: type: string maxLength: 20 description: Nome do modelo modelDescription: type: string maxLength: 1000 description: Descrição problemType: type: string maxLength: 100 description: Tipo de Problema featureColumns: type: string maxLength: 10000 description: Features do Modelo predictorType: type: string allOf: – #/definitions/amlPredictorType description: Tipo do modelo preditor targetColumnName: type: string maxLength: 60 description: Nome da variável target amlModelTrainingStatus: type: string allOf: – #/definitions/amlModelTrainingStatus description: Status do treinamento do modelo amlPredictionJob: type: array items: type: object allOf: – #/definitions/amlPredictionJob description: Identificador de inferência metricsPath: type: string maxLength: 1000 description: Caminho no s3 do csv com as métricas de teste errorMessage: type: string maxLength: 1000 description: Mensagem de erro onlyBatchPrediction: type: boolean description: Opção indica se o modelo trata somente predições em lote projectName: type: string maxLength: 10000 description: Nome do projeto createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAmlTrainingJob: type: object required: – id allOf: – #/definitions/amlTrainingJob amlPredictionJob: description: Inferências dos modelos do AutoML type: object required: – predictionJobType – predictionStatus properties: id: type: string format: uuid description: PK predictionJobName: type: string maxLength: 1000 description: Nome do job de inferência predictionJobType: type: string allOf: – #/definitions/amlPredictionJobType description: Tipo do job de inferência trainingJobId: type: object allOf: – #/definitions/amlTrainingJob description: Identificador do modelo predictionStatus: type: string allOf: – #/definitions/amlModelPredictionStatus description: Status da execução de inferência resultsPath: type: string maxLength: 1000 description: Caminho no s3 do csv com os resultados de inferência errorMessage: type: string maxLength: 1000 description: Mensagem de erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAmlPredictionJob: type: object required: – id allOf: – #/definitions/amlPredictionJob matcherAdherenceRequests: description: Requisições feitas ao matcher aderência type: object required: – requestId – requestStatus properties: id: type: string format: uuid description: PK requestId: type: string description: Identificador da requisição requestStatus: type: string allOf: – #/definitions/matcherAdherenceStatus description: status results: type: string description: Resultados da requisição errorMessage: type: string maxLength: 1000 description: Mensagem de erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMatcherAdherenceRequests: type: object required: – id allOf: – #/definitions/matcherAdherenceRequests notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage