Corpora

Yöntem: corpora.create

Boş bir Corpus oluşturur.

Uç nokta

yayınlayacağım https://generativelanguage.googleapis.com/v1beta/corpora

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynak adı. Kimlik ("corpora/" ön eki hariç ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili dokümanlar"

Yanıt gövdesi

Başarılı olursa yanıt metni, yeni oluşturulmuş bir Corpus örneği içerir.

Yöntem: corpora.query

Corpus üzerinde anlamsal arama yapar.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Yol parametreleri

name string

Zorunlu. Sorgulanacak Corpus öğesinin adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

Alanlar
query string

Zorunlu. Anlamsal arama gerçekleştirmek için sorgu dizesi.

metadataFilters[] object (MetadataFilter)

İsteğe bağlı. Chunk ve Document meta verileri için filtre uygulayın. Her MetadataFilter nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter nesne, mantıksal "AND" ifadeleriyle birleştirilir.

Belge düzeyinde örnek sorgu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = &quot;document.custom_metadata.year&quot; koşullar = [{int_value = 2020, işlem = GREATER_EQUAL}, {int_value = 2010, işlem = LESS}]}, {anahtar = "document.custom_metadata.year" koşullar = [{int_value = 2020, işlem = GREATER_EQUAL}, {int_value = 2010, işlem = LESS}]}, {anahtar = "document.custom_metadata.TYPE" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]}]

Sayısal bir değer aralığı için parça düzeyinde örnek sorgu: (yıl > 2015 VE yıl <= 2020)

MetadataFilter object list: metadataFilters = [ {key = &quot;chunk.custom_metadata.year&quot; koşullar = [{int_value = 2015, işlem = BÜYÜK HARF}]}, {anahtar = "chunk.custom_metadata.year" koşullar = [{int_value = 2020, işlem = LESS_EQUAL}]}]

Not: Aynı anahtara yönelik "VE" ifadeleri yalnızca sayısal değerler için desteklenir. Dize değerleri yalnızca aynı anahtar için "VEYA"ları destekler.

resultsCount integer

İsteğe bağlı. Döndürülecek maksimum Chunk sayısı. Hizmet daha az Chunk döndürebilir.

Belirtilmemişse en fazla 10 Chunk döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.

Yanıt gövdesi

Alakalı parçaların listesini içeren corpora.query yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
relevantChunks[] object (RelevantChunk)

İlgili parçalar.

JSON gösterimi 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Yöntem: corpora.list

Kullanıcının sahip olduğu tüm Corpora listesini listeler.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/corpora

Sorgu parametreleri

pageSize integer

İsteğe bağlı. Döndürülecek maksimum Corpora sayısı (sayfa başına). Hizmet, daha az Corpora sonucu döndürebilir.

Belirtilmezse en fazla 10 Corpora döndürülür. Maksimum boyut sınırı sayfa başına 20 Corpora'tır.

pageToken string

İsteğe bağlı. Önceki bir corpora.list çağrısından alınan sayfa jetonu.

Sonraki sayfayı almak için yanıtta döndürülen nextPageToken değerini bir sonraki isteğinin bağımsız değişkeni olarak sağlayın.

Sayfalara ayırma işlemi sırasında corpora.list öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

corpora.list tarafından gönderilen yanıt, sayfalara ayrılmış Corpora listesi içeriyor. Sonuçlar artan corpus.create_time sütununa göre sıralanır.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
corpora[] object (Corpus)

Döndürülen derlemeler.

nextPageToken string

Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa başka sayfa yoktur.

JSON gösterimi 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Yöntem: corpora.get

Belirli bir Corpus hakkında bilgi alır.

Uç nokta

indir https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: Corpora.patch

Corpus güncellemesi

Uç nokta

yama https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Yol parametreleri

corpus.name string

Değişmez. Tanımlayıcı. Corpus kaynağının adı. Kimlik ("corpora/" ön eki hariç ad), küçük harf alfanümerik karakterler veya kısa çizgiler (-) olmak üzere en fazla 40 karakter içerebilir. Kimlik, kısa çizgiyle başlayamaz veya bitemez. Oluşturma sırasında ad boşsa displayName'den 12 karakterlik rastgele bir ek ile birlikte benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c corpora/{corpora} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

Zorunlu. Güncellenecek alanların listesi. Şu anda yalnızca displayName güncellemesi desteklenmektedir.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni, Corpus öğesinin bir örneğini içerir.

Alanlar
displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Anlamsal Retriever ile ilgili dokümanlar"

Yanıt gövdesi

Başarılıysa yanıt metni, Corpus öğesinin bir örneğini içerir.

Yöntem: corpora.delete

Corpus öğesini siler.

Uç nokta

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Yol parametreleri

name string

Zorunlu. Corpus kaynağının adı. Örnek: corpora/my-corpus-123 corpora/{corpora} biçimindedir.

Sorgu parametreleri

force boolean

İsteğe bağlı. Doğru olarak ayarlanırsa bu Corpus ile ilişkili tüm Document'ler ve nesneler de silinir.

Yanlış ise (varsayılan) Corpus herhangi bir Document içeriyorsa FAILED_PRECONDITION hatası döndürülür.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni boş olur.

REST Kaynağı: Corpora.permissions

Kaynak: İzin

İzin kaynağı; kullanıcıya, gruba veya dünyanın geri kalanına PaLM API kaynağına (ör. hassaslaştırılmış bir model, topluluk) erişim izni verir.

