NAiOS IconNAiOS Logo
Volver al catálogo

Ragie

ragie

Fully managed RAG-as-a-Service for developers

Acciones
31
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (31)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create DocumentRAGIE_CREATE_DOCUMENTAcción

Tool to upload and process a document file in Ragie. Use when you need to create a new document with support for various formats including text, images, and documents. The endpoint accepts multipart/form-data and returns a Document object with processing status and metadata.

Parámetros de entrada

  • fileobject

    The document file to upload. FileUploadable object where 'name' is the filename. Supported formats: Plain Text (.eml, .html, .json, .md, .msg, .rst, .rtf, .txt, .xml), Images (.png, .webp, .jpg, .jpeg, .tiff, .bmp, .heic), Documents (.csv, .doc, .docx, .epub, .odt, .pdf, .ppt, .pptx, .tsv, .xlsx, .xls). Note: PDFs exceeding 2000 pages are unsupported in hi_res mode. If not provided, use raw_content and raw_filename instead.

  • modeany

    Processing strategy for the document. For text documents: 'hi_res' (extracts images/tables) or 'fast' (extracts text only, default). For audio: true/false. For video: 'audio_only', 'video_only', or 'audio_video'. Can specify 'all' for maximum quality across all media types.

  • namestring

    Custom document name. Defaults to the file's name if omitted.

  • metadataobject

    Custom key-value pairs for document metadata. Keys must be strings. Values can be strings, numbers, booleans, or string arrays. Maximum 1000 total values allowed.

  • partitionstring

    Partition scope for the document. Must be lowercase alphanumeric with only '_' and '-' allowed.

  • rawContentany

    Inline file content to upload as text or bytes, used when FileUploadable is not available.

  • external_idstring

    Custom identifier for the document (e.g., external system ID or source URL).

  • rawFilenamestring

    Filename for inline content (e.g., 'document.txt'). Required when using raw_content.

  • rawMimetypestring

    MIME type for the inline content (e.g., 'text/plain', 'application/pdf'). Defaults to text/plain.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Document From URLRAGIE_CREATE_DOCUMENT_FROM_URLAcción

Tool to ingest a document from a publicly accessible URL. Use when you need to add documents to Ragie from external sources. The document undergoes processing steps (pending, partitioning, indexed, ready) before becoming available for retrieval.

Parámetros de entrada

  • urlstringObligatorio

    URL of the file to download. Must be publicly accessible and use HTTP or HTTPS scheme.

  • modeany

    Partition strategy (hi_res/fast for text, boolean for audio, audio_only/video_only/audio_video for video); defaults to fast

  • namestring

    Optional document name; defaults if omitted

  • metadataobject

    Document metadata with string/number/boolean/array values; max 1000 total values

  • partitionstring

    Optional partition identifier for scoping

  • external_idstring

    Optional external system identifier

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Document RawRAGIE_CREATE_DOCUMENT_RAWAcción

Tool to ingest a document as raw text or JSON. Use when creating a new document from text or JSON data. The document goes through processing steps and becomes available for retrieval once in the ready state.

Parámetros de entrada

  • dataanyObligatorio

    Document data in text or JSON format.

  • namestring

    An optional name for the document. If not set, defaults to the current timestamp.

  • metadataobject

    Document metadata with string keys and string/number/boolean/array values; maximum 1000 total values.

  • partitionstring

    Document scope identifier; must be lowercase alphanumeric with only '_' and '-' special characters.

  • external_idstring

    An optional identifier for the document. A common value might be an id in an external system or the URL.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create InstructionRAGIE_CREATE_INSTRUCTIONAcción

Tool to create a new instruction that applies natural language directives to documents as they're ingested or updated. Use when you need to define structured data extraction or analysis rules for documents in Ragie.

Parámetros de entrada

  • namestringObligatorio

    Unique identifier for the instruction

  • scopestringenum

    Scope of instruction: 'document' for full analysis, 'chunk' for granular search (default: 'chunk')

    documentchunk
  • activeboolean

    Whether instruction applies to new/updated documents (default: true)

  • filterobject

    Optional metadata filter matching document metadata before applying instruction

  • promptstringObligatorio

    Natural language instruction which will be applied to documents as they are created and updated

  • partitionstring

    Optional partition identifier to scope instruction to specific partition

  • entity_schemaobjectObligatorio

    JSON Schema defining the entity structure generated by the instruction

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create OAuth Redirect URLRAGIE_CREATE_OAUTH_REDIRECT_URLAcción

