Sign in

Create, update, or delete documents.

post/v2/namespaces/{namespace}

Path parameters

namespacestring required

The name of the namespace.

Request body

{"stackTrail":"components:schemas:Write:properties:upsert_condition","oasType":"schema","type":"unknown","description":"A condition evaluated against the current value of each document targeted by an upsert write. Only documents that pass the condition are upserted.\n","extensionFields":{"x-stainless-any":true}}
{"stackTrail":"components:schemas:Write:properties:patch_condition","oasType":"schema","type":"unknown","description":"A condition evaluated against the current value of each document targeted by a patch write. Only documents that pass the condition are patched.\n","extensionFields":{"x-stainless-any":true}}
{"stackTrail":"components:schemas:Write:properties:delete_condition","oasType":"schema","type":"unknown","description":"A condition evaluated against the current value of each document targeted by a delete write. Only documents that pass the condition are deleted.\n","extensionFields":{"x-stainless-any":true}}
schemaobject

The schema of the attributes attached to the documents.

{"stackTrail":"components:schemas:Write:properties:delete_by_filter","oasType":"schema","type":"unknown","description":"The filter specifying which documents to delete.","extensionFields":{"x-stainless-any":true}}
delete_by_filter_allow_partialboolean

Allow partial completion when filter matches too many documents.

patch_by_filter_allow_partialboolean

Allow partial completion when filter matches too many documents.

return_affected_idsboolean

If true, return the IDs of affected rows (deleted, patched, upserted) in the response. For filtered and conditional writes, only IDs for writes that succeeded will be included.

disable_backpressureboolean

Disables write throttling (HTTP 429 responses) during high-volume ingestion.

Response

The status of the request.

status'OK' required

The status of the request.

messagestring required

A message describing the result of the write request.

rows_affectedinteger required

The number of rows affected by the write request.

rows_upsertedinteger

The number of rows upserted by the write request.

rows_patchedinteger

The number of rows patched by the write request.

rows_deletedinteger

The number of rows deleted by the write request.

rows_remainingboolean

Whether more documents match the filter for partial operations.

Changes

Changed in 12 of the 38 revisions of this API.2115

  • 42ae8d460fab1See the full diff
    • ○

      added the new optional request property schema/additionalProperties/anyOf[AttributeSchemaConfig]/ann/oneOf[AnnConfig]/late_interaction

      new-optional-request-property

  • b0cd7719ec631See the full diff
    • ○

      added the new optional request property sharding

      new-optional-request-property

  • 7973861a67c51See the full diff
    • ○

      added subschema #6 to the schema/additionalProperties/anyOf[AttributeSchemaConfig]/full_text_search/oneOf[FullTextSearchConfig]/tokenizer request property oneOf list

      request-property-one-of-added

  • a3a2adf34b951See the full diff
    • ○

      added the new optional request property schema/additionalProperties/anyOf[AttributeSchemaConfig]/embed

      new-optional-request-property

  • bda2b9d53b4e111See the full diff
    • ▲

      the encryption request property type/format changed from object/ to /

      request-property-type-changed

    • ●

      removed the request property encryption/cmek

      request-property-removed

    • ○

      added subschema #1: customer-managed subschema #2: default to the encryption request property oneOf list

      request-property-one-of-added

  • ffde0a5977cc1See the full diff
    • ○

      added the new optional request property schema/additionalProperties/anyOf[AttributeSchemaConfig]/sparse_knn

      new-optional-request-property

  • e6fc43e735f21See the full diff
    • ○

      added the new optional request property schema/additionalProperties/anyOf[AttributeSchemaConfig]/fuzzy

      new-optional-request-property

  • bedeb359e1001See the full diff
    • ○

      added the new optional request property schema/additionalProperties/anyOf[AttributeSchemaConfig]/glob

      new-optional-request-property

  • d299c006e7d911See the full diff
    • ▲

      the branch_from_namespace request property type/format changed from string/ to /

      request-property-type-changed

    • ○

      added subschema #1 subschema #2: branch-from-namespace-config to the branch_from_namespace request property oneOf list

      request-property-one-of-added

  • c4ce4610b91b1See the full diff
    • ○

      added the new optional request property branch_from_namespace

      new-optional-request-property