Skip to main content

Ingest data into a source

POST 

/bv/aisk/v1/sources/:id:ingest

This API is used to ingest data into a source.


It'll return a 400/BadRequest error if the following conditions meet:

  • if invoked this API that the source not in SOURCE_STATUS_INGESTING status and will return an ERROR_REASON_SOURCE_REQUIRES_IN_INGESTING_STATUS error reason.

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

Request

Path Parameters

    id stringrequired

    Required. The uuid of the source to be ingested data.

Body

required
    website object

    Optional. Required if source type is SOURCE_TYPE_WEBSITE.

    urls string[]required

    Required. The list of URLs used to scrape the content as a website source.

    file object

    Optional. Required if source type is SOURCE_TYPE_LOCAL_DRIVE.

    id stringrequired

    Required. The uuid of the file that will be obtained from the response via CMS - Upload a file API. Only support FILE_TYPE_DOCUMENT type currently.

    vod object

    Optional. Required if source type is SOURCE_TYPE_VOD.

    id string

    Required. The uuid of the vod which owns the subtitles will be used as a citation result. It can be obtained from the response via CMS - List VODs API.

    subtitle_ids string[]

    Required. The list of the uuid of the subtitles that will be created as the source.

    video object

    Optional. Required if source type is SOURCE_TYPE_VIDEO.

    id string

    Required. The uuid of the video which owns the subtitles will be used as a citation result. It can be obtained from the response via CMS - List Files API.

    subtitle_ids string[]

    Required. The list of the uuid of the subtitles that will be created as the source.

    text object

    Optional. Required if source type is SOURCE_TYPE_TEXT.

    content Required. The content of raw text (string)

Responses

A successful response.

Schema
    source object
    id string

    Output only. The uuid of the source.

    type stringrequired

    Possible values: [SOURCE_TYPE_WEBSITE, SOURCE_TYPE_LOCAL_DRIVE, SOURCE_TYPE_VOD, SOURCE_TYPE_VIDEO, SOURCE_TYPE_SUBTITLE, SOURCE_TYPE_TEXT]

    Required. Immutable. The type of the source.

    name stringrequired

    Required. The name of the source.

    status string

    Possible values: [SOURCE_STATUS_INGESTING, SOURCE_STATUS_PREPARING, SOURCE_STATUS_READY, SOURCE_STATUS_UPDATING, SOURCE_STATUS_FAILED, SOURCE_STATUS_DELETING]

    Output only. The status of the source.

    format string

    Possible values: [SOURCE_FORMAT_WEBSITE, SOURCE_FORMAT_PDF, SOURCE_FORMAT_DOC, SOURCE_FORMAT_DOCX, SOURCE_FORMAT_VOD_TO_TEXT, SOURCE_FORMAT_VIDEO_TO_TEXT, SOURCE_FORMAT_SRT, SOURCE_FORMAT_VTT, SOURCE_FORMAT_TEXT]

    Output only.

    size_in_bytes int64

    Output only. The size of the source in bytes.

    file object

    Output only. It'll be available if type is SOURCE_TYPE_LOCAL_DRIVE or SOURCE_TYPE_SUBTITLE.

    id string

    Output only. The uuid of the file.

    type string

    Possible values: [FILE_TYPE_VIDEO, FILE_TYPE_IMAGE, FILE_TYPE_SUBTITLE, FILE_TYPE_DOCUMENT, FILE_TYPE_WEB_LINK, FILE_TYPE_AUDIO]

    Output only. The type of the file.

    name string

    Output only. The name of the file.

    size_in_bytes int64

    Output only. The size of the file in bytes.

    vod object

    Output only. It'll be available if type is SOURCE_TYPE_VOD.

    id string

    Output only. The uuid of the vod.

    video object

    Output only. It'll be available if type is SOURCE_TYPE_VIDEO.

    id string

    Output only. The uuid of the video.

    text object

    Output only. It'll be available if type is SOURCE_TYPE_TEXT.

    content Output only. The content of text (string)
    metadata object

    Optional. The metadata of the source.

    keyword_1 object
    data object[]
  • Array [
  • value string
  • ]
  • keyword_2 object
    data object[]
  • Array [
  • value string
  • ]
  • keyword_3 object
    data object[]
  • Array [
  • value string
  • ]
  • integer_range_1 object
    data object[]
  • Array [
  • gte int64
    lte int64
  • ]
  • integer_range_2 object
    data object[]
  • Array [
  • gte int64
    lte int64
  • ]
  • integer_range_3 object
    data object[]
  • Array [
  • gte int64
    lte int64
  • ]
  • boolean_1 object
    data object
    value boolean
    boolean_2 object
    data object
    value boolean
    boolean_3 object
    data object
    value boolean
    text_1 object
    data object
    value string
    text_2 object
    data object
    value string
    text_3 object
    data object
    value string
    next_update_time date-time

    Output only. The time that the source will be updated in the next period.

    character_count int64

    Output only. The number of characters of this source used.

    created_at date-time

    Output only. The time that the source created.

    updated_at date-time

    Output only. The time that the source last updated.

    error_infos object[]

    Output only. A list of messages that carry the error infos when source 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...