airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.DestinationAstra

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.DestinationAstra;
import com.pulumi.airbyte.DestinationAstraArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationEmbeddingArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationEmbeddingAzureOpenAiArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationEmbeddingCohereArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationEmbeddingFakeArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationEmbeddingOpenAiArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationIndexingArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationProcessingArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationProcessingTextSplitterArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs;
import com.pulumi.airbyte.inputs.DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myDestinationAstra = new DestinationAstra("myDestinationAstra", DestinationAstraArgs.builder()
            .configuration(DestinationAstraConfigurationArgs.builder()
                .embedding(DestinationAstraConfigurationEmbeddingArgs.builder()
                    .azureOpenAi(DestinationAstraConfigurationEmbeddingAzureOpenAiArgs.builder()
                        .apiBase("https://your-resource-name.openai.azure.com")
                        .deployment("your-resource-name")
                        .openaiKey("...my_openai_key...")
                        .build())
                    .cohere(DestinationAstraConfigurationEmbeddingCohereArgs.builder()
                        .cohereKey("...my_cohere_key...")
                        .build())
                    .fake()
                    .openAi(DestinationAstraConfigurationEmbeddingOpenAiArgs.builder()
                        .openaiKey("...my_openai_key...")
                        .build())
                    .openAiCompatible(DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs.builder()
                        .apiKey("...my_api_key...")
                        .baseUrl("https://your-service-name.com")
                        .dimensions(1536)
                        .modelName("text-embedding-ada-002")
                        .build())
                    .build())
                .indexing(DestinationAstraConfigurationIndexingArgs.builder()
                    .astraDbAppToken("...my_astra_db_app_token...")
                    .astraDbEndpoint("https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com")
                    .astraDbKeyspace("...my_astra_db_keyspace...")
                    .collection("...my_collection...")
                    .build())
                .omit_raw_text(false)
                .processing(DestinationAstraConfigurationProcessingArgs.builder()
                    .chunkOverlap(6)
                    .chunkSize(2127)
                    .fieldNameMappings(DestinationAstraConfigurationProcessingFieldNameMappingArgs.builder()
                        .fromField("...my_from_field...")
                        .toField("...my_to_field...")
                        .build())
                    .metadataFields("...")
                    .textFields("...")
                    .textSplitter(DestinationAstraConfigurationProcessingTextSplitterArgs.builder()
                        .byMarkdownHeader(DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs.builder()
                            .splitLevel(1)
                            .build())
                        .byProgrammingLanguage(DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs.builder()
                            .language("js")
                            .build())
                        .bySeparator(DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs.builder()
                            .keepSeparator(false)
                            .separators("...")
                            .build())
                        .build())
                    .build())
                .build())
            .definitionId("79152260-aed1-4b65-bb98-3dd0b8ec05bd")
            .workspaceId("543d6f27-bf11-4034-a571-6e04a190e68b")
            .build());

    }
}

resources:
  myDestinationAstra:
    type: airbyte:DestinationAstra
    properties:
      configuration:
        embedding:
          azureOpenAi:
            apiBase: https://your-resource-name.openai.azure.com
            deployment: your-resource-name
            openaiKey: '...my_openai_key...'
          cohere:
            cohereKey: '...my_cohere_key...'
          fake: {}
          openAi:
            openaiKey: '...my_openai_key...'
          openAiCompatible:
            apiKey: '...my_api_key...'
            baseUrl: https://your-service-name.com
            dimensions: 1536
            modelName: text-embedding-ada-002
        indexing:
          astraDbAppToken: '...my_astra_db_app_token...'
          astraDbEndpoint: https://8292d414-dd1b-4c33-8431-e838bedc04f7-us-east1.apps.astra.datastax.com
          astraDbKeyspace: '...my_astra_db_keyspace...'
          collection: '...my_collection...'
        omit_raw_text: false
        processing:
          chunkOverlap: 6
          chunkSize: 2127
          fieldNameMappings:
            - fromField: '...my_from_field...'
              toField: '...my_to_field...'
          metadataFields:
            - '...'
          textFields:
            - '...'
          textSplitter:
            byMarkdownHeader:
              splitLevel: 1
            byProgrammingLanguage:
              language: js
            bySeparator:
              keepSeparator: false
              separators:
                - '...'
      definitionId: 79152260-aed1-4b65-bb98-3dd0b8ec05bd
      workspaceId: 543d6f27-bf11-4034-a571-6e04a190e68b

Create DestinationAstra Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DestinationAstra(name: string, args: DestinationAstraArgs, opts?: CustomResourceOptions);

