// Copyright 2025 Google LLC
//
// 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.

syntax = "proto3";

package google.cloud.aiplatform.v1beta1;

import "google/api/field_behavior.proto";
import "google/cloud/aiplatform/v1beta1/content.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "cloud.google.com/go/aiplatform/apiv1beta1/aiplatformpb;aiplatformpb";
option java_multiple_files = true;
option java_outer_classname = "ExampleProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";

// A single example of a conversation with the model.
message ContentsExample {
  // A single step of the expected output.
  message ExpectedContent {
    // Required. A single step's content.
    Content content = 1 [(google.api.field_behavior) = REQUIRED];
  }

  // Required. The content of the conversation with the model that resulted in
  // the expected output.
  repeated Content contents = 1 [(google.api.field_behavior) = REQUIRED];

  // Required. The expected output for the given `contents`. To represent
  // multi-step reasoning, this is a repeated field that contains the iterative
  // steps of the expected output.
  repeated ExpectedContent expected_contents = 2
      [(google.api.field_behavior) = REQUIRED];
}

// A ContentsExample to be used with GenerateContent alongside information
// required for storage and retrieval with Example Store.
message StoredContentsExample {
  // Options for generating the search key from the conversation history.
  message SearchKeyGenerationMethod {
    // Configuration for using only the last entry of the conversation history
    // as the search key.
    message LastEntry {}

    // The method for generating the search key.
    oneof method {
      // Use only the last entry of the conversation history
      // (`contents_example.contents`) as the search key.
      LastEntry last_entry = 1;
    }
  }

  // Optional. (Optional) the search key used for retrieval. If not provided at
  // upload-time, the search key will be generated from
  // `contents_example.contents` using the method provided by
  // `search_key_generation_method`. The generated search key will be included
  // in retrieved examples.
  string search_key = 1 [(google.api.field_behavior) = OPTIONAL];

  // Required. The example to be used with GenerateContent.
  ContentsExample contents_example = 2 [(google.api.field_behavior) = REQUIRED];

  // Optional. The method used to generate the search key from
  // `contents_example.contents`. This is ignored when uploading an example if
  // `search_key` is provided.
  SearchKeyGenerationMethod search_key_generation_method = 3
      [(google.api.field_behavior) = OPTIONAL];
}