Rol, kullanıcıların PaLM API kaynakları üzerinde belirli işlemleri gerçekleştirmesine olanak tanıyan izin verilen işlemler koleksiyonudur. Bunları kullanıcılar, gruplar veya hizmet hesaplarında kullanılabilir hale getirmek için roller atarsınız. Bir rol atadığınızda, rolün içerdiği izinleri verirsiniz.

Üç eş merkezli rol vardır. Her rol, önceki rolün izin verilen işlemlerinin bir üst kümesidir:

  • Okuyucu, kaynak (ör. ayarlanmış model, kitaplık) için çıkarım yapabilir
  • yazar, okuyucunun izinlerine sahiptir ve ayrıca düzenleyip paylaşabilir
  • sahibi, yazar izinlerine sahiptir ve ayrıca
Alanlar
name string

Yalnızca çıkış. Tanımlayıcı. İzin adı. Oluşturma sırasında benzersiz bir ad oluşturulur. Örnekler: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Yalnızca çıkış.

granteeType enum (GranteeType)

İsteğe bağlı. Sabit. Bağış alan tarafın türü.

emailAddress string

İsteğe bağlı. Sabit. Bu iznin ait olduğu kullanıcı veya grubun e-posta adresi. İznin veriliş türü HERKES olduğunda alan ayarlanmaz.

role enum (Role)

Zorunlu. Bu izinle verilen rol.

JSON gösterimi 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Bu iznin verileni türlerini tanımlar.

Sıralamalar
GRANTEE_TYPE_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
USER Bir kullanıcıyı temsil eder. Bu parametre ayarlandığında kullanıcı için emailAddress'i sağlamanız gerekir.
GROUP Bir grubu temsil eder. Ayarlandığında grup için emailAddress değerini sağlamanız gerekir.
EVERYONE Herkese erişimi temsil eder. Ek bilgiye gerek yoktur.

Rol

Bu izinle verilen rolü tanımlar.

Sıralamalar
ROLE_UNSPECIFIED Varsayılan değerdir. Bu değer kullanılmıyor.
OWNER Sahip, kaynağı kullanabilir, güncelleyebilir, paylaşabilir ve silebilir.
WRITER Yazar, kaynağı kullanabilir, güncelleyebilir ve paylaşabilir.
READER Okuyucu kaynağı kullanabilir.

MetadataFilter

Almayı Chunk veya Document düzeyindeki meta veri değerlerine göre sınırlamak için kullanıcı tarafından sağlanan filtre. Örnek (tür = dram VEYA tür = aksiyon): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Alanlar
key string

Zorunlu. Filtrelemek için kullanılacak meta verinin anahtarı.

conditions[] object (Condition)

Zorunlu. Belirtilen anahtar için bu filtreyi tetikleyecek Condition değerleri. Birden fazla Condition, mantıksal OR ile birleştirilir.

JSON gösterimi 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Koşul

Tek bir anahtar için geçerli olan filtre koşulu.

Alanlar
operation enum (Operator)

Zorunlu. Koşulu tetiklemek için belirli bir anahtar/değer çiftine uygulanan operatör.

Birlik alanı value. Değer türü, karşılık gelen anahtarın alanında tanımlanan değer türüyle tutarlı olmalıdır. Değer türleri tutarlı değilse sonuç boş bir küme olarak gösterilir. CustomMetadata, StringList değer türüne sahip olduğunda filtreleme koşulu, INCLUDES/EXCLUDES işlemiyle birlikte string_value kullanmalıdır. Aksi takdirde sonuç da boş bir küme olur. value yalnızca aşağıdakilerden biri olabilir:
stringValue string

Meta verileri filtrelemek için kullanılacak dize değeri.

numericValue number

Meta verilerin filtreleneceği sayısal değerdir.

JSON gösterimi 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}

Operatör

Bir anahtar/değer çiftine uygulanabilecek geçerli operatörleri tanımlar.

Sıralamalar
OPERATOR_UNSPECIFIED Varsayılan değer. Bu değer kullanılmamaktadır.
LESS Sayısal değerler desteklenir.
LESS_EQUAL Sayılarla desteklenir.
EQUAL Sayı ve dize desteklenir.
GREATER_EQUAL Sayılarla desteklenir.
GREATER Sayılarla desteklenir.
NOT_EQUAL Sayısal ve dize.
INCLUDES Yalnızca belirli bir anahtar için CustomMetadata değer türü stringListValue içerdiğinde dize olarak desteklenir.
EXCLUDES Dizeye göre yalnızca belirtilen anahtar için CustomMetadata değer türü stringListValue olduğunda desteklenir.

RelevantChunk

Bir sorguyla alakalı bir parçanın bilgileri.

Alanlar
chunkRelevanceScore number

Chunk sorguyla alaka düzeyi.

chunk object (Chunk)

Chunk ile ilişkilendirilir.

JSON gösterimi 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

REST Kaynağı: corpora

Kaynak: Corpus

Corpus, Document'lerden oluşan bir koleksiyondur. Bir projede en fazla 5 korpus oluşturulabilir.

Alanlar
name string

Değişmez. Tanımlayıcı. Corpus kaynağının adı. Kimlik ("Corpora/" öneki hariç olmak üzere ad), küçük harfli alfanümerik veya kısa çizgi (-) biçimindeki en fazla 40 karakter içerebilir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName öğesinden benzersiz bir ad türetilir. Örnek: corpora/my-awesome-corpora-123a456b789c

displayName string

İsteğe bağlı. Corpus için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Semantik Retriever ile ilgili Dokümanlar"

createTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin oluşturulduğu zaman damgası.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Yalnızca çıkış. Corpus öğesinin en son güncellendiği zaman damgası.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}