Package google.cloud.language.v2

Indice

LanguageService

Fornisce operazioni di analisi del testo come l'analisi del sentiment e il riconoscimento delle entità.

AnalyzeEntities

rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse)

Individua le entità denominate (attualmente nomi propri e nomi comuni) nel testo, oltre ai tipi di entità, alla probabilità, alle menzioni per ogni entità e ad altre proprietà.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

AnalyzeSentiment

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

Analizza il sentiment del testo fornito.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

AnnotateText

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

Un metodo pratico che fornisce tutte le funzionalità in un'unica chiamata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

ClassifyText

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

Classifica un documento in categorie.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

ModerateText

rpc ModerateText(ModerateTextRequest) returns (ModerateTextResponse)

Modera un documento per categorie dannose e sensibili.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

AnalyzeEntitiesRequest

Il messaggio di richiesta di analisi delle entità.

Campi
document

Document

Obbligatorio. Inserisci il documento.

encoding_type

EncodingType

Il tipo di codifica utilizzato dall'API per calcolare gli offset.

AnalyzeEntitiesResponse

Il messaggio di risposta dell'analisi delle entità.

Campi
entities[]

Entity

Le entità riconosciute nel documento di input.

language_code

string

La lingua del testo, che corrisponderà alla lingua specificata nella richiesta o, se non specificata, alla lingua rilevata automaticamente. Per ulteriori dettagli, consulta il campo [Document.language][].

language_supported

bool

Se la lingua è ufficialmente supportata. L'API potrebbe comunque restituire una risposta quando la lingua non è supportata, ma si tratta di un servizio secondo il criterio del "best effort".

AnalyzeSentimentRequest

Il messaggio di richiesta di analisi del sentiment.

Campi
document

Document

Obbligatorio. Inserisci il documento.

encoding_type

EncodingType

Il tipo di codifica utilizzato dall'API per calcolare gli offset delle frasi.

AnalyzeSentimentResponse

Il messaggio di risposta dell'analisi del sentiment.

Campi
document_sentiment

Sentiment

Il sentiment generale del documento di input.

language_code

string

La lingua del testo, che corrisponderà alla lingua specificata nella richiesta o, se non specificata, alla lingua rilevata automaticamente. Per ulteriori dettagli, consulta il campo [Document.language][].

sentences[]

Sentence

Il sentiment di tutte le frasi del documento.

language_supported

bool

Se la lingua è ufficialmente supportata. L'API potrebbe comunque restituire una risposta quando la lingua non è supportata, ma si tratta di un servizio secondo il criterio del "best effort".

AnnotateTextRequest

Il messaggio di richiesta per l'API di annotazione del testo, che può eseguire più tipi di analisi in una sola chiamata.

Campi
document

Document

Obbligatorio. Inserisci il documento.

features

Features

Obbligatorio. Le funzionalità abilitate.

encoding_type

EncodingType

Il tipo di codifica utilizzato dall'API per calcolare gli offset.

Funzionalità

Tutte le funzionalità disponibili. Se imposti ciascuna su true, verrà attivata l'analisi specifica per l'input.

Campi
extract_entities

bool

Facoltativo. Estrarre le entità.

extract_document_sentiment

bool

Facoltativo. Estrai il sentiment a livello di documento.

classify_text

bool

Facoltativo. Classifica l'intero documento in categorie.

moderate_text

bool

Facoltativo. Modera il documento per individuare contenuti dannosi e sensibili.

AnnotateTextResponse

Il messaggio di risposta per le annotazioni di testo.

Campi
sentences[]

Sentence

Frasi nel documento di input. Viene compilato se l'utente attiva AnnotateTextRequest.Features.extract_document_sentiment.

entities[]

Entity

Entità, insieme alle relative informazioni semantiche, nel documento di input. Viene compilato se l'utente attiva AnnotateTextRequest.Features.extract_entities o AnnotateTextRequest.Features.extract_entity_sentiment.

document_sentiment

Sentiment

Il sentiment complessivo del documento. Viene compilato se l'utente attiva AnnotateTextRequest.Features.extract_document_sentiment.

language_code

string

La lingua del testo, che corrisponderà alla lingua specificata nella richiesta o, se non specificata, alla lingua rilevata automaticamente. Per ulteriori dettagli, consulta il campo [Document.language][].

categories[]

ClassificationCategory

Categorie identificate nel documento di input.

moderation_categories[]

ClassificationCategory

Categorie dannose e sensibili identificate nel documento di input.

language_supported

bool

Indica se la lingua è supportata ufficialmente da tutte le funzionalità richieste. L'API potrebbe comunque restituire una risposta quando la lingua non è supportata, ma in base al criterio del "best effort".

ClassificationCategory

Rappresenta una categoria restituita dall'classificatore di testo.

Campi
name

string

Il nome della categoria che rappresenta il documento.

confidence

float