Tool to create an OAuth redirect URL for initializing embedded connector OAuth flows. Use when you need to set up OAuth authentication for connectors like Google Drive, Notion, or HubSpot.

Parámetros de entrada

  • modestring

    Processing strategy (hi_res/fast for text, true/false for audio, audio_only/video_only/audio_video for video).

  • themestring

    UI theme preference: 'light', 'dark', or 'system'; defaults to 'system'.

  • configobject

    Optional connector-specific configuration.

  • metadataobject

    Document metadata with string/number/boolean/array values; max 1000 total values.

  • partitionstring

    Optional partition identifier to scope the connection.

  • page_limitinteger

    Maximum pages to sync; connection disables when limit reached.

  • source_typestring

    Connector type (e.g., google_drive, notion, hubspot); defaults to 'google_drive'.

  • redirect_uristringObligatorio

    The URI where users return after OAuth authentication.

  • authenticator_idstring

    Optional authenticator ID for white-labeled credentials (UUID format).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create PartitionRAGIE_CREATE_PARTITION_PARTITIONS_POSTAcción

Tool to create a new partition for scoping documents and connections in Ragie. Use when you need to organize documents and set resource limits for different workspaces or tenants.

Parámetros de entrada

  • namestringObligatorio

    Identifier for the partition. This is a required field that uniquely identifies the partition.

  • descriptionstring

    Overview text describing the partition's purpose or usage

  • metadata_schemaobject

    Optional subset of document metadata defined as JSON Schema. Allows defining custom metadata structure for documents in this partition.

  • media_hosted_limit_maxinteger

    Maximum limit, in MBs, for media hosted

  • pages_hosted_limit_maxinteger

    Maximum limit, in pages, for hosted documents

  • media_streamed_limit_maxinteger

    Maximum limit, in MBs, for media streamed

  • audio_processed_limit_maxinteger

    Maximum limit, in minutes, for audio processing

  • pages_processed_limit_maxinteger

    Maximum limit, in pages, for processed documents

  • video_processed_limit_maxinteger

    Maximum limit, in minutes, for video processing

  • media_hosted_limit_monthlyinteger

    Monthly limit, in MBs, for media hosted

  • pages_hosted_limit_monthlyinteger

    Monthly limit of hosted pages added in the current month

  • media_streamed_limit_monthlyinteger

    Monthly limit, in MBs, for media streamed

  • audio_processed_limit_monthlyinteger

    Monthly limit, in minutes, for audio processing

  • pages_processed_limit_monthlyinteger

    Monthly limit, in pages, for processed documents

  • video_processed_limit_monthlyinteger

    Monthly limit, in minutes, for video processing

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete DocumentRAGIE_DELETE_DOCUMENTAcción

Tool to delete a document from Ragie. Use when you need to remove a document permanently from the system. Supports both synchronous and asynchronous deletion modes.

Parámetros de entrada

  • asyncboolean

    If true, performs document deletion asynchronously. Default is false for synchronous deletion.

  • partitionstring

    An optional partition to scope the request to.

  • document_idstringObligatorio

    The unique identifier (UUID) of the document to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete InstructionRAGIE_DELETE_INSTRUCTIONAcción

Tool to delete an instruction and all associated entities. Use when you need to permanently remove an instruction (irreversible operation). Requires the instruction ID (UUID format).

Parámetros de entrada

  • instruction_idstringObligatorio

    The unique identifier (UUID) of the instruction to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete PartitionRAGIE_DELETE_PARTITIONAcción

Tool to delete a partition and all associated data irreversibly. Use when you need to permanently remove a partition. Returns status 200 for synchronous deletion or 202 for asynchronous deletion.

Parámetros de entrada

  • partition_idstringObligatorio

    The partition identifier to delete

  • async_deletionboolean

    When true, performs partition deletion asynchronously. Defaults to false.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get DocumentRAGIE_GET_DOCUMENTAcción

Tool to retrieve a specific document by its unique identifier. Use when you need to get document details, metadata, processing status, or check for errors. Returns comprehensive document information including chunk count, page count, and any processing errors.

