1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/aiplatform/v1beta1/explanation.proto 18 19 package com.google.cloud.aiplatform.v1beta1; 20 21 public interface ExamplesOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.aiplatform.v1beta1.Examples) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The Cloud Storage input instances. 31 * </pre> 32 * 33 * <code>.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;</code> 34 * 35 * @return Whether the exampleGcsSource field is set. 36 */ hasExampleGcsSource()37 boolean hasExampleGcsSource(); 38 /** 39 * 40 * 41 * <pre> 42 * The Cloud Storage input instances. 43 * </pre> 44 * 45 * <code>.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;</code> 46 * 47 * @return The exampleGcsSource. 48 */ getExampleGcsSource()49 com.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource getExampleGcsSource(); 50 /** 51 * 52 * 53 * <pre> 54 * The Cloud Storage input instances. 55 * </pre> 56 * 57 * <code>.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;</code> 58 */ 59 com.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()60 getExampleGcsSourceOrBuilder(); 61 62 /** 63 * 64 * 65 * <pre> 66 * The full configuration for the generated index, the semantics are the 67 * same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and 68 * should match 69 * [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). 70 * </pre> 71 * 72 * <code>.google.protobuf.Value nearest_neighbor_search_config = 2;</code> 73 * 74 * @return Whether the nearestNeighborSearchConfig field is set. 75 */ hasNearestNeighborSearchConfig()76 boolean hasNearestNeighborSearchConfig(); 77 /** 78 * 79 * 80 * <pre> 81 * The full configuration for the generated index, the semantics are the 82 * same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and 83 * should match 84 * [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). 85 * </pre> 86 * 87 * <code>.google.protobuf.Value nearest_neighbor_search_config = 2;</code> 88 * 89 * @return The nearestNeighborSearchConfig. 90 */ getNearestNeighborSearchConfig()91 com.google.protobuf.Value getNearestNeighborSearchConfig(); 92 /** 93 * 94 * 95 * <pre> 96 * The full configuration for the generated index, the semantics are the 97 * same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and 98 * should match 99 * [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config). 100 * </pre> 101 * 102 * <code>.google.protobuf.Value nearest_neighbor_search_config = 2;</code> 103 */ getNearestNeighborSearchConfigOrBuilder()104 com.google.protobuf.ValueOrBuilder getNearestNeighborSearchConfigOrBuilder(); 105 106 /** 107 * 108 * 109 * <pre> 110 * Simplified preset configuration, which automatically sets configuration 111 * values based on the desired query speed-precision trade-off and modality. 112 * </pre> 113 * 114 * <code>.google.cloud.aiplatform.v1beta1.Presets presets = 4;</code> 115 * 116 * @return Whether the presets field is set. 117 */ hasPresets()118 boolean hasPresets(); 119 /** 120 * 121 * 122 * <pre> 123 * Simplified preset configuration, which automatically sets configuration 124 * values based on the desired query speed-precision trade-off and modality. 125 * </pre> 126 * 127 * <code>.google.cloud.aiplatform.v1beta1.Presets presets = 4;</code> 128 * 129 * @return The presets. 130 */ getPresets()131 com.google.cloud.aiplatform.v1beta1.Presets getPresets(); 132 /** 133 * 134 * 135 * <pre> 136 * Simplified preset configuration, which automatically sets configuration 137 * values based on the desired query speed-precision trade-off and modality. 138 * </pre> 139 * 140 * <code>.google.cloud.aiplatform.v1beta1.Presets presets = 4;</code> 141 */ getPresetsOrBuilder()142 com.google.cloud.aiplatform.v1beta1.PresetsOrBuilder getPresetsOrBuilder(); 143 144 /** 145 * 146 * 147 * <pre> 148 * The Cloud Storage locations that contain the instances to be 149 * indexed for approximate nearest neighbor search. 150 * </pre> 151 * 152 * <code>.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;</code> 153 * 154 * @return Whether the gcsSource field is set. 155 */ hasGcsSource()156 boolean hasGcsSource(); 157 /** 158 * 159 * 160 * <pre> 161 * The Cloud Storage locations that contain the instances to be 162 * indexed for approximate nearest neighbor search. 163 * </pre> 164 * 165 * <code>.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;</code> 166 * 167 * @return The gcsSource. 168 */ getGcsSource()169 com.google.cloud.aiplatform.v1beta1.GcsSource getGcsSource(); 170 /** 171 * 172 * 173 * <pre> 174 * The Cloud Storage locations that contain the instances to be 175 * indexed for approximate nearest neighbor search. 176 * </pre> 177 * 178 * <code>.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;</code> 179 */ getGcsSourceOrBuilder()180 com.google.cloud.aiplatform.v1beta1.GcsSourceOrBuilder getGcsSourceOrBuilder(); 181 182 /** 183 * 184 * 185 * <pre> 186 * The number of neighbors to return when querying for examples. 187 * </pre> 188 * 189 * <code>int32 neighbor_count = 3;</code> 190 * 191 * @return The neighborCount. 192 */ getNeighborCount()193 int getNeighborCount(); 194 getSourceCase()195 public com.google.cloud.aiplatform.v1beta1.Examples.SourceCase getSourceCase(); 196 getConfigCase()197 public com.google.cloud.aiplatform.v1beta1.Examples.ConfigCase getConfigCase(); 198 } 199