1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 cnrm.cloud.google.com/version: 0.0.0-dev
6 creationTimestamp: null
7 labels:
8 cnrm.cloud.google.com/managed-by-kcc: "true"
9 cnrm.cloud.google.com/stability-level: alpha
10 cnrm.cloud.google.com/system: "true"
11 cnrm.cloud.google.com/tf2crd: "true"
12 name: vertexaiindexes.vertexai.cnrm.cloud.google.com
13spec:
14 group: vertexai.cnrm.cloud.google.com
15 names:
16 categories:
17 - gcp
18 kind: VertexAIIndex
19 plural: vertexaiindexes
20 shortNames:
21 - gcpvertexaiindex
22 - gcpvertexaiindexes
23 singular: vertexaiindex
24 preserveUnknownFields: false
25 scope: Namespaced
26 versions:
27 - additionalPrinterColumns:
28 - jsonPath: .metadata.creationTimestamp
29 name: Age
30 type: date
31 - description: When 'True', the most recent reconcile of the resource succeeded
32 jsonPath: .status.conditions[?(@.type=='Ready')].status
33 name: Ready
34 type: string
35 - description: The reason for the value in 'Ready'
36 jsonPath: .status.conditions[?(@.type=='Ready')].reason
37 name: Status
38 type: string
39 - description: The last transition time for the value in 'Status'
40 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
41 name: Status Age
42 type: date
43 name: v1alpha1
44 schema:
45 openAPIV3Schema:
46 properties:
47 apiVersion:
48 description: 'apiVersion defines the versioned schema of this representation
49 of an object. Servers should convert recognized schemas to the latest
50 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
51 type: string
52 kind:
53 description: 'kind is a string value representing the REST resource this
54 object represents. Servers may infer this from the endpoint the client
55 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
56 type: string
57 metadata:
58 type: object
59 spec:
60 properties:
61 description:
62 description: The description of the Index.
63 type: string
64 displayName:
65 description: The display name of the Index. The name can be up to
66 128 characters long and can consist of any UTF-8 characters.
67 type: string
68 indexUpdateMethod:
69 description: |-
70 Immutable. The update method to use with this Index. The value must be the followings. If not set, BATCH_UPDATE will be used by default.
71 * BATCH_UPDATE: user can call indexes.patch with files on Cloud Storage of datapoints to update.
72 * STREAM_UPDATE: user can call indexes.upsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
73 type: string
74 metadata:
75 description: An additional information about the Index.
76 properties:
77 config:
78 description: Immutable. The configuration of the Matching Engine
79 Index.
80 properties:
81 algorithmConfig:
82 description: The configuration with regard to the algorithms
83 used for efficient search.
84 properties:
85 bruteForceConfig:
86 description: |-
87 Configuration options for using brute force search, which simply implements the
88 standard linear search in the database for each query.
89 type: object
90 x-kubernetes-preserve-unknown-fields: true
91 treeAhConfig:
92 description: |-
93 Configuration options for using the tree-AH algorithm (Shallow tree + Asymmetric Hashing).
94 Please refer to this paper for more details: https://arxiv.org/abs/1908.10396.
95 properties:
96 leafNodeEmbeddingCount:
97 description: Number of embeddings on each leaf node.
98 The default value is 1000 if not set.
99 type: integer
100 leafNodesToSearchPercent:
101 description: |-
102 The default percentage of leaf nodes that any query may be searched. Must be in
103 range 1-100, inclusive. The default value is 10 (means 10%) if not set.
104 type: integer
105 type: object
106 type: object
107 approximateNeighborsCount:
108 description: |-
109 The default number of neighbors to find via approximate search before exact reordering is
110 performed. Exact reordering is a procedure where results returned by an
111 approximate search algorithm are reordered via a more expensive distance computation.
112 Required if tree-AH algorithm is used.
113 type: integer
114 dimensions:
115 description: The number of dimensions of the input vectors.
116 type: integer
117 distanceMeasureType:
118 description: |-
119 The distance measure used in nearest neighbor search. The value must be one of the followings:
120 * SQUARED_L2_DISTANCE: Euclidean (L_2) Distance
121 * L1_DISTANCE: Manhattan (L_1) Distance
122 * COSINE_DISTANCE: Cosine Distance. Defined as 1 - cosine similarity.
123 * DOT_PRODUCT_DISTANCE: Dot Product Distance. Defined as a negative of the dot product.
124 type: string
125 featureNormType:
126 description: |-
127 Type of normalization to be carried out on each vector. The value must be one of the followings:
128 * UNIT_L2_NORM: Unit L2 normalization type
129 * NONE: No normalization type is specified.
130 type: string
131 required:
132 - dimensions
133 type: object
134 contentsDeltaUri:
135 description: |-
136 Allows inserting, updating or deleting the contents of the Matching Engine Index.
137 The string must be a valid Cloud Storage directory path. If this
138 field is set when calling IndexService.UpdateIndex, then no other
139 Index field can be also updated as part of the same call.
140 The expected structure and format of the files this URI points to is
141 described at https://cloud.google.com/vertex-ai/docs/matching-engine/using-matching-engine#input-data-format.
142 type: string
143 isCompleteOverwrite:
144 description: |-
145 If this field is set together with contentsDeltaUri when calling IndexService.UpdateIndex,
146 then existing content of the Index will be replaced by the data from the contentsDeltaUri.
147 type: boolean
148 type: object
149 projectRef:
150 description: The project that this resource belongs to.
151 oneOf:
152 - not:
153 required:
154 - external
155 required:
156 - name
157 - not:
158 anyOf:
159 - required:
160 - name
161 - required:
162 - namespace
163 required:
164 - external
165 properties:
166 external:
167 description: 'Allowed value: The `name` field of a `Project` resource.'
168 type: string
169 name:
170 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
171 type: string
172 namespace:
173 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
174 type: string
175 type: object
176 region:
177 description: Immutable. The region of the index. eg us-central1.
178 type: string
179 resourceID:
180 description: Immutable. Optional. The service-generated name of the
181 resource. Used for acquisition only. Leave unset to create a new
182 resource.
183 type: string
184 required:
185 - displayName
186 - projectRef
187 - region
188 type: object
189 status:
190 properties:
191 conditions:
192 description: Conditions represent the latest available observation
193 of the resource's current state.
194 items:
195 properties:
196 lastTransitionTime:
197 description: Last time the condition transitioned from one status
198 to another.
199 type: string
200 message:
201 description: Human-readable message indicating details about
202 last transition.
203 type: string
204 reason:
205 description: Unique, one-word, CamelCase reason for the condition's
206 last transition.
207 type: string
208 status:
209 description: Status is the status of the condition. Can be True,
210 False, Unknown.
211 type: string
212 type:
213 description: Type is the type of the condition.
214 type: string
215 type: object
216 type: array
217 createTime:
218 description: The timestamp of when the Index was created in RFC3339
219 UTC "Zulu" format, with nanosecond resolution and up to nine fractional
220 digits.
221 type: string
222 deployedIndexes:
223 description: The pointers to DeployedIndexes created from this Index.
224 An Index can be only deleted if all its DeployedIndexes had been
225 undeployed first.
226 items:
227 properties:
228 deployedIndexId:
229 description: The ID of the DeployedIndex in the above IndexEndpoint.
230 type: string
231 indexEndpoint:
232 description: A resource name of the IndexEndpoint.
233 type: string
234 type: object
235 type: array
236 etag:
237 description: Used to perform consistent read-modify-write updates.
238 type: string
239 indexStats:
240 description: Stats of the index resource.
241 items:
242 properties:
243 shardsCount:
244 description: The number of shards in the Index.
245 type: integer
246 vectorsCount:
247 description: The number of vectors in the Index.
248 type: string
249 type: object
250 type: array
251 metadataSchemaUri:
252 description: Points to a YAML file stored on Google Cloud Storage
253 describing additional information about the Index, that is specific
254 to it. Unset if the Index does not have any additional information.
255 type: string
256 name:
257 description: The resource name of the Index.
258 type: string
259 observedGeneration:
260 description: ObservedGeneration is the generation of the resource
261 that was most recently observed by the Config Connector controller.
262 If this is equal to metadata.generation, then that means that the
263 current reported status reflects the most recent desired state of
264 the resource.
265 type: integer
266 updateTime:
267 description: The timestamp of when the Index was last updated in RFC3339
268 UTC "Zulu" format, with nanosecond resolution and up to nine fractional
269 digits.
270 type: string
271 type: object
272 required:
273 - spec
274 type: object
275 served: true
276 storage: true
277 subresources:
278 status: {}
279status:
280 acceptedNames:
281 kind: ""
282 plural: ""
283 conditions: []
284 storedVersions: []
View as plain text