/
language-api.json
1320 lines (1320 loc) · 47.9 KB
/
language-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-language": {
"description": "Apply machine learning models to reveal the structure and meaning of text"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://language.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Natural Language",
"description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/natural-language/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "language:v1beta2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://language.mtls.googleapis.com/",
"name": "language",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"documents": {
"methods": {
"analyzeEntities": {
"description": "Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.",
"flatPath": "v1beta2/documents:analyzeEntities",
"httpMethod": "POST",
"id": "language.documents.analyzeEntities",
"parameterOrder": [],
"parameters": {},
"path": "v1beta2/documents:analyzeEntities",
"request": {
"$ref": "AnalyzeEntitiesRequest"
},
"response": {
"$ref": "AnalyzeEntitiesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"analyzeEntitySentiment": {
"description": "Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.",
"flatPath": "v1beta2/documents:analyzeEntitySentiment",
"httpMethod": "POST",
"id": "language.documents.analyzeEntitySentiment",
"parameterOrder": [],
"parameters": {},
"path": "v1beta2/documents:analyzeEntitySentiment",
"request": {
"$ref": "AnalyzeEntitySentimentRequest"
},
"response": {
"$ref": "AnalyzeEntitySentimentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"analyzeSentiment": {
"description": "Analyzes the sentiment of the provided text.",
"flatPath": "v1beta2/documents:analyzeSentiment",
"httpMethod": "POST",
"id": "language.documents.analyzeSentiment",
"parameterOrder": [],
"parameters": {},
"path": "v1beta2/documents:analyzeSentiment",
"request": {
"$ref": "AnalyzeSentimentRequest"
},
"response": {
"$ref": "AnalyzeSentimentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"analyzeSyntax": {
"description": "Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.",
"flatPath": "v1beta2/documents:analyzeSyntax",
"httpMethod": "POST",
"id": "language.documents.analyzeSyntax",
"parameterOrder": [],
"parameters": {},
"path": "v1beta2/documents:analyzeSyntax",
"request": {
"$ref": "AnalyzeSyntaxRequest"
},
"response": {
"$ref": "AnalyzeSyntaxResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"annotateText": {
"description": "A convenience method that provides all syntax, sentiment, entity, and classification features in one call.",
"flatPath": "v1beta2/documents:annotateText",
"httpMethod": "POST",
"id": "language.documents.annotateText",
"parameterOrder": [],
"parameters": {},
"path": "v1beta2/documents:annotateText",
"request": {
"$ref": "AnnotateTextRequest"
},
"response": {
"$ref": "AnnotateTextResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"classifyText": {
"description": "Classifies a document into categories.",
"flatPath": "v1beta2/documents:classifyText",
"httpMethod": "POST",
"id": "language.documents.classifyText",
"parameterOrder": [],
"parameters": {},
"path": "v1beta2/documents:classifyText",
"request": {
"$ref": "ClassifyTextRequest"
},
"response": {
"$ref": "ClassifyTextResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"revision": "20221015",
"rootUrl": "https://language.googleapis.com/",
"schemas": {
"AnalyzeEntitiesRequest": {
"description": "The entity analysis request message.",
"id": "AnalyzeEntitiesRequest",
"properties": {
"document": {
"$ref": "Document",
"description": "Required. Input document."
},
"encodingType": {
"description": "The encoding type used by the API to calculate offsets.",
"enum": [
"NONE",
"UTF8",
"UTF16",
"UTF32"
],
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
],
"type": "string"
}
},
"type": "object"
},
"AnalyzeEntitiesResponse": {
"description": "The entity analysis response message.",
"id": "AnalyzeEntitiesResponse",
"properties": {
"entities": {
"description": "The recognized entities in the input document.",
"items": {
"$ref": "Entity"
},
"type": "array"
},
"language": {
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
"type": "string"
}
},
"type": "object"
},
"AnalyzeEntitySentimentRequest": {
"description": "The entity-level sentiment analysis request message.",
"id": "AnalyzeEntitySentimentRequest",
"properties": {
"document": {
"$ref": "Document",
"description": "Required. Input document."
},
"encodingType": {
"description": "The encoding type used by the API to calculate offsets.",
"enum": [
"NONE",
"UTF8",
"UTF16",
"UTF32"
],
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
],
"type": "string"
}
},
"type": "object"
},
"AnalyzeEntitySentimentResponse": {
"description": "The entity-level sentiment analysis response message.",
"id": "AnalyzeEntitySentimentResponse",
"properties": {
"entities": {
"description": "The recognized entities in the input document with associated sentiments.",
"items": {
"$ref": "Entity"
},
"type": "array"
},
"language": {
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
"type": "string"
}
},
"type": "object"
},
"AnalyzeSentimentRequest": {
"description": "The sentiment analysis request message.",
"id": "AnalyzeSentimentRequest",
"properties": {
"document": {
"$ref": "Document",
"description": "Required. Input document."
},
"encodingType": {
"description": "The encoding type used by the API to calculate sentence offsets for the sentence sentiment.",
"enum": [
"NONE",
"UTF8",
"UTF16",
"UTF32"
],
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
],
"type": "string"
}
},
"type": "object"
},
"AnalyzeSentimentResponse": {
"description": "The sentiment analysis response message.",
"id": "AnalyzeSentimentResponse",
"properties": {
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment of the input document."
},
"language": {
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
"type": "string"
},
"sentences": {
"description": "The sentiment for all the sentences in the document.",
"items": {
"$ref": "Sentence"
},
"type": "array"
}
},
"type": "object"
},
"AnalyzeSyntaxRequest": {
"description": "The syntax analysis request message.",
"id": "AnalyzeSyntaxRequest",
"properties": {
"document": {
"$ref": "Document",
"description": "Required. Input document."
},
"encodingType": {
"description": "The encoding type used by the API to calculate offsets.",
"enum": [
"NONE",
"UTF8",
"UTF16",
"UTF32"
],
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
],
"type": "string"
}
},
"type": "object"
},
"AnalyzeSyntaxResponse": {
"description": "The syntax analysis response message.",
"id": "AnalyzeSyntaxResponse",
"properties": {
"language": {
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
"type": "string"
},
"sentences": {
"description": "Sentences in the input document.",
"items": {
"$ref": "Sentence"
},
"type": "array"
},
"tokens": {
"description": "Tokens, along with their syntactic information, in the input document.",
"items": {
"$ref": "Token"
},
"type": "array"
}
},
"type": "object"
},
"AnnotateTextRequest": {
"description": "The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.",
"id": "AnnotateTextRequest",
"properties": {
"document": {
"$ref": "Document",
"description": "Required. Input document."
},
"encodingType": {
"description": "The encoding type used by the API to calculate offsets.",
"enum": [
"NONE",
"UTF8",
"UTF16",
"UTF32"
],
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively."
],
"type": "string"
},
"features": {
"$ref": "Features",
"description": "Required. The enabled features."
}
},
"type": "object"
},
"AnnotateTextResponse": {
"description": "The text annotations response message.",
"id": "AnnotateTextResponse",
"properties": {
"categories": {
"description": "Categories identified in the input document.",
"items": {
"$ref": "ClassificationCategory"
},
"type": "array"
},
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment."
},
"entities": {
"description": "Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.",
"items": {
"$ref": "Entity"
},
"type": "array"
},
"language": {
"description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.",
"type": "string"
},
"sentences": {
"description": "Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.",
"items": {
"$ref": "Sentence"
},
"type": "array"
},
"tokens": {
"description": "Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.",
"items": {
"$ref": "Token"
},
"type": "array"
}
},
"type": "object"
},
"ClassificationCategory": {
"description": "Represents a category returned from the text classifier.",
"id": "ClassificationCategory",
"properties": {
"confidence": {
"description": "The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.",
"format": "float",
"type": "number"
},
"name": {
"description": "The name of the category representing the document, from the [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).",
"type": "string"
}
},
"type": "object"
},
"ClassificationModelOptions": {
"description": "Model options available for classification requests.",
"id": "ClassificationModelOptions",
"properties": {
"v1Model": {
"$ref": "V1Model",
"description": "Setting this field will use the V1 model and V1 content categories version. The V1 model is a legacy model; support for this will be discontinued in the future."
},
"v2Model": {
"$ref": "V2Model",
"description": "Setting this field will use the V2 model with the appropriate content categories version. The V2 model is a better performing model."
}
},
"type": "object"
},
"ClassifyTextRequest": {
"description": "The document classification request message.",
"id": "ClassifyTextRequest",
"properties": {
"classificationModelOptions": {
"$ref": "ClassificationModelOptions",
"description": "Model options to use for classification. Defaults to v1 options if not specified."
},
"document": {
"$ref": "Document",
"description": "Required. Input document."
}
},
"type": "object"
},
"ClassifyTextResponse": {
"description": "The document classification response message.",
"id": "ClassifyTextResponse",
"properties": {
"categories": {
"description": "Categories representing the input document.",
"items": {
"$ref": "ClassificationCategory"
},
"type": "array"
}
},
"type": "object"
},
"DependencyEdge": {
"description": "Represents dependency parse tree information for a token.",
"id": "DependencyEdge",
"properties": {
"headTokenIndex": {
"description": "Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index.",
"format": "int32",
"type": "integer"
},
"label": {
"description": "The parse label for the token.",
"enum": [
"UNKNOWN",
"ABBREV",
"ACOMP",
"ADVCL",
"ADVMOD",
"AMOD",
"APPOS",
"ATTR",
"AUX",
"AUXPASS",
"CC",
"CCOMP",
"CONJ",
"CSUBJ",
"CSUBJPASS",
"DEP",
"DET",
"DISCOURSE",
"DOBJ",
"EXPL",
"GOESWITH",
"IOBJ",
"MARK",
"MWE",
"MWV",
"NEG",
"NN",
"NPADVMOD",
"NSUBJ",
"NSUBJPASS",
"NUM",
"NUMBER",
"P",
"PARATAXIS",
"PARTMOD",
"PCOMP",
"POBJ",
"POSS",
"POSTNEG",
"PRECOMP",
"PRECONJ",
"PREDET",
"PREF",
"PREP",
"PRONL",
"PRT",
"PS",
"QUANTMOD",
"RCMOD",
"RCMODREL",
"RDROP",
"REF",
"REMNANT",
"REPARANDUM",
"ROOT",
"SNUM",
"SUFF",
"TMOD",
"TOPIC",
"VMOD",
"VOCATIVE",
"XCOMP",
"SUFFIX",
"TITLE",
"ADVPHMOD",
"AUXCAUS",
"AUXVV",
"DTMOD",
"FOREIGN",
"KW",
"LIST",
"NOMC",
"NOMCSUBJ",
"NOMCSUBJPASS",
"NUMC",
"COP",
"DISLOCATED",
"ASP",
"GMOD",
"GOBJ",
"INFMOD",
"MES",
"NCOMP"
],
"enumDescriptions": [
"Unknown",
"Abbreviation modifier",
"Adjectival complement",
"Adverbial clause modifier",
"Adverbial modifier",
"Adjectival modifier of an NP",
"Appositional modifier of an NP",
"Attribute dependent of a copular verb",
"Auxiliary (non-main) verb",
"Passive auxiliary",
"Coordinating conjunction",
"Clausal complement of a verb or adjective",
"Conjunct",
"Clausal subject",
"Clausal passive subject",
"Dependency (unable to determine)",
"Determiner",
"Discourse",
"Direct object",
"Expletive",
"Goes with (part of a word in a text not well edited)",
"Indirect object",
"Marker (word introducing a subordinate clause)",
"Multi-word expression",
"Multi-word verbal expression",
"Negation modifier",
"Noun compound modifier",
"Noun phrase used as an adverbial modifier",
"Nominal subject",
"Passive nominal subject",
"Numeric modifier of a noun",
"Element of compound number",
"Punctuation mark",
"Parataxis relation",
"Participial modifier",
"The complement of a preposition is a clause",
"Object of a preposition",
"Possession modifier",
"Postverbal negative particle",
"Predicate complement",
"Preconjunt",
"Predeterminer",
"Prefix",
"Prepositional modifier",
"The relationship between a verb and verbal morpheme",
"Particle",
"Associative or possessive marker",
"Quantifier phrase modifier",
"Relative clause modifier",
"Complementizer in relative clause",
"Ellipsis without a preceding predicate",
"Referent",
"Remnant",
"Reparandum",
"Root",
"Suffix specifying a unit of number",
"Suffix",
"Temporal modifier",
"Topic marker",
"Clause headed by an infinite form of the verb that modifies a noun",
"Vocative",
"Open clausal complement",
"Name suffix",
"Name title",
"Adverbial phrase modifier",
"Causative auxiliary",
"Helper auxiliary",
"Rentaishi (Prenominal modifier)",
"Foreign words",
"Keyword",
"List for chains of comparable items",
"Nominalized clause",
"Nominalized clausal subject",
"Nominalized clausal passive",
"Compound of numeric modifier",
"Copula",
"Dislocated relation (for fronted/topicalized elements)",
"Aspect marker",
"Genitive modifier",
"Genitive object",
"Infinitival modifier",
"Measure",
"Nominal complement of a noun"
],
"type": "string"
}
},
"type": "object"
},
"Document": {
"description": "Represents the input to API methods.",
"id": "Document",
"properties": {
"boilerplateHandling": {
"description": "Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.",
"enum": [
"BOILERPLATE_HANDLING_UNSPECIFIED",
"SKIP_BOILERPLATE",
"KEEP_BOILERPLATE"
],
"enumDescriptions": [
"The boilerplate handling is not specified.",
"Do not analyze detected boilerplate. Reference web URI is required for detecting boilerplate.",
"Treat boilerplate the same as content."
],
"type": "string"
},
"content": {
"description": "The content of the input in string format. Cloud audit logging exempt since it is based on user data.",
"type": "string"
},
"gcsContentUri": {
"description": "The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.",
"type": "string"
},
"language": {
"description": "The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned.",
"type": "string"
},
"referenceWebUri": {
"description": "The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.",
"type": "string"
},
"type": {
"description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.",
"enum": [
"TYPE_UNSPECIFIED",
"PLAIN_TEXT",
"HTML"
],
"enumDescriptions": [
"The content type is not specified.",
"Plain text",
"HTML"
],
"type": "string"
}
},
"type": "object"
},
"Entity": {
"description": "Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.",
"id": "Entity",
"properties": {
"mentions": {
"description": "The mentions of this entity in the input document. The API currently supports proper noun mentions.",
"items": {
"$ref": "EntityMention"
},
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.",
"type": "object"
},
"name": {
"description": "The representative name for the entity.",
"type": "string"
},
"salience": {
"description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.",
"format": "float",
"type": "number"
},
"sentiment": {
"$ref": "Sentiment",
"description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document."
},
"type": {
"description": "The entity type.",
"enum": [
"UNKNOWN",
"PERSON",
"LOCATION",
"ORGANIZATION",
"EVENT",
"WORK_OF_ART",
"CONSUMER_GOOD",
"OTHER",
"PHONE_NUMBER",
"ADDRESS",
"DATE",
"NUMBER",
"PRICE"
],
"enumDescriptions": [
"Unknown",
"Person",
"Location",
"Organization",
"Event",
"Artwork",
"Consumer product",
"Other types of entities",
"Phone number The metadata lists the phone number, formatted according to local convention, plus whichever additional elements appear in the text: * `number` - the actual number, broken down into sections as per local convention * `national_prefix` - country code, if detected * `area_code` - region or area code, if detected * `extension` - phone extension (to be dialed after connection), if detected",
"Address The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - street number * `locality` - city or town * `street_name` - street/route name, if detected * `postal_code` - postal code, if detected * `country` - country, if detected\u003c * `broad_region` - administrative area, such as the state, if detected * `narrow_region` - smaller administrative area, such as county, if detected * `sublocality` - used in Asian addresses to demark a district within a city, if detected",
"Date The metadata identifies the components of the date: * `year` - four digit year, if detected * `month` - two digit month number, if detected * `day` - two digit day number, if detected",
"Number The metadata is the number itself.",
"Price The metadata identifies the `value` and `currency`."
],
"type": "string"
}
},
"type": "object"
},
"EntityMention": {
"description": "Represents a mention for an entity in the text. Currently, proper noun mentions are supported.",
"id": "EntityMention",
"properties": {
"sentiment": {
"$ref": "Sentiment",
"description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document."
},
"text": {
"$ref": "TextSpan",
"description": "The mention text."
},
"type": {
"description": "The type of the entity mention.",
"enum": [
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
],
"enumDescriptions": [
"Unknown",
"Proper name",
"Common noun (or noun compound)"
],
"type": "string"
}
},
"type": "object"
},
"Features": {
"description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 11",
"id": "Features",
"properties": {
"classificationModelOptions": {
"$ref": "ClassificationModelOptions",
"description": "The model options to use for classification. Defaults to v1 options if not specified. Only used if `classify_text` is set to true."
},
"classifyText": {
"description": "Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).",
"type": "boolean"
},
"extractDocumentSentiment": {
"description": "Extract document-level sentiment.",
"type": "boolean"
},
"extractEntities": {
"description": "Extract entities.",
"type": "boolean"
},
"extractEntitySentiment": {
"description": "Extract entities and their associated sentiment.",
"type": "boolean"
},
"extractSyntax": {
"description": "Extract syntax information.",
"type": "boolean"
}
},
"type": "object"
},
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"id": "PartOfSpeech",
"properties": {
"aspect": {
"description": "The grammatical aspect.",
"enum": [
"ASPECT_UNKNOWN",
"PERFECTIVE",
"IMPERFECTIVE",
"PROGRESSIVE"
],
"enumDescriptions": [
"Aspect is not applicable in the analyzed language or is not predicted.",
"Perfective",
"Imperfective",
"Progressive"
],
"type": "string"
},
"case": {
"description": "The grammatical case.",
"enum": [
"CASE_UNKNOWN",
"ACCUSATIVE",
"ADVERBIAL",
"COMPLEMENTIVE",
"DATIVE",
"GENITIVE",
"INSTRUMENTAL",
"LOCATIVE",
"NOMINATIVE",
"OBLIQUE",
"PARTITIVE",
"PREPOSITIONAL",
"REFLEXIVE_CASE",
"RELATIVE_CASE",
"VOCATIVE"
],
"enumDescriptions": [
"Case is not applicable in the analyzed language or is not predicted.",
"Accusative",
"Adverbial",
"Complementive",
"Dative",
"Genitive",
"Instrumental",
"Locative",
"Nominative",
"Oblique",
"Partitive",
"Prepositional",
"Reflexive",
"Relative",
"Vocative"
],
"type": "string"
},
"form": {
"description": "The grammatical form.",
"enum": [
"FORM_UNKNOWN",
"ADNOMIAL",
"AUXILIARY",
"COMPLEMENTIZER",
"FINAL_ENDING",
"GERUND",
"REALIS",
"IRREALIS",
"SHORT",
"LONG",
"ORDER",
"SPECIFIC"
],
"enumDescriptions": [
"Form is not applicable in the analyzed language or is not predicted.",
"Adnomial",
"Auxiliary",