digitalocean.GenaiKnowledgeBaseDataSource
Explore with Pulumi AI
Create GenaiKnowledgeBaseDataSource Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GenaiKnowledgeBaseDataSource(name: string, args: GenaiKnowledgeBaseDataSourceArgs, opts?: CustomResourceOptions);
@overload
def GenaiKnowledgeBaseDataSource(resource_name: str,
args: GenaiKnowledgeBaseDataSourceInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GenaiKnowledgeBaseDataSource(resource_name: str,
opts: Optional[ResourceOptions] = None,
knowledge_base_uuid: Optional[str] = None,
spaces_data_source: Optional[GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs] = None,
web_crawler_data_source: Optional[GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs] = None)
func NewGenaiKnowledgeBaseDataSource(ctx *Context, name string, args GenaiKnowledgeBaseDataSourceArgs, opts ...ResourceOption) (*GenaiKnowledgeBaseDataSource, error)
public GenaiKnowledgeBaseDataSource(string name, GenaiKnowledgeBaseDataSourceArgs args, CustomResourceOptions? opts = null)
public GenaiKnowledgeBaseDataSource(String name, GenaiKnowledgeBaseDataSourceArgs args)
public GenaiKnowledgeBaseDataSource(String name, GenaiKnowledgeBaseDataSourceArgs args, CustomResourceOptions options)
type: digitalocean:GenaiKnowledgeBaseDataSource
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 GenaiKnowledgeBaseDataSourceArgs
- 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 GenaiKnowledgeBaseDataSourceInitArgs
- 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 GenaiKnowledgeBaseDataSourceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GenaiKnowledgeBaseDataSourceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GenaiKnowledgeBaseDataSourceArgs
- 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 genaiKnowledgeBaseDataSourceResource = new DigitalOcean.GenaiKnowledgeBaseDataSource("genaiKnowledgeBaseDataSourceResource", new()
{
KnowledgeBaseUuid = "string",
SpacesDataSource = new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs
{
BucketName = "string",
ItemPath = "string",
Region = "string",
},
WebCrawlerDataSource = new DigitalOcean.Inputs.GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs
{
BaseUrl = "string",
CrawlingOption = "string",
EmbedMedia = false,
},
});
example, err := digitalocean.NewGenaiKnowledgeBaseDataSource(ctx, "genaiKnowledgeBaseDataSourceResource", &digitalocean.GenaiKnowledgeBaseDataSourceArgs{
KnowledgeBaseUuid: pulumi.String("string"),
SpacesDataSource: &digitalocean.GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs{
BucketName: pulumi.String("string"),
ItemPath: pulumi.String("string"),
Region: pulumi.String("string"),
},
WebCrawlerDataSource: &digitalocean.GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs{
BaseUrl: pulumi.String("string"),
CrawlingOption: pulumi.String("string"),
EmbedMedia: pulumi.Bool(false),
},
})
var genaiKnowledgeBaseDataSourceResource = new GenaiKnowledgeBaseDataSource("genaiKnowledgeBaseDataSourceResource", GenaiKnowledgeBaseDataSourceArgs.builder()
.knowledgeBaseUuid("string")
.spacesDataSource(GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs.builder()
.bucketName("string")
.itemPath("string")
.region("string")
.build())
.webCrawlerDataSource(GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs.builder()
.baseUrl("string")
.crawlingOption("string")
.embedMedia(false)
.build())
.build());
genai_knowledge_base_data_source_resource = digitalocean.GenaiKnowledgeBaseDataSource("genaiKnowledgeBaseDataSourceResource",
knowledge_base_uuid="string",
spaces_data_source={
"bucket_name": "string",
"item_path": "string",
"region": "string",
},
web_crawler_data_source={
"base_url": "string",
"crawling_option": "string",
"embed_media": False,
})
const genaiKnowledgeBaseDataSourceResource = new digitalocean.GenaiKnowledgeBaseDataSource("genaiKnowledgeBaseDataSourceResource", {
knowledgeBaseUuid: "string",
spacesDataSource: {
bucketName: "string",
itemPath: "string",
region: "string",
},
webCrawlerDataSource: {
baseUrl: "string",
crawlingOption: "string",
embedMedia: false,
},
});
type: digitalocean:GenaiKnowledgeBaseDataSource
properties:
knowledgeBaseUuid: string
spacesDataSource:
bucketName: string
itemPath: string
region: string
webCrawlerDataSource:
baseUrl: string
crawlingOption: string
embedMedia: false
GenaiKnowledgeBaseDataSource 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 GenaiKnowledgeBaseDataSource resource accepts the following input properties:
- knowledge
Base StringUuid - UUID of the Knowledge Base
- spaces
Data Property MapSource - web
Crawler Property MapData Source
Outputs
All input properties are implicitly available as output properties. Additionally, the GenaiKnowledgeBaseDataSource resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GenaiKnowledgeBaseDataSource Resource
Get an existing GenaiKnowledgeBaseDataSource 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?: GenaiKnowledgeBaseDataSourceState, opts?: CustomResourceOptions): GenaiKnowledgeBaseDataSource
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
knowledge_base_uuid: Optional[str] = None,
spaces_data_source: Optional[GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs] = None,
web_crawler_data_source: Optional[GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs] = None) -> GenaiKnowledgeBaseDataSource
func GetGenaiKnowledgeBaseDataSource(ctx *Context, name string, id IDInput, state *GenaiKnowledgeBaseDataSourceState, opts ...ResourceOption) (*GenaiKnowledgeBaseDataSource, error)
public static GenaiKnowledgeBaseDataSource Get(string name, Input<string> id, GenaiKnowledgeBaseDataSourceState? state, CustomResourceOptions? opts = null)
public static GenaiKnowledgeBaseDataSource get(String name, Output<String> id, GenaiKnowledgeBaseDataSourceState state, CustomResourceOptions options)
resources: _: type: digitalocean:GenaiKnowledgeBaseDataSource 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.
- knowledge
Base StringUuid - UUID of the Knowledge Base
- spaces
Data Property MapSource - web
Crawler Property MapData Source
Supporting Types
GenaiKnowledgeBaseDataSourceSpacesDataSource, GenaiKnowledgeBaseDataSourceSpacesDataSourceArgs
- Bucket
Name string - The name of the Spaces bucket
- Item
Path string - The path to the item in the bucket
- Region string
- The region of the Spaces bucket
- Bucket
Name string - The name of the Spaces bucket
- Item
Path string - The path to the item in the bucket
- Region string
- The region of the Spaces bucket
- bucket
Name String - The name of the Spaces bucket
- item
Path String - The path to the item in the bucket
- region String
- The region of the Spaces bucket
- bucket
Name string - The name of the Spaces bucket
- item
Path 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
- bucket
Name String - The name of the Spaces bucket
- item
Path String - The path to the item in the bucket
- region String
- The region of the Spaces bucket
GenaiKnowledgeBaseDataSourceWebCrawlerDataSource, GenaiKnowledgeBaseDataSourceWebCrawlerDataSourceArgs
- Base
Url string - The base URL to crawl
- Crawling
Option 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.
- Embed
Media bool - Whether to embed media content
- Base
Url string - The base URL to crawl
- Crawling
Option 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.
- Embed
Media bool - Whether to embed media content
- base
Url String - The base URL to crawl
- crawling
Option 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.
- embed
Media Boolean - Whether to embed media content
- base
Url string - The base URL to crawl
- crawling
Option 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.
- embed
Media 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
- base
Url String - The base URL to crawl
- crawling
Option 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.
- embed
Media Boolean - Whether to embed media content
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
digitalocean
Terraform Provider.