Plataforma (platform)

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: api.senior.com.br /platform/ml_datalake_servicesecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /getMatcherAdherenceResults: post: description: Método para retornar os resultados da requisição ao Matcher Aderência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError get: description: Método para retornar os resultados da requisição ao Matcher Aderência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError /squareMeterValuePrediction: post: description: Predição de valor por metro quadrado ### Resources: - res://senior.com.br/platform/ml_datalake_service/mega-price-prediction x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 403: description: Usuário sem permissão 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Predição de valor por metro quadrado ### Resources: - res://senior.com.br/platform/ml_datalake_service/mega-price-prediction x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 403: description: Usuário sem permissão 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /amlCompleteUpload: post: description: Método para notificar que upload foi finalizado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – modelId – amlJobType properties: modelId: type: string description: Identificador do modelo amlJobType: #/definitions/amlJobType 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 default: description: Error response schema: #/definitions/genericError /amlRequestUpload: post: description: Método para obter URL para upload dos dados (de treinamento ou inferência) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – modelId – amlJobType properties: modelId: type: string description: Identificador do modelo amlJobType: #/definitions/amlJobType 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 default: description: Error response schema: #/definitions/genericError /jobClassification: post: description: Classificação de cargos HCM ### Resources: - res://senior.com.br/platform/ml_datalake_service/hcm-job-title-classification x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 403: description: Usuário sem permissão 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Classificação de cargos HCM ### Resources: - res://senior.com.br/platform/ml_datalake_service/hcm-job-title-classification x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 403: description: Usuário sem permissão 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /amlGetMetrics: post: description: Retorna url das métricas do modelo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError /amlPredictNoWait: post: description: Executa predição/inferência assíncrona x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError /amlGetPredictionDataId: post: description: Método retorna um id para os dados de inferência assíncrona x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError get: description: Método retorna um id para os dados de inferência assíncrona x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError /amlGetDataset: post: description: Retorna url dos dados de treinamento ou inferência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – modelId – amlJobType properties: modelId: type: string description: Id do modelo amlJobType: #/definitions/amlJobType 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 default: description: Error response schema: #/definitions/genericError /matcherRequestReady: post: description: Método para verificar se requisição ao Matcher Aderência foi finalizada x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError get: description: Método para verificar se requisição ao Matcher Aderência foi finalizada x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError /amlTrain: post: description: Executa pipeline de treino e teste x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – modelId properties: modelId: type: string description: Identificador do modelo responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /amlPredictWait: post: description: Executa predição/inferência síncrona x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – modelId – inputPayload properties: modelId: type: string description: Identificador do modelo inputPayload: type: string description: Payload responses: 200: description: Ok schema: type: object required: – resultsResponse properties: resultsResponse: type: string description: JSON com resultados de inferência default: description: Error response schema: #/definitions/genericError /amlGetResults: post: description: Retorna url dos resultados da inferência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 default: description: Error response schema: #/definitions/genericError /amlCreateModel: post: description: Método para criar um modelo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 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 default: description: Error response schema: #/definitions/genericError /startMatcherPrediction: post: description: Método para iniciar a predição do Matcher misto x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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 description: JSON com a lista de vagas numberCandidates: type: integer 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 default: description: Error response schema: #/definitions/genericError /matcherAdherence: post: description: Predição do Matcher Aderência de cargos e candidatos. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – vaga – candidato properties: vaga: type: string description: JSON com a lista de vagas candidato: type: string 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 default: description: Error response schema: #/definitions/genericError /matcherCandidateTags: post: description: Lista de tags a partir de uma lista de candidatos. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – candidato properties: candidato: type: string description: JSON com a lista de candidatos responses: 200: description: Ok schema: type: object required: – tagsByCandidates properties: tagsByCandidates: type: string description: Lista de retorno com os candidatos e suas repectivas tags default: description: Error response schema: #/definitions/genericError /matcherAdherenceReady: post: description: Notifica que a execução do matcher aderência foi finalizada. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – requestId – status properties: requestId: type: string description: Id da requisição status: #/definitions/matcherAdherenceStatus errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /amlModelTrainingDone: post: description: Notifica que o treinamento do modelo foi finalizado. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – modelName – status properties: modelName: type: string description: Nome do modelo status: #/definitions/amlModelTrainingStatus errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /amlModelInferenceDone: post: description: Notifica que a inferência do modelo foi finalizada. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – predictionJobName – status properties: predictionJobName: type: string description: Nome da chamada da inferência status: #/definitions/amlModelPredictionStatus errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: amlModelTrainingStatus: type: string enum: – No_Training_Data – Waiting – Training – Ready – Failed amlModelPredictionStatus: type: string enum: – No_Prediction_Data – Waiting – Executing – Completed – Cancelled – Error – Failed – Invalid amlJobType: type: string enum: – Training – Inference matcherAdherenceStatus: type: string enum: – Executing – Completed – Failed genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE