Docs Packages
  1. Packages
  2. Pinecone
  3. API Docs
  4. lookupPineconeIndex
Pinecone v0.4.3 published on Thursday, May 9, 2024 by pinecone-io
pinecone-io/pulumi-pinecone

pinecone.lookupPineconeIndex

Explore with Pulumi AI

pinecone logo
Pinecone v0.4.3 published on Thursday, May 9, 2024 by pinecone-io
pinecone-io/pulumi-pinecone

    Using lookupPineconeIndex

    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 lookupPineconeIndex(args: LookupPineconeIndexArgs, opts?: InvokeOptions): Promise<LookupPineconeIndexResult>
function lookupPineconeIndexOutput(args: LookupPineconeIndexOutputArgs, opts?: InvokeOptions): Output<LookupPineconeIndexResult>
    def lookup_pinecone_index(name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> LookupPineconeIndexResult
def lookup_pinecone_index_output(name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[LookupPineconeIndexResult]
    func LookupPineconeIndex(ctx *Context, args *LookupPineconeIndexArgs, opts ...InvokeOption) (*LookupPineconeIndexResult, error)
func LookupPineconeIndexOutput(ctx *Context, args *LookupPineconeIndexOutputArgs, opts ...InvokeOption) LookupPineconeIndexResultOutput

    > Note: This function is named LookupPineconeIndex in the Go SDK.

    public static class LookupPineconeIndex 
{
    public static Task<LookupPineconeIndexResult> InvokeAsync(LookupPineconeIndexArgs args, InvokeOptions? opts = null)
    public static Output<LookupPineconeIndexResult> Invoke(LookupPineconeIndexInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<LookupPineconeIndexResult> lookupPineconeIndex(LookupPineconeIndexArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: pinecone:lookupPineconeIndex
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Pinecone index.
    Name string
    The name of the Pinecone index.
    name String
    The name of the Pinecone index.
    name string
    The name of the Pinecone index.
    name str
    The name of the Pinecone index.
    name String
    The name of the Pinecone index.

    lookupPineconeIndex Result

    The following output properties are available:

    Host string
    The host of the index.
    Metric PineconeDatabase.Pinecone.IndexMetric
    The metric used to compute the distance between vectors.
    Name string
    The name of the Pinecone index.
    Spec PineconeDatabase.Pinecone.Outputs.PineconeSpec
    Describe how the index should be deployed.
    Status bool
    The status of the index.
    Dimension int
    The dimensions of the vectors in the index. Defaults to 1536.
    Host string
    The host of the index.
    Metric IndexMetric
    The metric used to compute the distance between vectors.
    Name string
    The name of the Pinecone index.
    Spec PineconeSpec
    Describe how the index should be deployed.
    Status bool
    The status of the index.
    Dimension int
    The dimensions of the vectors in the index. Defaults to 1536.
    host String
    The host of the index.
    metric IndexMetric
    The metric used to compute the distance between vectors.
    name String
    The name of the Pinecone index.
    spec PineconeSpec
    Describe how the index should be deployed.
    status Boolean
    The status of the index.
    dimension Integer
    The dimensions of the vectors in the index. Defaults to 1536.
    host string
    The host of the index.
    metric IndexMetric
    The metric used to compute the distance between vectors.
    name string
    The name of the Pinecone index.
    spec PineconeSpec
    Describe how the index should be deployed.
    status boolean
    The status of the index.
    dimension number
    The dimensions of the vectors in the index. Defaults to 1536.
    host str
    The host of the index.
    metric IndexMetric
    The metric used to compute the distance between vectors.
    name str
    The name of the Pinecone index.
    spec PineconeSpec
    Describe how the index should be deployed.
    status bool
    The status of the index.
    dimension int
    The dimensions of the vectors in the index. Defaults to 1536.
    host String
    The host of the index.
    metric "dotproduct" | "cosine" | "euclidean"
    The metric used to compute the distance between vectors.
    name String
    The name of the Pinecone index.
    spec Property Map
    Describe how the index should be deployed.
    status Boolean
    The status of the index.
    dimension Number
    The dimensions of the vectors in the index. Defaults to 1536.

    Supporting Types

    IndexMetric

    MetaDataConfig

    Indexed List<string>
    Indexed By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields which should be indexed.
    Indexed []string
    Indexed By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields which should be indexed.
    indexed List<String>
    Indexed By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields which should be indexed.
    indexed string[]
    Indexed By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields which should be indexed.
    indexed Sequence[str]
    Indexed By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields which should be indexed.
    indexed List<String>
    Indexed By default, all metadata is indexed; to change this behavior, use this property to specify an array of metadata fields which should be indexed.

    PineconePodSpec

    Environment string
    The environment where the index is hosted.
    PodType string
    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
    Replicas int
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
    MetaDataConfig PineconeDatabase.Pinecone.Inputs.MetaDataConfig
    Configuration for the behavior of Pinecone's internal metadata index.
    Pods int
    The number of pods to be used in the index. This should be equal to shards x replicas.
    Shards int
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
    SourceCollection string
    The name of the collection to be used as the source for the index.
    Environment string
    The environment where the index is hosted.
    PodType string
    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
    Replicas int
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
    MetaDataConfig MetaDataConfig
    Configuration for the behavior of Pinecone's internal metadata index.
    Pods int
    The number of pods to be used in the index. This should be equal to shards x replicas.
    Shards int
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
    SourceCollection string
    The name of the collection to be used as the source for the index.
    environment String
    The environment where the index is hosted.
    podType String
    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
    replicas Integer
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
    metaDataConfig MetaDataConfig
    Configuration for the behavior of Pinecone's internal metadata index.
    pods Integer
    The number of pods to be used in the index. This should be equal to shards x replicas.
    shards Integer
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
    sourceCollection String
    The name of the collection to be used as the source for the index.
    environment string
    The environment where the index is hosted.
    podType string
    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
    replicas number
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
    metaDataConfig MetaDataConfig
    Configuration for the behavior of Pinecone's internal metadata index.
    pods number
    The number of pods to be used in the index. This should be equal to shards x replicas.
    shards number
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
    sourceCollection string
    The name of the collection to be used as the source for the index.
    environment str
    The environment where the index is hosted.
    pod_type str
    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
    replicas int
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
    meta_data_config MetaDataConfig
    Configuration for the behavior of Pinecone's internal metadata index.
    pods int
    The number of pods to be used in the index. This should be equal to shards x replicas.
    shards int
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
    source_collection str
    The name of the collection to be used as the source for the index.
    environment String
    The environment where the index is hosted.
    podType String
    The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.
    replicas Number
    The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.
    metaDataConfig Property Map
    Configuration for the behavior of Pinecone's internal metadata index.
    pods Number
    The number of pods to be used in the index. This should be equal to shards x replicas.
    shards Number
    The number of shards. Shards split your data across multiple pods so you can fit more data into an index.
    sourceCollection String
    The name of the collection to be used as the source for the index.

    PineconeServerlessSpec

    Cloud PineconeDatabase.Pinecone.ServerlessSpecCloud
    The public cloud where you would like your index hosted.
    Region string
    The region where you would like your index to be created. Different cloud providers have different regions available.
    Cloud ServerlessSpecCloud
    The public cloud where you would like your index hosted.
    Region string
    The region where you would like your index to be created. Different cloud providers have different regions available.
    cloud ServerlessSpecCloud
    The public cloud where you would like your index hosted.
    region String
    The region where you would like your index to be created. Different cloud providers have different regions available.
    cloud ServerlessSpecCloud
    The public cloud where you would like your index hosted.
    region string
    The region where you would like your index to be created. Different cloud providers have different regions available.
    cloud ServerlessSpecCloud
    The public cloud where you would like your index hosted.
    region str
    The region where you would like your index to be created. Different cloud providers have different regions available.
    cloud "aws" | "azure" | "gcp"
    The public cloud where you would like your index hosted.
    region String
    The region where you would like your index to be created. Different cloud providers have different regions available.

    PineconeSpec

    Pod PineconeDatabase.Pinecone.Inputs.PineconePodSpec
    Configuration needed to deploy a pod index.
    Serverless PineconeDatabase.Pinecone.Inputs.PineconeServerlessSpec
    Configuration needed to deploy a serverless index.
    Pod PineconePodSpec
    Configuration needed to deploy a pod index.
    Serverless PineconeServerlessSpec
    Configuration needed to deploy a serverless index.
    pod PineconePodSpec
    Configuration needed to deploy a pod index.
    serverless PineconeServerlessSpec
    Configuration needed to deploy a serverless index.
    pod PineconePodSpec
    Configuration needed to deploy a pod index.
    serverless PineconeServerlessSpec
    Configuration needed to deploy a serverless index.
    pod PineconePodSpec
    Configuration needed to deploy a pod index.
    serverless PineconeServerlessSpec
    Configuration needed to deploy a serverless index.
    pod Property Map
    Configuration needed to deploy a pod index.
    serverless Property Map
    Configuration needed to deploy a serverless index.

    ServerlessSpecCloud

    Package Details

    Repository
    pinecone pinecone-io/pulumi-pinecone
    License
    Apache-2.0
    pinecone logo
    Pinecone v0.4.3 published on Thursday, May 9, 2024 by pinecone-io
    pinecone-io/pulumi-pinecone