Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2beta1
  6. getDocument

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v2beta1.getDocument

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Retrieves the specified document. Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

    Using getDocument

    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 getDocument(args: GetDocumentArgs, opts?: InvokeOptions): Promise<GetDocumentResult>
function getDocumentOutput(args: GetDocumentOutputArgs, opts?: InvokeOptions): Output<GetDocumentResult>
    def get_document(document_id: Optional[str] = None,
                 knowledge_base_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDocumentResult
def get_document_output(document_id: Optional[pulumi.Input[str]] = None,
                 knowledge_base_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDocumentResult]
    func LookupDocument(ctx *Context, args *LookupDocumentArgs, opts ...InvokeOption) (*LookupDocumentResult, error)
func LookupDocumentOutput(ctx *Context, args *LookupDocumentOutputArgs, opts ...InvokeOption) LookupDocumentResultOutput

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

    public static class GetDocument 
{
    public static Task<GetDocumentResult> InvokeAsync(GetDocumentArgs args, InvokeOptions? opts = null)
    public static Output<GetDocumentResult> Invoke(GetDocumentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDocumentResult> getDocument(GetDocumentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:dialogflow/v2beta1:getDocument
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DocumentId string
    KnowledgeBaseId string
    Location string
    Project string
    DocumentId string
    KnowledgeBaseId string
    Location string
    Project string
    documentId String
    knowledgeBaseId String
    location String
    project String
    documentId string
    knowledgeBaseId string
    location string
    project string
    documentId String
    knowledgeBaseId String
    location String
    project String

    getDocument Result

    The following output properties are available:

    Content string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
    ContentUri string
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    DisplayName string
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    EnableAutoReload bool
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    KnowledgeTypes List<string>
    The knowledge type of document content.
    LatestReloadStatus Pulumi.GoogleNative.Dialogflow.V2Beta1.Outputs.GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    Metadata Dictionary<string, string>
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    MimeType string
    The MIME type of this document.
    Name string
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    RawContent string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    State string
    The current state of the document.
    Content string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
    ContentUri string
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    DisplayName string
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    EnableAutoReload bool
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    KnowledgeTypes []string
    The knowledge type of document content.
    LatestReloadStatus GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    Metadata map[string]string
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    MimeType string
    The MIME type of this document.
    Name string
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    RawContent string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    State string
    The current state of the document.
    content String
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
    contentUri String
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    displayName String
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    enableAutoReload Boolean
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    knowledgeTypes List<String>
    The knowledge type of document content.
    latestReloadStatus GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    metadata Map<String,String>
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    mimeType String
    The MIME type of this document.
    name String
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    rawContent String
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    state String
    The current state of the document.
    content string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
    contentUri string
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    displayName string
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    enableAutoReload boolean
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    knowledgeTypes string[]
    The knowledge type of document content.
    latestReloadStatus GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    metadata {[key: string]: string}
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    mimeType string
    The MIME type of this document.
    name string
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    rawContent string
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    state string
    The current state of the document.
    content str
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
    content_uri str
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    display_name str
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    enable_auto_reload bool
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    knowledge_types Sequence[str]
    The knowledge type of document content.
    latest_reload_status GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    metadata Mapping[str, str]
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    mime_type str
    The MIME type of this document.
    name str
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    raw_content str
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    state str
    The current state of the document.
    content String
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
    contentUri String
    The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the gs:// format URI described above.
    displayName String
    The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
    enableAutoReload Boolean
    Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see source field for the source types. Reload status can be tracked in latest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.
    knowledgeTypes List<String>
    The knowledge type of document content.
    latestReloadStatus Property Map
    The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
    metadata Map<String>
    Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a key or a value of the metadata is 1024 bytes.
    mimeType String
    The MIME type of this document.
    name String
    Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
    rawContent String
    The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
    state String
    The current state of the document.

    Supporting Types

    GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse

    Status Pulumi.GoogleNative.Dialogflow.V2Beta1.Inputs.GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    Time string
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    Status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    Time string
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    time String
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    time string
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status GoogleRpcStatusResponse
    The status of a reload attempt or the initial load.
    time str
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.
    status Property Map
    The status of a reload attempt or the initial load.
    time String
    The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.

    GoogleRpcStatusResponse

    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details List<ImmutableDictionary<string, string>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details []map[string]string
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Integer
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String,String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code number
    The status code, which should be an enum value of google.rpc.Code.
    details {[key: string]: string}[]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code int
    The status code, which should be an enum value of google.rpc.Code.
    details Sequence[Mapping[str, str]]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message str
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Number
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native