Parámetros de entrada

  • partitionstring

    Scopes the request to a specific partition. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition.

  • document_idstringObligatorio

    The unique identifier of the document in UUID format (e.g., 00000000-0000-0000-0000-000000000000).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document ChunkRAGIE_GET_DOCUMENT_CHUNKAcción

Tool to retrieve a specific document chunk by its document and chunk ID. Use when you need detailed information about a specific chunk within a document, including its content, metadata, position index, and optional modality data for audio/video chunks.

Parámetros de entrada

  • chunk_idstringObligatorio

    The ID of the chunk (UUID format).

  • partitionstring

    Optional partition to scope the request; if omitted, defaults to the default partition for newer accounts.

  • document_idstringObligatorio

    The ID of the document (UUID format).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document Chunk ContentRAGIE_GET_DOCUMENT_CHUNK_CONTENTAcción

Tool to retrieve document chunk content in requested format with streaming support for media. Use when you need to get the actual content of a specific chunk from a document.

Parámetros de entrada

  • chunk_idstringObligatorio

    The unique identifier of the chunk (UUID format).

  • downloadboolean

    Whether to return the content as a file download or a raw stream. Default is false.

  • partitionstring

    Optional partition identifier to scope the request for multi-tenant isolation.

  • media_typestringenum

    Desired output format as MIME type. If not specified, returns the content in its original format.

    text/plainaudio/mpegvideo/mp4image/webpimage/heicimage/bmpimage/pngimage/jpegimage/tiff
  • document_idstringObligatorio

    The unique identifier of the document (UUID format).

  • range_headerstring

    Standard HTTP range header for byte-range requests (partial content), e.g., 'bytes=0-1023'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document ChunksRAGIE_GET_DOCUMENT_CHUNKSAcción

Tool to retrieve document chunks with pagination support. Lists all document chunks sorted by index in ascending order (max 100 items per page). Documents created prior to 9/18/2024 that have not been updated since have chunks sorted by ID instead of index.

Parámetros de entrada

  • cursorstring

    An opaque cursor for pagination used to retrieve subsequent pages.

  • end_indexinteger

    The inclusive ending index of the chunk range to list. Omitting both start_index and end_index returns all chunks.

  • page_sizeinteger

    The number of items per page (range: 1-100, default: 10).

  • partitionstring

    Header parameter scoping results to a specific partition.

  • document_idstringObligatorio

    The UUID of the document to retrieve chunks from.

  • start_indexinteger

    The inclusive starting index of the chunk range to list. Omitting both start_index and end_index returns all chunks.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document ContentRAGIE_GET_DOCUMENT_CONTENTAcción

Tool to retrieve the content of a document by its ID. Use when you need to access the full content of a specific document. The media_type parameter can be used to request content in different formats.

Parámetros de entrada

  • rangestring

    HTTP range header for partial content requests.

  • downloadboolean

    Whether to return content as file download. Defaults to false.

  • partitionstring

    An optional partition to scope the request to.

  • media_typestring

    Format to return content in. Accepts: text/plain, audio/mpeg, video/mp4, image/webp, image/heic, image/bmp, image/png, image/jpeg, image/tiff, or application/json. Default returns content with text descriptions of non-textual media.

  • document_idstringObligatorio

    The UUID of the document to retrieve content for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document SummaryRAGIE_GET_DOCUMENT_SUMMARYAcción

Tool to retrieve an LLM-generated summary of a document by its ID. Use when you need to get a concise summary of a document's content.

Parámetros de entrada

  • partitionstring

    Optional partition scope. If omitted, accounts created after 1/9/2025 default to the default partition; older accounts scope to all partitions.

  • document_idstringObligatorio

    The unique identifier of the document (UUID format).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PartitionRAGIE_GET_PARTITIONAcción

Tool to retrieve a partition by ID with usage statistics and resource limits. Use when you need to get detailed information about a specific partition.

Parámetros de entrada

  • partition_idstringObligatorio

    The identifier for the partition being retrieved

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ResponseRAGIE_GET_RESPONSEAcción

Tool to retrieve a response by its unique identifier. Use when you need to check the status or details of a previously created response.

Parámetros de entrada

  • response_idstringObligatorio

    The unique identifier (UUID format) for the response to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ConnectionsRAGIE_LIST_CONNECTIONS_CONNECTIONS_GETAcción

