Skip to main content

Update a knowledge base

PUT 
/bv/aisk/v1/knowledge-bases/:id

This API is used to update a knowledge base resource.

It'll return a 404/NotFound error if any requested resource is not found.

Request​

Path Parameters

    id stringrequired

    Required. The uuid of the knowledge base id.

Body

required
    name stringrequired

    Required. The name is to be updated in the knowledge base.

Responses​

A successful response.

Schema
    knowledge_base object
    id string

    Output only. The uuid of the knowledge base.

    name stringrequired

    Required. The name of the knowledge base.

    status string

    Possible values: [KNOWLEDGE_BASE_STATUS_PROCESSING, KNOWLEDGE_BASE_STATUS_READY, KNOWLEDGE_BASE_STATUS_FAILED, KNOWLEDGE_BASE_STATUS_DELETING]

    Output only. The status of the knowledge base.

    character_count int64

    Output only. The number of characters of this knowledge base used.

    created_at date-time

    Output only. The time that the knowledge base created.

    updated_at date-time

    Output only. The time that the knowledge base last updated.

    error_infos object[]

    Output only. A list of messages that carry the error infos when knowledge base is failed.

  • Array [
    • reason string

    The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

    domain string

    The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

    metadata object

    Additional structured details about this error.

    Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.

    property name* string
  • ]
Loading...