Busca de Jurisprudência Trabalhista no Brasil · Actions GPT

{
  "openapi": "3.1.0",
  "info": {
    "title": "Custom GPT API",
    "version": "1.0.0",
    "description": "API para a ação GetJUR"
  },
  "servers": [
    {
      "url": "https://c4bb-177-205-166-194.ngrok-free.app",
      "description": "Servidor principal"
    }
  ],
  "paths": {
    "/getjur": {
      "get": {
        "summary": "Esta ação pesquisa no portal LexML as jurisprudências trabalhistas solicitadas pelo usuário do gpt customizado, via uma API disponibilizada.",
        "operationId": "getJurInformation",
        "parameters": [
          {
            "name": "fragmento",
            "description": "Fragmento de texto, como uma ou mais palavras, passado no prompt do usuário para pesquisa na ementa (description) da jurisprudência. O usuário tem a opção de passar um fragmento de texto único ou múltiplos fragmentos de texto em seu prompt",
            "in": "query",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "examples": {
              "exemplo1": {
                "summary": "Exemplo de fragmento único de texto que pode ter mais de uma palavra",
                "value": [
                  "horas extras"
                ]
              },
              "exemplo2": {
                "summary": "Exemplo de múltiplos fragmentos de textos que são concatenados em um unica string e delimitados pelo delimitador %26%26%26. Exemplo com quatro fragmentos de texto",
                "value": [
                  "equiparação salarial",
                  "adicional noturno",
                  "horas extras",
                  "FGTS"
                ]
              }
            }
          },
          {
            "name": "hashcode",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "hashcode para a exclusão do diretório de pesquisa anteriormente realizada",
            "examples": {
              "exemplo1": {
                "summary": "Exemplo de hashcode preenchido com vazio quando placeholder {hashcode} não tem nenhum valor preenchido",
                "value": "vazio"
              },
              "exemplo2": {
                "summary": "Exemplo de hashcode recuperado com valor do placeholder {hashcode}",
                "value": "006d4c9b-180e-4482-8b4d-ef2a0e0e5a53"
              }
            }
          },
          {
            "name": "ano_inicial",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "example": 2021
            },
            "description": "Ano inicial das jurisprudências a serem pesquisadas.Deve ser um número no formato yyyy"
          },
          {
            "name": "autoridadeQ",
            "in": "query",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AutoridadeKeywordEnum"
              }
            },
            "description": "Nome da(s) autoridade(s) relativa à pesquisa a ser realizada",
            "examples": {
              "exemplo1": {
                "summary": "Exemplo de uma única autoridade passada no prompt do usuário",
                "value": [
                  "Tribunal Regional do Trabalho"
                ]
              },
              "exemplo2": {
                "summary": "Exemplo de múltiplas autoridades passadas no prompt do usuário",
                "value": [
                  "Superior Tribunal Federal",
                  "Tribunal Superior do Trabalho",
                  "Tribunal Regional do Trabalho"
                ]
              }
            }
          },
          {
            "name": "localidadeQ",
            "in": "query",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/LocalidadeKeywordEnum"
              }
            },
            "description": "Nome do(s) estado(s) ou país(es) onde está localizado a respectiva autoridade da pesquisa a ser realizada",
            "examples": {
              "exemplo1": {
                "summary": "Exemplo de uma única localidade passada pelo GPT customizado com base no tribunal passado no prompt do usuário",
                "value": [
                  "Rio de Janeiro"
                ]
              },
              "exemplo2": {
                "summary": "Exemplo de multiplas localidaded passadas pelo GPT customizado com base nod tribunais passadod no prompt do usuário",
                "value": [
                  "Brasil",
                  "Minas Gerais",
                  "Rio de Janeiro"
                ]
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Resposta com sucesso",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          },
          "500": {
            "description": "Resposta com erros",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/getpag": {
      "get": {
        "summary": "Paginar sobre pesquisa de jurisprudência previamente realizada",
        "operationId": "getPagination",
        "parameters": [
          {
            "name": "hashcode",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "hashcode para identificação de diretório de pesquisa anterior"
          },
          {
            "name": "start_index",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "valor do placeholder {start_index}"
          },
          {
            "name": "direction",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "direção da paginação que só poderá ser Avançar ou Retroceder ou IrPara"
          }
        ],
        "responses": {
          "200": {
            "description": "Resposta com sucesso",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          },
          "500": {
            "description": "Resposta com erros",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "SearchResponse": {
        "type": "object",
        "properties": {
          "chunk_index": {
            "type": "integer"
          },
          "total_chunks": {
            "type": "integer"
          },
          "hashcode": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "estatisticas": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "tribunal": {
                  "type": "string",
                  "example": "Supremo Tribunal Federal Brasil"
                },
                "qt_juris": {
                  "type": "string",
                  "example": "150"
                },
                "pagina": {
                  "type": "string",
                  "example": "3"
                },
                "pos_pag": {
                  "type": "string",
                  "example": "45"
                }
              }
            }
          }
        },
        "required": [
          "chunk_index",
          "total_chunks",
          "hashcode",
          "url",
          "estatisticas"
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        },
        "required": [
          "error"
        ]
      },
      "LocalidadeKeywordEnum": {
        "description": "Todos os tipos possíveis de string para localidade de um Tribunal",
        "type": "string",
        "enum": [
          "Rio de Janeiro",
          "Minas Gerais",
          "Brasil"
        ],
        "title": "LocalidadeKeywordEnum"
      },
      "AutoridadeKeywordEnum": {
        "description": "Todos os tipos possíveis de string para autoridade de um Tribunal",
        "type": "string",
        "enum": [
          "Tribunal Regional do Trabalho",
          "Superior Tribunal Federal",
          "Tribunal Superior do Trabalho"
        ],
        "title": "LocalidadeKeywordEnum"
      }
    }
  }
}