L'affidabilità del classificatore per la categoria. Il numero indica quanto è certo il classificatore che questa categoria rappresenti il testo specificato.

severity

float

Facoltativo. La gravità della categoria del classificatore. Questo valore è presente solo quando ModerateTextRequest.ModelVersion è impostato su MODEL_VERSION_2 e la categoria corrispondente ha un punteggio di gravità.

ClassifyTextRequest

Il messaggio di richiesta di classificazione dei documenti.

Campi
document

Document

Obbligatorio. Inserisci il documento.

ClassifyTextResponse

Il messaggio di risposta alla classificazione dei documenti.

Campi
categories[]

ClassificationCategory

Categorie che rappresentano il documento di input.

language_code

string

La lingua del testo, che corrisponderà alla lingua specificata nella richiesta o, se non specificata, alla lingua rilevata automaticamente. Per ulteriori dettagli, consulta il campo [Document.language][].

language_supported

bool

Se la lingua è ufficialmente supportata. L'API potrebbe comunque restituire una risposta quando la lingua non è supportata, ma si tratta di un servizio secondo il criterio del "best effort".

Documento

Rappresenta l'input per i metodi dell'API.

Campi
type

Type

Obbligatorio. Se il tipo non è impostato o è TYPE_UNSPECIFIED, viene restituito un errore INVALID_ARGUMENT.

language_code

string

Facoltativo. La lingua del documento (se non specificata, la lingua viene rilevata automaticamente). Sono accettati sia i codici lingua ISO che BCP-47.
Supporto delle lingue elenca le lingue attualmente supportate per ogni metodo dell'API. Se la lingua (specificata dall'utente che chiama o rilevata automaticamente) non è supportata dal metodo dell'API chiamato, viene restituito un errore INVALID_ARGUMENT.

Campo unione source. L'origine del documento: una stringa contenente i contenuti o un URI di Google Cloud Storage. source può essere solo uno dei seguenti:
content

string

I contenuti dell'input in formato di stringa. L'audit logging di Cloud è esente in quanto si basa sui dati utente.

gcs_content_uri

string

L'URI Google Cloud Storage in cui si trovano i contenuti del file. Questo URI deve avere il seguente formato: gs://nome_bucket/nome_oggetto. Per ulteriori dettagli, visita la pagina https://cloud.google.com/storage/docs/reference-uris. NOTA: il controllo delle versioni degli oggetti Cloud Storage non è supportato.

Tipo

L'enum dei tipi di documento.

Enum
TYPE_UNSPECIFIED Il tipo di contenuti non è specificato.
PLAIN_TEXT Testo normale
HTML HTML

EncodingType

Rappresenta la codifica del testo utilizzata dal chiamante per elaborare l'output. Ti consigliamo di fornire un EncodingType perché l'API fornisce gli offset iniziali per vari output, come token e menzioni, e le lingue che utilizzano in modo nativo codifiche di testo diverse potrebbero accedere agli offset in modo diverso.

Enum
NONE Se EncodingType non è specificato, le informazioni dipendenti dalla codifica (ad esempio begin_offset) verranno impostate su -1.
UTF8 Le informazioni dipendenti dalla codifica (ad esempio begin_offset) vengono calcolate in base alla codifica UTF-8 dell'input. C++ e Go sono esempi di linguaggi che utilizzano questa codifica in modo nativo.
UTF16 Le informazioni dipendenti dalla codifica (ad esempio begin_offset) vengono calcolate in base alla codifica UTF-16 dell'input. Java e JavaScript sono esempi di linguaggi che utilizzano questa codifica in modo nativo.
UTF32 Le informazioni dipendenti dalla codifica (ad esempio begin_offset) vengono calcolate in base alla codifica UTF-32 dell'input. Python è un esempio di linguaggio che utilizza questa codifica in modo nativo.

Entità

Rappresenta una frase nel testo che è un'entità nota, ad esempio una persona, un'organizzazione o una località. L'API associa informazioni, come probabilità e menzioni, alle entità.

Campi
name

string

Il nome rappresentativo dell'entità.

type

Type

Il tipo di entità.

metadata

map<string, string>

Metadati associati all'entità.

Per i metadati associati ad altri tipi di entità, consulta la tabella Tipo di seguito.

mentions[]

EntityMention

Le menzioni di questa entità nel documento di input. Al momento l'API supporta le menzioni di nomi propri.

sentiment

Sentiment

Per le chiamate a AnalyzeEntitySentimentRequest o se AnnotateTextRequest.Features.extract_entity_sentiment è impostato su true, questo campo conterrà il sentiment aggregato espresso per questa entità nel documento fornito.

Tipo

Il tipo di entità. La tabella seguente elenca i campi associati per le entità con metadati diversi.

