Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.GenerativeAi.getAgentAgent
Explore with Pulumi AI
This data source provides details about a specific Agent resource in Oracle Cloud Infrastructure Generative Ai Agent service.
GetAgent
Gets information about an agent.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testAgent = oci.GenerativeAi.getAgentAgent({
agentId: testAgentOciGenerativeAiAgentAgent.id,
});
import pulumi
import pulumi_oci as oci
test_agent = oci.GenerativeAi.get_agent_agent(agent_id=test_agent_oci_generative_ai_agent_agent["id"])
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.GetAgentAgent(ctx, &generativeai.GetAgentAgentArgs{
AgentId: testAgentOciGenerativeAiAgentAgent.Id,
}, 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 testAgent = Oci.GenerativeAi.GetAgentAgent.Invoke(new()
{
AgentId = testAgentOciGenerativeAiAgentAgent.Id,
});
});
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.GetAgentAgentArgs;
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 testAgent = GenerativeAiFunctions.getAgentAgent(GetAgentAgentArgs.builder()
.agentId(testAgentOciGenerativeAiAgentAgent.id())
.build());
}
}
variables:
testAgent:
fn::invoke:
Function: oci:GenerativeAi:getAgentAgent
Arguments:
agentId: ${testAgentOciGenerativeAiAgentAgent.id}
Using getAgentAgent
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 getAgentAgent(args: GetAgentAgentArgs, opts?: InvokeOptions): Promise<GetAgentAgentResult>
function getAgentAgentOutput(args: GetAgentAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentAgentResult>
def get_agent_agent(agent_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAgentAgentResult
def get_agent_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAgentAgentResult]
func GetAgentAgent(ctx *Context, args *GetAgentAgentArgs, opts ...InvokeOption) (*GetAgentAgentResult, error)
func GetAgentAgentOutput(ctx *Context, args *GetAgentAgentOutputArgs, opts ...InvokeOption) GetAgentAgentResultOutput
> Note: This function is named GetAgentAgent
in the Go SDK.
public static class GetAgentAgent
{
public static Task<GetAgentAgentResult> InvokeAsync(GetAgentAgentArgs args, InvokeOptions? opts = null)
public static Output<GetAgentAgentResult> Invoke(GetAgentAgentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAgentAgentResult> getAgentAgent(GetAgentAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:GenerativeAi/getAgentAgent:getAgentAgent
arguments:
# arguments dictionary
The following arguments are supported:
getAgentAgent Result
The following output properties are available:
- Agent
Id string - Compartment
Id string - The OCID of the compartment.
- 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
- Description about the agent.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- 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 agent.
- Knowledge
Base List<string>Ids - List of OCID of the knowledgeBases associated with agent.
- Lifecycle
Details string - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- State string
- The current state of the agent.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Welcome
Message string - Details about purpose and responsibility of the agent
- Agent
Id string - Compartment
Id string - The OCID of the compartment.
- 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
- Description about the agent.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- 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 agent.
- Knowledge
Base []stringIds - List of OCID of the knowledgeBases associated with agent.
- Lifecycle
Details string - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- State string
- The current state of the agent.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- Welcome
Message string - Details about purpose and responsibility of the agent
- agent
Id String - compartment
Id String - The OCID of the compartment.
- 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
- Description about the agent.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- 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 agent.
- knowledge
Base List<String>Ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details String - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state String
- The current state of the agent.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome
Message String - Details about purpose and responsibility of the agent
- agent
Id string - compartment
Id string - The OCID of the compartment.
- {[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
- Description about the agent.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable.
- {[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 agent.
- knowledge
Base string[]Ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details string - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state string
- The current state of the agent.
- {[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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome
Message string - Details about purpose and responsibility of the agent
- agent_
id str - compartment_
id str - The OCID of the compartment.
- 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
- Description about the agent.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable.
- 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 agent.
- knowledge_
base_ Sequence[str]ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle_
details str - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state str
- The current state of the agent.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time_
updated str - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome_
message str - Details about purpose and responsibility of the agent
- agent
Id String - compartment
Id String - The OCID of the compartment.
- 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
- Description about the agent.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable.
- 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 agent.
- knowledge
Base List<String>Ids - List of OCID of the knowledgeBases associated with agent.
- lifecycle
Details String - A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- state String
- The current state of the agent.
- 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 agent was created, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time the agent was updated, in the format defined by RFC 3339. Example:
2016-08-25T21:10:29.600Z
- welcome
Message String - Details about purpose and responsibility of the agent
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.