com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dialogflow Show documentation
The 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.dialogflow.v3.model;

/**
 * Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You
 * are a helpful and verbose at , . Your task is to help humans on ".
 *
 *  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 Dialogflow 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 GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings extends com.google.api.client.json.GenericJson {

  /**
   * Name of the virtual agent. Used for LLM prompt. Can be left empty.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String agent;

  /**
   * Identity of the agent, e.g. "virtual agent", "AI assistant".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String agentIdentity;

  /**
   * Agent scope, e.g. "Example company website", "internal Example company website for employees",
   * "manual of car owner".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String agentScope;

  /**
   * Name of the company, organization or other entity that the agent represents. Used for knowledge
   * connector LLM prompt and for knowledge search.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String business;

  /**
   * Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee
   * beans".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String businessDescription;

  /**
   * Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a
   * proper answer). Per default the feature is enabled.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean disableDataStoreFallback;

  /**
   * Name of the virtual agent. Used for LLM prompt. Can be left empty.
   * @return value or {@code null} for none
   */
  public java.lang.String getAgent() {
    return agent;
  }

  /**
   * Name of the virtual agent. Used for LLM prompt. Can be left empty.
   * @param agent agent or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings setAgent(java.lang.String agent) {
    this.agent = agent;
    return this;
  }

  /**
   * Identity of the agent, e.g. "virtual agent", "AI assistant".
   * @return value or {@code null} for none
   */
  public java.lang.String getAgentIdentity() {
    return agentIdentity;
  }

  /**
   * Identity of the agent, e.g. "virtual agent", "AI assistant".
   * @param agentIdentity agentIdentity or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings setAgentIdentity(java.lang.String agentIdentity) {
    this.agentIdentity = agentIdentity;
    return this;
  }

  /**
   * Agent scope, e.g. "Example company website", "internal Example company website for employees",
   * "manual of car owner".
   * @return value or {@code null} for none
   */
  public java.lang.String getAgentScope() {
    return agentScope;
  }

  /**
   * Agent scope, e.g. "Example company website", "internal Example company website for employees",
   * "manual of car owner".
   * @param agentScope agentScope or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings setAgentScope(java.lang.String agentScope) {
    this.agentScope = agentScope;
    return this;
  }

  /**
   * Name of the company, organization or other entity that the agent represents. Used for knowledge
   * connector LLM prompt and for knowledge search.
   * @return value or {@code null} for none
   */
  public java.lang.String getBusiness() {
    return business;
  }

  /**
   * Name of the company, organization or other entity that the agent represents. Used for knowledge
   * connector LLM prompt and for knowledge search.
   * @param business business or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings setBusiness(java.lang.String business) {
    this.business = business;
    return this;
  }

  /**
   * Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee
   * beans".
   * @return value or {@code null} for none
   */
  public java.lang.String getBusinessDescription() {
    return businessDescription;
  }

  /**
   * Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee
   * beans".
   * @param businessDescription businessDescription or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings setBusinessDescription(java.lang.String businessDescription) {
    this.businessDescription = businessDescription;
    return this;
  }

  /**
   * Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a
   * proper answer). Per default the feature is enabled.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDisableDataStoreFallback() {
    return disableDataStoreFallback;
  }

  /**
   * Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a
   * proper answer). Per default the feature is enabled.
   * @param disableDataStoreFallback disableDataStoreFallback or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings setDisableDataStoreFallback(java.lang.Boolean disableDataStoreFallback) {
    this.disableDataStoreFallback = disableDataStoreFallback;
    return this;
  }

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

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

}