com.google.api.services.documentai.v1.model.GoogleCloudDocumentaiV1OcrConfigHints Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-documentai Show documentation
There is a newer version: v1-rev20241210-2.0.0
Show newest version
/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.documentai.v1.model;

/**
 * Hints for OCR Engine
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Document AI API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudDocumentaiV1OcrConfigHints extends com.google.api.client.json.GenericJson {

  /**
   * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best
   * results since it enables automatic language detection. For languages based on the Latin
   * alphabet, setting hints is not needed. In rare cases, when the language of the text in the
   * image is known, setting a hint will help get better results (although it will be a significant
   * hindrance if the hint is wrong).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List languageHints;

  /**
   * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best
   * results since it enables automatic language detection. For languages based on the Latin
   * alphabet, setting hints is not needed. In rare cases, when the language of the text in the
   * image is known, setting a hint will help get better results (although it will be a significant
   * hindrance if the hint is wrong).
   * @return value or {@code null} for none
   */
  public java.util.List getLanguageHints() {
    return languageHints;
  }

  /**
   * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best
   * results since it enables automatic language detection. For languages based on the Latin
   * alphabet, setting hints is not needed. In rare cases, when the language of the text in the
   * image is known, setting a hint will help get better results (although it will be a significant
   * hindrance if the hint is wrong).
   * @param languageHints languageHints or {@code null} for none
   */
  public GoogleCloudDocumentaiV1OcrConfigHints setLanguageHints(java.util.List languageHints) {
    this.languageHints = languageHints;
    return this;
  }

  @Override
  public GoogleCloudDocumentaiV1OcrConfigHints set(String fieldName, Object value) {
    return (GoogleCloudDocumentaiV1OcrConfigHints) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudDocumentaiV1OcrConfigHints clone() {
    return (GoogleCloudDocumentaiV1OcrConfigHints) super.clone();
  }

}