Enum
UNKNOWN Sconosciuto
PERSON Persona
LOCATION Località
ORGANIZATION Organizzazione
EVENT Evento
WORK_OF_ART Opera d'arte
CONSUMER_GOOD Prodotto di consumo
OTHER Altri tipi di entità
PHONE_NUMBER

Numero di telefono

I metadati elencano il numero di telefono, formattato in base alle convenzioni locali, oltre a eventuali elementi aggiuntivi visualizzati nel testo:

  • number: il numero effettivo, suddiviso in sezioni in base alle convenzioni locali
  • national_prefix - codice paese, se rilevato
  • area_code - regione o prefisso, se rilevato
  • extension - estensione telefonica (da comporre dopo la connessione), se rilevata
ADDRESS

Indirizzo

I metadati identificano il numero civico e la località, oltre a eventuali elementi aggiuntivi visualizzati nel testo:

  • street_number - numero civico
  • locality - città
  • street_name - nome della via/della strada, se rilevato
  • postal_code - codice postale, se rilevato
  • country - paese, se rilevato
  • broad_region - area amministrativa, ad esempio la provincia, se rilevata
  • narrow_region - area amministrativa più piccola, ad esempio una contea, se rilevata
  • sublocality: se rilevato, viene utilizzato negli indirizzi asiatici per delimitare un quartiere all'interno di una città
DATE

Data

I metadati identificano i componenti della data:

  • year - anno a quattro cifre, se rilevato
  • month: numero del mese a due cifre, se rilevato
  • day - numero di giorno a due cifre, se rilevato
NUMBER

Numero

I metadati sono il numero stesso.

PRICE

Prezzo

I metadati identificano value e currency.

EntityMention

Rappresenta una menzione di un'entità nel testo. Al momento sono supportate le menzioni di nomi propri.

Campi
text

TextSpan

Il testo della menzione.

type

Type

Il tipo di menzione dell'entità.

sentiment

Sentiment

Per le chiamate a AnalyzeEntitySentimentRequest o se AnnotateTextRequest.Features.extract_entity_sentiment è impostato su true, questo campo conterrà il sentiment espresso per questa menzione della persona giuridica nel documento fornito.

probability

float

Punteggio di probabilità associato all'entità.

Il punteggio mostra la probabilità che la menzione dell'entità corrisponda al tipo di entità. Il punteggio è compreso nell'intervallo [0, 1].

Tipo

I tipi di menzioni supportati.

Enum
TYPE_UNKNOWN Sconosciuto
PROPER Nome proprio
COMMON Nome comune (o nome composto)

ModerateTextRequest

Il messaggio della richiesta di moderazione del documento.

Campi
document

Document

Obbligatorio. Inserisci il documento.

model_version

ModelVersion

Facoltativo. La versione del modello da utilizzare per ModerateText.

ModelVersion

La versione del modello da utilizzare per ModerateText.

Enum
MODEL_VERSION_UNSPECIFIED La versione del modello predefinita.
MODEL_VERSION_1 Utilizza il modello v1, che viene utilizzato per impostazione predefinita se non viene fornito. Il modello v1 restituisce solo il punteggio di probabilità (affidabilità) per ogni categoria.
MODEL_VERSION_2 Utilizza il modello v2. Il modello v2 restituisce solo il punteggio di probabilità (affidabilità) per ogni categoria e il punteggio di gravità per un sottoinsieme di categorie.

ModerateTextResponse

Il messaggio di risposta alla moderazione del documento.

Campi
moderation_categories[]

ClassificationCategory

Categorie dannose e sensibili che rappresentano il documento di input.

language_code

string

La lingua del testo, che corrisponderà alla lingua specificata nella richiesta o, se non specificata, alla lingua rilevata automaticamente. Per ulteriori dettagli, consulta il campo [Document.language][].

language_supported

bool

Se la lingua è ufficialmente supportata. L'API potrebbe comunque restituire una risposta quando la lingua non è supportata, ma in base al criterio del "best effort".

Sentence

Rappresenta una frase nel documento di input.

Campi
text

TextSpan

Il testo della frase.

sentiment

Sentiment

Per le chiamate a AnalyzeSentimentRequest o se AnnotateTextRequest.Features.extract_document_sentiment è impostato su true, questo campo conterrà il sentiment della frase.

Sentiment

Rappresenta il sentimento associato all'intero testo o alle entità al suo interno.

Campi
magnitude

float

Un numero non negativo nell'intervallo [0, +inf], che rappresenta la grandezza assoluta del sentiment indipendentemente dal punteggio (positivo o negativo).

score

float

Punteggio del sentiment compreso tra -1,0 (sentiment negativo) e 1,0 (sentiment positivo).

TextSpan

Rappresenta un intervallo di testo nel documento di input.

Campi
content

string

I contenuti dell'intervallo di testo, che è una sottostringa del documento.

begin_offset

int32

L'API calcola l'offset iniziale dei contenuti nel documento originale in base a EncodingType specificato nella richiesta dell'API.