1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. GenaiKnowledgeBase
DigitalOcean v4.51.0 published on Thursday, Aug 14, 2025 by Pulumi

digitalocean.GenaiKnowledgeBase

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.51.0 published on Thursday, Aug 14, 2025 by Pulumi

    Create GenaiKnowledgeBase Resource

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

    Constructor syntax

    new GenaiKnowledgeBase(name: string, args: GenaiKnowledgeBaseArgs, opts?: CustomResourceOptions);
    @overload
    def GenaiKnowledgeBase(resource_name: str,
                           args: GenaiKnowledgeBaseArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def GenaiKnowledgeBase(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           datasources: Optional[Sequence[GenaiKnowledgeBaseDataSourceArgs]] = None,
                           embedding_model_uuid: Optional[str] = None,
                           project_id: Optional[str] = None,
                           region: Optional[str] = None,
                           added_to_agent_at: Optional[str] = None,
                           database_id: Optional[str] = None,
                           is_public: Optional[bool] = None,
                           last_indexing_jobs: Optional[Sequence[GenaiKnowledgeBaseLastIndexingJobArgs]] = None,
                           name: Optional[str] = None,
                           tags: Optional[Sequence[str]] = None,
                           vpc_uuid: Optional[str] = None)
    func NewGenaiKnowledgeBase(ctx *Context, name string, args GenaiKnowledgeBaseArgs, opts ...ResourceOption) (*GenaiKnowledgeBase, error)
    public GenaiKnowledgeBase(string name, GenaiKnowledgeBaseArgs args, CustomResourceOptions? opts = null)
    public GenaiKnowledgeBase(String name, GenaiKnowledgeBaseArgs args)
    public GenaiKnowledgeBase(String name, GenaiKnowledgeBaseArgs args, CustomResourceOptions options)
    
    type: digitalocean:GenaiKnowledgeBase
    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 GenaiKnowledgeBaseArgs
    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 GenaiKnowledgeBaseArgs
    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 GenaiKnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GenaiKnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GenaiKnowledgeBaseArgs
    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 genaiKnowledgeBaseResource = new DigitalOcean.GenaiKnowledgeBase("genaiKnowledgeBaseResource", new()
    {
        Datasources = new[]
        {
            new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceArgs
            {
                CreatedAt = "string",
                FileUploadDataSources = new[]
                {
                    new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceFileUploadDataSourceArgs
                    {
                        OriginalFileName = "string",
                        SizeInBytes = "string",
                        StoredObjectKey = "string",
                    },
                },
                LastIndexingJobs = new[]
                {
                    new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceLastIndexingJobArgs
                    {
                        CompletedDatasources = 0,
                        CreatedAt = "string",
                        DataSourceUuids = new[]
                        {
                            "string",
                        },
                        FinishedAt = "string",
                        KnowledgeBaseUuid = "string",
                        Phase = "string",
                        StartedAt = "string",
                        Tokens = 0,
                        TotalDatasources = 0,
                        UpdatedAt = "string",
                        Uuid = "string",
                    },
                },
                SpacesDataSources = new[]
                {
                    new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs
                    {
                        BucketName = "string",
                        ItemPath = "string",
                        Region = "string",
                    },
                },
                UpdatedAt = "string",
                Uuid = "string",
                WebCrawlerDataSources = new[]
                {
                    new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs
                    {
                        BaseUrl = "string",
                        CrawlingOption = "string",
                        EmbedMedia = false,
                    },
                },
            },
        },
        EmbeddingModelUuid = "string",
        ProjectId = "string",
        Region = "string",
        AddedToAgentAt = "string",
        DatabaseId = "string",
        IsPublic = false,
        LastIndexingJobs = new[]
        {
            new DigitalOcean.Inputs.GenaiKnowledgeBaseLastIndexingJobArgs
            {
                CompletedDatasources = 0,
                CreatedAt = "string",
                DataSourceUuids = new[]
                {
                    "string",
                },
                FinishedAt = "string",
                KnowledgeBaseUuid = "string",
                Phase = "string",
                StartedAt = "string",
                Tokens = 0,
                TotalDatasources = 0,
                UpdatedAt = "string",
                Uuid = "string",
            },
        },
        Name = "string",
        Tags = new[]
        {
            "string",
        },
        VpcUuid = "string",
    });
    
    example, err := digitalocean.NewGenaiKnowledgeBase(ctx, "genaiKnowledgeBaseResource", &digitalocean.GenaiKnowledgeBaseArgs{
    	Datasources: digitalocean.GenaiKnowledgeBaseDataSourceTypeArray{
    		&digitalocean.GenaiKnowledgeBaseDataSourceTypeArgs{
    			CreatedAt: pulumi.String("string"),
    			FileUploadDataSources: digitalocean.GenaiKnowledgeBaseDataSourceFileUploadDataSourceArray{
    				&digitalocean.GenaiKnowledgeBaseDataSourceFileUploadDataSourceArgs{
    					OriginalFileName: pulumi.String("string"),
    					SizeInBytes:      pulumi.String("string"),
    					StoredObjectKey:  pulumi.String("string"),
    				},
    			},
    			LastIndexingJobs: digitalocean.GenaiKnowledgeBaseDataSourceLastIndexingJobArray{
    				&digitalocean.GenaiKnowledgeBaseDataSourceLastIndexingJobArgs{
    					CompletedDatasources: pulumi.Int(0),
    					CreatedAt:            pulumi.String("string"),
    					DataSourceUuids: pulumi.StringArray{
    						pulumi.String("string"),
    					},
    					FinishedAt:        pulumi.String("string"),
    					KnowledgeBaseUuid: pulumi.String("string"),
    					Phase:             pulumi.String("string"),
    					StartedAt:         pulumi.String("string"),
    					Tokens:            pulumi.Int(0),
    					TotalDatasources:  pulumi.Int(0),
    					UpdatedAt:         pulumi.String("string"),
    					Uuid:              pulumi.String("string"),
    				},
    			},
    			SpacesDataSources: digitalocean.GenaiKnowledgeBaseDataSourceSpacesDataSourceArray{
    				&digitalocean.GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs{
    					BucketName: pulumi.String("string"),
    					ItemPath:   pulumi.String("string"),
    					Region:     pulumi.String("string"),
    				},
    			},
    			UpdatedAt: pulumi.String("string"),
    			Uuid:      pulumi.String("string"),
    			WebCrawlerDataSources: digitalocean.GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArray{
    				&digitalocean.GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs{
    					BaseUrl:        pulumi.String("string"),
    					CrawlingOption: pulumi.String("string"),
    					EmbedMedia:     pulumi.Bool(false),
    				},
    			},
    		},
    	},
    	EmbeddingModelUuid: pulumi.String("string"),
    	ProjectId:          pulumi.String("string"),
    	Region:             pulumi.String("string"),
    	AddedToAgentAt:     pulumi.String("string"),
    	DatabaseId:         pulumi.String("string"),
    	IsPublic:           pulumi.Bool(false),
    	LastIndexingJobs: digitalocean.GenaiKnowledgeBaseLastIndexingJobArray{
    		&digitalocean.GenaiKnowledgeBaseLastIndexingJobArgs{
    			CompletedDatasources: pulumi.Int(0),
    			CreatedAt:            pulumi.String("string"),
    			DataSourceUuids: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			FinishedAt:        pulumi.String("string"),
    			KnowledgeBaseUuid: pulumi.String("string"),
    			Phase:             pulumi.String("string"),
    			StartedAt:         pulumi.String("string"),
    			Tokens:            pulumi.Int(0),
    			TotalDatasources:  pulumi.Int(0),
    			UpdatedAt:         pulumi.String("string"),
    			Uuid:              pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	VpcUuid: pulumi.String("string"),
    })
    
    var genaiKnowledgeBaseResource = new GenaiKnowledgeBase("genaiKnowledgeBaseResource", GenaiKnowledgeBaseArgs.builder()
        .datasources(GenaiKnowledgeBaseDataSourceArgs.builder()
            .createdAt("string")
            .fileUploadDataSources(GenaiKnowledgeBaseDataSourceFileUploadDataSourceArgs.builder()
                .originalFileName("string")
                .sizeInBytes("string")
                .storedObjectKey("string")
                .build())
            .lastIndexingJobs(GenaiKnowledgeBaseDataSourceLastIndexingJobArgs.builder()
                .completedDatasources(0)
                .createdAt("string")
                .dataSourceUuids("string")
                .finishedAt("string")
                .knowledgeBaseUuid("string")
                .phase("string")
                .startedAt("string")
                .tokens(0)
                .totalDatasources(0)
                .updatedAt("string")
                .uuid("string")
                .build())
            .spacesDataSources(GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs.builder()
                .bucketName("string")
                .itemPath("string")
                .region("string")
                .build())
            .updatedAt("string")
            .uuid("string")
            .webCrawlerDataSources(GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs.builder()
                .baseUrl("string")
                .crawlingOption("string")
                .embedMedia(false)
                .build())
            .build())
        .embeddingModelUuid("string")
        .projectId("string")
        .region("string")
        .addedToAgentAt("string")
        .databaseId("string")
        .isPublic(false)
        .lastIndexingJobs(GenaiKnowledgeBaseLastIndexingJobArgs.builder()
            .completedDatasources(0)
            .createdAt("string")
            .dataSourceUuids("string")
            .finishedAt("string")
            .knowledgeBaseUuid("string")
            .phase("string")
            .startedAt("string")
            .tokens(0)
            .totalDatasources(0)
            .updatedAt("string")
            .uuid("string")
            .build())
        .name("string")
        .tags("string")
        .vpcUuid("string")
        .build());
    
    genai_knowledge_base_resource = digitalocean.GenaiKnowledgeBase("genaiKnowledgeBaseResource",
        datasources=[{
            "created_at": "string",
            "file_upload_data_sources": [{
                "original_file_name": "string",
                "size_in_bytes": "string",
                "stored_object_key": "string",
            }],
            "last_indexing_jobs": [{
                "completed_datasources": 0,
                "created_at": "string",
                "data_source_uuids": ["string"],
                "finished_at": "string",
                "knowledge_base_uuid": "string",
                "phase": "string",
                "started_at": "string",
                "tokens": 0,
                "total_datasources": 0,
                "updated_at": "string",
                "uuid": "string",
            }],
            "spaces_data_sources": [{
                "bucket_name": "string",
                "item_path": "string",
                "region": "string",
            }],
            "updated_at": "string",
            "uuid": "string",
            "web_crawler_data_sources": [{
                "base_url": "string",
                "crawling_option": "string",
                "embed_media": False,
            }],
        }],
        embedding_model_uuid="string",
        project_id="string",
        region="string",
        added_to_agent_at="string",
        database_id="string",
        is_public=False,
        last_indexing_jobs=[{
            "completed_datasources": 0,
            "created_at": "string",
            "data_source_uuids": ["string"],
            "finished_at": "string",
            "knowledge_base_uuid": "string",
            "phase": "string",
            "started_at": "string",
            "tokens": 0,
            "total_datasources": 0,
            "updated_at": "string",
            "uuid": "string",
        }],
        name="string",
        tags=["string"],
        vpc_uuid="string")
    
    const genaiKnowledgeBaseResource = new digitalocean.GenaiKnowledgeBase("genaiKnowledgeBaseResource", {
        datasources: [{
            createdAt: "string",
            fileUploadDataSources: [{
                originalFileName: "string",
                sizeInBytes: "string",
                storedObjectKey: "string",
            }],
            lastIndexingJobs: [{
                completedDatasources: 0,
                createdAt: "string",
                dataSourceUuids: ["string"],
                finishedAt: "string",
                knowledgeBaseUuid: "string",
                phase: "string",
                startedAt: "string",
                tokens: 0,
                totalDatasources: 0,
                updatedAt: "string",
                uuid: "string",
            }],
            spacesDataSources: [{
                bucketName: "string",
                itemPath: "string",
                region: "string",
            }],
            updatedAt: "string",
            uuid: "string",
            webCrawlerDataSources: [{
                baseUrl: "string",
                crawlingOption: "string",
                embedMedia: false,
            }],
        }],
        embeddingModelUuid: "string",
        projectId: "string",
        region: "string",
        addedToAgentAt: "string",
        databaseId: "string",
        isPublic: false,
        lastIndexingJobs: [{
            completedDatasources: 0,
            createdAt: "string",
            dataSourceUuids: ["string"],
            finishedAt: "string",
            knowledgeBaseUuid: "string",
            phase: "string",
            startedAt: "string",
            tokens: 0,
            totalDatasources: 0,
            updatedAt: "string",
            uuid: "string",
        }],
        name: "string",
        tags: ["string"],
        vpcUuid: "string",
    });
    
    type: digitalocean:GenaiKnowledgeBase
    properties:
        addedToAgentAt: string
        databaseId: string
        datasources:
            - createdAt: string
              fileUploadDataSources:
                - originalFileName: string
                  sizeInBytes: string
                  storedObjectKey: string
              lastIndexingJobs:
                - completedDatasources: 0
                  createdAt: string
                  dataSourceUuids:
                    - string
                  finishedAt: string
                  knowledgeBaseUuid: string
                  phase: string
                  startedAt: string
                  tokens: 0
                  totalDatasources: 0
                  updatedAt: string
                  uuid: string
              spacesDataSources:
                - bucketName: string
                  itemPath: string
                  region: string
              updatedAt: string
              uuid: string
              webCrawlerDataSources:
                - baseUrl: string
                  crawlingOption: string
                  embedMedia: false
        embeddingModelUuid: string
        isPublic: false
        lastIndexingJobs:
            - completedDatasources: 0
              createdAt: string
              dataSourceUuids:
                - string
              finishedAt: string
              knowledgeBaseUuid: string
              phase: string
              startedAt: string
              tokens: 0
              totalDatasources: 0
              updatedAt: string
              uuid: string
        name: string
        projectId: string
        region: string
        tags:
            - string
        vpcUuid: string
    

    GenaiKnowledgeBase 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 GenaiKnowledgeBase resource accepts the following input properties:

    Datasources List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseDataSource>
    Data sources for the knowledge base
    EmbeddingModelUuid string
    The unique identifier of the embedding model
    ProjectId string
    The unique identifier of the project to which the knowledge base belongs.
    Region string
    AddedToAgentAt string
    The time when the knowledge base was added to the agent.
    DatabaseId string
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    IsPublic bool
    Indicates whether the knowledge base is public or private.
    LastIndexingJobs List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseLastIndexingJob>
    The last indexing job for the knowledge base.
    Name string
    The name of the knowledge base.
    Tags List<string>
    VpcUuid string
    The unique identifier of the VPC to which the knowledge base belongs.
    Datasources []GenaiKnowledgeBaseDataSourceTypeArgs
    Data sources for the knowledge base
    EmbeddingModelUuid string
    The unique identifier of the embedding model
    ProjectId string
    The unique identifier of the project to which the knowledge base belongs.
    Region string
    AddedToAgentAt string
    The time when the knowledge base was added to the agent.
    DatabaseId string
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    IsPublic bool
    Indicates whether the knowledge base is public or private.
    LastIndexingJobs []GenaiKnowledgeBaseLastIndexingJobArgs
    The last indexing job for the knowledge base.
    Name string
    The name of the knowledge base.
    Tags []string
    VpcUuid string
    The unique identifier of the VPC to which the knowledge base belongs.
    datasources List<GenaiKnowledgeBaseDataSource>
    Data sources for the knowledge base
    embeddingModelUuid String
    The unique identifier of the embedding model
    projectId String
    The unique identifier of the project to which the knowledge base belongs.
    region String
    addedToAgentAt String
    The time when the knowledge base was added to the agent.
    databaseId String
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    isPublic Boolean
    Indicates whether the knowledge base is public or private.
    lastIndexingJobs List<GenaiKnowledgeBaseLastIndexingJob>
    The last indexing job for the knowledge base.
    name String
    The name of the knowledge base.
    tags List<String>
    vpcUuid String
    The unique identifier of the VPC to which the knowledge base belongs.
    datasources GenaiKnowledgeBaseDataSource[]
    Data sources for the knowledge base
    embeddingModelUuid string
    The unique identifier of the embedding model
    projectId string
    The unique identifier of the project to which the knowledge base belongs.
    region string
    addedToAgentAt string
    The time when the knowledge base was added to the agent.
    databaseId string
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    isPublic boolean
    Indicates whether the knowledge base is public or private.
    lastIndexingJobs GenaiKnowledgeBaseLastIndexingJob[]
    The last indexing job for the knowledge base.
    name string
    The name of the knowledge base.
    tags string[]
    vpcUuid string
    The unique identifier of the VPC to which the knowledge base belongs.
    datasources Sequence[GenaiKnowledgeBaseDataSourceArgs]
    Data sources for the knowledge base
    embedding_model_uuid str
    The unique identifier of the embedding model
    project_id str
    The unique identifier of the project to which the knowledge base belongs.
    region str
    added_to_agent_at str
    The time when the knowledge base was added to the agent.
    database_id str
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    is_public bool
    Indicates whether the knowledge base is public or private.
    last_indexing_jobs Sequence[GenaiKnowledgeBaseLastIndexingJobArgs]
    The last indexing job for the knowledge base.
    name str
    The name of the knowledge base.
    tags Sequence[str]
    vpc_uuid str
    The unique identifier of the VPC to which the knowledge base belongs.
    datasources List<Property Map>
    Data sources for the knowledge base
    embeddingModelUuid String
    The unique identifier of the embedding model
    projectId String
    The unique identifier of the project to which the knowledge base belongs.
    region String
    addedToAgentAt String
    The time when the knowledge base was added to the agent.
    databaseId String
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    isPublic Boolean
    Indicates whether the knowledge base is public or private.
    lastIndexingJobs List<Property Map>
    The last indexing job for the knowledge base.
    name String
    The name of the knowledge base.
    tags List<String>
    vpcUuid String
    The unique identifier of the VPC to which the knowledge base belongs.

    Outputs

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

    CreatedAt string
    The time when the knowledge base was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    The time when the knowledge base was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The time when the knowledge base was created.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    The time when the knowledge base was created.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    The time when the knowledge base was created.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The time when the knowledge base was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GenaiKnowledgeBase Resource

    Get an existing GenaiKnowledgeBase 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?: GenaiKnowledgeBaseState, opts?: CustomResourceOptions): GenaiKnowledgeBase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            added_to_agent_at: Optional[str] = None,
            created_at: Optional[str] = None,
            database_id: Optional[str] = None,
            datasources: Optional[Sequence[GenaiKnowledgeBaseDataSourceArgs]] = None,
            embedding_model_uuid: Optional[str] = None,
            is_public: Optional[bool] = None,
            last_indexing_jobs: Optional[Sequence[GenaiKnowledgeBaseLastIndexingJobArgs]] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            vpc_uuid: Optional[str] = None) -> GenaiKnowledgeBase
    func GetGenaiKnowledgeBase(ctx *Context, name string, id IDInput, state *GenaiKnowledgeBaseState, opts ...ResourceOption) (*GenaiKnowledgeBase, error)
    public static GenaiKnowledgeBase Get(string name, Input<string> id, GenaiKnowledgeBaseState? state, CustomResourceOptions? opts = null)
    public static GenaiKnowledgeBase get(String name, Output<String> id, GenaiKnowledgeBaseState state, CustomResourceOptions options)
    resources:  _:    type: digitalocean:GenaiKnowledgeBase    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:
    AddedToAgentAt string
    The time when the knowledge base was added to the agent.
    CreatedAt string
    The time when the knowledge base was created.
    DatabaseId string
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    Datasources List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseDataSource>
    Data sources for the knowledge base
    EmbeddingModelUuid string
    The unique identifier of the embedding model
    IsPublic bool
    Indicates whether the knowledge base is public or private.
    LastIndexingJobs List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseLastIndexingJob>
    The last indexing job for the knowledge base.
    Name string
    The name of the knowledge base.
    ProjectId string
    The unique identifier of the project to which the knowledge base belongs.
    Region string
    Tags List<string>
    VpcUuid string
    The unique identifier of the VPC to which the knowledge base belongs.
    AddedToAgentAt string
    The time when the knowledge base was added to the agent.
    CreatedAt string
    The time when the knowledge base was created.
    DatabaseId string
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    Datasources []GenaiKnowledgeBaseDataSourceTypeArgs
    Data sources for the knowledge base
    EmbeddingModelUuid string
    The unique identifier of the embedding model
    IsPublic bool
    Indicates whether the knowledge base is public or private.
    LastIndexingJobs []GenaiKnowledgeBaseLastIndexingJobArgs
    The last indexing job for the knowledge base.
    Name string
    The name of the knowledge base.
    ProjectId string
    The unique identifier of the project to which the knowledge base belongs.
    Region string
    Tags []string
    VpcUuid string
    The unique identifier of the VPC to which the knowledge base belongs.
    addedToAgentAt String
    The time when the knowledge base was added to the agent.
    createdAt String
    The time when the knowledge base was created.
    databaseId String
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    datasources List<GenaiKnowledgeBaseDataSource>
    Data sources for the knowledge base
    embeddingModelUuid String
    The unique identifier of the embedding model
    isPublic Boolean
    Indicates whether the knowledge base is public or private.
    lastIndexingJobs List<GenaiKnowledgeBaseLastIndexingJob>
    The last indexing job for the knowledge base.
    name String
    The name of the knowledge base.
    projectId String
    The unique identifier of the project to which the knowledge base belongs.
    region String
    tags List<String>
    vpcUuid String
    The unique identifier of the VPC to which the knowledge base belongs.
    addedToAgentAt string
    The time when the knowledge base was added to the agent.
    createdAt string
    The time when the knowledge base was created.
    databaseId string
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    datasources GenaiKnowledgeBaseDataSource[]
    Data sources for the knowledge base
    embeddingModelUuid string
    The unique identifier of the embedding model
    isPublic boolean
    Indicates whether the knowledge base is public or private.
    lastIndexingJobs GenaiKnowledgeBaseLastIndexingJob[]
    The last indexing job for the knowledge base.
    name string
    The name of the knowledge base.
    projectId string
    The unique identifier of the project to which the knowledge base belongs.
    region string
    tags string[]
    vpcUuid string
    The unique identifier of the VPC to which the knowledge base belongs.
    added_to_agent_at str
    The time when the knowledge base was added to the agent.
    created_at str
    The time when the knowledge base was created.
    database_id str
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    datasources Sequence[GenaiKnowledgeBaseDataSourceArgs]
    Data sources for the knowledge base
    embedding_model_uuid str
    The unique identifier of the embedding model
    is_public bool
    Indicates whether the knowledge base is public or private.
    last_indexing_jobs Sequence[GenaiKnowledgeBaseLastIndexingJobArgs]
    The last indexing job for the knowledge base.
    name str
    The name of the knowledge base.
    project_id str
    The unique identifier of the project to which the knowledge base belongs.
    region str
    tags Sequence[str]
    vpc_uuid str
    The unique identifier of the VPC to which the knowledge base belongs.
    addedToAgentAt String
    The time when the knowledge base was added to the agent.
    createdAt String
    The time when the knowledge base was created.
    databaseId String
    The unique identifier of the DigitalOcean OpenSearch database this knowledge base will use
    datasources List<Property Map>
    Data sources for the knowledge base
    embeddingModelUuid String
    The unique identifier of the embedding model
    isPublic Boolean
    Indicates whether the knowledge base is public or private.
    lastIndexingJobs List<Property Map>
    The last indexing job for the knowledge base.
    name String
    The name of the knowledge base.
    projectId String
    The unique identifier of the project to which the knowledge base belongs.
    region String
    tags List<String>
    vpcUuid String
    The unique identifier of the VPC to which the knowledge base belongs.

    Supporting Types

    GenaiKnowledgeBaseDataSource, GenaiKnowledgeBaseDataSourceArgs

    CreatedAt string
    Created At timestamp for the Knowledge Base
    FileUploadDataSources List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceFileUploadDataSource>
    File upload data source configuration
    LastIndexingJobs List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceLastIndexingJob>
    Last indexing job for the data source
    SpacesDataSources List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceSpacesDataSource>
    Spaces data source configuration
    UpdatedAt string
    Timestamp when the Knowledge Base was updated
    Uuid string
    UUID of the Knowledge Base
    WebCrawlerDataSources List<Pulumi.DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceWebCrawlerDataSource>
    Web crawler data source configuration
    CreatedAt string
    Created At timestamp for the Knowledge Base
    FileUploadDataSources []GenaiKnowledgeBaseDataSourceFileUploadDataSource
    File upload data source configuration
    LastIndexingJobs []GenaiKnowledgeBaseDataSourceLastIndexingJob
    Last indexing job for the data source
    SpacesDataSources []GenaiKnowledgeBaseDataSourceSpacesDataSource
    Spaces data source configuration
    UpdatedAt string
    Timestamp when the Knowledge Base was updated
    Uuid string
    UUID of the Knowledge Base
    WebCrawlerDataSources []GenaiKnowledgeBaseDataSourceWebCrawlerDataSource
    Web crawler data source configuration
    createdAt String
    Created At timestamp for the Knowledge Base
    fileUploadDataSources List<GenaiKnowledgeBaseDataSourceFileUploadDataSource>
    File upload data source configuration
    lastIndexingJobs List<GenaiKnowledgeBaseDataSourceLastIndexingJob>
    Last indexing job for the data source
    spacesDataSources List<GenaiKnowledgeBaseDataSourceSpacesDataSource>
    Spaces data source configuration
    updatedAt String
    Timestamp when the Knowledge Base was updated
    uuid String
    UUID of the Knowledge Base
    webCrawlerDataSources List<GenaiKnowledgeBaseDataSourceWebCrawlerDataSource>
    Web crawler data source configuration
    createdAt string
    Created At timestamp for the Knowledge Base
    fileUploadDataSources GenaiKnowledgeBaseDataSourceFileUploadDataSource[]
    File upload data source configuration
    lastIndexingJobs GenaiKnowledgeBaseDataSourceLastIndexingJob[]
    Last indexing job for the data source
    spacesDataSources GenaiKnowledgeBaseDataSourceSpacesDataSource[]
    Spaces data source configuration
    updatedAt string
    Timestamp when the Knowledge Base was updated
    uuid string
    UUID of the Knowledge Base
    webCrawlerDataSources GenaiKnowledgeBaseDataSourceWebCrawlerDataSource[]
    Web crawler data source configuration
    created_at str
    Created At timestamp for the Knowledge Base
    file_upload_data_sources Sequence[GenaiKnowledgeBaseDataSourceFileUploadDataSource]
    File upload data source configuration
    last_indexing_jobs Sequence[GenaiKnowledgeBaseDataSourceLastIndexingJob]
    Last indexing job for the data source
    spaces_data_sources Sequence[GenaiKnowledgeBaseDataSourceSpacesDataSource]
    Spaces data source configuration
    updated_at str
    Timestamp when the Knowledge Base was updated
    uuid str
    UUID of the Knowledge Base
    web_crawler_data_sources Sequence[GenaiKnowledgeBaseDataSourceWebCrawlerDataSource]
    Web crawler data source configuration
    createdAt String
    Created At timestamp for the Knowledge Base
    fileUploadDataSources List<Property Map>
    File upload data source configuration
    lastIndexingJobs List<Property Map>
    Last indexing job for the data source
    spacesDataSources List<Property Map>
    Spaces data source configuration
    updatedAt String
    Timestamp when the Knowledge Base was updated
    uuid String
    UUID of the Knowledge Base
    webCrawlerDataSources List<Property Map>
    Web crawler data source configuration

    GenaiKnowledgeBaseDataSourceFileUploadDataSource, GenaiKnowledgeBaseDataSourceFileUploadDataSourceArgs

    OriginalFileName string
    The original name of the uploaded file
    SizeInBytes string
    The size of the file in bytes
    StoredObjectKey string
    The stored object key for the file
    OriginalFileName string
    The original name of the uploaded file
    SizeInBytes string
    The size of the file in bytes
    StoredObjectKey string
    The stored object key for the file
    originalFileName String
    The original name of the uploaded file
    sizeInBytes String
    The size of the file in bytes
    storedObjectKey String
    The stored object key for the file
    originalFileName string
    The original name of the uploaded file
    sizeInBytes string
    The size of the file in bytes
    storedObjectKey string
    The stored object key for the file
    original_file_name str
    The original name of the uploaded file
    size_in_bytes str
    The size of the file in bytes
    stored_object_key str
    The stored object key for the file
    originalFileName String
    The original name of the uploaded file
    sizeInBytes String
    The size of the file in bytes
    storedObjectKey String
    The stored object key for the file

    GenaiKnowledgeBaseDataSourceLastIndexingJob, GenaiKnowledgeBaseDataSourceLastIndexingJobArgs

    CompletedDatasources int
    Number of completed datasources in the last indexing job
    CreatedAt string
    Created At timestamp for the last indexing job
    DataSourceUuids List<string>
    Datasource UUIDs for the last indexing job
    FinishedAt string
    Timestamp when the last indexing job finished
    KnowledgeBaseUuid string
    UUID of the Knowledge Base for the last indexing job
    Phase string
    Phase of the last indexing job
    StartedAt string
    Timestamp when the last indexing job started
    Tokens int
    Number of tokens processed in the last indexing job
    TotalDatasources int
    Total number of datasources in the last indexing job
    UpdatedAt string
    Timestamp when the last indexing job updated
    Uuid string
    UUID of the last indexing job
    CompletedDatasources int
    Number of completed datasources in the last indexing job
    CreatedAt string
    Created At timestamp for the last indexing job
    DataSourceUuids []string
    Datasource UUIDs for the last indexing job
    FinishedAt string
    Timestamp when the last indexing job finished
    KnowledgeBaseUuid string
    UUID of the Knowledge Base for the last indexing job
    Phase string
    Phase of the last indexing job
    StartedAt string
    Timestamp when the last indexing job started
    Tokens int
    Number of tokens processed in the last indexing job
    TotalDatasources int
    Total number of datasources in the last indexing job
    UpdatedAt string
    Timestamp when the last indexing job updated
    Uuid string
    UUID of the last indexing job
    completedDatasources Integer
    Number of completed datasources in the last indexing job
    createdAt String
    Created At timestamp for the last indexing job
    dataSourceUuids List<String>
    Datasource UUIDs for the last indexing job
    finishedAt String
    Timestamp when the last indexing job finished
    knowledgeBaseUuid String
    UUID of the Knowledge Base for the last indexing job
    phase String
    Phase of the last indexing job
    startedAt String
    Timestamp when the last indexing job started
    tokens Integer
    Number of tokens processed in the last indexing job
    totalDatasources Integer
    Total number of datasources in the last indexing job
    updatedAt String
    Timestamp when the last indexing job updated
    uuid String
    UUID of the last indexing job
    completedDatasources number
    Number of completed datasources in the last indexing job
    createdAt string
    Created At timestamp for the last indexing job
    dataSourceUuids string[]
    Datasource UUIDs for the last indexing job
    finishedAt string
    Timestamp when the last indexing job finished
    knowledgeBaseUuid string
    UUID of the Knowledge Base for the last indexing job
    phase string
    Phase of the last indexing job
    startedAt string
    Timestamp when the last indexing job started
    tokens number
    Number of tokens processed in the last indexing job
    totalDatasources number
    Total number of datasources in the last indexing job
    updatedAt string
    Timestamp when the last indexing job updated
    uuid string
    UUID of the last indexing job
    completed_datasources int
    Number of completed datasources in the last indexing job
    created_at str
    Created At timestamp for the last indexing job
    data_source_uuids Sequence[str]
    Datasource UUIDs for the last indexing job
    finished_at str
    Timestamp when the last indexing job finished
    knowledge_base_uuid str
    UUID of the Knowledge Base for the last indexing job
    phase str
    Phase of the last indexing job
    started_at str
    Timestamp when the last indexing job started
    tokens int
    Number of tokens processed in the last indexing job
    total_datasources int
    Total number of datasources in the last indexing job
    updated_at str
    Timestamp when the last indexing job updated
    uuid str
    UUID of the last indexing job
    completedDatasources Number
    Number of completed datasources in the last indexing job
    createdAt String
    Created At timestamp for the last indexing job
    dataSourceUuids List<String>
    Datasource UUIDs for the last indexing job
    finishedAt String
    Timestamp when the last indexing job finished
    knowledgeBaseUuid String
    UUID of the Knowledge Base for the last indexing job
    phase String
    Phase of the last indexing job
    startedAt String
    Timestamp when the last indexing job started
    tokens Number
    Number of tokens processed in the last indexing job
    totalDatasources Number
    Total number of datasources in the last indexing job
    updatedAt String
    Timestamp when the last indexing job updated
    uuid String
    UUID of the last indexing job

    GenaiKnowledgeBaseDataSourceSpacesDataSource, GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs

    BucketName string
    The name of the Spaces bucket
    ItemPath string
    The path to the item in the bucket
    Region string
    The region of the Spaces bucket
    BucketName string
    The name of the Spaces bucket
    ItemPath string
    The path to the item in the bucket
    Region string
    The region of the Spaces bucket
    bucketName String
    The name of the Spaces bucket
    itemPath String
    The path to the item in the bucket
    region String
    The region of the Spaces bucket
    bucketName string
    The name of the Spaces bucket
    itemPath string
    The path to the item in the bucket
    region string
    The region of the Spaces bucket
    bucket_name str
    The name of the Spaces bucket
    item_path str
    The path to the item in the bucket
    region str
    The region of the Spaces bucket
    bucketName String
    The name of the Spaces bucket
    itemPath String
    The path to the item in the bucket
    region String
    The region of the Spaces bucket

    GenaiKnowledgeBaseDataSourceWebCrawlerDataSource, GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs

    BaseUrl string
    The base URL to crawl
    CrawlingOption string
    Options for specifying how URLs found on pages should be handled.

    • UNKNOWN: Default unknown value
    • SCOPED: Only include the base URL.
    • PATH: Crawl the base URL and linked pages within the URL path.
    • DOMAIN: Crawl the base URL and linked pages within the same domain.
    • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
    EmbedMedia bool
    Whether to embed media content
    BaseUrl string
    The base URL to crawl
    CrawlingOption string
    Options for specifying how URLs found on pages should be handled.

    • UNKNOWN: Default unknown value
    • SCOPED: Only include the base URL.
    • PATH: Crawl the base URL and linked pages within the URL path.
    • DOMAIN: Crawl the base URL and linked pages within the same domain.
    • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
    EmbedMedia bool
    Whether to embed media content
    baseUrl String
    The base URL to crawl
    crawlingOption String
    Options for specifying how URLs found on pages should be handled.

    • UNKNOWN: Default unknown value
    • SCOPED: Only include the base URL.
    • PATH: Crawl the base URL and linked pages within the URL path.
    • DOMAIN: Crawl the base URL and linked pages within the same domain.
    • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
    embedMedia Boolean
    Whether to embed media content
    baseUrl string
    The base URL to crawl
    crawlingOption string
    Options for specifying how URLs found on pages should be handled.

    • UNKNOWN: Default unknown value
    • SCOPED: Only include the base URL.
    • PATH: Crawl the base URL and linked pages within the URL path.
    • DOMAIN: Crawl the base URL and linked pages within the same domain.
    • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
    embedMedia boolean
    Whether to embed media content
    base_url str
    The base URL to crawl
    crawling_option str
    Options for specifying how URLs found on pages should be handled.

    • UNKNOWN: Default unknown value
    • SCOPED: Only include the base URL.
    • PATH: Crawl the base URL and linked pages within the URL path.
    • DOMAIN: Crawl the base URL and linked pages within the same domain.
    • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
    embed_media bool
    Whether to embed media content
    baseUrl String
    The base URL to crawl
    crawlingOption String
    Options for specifying how URLs found on pages should be handled.

    • UNKNOWN: Default unknown value
    • SCOPED: Only include the base URL.
    • PATH: Crawl the base URL and linked pages within the URL path.
    • DOMAIN: Crawl the base URL and linked pages within the same domain.
    • SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
    embedMedia Boolean
    Whether to embed media content

    GenaiKnowledgeBaseLastIndexingJob, GenaiKnowledgeBaseLastIndexingJobArgs

    CompletedDatasources int
    Number of completed datasources in the last indexing job
    CreatedAt string
    Created At timestamp for the last indexing job
    DataSourceUuids List<string>
    Datasource UUIDs for the last indexing job
    FinishedAt string
    Timestamp when the last indexing job finished
    KnowledgeBaseUuid string
    UUID of the Knowledge Base for the last indexing job
    Phase string
    Phase of the last indexing job
    StartedAt string
    Timestamp when the last indexing job started
    Tokens int
    Number of tokens processed in the last indexing job
    TotalDatasources int
    Total number of datasources in the last indexing job
    UpdatedAt string
    Timestamp when the last indexing job updated
    Uuid string
    UUID of the last indexing job
    CompletedDatasources int
    Number of completed datasources in the last indexing job
    CreatedAt string
    Created At timestamp for the last indexing job
    DataSourceUuids []string
    Datasource UUIDs for the last indexing job
    FinishedAt string
    Timestamp when the last indexing job finished
    KnowledgeBaseUuid string
    UUID of the Knowledge Base for the last indexing job
    Phase string
    Phase of the last indexing job
    StartedAt string
    Timestamp when the last indexing job started
    Tokens int
    Number of tokens processed in the last indexing job
    TotalDatasources int
    Total number of datasources in the last indexing job
    UpdatedAt string
    Timestamp when the last indexing job updated
    Uuid string
    UUID of the last indexing job
    completedDatasources Integer
    Number of completed datasources in the last indexing job
    createdAt String
    Created At timestamp for the last indexing job
    dataSourceUuids List<String>
    Datasource UUIDs for the last indexing job
    finishedAt String
    Timestamp when the last indexing job finished
    knowledgeBaseUuid String
    UUID of the Knowledge Base for the last indexing job
    phase String
    Phase of the last indexing job
    startedAt String
    Timestamp when the last indexing job started
    tokens Integer
    Number of tokens processed in the last indexing job
    totalDatasources Integer
    Total number of datasources in the last indexing job
    updatedAt String
    Timestamp when the last indexing job updated
    uuid String
    UUID of the last indexing job
    completedDatasources number
    Number of completed datasources in the last indexing job
    createdAt string
    Created At timestamp for the last indexing job
    dataSourceUuids string[]
    Datasource UUIDs for the last indexing job
    finishedAt string
    Timestamp when the last indexing job finished
    knowledgeBaseUuid string
    UUID of the Knowledge Base for the last indexing job
    phase string
    Phase of the last indexing job
    startedAt string
    Timestamp when the last indexing job started
    tokens number
    Number of tokens processed in the last indexing job
    totalDatasources number
    Total number of datasources in the last indexing job
    updatedAt string
    Timestamp when the last indexing job updated
    uuid string
    UUID of the last indexing job
    completed_datasources int
    Number of completed datasources in the last indexing job
    created_at str
    Created At timestamp for the last indexing job
    data_source_uuids Sequence[str]
    Datasource UUIDs for the last indexing job
    finished_at str
    Timestamp when the last indexing job finished
    knowledge_base_uuid str
    UUID of the Knowledge Base for the last indexing job
    phase str
    Phase of the last indexing job
    started_at str
    Timestamp when the last indexing job started
    tokens int
    Number of tokens processed in the last indexing job
    total_datasources int
    Total number of datasources in the last indexing job
    updated_at str
    Timestamp when the last indexing job updated
    uuid str
    UUID of the last indexing job
    completedDatasources Number
    Number of completed datasources in the last indexing job
    createdAt String
    Created At timestamp for the last indexing job
    dataSourceUuids List<String>
    Datasource UUIDs for the last indexing job
    finishedAt String
    Timestamp when the last indexing job finished
    knowledgeBaseUuid String
    UUID of the Knowledge Base for the last indexing job
    phase String
    Phase of the last indexing job
    startedAt String
    Timestamp when the last indexing job started
    tokens Number
    Number of tokens processed in the last indexing job
    totalDatasources Number
    Total number of datasources in the last indexing job
    updatedAt String
    Timestamp when the last indexing job updated
    uuid String
    UUID of the last indexing job

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.51.0 published on Thursday, Aug 14, 2025 by Pulumi