@overload
def DestinationAstra(resource_name: str,
                     args: DestinationAstraArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def DestinationAstra(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     configuration: Optional[DestinationAstraConfigurationArgs] = None,
                     workspace_id: Optional[str] = None,
                     definition_id: Optional[str] = None,
                     name: Optional[str] = None)

func NewDestinationAstra(ctx *Context, name string, args DestinationAstraArgs, opts ...ResourceOption) (*DestinationAstra, error)

public DestinationAstra(string name, DestinationAstraArgs args, CustomResourceOptions? opts = null)

public DestinationAstra(String name, DestinationAstraArgs args)
public DestinationAstra(String name, DestinationAstraArgs args, CustomResourceOptions options)

type: airbyte:DestinationAstra
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DestinationAstraArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DestinationAstraArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DestinationAstraArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DestinationAstraArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DestinationAstraArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var destinationAstraResource = new Airbyte.DestinationAstra("destinationAstraResource", new()
{
    Configuration = new Airbyte.Inputs.DestinationAstraConfigurationArgs
    {
        Embedding = new Airbyte.Inputs.DestinationAstraConfigurationEmbeddingArgs
        {
            AzureOpenAi = new Airbyte.Inputs.DestinationAstraConfigurationEmbeddingAzureOpenAiArgs
            {
                ApiBase = "string",
                Deployment = "string",
                OpenaiKey = "string",
            },
            Cohere = new Airbyte.Inputs.DestinationAstraConfigurationEmbeddingCohereArgs
            {
                CohereKey = "string",
            },
            Fake = null,
            OpenAi = new Airbyte.Inputs.DestinationAstraConfigurationEmbeddingOpenAiArgs
            {
                OpenaiKey = "string",
            },
            OpenAiCompatible = new Airbyte.Inputs.DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs
            {
                BaseUrl = "string",
                Dimensions = 0,
                ApiKey = "string",
                ModelName = "string",
            },
        },
        Indexing = new Airbyte.Inputs.DestinationAstraConfigurationIndexingArgs
        {
            AstraDbAppToken = "string",
            AstraDbEndpoint = "string",
            AstraDbKeyspace = "string",
            Collection = "string",
        },
        Processing = new Airbyte.Inputs.DestinationAstraConfigurationProcessingArgs
        {
            ChunkSize = 0,
            ChunkOverlap = 0,
            FieldNameMappings = new[]
            {
                new Airbyte.Inputs.DestinationAstraConfigurationProcessingFieldNameMappingArgs
                {
                    FromField = "string",
                    ToField = "string",
                },
            },
            MetadataFields = new[]
            {
                "string",
            },
            TextFields = new[]
            {
                "string",
            },
            TextSplitter = new Airbyte.Inputs.DestinationAstraConfigurationProcessingTextSplitterArgs
            {
                ByMarkdownHeader = new Airbyte.Inputs.DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs
                {
                    SplitLevel = 0,
                },
                ByProgrammingLanguage = new Airbyte.Inputs.DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs
                {
                    Language = "string",
                },
                BySeparator = new Airbyte.Inputs.DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs
                {
                    KeepSeparator = false,
                    Separators = new[]
                    {
                        "string",
                    },
                },
            },
        },
        OmitRawText = false,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
});

example, err := airbyte.NewDestinationAstra(ctx, "destinationAstraResource", &airbyte.DestinationAstraArgs{
Configuration: &.DestinationAstraConfigurationArgs{
Embedding: &.DestinationAstraConfigurationEmbeddingArgs{
AzureOpenAi: &.DestinationAstraConfigurationEmbeddingAzureOpenAiArgs{
ApiBase: pulumi.String("string"),
Deployment: pulumi.String("string"),
OpenaiKey: pulumi.String("string"),
},
Cohere: &.DestinationAstraConfigurationEmbeddingCohereArgs{
CohereKey: pulumi.String("string"),
},
Fake: &.DestinationAstraConfigurationEmbeddingFakeArgs{
},
OpenAi: &.DestinationAstraConfigurationEmbeddingOpenAiArgs{
OpenaiKey: pulumi.String("string"),
},
OpenAiCompatible: &.DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs{
BaseUrl: pulumi.String("string"),
Dimensions: pulumi.Float64(0),
ApiKey: pulumi.String("string"),
ModelName: pulumi.String("string"),
},
},
Indexing: &.DestinationAstraConfigurationIndexingArgs{
AstraDbAppToken: pulumi.String("string"),
AstraDbEndpoint: pulumi.String("string"),
AstraDbKeyspace: pulumi.String("string"),
Collection: pulumi.String("string"),
},
Processing: &.DestinationAstraConfigurationProcessingArgs{
ChunkSize: pulumi.Float64(0),
ChunkOverlap: pulumi.Float64(0),
FieldNameMappings: .DestinationAstraConfigurationProcessingFieldNameMappingArray{
&.DestinationAstraConfigurationProcessingFieldNameMappingArgs{
FromField: pulumi.String("string"),
ToField: pulumi.String("string"),
},
},
MetadataFields: pulumi.StringArray{
pulumi.String("string"),
},
TextFields: pulumi.StringArray{
pulumi.String("string"),
},
TextSplitter: &.DestinationAstraConfigurationProcessingTextSplitterArgs{
ByMarkdownHeader: &.DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs{
SplitLevel: pulumi.Float64(0),
},
ByProgrammingLanguage: &.DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs{
Language: pulumi.String("string"),
},
BySeparator: &.DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs{
KeepSeparator: pulumi.Bool(false),
Separators: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
OmitRawText: pulumi.Bool(false),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
})

var destinationAstraResource = new DestinationAstra("destinationAstraResource", DestinationAstraArgs.builder()
    .configuration(DestinationAstraConfigurationArgs.builder()
        .embedding(DestinationAstraConfigurationEmbeddingArgs.builder()
            .azureOpenAi(DestinationAstraConfigurationEmbeddingAzureOpenAiArgs.builder()
                .apiBase("string")
                .deployment("string")
                .openaiKey("string")
                .build())
            .cohere(DestinationAstraConfigurationEmbeddingCohereArgs.builder()
                .cohereKey("string")
                .build())
            .fake()
            .openAi(DestinationAstraConfigurationEmbeddingOpenAiArgs.builder()
                .openaiKey("string")
                .build())
            .openAiCompatible(DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs.builder()
                .baseUrl("string")
                .dimensions(0)
                .apiKey("string")
                .modelName("string")
                .build())
            .build())
        .indexing(DestinationAstraConfigurationIndexingArgs.builder()
            .astraDbAppToken("string")
            .astraDbEndpoint("string")
            .astraDbKeyspace("string")
            .collection("string")
            .build())
        .processing(DestinationAstraConfigurationProcessingArgs.builder()
            .chunkSize(0)
            .chunkOverlap(0)
            .fieldNameMappings(DestinationAstraConfigurationProcessingFieldNameMappingArgs.builder()
                .fromField("string")
                .toField("string")
                .build())
            .metadataFields("string")
            .textFields("string")
            .textSplitter(DestinationAstraConfigurationProcessingTextSplitterArgs.builder()
                .byMarkdownHeader(DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs.builder()
                    .splitLevel(0)
                    .build())
                .byProgrammingLanguage(DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs.builder()
                    .language("string")
                    .build())
                .bySeparator(DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs.builder()
                    .keepSeparator(false)
                    .separators("string")
                    .build())
                .build())
            .build())
        .omitRawText(false)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .build());

destination_astra_resource = airbyte.DestinationAstra("destinationAstraResource",
    configuration={
        "embedding": {
            "azure_open_ai": {
                "api_base": "string",
                "deployment": "string",
                "openai_key": "string",
            },
            "cohere": {
                "cohere_key": "string",
            },
            "fake": {},
            "open_ai": {
                "openai_key": "string",
            },
            "open_ai_compatible": {
                "base_url": "string",
                "dimensions": 0,
                "api_key": "string",
                "model_name": "string",
            },
        },
        "indexing": {
            "astra_db_app_token": "string",
            "astra_db_endpoint": "string",
            "astra_db_keyspace": "string",
            "collection": "string",
        },
        "processing": {
            "chunk_size": 0,
            "chunk_overlap": 0,
            "field_name_mappings": [{
                "from_field": "string",
                "to_field": "string",
            }],
            "metadata_fields": ["string"],
            "text_fields": ["string"],
            "text_splitter": {
                "by_markdown_header": {
                    "split_level": 0,
                },
                "by_programming_language": {
                    "language": "string",
                },
                "by_separator": {
                    "keep_separator": False,
                    "separators": ["string"],
                },
            },
        },
        "omit_raw_text": False,
    },
    workspace_id="string",
    definition_id="string",
    name="string")

const destinationAstraResource = new airbyte.DestinationAstra("destinationAstraResource", {
    configuration: {
        embedding: {
            azureOpenAi: {
                apiBase: "string",
                deployment: "string",
                openaiKey: "string",
            },
            cohere: {
                cohereKey: "string",
            },
            fake: {},
            openAi: {
                openaiKey: "string",
            },
            openAiCompatible: {
                baseUrl: "string",
                dimensions: 0,
                apiKey: "string",
                modelName: "string",
            },
        },
        indexing: {
            astraDbAppToken: "string",
            astraDbEndpoint: "string",
            astraDbKeyspace: "string",
            collection: "string",
        },
        processing: {
            chunkSize: 0,
            chunkOverlap: 0,
            fieldNameMappings: [{
                fromField: "string",
                toField: "string",
            }],
            metadataFields: ["string"],
            textFields: ["string"],
            textSplitter: {
                byMarkdownHeader: {
                    splitLevel: 0,
                },
                byProgrammingLanguage: {
                    language: "string",
                },
                bySeparator: {
                    keepSeparator: false,
                    separators: ["string"],
                },
            },
        },
        omitRawText: false,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
});

type: airbyte:DestinationAstra
properties:
    configuration:
        embedding:
            azureOpenAi:
                apiBase: string
                deployment: string
                openaiKey: string
            cohere:
                cohereKey: string
            fake: {}
            openAi:
                openaiKey: string
            openAiCompatible:
                apiKey: string
                baseUrl: string
                dimensions: 0
                modelName: string
        indexing:
            astraDbAppToken: string
            astraDbEndpoint: string
            astraDbKeyspace: string
            collection: string
        omitRawText: false
        processing:
            chunkOverlap: 0
            chunkSize: 0
            fieldNameMappings:
                - fromField: string
                  toField: string
            metadataFields:
                - string
            textFields:
                - string
            textSplitter:
                byMarkdownHeader:
                    splitLevel: 0
                byProgrammingLanguage:
                    language: string
                bySeparator:
                    keepSeparator: false
                    separators:
                        - string
    definitionId: string
    name: string
    workspaceId: string

DestinationAstra Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DestinationAstra resource accepts the following input properties:

Configuration DestinationAstraConfiguration: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

Configuration DestinationAstraConfigurationArgs: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationAstraConfiguration: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

configuration DestinationAstraConfiguration: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name string: Name of the destination e.g. dev-mysql-instance.

configuration DestinationAstraConfigurationArgs: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name str: Name of the destination e.g. dev-mysql-instance.

configuration Property Map: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
name String: Name of the destination e.g. dev-mysql-instance.

Outputs

All input properties are implicitly available as output properties. Additionally, the DestinationAstra resource produces the following output properties:

CreatedAt double
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.

CreatedAt float64
DestinationId string
DestinationType string
Id string: The provider-assigned unique ID for this managed resource.

createdAt Double
destinationId String
destinationType String
id String: The provider-assigned unique ID for this managed resource.

createdAt number
destinationId string
destinationType string
id string: The provider-assigned unique ID for this managed resource.

created_at float
destination_id str
destination_type str
id str: The provider-assigned unique ID for this managed resource.

createdAt Number
destinationId String
destinationType String
id String: The provider-assigned unique ID for this managed resource.

Look up Existing DestinationAstra Resource

Get an existing DestinationAstra resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DestinationAstraState, opts?: CustomResourceOptions): DestinationAstra

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[DestinationAstraConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_type: Optional[str] = None,
        name: Optional[str] = None,
        workspace_id: Optional[str] = None) -> DestinationAstra

func GetDestinationAstra(ctx *Context, name string, id IDInput, state *DestinationAstraState, opts ...ResourceOption) (*DestinationAstra, error)

public static DestinationAstra Get(string name, Input<string> id, DestinationAstraState? state, CustomResourceOptions? opts = null)

public static DestinationAstra get(String name, Output<String> id, DestinationAstraState state, CustomResourceOptions options)

resources:  _:    type: airbyte:DestinationAstra    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration DestinationAstraConfiguration: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
WorkspaceId string

Configuration DestinationAstraConfigurationArgs: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
DestinationId string
DestinationType string
Name string: Name of the destination e.g. dev-mysql-instance.
WorkspaceId string

configuration DestinationAstraConfiguration: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
workspaceId String

configuration DestinationAstraConfiguration: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId string
destinationType string
name string: Name of the destination e.g. dev-mysql-instance.
workspaceId string

configuration DestinationAstraConfigurationArgs: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
created_at float
definition_id str: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destination_id str
destination_type str
name str: Name of the destination e.g. dev-mysql-instance.
workspace_id str

configuration Property Map: The configuration model for the Vector DB based destinations. This model is used to generate the UI for the destination configuration, as well as to provide type safety for the configuration passed to the destination.
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. Requires replacement if changed.
destinationId String
destinationType String
name String: Name of the destination e.g. dev-mysql-instance.
workspaceId String

Supporting Types

DestinationAstraConfiguration, DestinationAstraConfigurationArgs

Embedding DestinationAstraConfigurationEmbedding: Embedding configuration
Indexing DestinationAstraConfigurationIndexing: Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production.
Processing DestinationAstraConfigurationProcessing
OmitRawText bool: Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. Default: false

Embedding DestinationAstraConfigurationEmbedding: Embedding configuration
Indexing DestinationAstraConfigurationIndexing: Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production.
Processing DestinationAstraConfigurationProcessing
OmitRawText bool: Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. Default: false

embedding DestinationAstraConfigurationEmbedding: Embedding configuration
indexing DestinationAstraConfigurationIndexing: Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production.
processing DestinationAstraConfigurationProcessing
omitRawText Boolean: Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. Default: false

embedding DestinationAstraConfigurationEmbedding: Embedding configuration
indexing DestinationAstraConfigurationIndexing: Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production.
processing DestinationAstraConfigurationProcessing
omitRawText boolean: Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. Default: false

embedding DestinationAstraConfigurationEmbedding: Embedding configuration
indexing DestinationAstraConfigurationIndexing: Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production.
processing DestinationAstraConfigurationProcessing
omit_raw_text bool: Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. Default: false

embedding Property Map: Embedding configuration
indexing Property Map: Astra DB gives developers the APIs, real-time data and ecosystem integrations to put accurate RAG and Gen AI apps with fewer hallucinations in production.
processing Property Map
omitRawText Boolean: Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. Default: false

DestinationAstraConfigurationEmbedding, DestinationAstraConfigurationEmbeddingArgs

AzureOpenAi DestinationAstraConfigurationEmbeddingAzureOpenAi: Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
Cohere DestinationAstraConfigurationEmbeddingCohere: Use the Cohere API to embed text.
Fake DestinationAstraConfigurationEmbeddingFake: Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs.
OpenAi DestinationAstraConfigurationEmbeddingOpenAi: Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
OpenAiCompatible DestinationAstraConfigurationEmbeddingOpenAiCompatible: Use a service that's compatible with the OpenAI API to embed text.

AzureOpenAi DestinationAstraConfigurationEmbeddingAzureOpenAi: Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
Cohere DestinationAstraConfigurationEmbeddingCohere: Use the Cohere API to embed text.
Fake DestinationAstraConfigurationEmbeddingFake: Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs.
OpenAi DestinationAstraConfigurationEmbeddingOpenAi: Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
OpenAiCompatible DestinationAstraConfigurationEmbeddingOpenAiCompatible: Use a service that's compatible with the OpenAI API to embed text.

azureOpenAi DestinationAstraConfigurationEmbeddingAzureOpenAi: Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
cohere DestinationAstraConfigurationEmbeddingCohere: Use the Cohere API to embed text.
fake DestinationAstraConfigurationEmbeddingFake: Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs.
openAi DestinationAstraConfigurationEmbeddingOpenAi: Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
openAiCompatible DestinationAstraConfigurationEmbeddingOpenAiCompatible: Use a service that's compatible with the OpenAI API to embed text.

azureOpenAi DestinationAstraConfigurationEmbeddingAzureOpenAi: Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
cohere DestinationAstraConfigurationEmbeddingCohere: Use the Cohere API to embed text.
fake DestinationAstraConfigurationEmbeddingFake: Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs.
openAi DestinationAstraConfigurationEmbeddingOpenAi: Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
openAiCompatible DestinationAstraConfigurationEmbeddingOpenAiCompatible: Use a service that's compatible with the OpenAI API to embed text.

azure_open_ai DestinationAstraConfigurationEmbeddingAzureOpenAi: Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
cohere DestinationAstraConfigurationEmbeddingCohere: Use the Cohere API to embed text.
fake DestinationAstraConfigurationEmbeddingFake: Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs.
open_ai DestinationAstraConfigurationEmbeddingOpenAi: Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
open_ai_compatible DestinationAstraConfigurationEmbeddingOpenAiCompatible: Use a service that's compatible with the OpenAI API to embed text.

azureOpenAi Property Map: Use the Azure-hosted OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
cohere Property Map: Use the Cohere API to embed text.
fake Property Map: Use a fake embedding made out of random vectors with 1536 embedding dimensions. This is useful for testing the data pipeline without incurring any costs.
openAi Property Map: Use the OpenAI API to embed text. This option is using the text-embedding-ada-002 model with 1536 embedding dimensions.
openAiCompatible Property Map: Use a service that's compatible with the OpenAI API to embed text.

DestinationAstraConfigurationEmbeddingAzureOpenAi, DestinationAstraConfigurationEmbeddingAzureOpenAiArgs

ApiBase string: The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
Deployment string: The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
OpenaiKey string: The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource

ApiBase string: The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
Deployment string: The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
OpenaiKey string: The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource

apiBase String: The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
deployment String: The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
openaiKey String: The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource

apiBase string: The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
deployment string: The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
openaiKey string: The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource

api_base str: The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
deployment str: The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
openai_key str: The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource

apiBase String: The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
deployment String: The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource
openaiKey String: The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource

DestinationAstraConfigurationEmbeddingCohere, DestinationAstraConfigurationEmbeddingCohereArgs

CohereKey string

CohereKey string

cohereKey String

cohereKey string

cohere_key str

cohereKey String

DestinationAstraConfigurationEmbeddingOpenAi, DestinationAstraConfigurationEmbeddingOpenAiArgs

OpenaiKey string

OpenaiKey string

openaiKey String

openaiKey string

openai_key str

openaiKey String

DestinationAstraConfigurationEmbeddingOpenAiCompatible, DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs

BaseUrl string: The base URL for your OpenAI-compatible service
Dimensions double: The number of dimensions the embedding model is generating
ApiKey string: Default: ""
ModelName string: The name of the model to use for embedding. Default: "text-embedding-ada-002"

BaseUrl string: The base URL for your OpenAI-compatible service
Dimensions float64: The number of dimensions the embedding model is generating
ApiKey string: Default: ""
ModelName string: The name of the model to use for embedding. Default: "text-embedding-ada-002"

baseUrl String: The base URL for your OpenAI-compatible service
dimensions Double: The number of dimensions the embedding model is generating
apiKey String: Default: ""
modelName String: The name of the model to use for embedding. Default: "text-embedding-ada-002"

baseUrl string: The base URL for your OpenAI-compatible service
dimensions number: The number of dimensions the embedding model is generating
apiKey string: Default: ""
modelName string: The name of the model to use for embedding. Default: "text-embedding-ada-002"

base_url str: The base URL for your OpenAI-compatible service
dimensions float: The number of dimensions the embedding model is generating
api_key str: Default: ""
model_name str: The name of the model to use for embedding. Default: "text-embedding-ada-002"

baseUrl String: The base URL for your OpenAI-compatible service
dimensions Number: The number of dimensions the embedding model is generating
apiKey String: Default: ""
modelName String: The name of the model to use for embedding. Default: "text-embedding-ada-002"

DestinationAstraConfigurationIndexing, DestinationAstraConfigurationIndexingArgs

AstraDbAppToken string: The application token authorizes a user to connect to a specific Astra DB database. It is created when the user clicks the Generate Token button on the Overview tab of the Database page in the Astra UI.
AstraDbEndpoint string: The endpoint specifies which Astra DB database queries are sent to. It can be copied from the Database Details section of the Overview tab of the Database page in the Astra UI.
AstraDbKeyspace string: Keyspaces (or Namespaces) serve as containers for organizing data within a database. You can create a new keyspace uisng the Data Explorer tab in the Astra UI. The keyspace default_keyspace is created for you when you create a Vector Database in Astra DB.
Collection string: Collections hold data. They are analagous to tables in traditional Cassandra terminology. This tool will create the collection with the provided name automatically if it does not already exist. Alternatively, you can create one thorugh the Data Explorer tab in the Astra UI.

AstraDbAppToken string: The application token authorizes a user to connect to a specific Astra DB database. It is created when the user clicks the Generate Token button on the Overview tab of the Database page in the Astra UI.
AstraDbEndpoint string: The endpoint specifies which Astra DB database queries are sent to. It can be copied from the Database Details section of the Overview tab of the Database page in the Astra UI.
AstraDbKeyspace string: Keyspaces (or Namespaces) serve as containers for organizing data within a database. You can create a new keyspace uisng the Data Explorer tab in the Astra UI. The keyspace default_keyspace is created for you when you create a Vector Database in Astra DB.
Collection string: Collections hold data. They are analagous to tables in traditional Cassandra terminology. This tool will create the collection with the provided name automatically if it does not already exist. Alternatively, you can create one thorugh the Data Explorer tab in the Astra UI.

astraDbAppToken String: The application token authorizes a user to connect to a specific Astra DB database. It is created when the user clicks the Generate Token button on the Overview tab of the Database page in the Astra UI.
astraDbEndpoint String: The endpoint specifies which Astra DB database queries are sent to. It can be copied from the Database Details section of the Overview tab of the Database page in the Astra UI.
astraDbKeyspace String: Keyspaces (or Namespaces) serve as containers for organizing data within a database. You can create a new keyspace uisng the Data Explorer tab in the Astra UI. The keyspace default_keyspace is created for you when you create a Vector Database in Astra DB.
collection String: Collections hold data. They are analagous to tables in traditional Cassandra terminology. This tool will create the collection with the provided name automatically if it does not already exist. Alternatively, you can create one thorugh the Data Explorer tab in the Astra UI.

astraDbAppToken string: The application token authorizes a user to connect to a specific Astra DB database. It is created when the user clicks the Generate Token button on the Overview tab of the Database page in the Astra UI.
astraDbEndpoint string: The endpoint specifies which Astra DB database queries are sent to. It can be copied from the Database Details section of the Overview tab of the Database page in the Astra UI.
astraDbKeyspace string: Keyspaces (or Namespaces) serve as containers for organizing data within a database. You can create a new keyspace uisng the Data Explorer tab in the Astra UI. The keyspace default_keyspace is created for you when you create a Vector Database in Astra DB.
collection string: Collections hold data. They are analagous to tables in traditional Cassandra terminology. This tool will create the collection with the provided name automatically if it does not already exist. Alternatively, you can create one thorugh the Data Explorer tab in the Astra UI.

astra_db_app_token str: The application token authorizes a user to connect to a specific Astra DB database. It is created when the user clicks the Generate Token button on the Overview tab of the Database page in the Astra UI.
astra_db_endpoint str: The endpoint specifies which Astra DB database queries are sent to. It can be copied from the Database Details section of the Overview tab of the Database page in the Astra UI.
astra_db_keyspace str: Keyspaces (or Namespaces) serve as containers for organizing data within a database. You can create a new keyspace uisng the Data Explorer tab in the Astra UI. The keyspace default_keyspace is created for you when you create a Vector Database in Astra DB.
collection str: Collections hold data. They are analagous to tables in traditional Cassandra terminology. This tool will create the collection with the provided name automatically if it does not already exist. Alternatively, you can create one thorugh the Data Explorer tab in the Astra UI.

astraDbAppToken String: The application token authorizes a user to connect to a specific Astra DB database. It is created when the user clicks the Generate Token button on the Overview tab of the Database page in the Astra UI.
astraDbEndpoint String: The endpoint specifies which Astra DB database queries are sent to. It can be copied from the Database Details section of the Overview tab of the Database page in the Astra UI.
astraDbKeyspace String: Keyspaces (or Namespaces) serve as containers for organizing data within a database. You can create a new keyspace uisng the Data Explorer tab in the Astra UI. The keyspace default_keyspace is created for you when you create a Vector Database in Astra DB.
collection String: Collections hold data. They are analagous to tables in traditional Cassandra terminology. This tool will create the collection with the provided name automatically if it does not already exist. Alternatively, you can create one thorugh the Data Explorer tab in the Astra UI.

DestinationAstraConfigurationProcessing, DestinationAstraConfigurationProcessingArgs

ChunkSize double: Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM)
ChunkOverlap double: Size of overlap between chunks in tokens to store in vector store to better capture relevant context. Default: 0
FieldNameMappings List<DestinationAstraConfigurationProcessingFieldNameMapping>: List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation.
MetadataFields List<string>: List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path.
TextFields List<string>: List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
TextSplitter DestinationAstraConfigurationProcessingTextSplitter: Split text fields into chunks based on the specified method.

ChunkSize float64: Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM)
ChunkOverlap float64: Size of overlap between chunks in tokens to store in vector store to better capture relevant context. Default: 0
FieldNameMappings []DestinationAstraConfigurationProcessingFieldNameMapping: List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation.
MetadataFields []string: List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path.
TextFields []string: List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
TextSplitter DestinationAstraConfigurationProcessingTextSplitter: Split text fields into chunks based on the specified method.

chunkSize Double: Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM)
chunkOverlap Double: Size of overlap between chunks in tokens to store in vector store to better capture relevant context. Default: 0
fieldNameMappings List<DestinationAstraConfigurationProcessingFieldNameMapping>: List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation.
metadataFields List<String>: List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path.
textFields List<String>: List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
textSplitter DestinationAstraConfigurationProcessingTextSplitter: Split text fields into chunks based on the specified method.

chunkSize number: Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM)
chunkOverlap number: Size of overlap between chunks in tokens to store in vector store to better capture relevant context. Default: 0
fieldNameMappings DestinationAstraConfigurationProcessingFieldNameMapping[]: List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation.
metadataFields string[]: List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path.
textFields string[]: List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
textSplitter DestinationAstraConfigurationProcessingTextSplitter: Split text fields into chunks based on the specified method.

chunk_size float: Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM)
chunk_overlap float: Size of overlap between chunks in tokens to store in vector store to better capture relevant context. Default: 0
field_name_mappings Sequence[DestinationAstraConfigurationProcessingFieldNameMapping]: List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation.
metadata_fields Sequence[str]: List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path.
text_fields Sequence[str]: List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
text_splitter DestinationAstraConfigurationProcessingTextSplitter: Split text fields into chunks based on the specified method.

chunkSize Number: Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM)
chunkOverlap Number: Size of overlap between chunks in tokens to store in vector store to better capture relevant context. Default: 0
fieldNameMappings List<Property Map>: List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation.
metadataFields List<String>: List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path.
textFields List<String>: List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. user.name will access the name field in the user object. It's also possible to use wildcards to access all fields in an object, e.g. users.*.name will access all names fields in all entries of the users array.
textSplitter Property Map: Split text fields into chunks based on the specified method.

DestinationAstraConfigurationProcessingFieldNameMapping, DestinationAstraConfigurationProcessingFieldNameMappingArgs

FromField string: The field name in the source
ToField string: The field name to use in the destination

FromField string: The field name in the source
ToField string: The field name to use in the destination

fromField String: The field name in the source
toField String: The field name to use in the destination

fromField string: The field name in the source
toField string: The field name to use in the destination

from_field str: The field name in the source
to_field str: The field name to use in the destination

fromField String: The field name in the source
toField String: The field name to use in the destination

DestinationAstraConfigurationProcessingTextSplitter, DestinationAstraConfigurationProcessingTextSplitterArgs

ByMarkdownHeader DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader: Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk.
ByProgrammingLanguage DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage: Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks.
BySeparator DestinationAstraConfigurationProcessingTextSplitterBySeparator: Split the text by the list of separators until the chunk size is reached, using the earlier mentioned separators where possible. This is useful for splitting text fields by paragraphs, sentences, words, etc.

ByMarkdownHeader DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader: Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk.
ByProgrammingLanguage DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage: Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks.
BySeparator DestinationAstraConfigurationProcessingTextSplitterBySeparator: Split the text by the list of separators until the chunk size is reached, using the earlier mentioned separators where possible. This is useful for splitting text fields by paragraphs, sentences, words, etc.

byMarkdownHeader DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader: Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk.
byProgrammingLanguage DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage: Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks.
bySeparator DestinationAstraConfigurationProcessingTextSplitterBySeparator: Split the text by the list of separators until the chunk size is reached, using the earlier mentioned separators where possible. This is useful for splitting text fields by paragraphs, sentences, words, etc.

byMarkdownHeader DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader: Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk.
byProgrammingLanguage DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage: Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks.
bySeparator DestinationAstraConfigurationProcessingTextSplitterBySeparator: Split the text by the list of separators until the chunk size is reached, using the earlier mentioned separators where possible. This is useful for splitting text fields by paragraphs, sentences, words, etc.

by_markdown_header DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader: Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk.
by_programming_language DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage: Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks.
by_separator DestinationAstraConfigurationProcessingTextSplitterBySeparator: Split the text by the list of separators until the chunk size is reached, using the earlier mentioned separators where possible. This is useful for splitting text fields by paragraphs, sentences, words, etc.

byMarkdownHeader Property Map: Split the text by Markdown headers down to the specified header level. If the chunk size fits multiple sections, they will be combined into a single chunk.
byProgrammingLanguage Property Map: Split the text by suitable delimiters based on the programming language. This is useful for splitting code into chunks.
bySeparator Property Map: Split the text by the list of separators until the chunk size is reached, using the earlier mentioned separators where possible. This is useful for splitting text fields by paragraphs, sentences, words, etc.

DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader, DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs

SplitLevel double: Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points. Default: 1

SplitLevel float64: Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points. Default: 1

splitLevel Double: Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points. Default: 1

splitLevel number: Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points. Default: 1

split_level float: Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points. Default: 1

splitLevel Number: Level of markdown headers to split text fields by. Headings down to the specified level will be used as split points. Default: 1

DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage, DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs

Language string: Split code in suitable places based on the programming language. must be one of ["cpp", "go", "java", "js", "php", "proto", "python", "rst", "ruby", "rust", "scala", "swift", "markdown", "latex", "html", "sol"]

Language string: Split code in suitable places based on the programming language. must be one of ["cpp", "go", "java", "js", "php", "proto", "python", "rst", "ruby", "rust", "scala", "swift", "markdown", "latex", "html", "sol"]

language String: Split code in suitable places based on the programming language. must be one of ["cpp", "go", "java", "js", "php", "proto", "python", "rst", "ruby", "rust", "scala", "swift", "markdown", "latex", "html", "sol"]

language string: Split code in suitable places based on the programming language. must be one of ["cpp", "go", "java", "js", "php", "proto", "python", "rst", "ruby", "rust", "scala", "swift", "markdown", "latex", "html", "sol"]

language str: Split code in suitable places based on the programming language. must be one of ["cpp", "go", "java", "js", "php", "proto", "python", "rst", "ruby", "rust", "scala", "swift", "markdown", "latex", "html", "sol"]

language String: Split code in suitable places based on the programming language. must be one of ["cpp", "go", "java", "js", "php", "proto", "python", "rst", "ruby", "rust", "scala", "swift", "markdown", "latex", "html", "sol"]

DestinationAstraConfigurationProcessingTextSplitterBySeparator, DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs

KeepSeparator bool: Whether to keep the separator in the resulting chunks. Default: false
Separators List<string>: List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n".

KeepSeparator bool: Whether to keep the separator in the resulting chunks. Default: false
Separators []string: List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n".

keepSeparator Boolean: Whether to keep the separator in the resulting chunks. Default: false
separators List<String>: List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n".

keepSeparator boolean: Whether to keep the separator in the resulting chunks. Default: false
separators string[]: List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n".

keep_separator bool: Whether to keep the separator in the resulting chunks. Default: false
separators Sequence[str]: List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n".

keepSeparator Boolean: Whether to keep the separator in the resulting chunks. Default: false
separators List<String>: List of separator strings to split text fields by. The separator itself needs to be wrapped in double quotes, e.g. to split by the dot character, use ".". To split by a newline, use "\n".

Import

$ pulumi import airbyte:index/destinationAstra:DestinationAstra my_airbyte_destination_astra ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.DestinationAstra

On this page

On this page

Example Usage

Create DestinationAstra Resource

Constructor syntax

Parameters

Constructor example

DestinationAstra Resource Properties

Inputs

Outputs

Look up Existing DestinationAstra Resource

Supporting Types

DestinationAstraConfiguration, DestinationAstraConfigurationArgs

DestinationAstraConfigurationEmbedding, DestinationAstraConfigurationEmbeddingArgs

DestinationAstraConfigurationEmbeddingAzureOpenAi, DestinationAstraConfigurationEmbeddingAzureOpenAiArgs

DestinationAstraConfigurationEmbeddingCohere, DestinationAstraConfigurationEmbeddingCohereArgs

DestinationAstraConfigurationEmbeddingOpenAi, DestinationAstraConfigurationEmbeddingOpenAiArgs

DestinationAstraConfigurationEmbeddingOpenAiCompatible, DestinationAstraConfigurationEmbeddingOpenAiCompatibleArgs

DestinationAstraConfigurationIndexing, DestinationAstraConfigurationIndexingArgs

DestinationAstraConfigurationProcessing, DestinationAstraConfigurationProcessingArgs

DestinationAstraConfigurationProcessingFieldNameMapping, DestinationAstraConfigurationProcessingFieldNameMappingArgs

DestinationAstraConfigurationProcessingTextSplitter, DestinationAstraConfigurationProcessingTextSplitterArgs

DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeader, DestinationAstraConfigurationProcessingTextSplitterByMarkdownHeaderArgs

DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguage, DestinationAstraConfigurationProcessingTextSplitterByProgrammingLanguageArgs

DestinationAstraConfigurationProcessingTextSplitterBySeparator, DestinationAstraConfigurationProcessingTextSplitterBySeparatorArgs

Import

Package Details

On this page

On this page