Discovery Engine API . projects . locations . notebooks . sources

batchCreate(parent, body=None, x__xgafv=None)

Creates a list of Sources.

Args:
  parent: string, Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for SourceService.BatchCreateSources method.
  "userContents": [ # Required. The UserContents to be uploaded.
    { # The "Content" messages refer to data the user wants to upload.
      "agentspaceContent": { # Agentspace content uploaded as source. # Agentspace content uploaded as source.
        "documentName": "A String", # Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
        "engineName": "A String", # Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.
        "ideaforgeIdeaName": "A String", # Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}`
      },
      "googleDriveContent": { # The content from Google Drive. # The content from Google Drive.
        "documentId": "A String", # The document id of the selected document.
        "mimeType": "A String", # The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.
        "sourceName": "A String", # The name to be displayed for the source.
      },
      "textContent": { # The text content uploaded as source. # The text content uploaded as source.
        "content": "A String", # The name to be displayed for the source.
        "sourceName": "A String", # The display name of the text source.
      },
      "videoContent": { # Video content uploaded as source. # The video content uploaded as source.
        "youtubeUrl": "A String", # The youtube url of the video content.
      },
      "webContent": { # The web content uploaded as source. # The web content uploaded as source.
        "sourceName": "A String", # The name to be displayed for the source.
        "url": "A String", # If URL is supplied, will fetch the webpage in the backend.
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for SourceService.BatchCreateSources method.
  "sources": [ # The Sources.
    { # Source represents a single source of content.
      "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
        "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
          "documentName": "A String", # Output only. The full document name in Agentspace.
          "documentTitle": "A String", # Output only. The title of the document.
        },
        "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
          "documentId": "A String", # Output only. The document id of the google doc.
          "revisionId": "A String", # Output only. Revision id for the doc.
        },
        "sourceAddedTimestamp": "A String", # The timestamp the source was added.
        "tokenCount": 42, # The number of tokens in the source.
        "wordCount": 42, # The word count of the source.
        "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
          "channelName": "A String", # Output only. The channel name of the youtube video.
          "videoId": "A String", # Output only. The id of the youtube video.
        },
      },
      "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
        "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
          "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
            "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
            },
            "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
            },
          },
          "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
          },
          "googleDriveError": { # A google drive specific error. # A google drive specific error.
            "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
            },
          },
          "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
          },
          "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
          },
          "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
          },
          "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
          },
          "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
            "wordCount": 42, # The number of words in the source.
            "wordLimit": 42, # The word count limit for the current user at the time of the upload.
          },
          "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
            "errorDetails": "A String", # Describes why the source is unreachable.
          },
          "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
          },
          "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
          },
          "youtubeError": { # A youtube specific error. # A youtube specific error.
            "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
            },
          },
        },
        "status": "A String", # Status of the source.
      },
      "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
        "id": "A String", # The id of the source.
      },
      "title": "A String", # Optional. Title of the source.
    },
  ],
}

batchDelete(parent, body=None, x__xgafv=None)

Deletes multiple sources

Args:
  parent: string, Required. The parent resource where the sources will be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for SourceService.BatchDeleteSourcesRequest method.
  "names": [ # Required. Names of sources to be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a Source.

Args:
  name: string, Required. The resource name for source Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Source represents a single source of content.
  "metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
    "agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
      "documentName": "A String", # Output only. The full document name in Agentspace.
      "documentTitle": "A String", # Output only. The title of the document.
    },
    "googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
      "documentId": "A String", # Output only. The document id of the google doc.
      "revisionId": "A String", # Output only. Revision id for the doc.
    },
    "sourceAddedTimestamp": "A String", # The timestamp the source was added.
    "tokenCount": 42, # The number of tokens in the source.
    "wordCount": 42, # The word count of the source.
    "youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
      "channelName": "A String", # Output only. The channel name of the youtube video.
      "videoId": "A String", # Output only. The id of the youtube video.
    },
  },
  "name": "A String", # Identifier. The full resource name of the source. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
  "settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
    "failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
      "audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
        "languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
        },
        "noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
        },
      },
      "domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
      },
      "googleDriveError": { # A google drive specific error. # A google drive specific error.
        "downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
        },
      },
      "ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
      },
      "paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
      },
      "sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
      },
      "sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
      },
      "sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
        "wordCount": 42, # The number of words in the source.
        "wordLimit": 42, # The word count limit for the current user at the time of the upload.
      },
      "sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
        "errorDetails": "A String", # Describes why the source is unreachable.
      },
      "unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
      },
      "uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
      },
      "youtubeError": { # A youtube specific error. # A youtube specific error.
        "videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
        },
      },
    },
    "status": "A String", # Status of the source.
  },
  "sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
    "id": "A String", # The id of the source.
  },
  "title": "A String", # Optional. Title of the source.
}