Remove raw html from proto comments as this breaks client library documentation generators.

See https://aip.dev/192

> Any formatting in comments must be in CommonMark. Headings and tables must not be used, as these cause problems for several tools, and are unsuitable for client library reference documentation.
>
> Comments should use code font for property names and for literals (such as true).
>
> Raw HTML must not be used.

PiperOrigin-RevId: 308716969
This commit is contained in:
Google APIs 2020-04-27 16:03:26 -07:00 committed by Copybara-Service
parent c2bfceedfc
commit 371206424e
1 changed files with 42 additions and 46 deletions

View File

@ -46,42 +46,38 @@ service PredictionService {
// returned in the response.
// Available for following ML scenarios, and their expected request payloads:
//
// <table>
// <tr>
// <td>AutoML Vision Classification</td>
// <td>An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.</td>
// </tr>
// <tr>
// <td>AutoML Vision Object Detection</td>
// <td>An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.</td>
// </tr>
// <tr>
// <td>AutoML Natural Language Classification</td>
// <td>A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in
// .PDF, .TIF or .TIFF format with size upto 2MB.</td>
// </tr>
// <tr>
// <td>AutoML Natural Language Entity Extraction</td>
// <td>A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document
// in .PDF, .TIF or .TIFF format with size upto 20MB.</td>
// </tr>
// <tr>
// <td>AutoML Natural Language Sentiment Analysis</td>
// <td>A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in
// .PDF, .TIF or .TIFF format with size upto 2MB.</td>
// </tr>
// <tr>
// <td>AutoML Translation</td>
// <td>A TextSnippet up to 25,000 characters, UTF-8 encoded.</td>
// </tr>
// <tr>
// <td>AutoML Tables</td>
// <td>A row with column values matching
// AutoML Vision Classification
//
// * An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.
//
// AutoML Vision Object Detection
//
// * An image in .JPEG, .GIF or .PNG format, image_bytes up to 30MB.
//
// AutoML Natural Language Classification
//
// * A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in
// .PDF, .TIF or .TIFF format with size upto 2MB.
//
// AutoML Natural Language Entity Extraction
//
// * A TextSnippet up to 10,000 characters, UTF-8 NFC encoded or a document
// in .PDF, .TIF or .TIFF format with size upto 20MB.
//
// AutoML Natural Language Sentiment Analysis
//
// * A TextSnippet up to 60,000 characters, UTF-8 encoded or a document in
// .PDF, .TIF or .TIFF format with size upto 2MB.
//
// AutoML Translation
//
// * A TextSnippet up to 25,000 characters, UTF-8 encoded.
//
// AutoML Tables
//
// * A row with column values matching
// the columns of the model, up to 5MB. Not available for FORECASTING
// `prediction_type`.
// </td>
// </tr>
// </table>
rpc Predict(PredictRequest) returns (PredictResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/models/*}:predict"
@ -135,14 +131,14 @@ message PredictRequest {
// Additional domain-specific parameters, any string must be up to 25000
// characters long.
//
// <h4>AutoML Vision Classification</h4>
// AutoML Vision Classification
//
// `score_threshold`
// : (float) A value from 0.0 to 1.0. When the model
// makes predictions for an image, it will only produce results that have
// at least this confidence score. The default is 0.5.
//
// <h4>AutoML Vision Object Detection</h4>
// AutoML Vision Object Detection
//
// `score_threshold`
// : (float) When Model detects objects on the image,
@ -154,7 +150,7 @@ message PredictRequest {
// boxes returned. The default is 100. The
// number of returned bounding boxes might be limited by the server.
//
// <h4>AutoML Tables</h4>
// AutoML Tables
//
// `feature_importance`
// : (boolean) Whether
@ -185,12 +181,12 @@ message PredictResponse {
// Additional domain-specific prediction response metadata.
//
// <h4>AutoML Vision Object Detection</h4>
// AutoML Vision Object Detection
//
// `max_bounding_box_count`
// : (int64) The maximum number of bounding boxes to return per image.
//
// <h4>AutoML Natural Language Sentiment Analysis</h4>
// AutoML Natural Language Sentiment Analysis
//
// `sentiment_score`
// : (float, deprecated) A value between -1 and 1,
@ -224,7 +220,7 @@ message BatchPredictRequest {
// Additional domain-specific parameters for the predictions, any string must
// be up to 25000 characters long.
//
// <h4>AutoML Natural Language Classification</h4>
// AutoML Natural Language Classification
//
// `score_threshold`
// : (float) A value from 0.0 to 1.0. When the model
@ -232,14 +228,14 @@ message BatchPredictRequest {
// that have at least this confidence score. The default is 0.5.
//
//
// <h4>AutoML Vision Classification</h4>
// AutoML Vision Classification
//
// `score_threshold`
// : (float) A value from 0.0 to 1.0. When the model
// makes predictions for an image, it will only produce results that
// have at least this confidence score. The default is 0.5.
//
// <h4>AutoML Vision Object Detection</h4>
// AutoML Vision Object Detection
//
// `score_threshold`
// : (float) When Model detects objects on the image,
@ -250,7 +246,7 @@ message BatchPredictRequest {
// : (int64) The maximum number of bounding
// boxes returned per image. The default is 100, the
// number of bounding boxes returned might be limited by the server.
// <h4>AutoML Video Intelligence Classification</h4>
// AutoML Video Intelligence Classification
//
// `score_threshold`
// : (float) A value from 0.0 to 1.0. When the model
@ -288,7 +284,7 @@ message BatchPredictRequest {
// type, the quality of it depends on training data, but there are no
// metrics provided to describe that quality.
//
// <h4>AutoML Video Intelligence Object Tracking</h4>
// AutoML Video Intelligence Object Tracking
//
// `score_threshold`
// : (float) When Model detects objects on video frames,
@ -314,12 +310,12 @@ message BatchPredictRequest {
message BatchPredictResult {
// Additional domain-specific prediction response metadata.
//
// <h4>AutoML Vision Object Detection</h4>
// AutoML Vision Object Detection
//
// `max_bounding_box_count`
// : (int64) The maximum number of bounding boxes returned per image.
//
// <h4>AutoML Video Intelligence Object Tracking</h4>
// AutoML Video Intelligence Object Tracking
//
// `max_bounding_box_count`
// : (int64) The maximum number of bounding boxes returned per frame.