- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Example
- Try it!
Lists sentence pairs in the dataset.
HTTP request
GET https://translate.googleapis.com/v3/{parent=projects/*/locations/*/datasets/*}/examples
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent
|
Required. Name of the parent dataset. In form of |
Query parameters
| Parameters | |
|---|---|
filter
|
Optional. An expression for filtering the examples that will be returned. Example filter: * |
pageSize
|
Optional. Requested page size. The server can return fewer results than requested. |
pageToken
|
Optional. A token identifying a page of results for the server to return. Typically obtained from nextPageToken field in the response of a examples.list call. |
Request body
The request body must be empty.
Response body
Response message for examples.list.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"examples"
:
[
{
object (
|
| Fields | |
|---|---|
examples[]
|
The sentence pairs. |
nextPageToken
|
A token to retrieve next page of results. Pass this token to the pageToken field in the ListExamplesRequest to obtain the corresponding page. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/cloud-translation
For more information, see the Authentication Overview .
Example
A sentence pair.
| JSON representation |
|---|
{ "name" : string , "sourceText" : string , "targetText" : string , "usage" : string } |
| Fields | |
|---|---|
name
|
Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{locationId}/datasets/{datasetId}/examples/{example_id}' |
sourceText
|
Sentence in source language. |
targetText
|
Sentence in target language. |
usage
|
Output only. Usage of the sentence pair. Options are TRAIN|VALIDATION|TEST. |
