gcp.vertex.getAiIndex
Explore with Pulumi AI
A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
Using getAiIndex
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAiIndex(args: GetAiIndexArgs, opts?: InvokeOptions): Promise<GetAiIndexResult>
function getAiIndexOutput(args: GetAiIndexOutputArgs, opts?: InvokeOptions): Output<GetAiIndexResult>
def get_ai_index(name: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAiIndexResult
def get_ai_index_output(name: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAiIndexResult]
func LookupAiIndex(ctx *Context, args *LookupAiIndexArgs, opts ...InvokeOption) (*LookupAiIndexResult, error)
func LookupAiIndexOutput(ctx *Context, args *LookupAiIndexOutputArgs, opts ...InvokeOption) LookupAiIndexResultOutput
> Note: This function is named LookupAiIndex
in the Go SDK.
public static class GetAiIndex
{
public static Task<GetAiIndexResult> InvokeAsync(GetAiIndexArgs args, InvokeOptions? opts = null)
public static Output<GetAiIndexResult> Invoke(GetAiIndexInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAiIndexResult> getAiIndex(GetAiIndexArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:vertex/getAiIndex:getAiIndex
arguments:
# arguments dictionary
The following arguments are supported:
getAiIndex Result
The following output properties are available:
- Create
Time string - Deployed
Indexes List<GetAi Index Deployed Index> - Description string
- Display
Name string - Etag string
- Id string
The provider-assigned unique ID for this managed resource.
- Index
Stats List<GetAi Index Index Stat> - Index
Update stringMethod - Labels Dictionary<string, string>
- Metadata
Schema stringUri - Metadatas
List<Get
Ai Index Metadata> - Name string
- Region string
- Update
Time string - Project string
- Create
Time string - Deployed
Indexes []GetAi Index Deployed Index - Description string
- Display
Name string - Etag string
- Id string
The provider-assigned unique ID for this managed resource.
- Index
Stats []GetAi Index Index Stat - Index
Update stringMethod - Labels map[string]string
- Metadata
Schema stringUri - Metadatas
[]Get
Ai Index Metadata - Name string
- Region string
- Update
Time string - Project string
- create
Time String - deployed
Indexes List<GetAi Index Deployed Index> - description String
- display
Name String - etag String
- id String
The provider-assigned unique ID for this managed resource.
- index
Stats List<GetAi Index Index Stat> - index
Update StringMethod - labels Map<String,String>
- metadata
Schema StringUri - metadatas
List<Get
Ai Index Metadata> - name String
- region String
- update
Time String - project String
- create
Time string - deployed
Indexes GetAi Index Deployed Index[] - description string
- display
Name string - etag string
- id string
The provider-assigned unique ID for this managed resource.
- index
Stats GetAi Index Index Stat[] - index
Update stringMethod - labels {[key: string]: string}
- metadata
Schema stringUri - metadatas
Get
Ai Index Metadata[] - name string
- region string
- update
Time string - project string
- create_
time str - deployed_
indexes Sequence[GetAi Index Deployed Index] - description str
- display_
name str - etag str
- id str
The provider-assigned unique ID for this managed resource.
- index_
stats Sequence[GetAi Index Index Stat] - index_
update_ strmethod - labels Mapping[str, str]
- metadata_
schema_ struri - metadatas
Sequence[Get
Ai Index Metadata] - name str
- region str
- update_
time str - project str
- create
Time String - deployed
Indexes List<Property Map> - description String
- display
Name String - etag String
- id String
The provider-assigned unique ID for this managed resource.
- index
Stats List<Property Map> - index
Update StringMethod - labels Map<String>
- metadata
Schema StringUri - metadatas List<Property Map>
- name String
- region String
- update
Time String - project String
Supporting Types
GetAiIndexDeployedIndex
- Deployed
Index stringId - Index
Endpoint string
- Deployed
Index stringId - Index
Endpoint string
- deployed
Index StringId - index
Endpoint String
- deployed
Index stringId - index
Endpoint string
- deployed_
index_ strid - index_
endpoint str
- deployed
Index StringId - index
Endpoint String
GetAiIndexIndexStat
- int
- Vectors
Count string
- int
- Vectors
Count string
- Integer
- vectors
Count String
- number
- vectors
Count string
- int
- vectors_
count str
- Number
- vectors
Count String
GetAiIndexMetadata
- configs List<Property Map>
- contents
Delta StringUri - is
Complete BooleanOverwrite
GetAiIndexMetadataConfig
- algorithm
Configs List<GetAi Index Metadata Config Algorithm Config> - approximate
Neighbors IntegerCount - dimensions Integer
- distance
Measure StringType - feature
Norm StringType - String
- algorithm
Configs GetAi Index Metadata Config Algorithm Config[] - approximate
Neighbors numberCount - dimensions number
- distance
Measure stringType - feature
Norm stringType - string
- algorithm
Configs List<Property Map> - approximate
Neighbors NumberCount - dimensions Number
- distance
Measure StringType - feature
Norm StringType - String
GetAiIndexMetadataConfigAlgorithmConfig
GetAiIndexMetadataConfigAlgorithmConfigTreeAhConfig
- leaf
Node IntegerEmbedding Count - leaf
Nodes IntegerTo Search Percent
- leaf
Node numberEmbedding Count - leaf
Nodes numberTo Search Percent
- leaf
Node NumberEmbedding Count - leaf
Nodes NumberTo Search Percent
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.