Package google.cloud.language.v2

Index

LanguageService

Fournit des opérations d'analyse de texte telles que l'analyse des sentiments et la reconnaissance d'entités.

AnalyzeEntities

rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse)

Recherche les entités nommées (à l'heure actuelle, noms propres et noms communs) dans le texte, ainsi que les types d'entités, la probabilité, les mentions pour chaque entité et d'autres propriétés.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Présentation de l'authentification.
AnalyzeSentiment

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

Analyse le sentiment du texte fourni.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Présentation de l'authentification.
AnnotateText

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

Méthode pratique fournissant toutes les fonctionnalités en un seul appel.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Présentation de l'authentification.
ClassifyText

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

Classe un document en catégories.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.
ModerateText

rpc ModerateText(ModerateTextRequest) returns (ModerateTextResponse)

Modère un document pour les catégories nuisibles et sensibles.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Présentation de l'authentification.

AnalyzeEntitiesRequest

Message de requête d'analyse des entités.

Champs
document

Document

Obligatoire. Document d'entrée.
encoding_type

EncodingType

Type d'encodage utilisé par l'API pour calculer les décalages.

AnalyzeEntitiesResponse

Message de réponse de l'analyse des entités.

Champs
entities[]

Entity

Entités reconnues dans le document d'entrée.
language_code

string

Langue du texte, qui correspond à celle spécifiée dans la requête ou, si celle-ci est omise, à la langue détectée automatiquement. Pour en savoir plus, consultez le champ [Document.language][].
language_supported

bool

Indique si la langue est officiellement prise en charge. L'API peut toujours renvoyer une réponse lorsque la langue n'est pas prise en charge, mais dans la mesure du possible.

AnalyzeSentimentRequest

Message de requête d'analyse des sentiments.

Champs
document

Document

Obligatoire. Document d'entrée.
encoding_type

EncodingType

Type d'encodage utilisé par l'API pour calculer les décalages de phrase.

AnalyzeSentimentResponse

Message de réponse de l'analyse des sentiments.

Champs
document_sentiment

Sentiment

Sentiment général du document d'entrée.
language_code

string

Langue du texte, qui correspond à celle spécifiée dans la requête ou, si celle-ci est omise, à la langue détectée automatiquement. Pour en savoir plus, consultez le champ [Document.language][].
sentences[]

Sentence

Sentiment pour toutes les phrases du document.
language_supported

bool

Indique si la langue est officiellement prise en charge. L'API peut toujours renvoyer une réponse lorsque la langue n'est pas prise en charge, mais dans la mesure du possible.

AnnotateTextRequest

Message de requête pour l'API d'annotation de texte, qui permet d'effectuer plusieurs types d'analyse dans un même appel.

Champs
document

Document

Obligatoire. Document d'entrée.
features

Features

Obligatoire. Caractéristiques activées.
encoding_type

EncodingType

Type d'encodage utilisé par l'API pour calculer les décalages.

Fonctionnalités

Toutes les fonctionnalités disponibles Définir l'une de ces valeurs sur "true" active l'analyse associée sur l'entrée.

Champs
extract_entities

bool

Facultatif. extraire des entités textuelles ;
extract_document_sentiment

bool

Facultatif. Extraire les sentiments au niveau du document.
classify_text

bool

Facultatif. Classer l'intégralité du document en catégories.
moderate_text

bool

Facultatif. Modérer le document pour les catégories nuisibles et sensibles.

AnnotateTextResponse

Message de réponse des annotations textuelles.

Champs
sentences[]

Sentence

Phrases identifiées dans le document d'entrée. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_document_sentiment.
entities[]

Entity

Entités, accompagnées des informations sémantiques correspondantes, identifiées dans le document d'entrée. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_entities ou AnnotateTextRequest.Features.extract_entity_sentiment.
document_sentiment

Sentiment

Sentiment général du document. Champ renseigné si l'utilisateur active AnnotateTextRequest.Features.extract_document_sentiment.
language_code

string

Langue du texte, qui correspond à celle spécifiée dans la requête ou, si celle-ci est omise, à la langue détectée automatiquement. Pour en savoir plus, consultez le champ [Document.language][].
categories[]

ClassificationCategory

Catégories identifiées dans le document d'entrée.
moderation_categories[]

ClassificationCategory

Catégories nuisibles et sensibles identifiées dans le document d'entrée.
language_supported

bool

Indique si la langue est officiellement prise en charge par toutes les fonctionnalités demandées. L'API peut toujours renvoyer une réponse lorsque la langue n'est pas prise en charge, mais dans la mesure du possible.

ClassificationCategory

Représente une catégorie renvoyée par le classificateur de texte.

Champs
name

string

Nom de la catégorie représentant le document.
confidence

float

Niveau de confiance du classificateur pour la catégorie. Valeur numérique indiquant le degré de certitude du classificateur pour l'association de cette catégorie au texte.
severity

float

Facultatif. Gravité de la catégorie selon le classificateur. Ce champ n'est présent que lorsque ModerateTextRequest.ModelVersion est défini sur MODEL_VERSION_2 et que la catégorie correspondante dispose d'un score de gravité.

ClassifyTextRequest

Message de requête de classification de document.

Champs
document

Document

Obligatoire. Document d'entrée.

ClassifyTextResponse

Message de réponse de la classification de document.

Champs
categories[]

ClassificationCategory

Catégories représentant le document d'entrée.
language_code

string

Langue du texte, qui correspond à celle spécifiée dans la requête ou, si celle-ci est omise, à la langue détectée automatiquement. Pour en savoir plus, consultez le champ [Document.language][].
language_supported

bool

Indique si la langue est officiellement prise en charge. L'API peut toujours renvoyer une réponse lorsque la langue n'est pas prise en charge, mais dans la mesure du possible.

Document

Représente l'entrée fournie aux méthodes API.

Champs
type

Type

Obligatoire. Si le type n'est pas défini ou est défini sur TYPE_UNSPECIFIED, une erreur INVALID_ARGUMENT est renvoyée.
language_code

string

Facultatif. Langue du document (si aucune valeur n'est spécifiée, la langue est détectée automatiquement). Les codes de langue ISO et BCP-47 sont acceptés.
La page Langues acceptées répertorie les langues compatibles pour chaque méthode API. Si la langue (spécifiée par l'appelant ou détectée automatiquement) n'est pas acceptée par la méthode API appelée, une erreur INVALID_ARGUMENT est renvoyée.
Champ d'union source. Source du document : chaîne contenant le contenu ou URI URI Google Cloud Storage. source ne peut être qu'un des éléments suivants :
content

string

Contenu de l'entrée au format de chaîne. Exclu de Cloud Audit Logging, car il est basé sur des données utilisateur.
gcs_content_uri

string

URI Google Cloud Storage où se trouve le contenu du fichier. Cet URI doit être au format gs://nom_bucket/nom_objet. Pour en savoir plus, consultez la page https://cloud.google.com/storage/docs/reference-uris. REMARQUE : La gestion des versions d'objets Cloud Storage n'est pas compatible.

Type

Énumération des types de documents.

Enums
TYPE_UNSPECIFIED Le type de contenu n'est pas spécifié.
PLAIN_TEXT Texte brut
HTML HTML

EncodingType

Représente l'encodage de texte utilisé par l'appelant pour traiter la sortie. Il est recommandé de fournir un type d'encodage EncodingType, car l'API fournit les décalages de début pour divers résultats, tels que des jetons et les mentions, et certaines langues utilisant de manière native des encodages de texte différents peuvent accéder aux décalages différemment.

Enums
NONE Si EncodingType n'est pas spécifié, les informations dépendant de l'encodage (par exemple, begin_offset) seront définies sur -1.
UTF8 Les informations dépendant de l'encodage (par exemple, begin_offset) sont calculées en fonction de l'encodage UTF-8 de l'entrée. C++ et Go sont des exemples de langues utilisant cet encodage de manière native.
UTF16 Les informations dépendant de l'encodage (par exemple, begin_offset) sont calculées en fonction de l'encodage UTF-16 de l'entrée. Java et JavaScript sont des exemples de langages utilisant cet encodage de manière native.
UTF32 Les informations dépendant de l'encodage (par exemple, begin_offset) sont calculées en fonction de l'encodage UTF-32 de l'entrée. Python est un exemple de langage utilisant cet encodage de manière native.

Entity

Représente une expression dans le texte qui est une entité connue, telle qu'une personne, une organisation ou un lieu. L'API associe aux entités des informations telles que la probabilité et les mentions.

Champs
name

string

Nom représentatif de l'entité.
type

Type

Type de l'entité.
metadata

map<string, string>

Métadonnées associées à l'entité.

Pour les métadonnées associées aux autres types d'entités, consultez le tableau "Type" ci-dessous.
mentions[]

EntityMention

Mentions de cette entité dans le document d'entrée. L'API accepte actuellement les mentions de noms propres.
sentiment

Sentiment

Pour les appels à AnalyzeEntitySentimentRequest ou si AnnotateTextRequest.Features.extract_entity_sentiment est défini sur "true", ce champ contient le sentiment agrégé exprimé pour cette entité dans le document fourni.

Type

Type d'entité. Le tableau ci-dessous répertorie les champs associés pour les entités ayant des métadonnées différentes.

Enums
UNKNOWN Inconnu
PERSON Personne
LOCATION Emplacement
ORGANIZATION Organisation
EVENT Événement
WORK_OF_ART Œuvre d'art
CONSUMER_GOOD Produit grand public
OTHER Autres types d'entités
PHONE_NUMBER

Phone number

Les métadonnées contiennent le numéro de téléphone, au format local standard, ainsi que les éléments supplémentaires figurant dans le texte :

  • number : le numéro de téléphone proprement dit, divisé en sections conformément à la convention locale
  • national_prefix : code pays, le cas échéant
  • area_code : indicatif de région ou de zone, le cas échéant
  • extension : extension téléphonique (à composer après connexion), le cas échéant
ADDRESS

Address

Les métadonnées identifient le numéro de rue, la localité, ainsi que les éléments supplémentaires figurant dans le texte :

  • street_number : numéro de rue
  • locality : ville
  • street_name : nom de la rue/route, le cas échéant
  • postal_code : code postal, le cas échéant
  • country : pays, le cas échéant
  • broad_region : zone administrative, telle qu'un État, le cas échéant
  • narrow_region : zone administrative plus petite, telle qu'un comté, le cas échéant
  • sublocality : utilisée dans les adresses asiatiques pour identifier un quartier dans une ville, le cas échéant
DATE

Date

Les métadonnées identifient les composants de la date :

  • year : année à quatre chiffres, le cas échéant
  • month : numéro de mois à deux chiffres, le cas échéant
  • day : numéro du jour à deux chiffres, le cas échéant
NUMBER

Number

Les métadonnées sont le nombre lui-même.
PRICE

Price

Les métadonnées identifient la valeur value et la devisecurrency.

EntityMention

Représente une mention d'une entité dans le texte. Actuellement, les mentions de noms propres sont acceptées.

Champs
text

TextSpan

Texte de la mention.
type

Type

Type de la mention d'entité.
sentiment

Sentiment

Pour les appels à AnalyzeEntitySentimentRequest ou si AnnotateTextRequest.Features.extract_entity_sentiment est défini sur "true", ce champ contient le sentiment exprimé pour cette mention de l'entité dans le document fourni.
probability

float

Score de probabilité associé à l'entité.

Le score indique la probabilité que la mention d'entité corresponde au type d'entité. Le score est compris dans la plage (0, 1].

Type

Types de mentions acceptés.

Enums
TYPE_UNKNOWN Inconnu
PROPER Nom propre
COMMON Nom courant (ou composé)

ModerateTextRequest

Message de requête de modération de document.

Champs
document

Document

Obligatoire. Document d'entrée.
model_version

ModelVersion

Facultatif. Version du modèle à utiliser pour ModerateText.

ModelVersion

Version du modèle à utiliser pour ModerateText.

Enums
MODEL_VERSION_UNSPECIFIED Version par défaut du modèle.
MODEL_VERSION_1 Utilisez le modèle v1, qui est utilisé par défaut lorsqu'il n'est pas fourni. Le modèle v1 ne renvoie qu'un score de probabilité (confiance) pour chaque catégorie.
MODEL_VERSION_2 Utilisez le modèle v2. Le modèle v2 ne renvoie qu'un score de probabilité (confiance) pour chaque catégorie et un score de gravité pour un sous-ensemble de catégories.

ModerateTextResponse

Message de réponse de la modération des documents.

Champs
moderation_categories[]

ClassificationCategory

Catégories nuisibles et sensibles représentant le document d'entrée.
language_code

string

Langue du texte, qui correspond à celle spécifiée dans la requête ou, si celle-ci est omise, à la langue détectée automatiquement. Pour en savoir plus, consultez le champ [Document.language][].
language_supported

bool

Indique si la langue est officiellement prise en charge. L'API peut toujours renvoyer une réponse lorsque la langue n'est pas prise en charge, mais dans la mesure du possible.

Phrase

Représente une phrase dans le document d'entrée.

Champs
text

TextSpan

Texte de la phrase.
sentiment

Sentiment

Pour les appels à AnalyzeSentimentRequest ou si AnnotateTextRequest.Features.extract_document_sentiment est défini sur "true", ce champ contient le sentiment associé à la phrase.

Sentiment

Représente le sentiment associé à l'ensemble du texte ou aux entités du texte.

Champs
magnitude

float

Nombre non négatif dans l'intervalle [0, +inf], qui représente la magnitude absolue du sentiment, indépendamment du score (positif ou négatif).
score

float

Score de sentiment compris entre -1,0 (sentiment négatif) et 1,0 (sentiment positif).

TextSpan

Représente une plage de texte dans le document d'entrée.

Champs
content

string

Contenu de la plage de texte, qui est une sous-chaîne du document.
begin_offset

int32

L'API calcule le décalage correspondant au début du contenu dans le document d'origine en fonction de la valeur EncodingType spécifiée dans la requête API.