Sync Item.

client.AISearch.Namespaces.Instances.Items.Sync(ctx, name, id, itemID, params) (*NamespaceInstanceItemSyncResponse, error)

PATCH/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Syncs an item to an AI Search instance index.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

name string

id string

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64

minLength1

itemID string

params NamespaceInstanceItemSyncParams

AccountID param.Field[string]

Path param

NextAction param.Field[NamespaceInstanceItemSyncParamsNextAction]

Body param

const NamespaceInstanceItemSyncParamsNextActionIndex NamespaceInstanceItemSyncParamsNextAction = "INDEX"

WaitForCompletion param.Field[bool]Optional

Body param: Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in running state and the background alarm continues polling. Defaults to false.

ReturnsExpand Collapse

type NamespaceInstanceItemSyncResponse struct{…}

ID string

Checksum string

ChunksCount int64

CreatedAt Time

formatdate-time

FileSize float64

Key string

LastSeenAt Time

formatdate-time

Namespace string

NextAction NamespaceInstanceItemSyncResponseNextAction

One of the following:

const NamespaceInstanceItemSyncResponseNextActionIndex NamespaceInstanceItemSyncResponseNextAction = "INDEX"

const NamespaceInstanceItemSyncResponseNextActionDelete NamespaceInstanceItemSyncResponseNextAction = "DELETE"

SourceID string

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

Status NamespaceInstanceItemSyncResponseStatus

One of the following:

const NamespaceInstanceItemSyncResponseStatusQueued NamespaceInstanceItemSyncResponseStatus = "queued"

const NamespaceInstanceItemSyncResponseStatusRunning NamespaceInstanceItemSyncResponseStatus = "running"

const NamespaceInstanceItemSyncResponseStatusCompleted NamespaceInstanceItemSyncResponseStatus = "completed"

const NamespaceInstanceItemSyncResponseStatusError NamespaceInstanceItemSyncResponseStatus = "error"

const NamespaceInstanceItemSyncResponseStatusSkipped NamespaceInstanceItemSyncResponseStatus = "skipped"

const NamespaceInstanceItemSyncResponseStatusOutdated NamespaceInstanceItemSyncResponseStatus = "outdated"

Error stringOptional

Sync Item.

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/ai_search"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.AISearch.Namespaces.Instances.Items.Sync(
    context.TODO(),
    "my-namespace",
    "my-ai-search",
    "item_id",
    ai_search.NamespaceInstanceItemSyncParams{
      AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
      NextAction: cloudflare.F(ai_search.NamespaceInstanceItemSyncParamsNextActionIndex),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}

{
  "result": {
    "id": "id",
    "checksum": "checksum",
    "chunks_count": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "key": "key",
    "last_seen_at": "2019-12-27T18:11:19.117Z",
    "namespace": "namespace",
    "next_action": "INDEX",
    "source_id": "source_id",
    "status": "queued",
    "error": "error"
  },
  "success": true
}

Returns Examples

{
  "result": {
    "id": "id",
    "checksum": "checksum",
    "chunks_count": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "key": "key",
    "last_seen_at": "2019-12-27T18:11:19.117Z",
    "namespace": "namespace",
    "next_action": "INDEX",
    "source_id": "source_id",
    "status": "queued",
    "error": "error"
  },
  "success": true
}