Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.GenerativeAi.getAgentKnowledgeBases
Explore with Pulumi AI
This data source provides the list of Knowledge Bases in Oracle Cloud Infrastructure Generative Ai Agent service.
ListKnowledgeBases
Gets a list of knowledge bases.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testKnowledgeBases = oci.GenerativeAi.getAgentKnowledgeBases({
compartmentId: compartmentId,
displayName: knowledgeBaseDisplayName,
state: knowledgeBaseState,
});
import pulumi
import pulumi_oci as oci
test_knowledge_bases = oci.GenerativeAi.get_agent_knowledge_bases(compartment_id=compartment_id,
display_name=knowledge_base_display_name,
state=knowledge_base_state)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/GenerativeAi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := GenerativeAi.GetAgentKnowledgeBases(ctx, &generativeai.GetAgentKnowledgeBasesArgs{
CompartmentId: pulumi.StringRef(compartmentId),
DisplayName: pulumi.StringRef(knowledgeBaseDisplayName),
State: pulumi.StringRef(knowledgeBaseState),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testKnowledgeBases = Oci.GenerativeAi.GetAgentKnowledgeBases.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = knowledgeBaseDisplayName,
State = knowledgeBaseState,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentKnowledgeBasesArgs;
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) {
final var testKnowledgeBases = GenerativeAiFunctions.getAgentKnowledgeBases(GetAgentKnowledgeBasesArgs.builder()
.compartmentId(compartmentId)
.displayName(knowledgeBaseDisplayName)
.state(knowledgeBaseState)
.build());
}
}
variables:
testKnowledgeBases:
fn::invoke:
Function: oci:GenerativeAi:getAgentKnowledgeBases
Arguments:
compartmentId: ${compartmentId}
displayName: ${knowledgeBaseDisplayName}
state: ${knowledgeBaseState}
Using getAgentKnowledgeBases
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAgentKnowledgeBases(args: GetAgentKnowledgeBasesArgs, opts?: InvokeOptions): Promise<GetAgentKnowledgeBasesResult>
function getAgentKnowledgeBasesOutput(args: GetAgentKnowledgeBasesOutputArgs, opts?: InvokeOptions): Output<GetAgentKnowledgeBasesResult>
def get_agent_knowledge_bases(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_generativeai.GetAgentKnowledgeBasesFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentKnowledgeBasesResult
def get_agent_knowledge_bases_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_generativeai.GetAgentKnowledgeBasesFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAgentKnowledgeBasesResult]
func GetAgentKnowledgeBases(ctx *Context, args *GetAgentKnowledgeBasesArgs, opts ...InvokeOption) (*GetAgentKnowledgeBasesResult, error)
func GetAgentKnowledgeBasesOutput(ctx *Context, args *GetAgentKnowledgeBasesOutputArgs, opts ...InvokeOption) GetAgentKnowledgeBasesResultOutput
> Note: This function is named GetAgentKnowledgeBases
in the Go SDK.
public static class GetAgentKnowledgeBases
{
public static Task<GetAgentKnowledgeBasesResult> InvokeAsync(GetAgentKnowledgeBasesArgs args, InvokeOptions? opts = null)
public static Output<GetAgentKnowledgeBasesResult> Invoke(GetAgentKnowledgeBasesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAgentKnowledgeBasesResult> getAgentKnowledgeBases(GetAgentKnowledgeBasesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:GenerativeAi/getAgentKnowledgeBases:getAgentKnowledgeBases
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Agent Knowledge Bases Filter> - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Agent Knowledge Bases Filter - State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Agent Knowledge Bases Filter> - state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id string - The OCID of the compartment in which to list resources.
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Agent Knowledge Bases Filter[] - state string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment_
id str - The OCID of the compartment in which to list resources.
- display_
name str - A filter to return only resources that match the given display name exactly.
- filters
Sequence[generativeai.
Get Agent Knowledge Bases Filter] - state str
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment in which to list resources.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters List<Property Map>
- state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
getAgentKnowledgeBases Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base List<GetCollections Agent Knowledge Bases Knowledge Base Collection> - The list of knowledge_base_collection.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
List<Get
Agent Knowledge Bases Filter> - State string
- The current state of the knowledge base.
- Id string
- The provider-assigned unique ID for this managed resource.
- Knowledge
Base []GetCollections Agent Knowledge Bases Knowledge Base Collection - The list of knowledge_base_collection.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- Filters
[]Get
Agent Knowledge Bases Filter - State string
- The current state of the knowledge base.
- id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base List<GetCollections Agent Knowledge Bases Knowledge Base Collection> - The list of knowledge_base_collection.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
List<Get
Agent Knowledge Bases Filter> - state String
- The current state of the knowledge base.
- id string
- The provider-assigned unique ID for this managed resource.
- knowledge
Base GetCollections Agent Knowledge Bases Knowledge Base Collection[] - The list of knowledge_base_collection.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
Get
Agent Knowledge Bases Filter[] - state string
- The current state of the knowledge base.
- id str
- The provider-assigned unique ID for this managed resource.
- knowledge_
base_ Sequence[generativeai.collections Get Agent Knowledge Bases Knowledge Base Collection] - The list of knowledge_base_collection.
- compartment_
id str - The OCID of the compartment.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable.
- filters
Sequence[generativeai.
Get Agent Knowledge Bases Filter] - state str
- The current state of the knowledge base.
- id String
- The provider-assigned unique ID for this managed resource.
- knowledge
Base List<Property Map>Collections - The list of knowledge_base_collection.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- filters List<Property Map>
- state String
- The current state of the knowledge base.
Supporting Types
GetAgentKnowledgeBasesFilter
GetAgentKnowledgeBasesKnowledgeBaseCollection
GetAgentKnowledgeBasesKnowledgeBaseCollectionItem
- Compartment
Id string - The OCID of the compartment in which to list resources.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- A description of the knowledge base.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The OCID of the knowledge base.
- Index
Configs List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config> - IndexConfig
- Lifecycle
Details string - A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the knowledge base was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Compartment
Id string - The OCID of the compartment in which to list resources.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Description string
- A description of the knowledge base.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Id string
- The OCID of the knowledge base.
- Index
Configs []GetAgent Knowledge Bases Knowledge Base Collection Item Index Config - IndexConfig
- Lifecycle
Details string - A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- State string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time the knowledge base was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- A description of the knowledge base.
- display
Name String - A filter to return only resources that match the given display name exactly.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The OCID of the knowledge base.
- index
Configs List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config> - IndexConfig
- lifecycle
Details String - A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the knowledge base was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id string - The OCID of the compartment in which to list resources.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description string
- A description of the knowledge base.
- display
Name string - A filter to return only resources that match the given display name exactly.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id string
- The OCID of the knowledge base.
- index
Configs GetAgent Knowledge Bases Knowledge Base Collection Item Index Config[] - IndexConfig
- lifecycle
Details string - A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state string
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The date and time the knowledge base was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- compartment_
id str - The OCID of the compartment in which to list resources.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description str
- A description of the knowledge base.
- display_
name str - A filter to return only resources that match the given display name exactly.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id str
- The OCID of the knowledge base.
- index_
configs Sequence[generativeai.Get Agent Knowledge Bases Knowledge Base Collection Item Index Config] - IndexConfig
- lifecycle_
details str - A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state str
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - The date and time the knowledge base was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
updated str - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- compartment
Id String - The OCID of the compartment in which to list resources.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- description String
- A description of the knowledge base.
- display
Name String - A filter to return only resources that match the given display name exactly.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- id String
- The OCID of the knowledge base.
- index
Configs List<Property Map> - IndexConfig
- lifecycle
Details String - A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state String
- A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time the knowledge base was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the knowledge base was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfig
- Cluster
Id string - The OCID of the OpenSearch Cluster.
- Database
Connections List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Connection> - DatabaseConnection
- Database
Functions List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Function> - Array of Database functions to be used.
- Index
Config stringType - The type of index. The allowed values are:
DEFAULT_INDEX_CONFIG
: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.OCI_OPEN_SEARCH_INDEX_CONFIG
: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.OCI_DATABASE_CONFIG
: OciDatabaseConfig allows customer to configure their Database.
- Indexes
List<Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index> - Index configuration for open search.
- Secret
Details List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Secret Detail> - SecretDetail
- Should
Enable boolHybrid Search - Whether to enable Hybrid search in service managed OpenSearch.
- Cluster
Id string - The OCID of the OpenSearch Cluster.
- Database
Connections []GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Connection - DatabaseConnection
- Database
Functions []GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Function - Array of Database functions to be used.
- Index
Config stringType - The type of index. The allowed values are:
DEFAULT_INDEX_CONFIG
: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.OCI_OPEN_SEARCH_INDEX_CONFIG
: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.OCI_DATABASE_CONFIG
: OciDatabaseConfig allows customer to configure their Database.
- Indexes
[]Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index - Index configuration for open search.
- Secret
Details []GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Secret Detail - SecretDetail
- Should
Enable boolHybrid Search - Whether to enable Hybrid search in service managed OpenSearch.
- cluster
Id String - The OCID of the OpenSearch Cluster.
- database
Connections List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Connection> - DatabaseConnection
- database
Functions List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Function> - Array of Database functions to be used.
- index
Config StringType - The type of index. The allowed values are:
DEFAULT_INDEX_CONFIG
: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.OCI_OPEN_SEARCH_INDEX_CONFIG
: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.OCI_DATABASE_CONFIG
: OciDatabaseConfig allows customer to configure their Database.
- indexes
List<Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index> - Index configuration for open search.
- secret
Details List<GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Secret Detail> - SecretDetail
- should
Enable BooleanHybrid Search - Whether to enable Hybrid search in service managed OpenSearch.
- cluster
Id string - The OCID of the OpenSearch Cluster.
- database
Connections GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Connection[] - DatabaseConnection
- database
Functions GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Database Function[] - Array of Database functions to be used.
- index
Config stringType - The type of index. The allowed values are:
DEFAULT_INDEX_CONFIG
: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.OCI_OPEN_SEARCH_INDEX_CONFIG
: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.OCI_DATABASE_CONFIG
: OciDatabaseConfig allows customer to configure their Database.
- indexes
Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index[] - Index configuration for open search.
- secret
Details GetAgent Knowledge Bases Knowledge Base Collection Item Index Config Secret Detail[] - SecretDetail
- should
Enable booleanHybrid Search - Whether to enable Hybrid search in service managed OpenSearch.
- cluster_
id str - The OCID of the OpenSearch Cluster.
- database_
connections Sequence[generativeai.Get Agent Knowledge Bases Knowledge Base Collection Item Index Config Database Connection] - DatabaseConnection
- database_
functions Sequence[generativeai.Get Agent Knowledge Bases Knowledge Base Collection Item Index Config Database Function] - Array of Database functions to be used.
- index_
config_ strtype - The type of index. The allowed values are:
DEFAULT_INDEX_CONFIG
: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.OCI_OPEN_SEARCH_INDEX_CONFIG
: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.OCI_DATABASE_CONFIG
: OciDatabaseConfig allows customer to configure their Database.
- indexes
Sequence[generativeai.
Get Agent Knowledge Bases Knowledge Base Collection Item Index Config Index] - Index configuration for open search.
- secret_
details Sequence[generativeai.Get Agent Knowledge Bases Knowledge Base Collection Item Index Config Secret Detail] - SecretDetail
- should_
enable_ boolhybrid_ search - Whether to enable Hybrid search in service managed OpenSearch.
- cluster
Id String - The OCID of the OpenSearch Cluster.
- database
Connections List<Property Map> - DatabaseConnection
- database
Functions List<Property Map> - Array of Database functions to be used.
- index
Config StringType - The type of index. The allowed values are:
DEFAULT_INDEX_CONFIG
: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.OCI_OPEN_SEARCH_INDEX_CONFIG
: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.OCI_DATABASE_CONFIG
: OciDatabaseConfig allows customer to configure their Database.
- indexes List<Property Map>
- Index configuration for open search.
- secret
Details List<Property Map> - SecretDetail
- should
Enable BooleanHybrid Search - Whether to enable Hybrid search in service managed OpenSearch.
GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseConnection
- Connection
Id string - The OCID of the Database Tools Connection.
- Connection
Type string - The type of Database connection. The allowed values are:
DATABASE_TOOL_CONNECTION
: This allows the service to connect to a vector store via a Database Tools Connection.
- Connection
Id string - The OCID of the Database Tools Connection.
- Connection
Type string - The type of Database connection. The allowed values are:
DATABASE_TOOL_CONNECTION
: This allows the service to connect to a vector store via a Database Tools Connection.
- connection
Id String - The OCID of the Database Tools Connection.
- connection
Type String - The type of Database connection. The allowed values are:
DATABASE_TOOL_CONNECTION
: This allows the service to connect to a vector store via a Database Tools Connection.
- connection
Id string - The OCID of the Database Tools Connection.
- connection
Type string - The type of Database connection. The allowed values are:
DATABASE_TOOL_CONNECTION
: This allows the service to connect to a vector store via a Database Tools Connection.
- connection_
id str - The OCID of the Database Tools Connection.
- connection_
type str - The type of Database connection. The allowed values are:
DATABASE_TOOL_CONNECTION
: This allows the service to connect to a vector store via a Database Tools Connection.
- connection
Id String - The OCID of the Database Tools Connection.
- connection
Type String - The type of Database connection. The allowed values are:
DATABASE_TOOL_CONNECTION
: This allows the service to connect to a vector store via a Database Tools Connection.
GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigDatabaseFunction
- Name string
- The index name in opensearch.
- Name string
- The index name in opensearch.
- name String
- The index name in opensearch.
- name string
- The index name in opensearch.
- name str
- The index name in opensearch.
- name String
- The index name in opensearch.
GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndex
- Name string
- The index name in opensearch.
- Schemas
List<Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index Schema> - IndexSchema
- Name string
- The index name in opensearch.
- Schemas
[]Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index Schema - IndexSchema
- name String
- The index name in opensearch.
- schemas
List<Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index Schema> - IndexSchema
- name string
- The index name in opensearch.
- schemas
Get
Agent Knowledge Bases Knowledge Base Collection Item Index Config Index Schema[] - IndexSchema
- name str
- The index name in opensearch.
- schemas
Sequence[generativeai.
Get Agent Knowledge Bases Knowledge Base Collection Item Index Config Index Schema] - IndexSchema
- name String
- The index name in opensearch.
- schemas List<Property Map>
- IndexSchema
GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigIndexSchema
- Body
Key string - Body key name.
- Embedding
Body stringKey - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
- Title
Key string - Title key that stores the Title of a document, if available.
- Url
Key string - URL key that stores the URL of a document, if available.
- Body
Key string - Body key name.
- Embedding
Body stringKey - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
- Title
Key string - Title key that stores the Title of a document, if available.
- Url
Key string - URL key that stores the URL of a document, if available.
- body
Key String - Body key name.
- embedding
Body StringKey - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
- title
Key String - Title key that stores the Title of a document, if available.
- url
Key String - URL key that stores the URL of a document, if available.
- body
Key string - Body key name.
- embedding
Body stringKey - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
- title
Key string - Title key that stores the Title of a document, if available.
- url
Key string - URL key that stores the URL of a document, if available.
- body_
key str - Body key name.
- embedding_
body_ strkey - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
- title_
key str - Title key that stores the Title of a document, if available.
- url_
key str - URL key that stores the URL of a document, if available.
- body
Key String - Body key name.
- embedding
Body StringKey - Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
- title
Key String - Title key that stores the Title of a document, if available.
- url
Key String - URL key that stores the URL of a document, if available.
GetAgentKnowledgeBasesKnowledgeBaseCollectionItemIndexConfigSecretDetail
- Client
Id string - The IDCS Connect clientId.
- Idcs
Url string - The URL represent authentication url of the IDCS.
- Scope
Url string - Fully qualified scope url
- Type string
- The type of OpenID. The allowed values are:
IDCS_SECRET
: The OpenID configuration used is OpenSearch is IDCS.BASIC_AUTH_SECRET
: Basic authentication use for OpenSearch
- Vault
Secret stringId - The OCID of the secret for basic authentication.
- Client
Id string - The IDCS Connect clientId.
- Idcs
Url string - The URL represent authentication url of the IDCS.
- Scope
Url string - Fully qualified scope url
- Type string
- The type of OpenID. The allowed values are:
IDCS_SECRET
: The OpenID configuration used is OpenSearch is IDCS.BASIC_AUTH_SECRET
: Basic authentication use for OpenSearch
- Vault
Secret stringId - The OCID of the secret for basic authentication.
- client
Id String - The IDCS Connect clientId.
- idcs
Url String - The URL represent authentication url of the IDCS.
- scope
Url String - Fully qualified scope url
- type String
- The type of OpenID. The allowed values are:
IDCS_SECRET
: The OpenID configuration used is OpenSearch is IDCS.BASIC_AUTH_SECRET
: Basic authentication use for OpenSearch
- vault
Secret StringId - The OCID of the secret for basic authentication.
- client
Id string - The IDCS Connect clientId.
- idcs
Url string - The URL represent authentication url of the IDCS.
- scope
Url string - Fully qualified scope url
- type string
- The type of OpenID. The allowed values are:
IDCS_SECRET
: The OpenID configuration used is OpenSearch is IDCS.BASIC_AUTH_SECRET
: Basic authentication use for OpenSearch
- vault
Secret stringId - The OCID of the secret for basic authentication.
- client_
id str - The IDCS Connect clientId.
- idcs_
url str - The URL represent authentication url of the IDCS.
- scope_
url str - Fully qualified scope url
- type str
- The type of OpenID. The allowed values are:
IDCS_SECRET
: The OpenID configuration used is OpenSearch is IDCS.BASIC_AUTH_SECRET
: Basic authentication use for OpenSearch
- vault_
secret_ strid - The OCID of the secret for basic authentication.
- client
Id String - The IDCS Connect clientId.
- idcs
Url String - The URL represent authentication url of the IDCS.
- scope
Url String - Fully qualified scope url
- type String
- The type of OpenID. The allowed values are:
IDCS_SECRET
: The OpenID configuration used is OpenSearch is IDCS.BASIC_AUTH_SECRET
: Basic authentication use for OpenSearch
- vault
Secret StringId - The OCID of the secret for basic authentication.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.