Skip to content

Commit

Permalink
review feedback - tweak doc comments, link to specific code bits
Browse files Browse the repository at this point in the history
  • Loading branch information
austin-denoble committed Oct 16, 2024
1 parent 7b53f93 commit 616675e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions pinecone/index_connection.go
Original file line number Diff line number Diff line change
Expand Up @@ -1012,8 +1012,8 @@ type StartImportResponse struct {
}

// StartImport imports data from a storage provider into an index. The uri parameter must start with the
// schema of a supported storage provider. For buckets that are not publicly readable, you will also need to
// separately configure a storage integration and pass the integration id.
// schema of a supported storage provider (e.g. "s3://"). For buckets that are not publicly readable, you will also need to
// separately configure a [storage integration] and pass the integration id.
//
// Returns a pointer to a StartImportResponse object with the import ID or an error if the request fails.
//
Expand Down Expand Up @@ -1057,6 +1057,8 @@ type StartImportResponse struct {
// log.Fatalf("Failed to start import: %v", err)
// }
// fmt.Printf("import starteed with ID: %s", importRes.Id)
//
// [storage integration]: https://docs.pinecone.io/guides/operations/integrations/manage-storage-integrations
func (idx *IndexConnection) StartImport(ctx context.Context, uri string, integrationId *string, errorMode *ImportErrorMode) (*StartImportResponse, error) {
if uri == "" {
return nil, fmt.Errorf("must specify a uri to start an import")
Expand Down Expand Up @@ -1093,8 +1095,8 @@ func (idx *IndexConnection) StartImport(ctx context.Context, uri string, integra
// Parameters:
// - ctx: A context.Context object controls the request's lifetime,
// allowing for the request to be canceled or to timeout according to the context's deadline.
// - id: The id of the import operation. This is returned when you call StartImport, or can be retrieved
// through the ListImports method.
// - id: The id of the import operation. This is returned when you call [IndexConnection.StartImport], or can be retrieved
// through the [IndexConnection.ListImports] method.
//
// Example:
//
Expand Down

0 comments on commit 616675e

Please sign in to comment.