Get-DifyDocumentIndexingStatus
Warning
This help was primarily created by a generative AI. It may contain partially inaccurate expressions.
SYNOPSIS
Retrieve document indexing status.
SYNTAX
Get-DifyDocumentIndexingStatus [[-Document] <PSObject>] [[-Knowledge] <PSObject>] [[-Batch] <String>] [-Wait]
[[-Interval] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the indexing status of documents within a specified batch. It can also wait for the indexing process to complete based on the -Wait parameter. By default, the cmdlet checks and retrieves the indexing status without waiting.
NOTE: This help was primarily created by a generative AI. It may contain partially inaccurate expressions.
EXAMPLES
Example 1
Add-DifyDocument -Knowledge $Knowledge -Path "Docs/*.md" | Get-DifyDocumentIndexingStatus
Get indexing status (specify directly from Add-DifyDocument).
Example 2
$DocumentToCheckIndexingStatus = Add-DifyDocument -Knowledge $Knowledge -Path "Docs/*.md"
Get-DifyDocumentIndexingStatus -Document $DocumentToCheckIndexingStatus
Get indexing status (specify from Add-DifyDocument result).
Example 3
Get-DifyDocumentIndexingStatus -Knowledge $Knowledge -Batch "..."
Get indexing status (specify knowledge and batch ID).
Example 4
Get-DifyDocumentIndexingStatus -Knowledge $Knowledge -Batch "..." -Wait
Get indexing status (wait for completion).
Example 5
Get-DifyDocumentIndexingStatus -Knowledge $Knowledge -Batch "..." -Wait -Interval 10 -Timeout 600
Get indexing status (change waiting time).
PARAMETERS
-Batch
Specifies the batch ID for which to retrieve the indexing status. This is required if no documents are provided.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Document
Specifies the document object(s) to retrieve the indexing status for. If provided, the knowledge and batch are inferred from the document metadata.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Interval
Specifies the interval, in seconds, at which the cmdlet checks the indexing status when the -Wait parameter is used.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 5
Accept pipeline input: False
Accept wildcard characters: False
-Knowledge
Specifies the knowledge object for which to retrieve the indexing status. This is required if no documents are provided.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Timeout
Specifies the timeout duration, in seconds, for the wait operation when the -Wait parameter is used.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 300
Accept pipeline input: False
Accept wildcard characters: False
-Wait
Indicates that the cmdlet should wait for the indexing process to complete before returning.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.