Skip to content

Commit ef19564

Browse files
authored
Update README.me
1 parent a5718c3 commit ef19564

1 file changed

Lines changed: 6 additions & 40 deletions

File tree

README.md

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,14 @@ Projeto pensado para classificar as ementas de decisões extraídas das páginas
88
Os dados de retorno podem ser ```bool```, ```string``` ou ```Infered_decision```, essa última é composta por:
99

1010
```
11-
type Infered_decision struct {
12-
Summary string `json:"summary,omitempty"`
13-
Text string `json:"text,omitempty"`
14-
Class string `json:"classificcao,omitempty"`
15-
Identifier string `json:"Identifier,omitempty"`
16-
Court string `json:"Court,omitempty"`
11+
type InferredDecision struct {
12+
Summary string `json:"summary,omitempty"`
13+
Class string `json:"classificcao,omitempty"`
1714
}
1815
```
1916

2017
- Summary: Ementa ou trecho de decisão para classificar
21-
- Text: Trecho de texto selecionado pelo classificador
2218
- Class: A classificação feita (ver a seção "Categorias" abaixo)
23-
- Identifier: Um identificador. É recomendado que seja utilizado o número do CNJ que a ementa está conectada para facilitar o cruzamento de dados
24-
- Court: O tribunal do qual a ementa foi extraída
2519

2620
## Categorias
2721
- Prejudicado
@@ -30,7 +24,6 @@ type Infered_decision struct {
3024
- Parcial Provimento
3125
- Improvimento
3226
- Provimento
33-
- Sem Ementa
3427
- Casos não mapeados
3528

3629
## Example
@@ -76,36 +69,9 @@ Files created
7669
```
7770

7871
## Functions
79-
80-
Main Function:
81-
- Decision_Classifier(summary string, identifier string, court string) -> retorna uma *Infered_decision* necessitantando da ementa, identificador, tribunal. Essa função faz um uso em laço da *ClassDecision*, iniciando com 16 caracteres, até a totalidade de caracteres da ementa para classificar o texto.
82-
- SummaryClassifierCSV(rawPath string, separator rune, resultFolder string)-> retorna um CSV para uma pasta do projeto com o nome apontado em *resultFolder*. Para utilizar a função basta apontar o caminho do CSV (que deve ter a sequência de colunas {id, identifier, decision, court}) e o separador (';' ',' etc..)
83-
84-
Decision Function:
85-
- ClassDecision(summary string, identifier string, court string, char int) -> retorna uma *Infered_decision* necessitantando da ementa, identificador, tribunal e número de caracteres a serem analisados na ementa (de trás para frente).
86-
87-
Suport Functions:
88-
- Affected(text string, char int) -> retorna true para uma ementa *prejudicada*
89-
- Diligence(text string, char int) -> retorna true para uma ementa *convertida em diligência*
90-
- ExOfficioReview(text string, char int) -> retorna true para uma ementa *reexame necessário*
91-
- Partial(text string, char int) -> retorna true para uma ementa *parcial provimento*
92-
- Groundless(text string, char int) -> retorna true para uma ementa *improvimento*
93-
- HasGround(text string, char int) -> retorna true para uma ementa *provimento*
94-
95-
## CSV return files
96-
Serão retornados 9 arquivos csv apartados correspondetes a uma classificação mencionada acima, sendo esses:
97-
98-
- affected.csv
99-
- diligence.csv
100-
- exOfficioReview.csv
101-
- partial.csv
102-
- groundless.csv
103-
- hasGrounds.csv
104-
- noSummary.csv
105-
- notMapped.csv
106-
- totalInfered.csv <> **Compilado de todos os documentos acima**
107-
108-
Caso não exista nenhum elemento de uma dada categoria o arquivo não será retornado.
72+
- Classify(summary string) -> retorna *[Infered_decision](https://pkg.go.dev/github.com/Darklabel91/Summary_Classifier/Summary#InferredDecision)*
73+
- ReturnSummaryClass(summary string, char int) -> retorna uma das sete categorias de classificação possíveis.
74+
- SummaryClassifierCSV(rawFilePath string, separator rune, nameResultFolder string) -> retorna um CSV para uma pasta do projeto com o nome apontado em *resultFolder*. Para utilizar a função basta apontar o caminho do CSV (deve possuir uma única coluna com as ementas)
10975

11076
## Disclaimer
11177
Esse classificador foi testado, até o momento, apenas com ementas dos julgados do segundo grau do TJSP (Tribunal de Justiça de São Paulo) com uma assertividade de 96%, de qualquer modo, use com cautela.

0 commit comments

Comments
 (0)