close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a Model.

Args:
parent: string, Required. The project name, in form of `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:

{ # A trained translation model.
"createTime": "A String", # Output only. Timestamp when the model resource was created, which is also when the training started.
"dataset": "A String", # The dataset from which the model is trained, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}`
"displayName": "A String", # The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9.
"name": "A String", # The resource name of the model, in form of `projects/{project-number-or-id}/locations/{location_id}/models/{model_id}`
"sourceLanguageCode": "A String", # Output only. The BCP-47 language code of the source language.
"targetLanguageCode": "A String", # Output only. The BCP-47 language code of the target language.
"testExampleCount": 42, # Output only. Number of examples (sentence pairs) used to test the model.
"trainExampleCount": 42, # Output only. Number of examples (sentence pairs) used to train the model.
"updateTime": "A String", # Output only. Timestamp when this model was last updated.
"validateExampleCount": 42, # Output only. Number of examples (sentence pairs) used to validate the model.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, x__xgafv=None)

Deletes a model.

Args:
name: string, Required. The name of the model to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets a model.

Args:
  name: string, Required. The resource name of the model to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A trained translation model.
  "createTime": "A String", # Output only. Timestamp when the model resource was created, which is also when the training started.
  "dataset": "A String", # The dataset from which the model is trained, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}`
  "displayName": "A String", # The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9.
  "name": "A String", # The resource name of the model, in form of `projects/{project-number-or-id}/locations/{location_id}/models/{model_id}`
  "sourceLanguageCode": "A String", # Output only. The BCP-47 language code of the source language.
  "targetLanguageCode": "A String", # Output only. The BCP-47 language code of the target language.
  "testExampleCount": 42, # Output only. Number of examples (sentence pairs) used to test the model.
  "trainExampleCount": 42, # Output only. Number of examples (sentence pairs) used to train the model.
  "updateTime": "A String", # Output only. Timestamp when this model was last updated.
  "validateExampleCount": 42, # Output only. Number of examples (sentence pairs) used to validate the model.
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists models.

Args:
  parent: string, Required. Name of the parent project. In form of `projects/{project-number-or-id}/locations/{location-id}` (required)
  filter: string, Optional. An expression for filtering the models that will be returned. Supported filter: `dataset_id=${dataset_id}`
  pageSize: integer, Optional. Requested page size. The server can return fewer results than requested.
  pageToken: string, Optional. A token identifying a page of results for the server to return. Typically obtained from next_page_token field in the response of a ListModels call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListModels.
  "models": [ # The models read.
    { # A trained translation model.
      "createTime": "A String", # Output only. Timestamp when the model resource was created, which is also when the training started.
      "dataset": "A String", # The dataset from which the model is trained, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}`
      "displayName": "A String", # The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9.
      "name": "A String", # The resource name of the model, in form of `projects/{project-number-or-id}/locations/{location_id}/models/{model_id}`
      "sourceLanguageCode": "A String", # Output only. The BCP-47 language code of the source language.
      "targetLanguageCode": "A String", # Output only. The BCP-47 language code of the target language.
      "testExampleCount": 42, # Output only. Number of examples (sentence pairs) used to test the model.
      "trainExampleCount": 42, # Output only. Number of examples (sentence pairs) used to train the model.
      "updateTime": "A String", # Output only. Timestamp when this model was last updated.
      "validateExampleCount": 42, # Output only. Number of examples (sentence pairs) used to validate the model.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve next page of results. Pass this token to the page_token field in the ListModelsRequest to obtain the corresponding page.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

Cloud Translation API . projects . locations . models

Instance Methods

Method Details