Get-DifyDocument
Warning
This help was primarily created by a generative AI. It may contain partially inaccurate expressions.
SYNOPSIS
Retrieve document information in knowledge.
SYNTAX
Get-DifyDocument [[-Knowledge] <PSObject>] [[-Id] <String>] [[-Name] <String>] [[-Search] <String>]
[<CommonParameters>]
DESCRIPTION
The Get-DifyDocument cmdlet retrieves document information associated with a specified knowledge. You can filter documents by ID, name, or search keyword. This cmdlet can return all documents for a given knowledge or specific documents based on the provided parameters.
NOTE: This help was primarily created by a generative AI. It may contain partially inaccurate expressions.
EXAMPLES
Example 1
Get-DifyKnowledge -Name "..." | Get-DifyDocument
Get all documents, specifying directly from Get-DifyKnowledge.
Example 2
$Knowledge = Get-DifyKnowledge -Name "..."
Get-DifyDocument -Knowledge $Knowledge
Get all documents using the result from Get-DifyKnowledge.
Example 3
Get-DifyKnowledge -Name "..." | Get-DifyDocument -Id "..."
Get documents by ID.
Example 4
Get-DifyKnowledge -Name "..." | Get-DifyDocument -Name "..."
Get documents by name (complete match).
Example 5
Get-DifyKnowledge -Name "..." | Get-DifyDocument -Search "..."
Get documents by name (partial match).
PARAMETERS
-Id
Specifies the ID of the document to retrieve. If this parameter is provided, only the document with the matching ID will be returned.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Knowledge
Specifies the knowledge from which to retrieve documents. This parameter supports pipeline input.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name
Specifies the name of the document to retrieve. Only documents with a name that exactly matches the specified value will be returned.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Search
Specifies a keyword to search for documents. Documents with names that contain the specified keyword will be returned.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.