Tool to list all connections sorted by creation date descending with pagination support. Use when you need to retrieve connections, optionally filtered by metadata.

Parámetros de entrada

  • cursorstring

    Pagination token for navigating to next page.

  • filterstring

    Metadata filter supporting operators ($eq, $ne, $gt, $gte, $lt, $lte, $in, $nin) with AND/OR logic.

  • page_sizeinteger

    Number of items per page, range 1-100, defaults to 10.

  • partitionstring

    Partition identifier to scope the request. Defaults to default partition if omitted.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Connection Source TypesRAGIE_LIST_CONNECTION_SOURCE_TYPESAcción

Tool to list available connection source types like 'google_drive' and 'notion' along with their metadata. Use when you need to discover what connector types are available in Ragie.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List DocumentsRAGIE_LIST_DOCUMENTSAcción

Tool to list all documents sorted by creation date (descending) with pagination support. Use when you need to browse or retrieve document metadata. Supports filtering and pagination up to 100 items per page.

Parámetros de entrada

  • cursorstring

    An opaque cursor for pagination. Use the next_cursor from previous response to get next page.

  • filterstring

    Filter expression for documents. Supports operators: $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin. Can combine with AND/OR logic.

  • page_sizeinteger

    The number of items per page. Must be between 1 and 100. Default is 10.

  • partitionstring

    Scopes request to specific partition. If not provided, default behavior varies by account creation date.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Entities By DocumentRAGIE_LIST_ENTITIES_BY_DOCUMENTAcción

Tool to retrieve all extracted entities from a specific document with pagination support. Use when you need to access structured data that has been extracted from a document by Ragie's entity extraction instructions.

Parámetros de entrada

  • cursorstring

    An opaque cursor for pagination. Use the next_cursor from a previous response to fetch the next page of results.

  • page_sizeinteger

    Number of items per page. Must be between 1 and 100. Defaults to 10 if not specified.

  • partitionstring

    An optional partition to scope the request to. If omitted, scoped to default partition.

  • document_idstringObligatorio

    The ID of the document from which to retrieve entities. Must be a valid UUID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Entities by InstructionRAGIE_LIST_ENTITIES_BY_INSTRUCTIONAcción

Tool to retrieve entities generated by a specific instruction. Use when you need to fetch entities extracted from documents based on a specific instruction's processing.

Parámetros de entrada

  • cursorstring

    An opaque cursor for pagination to fetch the next page of results.

  • page_sizeinteger

    The number of items per page. Must be between 1 and 100. Default is 10.

  • partitionstring

    An optional partition to scope the request to.

  • instruction_idstringObligatorio

    The ID of the instruction (UUID format).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List InstructionsRAGIE_LIST_INSTRUCTIONSAcción

Tool to retrieve all instruction records from the Ragie system. Use when you need to view all available instructions that define natural language prompts and entity schemas applied to documents.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List PartitionsRAGIE_LIST_PARTITIONSAcción

Tool to retrieve a paginated list of all partitions sorted by name in ascending order. Use when you need to list available partitions with their configurations and limits.

Parámetros de entrada

  • cursorstring

    An opaque cursor for pagination to retrieve the next page of results

  • page_sizeinteger

    The number of items per page (must be greater than 0 and less than or equal to 100). Defaults to 10.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Patch Document MetadataRAGIE_PATCH_DOCUMENT_METADATAAcción

Tool to update metadata for a specific document with partial update support. Use when you need to modify document metadata fields without replacing the entire metadata object. Supports both synchronous and asynchronous updates.

Parámetros de entrada

  • asyncboolean

    Whether to run the metadata update asynchronously. If true, the metadata update will be run in the background and the response will be 202 Accepted.

  • metadataobjectObligatorio

    The metadata to update on the document. Performs a partial update. Supports string, number, boolean, and string array values. Keys set to null are deleted. Maximum 1000 total values allowed.

  • partitionstring

    Optional partition scope. If omitted, accounts created after 1/9/2025 default to the default partition.

  • document_idstringObligatorio

    The unique identifier of the document (UUID format).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Document ChunksRAGIE_RETRIEVEAcción

Tool to retrieve relevant document chunks based on a query. Use when you need to search and retrieve document content that matches a specific query, with optional filtering and reranking capabilities.

