Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getIntent

Retrieves the specified intent.

Using getIntent

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 getIntent(args: GetIntentArgs, opts?: InvokeOptions): Promise<GetIntentResult>
function getIntentOutput(args: GetIntentOutputArgs, opts?: InvokeOptions): Output<GetIntentResult>
def get_intent(agent_id: Optional[str] = None,
               intent_id: Optional[str] = None,
               language_code: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetIntentResult
def get_intent_output(agent_id: Optional[pulumi.Input[str]] = None,
               intent_id: Optional[pulumi.Input[str]] = None,
               language_code: Optional[pulumi.Input[str]] = None,
               location: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetIntentResult]
func LookupIntent(ctx *Context, args *LookupIntentArgs, opts ...InvokeOption) (*LookupIntentResult, error)
func LookupIntentOutput(ctx *Context, args *LookupIntentOutputArgs, opts ...InvokeOption) LookupIntentResultOutput

> Note: This function is named LookupIntent in the Go SDK.

public static class GetIntent 
{
    public static Task<GetIntentResult> InvokeAsync(GetIntentArgs args, InvokeOptions? opts = null)
    public static Output<GetIntentResult> Invoke(GetIntentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIntentResult> getIntent(GetIntentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:dialogflow/v3:getIntent
  arguments:
    # arguments dictionary

The following arguments are supported:

AgentId string
IntentId string
Location string
LanguageCode string
Project string
AgentId string
IntentId string
Location string
LanguageCode string
Project string
agentId String
intentId String
location String
languageCode String
project String
agentId string
intentId string
location string
languageCode string
project string
agentId String
intentId String
location String
languageCode String
project String

getIntent Result

The following output properties are available:

Description string

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

DisplayName string

The human-readable name of the intent, unique within the agent.

IsFallback bool

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

Labels Dictionary<string, string>

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

Name string

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

Parameters List<Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3IntentParameterResponse>

The collection of parameters associated with the intent.

Priority int

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

TrainingPhrases List<Pulumi.GoogleNative.Dialogflow.V3.Outputs.GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse>

The collection of training phrases the agent is trained on to identify the intent.

Description string

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

DisplayName string

The human-readable name of the intent, unique within the agent.

IsFallback bool

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

Labels map[string]string

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

Name string

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

Parameters []GoogleCloudDialogflowCxV3IntentParameterResponse

The collection of parameters associated with the intent.

Priority int

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

TrainingPhrases []GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse

The collection of training phrases the agent is trained on to identify the intent.

description String

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

displayName String

The human-readable name of the intent, unique within the agent.

isFallback Boolean

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

labels Map<String,String>

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

name String

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

parameters List<GoogleCloudDialogflowCxV3IntentParameterResponse>

The collection of parameters associated with the intent.

priority Integer

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

trainingPhrases List<GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse>

The collection of training phrases the agent is trained on to identify the intent.

description string

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

displayName string

The human-readable name of the intent, unique within the agent.

isFallback boolean

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

labels {[key: string]: string}

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

name string

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

parameters GoogleCloudDialogflowCxV3IntentParameterResponse[]

The collection of parameters associated with the intent.

priority number

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

trainingPhrases GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse[]

The collection of training phrases the agent is trained on to identify the intent.

description str

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

display_name str

The human-readable name of the intent, unique within the agent.

is_fallback bool

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

labels Mapping[str, str]

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

name str

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

parameters Sequence[GoogleCloudDialogflowCxV3IntentParameterResponse]

The collection of parameters associated with the intent.

priority int

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

training_phrases Sequence[GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse]

The collection of training phrases the agent is trained on to identify the intent.

description String

Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

displayName String

The human-readable name of the intent, unique within the agent.

isFallback Boolean

Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.

labels Map<String>

The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent.

name String

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

parameters List<Property Map>

The collection of parameters associated with the intent.

priority Number

The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.

trainingPhrases List<Property Map>

The collection of training phrases the agent is trained on to identify the intent.

Supporting Types

GoogleCloudDialogflowCxV3IntentParameterResponse

EntityType string

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

IsList bool

Indicates whether the parameter represents a list of values.

Redact bool

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

EntityType string

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

IsList bool

Indicates whether the parameter represents a list of values.

Redact bool

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

entityType String

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

isList Boolean

Indicates whether the parameter represents a list of values.

redact Boolean

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

entityType string

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

isList boolean

Indicates whether the parameter represents a list of values.

redact boolean

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

entity_type str

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

is_list bool

Indicates whether the parameter represents a list of values.

redact bool

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

entityType String

The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.

isList Boolean

Indicates whether the parameter represents a list of values.

redact Boolean

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.

GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse

ParameterId string

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

Text string

The text for this part.

ParameterId string

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

Text string

The text for this part.

parameterId String

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

text String

The text for this part.

parameterId string

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

text string

The text for this part.

parameter_id str

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

text str

The text for this part.

parameterId String

The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.

text String

The text for this part.

GoogleCloudDialogflowCxV3IntentTrainingPhraseResponse

Parts List<Pulumi.GoogleNative.Dialogflow.V3.Inputs.GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse>

The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

RepeatCount int

Indicates how many times this example was added to the intent.

Parts []GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse

The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

RepeatCount int

Indicates how many times this example was added to the intent.

parts List<GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse>

The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

repeatCount Integer

Indicates how many times this example was added to the intent.

parts GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse[]

The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

repeatCount number

Indicates how many times this example was added to the intent.

parts Sequence[GoogleCloudDialogflowCxV3IntentTrainingPhrasePartResponse]

The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

repeat_count int

Indicates how many times this example was added to the intent.

parts List<Property Map>

The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - Part.text is set to a part of the phrase that has no parameters. - Part.text is set to a part of the phrase that you want to annotate, and the parameter_id field is set.

repeatCount Number

Indicates how many times this example was added to the intent.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0