Parámetros de entrada

  • querystringObligatorio

    The query to search with when retrieving document chunks.

  • top_kinteger

    The maximum number of chunks to return. Defaults to 8.

  • filterobject

    Metadata search filter supporting operators: $eq (equal), $ne (not equal), $gt (greater than), $gte (greater than or equal), $lt (less than), $lte (less than or equal), $in (in array), $nin (not in array). Example: {"department": {"$in": ["sales", "marketing"]}}.

  • rerankboolean

    Reranks the chunks for semantic relevancy post cosine similarity.

  • partitionstring

    The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition.

  • recency_biasboolean

    Enables recency bias which will favor more recent documents vs older documents.

  • max_chunks_per_documentinteger

    Maximum number of chunks to retrieve per document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Partition LimitsRAGIE_SET_PARTITION_LIMITSAcción

Tool to set usage limits on partition pages and media. Use when you need to configure monthly or maximum limits for pages processed/hosted, video/audio processing, or media streaming/hosting for a specific partition.

Parámetros de entrada

  • partition_idstringObligatorio

    The identifier for the partition being modified.

  • media_hosted_limit_maxinteger

    Maximum media hosting limit in megabytes.

  • pages_hosted_limit_maxinteger

    Absolute maximum for hosted document pages.

  • media_streamed_limit_maxinteger

    Maximum media streaming limit in megabytes.

  • audio_processed_limit_maxinteger

    Maximum audio processing limit in minutes.

  • pages_processed_limit_maxinteger

    Absolute maximum for processed document pages.

  • video_processed_limit_maxinteger

    Maximum video processing limit in minutes.

  • media_hosted_limit_monthlyinteger

    Monthly media hosting limit in megabytes.

  • pages_hosted_limit_monthlyinteger

    Monthly cap for newly added hosted pages.

  • media_streamed_limit_monthlyinteger

    Monthly media streaming limit in megabytes.

  • audio_processed_limit_monthlyinteger

    Monthly audio processing limit in minutes.

  • pages_processed_limit_monthlyinteger

    Monthly cap for processed document pages.

  • video_processed_limit_monthlyinteger

    Monthly video processing limit in minutes.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Document From URLRAGIE_UPDATE_DOCUMENT_FROM_URLAcción

Tool to update an existing document by fetching content from a publicly accessible URL. Use when you need to refresh or replace a document's content with data from a web URL. The document goes through processing steps before it is ready for retrieval.

Parámetros de entrada

  • urlstringObligatoriouri

    URL of the file to download. Must be publicly accessible and use HTTP or HTTPS scheme.

  • modeany

    Processing strategy for different file types. Can be 'hi_res', 'fast', or a media configuration object. Defaults to 'fast'.

  • partitionstring

    Scopes the request to a specific partition

  • document_idstringObligatorio

    The unique identifier (UUID) of the document to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Document RawRAGIE_UPDATE_DOCUMENT_RAWAcción

Tool to update a document's content from raw text or JSON data. Use when modifying existing document content. The document undergoes processing and becomes available for retrieval once it reaches the ready state.

Parámetros de entrada

  • dataanyObligatorio

    The document content in text or JSON format. Must be at least 1 character long.

  • document_idstringObligatorio

    UUID of the document to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update InstructionRAGIE_UPDATE_INSTRUCTIONAcción

Tool to update an instruction's active status. Use when you need to activate or deactivate an existing instruction.

Parámetros de entrada

  • activebooleanObligatorio

    Whether the instruction is active. Active instructions are applied to documents when they're created or when their file is updated

  • instruction_idstringObligatorio

    The UUID of the instruction to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update PartitionRAGIE_UPDATE_PARTITIONAcción

Tool to update a partition's configuration including description, context-aware settings, and metadata schema. Use when you need to modify an existing partition's settings.

Parámetros de entrada

  • descriptionstring

    A text description explaining the purpose or contents of the partition.

  • partition_idstringObligatorio

    The unique identifier of the partition to update

  • context_awareboolean

    Enable context-aware descriptions for the partition. When enabled, the partition will generate contextual descriptions for content.

  • metadata_schemaobject

    A JSON Schema subset defining the metadata fields for documents in this partition. Providing detailed descriptions of fields helps LLMs generate filters dynamically.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not